src/stdafx.h

   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
   8 /** @file stdafx.h Definition of base types and functions in a cross-platform compatible way. */
   9
  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__)
 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 #       ifndef __clang__
 199 #               define FINAL sealed
 200 #       else
 201 #               define FINAL
 202 #       endif
 203
 204         /* fallthrough attribute, VS 2017 */
 205 #       if (_MSC_VER >= 1910)
 206 #               define FALLTHROUGH [[fallthrough]]
 207 #       else
 208 #               define FALLTHROUGH
 209 #       endif
 210
 211 #       if defined(_WIN32) && !defined(_WIN64)
 212 #               if !defined(_W64)
 213 #                       define _W64
 214 #               endif
 215
 216                 typedef _W64 int INT_PTR, *PINT_PTR;
 217                 typedef _W64 unsigned int UINT_PTR, *PUINT_PTR;
 218 #       endif /* _WIN32 && !_WIN64 */
 219
 220 #       if defined(_WIN64)
 221 #               define fseek _fseeki64
 222 #       endif /* _WIN64 */
 223
 224         /* zlib from vcpkg use cdecl calling convention without enforcing it in the headers */
 225 #       if defined(WITH_ZLIB)
 226 #               if !defined(ZEXPORT)
 227 #                       define ZEXPORT CDECL
 228 #               endif
 229 #       endif
 230
 231         /* freetype from vcpkg use cdecl calling convention without enforcing it in the headers */
 232 #       if defined(WITH_FREETYPE)
 233 #               if !defined(FT_EXPORT)
 234 #                       define FT_EXPORT( x )  extern "C"  x CDECL
 235 #               endif
 236 #       endif
 237
 238         /* liblzma from vcpkg (before 5.2.4-2) used to patch lzma.h to define LZMA_API_STATIC for static builds */
 239 #       if defined(WITH_LIBLZMA)
 240 #               if !defined(LZMA_API_STATIC)
 241 #                       define LZMA_API_STATIC
 242 #               endif
 243 #       endif
 244
 245 #       define strcasecmp stricmp
 246 #       define strncasecmp strnicmp
 247 #       define strtoull _strtoui64
 248
 249         /* MSVC doesn't have these :( */
 250 #       define S_ISDIR(mode) (mode & S_IFDIR)
 251 #       define S_ISREG(mode) (mode & S_IFREG)
 252
 253 #endif /* defined(_MSC_VER) */
 254
 255 /* NOTE: the string returned by these functions is only valid until the next
 256  * call to the same function and is not thread- or reentrancy-safe */
 257 #if !defined(STRGEN) && !defined(SETTINGSGEN)
 258 #       if defined(_WIN32)
 259                 char *getcwd(char *buf, size_t size);
 260 #               include <tchar.h>
 261 #               include <io.h>
 262
 263                 namespace std { using ::_wfopen; }
 264 #               define fopen(file, mode) _wfopen(OTTD2FS(file), _T(mode))
 265 #               define unlink(file) _wunlink(OTTD2FS(file))
 266
 267                 const char *FS2OTTD(const wchar_t *name);
 268                 const wchar_t *OTTD2FS(const char *name, bool console_cp = false);
 269 #       else
 270 #               define fopen(file, mode) fopen(OTTD2FS(file), mode)
 271                 const char *FS2OTTD(const char *name);
 272                 const char *OTTD2FS(const char *name);
 273 #       endif /* _WIN32 */
 274 #endif /* STRGEN || SETTINGSGEN */
 275
 276 #if defined(_WIN32) || defined(__OS2__) && !defined(__INNOTEK_LIBC__)
 277 #       define PATHSEP "\\"
 278 #       define PATHSEPCHAR '\\'
 279 #else
 280 #       define PATHSEP "/"
 281 #       define PATHSEPCHAR '/'
 282 #endif
 283
 284 #if defined(_MSC_VER) || defined(__WATCOMC__)
 285 #       define PACK_N(type_dec, n) __pragma(pack(push, n)) type_dec; __pragma(pack(pop))
 286 #elif defined(__MINGW32__)
 287 #       define PRAGMA(x) _Pragma(#x)
 288 #       define PACK_N(type_dec, n) PRAGMA(pack(push, n)) type_dec; PRAGMA(pack(pop))
 289 #else
 290 #       define PACK_N(type_dec, n) type_dec __attribute__((__packed__, aligned(n)))
 291 #endif
 292 #define PACK(type_dec) PACK_N(type_dec, 1)
 293
 294 /* MSVCRT of course has to have a different syntax for long long *sigh* */
 295 #if defined(_MSC_VER) || defined(__MINGW32__)
 296 #   define OTTD_PRINTF64 "%I64d"
 297 #   define OTTD_PRINTFHEX64 "%I64x"
 298 #   define PRINTF_SIZE "%Iu"
 299 #   define PRINTF_SIZEX "%IX"
 300 #else
 301 #   define OTTD_PRINTF64 "%lld"
 302 #   define OTTD_PRINTFHEX64 "%llx"
 303 #   define PRINTF_SIZE "%zu"
 304 #   define PRINTF_SIZEX "%zX"
 305 #endif
 306
 307 typedef unsigned char byte;
 308
 309 /* This is already defined in unix, but not in QNX Neutrino (6.x) or Cygwin. */
 310 #if (!defined(UNIX) && !defined(__HAIKU__)) || defined(__QNXNTO__) || defined(__CYGWIN__)
 311         typedef unsigned int uint;
 312 #endif
 313
 314 #if defined(TROUBLED_INTS)
 315         /* Haiku's types for uint32/int32/uint64/int64 are different than what
 316          * they are on other platforms; not in length, but how to print them.
 317          * So make them more like the other platforms, to make printf() etc a
 318          * little bit easier. */
 319 #       define uint32 uint32_ugly_hack
 320 #       define int32 int32_ugly_hack
 321 #       define uint64 uint64_ugly_hack
 322 #       define int64 int64_ugly_hack
 323         typedef unsigned int uint32_ugly_hack;
 324         typedef signed int int32_ugly_hack;
 325         typedef unsigned __int64 uint64_ugly_hack;
 326         typedef signed __int64 int64_ugly_hack;
 327 #else
 328         typedef unsigned char    uint8;
 329         typedef   signed char     int8;
 330         typedef unsigned short   uint16;
 331         typedef   signed short    int16;
 332         typedef unsigned int     uint32;
 333         typedef   signed int      int32;
 334         typedef unsigned __int64 uint64;
 335         typedef   signed __int64  int64;
 336 #endif /* !TROUBLED_INTS */
 337
 338 #if !defined(WITH_PERSONAL_DIR)
 339 #       define PERSONAL_DIR ""
 340 #endif
 341
 342 /* Define the the platforms that use XDG */
 343 #if defined(WITH_PERSONAL_DIR) && defined(UNIX) && !defined(__APPLE__)
 344 #       define USE_XDG
 345 #endif
 346
 347 /* Check if the types have the bitsizes like we are using them */
 348 static_assert(sizeof(uint64) == 8);
 349 static_assert(sizeof(uint32) == 4);
 350 static_assert(sizeof(uint16) == 2);
 351 static_assert(sizeof(uint8)  == 1);
 352 static_assert(SIZE_MAX >= UINT32_MAX);
 353
 354 #ifndef M_PI_2
 355 #define M_PI_2 1.57079632679489661923
 356 #define M_PI   3.14159265358979323846
 357 #endif /* M_PI_2 */
 358
 359 /**
 360  * Return the length of an fixed size array.
 361  * Unlike sizeof this function returns the number of elements
 362  * of the given type.
 363  *
 364  * @param x The pointer to the first element of the array
 365  * @return The number of elements
 366  */
 367 #define lengthof(x) (sizeof(x) / sizeof(x[0]))
 368
 369 /**
 370  * Get the end element of an fixed size array.
 371  *
 372  * @param x The pointer to the first element of the array
 373  * @return The pointer past to the last element of the array
 374  */
 375 #define endof(x) (&x[lengthof(x)])
 376
 377 /**
 378  * Get the last element of an fixed size array.
 379  *
 380  * @param x The pointer to the first element of the array
 381  * @return The pointer to the last element of the array
 382  */
 383 #define lastof(x) (&x[lengthof(x) - 1])
 384
 385 /**
 386  * Gets the size of a variable within a class.
 387  * @param base     The class the variable is in.
 388  * @param variable The variable to get the size of.
 389  * @return the size of the variable
 390  */
 391 #define cpp_sizeof(base, variable) (sizeof(std::declval<base>().variable))
 392
 393 /**
 394  * Gets the length of an array variable within a class.
 395  * @param base     The class the variable is in.
 396  * @param variable The array variable to get the size of.
 397  * @return the length of the array
 398  */
 399 #define cpp_lengthof(base, variable) (cpp_sizeof(base, variable) / cpp_sizeof(base, variable[0]))
 400
 401
 402 /* take care of some name clashes on MacOS */
 403 #if defined(__APPLE__)
 404 #       define GetString OTTD_GetString
 405 #       define DrawString OTTD_DrawString
 406 #       define CloseConnection OTTD_CloseConnection
 407 #endif /* __APPLE__ */
 408
 409 #if defined(__GNUC__) || defined(__clang__)
 410 #       define likely(x)   __builtin_expect(!!(x), 1)
 411 #       define unlikely(x) __builtin_expect(!!(x), 0)
 412 #else
 413 #       define likely(x)   (x)
 414 #       define unlikely(x) (x)
 415 #endif /* __GNUC__ || __clang__ */
 416
 417 void NORETURN CDECL usererror(const char *str, ...) WARN_FORMAT(1, 2);
 418 void NORETURN CDECL error(const char *str, ...) WARN_FORMAT(1, 2);
 419 #define NOT_REACHED() error("NOT_REACHED triggered at line %i of %s", __LINE__, __FILE__)
 420
 421 /* For non-debug builds with assertions enabled use the special assertion handler. */
 422 #if defined(NDEBUG) && defined(WITH_ASSERT)
 423 #       undef assert
 424 #       define assert(expression) if (unlikely(!(expression))) error("Assertion failed at line %i of %s: %s", __LINE__, __FILE__, #expression);
 425 #endif
 426
 427 /* Asserts are enabled if NDEBUG isn't defined or WITH_ASSERT is defined. */
 428 #if !defined(NDEBUG) || defined(WITH_ASSERT)
 429 #       define OTTD_ASSERT
 430 #       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__);
 431 #else
 432 #       define assert_msg(expression, msg, ...)
 433 #endif
 434
 435 #if defined(OPENBSD)
 436         /* OpenBSD uses strcasecmp(3) */
 437 #       define _stricmp strcasecmp
 438 #endif
 439
 440 #if defined(MAX_PATH)
 441         /* It's already defined, no need to override */
 442 #elif defined(PATH_MAX) && PATH_MAX > 0
 443         /* Use the value from PATH_MAX, if it exists */
 444 #       define MAX_PATH PATH_MAX
 445 #else
 446         /* If all else fails, hardcode something :( */
 447 #       define MAX_PATH 260
 448 #endif
 449
 450 /**
 451  * Version of the standard free that accepts const pointers.
 452  * @param ptr The data to free.
 453  */
 454 static inline void free(const void *ptr)
 455 {
 456         free(const_cast<void *>(ptr));
 457 }
 458
 459 /**
 460  * The largest value that can be entered in a variable
 461  * @param type the type of the variable
 462  */
 463 #define MAX_UVALUE(type) ((type)~(type)0)
 464
 465 #if defined(_MSC_VER) && !defined(_DEBUG)
 466 #       define IGNORE_UNINITIALIZED_WARNING_START __pragma(warning(push)) __pragma(warning(disable:4700))
 467 #       define IGNORE_UNINITIALIZED_WARNING_STOP __pragma(warning(pop))
 468 #elif defined(__GNUC__) && !defined(_DEBUG)
 469 #       define HELPER0(x) #x
 470 #       define HELPER1(x) HELPER0(GCC diagnostic ignored x)
 471 #       define HELPER2(y) HELPER1(#y)
 472 #if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
 473 #       define IGNORE_UNINITIALIZED_WARNING_START \
 474                 _Pragma("GCC diagnostic push") \
 475                 _Pragma(HELPER2(-Wuninitialized)) \
 476                 _Pragma(HELPER2(-Wmaybe-uninitialized))
 477 #       define IGNORE_UNINITIALIZED_WARNING_STOP _Pragma("GCC diagnostic pop")
 478 #endif
 479 #endif
 480
 481 #ifndef IGNORE_UNINITIALIZED_WARNING_START
 482 #       define IGNORE_UNINITIALIZED_WARNING_START
 483 #       define IGNORE_UNINITIALIZED_WARNING_STOP
 484 #endif
 485
 486 #endif /* STDAFX_H */