OpenTTD
stdafx.h
Go to the documentation of this file.
1 /* $Id$ */
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(__HAIKU__)
20  #include <SupportDefs.h>
21  #include <unistd.h>
22  #define _GNU_SOURCE
23  #define TROUBLED_INTS
24 #endif
25 
26 #if defined(__HAIKU__) || defined(__CYGWIN__)
27 # include <strings.h> /* strncasecmp */
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.
33  * For OSX the inclusion is already done in osx_stdafx.h. */
34 #if !defined(__APPLE__) && (!defined(_MSC_VER) || _MSC_VER >= 1600)
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 #include <memory>
90 
91 #ifndef SIZE_MAX
92  #define SIZE_MAX ((size_t)-1)
93 #endif
94 
95 #if defined(UNIX) || defined(__MINGW32__)
96  #include <sys/types.h>
97 #endif
98 
99 #if defined(__OS2__)
100  #include <types.h>
101  #define strcasecmp stricmp
102 #endif
103 
104 #if defined(SUNOS) || defined(HPUX) || defined(__CYGWIN__)
105  #include <alloca.h>
106 #endif
107 
108 /* Stuff for GCC */
109 #if defined(__GNUC__)
110  #define NORETURN __attribute__ ((noreturn))
111  #define CDECL
112  #define __int64 long long
113  /* Warn about functions using 'printf' format syntax. First argument determines which parameter
114  * is the format string, second argument is start of values passed to printf. */
115  #define WARN_FORMAT(string, args) __attribute__ ((format (printf, string, args)))
116  #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7)
117  #define FINAL final
118  #else
119  #define FINAL
120  #endif
121 
122  /* Use fallthrough attribute where supported */
123  #if __GNUC__ >= 7
124  #if __cplusplus > 201402L // C++17
125  #define FALLTHROUGH [[fallthrough]]
126  #else
127  #define FALLTHROUGH __attribute__((fallthrough))
128  #endif
129  #else
130  #define FALLTHROUGH
131  #endif
132 #endif /* __GNUC__ */
133 
134 #if defined(__WATCOMC__)
135  #define NORETURN
136  #define CDECL
137  #define WARN_FORMAT(string, args)
138  #define FINAL
139  #define FALLTHROUGH
140  #include <malloc.h>
141 #endif /* __WATCOMC__ */
142 
143 #if defined(__MINGW32__)
144  #include <malloc.h> // alloca()
145 #endif
146 
147 #if defined(_WIN32)
148  #define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers
149 #endif
150 
151 /* Stuff for MSVC */
152 #if defined(_MSC_VER)
153  #pragma once
154  #ifdef _WIN64
155  /* No 64-bit Windows below XP, so we can safely assume it as the target platform. */
156  #define NTDDI_VERSION NTDDI_WINXP // Windows XP
157  #define _WIN32_WINNT 0x501 // Windows XP
158  #define _WIN32_WINDOWS 0x501 // Windows XP
159  #define WINVER 0x0501 // Windows XP
160  #define _WIN32_IE_ 0x0600 // 6.0 (XP+)
161  #else
162  /* Define a win32 target platform, to override defaults of the SDK
163  * We need to define NTDDI version for Vista SDK, but win2k is minimum */
164  #define NTDDI_VERSION NTDDI_WIN2K // Windows 2000
165  #define _WIN32_WINNT 0x0500 // Windows 2000
166  #define _WIN32_WINDOWS 0x400 // Windows 95
167  #define WINVER 0x0400 // Windows NT 4.0 / Windows 95
168  #define _WIN32_IE_ 0x0401 // 4.01 (win98 and NT4SP5+)
169  #endif
170  #define NOMINMAX // Disable min/max macros in windows.h.
171 
172  #pragma warning(disable: 4244) // 'conversion' conversion from 'type1' to 'type2', possible loss of data
173  #pragma warning(disable: 4761) // integral size mismatch in argument : conversion supplied
174  #pragma warning(disable: 4200) // nonstandard extension used : zero-sized array in struct/union
175  #pragma warning(disable: 4355) // 'this' : used in base member initializer list
176 
177  #if (_MSC_VER < 1400) // MSVC 2005 safety checks
178  #error "Only MSVC 2005 or higher are supported. MSVC 2003 and earlier are not! Upgrade your compiler."
179  #endif /* (_MSC_VER < 1400) */
180  #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)
181  #pragma warning(disable: 4996) // 'function': was declared deprecated
182  #define _CRT_SECURE_NO_DEPRECATE // all deprecated 'unsafe string functions
183  #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
184  #pragma warning(disable: 6011) // code analyzer: Dereferencing NULL pointer 'pfGetAddrInfo': Lines: 995, 996, 998, 999, 1001
185  #pragma warning(disable: 6326) // code analyzer: potential comparison of a constant with another constant
186  #pragma warning(disable: 6031) // code analyzer: Return value ignored: 'ReadFile'
187  #pragma warning(disable: 6255) // code analyzer: _alloca indicates failure by raising a stack overflow exception. Consider using _malloca instead
188  #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 ...
189 
190  #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
191  #define _DO_NOT_DECLARE_INTERLOCKED_INTRINSICS_IN_MEMORY
192  #include <intrin.h>
193  #endif
194 
195  #include <malloc.h> // alloca()
196  #define NORETURN __declspec(noreturn)
197  #if (_MSC_VER < 1900)
198  #define inline __forceinline
199  #endif
200 
201  #define CDECL _cdecl
202  #define WARN_FORMAT(string, args)
203  #define FINAL sealed
204 
205  /* fallthrough attribute, VS 2017 */
206  #if (_MSC_VER >= 1910)
207  #define FALLTHROUGH [[fallthrough]]
208  #else
209  #define FALLTHROUGH
210  #endif
211 
212 # if defined(_WIN32) && !defined(_WIN64)
213  #if !defined(_W64)
214  #define _W64
215  #endif
216 
217  typedef _W64 int INT_PTR, *PINT_PTR;
218  typedef _W64 unsigned int UINT_PTR, *PUINT_PTR;
219 # endif /* _WIN32 && !_WIN64 */
220 
221 # if defined(_WIN64)
222  #define fseek _fseeki64
223 # endif /* _WIN64 */
224 
225  /* zlib from vcpkg use cdecl calling convention without enforcing it in the headers */
226 # if defined(WITH_ZLIB)
227 # if !defined(ZEXPORT)
228 # define ZEXPORT CDECL
229 # endif
230 # endif
231 
232  /* freetype from vcpkg use cdecl calling convention without enforcing it in the headers */
233 # if defined(WITH_FREETYPE)
234 # if !defined(FT_EXPORT)
235 # define FT_EXPORT( x ) extern "C" x CDECL
236 # endif
237 # endif
238 
239  /* liblzma from vcpkg (before 5.2.4-2) used to patch lzma.h to define LZMA_API_STATIC for static builds */
240 # if defined(WITH_LIBLZMA)
241 # if !defined(LZMA_API_STATIC)
242 # define LZMA_API_STATIC
243 # endif
244 # endif
245 
246  #define strcasecmp stricmp
247  #define strncasecmp strnicmp
248  #define strtoull _strtoui64
249 
250  /* MSVC doesn't have these :( */
251  #define S_ISDIR(mode) (mode & S_IFDIR)
252  #define S_ISREG(mode) (mode & S_IFREG)
253 
254 #endif /* defined(_MSC_VER) */
255 
256 /* NOTE: the string returned by these functions is only valid until the next
257  * call to the same function and is not thread- or reentrancy-safe */
258 #if !defined(STRGEN) && !defined(SETTINGSGEN)
259 # if defined(_WIN32)
260  char *getcwd(char *buf, size_t size);
261  #include <tchar.h>
262  #include <io.h>
263 
264  namespace std { using ::_tfopen; }
265  #define fopen(file, mode) _tfopen(OTTD2FS(file), _T(mode))
266  #define unlink(file) _tunlink(OTTD2FS(file))
267 
268  const char *FS2OTTD(const TCHAR *name);
269  const TCHAR *OTTD2FS(const char *name, bool console_cp = false);
270 # else
271  #define fopen(file, mode) fopen(OTTD2FS(file), mode)
272  const char *FS2OTTD(const char *name);
273  const char *OTTD2FS(const char *name);
274 # endif /* _WIN32 */
275 #endif /* STRGEN || SETTINGSGEN */
276 
277 #if defined(_WIN32) || defined(__OS2__) && !defined(__INNOTEK_LIBC__)
278  #define PATHSEP "\\"
279  #define PATHSEPCHAR '\\'
280 #else
281  #define PATHSEP "/"
282  #define PATHSEPCHAR '/'
283 #endif
284 
285 #if defined(_MSC_VER) || defined(__WATCOMC__)
286 # define PACK_N(type_dec, n) __pragma(pack(push, n)) type_dec; __pragma(pack(pop))
287 #elif defined(__MINGW32__)
288 # define PRAGMA(x) _Pragma(#x)
289 # define PACK_N(type_dec, n) PRAGMA(pack(push, n)) type_dec; PRAGMA(pack(pop))
290 #else
291 # define PACK_N(type_dec, n) type_dec __attribute__((__packed__, aligned(n)))
292 #endif
293 #define PACK(type_dec) PACK_N(type_dec, 1)
294 
295 /* MSVCRT of course has to have a different syntax for long long *sigh* */
296 #if defined(_MSC_VER) || defined(__MINGW32__)
297 # define OTTD_PRINTF64 "%I64d"
298 # define OTTD_PRINTFHEX64 "%I64x"
299 # define PRINTF_SIZE "%Iu"
300 # define PRINTF_SIZEX "%IX"
301 #else
302 # define OTTD_PRINTF64 "%lld"
303 # define OTTD_PRINTFHEX64 "%llx"
304 # define PRINTF_SIZE "%zu"
305 # define PRINTF_SIZEX "%zX"
306 #endif
307 
308 typedef unsigned char byte;
309 
310 /* This is already defined in unix, but not in QNX Neutrino (6.x)*/
311 #if (!defined(UNIX) && !defined(__HAIKU__)) || defined(__QNXNTO__)
312  typedef unsigned int uint;
313 #endif
314 
315 #if defined(TROUBLED_INTS)
316  /* Haiku's types for uint32/int32/uint64/int64 are different than what
317  * they are on other platforms; not in length, but how to print them.
318  * So make them more like the other platforms, to make printf() etc a
319  * little bit easier. */
320 # define uint32 uint32_ugly_hack
321 # define int32 int32_ugly_hack
322 # define uint64 uint64_ugly_hack
323 # define int64 int64_ugly_hack
324  typedef unsigned int uint32_ugly_hack;
325  typedef signed int int32_ugly_hack;
326  typedef unsigned __int64 uint64_ugly_hack;
327  typedef signed __int64 int64_ugly_hack;
328 #else
329  typedef unsigned char uint8;
330  typedef signed char int8;
331  typedef unsigned short uint16;
332  typedef signed short int16;
333  typedef unsigned int uint32;
334  typedef signed int int32;
335  typedef unsigned __int64 uint64;
336  typedef signed __int64 int64;
337 #endif /* !TROUBLED_INTS */
338 
339 #if !defined(WITH_PERSONAL_DIR)
340  #define PERSONAL_DIR ""
341 #endif
342 
343 /* Compile time assertions. Prefer c++0x static_assert().
344  * Older compilers cannot evaluate some expressions at compile time,
345  * typically when templates are involved, try assert_tcompile() in those cases. */
346 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1600)
347  #define assert_compile(expr) static_assert(expr, #expr )
348  #define assert_tcompile(expr) assert_compile(expr)
349 #elif defined(__OS2__)
350  /* Disabled for OS/2 */
351  #define assert_compile(expr)
352  #define assert_tcompile(expr) assert_compile(expr)
353 #else
354  #define assert_compile(expr) typedef int __ct_assert__[1 - 2 * !(expr)]
355  #define assert_tcompile(expr) assert(expr)
356 #endif
357 
358 /* Check if the types have the bitsizes like we are using them */
359 assert_compile(sizeof(uint64) == 8);
360 assert_compile(sizeof(uint32) == 4);
361 assert_compile(sizeof(uint16) == 2);
362 assert_compile(sizeof(uint8) == 1);
363 assert_compile(SIZE_MAX >= UINT32_MAX);
364 
365 #ifndef M_PI_2
366 #define M_PI_2 1.57079632679489661923
367 #define M_PI 3.14159265358979323846
368 #endif /* M_PI_2 */
369 
378 #define lengthof(x) (sizeof(x) / sizeof(x[0]))
379 
386 #define endof(x) (&x[lengthof(x)])
387 
394 #define lastof(x) (&x[lengthof(x) - 1])
395 
396 #define cpp_offsetof(s, m) (((size_t)&reinterpret_cast<const volatile char&>((((s*)(char*)8)->m))) - 8)
397 #if !defined(offsetof)
398  #define offsetof(s, m) cpp_offsetof(s, m)
399 #endif /* offsetof */
400 
407 #define cpp_sizeof(base, variable) (sizeof(((base*)8)->variable))
408 
415 #define cpp_lengthof(base, variable) (cpp_sizeof(base, variable) / cpp_sizeof(base, variable[0]))
416 
417 
418 /* take care of some name clashes on MacOS */
419 #if defined(__APPLE__)
420  #define GetString OTTD_GetString
421  #define DrawString OTTD_DrawString
422  #define CloseConnection OTTD_CloseConnection
423 #endif /* __APPLE__ */
424 
425 void NORETURN CDECL usererror(const char *str, ...) WARN_FORMAT(1, 2);
426 void NORETURN CDECL error(const char *str, ...) WARN_FORMAT(1, 2);
427 #define NOT_REACHED() error("NOT_REACHED triggered at line %i of %s", __LINE__, __FILE__)
428 
429 /* For non-debug builds with assertions enabled use the special assertion handler:
430  * - For MSVC: NDEBUG is set for all release builds and WITH_ASSERT overrides the disabling of asserts.
431  * - For non MSVC: NDEBUG is set when assertions are disables, _DEBUG is set for non-release builds.
432  */
433 #if (defined(_MSC_VER) && defined(NDEBUG) && defined(WITH_ASSERT)) || (!defined(_MSC_VER) && !defined(NDEBUG) && !defined(_DEBUG))
434  #undef assert
435  #define assert(expression) if (!(expression)) error("Assertion failed at line %i of %s: %s", __LINE__, __FILE__, #expression);
436 #endif
437 
438 /* Asserts are enabled if NDEBUG isn't defined, or if we are using MSVC and WITH_ASSERT is defined. */
439 #if !defined(NDEBUG) || (defined(_MSC_VER) && defined(WITH_ASSERT))
440  #define OTTD_ASSERT
441 #endif
442 
443 #if defined(OPENBSD)
444  /* OpenBSD uses strcasecmp(3) */
445  #define _stricmp strcasecmp
446 #endif
447 
448 #if defined(MAX_PATH)
449  /* It's already defined, no need to override */
450 #elif defined(PATH_MAX) && PATH_MAX > 0
451  /* Use the value from PATH_MAX, if it exists */
452  #define MAX_PATH PATH_MAX
453 #else
454  /* If all else fails, hardcode something :( */
455  #define MAX_PATH 260
456 #endif
457 
462 static inline void free(const void *ptr)
463 {
464  free(const_cast<void *>(ptr));
465 }
466 
471 #define MAX_UVALUE(type) ((type)~(type)0)
472 
473 #if defined(_MSC_VER) && !defined(_DEBUG)
474  #define IGNORE_UNINITIALIZED_WARNING_START __pragma(warning(push)) __pragma(warning(disable:4700))
475  #define IGNORE_UNINITIALIZED_WARNING_STOP __pragma(warning(pop))
476 #elif defined(__GNUC__) && !defined(_DEBUG)
477  #define HELPER0(x) #x
478  #define HELPER1(x) HELPER0(GCC diagnostic ignored x)
479  #define HELPER2(y) HELPER1(#y)
480 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
481  #define IGNORE_UNINITIALIZED_WARNING_START \
482  _Pragma("GCC diagnostic push") \
483  _Pragma(HELPER2(-Wuninitialized)) \
484  _Pragma(HELPER2(-Wmaybe-uninitialized))
485  #define IGNORE_UNINITIALIZED_WARNING_STOP _Pragma("GCC diagnostic pop")
486 #endif
487 #endif
488 
489 #ifndef IGNORE_UNINITIALIZED_WARNING_START
490  #define IGNORE_UNINITIALIZED_WARNING_START
491  #define IGNORE_UNINITIALIZED_WARNING_STOP
492 #endif
493 
494 #endif /* STDAFX_H */
const char * FS2OTTD(const TCHAR *name)
Convert to OpenTTD&#39;s encoding from that of the local environment.
Definition: win32.cpp:560
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:462
void CDECL usererror(const char *s,...)
Error handling for fatal user errors.
Definition: openttd.cpp:94
const TCHAR * OTTD2FS(const char *name, bool console_cp)
Convert from OpenTTD&#39;s encoding to that of the local environment.
Definition: win32.cpp:578
OSX is different on some places.