1

/* $Id$ */

     2

     3

/** @file stdafx.h Definition of base types and functions in a cross-platform compatible way. */

     4

     5

#ifndef STDAFX_H

     6

#define STDAFX_H

     7

     8

#if defined(__NDS__)

     9

	#include <nds/jtypes.h>

    10

	/* NDS' types for uint32/int32 are based on longs, which causes

    11

	 * trouble all over the place in OpenTTD. */

    12

	#define uint32 uint32_ugly_hack

    13

	#define int32 int32_ugly_hack

    14

	typedef unsigned int uint32_ugly_hack;

    15

	typedef signed int int32_ugly_hack;

    16

#endif /* __NDS__ */

    17

    18

/* It seems that we need to include stdint.h before anything else

    19

 * We need INT64_MAX, which for most systems comes from stdint.h. However, MSVC

    20

 * does not have stdint.h and apparently neither does MorphOS, so define

    21

 * INT64_MAX for them ourselves.

    22

 * Sometimes OSX headers manages to include stdint.h before this but without

    23

 * __STDC_LIMIT_MACROS so it will be without INT64_*. We need to define those

    24

 * too if this is the case. */

    25

#if !defined(_MSC_VER) && !defined( __MORPHOS__) && !defined(_STDINT_H_)

    26

	#if defined(SUNOS)

    27

		/* SunOS/Solaris does not have stdint.h, but inttypes.h defines everything

    28

		 * stdint.h defines and we need. */

    29

		#include <inttypes.h>

    30

	# else

    31

		#define __STDC_LIMIT_MACROS

    32

		#include <stdint.h>

    33

	#endif

    34

#else

    35

	#define UINT64_MAX (18446744073709551615ULL)

    36

	#define INT64_MAX  (9223372036854775807LL)

    37

	#define INT64_MIN  (-INT64_MAX - 1)

    38

	#define UINT32_MAX (4294967295U)

    39

	#define INT32_MAX  (2147483647)

    40

	#define INT32_MIN  (-INT32_MAX - 1)

    41

	#define UINT16_MAX (65535U)

    42

	#define INT16_MAX  (32767)

    43

	#define INT16_MIN  (-INT16_MAX - 1)

    44

#endif

    45

    46

#include <cstdio>

    47

#include <cstddef>

    48

#include <cstring>

    49

#include <cstdlib>

    50

#include <climits>

    51

    52

/* MacOS X will use an NSAlert to display failed assertaions since they're lost unless running from a terminal

    53

 * strgen always runs from terminal and don't need a window for asserts */

    54

#if !defined(__APPLE__) || defined(STRGEN)

    55

	#include <cassert>

    56

#else

    57

	#include "os/macosx/macos.h"

    58

#endif

    59

    60

#if defined(UNIX) || defined(__MINGW32__)

    61

	#include <sys/types.h>

    62

#endif

    63

    64

#if defined(__OS2__)

    65

	#include <types.h>

    66

	#define strcasecmp stricmp

    67

#endif

    68

    69

#if defined(PSP)

    70

	#include <psptypes.h>

    71

	#include <pspdebug.h>

    72

	#include <pspthreadman.h>

    73

#endif

    74

    75

#if defined(__BEOS__)

    76

	#include <SupportDefs.h>

    77

#endif

    78

    79

#if defined(SUNOS) || defined(HPUX)

    80

	#include <alloca.h>

    81

#endif

    82

    83

#if defined(__MORPHOS__)

    84

	/* MorphOS defines certain Amiga defines per default, we undefine them

    85

	 * here to make the rest of source less messy and more clear what is

    86

	 * required for morphos and what for AmigaOS */

    87

	#if defined(amigaos)

    88

		#undef amigaos

    89

	#endif

    90

	#if defined(__amigaos__)

    91

		#undef __amigaos__

    92

	# endif

    93

	#if defined(__AMIGA__)

    94

		#undef __AMIGA__

    95

	#endif

    96

	#if defined(AMIGA)

    97

		#undef AMIGA

    98

	#endif

    99

	#if defined(amiga)

   100

		#undef amiga

   101

	#endif

   102

	/* Act like we already included this file, as it somehow gives linkage problems

   103

	 *  (mismatch linkage of C++ and C between this include and unistd.h). */

   104

	#define CLIB_USERGROUP_PROTOS_H

   105

