OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

stdafx.h
Go to the documentation of this file.
1 /* $Id: stdafx.h 27109 2015-01-02 19:50:43Z rubidium $ */
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 #endif /* __GNUC__ */
160
161 #if defined(__WATCOMC__)
162 #define NORETURN
163 #define CDECL
164 #define GCC_PACK
165 #define WARN_FORMAT(string, args)
166 #define FINAL
167 #include <malloc.h>
168 #endif /* __WATCOMC__ */
169
170 #if defined(__MINGW32__) || defined(__CYGWIN__)
171 #include <malloc.h> // alloca()
172 #endif
173
174 #if defined(WIN32)
175 #define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers
176 #endif
177
178 /* Stuff for MSVC */
179 #if defined(_MSC_VER)
180 #pragma once
181 #ifdef _WIN64
182 /* No 64-bit Windows below XP, so we can safely assume it as the target platform. */
183 #define NTDDI_VERSION NTDDI_WINXP // Windows XP
184 #define _WIN32_WINNT 0x501 // Windows XP
185 #define _WIN32_WINDOWS 0x501 // Windows XP
186 #define WINVER 0x0501 // Windows XP
187 #define _WIN32_IE_ 0x0600 // 6.0 (XP+)
188 #else
189 /* Define a win32 target platform, to override defaults of the SDK
190 * We need to define NTDDI version for Vista SDK, but win2k is minimum */
191 #define NTDDI_VERSION NTDDI_WIN2K // Windows 2000
192 #define _WIN32_WINNT 0x0500 // Windows 2000
193 #define _WIN32_WINDOWS 0x400 // Windows 95
194 #if !defined(WINCE)
195 #define WINVER 0x0400 // Windows NT 4.0 / Windows 95
196 #endif
197 #define _WIN32_IE_ 0x0401 // 4.01 (win98 and NT4SP5+)
198 #endif
199 #define NOMINMAX // Disable min/max macros in windows.h.
200
201 #pragma warning(disable: 4244) // 'conversion' conversion from 'type1' to 'type2', possible loss of data
202 #pragma warning(disable: 4761) // integral size mismatch in argument : conversion supplied
203 #pragma warning(disable: 4200) // nonstandard extension used : zero-sized array in struct/union
204 #pragma warning(disable: 4355) // 'this' : used in base member initializer list
205
206 #if (_MSC_VER < 1400) // MSVC 2005 safety checks
207 #error "Only MSVC 2005 or higher are supported. MSVC 2003 and earlier are not! Upgrade your compiler."
208 #endif /* (_MSC_VER < 1400) */
209 #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)
210 #pragma warning(disable: 4996) // 'function': was declared deprecated
211 #define _CRT_SECURE_NO_DEPRECATE // all deprecated 'unsafe string functions
212 #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
213 #pragma warning(disable: 6011) // code analyzer: Dereferencing NULL pointer 'pfGetAddrInfo': Lines: 995, 996, 998, 999, 1001
214 #pragma warning(disable: 6326) // code analyzer: potential comparison of a constant with another constant
215 #pragma warning(disable: 6031) // code analyzer: Return value ignored: 'ReadFile'
216 #pragma warning(disable: 6255) // code analyzer: _alloca indicates failure by raising a stack overflow exception. Consider using _malloca instead
217 #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 ...
218
219 #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
220 #define _DO_NOT_DECLARE_INTERLOCKED_INTRINSICS_IN_MEMORY
221 #include <intrin.h>
222 #endif
223
224 #include <malloc.h> // alloca()
225 #define NORETURN __declspec(noreturn)
226 #define inline __forceinline
227
228 #if !defined(WINCE)
229 #define CDECL _cdecl
230 #endif
231
232 #define GCC_PACK
233 #define WARN_FORMAT(string, args)
234 #define FINAL sealed
235
236 #if defined(WINCE)
237 int CDECL vsnprintf(char *str, size_t size, const char *format, va_list ap);
238 #endif
239
240 #if defined(WIN32) && !defined(_WIN64) && !defined(WIN64)
241 #if !defined(_W64)
242 #define _W64
243 #endif
244
245 typedef _W64 int INT_PTR, *PINT_PTR;
246 typedef _W64 unsigned int UINT_PTR, *PUINT_PTR;
247 #endif /* WIN32 && !_WIN64 && !WIN64 */
248
249 #if defined(_WIN64) || defined(WIN64)
250 #define fseek _fseeki64
251 #endif /* _WIN64 || WIN64 */
252
253 /* This is needed to zlib uses the stdcall calling convention on visual studio */
254 #if defined(WITH_ZLIB) || defined(WITH_PNG)
255 #if !defined(ZLIB_WINAPI)
256 #define ZLIB_WINAPI
257 #endif
258 #endif
259
260 #if defined(WINCE)
261 #define strcasecmp _stricmp
262 #define strncasecmp _strnicmp
263 #undef DEBUG
264 #else
265 #define strcasecmp stricmp
266 #define strncasecmp strnicmp
267 #endif
268
269 #define strtoull _strtoui64
270
271 /* MSVC doesn't have these :( */
272 #define S_ISDIR(mode) (mode & S_IFDIR)
273 #define S_ISREG(mode) (mode & S_IFREG)
274
275 #endif /* defined(_MSC_VER) */
276
277 #if defined(DOS)
278 /* The DOS port does not have all signals/signal functions. */
279 #define strsignal(sig) ""
280 /* Use 'no floating point' for bus errors; SIGBUS does not exist
281 * for DOS, SIGNOFP for other platforms. So it's fairly safe
282 * to interchange those. */
283 #define SIGBUS SIGNOFP
284 #endif
285
286 #if defined(WINCE)
287 #define stredup _stredup
288 #endif /* WINCE */
289
290 /* NOTE: the string returned by these functions is only valid until the next
291 * call to the same function and is not thread- or reentrancy-safe */
292 #if !defined(STRGEN) && !defined(SETTINGSGEN)
293 #if defined(WIN32) || defined(WIN64)
294 char *getcwd(char *buf, size_t size);
295 #include <tchar.h>
296 #include <io.h>
297
298 /* XXX - WinCE without MSVCRT doesn't support wfopen, so it seems */
299 #if !defined(WINCE)
300 namespace std { using ::_tfopen; }
301 #define fopen(file, mode) _tfopen(OTTD2FS(file), _T(mode))
302 #define unlink(file) _tunlink(OTTD2FS(file))
303 #endif /* WINCE */
304
305 const char *FS2OTTD(const TCHAR *name);
306 const TCHAR *OTTD2FS(const char *name, bool console_cp = false);
307 #else
308 #define fopen(file, mode) fopen(OTTD2FS(file), mode)
309 const char *FS2OTTD(const char *name);
310 const char *OTTD2FS(const char *name);
311 #endif /* WIN32 */
312 #endif /* STRGEN || SETTINGSGEN */
313
314 #if defined(WIN32) || defined(WIN64) || defined(__OS2__) && !defined(__INNOTEK_LIBC__)
315 #define PATHSEP "\\"
316 #define PATHSEPCHAR '\\'
317 #else
318 #define PATHSEP "/"
319 #define PATHSEPCHAR '/'
320 #endif
321
322 /* MSVCRT of course has to have a different syntax for long long *sigh* */
323 #if defined(_MSC_VER) || defined(__MINGW32__)
324 #define OTTD_PRINTF64 "%I64d"
325 #define OTTD_PRINTFHEX64 "%I64x"
326 #define PRINTF_SIZE "%Iu"
327 #else
328 #define OTTD_PRINTF64 "%lld"
329 #define OTTD_PRINTFHEX64 "%llx"
330 #define PRINTF_SIZE "%zu"
331 #endif
332
333 typedef unsigned char byte;
334
335 /* This is already defined in unix, but not in QNX Neutrino (6.x)*/
336 #if (!defined(UNIX) && !defined(__CYGWIN__) && !defined(__BEOS__) && !defined(__HAIKU__) && !defined(__MORPHOS__)) || defined(__QNXNTO__)
337 typedef unsigned int uint;
338 #endif
339
340 #if defined(TROUBLED_INTS)
341 /* NDS'/BeOS'/Haiku's types for uint32/int32 are based on longs, which causes
342 * trouble all over the place in OpenTTD. */
343 #define uint32 uint32_ugly_hack
344 #define int32 int32_ugly_hack
345 typedef unsigned int uint32_ugly_hack;
346 typedef signed int int32_ugly_hack;
347 #else
348 typedef unsigned char uint8;
349 typedef signed char int8;
350 typedef unsigned short uint16;
351 typedef signed short int16;
352 typedef unsigned int uint32;
353 typedef signed int int32;
354 typedef unsigned __int64 uint64;
355 typedef signed __int64 int64;
356 #endif /* !TROUBLED_INTS */
357
358 #if !defined(WITH_PERSONAL_DIR)
359 #define PERSONAL_DIR ""
360 #endif
361
362 /* Compile time assertions. Prefer c++0x static_assert().
363 * Older compilers cannot evaluate some expressions at compile time,
364 * typically when templates are involved, try assert_tcompile() in those cases. */
365 #if defined(__STDCXX_VERSION__) || defined(__GXX_EXPERIMENTAL_CXX0X__) || defined(__GXX_EXPERIMENTAL_CPP0X__) || defined(static_assert)
366 /* __STDCXX_VERSION__ is c++0x feature macro, __GXX_EXPERIMENTAL_CXX0X__ is used by gcc, __GXX_EXPERIMENTAL_CPP0X__ by icc */
367 #define assert_compile(expr) static_assert(expr, #expr )
368 #define assert_tcompile(expr) assert_compile(expr)
369 #elif defined(__OS2__)
370 /* Disabled for OS/2 */
371 #define assert_compile(expr)
372 #define assert_tcompile(expr) assert_compile(expr)
373 #else
374 #define assert_compile(expr) typedef int __ct_assert__[1 - 2 * !(expr)]
375 #define assert_tcompile(expr) assert(expr)
376 #endif
377
378 /* Check if the types have the bitsizes like we are using them */
379 assert_compile(sizeof(uint64) == 8);
380 assert_compile(sizeof(uint32) == 4);
381 assert_compile(sizeof(uint16) == 2);
382 assert_compile(sizeof(uint8) == 1);
383 assert_compile(SIZE_MAX >= UINT32_MAX);
384
385 #ifndef M_PI_2
386 #define M_PI_2 1.57079632679489661923
387 #define M_PI 3.14159265358979323846
388 #endif /* M_PI_2 */
389
398 #define lengthof(x) (sizeof(x) / sizeof(x[0]))
399
406 #define endof(x) (&x[lengthof(x)])
407
414 #define lastof(x) (&x[lengthof(x) - 1])
415
416 #define cpp_offsetof(s, m) (((size_t)&reinterpret_cast<const volatile char&>((((s*)(char*)8)->m))) - 8)
417 #if !defined(offsetof)
418 #define offsetof(s, m) cpp_offsetof(s, m)
419 #endif /* offsetof */
420
427 #define cpp_sizeof(base, variable) (sizeof(((base*)8)->variable))
428
435 #define cpp_lengthof(base, variable) (cpp_sizeof(base, variable) / cpp_sizeof(base, variable[0]))
436
437
438 /* take care of some name clashes on MacOS */
439 #if defined(__APPLE__)
440 #define GetString OTTD_GetString
441 #define DrawString OTTD_DrawString
442 #define CloseConnection OTTD_CloseConnection
443 #endif /* __APPLE__ */
444
445 void NORETURN CDECL usererror(const char *str, ...) WARN_FORMAT(1, 2);
446 void NORETURN CDECL error(const char *str, ...) WARN_FORMAT(1, 2);
447 #define NOT_REACHED() error("NOT_REACHED triggered at line %i of %s", __LINE__, __FILE__)
448
449 /* For non-debug builds with assertions enabled use the special assertion handler:
450 * - For MSVC: NDEBUG is set for all release builds and WITH_ASSERT overrides the disabling of asserts.
451 * - For non MSVC: NDEBUG is set when assertions are disables, _DEBUG is set for non-release builds.
452 */
453 #if (defined(_MSC_VER) && defined(NDEBUG) && defined(WITH_ASSERT)) || (!defined(_MSC_VER) && !defined(NDEBUG) && !defined(_DEBUG))
454 #undef assert
455 #define assert(expression) if (!(expression)) error("Assertion failed at line %i of %s: %s", __LINE__, __FILE__, #expression);
456 #endif
457
458 /* Asserts are enabled if NDEBUG isn't defined, or if we are using MSVC and WITH_ASSERT is defined. */
459 #if !defined(NDEBUG) || (defined(_MSC_VER) && defined(WITH_ASSERT))
460 #define OTTD_ASSERT
461 #endif
462
463 #if defined(MORPHOS) || defined(__NDS__) || defined(__DJGPP__)
464 /* MorphOS and NDS don't have C++ conformant _stricmp... */
465 #define _stricmp stricmp
466 #elif defined(OPENBSD)
467 /* OpenBSD uses strcasecmp(3) */
468 #define _stricmp strcasecmp
469 #endif
470
471 #if defined(MAX_PATH)
472 /* It's already defined, no need to override */
473 #elif defined(PATH_MAX) && PATH_MAX > 0
474 /* Use the value from PATH_MAX, if it exists */
475 #define MAX_PATH PATH_MAX
476 #else
477 /* If all else fails, hardcode something :( */
478 #define MAX_PATH 260
479 #endif
480
485 static inline void free(const void *ptr)
486 {
487 free(const_cast<void *>(ptr));
488 }
489
494 #define MAX_UVALUE(type) ((type)~(type)0)
495
496 #if defined(_MSC_VER) && !defined(_DEBUG)
497 #define IGNORE_UNINITIALIZED_WARNING_START __pragma(warning(push)) __pragma(warning(disable:4700))
498 #define IGNORE_UNINITIALIZED_WARNING_STOP __pragma(warning(pop))
499 #elif defined(__GNUC__) && !defined(_DEBUG)
500 #define HELPER0(x) #x
501 #define HELPER1(x) HELPER0(GCC diagnostic ignored x)
502 #define HELPER2(y) HELPER1(#y)
503 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
504 #define IGNORE_UNINITIALIZED_WARNING_START \
505 _Pragma("GCC diagnostic push") \
506 _Pragma(HELPER2(-Wuninitialized)) \
507 _Pragma(HELPER2(-Wmaybe-uninitialized))
508 #define IGNORE_UNINITIALIZED_WARNING_STOP _Pragma("GCC diagnostic pop")
509 #endif
510 #endif
511
512 #ifndef IGNORE_UNINITIALIZED_WARNING_START
513 #define IGNORE_UNINITIALIZED_WARNING_START
514 #define IGNORE_UNINITIALIZED_WARNING_STOP
515 #endif
516
517 #endif /* STDAFX_H */