OpenTTD
stdafx.h
Go to the documentation of this file.
1 /* $Id: stdafx.h 27916 2017-09-24 13:35:27Z frosch $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #ifndef STDAFX_H
13 #define STDAFX_H
14 
15 #if defined(__APPLE__)
16  #include "os/macosx/osx_stdafx.h"
17 #endif /* __APPLE__ */
18 
19 #if defined(__BEOS__) || defined(__HAIKU__)
20  #include <SupportDefs.h>
21  #include <unistd.h>
22  #define _GNU_SOURCE
23  #define TROUBLED_INTS
24  #include <strings.h>
25 #elif defined(__NDS__)
26  #include <nds/jtypes.h>
27  #define TROUBLED_INTS
28 #endif
29 
30 /* It seems that we need to include stdint.h before anything else
31  * We need INT64_MAX, which for most systems comes from stdint.h. However, MSVC
32  * does not have stdint.h and apparently neither does MorphOS.
33  * For OSX the inclusion is already done in osx_stdafx.h. */
34 #if !defined(__APPLE__) && (!defined(_MSC_VER) || _MSC_VER >= 1600) && !defined(__MORPHOS__)
35  #if defined(SUNOS)
36  /* SunOS/Solaris does not have stdint.h, but inttypes.h defines everything
37  * stdint.h defines and we need. */
38  #include <inttypes.h>
39  #else
40  #define __STDC_LIMIT_MACROS
41  #include <stdint.h>
42  #endif
43 #endif
44 
45 /* The conditions for these constants to be available are way too messy; so check them one by one */
46 #if !defined(UINT64_MAX)
47  #define UINT64_MAX (18446744073709551615ULL)
48 #endif
49 #if !defined(INT64_MAX)
50  #define INT64_MAX (9223372036854775807LL)
51 #endif
52 #if !defined(INT64_MIN)
53  #define INT64_MIN (-INT64_MAX - 1)
54 #endif
55 #if !defined(UINT32_MAX)
56  #define UINT32_MAX (4294967295U)
57 #endif
58 #if !defined(INT32_MAX)
59  #define INT32_MAX (2147483647)
60 #endif
61 #if !defined(INT32_MIN)
62  #define INT32_MIN (-INT32_MAX - 1)
63 #endif
64 #if !defined(UINT16_MAX)
65  #define UINT16_MAX (65535U)
66 #endif
67 #if !defined(INT16_MAX)
68  #define INT16_MAX (32767)
69 #endif
70 #if !defined(INT16_MIN)
71  #define INT16_MIN (-INT16_MAX - 1)
72 #endif
73 #if !defined(UINT8_MAX)
74  #define UINT8_MAX (255)
75 #endif
76 #if !defined(INT8_MAX)
77  #define INT8_MAX (127)
78 #endif
79 #if !defined(INT8_MIN)
80  #define INT8_MIN (-INT8_MAX - 1)
81 #endif
82 
83 #include <cstdio>
84 #include <cstddef>
85 #include <cstring>
86 #include <cstdlib>
87 #include <climits>
88 #include <cassert>
89 
90 #ifndef SIZE_MAX
91  #define SIZE_MAX ((size_t)-1)
92 #endif
93 
94 #if defined(UNIX) || defined(__MINGW32__)
95  #include <sys/types.h>
96 #endif
97 
98 #if defined(__OS2__)
99  #include <types.h>
100  #define strcasecmp stricmp
101 #endif
102 
103 #if defined(PSP)
104  #include <psptypes.h>
105  #include <pspdebug.h>
106  #include <pspthreadman.h>
107 #endif
108 
109 #if defined(SUNOS) || defined(HPUX)
110  #include <alloca.h>
111 #endif
112 
113 #if defined(__MORPHOS__)
114  /* MorphOS defines certain Amiga defines per default, we undefine them
115  * here to make the rest of source less messy and more clear what is
116  * required for morphos and what for AmigaOS */
117  #if defined(amigaos)
118  #undef amigaos
119  #endif
120  #if defined(__amigaos__)
121  #undef __amigaos__
122  # endif
123  #if defined(__AMIGA__)
124  #undef __AMIGA__
125  #endif
126  #if defined(AMIGA)
127  #undef AMIGA
128  #endif
129  #if defined(amiga)
130  #undef amiga
131  #endif
132  /* Act like we already included this file, as it somehow gives linkage problems
133  * (mismatch linkage of C++ and C between this include and unistd.h). */
134  #define CLIB_USERGROUP_PROTOS_H
135 #endif /* __MORPHOS__ */
136 
137 #if defined(PSP)
138  /* PSP can only have 10 file-descriptors open at any given time, but this
139  * switch only limits reads via the Fio system. So keep 2 fds free for things
140  * like saving a game. */
141  #define LIMITED_FDS 8
142  #define printf pspDebugScreenPrintf
143 #endif /* PSP */
144 
145 /* Stuff for GCC */
146 #if defined(__GNUC__)
147  #define NORETURN __attribute__ ((noreturn))
148  #define CDECL
149  #define __int64 long long
150  #define GCC_PACK __attribute__((packed))
151  /* Warn about functions using 'printf' format syntax. First argument determines which parameter
152  * is the format string, second argument is start of values passed to printf. */
153  #define WARN_FORMAT(string, args) __attribute__ ((format (printf, string, args)))
154  #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7)
155  #define FINAL final
156  #else
157  #define FINAL
158  #endif
159 
160  /* Use fallthrough attribute where supported */
161  #if __GNUC__ >= 7
162  #if __cplusplus > 201402L // C++17
163  #define FALLTHROUGH [[fallthrough]]
164  #else
165  #define FALLTHROUGH __attribute__((fallthrough))
166  #endif
167  #else
168  #define FALLTHROUGH
169  #endif
170 #endif /* __GNUC__ */
171 
172 #if defined(__WATCOMC__)
173  #define NORETURN
174  #define CDECL
175  #define GCC_PACK
176  #define WARN_FORMAT(string, args)
177  #define FINAL
178  #define FALLTHROUGH
179  #include <malloc.h>
180 #endif /* __WATCOMC__ */
181 
182 #if defined(__MINGW32__) || defined(__CYGWIN__)
183  #include <malloc.h> // alloca()
184 #endif
185 
186 #if defined(WIN32)
187  #define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers
188 #endif
189 
190 /* Stuff for MSVC */
191 #if defined(_MSC_VER)
192  #pragma once
193  #ifdef _WIN64
194  /* No 64-bit Windows below XP, so we can safely assume it as the target platform. */
195  #define NTDDI_VERSION NTDDI_WINXP // Windows XP
196  #define _WIN32_WINNT 0x501 // Windows XP
197  #define _WIN32_WINDOWS 0x501 // Windows XP
198  #define WINVER 0x0501 // Windows XP
199  #define _WIN32_IE_ 0x0600 // 6.0 (XP+)
200  #else
201  /* Define a win32 target platform, to override defaults of the SDK
202  * We need to define NTDDI version for Vista SDK, but win2k is minimum */
203  #define NTDDI_VERSION NTDDI_WIN2K // Windows 2000
204  #define _WIN32_WINNT 0x0500 // Windows 2000
205  #define _WIN32_WINDOWS 0x400 // Windows 95
206  #if !defined(WINCE)
207  #define WINVER 0x0400 // Windows NT 4.0 / Windows 95
208  #endif
209  #define _WIN32_IE_ 0x0401 // 4.01 (win98 and NT4SP5+)
210  #endif
211  #define NOMINMAX // Disable min/max macros in windows.h.
212 
213  #pragma warning(disable: 4244) // 'conversion' conversion from 'type1' to 'type2', possible loss of data
214  #pragma warning(disable: 4761) // integral size mismatch in argument : conversion supplied
215  #pragma warning(disable: 4200) // nonstandard extension used : zero-sized array in struct/union
216  #pragma warning(disable: 4355) // 'this' : used in base member initializer list
217 
218  #if (_MSC_VER < 1400) // MSVC 2005 safety checks
219  #error "Only MSVC 2005 or higher are supported. MSVC 2003 and earlier are not! Upgrade your compiler."
220  #endif /* (_MSC_VER < 1400) */
221  #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)
222  #pragma warning(disable: 4996) // 'function': was declared deprecated
223  #define _CRT_SECURE_NO_DEPRECATE // all deprecated 'unsafe string functions
224  #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
225  #pragma warning(disable: 6011) // code analyzer: Dereferencing NULL pointer 'pfGetAddrInfo': Lines: 995, 996, 998, 999, 1001
226  #pragma warning(disable: 6326) // code analyzer: potential comparison of a constant with another constant
227  #pragma warning(disable: 6031) // code analyzer: Return value ignored: 'ReadFile'
228  #pragma warning(disable: 6255) // code analyzer: _alloca indicates failure by raising a stack overflow exception. Consider using _malloca instead
229  #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 ...
230 
231  #if (_MSC_VER == 1500) // Addresses item #13 on http://blogs.msdn.com/b/vcblog/archive/2008/08/11/tr1-fixes-in-vc9-sp1.aspx, for Visual Studio 2008
232  #define _DO_NOT_DECLARE_INTERLOCKED_INTRINSICS_IN_MEMORY
233  #include <intrin.h>
234  #endif
235 
236  #include <malloc.h> // alloca()
237  #define NORETURN __declspec(noreturn)
238  #if (_MSC_VER < 1900)
239  #define inline __forceinline
240  #endif
241 
242  #if !defined(WINCE)
243  #define CDECL _cdecl
244  #endif
245 
246  #define GCC_PACK
247  #define WARN_FORMAT(string, args)
248  #define FINAL sealed
249 
250  /* fallthrough attribute, VS 2017 */
251  #if (_MSC_VER >= 1910)
252  #define FALLTHROUGH [[fallthrough]]
253  #else
254  #define FALLTHROUGH
255  #endif
256 
257  #if defined(WINCE)
258  int CDECL vsnprintf(char *str, size_t size, const char *format, va_list ap);
259  #endif
260 
261  #if defined(WIN32) && !defined(_WIN64) && !defined(WIN64)
262  #if !defined(_W64)
263  #define _W64
264  #endif
265 
266  typedef _W64 int INT_PTR, *PINT_PTR;
267  typedef _W64 unsigned int UINT_PTR, *PUINT_PTR;
268  #endif /* WIN32 && !_WIN64 && !WIN64 */
269 
270  #if defined(_WIN64) || defined(WIN64)
271  #define fseek _fseeki64
272  #endif /* _WIN64 || WIN64 */
273 
274  /* This is needed to zlib uses the stdcall calling convention on visual studio */
275  #if defined(WITH_ZLIB) || defined(WITH_PNG)
276  #if !defined(ZLIB_WINAPI)
277  #define ZLIB_WINAPI
278  #endif
279  #endif
280 
281  #if defined(WINCE)
282  #define strcasecmp _stricmp
283  #define strncasecmp _strnicmp
284  #undef DEBUG
285  #else
286  #define strcasecmp stricmp
287  #define strncasecmp strnicmp
288  #endif
289 
290  #define strtoull _strtoui64
291 
292  /* MSVC doesn't have these :( */
293  #define S_ISDIR(mode) (mode & S_IFDIR)
294  #define S_ISREG(mode) (mode & S_IFREG)
295 
296 #endif /* defined(_MSC_VER) */
297 
298 #if defined(DOS)
299  /* The DOS port does not have all signals/signal functions. */
300  #define strsignal(sig) ""
301  /* Use 'no floating point' for bus errors; SIGBUS does not exist
302  * for DOS, SIGNOFP for other platforms. So it's fairly safe
303  * to interchange those. */
304  #define SIGBUS SIGNOFP
305 #endif
306 
307 #if defined(WINCE)
308  #define stredup _stredup
309 #endif /* WINCE */
310 
311 /* NOTE: the string returned by these functions is only valid until the next
312  * call to the same function and is not thread- or reentrancy-safe */
313 #if !defined(STRGEN) && !defined(SETTINGSGEN)
314  #if defined(WIN32) || defined(WIN64)
315  char *getcwd(char *buf, size_t size);
316  #include <tchar.h>
317  #include <io.h>
318 
319  /* XXX - WinCE without MSVCRT doesn't support wfopen, so it seems */
320  #if !defined(WINCE)
321  namespace std { using ::_tfopen; }
322  #define fopen(file, mode) _tfopen(OTTD2FS(file), _T(mode))
323  #define unlink(file) _tunlink(OTTD2FS(file))
324  #endif /* WINCE */
325 
326  const char *FS2OTTD(const TCHAR *name);
327  const TCHAR *OTTD2FS(const char *name, bool console_cp = false);
328  #else
329  #define fopen(file, mode) fopen(OTTD2FS(file), mode)
330  const char *FS2OTTD(const char *name);
331  const char *OTTD2FS(const char *name);
332  #endif /* WIN32 */
333 #endif /* STRGEN || SETTINGSGEN */
334 
335 #if defined(WIN32) || defined(WIN64) || defined(__OS2__) && !defined(__INNOTEK_LIBC__)
336  #define PATHSEP "\\"
337  #define PATHSEPCHAR '\\'
338 #else
339  #define PATHSEP "/"
340  #define PATHSEPCHAR '/'
341 #endif
342 
343 /* MSVCRT of course has to have a different syntax for long long *sigh* */
344 #if defined(_MSC_VER) || defined(__MINGW32__)
345  #define OTTD_PRINTF64 "%I64d"
346  #define OTTD_PRINTFHEX64 "%I64x"
347  #define PRINTF_SIZE "%Iu"
348 #else
349  #define OTTD_PRINTF64 "%lld"
350  #define OTTD_PRINTFHEX64 "%llx"
351  #define PRINTF_SIZE "%zu"
352 #endif
353 
354 typedef unsigned char byte;
355 
356 /* This is already defined in unix, but not in QNX Neutrino (6.x)*/
357 #if (!defined(UNIX) && !defined(__CYGWIN__) && !defined(__BEOS__) && !defined(__HAIKU__) && !defined(__MORPHOS__)) || defined(__QNXNTO__)
358  typedef unsigned int uint;
359 #endif
360 
361 #if defined(TROUBLED_INTS)
362  /* NDS'/BeOS'/Haiku's types for uint32/int32 are based on longs, which causes
363  * trouble all over the place in OpenTTD. */
364  #define uint32 uint32_ugly_hack
365  #define int32 int32_ugly_hack
366  typedef unsigned int uint32_ugly_hack;
367  typedef signed int int32_ugly_hack;
368 #else
369  typedef unsigned char uint8;
370  typedef signed char int8;
371  typedef unsigned short uint16;
372  typedef signed short int16;
373  typedef unsigned int uint32;
374  typedef signed int int32;
375  typedef unsigned __int64 uint64;
376  typedef signed __int64 int64;
377 #endif /* !TROUBLED_INTS */
378 
379 #if !defined(WITH_PERSONAL_DIR)
380  #define PERSONAL_DIR ""
381 #endif
382 
383 /* Compile time assertions. Prefer c++0x static_assert().
384  * Older compilers cannot evaluate some expressions at compile time,
385  * typically when templates are involved, try assert_tcompile() in those cases. */
386 #if defined(__STDCXX_VERSION__) || defined(__GXX_EXPERIMENTAL_CXX0X__) || defined(__GXX_EXPERIMENTAL_CPP0X__) || defined(static_assert) || (defined(_MSC_VER) && _MSC_VER >= 1600)
387  /* __STDCXX_VERSION__ is c++0x feature macro, __GXX_EXPERIMENTAL_CXX0X__ is used by gcc, __GXX_EXPERIMENTAL_CPP0X__ by icc */
388  #define assert_compile(expr) static_assert(expr, #expr )
389  #define assert_tcompile(expr) assert_compile(expr)
390 #elif defined(__OS2__)
391  /* Disabled for OS/2 */
392  #define assert_compile(expr)
393  #define assert_tcompile(expr) assert_compile(expr)
394 #else
395  #define assert_compile(expr) typedef int __ct_assert__[1 - 2 * !(expr)]
396  #define assert_tcompile(expr) assert(expr)
397 #endif
398 
399 /* Check if the types have the bitsizes like we are using them */
400 assert_compile(sizeof(uint64) == 8);
401 assert_compile(sizeof(uint32) == 4);
402 assert_compile(sizeof(uint16) == 2);
403 assert_compile(sizeof(uint8) == 1);
404 assert_compile(SIZE_MAX >= UINT32_MAX);
405 
406 #ifndef M_PI_2
407 #define M_PI_2 1.57079632679489661923
408 #define M_PI 3.14159265358979323846
409 #endif /* M_PI_2 */
410 
419 #define lengthof(x) (sizeof(x) / sizeof(x[0]))
420 
427 #define endof(x) (&x[lengthof(x)])
428 
435 #define lastof(x) (&x[lengthof(x) - 1])
436 
437 #define cpp_offsetof(s, m) (((size_t)&reinterpret_cast<const volatile char&>((((s*)(char*)8)->m))) - 8)
438 #if !defined(offsetof)
439  #define offsetof(s, m) cpp_offsetof(s, m)
440 #endif /* offsetof */
441 
448 #define cpp_sizeof(base, variable) (sizeof(((base*)8)->variable))
449 
456 #define cpp_lengthof(base, variable) (cpp_sizeof(base, variable) / cpp_sizeof(base, variable[0]))
457 
458 
459 /* take care of some name clashes on MacOS */
460 #if defined(__APPLE__)
461  #define GetString OTTD_GetString
462  #define DrawString OTTD_DrawString
463  #define CloseConnection OTTD_CloseConnection
464 #endif /* __APPLE__ */
465 
466 void NORETURN CDECL usererror(const char *str, ...) WARN_FORMAT(1, 2);
467 void NORETURN CDECL error(const char *str, ...) WARN_FORMAT(1, 2);
468 #define NOT_REACHED() error("NOT_REACHED triggered at line %i of %s", __LINE__, __FILE__)
469 
470 /* For non-debug builds with assertions enabled use the special assertion handler:
471  * - For MSVC: NDEBUG is set for all release builds and WITH_ASSERT overrides the disabling of asserts.
472  * - For non MSVC: NDEBUG is set when assertions are disables, _DEBUG is set for non-release builds.
473  */
474 #if (defined(_MSC_VER) && defined(NDEBUG) && defined(WITH_ASSERT)) || (!defined(_MSC_VER) && !defined(NDEBUG) && !defined(_DEBUG))
475  #undef assert
476  #define assert(expression) if (!(expression)) error("Assertion failed at line %i of %s: %s", __LINE__, __FILE__, #expression);
477 #endif
478 
479 /* Asserts are enabled if NDEBUG isn't defined, or if we are using MSVC and WITH_ASSERT is defined. */
480 #if !defined(NDEBUG) || (defined(_MSC_VER) && defined(WITH_ASSERT))
481  #define OTTD_ASSERT
482 #endif
483 
484 #if defined(MORPHOS) || defined(__NDS__) || defined(__DJGPP__)
485  /* MorphOS and NDS don't have C++ conformant _stricmp... */
486  #define _stricmp stricmp
487 #elif defined(OPENBSD)
488  /* OpenBSD uses strcasecmp(3) */
489  #define _stricmp strcasecmp
490 #endif
491 
492 #if defined(MAX_PATH)
493  /* It's already defined, no need to override */
494 #elif defined(PATH_MAX) && PATH_MAX > 0
495  /* Use the value from PATH_MAX, if it exists */
496  #define MAX_PATH PATH_MAX
497 #else
498  /* If all else fails, hardcode something :( */
499  #define MAX_PATH 260
500 #endif
501 
506 static inline void free(const void *ptr)
507 {
508  free(const_cast<void *>(ptr));
509 }
510 
515 #define MAX_UVALUE(type) ((type)~(type)0)
516 
517 #if defined(_MSC_VER) && !defined(_DEBUG)
518  #define IGNORE_UNINITIALIZED_WARNING_START __pragma(warning(push)) __pragma(warning(disable:4700))
519  #define IGNORE_UNINITIALIZED_WARNING_STOP __pragma(warning(pop))
520 #elif defined(__GNUC__) && !defined(_DEBUG)
521  #define HELPER0(x) #x
522  #define HELPER1(x) HELPER0(GCC diagnostic ignored x)
523  #define HELPER2(y) HELPER1(#y)
524 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
525  #define IGNORE_UNINITIALIZED_WARNING_START \
526  _Pragma("GCC diagnostic push") \
527  _Pragma(HELPER2(-Wuninitialized)) \
528  _Pragma(HELPER2(-Wmaybe-uninitialized))
529  #define IGNORE_UNINITIALIZED_WARNING_STOP _Pragma("GCC diagnostic pop")
530 #endif
531 #endif
532 
533 #ifndef IGNORE_UNINITIALIZED_WARNING_START
534  #define IGNORE_UNINITIALIZED_WARNING_START
535  #define IGNORE_UNINITIALIZED_WARNING_STOP
536 #endif
537 
538 #endif /* STDAFX_H */
const char * FS2OTTD(const TCHAR *name)
Convert to OpenTTD&#39;s encoding from that of the local environment.
Definition: win32.cpp:613
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:506
void CDECL usererror(const char *s,...)
Error handling for fatal user errors.
Definition: openttd.cpp:90
const TCHAR * OTTD2FS(const char *name, bool console_cp)
Convert from OpenTTD&#39;s encoding to that of the local environment.
Definition: win32.cpp:631
OSX is different on some places.