#endif /* __MORPHOS__ */

   106

   107

#if defined(__APPLE__)

   108

	#include "os/macosx/osx_stdafx.h"

   109

#endif /* __APPLE__ */

   110

   111

#if defined(PSP)

   112

	/* PSP can only have 10 file-descriptors open at any given time, but this

   113

	 *  switch only limits reads via the Fio system. So keep 2 fds free for things

   114

	 *  like saving a game. */

   115

	#define LIMITED_FDS 8

   116

	#define printf pspDebugScreenPrintf

   117

#endif /* PSP */

   118

   119

/* by default we use [] var arrays */

   120

#define VARARRAY_SIZE

   121

   122

/* Stuff for GCC */

   123

#if defined(__GNUC__)

   124

	#define NORETURN __attribute__ ((noreturn))

   125

	#define FORCEINLINE inline

   126

	#define CDECL

   127

	#define __int64 long long

   128

	#define GCC_PACK __attribute__((packed))

   129

   130

	#if (__GNUC__ == 2)

   131

		#undef VARARRAY_SIZE

   132

		#define VARARRAY_SIZE 0

   133

	#endif

   134

#endif /* __GNUC__ */

   135

   136

#if defined(__WATCOMC__)

   137

	#define NORETURN

   138

	#define FORCEINLINE inline

   139

	#define CDECL

   140

	#define GCC_PACK

   141

	#include <malloc.h>

   142

#endif /* __WATCOMC__ */

   143

   144

#if defined(__MINGW32__) || defined(__CYGWIN__)

   145

	#include <malloc.h> // alloca()

   146

#endif

   147

   148

#if defined(__MINGW32__) && defined(_GNU_SOURCE)

   149

	/* For some weird reasons, SDL defines _GNU_SOURCE */

   150

	#undef _GNU_SOURCE

   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 a win32 target platform, to override defaults of the SDK

   161

	 * We need to define NTDDI version for Vista SDK, but win2k is minimum */

   162

	#define NTDDI_VERSION NTDDI_WIN2K // Windows 2000

   163

	#define _WIN32_WINNT 0x0500       // Windows 2000

   164

	#define _WIN32_WINDOWS 0x400      // Windows 95

   165

	#if !defined(WINCE)

   166

		#define WINVER 0x0400     // Windows NT 4.0 / Windows 95

   167

	#endif

   168

	#define _WIN32_IE_ 0x0401         // 4.01 (win98 and NT4SP5+)

   169

   170

	#pragma warning(disable: 4244)  // 'conversion' conversion from 'type1' to 'type2', possible loss of data

   171

	#pragma warning(disable: 4761)  // integral size mismatch in argument : conversion supplied

   172

	#pragma warning(disable: 4200)  // nonstandard extension used : zero-sized array in struct/union

   173

   174

	#if (_MSC_VER < 1400)                   // MSVC 2005 safety checks

   175

		#error "Only MSVC 2005 or higher are supported. MSVC 2003 and earlier are not!. Upgrade your compiler."

   176

	#endif /* (_MSC_VER < 1400) */

   177

	#pragma warning(disable: 4996)   // 'strdup' was declared deprecated

   178

	#define _CRT_SECURE_NO_DEPRECATE // all deprecated 'unsafe string functions

   179

	#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

   180

	#pragma warning(disable: 6011)   // code analyzer: Dereferencing NULL pointer 'pfGetAddrInfo': Lines: 995, 996, 998, 999, 1001

   181

	#pragma warning(disable: 6326)   // code analyzer: potential comparison of a constant with another constant

   182

	#pragma warning(disable: 6031)   // code analyzer: Return value ignored: 'ReadFile'

   183

	#pragma warning(disable: 6255)   // code analyzer: _alloca indicates failure by raising a stack overflow exception. Consider using _malloca instead

   184

	#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 ...

   185

   186

	#include <malloc.h> // alloca()

   187

	#define NORETURN __declspec(noreturn)

   188

	#define FORCEINLINE __forceinline

   189

	#define inline _inline

   190

   191

	#if !defined(WINCE)

   192

		#define CDECL _cdecl

   193

	#endif

   194

   195

	int CDECL snprintf(char *str, size_t size, const char *format, ...);

   196

	#if (_MSC_VER < 1400) || defined(WINCE)

   197

		int CDECL vsnprintf(char *str, size_t size, const char *format, va_list ap);

   198

	#endif

   199

   200

	#if defined(WIN32) && !defined(_WIN64) && !defined(WIN64)

   201

		#if !defined(_W64)

   202

			#define _W64

   203

		#endif

   204

   205

		typedef _W64 int INT_PTR, *PINT_PTR;

   206

		typedef _W64 unsigned int UINT_PTR, *PUINT_PTR;

   207

	#endif /* WIN32 && !_WIN64 && !WIN64 */

   208

   209

	#if defined(_WIN64) || defined(WIN64)

   210

		#define fseek _fseeki64

   211

	#endif /* _WIN64 || WIN64 */

   212

   213

   214

	#define GCC_PACK

   215

   216

	/* This is needed to zlib uses the stdcall calling convention on visual studio */

   217

	#if defined(WITH_ZLIB) || defined(WITH_PNG)

   218

		#if !defined(ZLIB_WINAPI)

   219

			#define ZLIB_WINAPI

   220

		#endif

   221

	#endif

   222

   223

	#if defined(WINCE)

   224

		#define strcasecmp _stricmp

   225

		#define strncasecmp _strnicmp

   226

		#undef DEBUG

   227

	#else

   228

		#define strcasecmp stricmp

   229

		#define strncasecmp strnicmp

   230

	#endif

   231

   232

	void SetExceptionString(const char* s, ...);

   233

   234

	#if defined(NDEBUG) && defined(WITH_ASSERT)

   235

		#undef assert

   236

		#define assert(expression) if (!(expression)) { SetExceptionString("Assertion failed at %s:%d: %s", __FILE__, __LINE__, #expression); *(byte*)0 = 0; }

   237

	#endif

   243

