OpenTTD Source  1.11.1
stdafx.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #ifndef STDAFX_H
11 #define STDAFX_H
12 
13 #ifdef _MSC_VER
14  /* Stop Microsoft (and clang-cl) compilers from complaining about potentially-unsafe/potentially-non-standard functions */
15 # define _CRT_SECURE_NO_DEPRECATE
16 # define _CRT_SECURE_NO_WARNINGS
17 # define _CRT_NONSTDC_NO_WARNINGS
18 #endif
19 
20 #if defined(__APPLE__)
21 # include "os/macosx/osx_stdafx.h"
22 #endif /* __APPLE__ */
23 
24 #if defined(__HAIKU__)
25 # include <SupportDefs.h>
26 # include <unistd.h>
27 # define _GNU_SOURCE
28 # define TROUBLED_INTS
29 #endif
30 
31 #if defined(__HAIKU__) || defined(__CYGWIN__)
32 # include <strings.h> /* strncasecmp */
33 #endif
34 
35 /* It seems that we need to include stdint.h before anything else
36  * We need INT64_MAX, which for most systems comes from stdint.h. However, MSVC
37  * does not have stdint.h.
38  * For OSX the inclusion is already done in osx_stdafx.h. */
39 #if !defined(__APPLE__) && (!defined(_MSC_VER) || _MSC_VER >= 1600)
40 # if defined(SUNOS)
41  /* SunOS/Solaris does not have stdint.h, but inttypes.h defines everything
42  * stdint.h defines and we need. */
43 # include <inttypes.h>
44 # else
45 # define __STDC_LIMIT_MACROS
46 # include <stdint.h>
47 # endif
48 #endif
49 
50 /* The conditions for these constants to be available are way too messy; so check them one by one */
51 #if !defined(UINT64_MAX)
52 # define UINT64_MAX (18446744073709551615ULL)
53 #endif
54 #if !defined(INT64_MAX)
55 # define INT64_MAX (9223372036854775807LL)
56 #endif
57 #if !defined(INT64_MIN)
58 # define INT64_MIN (-INT64_MAX - 1)
59 #endif
60 #if !defined(UINT32_MAX)
61 # define UINT32_MAX (4294967295U)
62 #endif
63 #if !defined(INT32_MAX)
64 # define INT32_MAX (2147483647)
65 #endif
66 #if !defined(INT32_MIN)
67 # define INT32_MIN (-INT32_MAX - 1)
68 #endif
69 #if !defined(UINT16_MAX)
70 # define UINT16_MAX (65535U)
71 #endif
72 #if !defined(INT16_MAX)
73 # define INT16_MAX (32767)
74 #endif
75 #if !defined(INT16_MIN)
76 # define INT16_MIN (-INT16_MAX - 1)
77 #endif
78 #if !defined(UINT8_MAX)
79 # define UINT8_MAX (255)
80 #endif
81 #if !defined(INT8_MAX)
82 # define INT8_MAX (127)
83 #endif
84 #if !defined(INT8_MIN)
85 # define INT8_MIN (-INT8_MAX - 1)
86 #endif
87 
88 #include <algorithm>
89 #include <cstdio>
90 #include <cstddef>
91 #include <cstring>
92 #include <cstdlib>
93 #include <climits>
94 #include <cassert>
95 #include <memory>
96 
97 #ifndef SIZE_MAX
98 # define SIZE_MAX ((size_t)-1)
99 #endif
100 
101 #if defined(UNIX) || defined(__MINGW32__)
102 # include <sys/types.h>
103 #endif
104 
105 #if defined(__OS2__)
106 # include <types.h>
107 # define strcasecmp stricmp
108 #endif
109 
110 #if defined(SUNOS) || defined(HPUX) || defined(__CYGWIN__)
111 # include <alloca.h>
112 #endif
113 
114 /* Stuff for GCC */
115 #if defined(__GNUC__) || (defined(__clang__) && !defined(_MSC_VER))
116 # define NORETURN __attribute__ ((noreturn))
117 # define CDECL
118 # define __int64 long long
119  /* Warn about functions using 'printf' format syntax. First argument determines which parameter
120  * is the format string, second argument is start of values passed to printf. */
121 # define WARN_FORMAT(string, args) __attribute__ ((format (printf, string, args)))
122 # if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7)
123 # define FINAL final
124 # else
125 # define FINAL
126 # endif
127 
128  /* Use fallthrough attribute where supported */
129 # if __GNUC__ >= 7
130 # if __cplusplus > 201402L // C++17
131 # define FALLTHROUGH [[fallthrough]]
132 # else
133 # define FALLTHROUGH __attribute__((fallthrough))
134 # endif
135 # else
136 # define FALLTHROUGH
137 # endif
138 #endif /* __GNUC__ || __clang__ */
139 
140 #if defined(__WATCOMC__)
141 # define NORETURN
142 # define CDECL
143 # define WARN_FORMAT(string, args)
144 # define FINAL
145 # define FALLTHROUGH
146 # include <malloc.h>
147 #endif /* __WATCOMC__ */
148 
149 #if defined(__MINGW32__)
150 # include <malloc.h> // alloca()
151 #endif
152 
153 #if defined(_WIN32)
154 # define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers
155 #endif
156 
157 /* Stuff for MSVC */
158 #if defined(_MSC_VER)
159 # pragma once
160 # define NTDDI_VERSION NTDDI_WINXP // Windows XP
161 # define _WIN32_WINNT 0x501 // Windows XP
162 # define _WIN32_WINDOWS 0x501 // Windows XP
163 # define WINVER 0x0501 // Windows XP
164 # define _WIN32_IE_ 0x0600 // 6.0 (XP+)
165 
166 # define NOMINMAX // Disable min/max macros in windows.h.
167 
168 # pragma warning(disable: 4244) // 'conversion' conversion from 'type1' to 'type2', possible loss of data
169 # pragma warning(disable: 4761) // integral size mismatch in argument : conversion supplied
170 # pragma warning(disable: 4200) // nonstandard extension used : zero-sized array in struct/union
171 # pragma warning(disable: 4355) // 'this' : used in base member initializer list
172 
173 # if (_MSC_VER < 1400) // MSVC 2005 safety checks
174 # error "Only MSVC 2005 or higher are supported. MSVC 2003 and earlier are not! Upgrade your compiler."
175 # endif /* (_MSC_VER < 1400) */
176 # 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)
177 # pragma warning(disable: 4996) // 'function': was declared deprecated
178 # 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
179 # pragma warning(disable: 6011) // code analyzer: Dereferencing NULL pointer 'pfGetAddrInfo': Lines: 995, 996, 998, 999, 1001
180 # pragma warning(disable: 6326) // code analyzer: potential comparison of a constant with another constant
181 # pragma warning(disable: 6031) // code analyzer: Return value ignored: 'ReadFile'
182 # pragma warning(disable: 6255) // code analyzer: _alloca indicates failure by raising a stack overflow exception. Consider using _malloca instead
183 # 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 ...
184 
185 # 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
186 # define _DO_NOT_DECLARE_INTERLOCKED_INTRINSICS_IN_MEMORY
187 # include <intrin.h>
188 # endif
189 
190 # include <malloc.h> // alloca()
191 # define NORETURN __declspec(noreturn)
192 # if (_MSC_VER < 1900)
193 # define inline __forceinline
194 # endif
195 
196 # define CDECL _cdecl
197 # define WARN_FORMAT(string, args)
198 # define FINAL final
199 
200  /* fallthrough attribute, VS 2017 */
201 # if (_MSC_VER >= 1910) || defined(__clang__)
202 # define FALLTHROUGH [[fallthrough]]
203 # else
204 # define FALLTHROUGH
205 # endif
206 
207 # if defined(_WIN32) && !defined(_WIN64)
208 # if !defined(_W64)
209 # define _W64
210 # endif
211 
212  typedef _W64 int INT_PTR, *PINT_PTR;
213  typedef _W64 unsigned int UINT_PTR, *PUINT_PTR;
214 # endif /* _WIN32 && !_WIN64 */
215 
216 # if defined(_WIN64)
217 # define fseek _fseeki64
218 # endif /* _WIN64 */
219 
220  /* zlib from vcpkg use cdecl calling convention without enforcing it in the headers */
221 # if defined(WITH_ZLIB)
222 # if !defined(ZEXPORT)
223 # define ZEXPORT CDECL
224 # endif
225 # endif
226 
227  /* freetype from vcpkg use cdecl calling convention without enforcing it in the headers */
228 # if defined(WITH_FREETYPE)
229 # if !defined(FT_EXPORT)
230 # define FT_EXPORT( x ) extern "C" x CDECL
231 # endif
232 # endif
233 
234  /* liblzma from vcpkg (before 5.2.4-2) used to patch lzma.h to define LZMA_API_STATIC for static builds */
235 # if defined(WITH_LIBLZMA)
236 # if !defined(LZMA_API_STATIC)
237 # define LZMA_API_STATIC
238 # endif
239 # endif
240 
241 # define strcasecmp stricmp
242 # define strncasecmp strnicmp
243 # define strtoull _strtoui64
244 
245  /* MSVC doesn't have these :( */
246 # define S_ISDIR(mode) (mode & S_IFDIR)
247 # define S_ISREG(mode) (mode & S_IFREG)
248 
249 #endif /* defined(_MSC_VER) */
250 
251 /* NOTE: the string returned by these functions is only valid until the next
252  * call to the same function and is not thread- or reentrancy-safe */
253 #if !defined(STRGEN) && !defined(SETTINGSGEN)
254 # if defined(_WIN32)
255  char *getcwd(char *buf, size_t size);
256 # include <tchar.h>
257 # include <io.h>
258 
259  namespace std { using ::_wfopen; }
260 # define fopen(file, mode) _wfopen(OTTD2FS(file), _T(mode))
261 # define unlink(file) _wunlink(OTTD2FS(file))
262 
263  const char *FS2OTTD(const wchar_t *name);
264  const wchar_t *OTTD2FS(const char *name, bool console_cp = false);
265 # else
266 # define fopen(file, mode) fopen(OTTD2FS(file), mode)
267  const char *FS2OTTD(const char *name);
268  const char *OTTD2FS(const char *name);
269 # endif /* _WIN32 */
270 #endif /* STRGEN || SETTINGSGEN */
271 
272 #if defined(_WIN32) || defined(__OS2__) && !defined(__INNOTEK_LIBC__)
273 # define PATHSEP "\\"
274 # define PATHSEPCHAR '\\'
275 #else
276 # define PATHSEP "/"
277 # define PATHSEPCHAR '/'
278 #endif
279 
280 #if defined(_MSC_VER) || defined(__WATCOMC__)
281 # define PACK_N(type_dec, n) __pragma(pack(push, n)) type_dec; __pragma(pack(pop))
282 #elif defined(__MINGW32__)
283 # define PRAGMA(x) _Pragma(#x)
284 # define PACK_N(type_dec, n) PRAGMA(pack(push, n)) type_dec; PRAGMA(pack(pop))
285 #else
286 # define PACK_N(type_dec, n) type_dec __attribute__((__packed__, aligned(n)))
287 #endif
288 #define PACK(type_dec) PACK_N(type_dec, 1)
289 
290 /* MSVCRT of course has to have a different syntax for long long *sigh* */
291 #if defined(_MSC_VER) || defined(__MINGW32__)
292 # define OTTD_PRINTF64 "%I64d"
293 # define OTTD_PRINTFHEX64 "%I64x"
294 # define PRINTF_SIZE "%Iu"
295 # define PRINTF_SIZEX "%IX"
296 #else
297 # define OTTD_PRINTF64 "%lld"
298 # define OTTD_PRINTFHEX64 "%llx"
299 # define PRINTF_SIZE "%zu"
300 # define PRINTF_SIZEX "%zX"
301 #endif
302 
303 typedef unsigned char byte;
304 
305 /* This is already defined in unix, but not in QNX Neutrino (6.x) or Cygwin. */
306 #if (!defined(UNIX) && !defined(__HAIKU__)) || defined(__QNXNTO__) || defined(__CYGWIN__)
307  typedef unsigned int uint;
308 #endif
309 
310 #if defined(TROUBLED_INTS)
311  /* Haiku's types for uint32/int32/uint64/int64 are different than what
312  * they are on other platforms; not in length, but how to print them.
313  * So make them more like the other platforms, to make printf() etc a
314  * little bit easier. */
315 # define uint32 uint32_ugly_hack
316 # define int32 int32_ugly_hack
317 # define uint64 uint64_ugly_hack
318 # define int64 int64_ugly_hack
319  typedef unsigned int uint32_ugly_hack;
320  typedef signed int int32_ugly_hack;
321  typedef unsigned __int64 uint64_ugly_hack;
322  typedef signed __int64 int64_ugly_hack;
323 #else
324  typedef unsigned char uint8;
325  typedef signed char int8;
326  typedef unsigned short uint16;
327  typedef signed short int16;
328  typedef unsigned int uint32;
329  typedef signed int int32;
330  typedef unsigned __int64 uint64;
331  typedef signed __int64 int64;
332 #endif /* !TROUBLED_INTS */
333 
334 #if !defined(WITH_PERSONAL_DIR)
335 # define PERSONAL_DIR ""
336 #endif
337 
338 /* Define the the platforms that use XDG */
339 #if defined(WITH_PERSONAL_DIR) && defined(UNIX) && !defined(__APPLE__)
340 # define USE_XDG
341 #endif
342 
343 /* Check if the types have the bitsizes like we are using them */
344 static_assert(sizeof(uint64) == 8);
345 static_assert(sizeof(uint32) == 4);
346 static_assert(sizeof(uint16) == 2);
347 static_assert(sizeof(uint8) == 1);
348 static_assert(SIZE_MAX >= UINT32_MAX);
349 
350 #ifndef M_PI_2
351 #define M_PI_2 1.57079632679489661923
352 #define M_PI 3.14159265358979323846
353 #endif /* M_PI_2 */
354 
363 #define lengthof(x) (sizeof(x) / sizeof(x[0]))
364 
371 #define endof(x) (&x[lengthof(x)])
372 
379 #define lastof(x) (&x[lengthof(x) - 1])
380 
387 #define cpp_sizeof(base, variable) (sizeof(std::declval<base>().variable))
388 
395 #define cpp_lengthof(base, variable) (cpp_sizeof(base, variable) / cpp_sizeof(base, variable[0]))
396 
397 
398 /* take care of some name clashes on MacOS */
399 #if defined(__APPLE__)
400 # define GetString OTTD_GetString
401 # define DrawString OTTD_DrawString
402 # define CloseConnection OTTD_CloseConnection
403 #endif /* __APPLE__ */
404 
405 #if defined(__GNUC__) || defined(__clang__)
406 # define likely(x) __builtin_expect(!!(x), 1)
407 # define unlikely(x) __builtin_expect(!!(x), 0)
408 #else
409 # define likely(x) (x)
410 # define unlikely(x) (x)
411 #endif /* __GNUC__ || __clang__ */
412 
413 void NORETURN CDECL usererror(const char *str, ...) WARN_FORMAT(1, 2);
414 void NORETURN CDECL error(const char *str, ...) WARN_FORMAT(1, 2);
415 #define NOT_REACHED() error("NOT_REACHED triggered at line %i of %s", __LINE__, __FILE__)
416 
417 /* For non-debug builds with assertions enabled use the special assertion handler. */
418 #if defined(NDEBUG) && defined(WITH_ASSERT)
419 # undef assert
420 # define assert(expression) if (unlikely(!(expression))) error("Assertion failed at line %i of %s: %s", __LINE__, __FILE__, #expression);
421 #endif
422 
423 /* Asserts are enabled if NDEBUG isn't defined or WITH_ASSERT is defined. */
424 #if !defined(NDEBUG) || defined(WITH_ASSERT)
425 # define OTTD_ASSERT
426 # define assert_msg(expression, msg, ...) if (unlikely(!(expression))) error("Assertion failed at line %i of %s: %s\n\t" msg, __LINE__, __FILE__, #expression, __VA_ARGS__);
427 #else
428 # define assert_msg(expression, msg, ...)
429 #endif
430 
431 #if defined(OPENBSD)
432  /* OpenBSD uses strcasecmp(3) */
433 # define _stricmp strcasecmp
434 #endif
435 
436 #if defined(MAX_PATH)
437  /* It's already defined, no need to override */
438 #elif defined(PATH_MAX) && PATH_MAX > 0
439  /* Use the value from PATH_MAX, if it exists */
440 # define MAX_PATH PATH_MAX
441 #else
442  /* If all else fails, hardcode something :( */
443 # define MAX_PATH 260
444 #endif
445 
450 static inline void free(const void *ptr)
451 {
452  free(const_cast<void *>(ptr));
453 }
454 
459 #define MAX_UVALUE(type) ((type)~(type)0)
460 
461 #if defined(_MSC_VER) && !defined(_DEBUG)
462 # define IGNORE_UNINITIALIZED_WARNING_START __pragma(warning(push)) __pragma(warning(disable:4700))
463 # define IGNORE_UNINITIALIZED_WARNING_STOP __pragma(warning(pop))
464 #elif defined(__GNUC__) && !defined(_DEBUG)
465 # define HELPER0(x) #x
466 # define HELPER1(x) HELPER0(GCC diagnostic ignored x)
467 # define HELPER2(y) HELPER1(#y)
468 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
469 # define IGNORE_UNINITIALIZED_WARNING_START \
470  _Pragma("GCC diagnostic push") \
471  _Pragma(HELPER2(-Wuninitialized)) \
472  _Pragma(HELPER2(-Wmaybe-uninitialized))
473 # define IGNORE_UNINITIALIZED_WARNING_STOP _Pragma("GCC diagnostic pop")
474 #endif
475 #endif
476 
477 #ifndef IGNORE_UNINITIALIZED_WARNING_START
478 # define IGNORE_UNINITIALIZED_WARNING_START
479 # define IGNORE_UNINITIALIZED_WARNING_STOP
480 #endif
481 
482 #endif /* STDAFX_H */
usererror
void CDECL usererror(const char *s,...)
Error handling for fatal user errors.
Definition: openttd.cpp:102
FS2OTTD
const char * FS2OTTD(const wchar_t *name)
Convert to OpenTTD's encoding from wide characters.
Definition: win32.cpp:565
osx_stdafx.h
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:450
OTTD2FS
const wchar_t * OTTD2FS(const char *name, bool console_cp)
Convert from OpenTTD's encoding to wide characters.
Definition: win32.cpp:580