platform.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2025 Global Graphics Software Ltd. All rights reserved.
 */

 
#ifndef PLATFORM_H
#define PLATFORM_H
 
 
/***********************************************************
 * The target platforms currently supported by Mako consist of:
 *
 *  Operating System            Processor Architecture
 *  ----------------            ----------------------
 *  Windows                     x86
 *  Windows                     x64
 *  Windows                     arm64
 *  Windows Server              x64
 *  Windows Server              x64
 *  Windows UWP                 armv7
 *
 *  macOS                       x64
 *  macOS                       arm64
 *  iOS                         arm64
 *  iOS                         x64 (simulator)
 *  iOS                         arm64 (simulator)
 *
 *  Linux                       x86
 *  Linux                       arm32
 *  Linux                       arm64
 *
 * In order to be able to resolve these platforms at compilation time
 * we are expecting the compilation environment to supply one (or more)
 * of the following preprocessor symbols:
 *
 *  _WIN32
 *  _WIN64
 *  __linux
 *  __APPLE__
 *  __ppc__
 *  __i386__
 *  __ppc64__
 *  __amd64__
 *  __x86_64__
 *  __arm__
 *  __arm64__
 *
 *
 * For some of these we additionally define a number of parallel symbols
 * that are needed by header files provided by other packages whose header files we compile against
 * and whose libraries we link to build Mako
 *
 *  WIN32
 *  WIN64
 *  LINUX
 ***********************************************************/
 
#ifdef _WIN32
#ifndef WIN32
#define WIN32
#endif
#endif
 
#ifdef _WIN64
#ifndef WIN64
#define WIN64
#endif
#endif
 
#ifdef __linux
#ifndef LINUX
#define LINUX
#endif
#endif
 
 
/***********************************************************
 * In addition to these operating-system/processor-architecture dependent
 * switches, where supported by the target platform EDL can also be build
 * with the "endianness" configured by the setting of the symbol
 *
 *  EDLENDIAN
 *
 * to either eEndianBig or eEndianLittle
 ***********************************************************/
 
typedef enum { eEndianBig, eEndianLittle } eEDLEndian;
 
#if defined(_WIN32) || defined(_WIN64)
// Windows only runs on little endian systems
#define EDLENDIAN   eEndianLittle
#elif defined(__i386__) || defined(__amd64__) || defined(__x86_64__) || defined(__arm__) || defined(__arm64__) || defined(__aarch64__)
#define EDLENDIAN   eEndianLittle
#elif defined(__ppc__) || defined(__ppc64__)
#define EDLENDIAN   eEndianBig
#else
#error "Don't know the endianness for this architecture!"
#endif
 
/***********************************************************
 * EDLPTRSIZE indicates the size in bytes of a pointer for this architecture
 ***********************************************************/
 
 #if defined(_WIN64) || defined(__amd64__) || defined(__x86_64__) || defined(__ppc64__) || defined(__arm64__) || defined(__aarch64__)
 #define EDLPTRSIZE 8
 #elif defined(_WIN32) || defined(__ppc__) || defined(__i386__) || defined(__arm__)
 #define EDLPTRSIZE 4
 #else
 #error "Don't know the pointer size for this architecture"
 #endif
 
 
/**********************************************************
 * In addition to the target-platform-dependent "switches"
 * we also define a number of symbols whose values are themselves platform-dependent
 * These include:
 *
 * PATH_SEP_CHAR which defines the character that represents a filestore path separator.
 *
 * DRIVE_DELIM which defines the character which separates/identifies
 * a drive letter at the start of a (Windows) path.
 *
 * And the various file permission "masks" like S_IRWXU
 *********************************************************/
 
#if defined(_WIN32) || defined(_WIN64)
 
// Windows dependencies
#include <limits.h>
 
#define PATH_SEP_CHAR    '\\'
#if _MSC_VER < 1900
#define snprintf _snprintf
#endif
#define getcwd   _getcwd
 
#ifndef MAXPATHLEN
#define MAXPATHLEN _MAX_PATH
#endif /* _WIN32 || _WIN64 */
 
#if _MSC_VER < 1800
#define roundf(v) round(v)
#endif
 
#define MAKO_DEPRECATED_FUNC(func, msg) __declspec(deprecated(msg)) func
 
#endif /* _WIN32 || _WIN64 */
 
 
#ifdef __APPLE__
 
// OSX OS and iOS dependencies
 
#include <errno.h>
#include <unistd.h>
#include <sys/param.h>
#include <sys/types.h>
#include <sys/stat.h>    // for the file creation mask symbols S_IRWXU etc. and for mkdir()
#include <semaphore.h>  // for semaphores
#include <sys/socket.h> // for sockets
#include <netinet/in.h>   // for sockaddr_in
#include <arpa/inet.h>   // for inet_addr
 
#define PATH_SEP_CHAR     '/'
 
extern const char **environ;
 
#define MAKO_DEPRECATED_FUNC(func,msg) func __attribute__((deprecated(msg)))
 
#endif /* __APPLE__ */
 
 
#ifdef __linux
 
    // Linux OS dependencies
 
#include <errno.h>
#include <unistd.h>
#include <sys/param.h>
#include <sys/types.h>
#include <sys/stat.h>    // for the file creation mask symbols S_IRWXU etc. and for mkdir()
#include <semaphore.h>  // for semaphores
#include <sys/socket.h> // for sockets
#include <netinet/in.h>   // for sockaddr_in
#include <arpa/inet.h>   // for inet_addr
 
#define PATH_SEP_CHAR     '/'
 
#define MAKO_DEPRECATED_FUNC(func, msg) func  __attribute__((deprecated, warning(msg)))
 
#endif /* __linux */
 
#if defined(SWIG) || defined(SWIG_VERSION)
#undef MAKO_DEPRECATED_FUNC
#define MAKO_DEPRECATED_FUNC(func, msg) func
#endif
 
#endif   /* __PLATFORM_H__ */