#endif /* defined(_MSC_VER) */

   244

   245

#if defined(WINCE)

   246

	#define strdup _strdup

   247

#endif /* WINCE */

   248

   249

/* NOTE: the string returned by these functions is only valid until the next

   250

 * call to the same function and is not thread- or reentrancy-safe */

   251

#if !defined(STRGEN)

   252

	#if defined(WIN32) || defined(WIN64)

   253

		char *getcwd(char *buf, size_t size);

   254

		#include <tchar.h>

   255

   256

		/* XXX - WinCE without MSVCRT doesn't support wfopen, so it seems */

   257

		#if !defined(WINCE)

   258

			#define fopen(file, mode) _tfopen(OTTD2FS(file), _T(mode))

   259

		#endif /* WINCE */

   260

   261

		const char *FS2OTTD(const TCHAR *name);

   262

		const TCHAR *OTTD2FS(const char *name);

   263

	#else

   264

		#define fopen(file, mode) fopen(OTTD2FS(file), mode)

   265

		const char *FS2OTTD(const char *name);

   266

		const char *OTTD2FS(const char *name);

   267

	#endif /* WIN32 */

   268

#endif /* STRGEN */

   269

   270

#if defined(WIN32) || defined(WIN64) || defined(__OS2__) && !defined(__INNOTEK_LIBC__)

   271

	#define PATHSEP "\\"

   272

	#define PATHSEPCHAR '\\'

   273

#else

   274

	#define PATHSEP "/"

   275

	#define PATHSEPCHAR '/'

   276

#endif

   277

   278

typedef unsigned char byte;

   279

   280

/* This is already defined in unix, but not in QNX Neutrino (6.x)*/

   281

#if (!defined(UNIX) && !defined(__CYGWIN__) && !defined(__BEOS__) && !defined(__MORPHOS__)) || defined(__QNXNTO__)

   282

	typedef unsigned int uint;

   283

