scummvm/common/scummsys.h
2009-09-27 22:42:21 +00:00

450 lines
10 KiB
C

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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; either version 2
* of the License, or (at your option) any later version.
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*
*/
#ifndef COMMON_SCUMMSYS_H
#define COMMON_SCUMMSYS_H
#if defined(_WIN32_WCE) && _WIN32_WCE < 300
#define NONSTANDARD_PORT
#endif
#if defined(NONSTANDARD_PORT)
// Ports which need to perform #includes and #defines visible in
// virtually all the source of ScummVM should do so by providing a
// "portdefs.h" header file (and not by directly modifying this
// header file).
#include <portdefs.h>
#else // defined(NONSTANDARD_PORT)
#if defined(WIN32)
#ifdef _MSC_VER
// vsnprintf is already defined in Visual Studio 2008
#if (_MSC_VER < 1500)
#define vsnprintf _vsnprintf
#endif
#endif
#if !defined(_WIN32_WCE)
#define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers
#define NOGDICAPMASKS
#define OEMRESOURCE
#define NONLS
#define NOICONS
#define NOMCX
#define NOPROFILER
#define NOKANJI
#define NOSERVICE
#define NOMETAFILE
#define NOCOMM
#define NOCRYPT
#define NOIME
#define NOATOM
#define NOCTLMGR
#define NOCLIPBOARD
#define NOMEMMGR
#define NOSYSMETRICS
#define NOMENUS
#define NOOPENFILE
#define NOWH
#define NOSOUND
#define NODRAWTEXT
#endif
#if defined(ARRAYSIZE)
// VS2005beta2 introduces new stuff in winnt.h
#undef ARRAYSIZE
#endif
#endif
#if defined(__QNXNTO__)
#include <strings.h> /* For strcasecmp */
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
#include <assert.h>
#include <ctype.h>
#include <math.h>
#endif
// Use config.h, generated by configure
#if defined(HAVE_CONFIG_H)
#include "config.h"
#endif
// make sure we really are compiling for WIN32
#ifndef WIN32
#undef _MSC_VER
#endif
// In the following we configure various targets, in particular those
// which can't use our "configure" tool and hence don't use config.h.
//
// Some #defines that occur here frequently:
// SCUMM_LITTLE_ENDIAN
// - Define this on a little endian target
// SCUMM_BIG_ENDIAN
// - Define this on a big endian target
// SCUMM_NEED_ALIGNMENT
// - Define this if your system has problems reading e.g. an int32 from an odd address
// SCUMMVM_USE_LONG_INT
// - Define this if your port needs to use 'long' for the int32 datatype
// (i.e. an integer with exactly 32 bits).
// SCUMMVM_DONT_DEFINE_TYPES
// - Define this if you need to provide your own typedefs, e.g. because your
// system headers conflict with our typenames, or because you have odd
// type requirements.
// SMALL_SCREEN_DEVICE
// - ...
// ...
// We define all types in config.h, so we don't want to typedef those types
// here again!
#ifdef HAVE_CONFIG_H
#define SCUMMVM_DONT_DEFINE_TYPES
#endif
//
// By default we try to use pragma push/pop to ensure various structs we use
// are "packed". If your compiler doesn't support this pragma, you are in for
// a problem. If you are lucky, there is a compiler switch, or another pragma,
// doing the same thing -- in that case, try to modify common/pack-begin.h and
// common/pack-end.h accordingly. Or maybe your port simply *always* packs
// everything, in which case you could #undefine SCUMMVM_USE_PRAGMA_PACK.
//
// If neither is possible, tough luck. Try to contact the team, maybe we can
// come up with a solution, though I wouldn't hold my breath on it :-/.
//
#define SCUMMVM_USE_PRAGMA_PACK
#if defined(__SYMBIAN32__)
#define scumm_stricmp strcasecmp
#define scumm_strnicmp strncasecmp
#define SCUMM_LITTLE_ENDIAN
#define SCUMM_NEED_ALIGNMENT
#define SMALL_SCREEN_DEVICE
// Enable Symbians own datatypes
// This is done for two reasons
// a) uint is already defined by Symbians libc component
// b) Symbian is using its "own" datatyping, and the Scummvm port
// should follow this to ensure the best compability possible.
#define SCUMMVM_DONT_DEFINE_TYPES
typedef unsigned char byte;
typedef unsigned char uint8;
typedef signed char int8;
typedef unsigned short int uint16;
typedef signed short int int16;
typedef unsigned long int uint32;
typedef signed long int int32;
#elif defined(_WIN32_WCE)
#define scumm_stricmp stricmp
#define scumm_strnicmp _strnicmp
#define snprintf _snprintf
#define SCUMM_LITTLE_ENDIAN
#ifndef __GNUC__
#define FORCEINLINE __forceinline
#define NORETURN __declspec(noreturn)
#endif
#define PLUGIN_EXPORT __declspec(dllexport)
#if _WIN32_WCE < 300
#define SMALL_SCREEN_DEVICE
#endif
typedef signed char int8_t;
typedef signed short int16_t;
typedef unsigned char uint8_t;
typedef unsigned short uint16_t;
#elif defined(_MSC_VER)
#define scumm_stricmp stricmp
#define scumm_strnicmp _strnicmp
#define snprintf _snprintf
#define SCUMM_LITTLE_ENDIAN
#define FORCEINLINE __forceinline
#define NORETURN __declspec(noreturn)
#define PLUGIN_EXPORT __declspec(dllexport)
typedef signed char int8_t;
typedef signed short int16_t;
typedef unsigned char uint8_t;
typedef unsigned short uint16_t;
#if !defined(SDL_COMPILEDVERSION) || (SDL_COMPILEDVERSION < 1210)
typedef signed long int32_t;
typedef unsigned long uint32_t;
#endif
#elif defined(__MINGW32__)
#define scumm_stricmp stricmp
#define scumm_strnicmp strnicmp
#define SCUMM_LITTLE_ENDIAN
#define PLUGIN_EXPORT __declspec(dllexport)
#elif defined(UNIX)
#define scumm_stricmp strcasecmp
#define scumm_strnicmp strncasecmp
#ifndef CONFIG_H
/* need this for the SDL_BYTEORDER define */
#include <SDL_byteorder.h>
#if SDL_BYTEORDER == SDL_LIL_ENDIAN
#define SCUMM_LITTLE_ENDIAN
#elif SDL_BYTEORDER == SDL_BIG_ENDIAN
#define SCUMM_BIG_ENDIAN
#else
#error Neither SDL_BIG_ENDIAN nor SDL_LIL_ENDIAN is set.
#endif
#endif
// You need to set this manually if necessary
// #define SCUMM_NEED_ALIGNMENT
#if defined(__DECCXX) // Assume alpha architecture
#define INVERSE_MKID
#define SCUMM_NEED_ALIGNMENT
#endif
#elif defined(__PALMOS_TRAPS__) || defined (__PALMOS_ARMLET__)
#ifdef __PALMOS_ARMLET__
#include <extras_string.h>
#endif
#define SCUMM_LITTLE_ENDIAN
#define scumm_stricmp stricmp
#define scumm_strnicmp strnicmp
#define SCUMM_NEED_ALIGNMENT
#define STRINGBUFLEN 256
extern const char *SCUMMVM_SAVEPATH;
#if !defined(COMPILE_ZODIAC) && !defined(COMPILE_OS5)
# define NEWGUI_256
#else
# undef UNUSED
#endif
#elif defined(__DC__)
#define scumm_stricmp strcasecmp
#define scumm_strnicmp strncasecmp
#define SCUMM_LITTLE_ENDIAN
#define SCUMM_NEED_ALIGNMENT
#elif defined(__GP32__)
#define scumm_stricmp stricmp
#define scumm_strnicmp strnicmp
#define SCUMM_LITTLE_ENDIAN
#define SCUMM_NEED_ALIGNMENT
// Override typenames. uint is already defined by system header files.
#define SCUMMVM_DONT_DEFINE_TYPES
typedef unsigned char byte;
typedef unsigned char uint8;
typedef signed char int8;
typedef unsigned short int uint16;
typedef signed short int int16;
typedef unsigned long int uint32;
typedef signed long int int32;
#elif defined(__PLAYSTATION2__)
#define scumm_stricmp strcasecmp
#define scumm_strnicmp strncasecmp
#define SCUMM_LITTLE_ENDIAN
#define SCUMM_NEED_ALIGNMENT
#elif defined(__PSP__)
#include <malloc.h>
#define scumm_stricmp strcasecmp
#define scumm_strnicmp strncasecmp
#define SCUMM_LITTLE_ENDIAN
#define SCUMM_NEED_ALIGNMENT
#elif defined(__amigaos4__)
#define scumm_stricmp strcasecmp
#define scumm_strnicmp strncasecmp
#define SCUMM_BIG_ENDIAN
#define SCUMM_NEED_ALIGNMENT
#elif defined (__DS__)
#define scumm_stricmp stricmp
#define scumm_strnicmp strnicmp
#define SCUMM_NEED_ALIGNMENT
#define SCUMM_LITTLE_ENDIAN
#define SCUMMVM_DONT_DEFINE_TYPES
#define STRINGBUFLEN 256
// #define printf(fmt, ...) consolePrintf(fmt, ##__VA_ARGS__)
#elif defined(__WII__)
#define scumm_stricmp strcasecmp
#define scumm_strnicmp strncasecmp
#define SCUMM_BIG_ENDIAN
#define SCUMM_NEED_ALIGNMENT
#else
#error No system type defined
#endif
//
// GCC specific stuff
//
#if defined(__GNUC__)
#define NORETURN __attribute__((__noreturn__))
#define PACKED_STRUCT __attribute__((__packed__))
#define GCC_PRINTF(x,y) __attribute__((__format__(printf, x, y)))
#if !defined(FORCEINLINE) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
#define FORCEINLINE inline __attribute__((__always_inline__))
#endif
#else
#define PACKED_STRUCT
#define GCC_PRINTF(x,y)
#endif
//
// Fallbacks / default values for various special macros
//
#ifndef FORCEINLINE
#define FORCEINLINE inline
#endif
#ifndef PLUGIN_EXPORT
#define PLUGIN_EXPORT
#endif
#ifndef NORETURN
#define NORETURN
#endif
#ifndef STRINGBUFLEN
#define STRINGBUFLEN 1024
#endif
#ifndef PI
#define PI 3.14159265358979323846
#endif
#ifndef MAXPATHLEN
#define MAXPATHLEN 256
#endif
//
// Typedef our system types unless SCUMMVM_DONT_DEFINE_TYPES is set.
//
#ifndef SCUMMVM_DONT_DEFINE_TYPES
typedef unsigned char byte;
typedef unsigned char uint8;
typedef signed char int8;
typedef unsigned short uint16;
typedef signed short int16;
#ifdef SCUMMVM_USE_LONG_INT
typedef unsigned long uint32;
typedef signed long int32;
typedef unsigned long uint;
#else
typedef unsigned int uint32;
typedef signed int int32;
typedef unsigned int uint;
#endif
#endif
//
// Overlay color type (FIXME: shouldn't be declared here)
//
#if defined(NEWGUI_256)
// 256 color only on PalmOS
typedef byte OverlayColor;
#else
// 15/16 bit color mode everywhere else...
typedef uint16 OverlayColor;
#endif
#endif