mirror of https://github.com/OpenTTD/OpenTTD.git
490 lines
16 KiB
C++
490 lines
16 KiB
C++
/*
|
|
* This file is part of OpenTTD.
|
|
* 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.
|
|
* 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.
|
|
* 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/>.
|
|
*/
|
|
|
|
/** @file stdafx.h Definition of base types and functions in a cross-platform compatible way. */
|
|
|
|
#ifndef STDAFX_H
|
|
#define STDAFX_H
|
|
|
|
#if defined(__APPLE__)
|
|
#include "os/macosx/osx_stdafx.h"
|
|
#endif /* __APPLE__ */
|
|
|
|
#if defined(__HAIKU__)
|
|
#include <SupportDefs.h>
|
|
#include <unistd.h>
|
|
#define _GNU_SOURCE
|
|
#define TROUBLED_INTS
|
|
#endif
|
|
|
|
#if defined(__HAIKU__) || defined(__CYGWIN__)
|
|
# include <strings.h> /* strncasecmp */
|
|
#endif
|
|
|
|
/* It seems that we need to include stdint.h before anything else
|
|
* We need INT64_MAX, which for most systems comes from stdint.h. However, MSVC
|
|
* does not have stdint.h.
|
|
* For OSX the inclusion is already done in osx_stdafx.h. */
|
|
#if !defined(__APPLE__) && (!defined(_MSC_VER) || _MSC_VER >= 1600)
|
|
#if defined(SUNOS)
|
|
/* SunOS/Solaris does not have stdint.h, but inttypes.h defines everything
|
|
* stdint.h defines and we need. */
|
|
#include <inttypes.h>
|
|
#else
|
|
#define __STDC_LIMIT_MACROS
|
|
#include <stdint.h>
|
|
#endif
|
|
#endif
|
|
|
|
/* The conditions for these constants to be available are way too messy; so check them one by one */
|
|
#if !defined(UINT64_MAX)
|
|
#define UINT64_MAX (18446744073709551615ULL)
|
|
#endif
|
|
#if !defined(INT64_MAX)
|
|
#define INT64_MAX (9223372036854775807LL)
|
|
#endif
|
|
#if !defined(INT64_MIN)
|
|
#define INT64_MIN (-INT64_MAX - 1)
|
|
#endif
|
|
#if !defined(UINT32_MAX)
|
|
#define UINT32_MAX (4294967295U)
|
|
#endif
|
|
#if !defined(INT32_MAX)
|
|
#define INT32_MAX (2147483647)
|
|
#endif
|
|
#if !defined(INT32_MIN)
|
|
#define INT32_MIN (-INT32_MAX - 1)
|
|
#endif
|
|
#if !defined(UINT16_MAX)
|
|
#define UINT16_MAX (65535U)
|
|
#endif
|
|
#if !defined(INT16_MAX)
|
|
#define INT16_MAX (32767)
|
|
#endif
|
|
#if !defined(INT16_MIN)
|
|
#define INT16_MIN (-INT16_MAX - 1)
|
|
#endif
|
|
#if !defined(UINT8_MAX)
|
|
#define UINT8_MAX (255)
|
|
#endif
|
|
#if !defined(INT8_MAX)
|
|
#define INT8_MAX (127)
|
|
#endif
|
|
#if !defined(INT8_MIN)
|
|
#define INT8_MIN (-INT8_MAX - 1)
|
|
#endif
|
|
|
|
#include <cstdio>
|
|
#include <cstddef>
|
|
#include <cstring>
|
|
#include <cstdlib>
|
|
#include <climits>
|
|
#include <cassert>
|
|
#include <memory>
|
|
|
|
#ifndef SIZE_MAX
|
|
#define SIZE_MAX ((size_t)-1)
|
|
#endif
|
|
|
|
#if defined(UNIX) || defined(__MINGW32__)
|
|
#include <sys/types.h>
|
|
#endif
|
|
|
|
#if defined(__OS2__)
|
|
#include <types.h>
|
|
#define strcasecmp stricmp
|
|
#endif
|
|
|
|
#if defined(SUNOS) || defined(HPUX) || defined(__CYGWIN__)
|
|
#include <alloca.h>
|
|
#endif
|
|
|
|
/* Stuff for GCC */
|
|
#if defined(__GNUC__)
|
|
#define NORETURN __attribute__ ((noreturn))
|
|
#define CDECL
|
|
#define __int64 long long
|
|
/* Warn about functions using 'printf' format syntax. First argument determines which parameter
|
|
* is the format string, second argument is start of values passed to printf. */
|
|
#define WARN_FORMAT(string, args) __attribute__ ((format (printf, string, args)))
|
|
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 7)
|
|
#define FINAL final
|
|
#else
|
|
#define FINAL
|
|
#endif
|
|
|
|
/* Use fallthrough attribute where supported */
|
|
#if __GNUC__ >= 7
|
|
#if __cplusplus > 201402L // C++17
|
|
#define FALLTHROUGH [[fallthrough]]
|
|
#else
|
|
#define FALLTHROUGH __attribute__((fallthrough))
|
|
#endif
|
|
#else
|
|
#define FALLTHROUGH
|
|
#endif
|
|
#endif /* __GNUC__ */
|
|
|
|
#if defined(__WATCOMC__)
|
|
#define NORETURN
|
|
#define CDECL
|
|
#define WARN_FORMAT(string, args)
|
|
#define FINAL
|
|
#define FALLTHROUGH
|
|
#include <malloc.h>
|
|
#endif /* __WATCOMC__ */
|
|
|
|
#if defined(__MINGW32__)
|
|
#include <malloc.h> // alloca()
|
|
#endif
|
|
|
|
#if defined(_WIN32)
|
|
#define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers
|
|
#endif
|
|
|
|
/* Stuff for MSVC */
|
|
#if defined(_MSC_VER)
|
|
#pragma once
|
|
#ifdef _WIN64
|
|
/* No 64-bit Windows below XP, so we can safely assume it as the target platform. */
|
|
#define NTDDI_VERSION NTDDI_WINXP // Windows XP
|
|
#define _WIN32_WINNT 0x501 // Windows XP
|
|
#define _WIN32_WINDOWS 0x501 // Windows XP
|
|
#define WINVER 0x0501 // Windows XP
|
|
#define _WIN32_IE_ 0x0600 // 6.0 (XP+)
|
|
#else
|
|
/* Define a win32 target platform, to override defaults of the SDK
|
|
* We need to define NTDDI version for Vista SDK, but win2k is minimum */
|
|
#define NTDDI_VERSION NTDDI_WIN2K // Windows 2000
|
|
#define _WIN32_WINNT 0x0500 // Windows 2000
|
|
#define _WIN32_WINDOWS 0x400 // Windows 95
|
|
#define WINVER 0x0400 // Windows NT 4.0 / Windows 95
|
|
#define _WIN32_IE_ 0x0401 // 4.01 (win98 and NT4SP5+)
|
|
#endif
|
|
#define NOMINMAX // Disable min/max macros in windows.h.
|
|
|
|
#pragma warning(disable: 4244) // 'conversion' conversion from 'type1' to 'type2', possible loss of data
|
|
#pragma warning(disable: 4761) // integral size mismatch in argument : conversion supplied
|
|
#pragma warning(disable: 4200) // nonstandard extension used : zero-sized array in struct/union
|
|
#pragma warning(disable: 4355) // 'this' : used in base member initializer list
|
|
|
|
#if (_MSC_VER < 1400) // MSVC 2005 safety checks
|
|
#error "Only MSVC 2005 or higher are supported. MSVC 2003 and earlier are not! Upgrade your compiler."
|
|
#endif /* (_MSC_VER < 1400) */
|
|
#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)
|
|
#pragma warning(disable: 4996) // 'function': was declared deprecated
|
|
#define _CRT_SECURE_NO_DEPRECATE // all deprecated 'unsafe string functions
|
|
#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
|
|
#pragma warning(disable: 6011) // code analyzer: Dereferencing NULL pointer 'pfGetAddrInfo': Lines: 995, 996, 998, 999, 1001
|
|
#pragma warning(disable: 6326) // code analyzer: potential comparison of a constant with another constant
|
|
#pragma warning(disable: 6031) // code analyzer: Return value ignored: 'ReadFile'
|
|
#pragma warning(disable: 6255) // code analyzer: _alloca indicates failure by raising a stack overflow exception. Consider using _malloca instead
|
|
#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 ...
|
|
|
|
#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
|
|
#define _DO_NOT_DECLARE_INTERLOCKED_INTRINSICS_IN_MEMORY
|
|
#include <intrin.h>
|
|
#endif
|
|
|
|
#include <malloc.h> // alloca()
|
|
#define NORETURN __declspec(noreturn)
|
|
#if (_MSC_VER < 1900)
|
|
#define inline __forceinline
|
|
#endif
|
|
|
|
#define CDECL _cdecl
|
|
#define WARN_FORMAT(string, args)
|
|
#define FINAL sealed
|
|
|
|
/* fallthrough attribute, VS 2017 */
|
|
#if (_MSC_VER >= 1910)
|
|
#define FALLTHROUGH [[fallthrough]]
|
|
#else
|
|
#define FALLTHROUGH
|
|
#endif
|
|
|
|
# if defined(_WIN32) && !defined(_WIN64)
|
|
#if !defined(_W64)
|
|
#define _W64
|
|
#endif
|
|
|
|
typedef _W64 int INT_PTR, *PINT_PTR;
|
|
typedef _W64 unsigned int UINT_PTR, *PUINT_PTR;
|
|
# endif /* _WIN32 && !_WIN64 */
|
|
|
|
# if defined(_WIN64)
|
|
#define fseek _fseeki64
|
|
# endif /* _WIN64 */
|
|
|
|
/* zlib from vcpkg use cdecl calling convention without enforcing it in the headers */
|
|
# if defined(WITH_ZLIB)
|
|
# if !defined(ZEXPORT)
|
|
# define ZEXPORT CDECL
|
|
# endif
|
|
# endif
|
|
|
|
/* freetype from vcpkg use cdecl calling convention without enforcing it in the headers */
|
|
# if defined(WITH_FREETYPE)
|
|
# if !defined(FT_EXPORT)
|
|
# define FT_EXPORT( x ) extern "C" x CDECL
|
|
# endif
|
|
# endif
|
|
|
|
/* liblzma from vcpkg (before 5.2.4-2) used to patch lzma.h to define LZMA_API_STATIC for static builds */
|
|
# if defined(WITH_LIBLZMA)
|
|
# if !defined(LZMA_API_STATIC)
|
|
# define LZMA_API_STATIC
|
|
# endif
|
|
# endif
|
|
|
|
#define strcasecmp stricmp
|
|
#define strncasecmp strnicmp
|
|
#define strtoull _strtoui64
|
|
|
|
/* MSVC doesn't have these :( */
|
|
#define S_ISDIR(mode) (mode & S_IFDIR)
|
|
#define S_ISREG(mode) (mode & S_IFREG)
|
|
|
|
#endif /* defined(_MSC_VER) */
|
|
|
|
/* NOTE: the string returned by these functions is only valid until the next
|
|
* call to the same function and is not thread- or reentrancy-safe */
|
|
#if !defined(STRGEN) && !defined(SETTINGSGEN)
|
|
# if defined(_WIN32)
|
|
char *getcwd(char *buf, size_t size);
|
|
#include <tchar.h>
|
|
#include <io.h>
|
|
|
|
namespace std { using ::_tfopen; }
|
|
#define fopen(file, mode) _tfopen(OTTD2FS(file), _T(mode))
|
|
#define unlink(file) _tunlink(OTTD2FS(file))
|
|
|
|
const char *FS2OTTD(const TCHAR *name);
|
|
const TCHAR *OTTD2FS(const char *name, bool console_cp = false);
|
|
# else
|
|
#define fopen(file, mode) fopen(OTTD2FS(file), mode)
|
|
const char *FS2OTTD(const char *name);
|
|
const char *OTTD2FS(const char *name);
|
|
# endif /* _WIN32 */
|
|
#endif /* STRGEN || SETTINGSGEN */
|
|
|
|
#if defined(_WIN32) || defined(__OS2__) && !defined(__INNOTEK_LIBC__)
|
|
#define PATHSEP "\\"
|
|
#define PATHSEPCHAR '\\'
|
|
#else
|
|
#define PATHSEP "/"
|
|
#define PATHSEPCHAR '/'
|
|
#endif
|
|
|
|
#if defined(_MSC_VER) || defined(__WATCOMC__)
|
|
# define PACK_N(type_dec, n) __pragma(pack(push, n)) type_dec; __pragma(pack(pop))
|
|
#elif defined(__MINGW32__)
|
|
# define PRAGMA(x) _Pragma(#x)
|
|
# define PACK_N(type_dec, n) PRAGMA(pack(push, n)) type_dec; PRAGMA(pack(pop))
|
|
#else
|
|
# define PACK_N(type_dec, n) type_dec __attribute__((__packed__, aligned(n)))
|
|
#endif
|
|
#define PACK(type_dec) PACK_N(type_dec, 1)
|
|
|
|
/* MSVCRT of course has to have a different syntax for long long *sigh* */
|
|
#if defined(_MSC_VER) || defined(__MINGW32__)
|
|
# define OTTD_PRINTF64 "%I64d"
|
|
# define OTTD_PRINTFHEX64 "%I64x"
|
|
# define PRINTF_SIZE "%Iu"
|
|
# define PRINTF_SIZEX "%IX"
|
|
#else
|
|
# define OTTD_PRINTF64 "%lld"
|
|
# define OTTD_PRINTFHEX64 "%llx"
|
|
# define PRINTF_SIZE "%zu"
|
|
# define PRINTF_SIZEX "%zX"
|
|
#endif
|
|
|
|
typedef unsigned char byte;
|
|
|
|
/* This is already defined in unix, but not in QNX Neutrino (6.x)*/
|
|
#if (!defined(UNIX) && !defined(__HAIKU__)) || defined(__QNXNTO__)
|
|
typedef unsigned int uint;
|
|
#endif
|
|
|
|
#if defined(TROUBLED_INTS)
|
|
/* Haiku's types for uint32/int32/uint64/int64 are different than what
|
|
* they are on other platforms; not in length, but how to print them.
|
|
* So make them more like the other platforms, to make printf() etc a
|
|
* little bit easier. */
|
|
# define uint32 uint32_ugly_hack
|
|
# define int32 int32_ugly_hack
|
|
# define uint64 uint64_ugly_hack
|
|
# define int64 int64_ugly_hack
|
|
typedef unsigned int uint32_ugly_hack;
|
|
typedef signed int int32_ugly_hack;
|
|
typedef unsigned __int64 uint64_ugly_hack;
|
|
typedef signed __int64 int64_ugly_hack;
|
|
#else
|
|
typedef unsigned char uint8;
|
|
typedef signed char int8;
|
|
typedef unsigned short uint16;
|
|
typedef signed short int16;
|
|
typedef unsigned int uint32;
|
|
typedef signed int int32;
|
|
typedef unsigned __int64 uint64;
|
|
typedef signed __int64 int64;
|
|
#endif /* !TROUBLED_INTS */
|
|
|
|
#if !defined(WITH_PERSONAL_DIR)
|
|
#define PERSONAL_DIR ""
|
|
#endif
|
|
|
|
/* Compile time assertions. Prefer c++0x static_assert().
|
|
* Older compilers cannot evaluate some expressions at compile time,
|
|
* typically when templates are involved, try assert_tcompile() in those cases. */
|
|
#if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1600)
|
|
#define assert_compile(expr) static_assert(expr, #expr )
|
|
#define assert_tcompile(expr) assert_compile(expr)
|
|
#elif defined(__OS2__)
|
|
/* Disabled for OS/2 */
|
|
#define assert_compile(expr)
|
|
#define assert_tcompile(expr) assert_compile(expr)
|
|
#else
|
|
#define assert_compile(expr) typedef int __ct_assert__[1 - 2 * !(expr)]
|
|
#define assert_tcompile(expr) assert(expr)
|
|
#endif
|
|
|
|
/* Check if the types have the bitsizes like we are using them */
|
|
assert_compile(sizeof(uint64) == 8);
|
|
assert_compile(sizeof(uint32) == 4);
|
|
assert_compile(sizeof(uint16) == 2);
|
|
assert_compile(sizeof(uint8) == 1);
|
|
assert_compile(SIZE_MAX >= UINT32_MAX);
|
|
|
|
#ifndef M_PI_2
|
|
#define M_PI_2 1.57079632679489661923
|
|
#define M_PI 3.14159265358979323846
|
|
#endif /* M_PI_2 */
|
|
|
|
/**
|
|
* Return the length of an fixed size array.
|
|
* Unlike sizeof this function returns the number of elements
|
|
* of the given type.
|
|
*
|
|
* @param x The pointer to the first element of the array
|
|
* @return The number of elements
|
|
*/
|
|
#define lengthof(x) (sizeof(x) / sizeof(x[0]))
|
|
|
|
/**
|
|
* Get the end element of an fixed size array.
|
|
*
|
|
* @param x The pointer to the first element of the array
|
|
* @return The pointer past to the last element of the array
|
|
*/
|
|
#define endof(x) (&x[lengthof(x)])
|
|
|
|
/**
|
|
* Get the last element of an fixed size array.
|
|
*
|
|
* @param x The pointer to the first element of the array
|
|
* @return The pointer to the last element of the array
|
|
*/
|
|
#define lastof(x) (&x[lengthof(x) - 1])
|
|
|
|
#define cpp_offsetof(s, m) (((size_t)&reinterpret_cast<const volatile char&>((((s*)(char*)8)->m))) - 8)
|
|
#if !defined(offsetof)
|
|
#define offsetof(s, m) cpp_offsetof(s, m)
|
|
#endif /* offsetof */
|
|
|
|
/**
|
|
* Gets the size of a variable within a class.
|
|
* @param base The class the variable is in.
|
|
* @param variable The variable to get the size of.
|
|
* @return the size of the variable
|
|
*/
|
|
#define cpp_sizeof(base, variable) (sizeof(((base*)8)->variable))
|
|
|
|
/**
|
|
* Gets the length of an array variable within a class.
|
|
* @param base The class the variable is in.
|
|
* @param variable The array variable to get the size of.
|
|
* @return the length of the array
|
|
*/
|
|
#define cpp_lengthof(base, variable) (cpp_sizeof(base, variable) / cpp_sizeof(base, variable[0]))
|
|
|
|
|
|
/* take care of some name clashes on MacOS */
|
|
#if defined(__APPLE__)
|
|
#define GetString OTTD_GetString
|
|
#define DrawString OTTD_DrawString
|
|
#define CloseConnection OTTD_CloseConnection
|
|
#endif /* __APPLE__ */
|
|
|
|
void NORETURN CDECL usererror(const char *str, ...) WARN_FORMAT(1, 2);
|
|
void NORETURN CDECL error(const char *str, ...) WARN_FORMAT(1, 2);
|
|
#define NOT_REACHED() error("NOT_REACHED triggered at line %i of %s", __LINE__, __FILE__)
|
|
|
|
/* For non-debug builds with assertions enabled use the special assertion handler. */
|
|
#if defined(NDEBUG) && defined(WITH_ASSERT)
|
|
#undef assert
|
|
#define assert(expression) if (!(expression)) error("Assertion failed at line %i of %s: %s", __LINE__, __FILE__, #expression);
|
|
#endif
|
|
|
|
/* Asserts are enabled if NDEBUG isn't defined or WITH_ASSERT is defined. */
|
|
#if !defined(NDEBUG) || defined(WITH_ASSERT)
|
|
#define OTTD_ASSERT
|
|
#endif
|
|
|
|
#if defined(OPENBSD)
|
|
/* OpenBSD uses strcasecmp(3) */
|
|
#define _stricmp strcasecmp
|
|
#endif
|
|
|
|
#if defined(MAX_PATH)
|
|
/* It's already defined, no need to override */
|
|
#elif defined(PATH_MAX) && PATH_MAX > 0
|
|
/* Use the value from PATH_MAX, if it exists */
|
|
#define MAX_PATH PATH_MAX
|
|
#else
|
|
/* If all else fails, hardcode something :( */
|
|
#define MAX_PATH 260
|
|
#endif
|
|
|
|
/**
|
|
* Version of the standard free that accepts const pointers.
|
|
* @param ptr The data to free.
|
|
*/
|
|
static inline void free(const void *ptr)
|
|
{
|
|
free(const_cast<void *>(ptr));
|
|
}
|
|
|
|
/**
|
|
* The largest value that can be entered in a variable
|
|
* @param type the type of the variable
|
|
*/
|
|
#define MAX_UVALUE(type) ((type)~(type)0)
|
|
|
|
#if defined(_MSC_VER) && !defined(_DEBUG)
|
|
#define IGNORE_UNINITIALIZED_WARNING_START __pragma(warning(push)) __pragma(warning(disable:4700))
|
|
#define IGNORE_UNINITIALIZED_WARNING_STOP __pragma(warning(pop))
|
|
#elif defined(__GNUC__) && !defined(_DEBUG)
|
|
#define HELPER0(x) #x
|
|
#define HELPER1(x) HELPER0(GCC diagnostic ignored x)
|
|
#define HELPER2(y) HELPER1(#y)
|
|
#if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6))
|
|
#define IGNORE_UNINITIALIZED_WARNING_START \
|
|
_Pragma("GCC diagnostic push") \
|
|
_Pragma(HELPER2(-Wuninitialized)) \
|
|
_Pragma(HELPER2(-Wmaybe-uninitialized))
|
|
#define IGNORE_UNINITIALIZED_WARNING_STOP _Pragma("GCC diagnostic pop")
|
|
#endif
|
|
#endif
|
|
|
|
#ifndef IGNORE_UNINITIALIZED_WARNING_START
|
|
#define IGNORE_UNINITIALIZED_WARNING_START
|
|
#define IGNORE_UNINITIALIZED_WARNING_STOP
|
|
#endif
|
|
|
|
#endif /* STDAFX_H */
|