#endif

   284

   285

#if !defined(__BEOS__) && !defined(__NDS__) /* Already defined on BEOS and NDS */

   286

	typedef unsigned char    uint8;

   287

	typedef   signed char     int8;

   288

	typedef unsigned short   uint16;

   289

	typedef   signed short    int16;

   290

	typedef unsigned int     uint32;

   291

	typedef   signed int      int32;

   292

	typedef unsigned __int64 uint64;

   293

	typedef   signed __int64  int64;

   294

#endif /* !__BEOS__ && !__NDS__ */

   295

   296

#if !defined(WITH_PERSONAL_DIR)

   297

	#define PERSONAL_DIR ""

   298

#endif

   299

   300

/* Compile time assertions */

   301

#if defined(__OS2__)

   302

	#define assert_compile(expr)

   303

#else

   304

	#define assert_compile(expr) extern const int __ct_assert__[1 - 2 * !(expr)]

   305

#endif /* __OS2__ */

   306

   307

/* Check if the types have the bitsizes like we are using them */

   308

assert_compile(sizeof(uint64) == 8);

   309

assert_compile(sizeof(uint32) == 4);

   310

assert_compile(sizeof(uint16) == 2);

   311

assert_compile(sizeof(uint8)  == 1);

   312

   313

/**

   314

 * Return the length of an fixed size array.

   315

 * Unlike sizeof this function returns the number of elements

   316

 * of the given type.

   317

 *

   318

 * @param x The pointer to the first element of the array

   319

 * @return The number of elements

   320

 */

   321

#define lengthof(x) (sizeof(x) / sizeof(x[0]))

   322

   323

/**

   324

 * Get the end element of an fixed size array.

   325

 *

   326

 * @param x The pointer to the first element of the array

   327

 * @return The pointer past to the last element of the array

   328

 */

   329

#define endof(x) (&x[lengthof(x)])

   330

   331

/**

   332

 * Get the last element of an fixed size array.

   333

 *

   334

 * @param x The pointer to the first element of the array

   335

 * @return The pointer to the last element of the array

   336

 */

   337

#define lastof(x) (&x[lengthof(x) - 1])

   338

   339

#define cpp_offsetof(s, m)   (((size_t)&reinterpret_cast<const volatile char&>((((s*)(char*)8)->m))) - 8)

   340

#if !defined(offsetof)

   341

	#define offsetof(s, m) cpp_offsetof(s, m)

   342

#endif /* offsetof */

   343

   344

   345

/* take care of some name clashes on MacOS */

   346

#if defined(__APPLE__)

   347

	#define GetString OTTD_GetString

   348

	#define DrawString OTTD_DrawString

   349

	#define CloseConnection OTTD_CloseConnection

   350

#endif /* __APPLE__ */

   351

   352

void NORETURN CDECL usererror(const char *str, ...);

   353

void NORETURN CDECL error(const char *str, ...);

   354

#define NOT_REACHED() error("NOT_REACHED triggered at line %i of %s", __LINE__, __FILE__)

   355

   356

#if defined(MORPHOS) || defined(__NDS__)

   357

	/* MorphOS and NDS don't have C++ conformant _stricmp... */

   358

	#define _stricmp stricmp

   359

#elif defined(OPENBSD)

   360

	/* OpenBSD uses strcasecmp(3) */

   361

	#define _stricmp strcasecmp

   362

#endif

   363

   364

#if !defined(MORPHOS) && !defined(OPENBSD) && !defined(__NDS__)

   365

	/* NDS, MorphOS & OpenBSD don't know wchars, the rest does :( */

   366

	#define HAS_WCHAR

   367

#endif /* !defined(MORPHOS) && !defined(OPENBSD) && !defined(__NDS__) */

   368

   369

#if !defined(MAX_PATH)

   370

	#define MAX_PATH 260

   371

#endif

   372

   373

/**

   374

 * The largest value that can be entered in a variable

   375

 * @param type the type of the variable

   376

 */

   377

#define MAX_UVALUE(type) ((type)~(type)0)

   378

   379

#endif /* STDAFX_H */