2005-07-24 16:12:37 +02:00
/* $Id$ */
2009-08-21 22:21:05 +02:00
/*
* 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/>.
*/
2008-05-06 17:11:33 +02:00
/** @file stdafx.h Definition of base types and functions in a cross-platform compatible way. */
2007-04-04 03:35:16 +02:00
2005-09-18 22:56:44 +02:00
# ifndef STDAFX_H
# define STDAFX_H
2004-08-09 19:04:08 +02:00
2009-03-29 21:55:08 +02:00
# if defined(__APPLE__)
# include "os/macosx/osx_stdafx.h"
# endif /* __APPLE__ */
2008-01-22 00:55:57 +01:00
# if defined(__NDS__)
# include <nds/jtypes.h>
/* NDS' types for uint32/int32 are based on longs, which causes
* trouble all over the place in OpenTTD . */
# define uint32 uint32_ugly_hack
# define int32 int32_ugly_hack
typedef unsigned int uint32_ugly_hack ;
typedef signed int int32_ugly_hack ;
# endif /* __NDS__ */
2007-01-24 01:55:35 +01:00
/* 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 and apparently neither does MorphOS , so define
2009-07-14 19:16:32 +02:00
* INT64_MAX for them ourselves . */
# if defined(__APPLE__)
/* Already done in osx_stdafx.h */
# elif !defined(_MSC_VER) && !defined( __MORPHOS__) && !defined(_STDINT_H_)
2007-12-02 22:43:16 +01:00
# 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
2007-01-24 01:55:35 +01:00
# else
2008-04-04 22:34:09 +02:00
# define UINT64_MAX (18446744073709551615ULL)
# define INT64_MAX (9223372036854775807LL)
# define INT64_MIN (-INT64_MAX - 1)
# define UINT32_MAX (4294967295U)
# define INT32_MAX (2147483647)
# define INT32_MIN (-INT32_MAX - 1)
# define UINT16_MAX (65535U)
# define INT16_MAX (32767)
# define INT16_MIN (-INT16_MAX - 1)
2007-01-24 01:55:35 +01:00
# endif
2007-02-04 12:14:42 +01:00
# include <cstdio>
# include <cstddef>
# include <cstring>
# include <cstdlib>
# include <climits>
2004-08-09 19:04:08 +02:00
2007-02-04 12:20:24 +01:00
/* MacOS X will use an NSAlert to display failed assertaions since they're lost unless running from a terminal
* strgen always runs from terminal and don ' t need a window for asserts */
2005-12-09 14:17:31 +01:00
# if !defined(__APPLE__) || defined(STRGEN)
2007-12-02 22:43:16 +01:00
# include <cassert>
2005-07-28 23:47:41 +02:00
# else
2007-12-02 22:43:16 +01:00
# include "os/macosx/macos.h"
2005-07-28 23:47:41 +02:00
# endif
2005-01-03 15:33:59 +01:00
# if defined(UNIX) || defined(__MINGW32__)
2007-12-02 22:43:16 +01:00
# include <sys/types.h>
2004-08-09 19:04:08 +02:00
# endif
2004-12-23 15:46:16 +01:00
# if defined(__OS2__)
2007-12-02 22:43:16 +01:00
# include <types.h>
# define strcasecmp stricmp
2004-12-23 15:46:16 +01:00
# endif
2007-02-11 14:57:35 +01:00
# if defined(PSP)
2007-12-02 22:43:16 +01:00
# include <psptypes.h>
# include <pspdebug.h>
# include <pspthreadman.h>
# endif
2007-02-11 14:57:35 +01:00
2007-12-02 22:43:16 +01:00
# if defined(__BEOS__)
# include <SupportDefs.h>
2004-08-09 19:04:08 +02:00
# endif
2008-04-30 09:39:46 +02:00
# if defined(SUNOS) || defined(HPUX)
2007-12-02 22:43:16 +01:00
# include <alloca.h>
2004-11-17 10:07:29 +01:00
# endif
2007-12-02 22:43:16 +01:00
# if defined(__MORPHOS__)
/* MorphOS defines certain Amiga defines per default, we undefine them
* here to make the rest of source less messy and more clear what is
* required for morphos and what for AmigaOS */
# if defined(amigaos)
# undef amigaos
# endif
# if defined(__amigaos__)
# undef __amigaos__
# endif
# if defined(__AMIGA__)
# undef __AMIGA__
# endif
# if defined(AMIGA)
# undef AMIGA
# endif
# if defined(amiga)
# undef amiga
# endif
/* Act like we already included this file, as it somehow gives linkage problems
* ( mismatch linkage of C + + and C between this include and unistd . h ) . */
# define CLIB_USERGROUP_PROTOS_H
2004-12-22 22:12:36 +01:00
# endif /* __MORPHOS__ */
2007-02-09 00:46:25 +01:00
# if defined(PSP)
2007-12-02 22:43:16 +01:00
/* PSP can only have 10 file-descriptors open at any given time, but this
* switch only limits reads via the Fio system . So keep 2 fds free for things
* like saving a game . */
# define LIMITED_FDS 8
# define printf pspDebugScreenPrintf
2007-02-09 00:46:25 +01:00
# endif /* PSP */
2007-02-04 12:20:24 +01:00
/* Stuff for GCC */
2004-08-09 19:04:08 +02:00
# if defined(__GNUC__)
2007-12-02 22:43:16 +01:00
# define NORETURN __attribute__ ((noreturn))
# define FORCEINLINE inline
# define CDECL
# define __int64 long long
# define GCC_PACK __attribute__((packed))
2009-07-01 23:29:03 +02:00
# define UNUSED __attribute__((unused))
2009-05-10 19:27:25 +02:00
/* 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)))
2005-10-04 00:16:30 +02:00
# endif /* __GNUC__ */
2004-08-09 19:04:08 +02:00
2004-12-23 15:46:16 +01:00
# if defined(__WATCOMC__)
2007-12-02 22:43:16 +01:00
# define NORETURN
# define FORCEINLINE inline
# define CDECL
# define GCC_PACK
2009-07-01 23:29:03 +02:00
# define UNUSED
2009-05-10 19:27:25 +02:00
# define WARN_FORMAT(string, args)
2007-12-02 22:43:16 +01:00
# include <malloc.h>
2005-10-04 00:16:30 +02:00
# endif /* __WATCOMC__ */
2004-12-23 15:46:16 +01:00
2004-12-23 23:31:46 +01:00
# if defined(__MINGW32__) || defined(__CYGWIN__)
2007-12-02 22:43:16 +01:00
# include <malloc.h> // alloca()
2004-12-23 23:31:46 +01:00
# endif
2008-05-16 19:53:19 +02:00
# if defined(WIN32)
# define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers
# endif
2007-02-04 12:20:24 +01:00
/* Stuff for MSVC */
2004-08-09 19:04:08 +02:00
# if defined(_MSC_VER)
2007-12-02 22:43:16 +01:00
# pragma once
/* 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
# if !defined(WINCE)
# define WINVER 0x0400 // Windows NT 4.0 / Windows 95
# endif
# define _WIN32_IE_ 0x0401 // 4.01 (win98 and NT4SP5+)
# 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
2008-01-24 19:47:05 +01:00
# if (_MSC_VER < 1400) // MSVC 2005 safety checks
2009-01-30 18:54:48 +01:00
# error "Only MSVC 2005 or higher are supported. MSVC 2003 and earlier are not! Upgrade your compiler."
2008-01-24 19:47:05 +01:00
# endif /* (_MSC_VER < 1400) */
# pragma warning(disable: 4996) // 'strdup' 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 ...
2009-05-10 19:27:25 +02:00
# define WARN_FORMAT(string, args)
2007-12-02 22:43:16 +01:00
# include <malloc.h> // alloca()
# define NORETURN __declspec(noreturn)
# define FORCEINLINE __forceinline
# define inline _inline
# if !defined(WINCE)
# define CDECL _cdecl
# endif
2009-07-01 23:29:03 +02:00
# define GCC_PACK
# define UNUSED
2009-05-10 19:27:25 +02:00
int CDECL snprintf ( char * str , size_t size , const char * format , . . . ) WARN_FORMAT ( 3 , 4 ) ;
2009-01-30 18:54:48 +01:00
# if defined(WINCE)
2007-12-02 22:43:16 +01:00
int CDECL vsnprintf ( char * str , size_t size , const char * format , va_list ap ) ;
# endif
# if defined(WIN32) && !defined(_WIN64) && !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 && !WIN64 */
2008-05-27 23:41:00 +02:00
# if defined(_WIN64) || defined(WIN64)
# define fseek _fseeki64
# endif /* _WIN64 || WIN64 */
2007-12-02 22:43:16 +01:00
/* This is needed to zlib uses the stdcall calling convention on visual studio */
# if defined(WITH_ZLIB) || defined(WITH_PNG)
# if !defined(ZLIB_WINAPI)
# define ZLIB_WINAPI
# endif
# endif
# if defined(WINCE)
# define strcasecmp _stricmp
# define strncasecmp _strnicmp
# undef DEBUG
# else
# define strcasecmp stricmp
# define strncasecmp strnicmp
# endif
2007-12-09 22:20:21 +01:00
2008-11-26 02:07:49 +01:00
/* MSVC doesn't have these :( */
# define S_ISDIR(mode) (mode & S_IFDIR)
# define S_ISREG(mode) (mode & S_IFREG)
2005-10-04 00:16:30 +02:00
# endif /* defined(_MSC_VER) */
2004-08-09 19:04:08 +02:00
2007-01-21 15:19:18 +01:00
# if defined(WINCE)
2007-12-02 22:43:16 +01:00
# define strdup _strdup
2007-01-21 15:19:18 +01:00
# endif /* WINCE */
2006-11-28 15:42:31 +01:00
/* 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)
2007-12-02 22:43:16 +01:00
# if defined(WIN32) || defined(WIN64)
char * getcwd ( char * buf , size_t size ) ;
# include <tchar.h>
2009-03-14 16:42:53 +01:00
# include <io.h>
2007-12-02 22:43:16 +01:00
/* XXX - WinCE without MSVCRT doesn't support wfopen, so it seems */
# if !defined(WINCE)
# define fopen(file, mode) _tfopen(OTTD2FS(file), _T(mode))
2009-03-14 01:25:59 +01:00
# define unlink(file) _tunlink(OTTD2FS(file))
2007-12-02 22:43:16 +01:00
# endif /* WINCE */
const char * FS2OTTD ( const TCHAR * name ) ;
const TCHAR * OTTD2FS ( const char * name ) ;
# else
# define fopen(file, mode) fopen(OTTD2FS(file), mode)
const char * FS2OTTD ( const char * name ) ;
const char * OTTD2FS ( const char * name ) ;
# endif /* WIN32 */
2006-11-28 15:42:31 +01:00
# endif /* STRGEN */
2005-10-03 00:39:56 +02:00
2007-01-10 20:39:54 +01:00
# if defined(WIN32) || defined(WIN64) || defined(__OS2__) && !defined(__INNOTEK_LIBC__)
2007-12-02 22:43:16 +01:00
# define PATHSEP "\\"
# define PATHSEPCHAR '\\'
2006-08-25 14:26:34 +02:00
# else
2007-12-02 22:43:16 +01:00
# define PATHSEP " / "
# define PATHSEPCHAR ' / '
2004-08-09 19:04:08 +02:00
# endif
2009-05-10 19:27:25 +02:00
/* MSVCRT of course has to have a different syntax for long long *sigh* */
# if defined(_MSC_VER) || defined(__MINGW32__)
# define OTTD_PRINTF64 "%I64d"
# define PRINTF_SIZE "%Iu"
# else
# define OTTD_PRINTF64 "%lld"
# define PRINTF_SIZE "%zu"
# endif
2004-08-09 19:04:08 +02:00
typedef unsigned char byte ;
2007-12-02 22:43:16 +01:00
/* This is already defined in unix, but not in QNX Neutrino (6.x)*/
# if (!defined(UNIX) && !defined(__CYGWIN__) && !defined(__BEOS__) && !defined(__MORPHOS__)) || defined(__QNXNTO__)
typedef unsigned int uint ;
2004-12-04 18:54:56 +01:00
# endif
2004-08-09 19:04:08 +02:00
2008-01-22 00:55:57 +01:00
# if !defined(__BEOS__) && !defined(__NDS__) /* Already defined on BEOS and NDS */
2007-12-02 22:43:16 +01:00
typedef unsigned char uint8 ;
typedef signed char int8 ;
typedef unsigned short uint16 ;
typedef signed short int16 ;
typedef unsigned int uint32 ;
typedef signed int int32 ;
2006-05-27 18:12:16 +02:00
typedef unsigned __int64 uint64 ;
2007-12-02 22:43:16 +01:00
typedef signed __int64 int64 ;
2008-01-22 00:55:57 +01:00
# endif /* !__BEOS__ && !__NDS__ */
2004-08-09 19:04:08 +02:00
2007-06-17 17:48:57 +02:00
# if !defined(WITH_PERSONAL_DIR)
2007-12-02 22:43:16 +01:00
# define PERSONAL_DIR ""
2004-08-09 19:04:08 +02:00
# endif
2009-09-07 23:02:10 +02:00
/* Compile time assertions. Prefer c++0x static_assert() */
# if defined(__STDCXX_VERSION__) || defined(__GXX_EXPERIMENTAL_CXX0X__) || defined(__GXX_EXPERIMENTAL_CPP0X__) || defined(static_assert)
/* __STDCXX_VERSION__ is c++0x feature macro, __GXX_EXPERIMENTAL_CXX0X__ is used by gcc, __GXX_EXPERIMENTAL_CPP0X__ by icc */
# define assert_compile(expr) static_assert(expr, #expr )
# elif defined(__OS2__) || (defined(__GNUC__) && __GNUC__ == 3 && __GNUC_MINOR__ < 4)
/* Disabled for OS/2 or GCC < 3.4 (GCC < 3 isn't supported anymore) */
2007-12-02 22:43:16 +01:00
# define assert_compile(expr)
2004-12-23 15:46:16 +01:00
# else
2009-07-01 23:29:03 +02:00
# define assert_compile(expr) extern const int __ct_assert__[1 - 2 * !(expr)] UNUSED
2009-09-07 23:02:10 +02:00
# endif
2004-08-09 19:04:08 +02:00
2008-03-05 19:51:26 +01:00
/* Check if the types have the bitsizes like we are using them */
assert_compile ( sizeof ( uint64 ) = = 8 ) ;
2004-08-09 19:04:08 +02:00
assert_compile ( sizeof ( uint32 ) = = 4 ) ;
assert_compile ( sizeof ( uint16 ) = = 2 ) ;
2005-11-14 20:48:04 +01:00
assert_compile ( sizeof ( uint8 ) = = 1 ) ;
2004-08-09 19:04:08 +02:00
2008-11-02 12:05:26 +01:00
/**
* 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
*/
2008-05-07 00:17:12 +02:00
# define lengthof(x) (sizeof(x) / sizeof(x[0]))
2008-11-02 12:05:26 +01:00
/**
* 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
*/
2004-08-09 19:04:08 +02:00
# define endof(x) (&x[lengthof(x)])
2008-11-02 12:05:26 +01:00
/**
* 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
*/
2005-02-06 14:41:02 +01:00
# define lastof(x) (&x[lengthof(x) - 1])
2007-01-14 22:03:21 +01:00
2008-04-18 06:37:06 +02:00
# define cpp_offsetof(s, m) (((size_t)&reinterpret_cast<const volatile char&>((((s*)(char*)8)->m))) - 8)
2007-12-02 22:43:16 +01:00
# if !defined(offsetof)
2008-04-18 06:37:06 +02:00
# define offsetof(s, m) cpp_offsetof(s, m)
2007-02-19 22:11:44 +01:00
# endif /* offsetof */
2007-01-14 22:03:21 +01:00
2004-08-09 19:04:08 +02:00
2007-02-04 12:20:24 +01:00
/* take care of some name clashes on MacOS */
2004-08-09 19:04:08 +02:00
# if defined(__APPLE__)
2007-12-02 22:43:16 +01:00
# define GetString OTTD_GetString
# define DrawString OTTD_DrawString
# define CloseConnection OTTD_CloseConnection
2007-12-23 15:06:03 +01:00
# endif /* __APPLE__ */
2007-12-02 22:43:16 +01:00
2009-05-10 19:27:25 +02:00
void NORETURN CDECL usererror ( const char * str , . . . ) WARN_FORMAT ( 1 , 2 ) ;
void NORETURN CDECL error ( const char * str , . . . ) WARN_FORMAT ( 1 , 2 ) ;
2007-05-17 22:00:45 +02:00
# define NOT_REACHED() error("NOT_REACHED triggered at line %i of %s", __LINE__, __FILE__)
2007-05-15 15:01:52 +02:00
2009-09-07 14:14:45 +02:00
/* For non-debug builds with assertions enabled use the special assertion handler:
* - For MSVC : NDEBUG is set for all release builds and WITH_ASSERT overrides the disabling of asserts .
* - For non MSVC : NDEBUG is set when assertions are disables , _DEBUG is set for non - release builds .
*/
# if (defined(_MSC_VER) && defined(NDEBUG) && defined(WITH_ASSERT)) || (!defined(_MSC_VER) && !defined(NDEBUG) && !defined(_DEBUG))
# undef assert
# define assert(expression) if (!(expression)) error("Assertion failed at line %i of %s: %s", __LINE__, __FILE__, #expression);
# endif
2008-11-26 14:12:45 +01:00
# if defined(MORPHOS) || defined(__NDS__) || defined(__DJGPP__)
2008-01-22 00:55:57 +01:00
/* MorphOS and NDS don't have C++ conformant _stricmp... */
2007-12-02 22:43:16 +01:00
# define _stricmp stricmp
2007-07-17 18:59:21 +02:00
# elif defined(OPENBSD)
2007-12-02 22:43:16 +01:00
/* OpenBSD uses strcasecmp(3) */
# define _stricmp strcasecmp
2007-07-17 18:59:21 +02:00
# endif
2007-07-16 11:16:58 +02:00
# if !defined(MAX_PATH)
2007-12-02 22:43:16 +01:00
# define MAX_PATH 260
2007-07-16 11:16:58 +02:00
# endif
2007-12-23 11:56:02 +01:00
/**
* The largest value that can be entered in a variable
* @ param type the type of the variable
*/
# define MAX_UVALUE(type) ((type)~(type)0)
2005-09-18 22:56:44 +02:00
# endif /* STDAFX_H */