# stdafx.h

Go to the documentation of this file.

    00001 /* $Id$ */
    00002
    00003 /*
    00004  * This file is part of OpenTTD.
    00005  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
    00006  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
    00007  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
    00008  */
    00009
    00012 #ifndef STDAFX_H
    00013 #define STDAFX_H
    00014
    00015 #if defined(__APPLE__)
    00016   #include "os/macosx/osx_stdafx.h"
    00017 #endif /* __APPLE__ */
    00018
    00019 #if defined(__BEOS__) || defined(__HAIKU__)
    00020   #include <SupportDefs.h>
    00021   #include <unistd.h>
    00022   #define _GNU_SOURCE
    00023   #define TROUBLED_INTS
    00024 #elif defined(__NDS__)
    00025   #include <nds/jtypes.h>
    00026   #define TROUBLED_INTS
    00027 #endif
    00028
    00029 /* It seems that we need to include stdint.h before anything else
    00030  * We need INT64_MAX, which for most systems comes from stdint.h. However, MSVC
    00031  * does not have stdint.h and apparently neither does MorphOS, so define
    00032  * INT64_MAX for them ourselves. */
    00033 #if defined(__APPLE__)
    00034   /* Already done in osx_stdafx.h */
    00035 #elif !defined(_MSC_VER) && !defined( __MORPHOS__) && !defined(_STDINT_H_)
    00036   #if defined(SUNOS)
    00037     /* SunOS/Solaris does not have stdint.h, but inttypes.h defines everything
    00038      * stdint.h defines and we need. */
    00039     #include <inttypes.h>
    00040   # else
    00041     #define __STDC_LIMIT_MACROS
    00042     #include <stdint.h>
    00043   #endif
    00044 #else
    00045   #define UINT64_MAX (18446744073709551615ULL)
    00046   #define INT64_MAX  (9223372036854775807LL)
    00047   #define INT64_MIN  (-INT64_MAX - 1)
    00048   #define UINT32_MAX (4294967295U)
    00049   #define INT32_MAX  (2147483647)
    00050   #define INT32_MIN  (-INT32_MAX - 1)
    00051   #define UINT16_MAX (65535U)
    00052   #define INT16_MAX  (32767)
    00053   #define INT16_MIN  (-INT16_MAX - 1)
    00054   #define UINT8_MAX  (255)
    00055   #define INT8_MAX   (127)
    00056   #define INT8_MIN   (-INT8_MAX - 1)
    00057 #endif
    00058
    00059 #include <cstdio>
    00060 #include <cstddef>
    00061 #include <cstring>
    00062 #include <cstdlib>
    00063 #include <climits>
    00064 #include <cassert>
    00065
    00066 #ifndef SIZE_MAX
    00067   #define SIZE_MAX ((size_t)-1)
    00068 #endif
    00069
    00070 #if defined(UNIX) || defined(__MINGW32__)
    00071   #include <sys/types.h>
    00072 #endif
    00073
    00074 #if defined(__OS2__)
    00075   #include <types.h>
    00076   #define strcasecmp stricmp
    00077 #endif
    00078
    00079 #if defined(PSP)
    00080   #include <psptypes.h>
    00081   #include <pspdebug.h>
    00082   #include <pspthreadman.h>
    00083 #endif
    00084
    00085 #if defined(SUNOS) || defined(HPUX)
    00086   #include <alloca.h>
    00087 #endif
    00088
    00089 #if defined(__MORPHOS__)
    00090   /* MorphOS defines certain Amiga defines per default, we undefine them
    00091    * here to make the rest of source less messy and more clear what is
    00092    * required for morphos and what for AmigaOS */
    00093   #if defined(amigaos)
    00094     #undef amigaos
    00095   #endif
    00096   #if defined(__amigaos__)
    00097     #undef __amigaos__
    00098   # endif
    00099   #if defined(__AMIGA__)
    00100     #undef __AMIGA__
    00101   #endif
    00102   #if defined(AMIGA)
    00103     #undef AMIGA
    00104   #endif
    00105   #if defined(amiga)
    00106     #undef amiga
    00107   #endif
    00108   /* Act like we already included this file, as it somehow gives linkage problems
    00109    *  (mismatch linkage of C++ and C between this include and unistd.h). */
    00110   #define CLIB_USERGROUP_PROTOS_H
    00111 #endif /* __MORPHOS__ */
    00112
    00113 #if defined(PSP)
    00114   /* PSP can only have 10 file-descriptors open at any given time, but this
    00115    *  switch only limits reads via the Fio system. So keep 2 fds free for things
    00116    *  like saving a game. */
    00117   #define LIMITED_FDS 8
    00118   #define printf pspDebugScreenPrintf
    00119 #endif /* PSP */
    00120
    00121 /* Stuff for GCC */
    00122 #if defined(__GNUC__)
    00123   #define NORETURN __attribute__ ((noreturn))
    00124   #define CDECL
    00125   #define __int64 long long
    00126   #define GCC_PACK __attribute__((packed))
    00127   /* Warn about functions using 'printf' format syntax. First argument determines which parameter
    00128    * is the format string, second argument is start of values passed to printf. */
    00129   #define WARN_FORMAT(string, args) __attribute__ ((format (printf, string, args)))
    00130   #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7)
    00131     #define FINAL final
    00132   #else
    00133     #define FINAL
    00134   #endif
    00135 #endif /* __GNUC__ */
    00136
    00137 #if defined(__WATCOMC__)
    00138   #define NORETURN
    00139   #define CDECL
    00140   #define GCC_PACK
    00141   #define WARN_FORMAT(string, args)
    00142   #define FINAL
    00143   #include <malloc.h>
    00144 #endif /* __WATCOMC__ */
    00145
    00146 #if defined(__MINGW32__) || defined(__CYGWIN__)
    00147   #include <malloc.h> // alloca()
    00148 #endif
    00149
    00150 #if defined(WIN32)
    00151   #define WIN32_LEAN_AND_MEAN     // Exclude rarely-used stuff from Windows headers
    00152 #endif
    00153
    00154 /* Stuff for MSVC */
    00155 #if defined(_MSC_VER)
    00156   #pragma once
    00157   /* Define a win32 target platform, to override defaults of the SDK
    00158    * We need to define NTDDI version for Vista SDK, but win2k is minimum */
    00159   #define NTDDI_VERSION NTDDI_WIN2K // Windows 2000
    00160   #define _WIN32_WINNT 0x0500       // Windows 2000
    00161   #define _WIN32_WINDOWS 0x400      // Windows 95
    00162   #if !defined(WINCE)
    00163     #define WINVER 0x0400     // Windows NT 4.0 / Windows 95
    00164   #endif
    00165   #define _WIN32_IE_ 0x0401         // 4.01 (win98 and NT4SP5+)
    00166
    00167   #pragma warning(disable: 4244)  // 'conversion' conversion from 'type1' to 'type2', possible loss of data
    00168   #pragma warning(disable: 4761)  // integral size mismatch in argument : conversion supplied
    00169   #pragma warning(disable: 4200)  // nonstandard extension used : zero-sized array in struct/union
    00170
    00171   #if (_MSC_VER < 1400)                   // MSVC 2005 safety checks
    00172     #error "Only MSVC 2005 or higher are supported. MSVC 2003 and earlier are not! Upgrade your compiler."
    00173   #endif /* (_MSC_VER < 1400) */
    00174   #pragma warning(disable: 4291)   // no matching operator delete found; memory will not be freed if initialization throws an exception (reason: our overloaded functions never throw an exception)
    00175   #pragma warning(disable: 4996)   // 'function': was declared deprecated
    00176   #define _CRT_SECURE_NO_DEPRECATE // all deprecated 'unsafe string functions
    00177   #pragma warning(disable: 6308)   // code analyzer: 'realloc' might return null pointer: assigning null pointer to 't_ptr', which is passed as an argument to 'realloc', will cause the original memory block to be leaked
    00178   #pragma warning(disable: 6011)   // code analyzer: Dereferencing NULL pointer 'pfGetAddrInfo': Lines: 995, 996, 998, 999, 1001
    00179   #pragma warning(disable: 6326)   // code analyzer: potential comparison of a constant with another constant
    00180   #pragma warning(disable: 6031)   // code analyzer: Return value ignored: 'ReadFile'
    00181   #pragma warning(disable: 6255)   // code analyzer: _alloca indicates failure by raising a stack overflow exception. Consider using _malloca instead
    00182   #pragma warning(disable: 6246)   // code analyzer: Local declaration of 'statspec' hides declaration of the same name in outer scope. For additional information, see previous declaration at ...
    00183
    00184   #include <malloc.h> // alloca()
    00185   #define NORETURN __declspec(noreturn)
    00186   #define inline __forceinline
    00187
    00188   #if !defined(WINCE)
    00189     #define CDECL _cdecl
    00190   #endif
    00191
    00192   #define GCC_PACK
    00193   #define WARN_FORMAT(string, args)
    00194   #define FINAL sealed
    00195
    00196   int CDECL snprintf(char *str, size_t size, const char *format, ...) WARN_FORMAT(3, 4);
    00197   #if defined(WINCE)
    00198     int CDECL vsnprintf(char *str, size_t size, const char *format, va_list ap);
    00199   #endif
    00200
    00201   #if defined(WIN32) && !defined(_WIN64) && !defined(WIN64)
    00202     #if !defined(_W64)
    00203       #define _W64
    00204     #endif
    00205
    00206     typedef _W64 int INT_PTR, *PINT_PTR;
    00207     typedef _W64 unsigned int UINT_PTR, *PUINT_PTR;
    00208   #endif /* WIN32 && !_WIN64 && !WIN64 */
    00209
    00210   #if defined(_WIN64) || defined(WIN64)
    00211     #define fseek _fseeki64
    00212   #endif /* _WIN64 || WIN64 */
    00213
    00214   /* This is needed to zlib uses the stdcall calling convention on visual studio */
    00215   #if defined(WITH_ZLIB) || defined(WITH_PNG)
    00216     #if !defined(ZLIB_WINAPI)
    00217       #define ZLIB_WINAPI
    00218     #endif
    00219   #endif
    00220
    00221   #if defined(WINCE)
    00222     #define strcasecmp _stricmp
    00223     #define strncasecmp _strnicmp
    00224     #undef DEBUG
    00225   #else
    00226     #define strcasecmp stricmp
    00227     #define strncasecmp strnicmp
    00228   #endif
    00229
    00230   /* MSVC doesn't have these :( */
    00231   #define S_ISDIR(mode) (mode & S_IFDIR)
    00232   #define S_ISREG(mode) (mode & S_IFREG)
    00233
    00234 #endif /* defined(_MSC_VER) */
    00235
    00236 #if defined(DOS)
    00237   /* The DOS port does not have all signals/signal functions. */
    00238   #define strsignal(sig) ""
    00239   /* Use 'no floating point' for bus errors; SIGBUS does not exist
    00240    * for DOS, SIGNOFP for other platforms. So it's fairly safe
    00241    * to interchange those. */
    00242   #define SIGBUS SIGNOFP
    00243 #endif
    00244
    00245 #if defined(WINCE)
    00246   #define strdup _strdup
    00247 #endif /* WINCE */
    00248
    00249 /* NOTE: the string returned by these functions is only valid until the next
    00250  * call to the same function and is not thread- or reentrancy-safe */
    00251 #if !defined(STRGEN) && !defined(SETTINGSGEN)
    00252   #if defined(WIN32) || defined(WIN64)
    00253     char *getcwd(char *buf, size_t size);
    00254     #include <tchar.h>
    00255     #include <io.h>
    00256
    00257     /* XXX - WinCE without MSVCRT doesn't support wfopen, so it seems */
    00258     #if !defined(WINCE)
    00259       namespace std { using ::_tfopen; }
    00260       #define fopen(file, mode) _tfopen(OTTD2FS(file), _T(mode))
    00261       #define unlink(file) _tunlink(OTTD2FS(file))
    00262     #endif /* WINCE */
    00263
    00264     const char *FS2OTTD(const TCHAR *name);
    00265     const TCHAR *OTTD2FS(const char *name);
    00266     #define SQ2OTTD(name) FS2OTTD(name)
    00267     #define OTTD2SQ(name) OTTD2FS(name)
    00268   #else
    00269     #define fopen(file, mode) fopen(OTTD2FS(file), mode)
    00270     const char *FS2OTTD(const char *name);
    00271     const char *OTTD2FS(const char *name);
    00272     #define SQ2OTTD(name) (name)
    00273     #define OTTD2SQ(name) (name)
    00274   #endif /* WIN32 */
    00275 #endif /* STRGEN || SETTINGSGEN */
    00276
    00277 #if defined(WIN32) || defined(WIN64) || defined(__OS2__) && !defined(__INNOTEK_LIBC__)
    00278   #define PATHSEP "\\"
    00279   #define PATHSEPCHAR '\\'
    00280 #else
    00281   #define PATHSEP "/"
    00282   #define PATHSEPCHAR '/'
    00283 #endif
    00284
    00285 /* MSVCRT of course has to have a different syntax for long long *sigh* */
    00286 #if defined(_MSC_VER) || defined(__MINGW32__)
    00287   #define OTTD_PRINTF64 "%I64d"
    00288   #define OTTD_PRINTFHEX64 "%I64x"
    00289   #define PRINTF_SIZE "%Iu"
    00290 #else
    00291   #define OTTD_PRINTF64 "%lld"
    00292   #define OTTD_PRINTFHEX64 "%llx"
    00293   #define PRINTF_SIZE "%zu"
    00294 #endif
    00295
    00296 typedef unsigned char byte;
    00297
    00298 /* This is already defined in unix, but not in QNX Neutrino (6.x)*/
    00299 #if (!defined(UNIX) && !defined(__CYGWIN__) && !defined(__BEOS__) && !defined(__HAIKU__) && !defined(__MORPHOS__)) || defined(__QNXNTO__)
    00300   typedef unsigned int uint;
    00301 #endif
    00302
    00303 #if defined(TROUBLED_INTS)
    00304   /* NDS'/BeOS'/Haiku's types for uint32/int32 are based on longs, which causes
    00305    * trouble all over the place in OpenTTD. */
    00306   #define uint32 uint32_ugly_hack
    00307   #define int32 int32_ugly_hack
    00308   typedef unsigned int uint32_ugly_hack;
    00309   typedef signed int int32_ugly_hack;
    00310 #else
    00311   typedef unsigned char    uint8;
    00312   typedef   signed char     int8;
    00313   typedef unsigned short   uint16;
    00314   typedef   signed short    int16;
    00315   typedef unsigned int     uint32;
    00316   typedef   signed int      int32;
    00317   typedef unsigned __int64 uint64;
    00318   typedef   signed __int64  int64;
    00319 #endif /* !TROUBLED_INTS */
    00320
    00321 #if !defined(WITH_PERSONAL_DIR)
    00322   #define PERSONAL_DIR ""
    00323 #endif
    00324
    00325 /* Compile time assertions. Prefer c++0x static_assert().
    00326  * Older compilers cannot evaluate some expressions at compile time,
    00327  * typically when templates are involved, try assert_tcompile() in those cases. */
    00328 #if defined(__STDCXX_VERSION__) || defined(__GXX_EXPERIMENTAL_CXX0X__) || defined(__GXX_EXPERIMENTAL_CPP0X__) || defined(static_assert)
    00329   /* __STDCXX_VERSION__ is c++0x feature macro, __GXX_EXPERIMENTAL_CXX0X__ is used by gcc, __GXX_EXPERIMENTAL_CPP0X__ by icc */
    00330   #define assert_compile(expr) static_assert(expr, #expr )
    00331   #define assert_tcompile(expr) assert_compile(expr)
    00332 #elif defined(__OS2__)
    00333   /* Disabled for OS/2 */
    00334   #define assert_compile(expr)
    00335   #define assert_tcompile(expr) assert_compile(expr)
    00336 #else
    00337   #define assert_compile(expr) typedef int __ct_assert__[1 - 2 * !(expr)]
    00338   #define assert_tcompile(expr) assert(expr)
    00339 #endif
    00340
    00341 /* Check if the types have the bitsizes like we are using them */
    00342 assert_compile(sizeof(uint64) == 8);
    00343 assert_compile(sizeof(uint32) == 4);
    00344 assert_compile(sizeof(uint16) == 2);
    00345 assert_compile(sizeof(uint8)  == 1);
    00346 assert_compile(SIZE_MAX >= UINT32_MAX);
    00347
    00348 #ifndef M_PI_2
    00349 #define M_PI_2 1.57079632679489661923
    00350 #define M_PI   3.14159265358979323846
    00351 #endif /* M_PI_2 */
    00352
    00361 #define lengthof(x) (sizeof(x) / sizeof(x[0]))
    00362
    00369 #define endof(x) (&x[lengthof(x)])
    00370
    00377 #define lastof(x) (&x[lengthof(x) - 1])
    00378
    00379 #define cpp_offsetof(s, m)   (((size_t)&reinterpret_cast<const volatile char&>((((s*)(char*)8)->m))) - 8)
    00380 #if !defined(offsetof)
    00381   #define offsetof(s, m) cpp_offsetof(s, m)
    00382 #endif /* offsetof */
    00383
    00390 #define cpp_sizeof(base, variable) (sizeof(((base*)8)->variable))
    00391
    00398 #define cpp_lengthof(base, variable) (cpp_sizeof(base, variable) / cpp_sizeof(base, variable[0]))
    00399
    00400
    00401 /* take care of some name clashes on MacOS */
    00402 #if defined(__APPLE__)
    00403   #define GetString OTTD_GetString
    00404   #define DrawString OTTD_DrawString
    00405   #define CloseConnection OTTD_CloseConnection
    00406 #endif /* __APPLE__ */
    00407
    00408 void NORETURN CDECL usererror(const char *str, ...) WARN_FORMAT(1, 2);
    00409 void NORETURN CDECL error(const char *str, ...) WARN_FORMAT(1, 2);
    00410 #define NOT_REACHED() error("NOT_REACHED triggered at line %i of %s", __LINE__, __FILE__)
    00411
    00412 /* For non-debug builds with assertions enabled use the special assertion handler:
    00413  * - For MSVC: NDEBUG is set for all release builds and WITH_ASSERT overrides the disabling of asserts.
    00414  * - For non MSVC: NDEBUG is set when assertions are disables, _DEBUG is set for non-release builds.
    00415  */
    00416 #if (defined(_MSC_VER) && defined(NDEBUG) && defined(WITH_ASSERT)) || (!defined(_MSC_VER) && !defined(NDEBUG) && !defined(_DEBUG))
    00417   #undef assert
    00418   #define assert(expression) if (!(expression)) error("Assertion failed at line %i of %s: %s", __LINE__, __FILE__, #expression);
    00419 #endif
    00420
    00421 /* Asserts are enabled if NDEBUG isn't defined, or if we are using MSVC and WITH_ASSERT is defined. */
    00422 #if !defined(NDEBUG) || (defined(_MSC_VER) && defined(WITH_ASSERT))
    00423   #define OTTD_ASSERT
    00424 #endif
    00425
    00426 #if defined(MORPHOS) || defined(__NDS__) || defined(__DJGPP__)
    00427   /* MorphOS and NDS don't have C++ conformant _stricmp... */
    00428   #define _stricmp stricmp
    00429 #elif defined(OPENBSD)
    00430   /* OpenBSD uses strcasecmp(3) */
    00431   #define _stricmp strcasecmp
    00432 #endif
    00433
    00434 #if defined(MAX_PATH)
    00435   /* It's already defined, no need to override */
    00436 #elif defined(PATH_MAX) && PATH_MAX > 0
    00437   /* Use the value from PATH_MAX, if it exists */
    00438   #define MAX_PATH PATH_MAX
    00439 #else
    00440   /* If all else fails, hardcode something :( */
    00441   #define MAX_PATH 260
    00442 #endif
    00443
    00448 static inline void free(const void *ptr)
    00449 {
    00450   free(const_cast<void *>(ptr));
    00451 }
    00452
    00457 #define MAX_UVALUE(type) ((type)~(type)0)
    00458
    00459 #endif /* STDAFX_H */