/*

    SDL - Simple DirectMedia Layer

    Copyright (C) 1997-2009 Sam Lantinga

    This library is free software; you can redistribute it and/or

    modify it under the terms of the GNU Lesser General Public

    License as published by the Free Software Foundation; either

    version 2.1 of the License, or (at your option) any later version.

    This library 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

    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public

    License along with this library; if not, write to the Free Software

    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    Sam Lantinga

    slouken@libsdl.org

*/

/**

 *  \file SDL_stdinc.h

 *  

 *  This is a general header that includes C language support.

 */

#ifndef _SDL_stdinc_h

#define _SDL_stdinc_h

#include "SDL_config.h"

#ifdef HAVE_SYS_TYPES_H

#include <sys/types.h>

#endif

#ifdef HAVE_STDIO_H

#include <stdio.h>

#endif

#if defined(STDC_HEADERS)

# include <stdlib.h>

# include <stddef.h>

# include <stdarg.h>

#else

# if defined(HAVE_STDLIB_H)

#  include <stdlib.h>

# elif defined(HAVE_MALLOC_H)

#  include <malloc.h>

# endif

# if defined(HAVE_STDDEF_H)

#  include <stddef.h>

# endif

# if defined(HAVE_STDARG_H)

#  include <stdarg.h>

# endif

#endif

#ifdef HAVE_STRING_H

# if !defined(STDC_HEADERS) && defined(HAVE_MEMORY_H)

#  include <memory.h>

# endif

# include <string.h>

#endif

#ifdef HAVE_STRINGS_H

# include <strings.h>

#endif

#if defined(HAVE_INTTYPES_H)

# include <inttypes.h>

#elif defined(HAVE_STDINT_H)

# include <stdint.h>

#endif

#ifdef HAVE_CTYPE_H

# include <ctype.h>

#endif

#ifdef HAVE_MATH_H

# include <math.h>

#endif

#if defined(HAVE_ICONV) && defined(HAVE_ICONV_H)

# include <iconv.h>

#endif

/**

 *  The number of elements in an array.

 */

#define SDL_arraysize(array)	(sizeof(array)/sizeof(array[0]))

#define SDL_TABLESIZE(table)	SDL_arraysize(table)

/**

 *  \name Cast operators

 *  

 *  Use proper C++ casts when compiled as C++ to be compatible with the option

 *  -Wold-style-cast of GCC (and -Werror=old-style-cast in GCC 4.2 and above).

 */

/*@{*/

#ifdef __cplusplus

#define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression)

#define SDL_static_cast(type, expression) static_cast<type>(expression)

#else

#define SDL_reinterpret_cast(type, expression) ((type)(expression))

#define SDL_static_cast(type, expression) ((type)(expression))

#endif

/*@}*//*Cast operators*/

/**

 *  \name Basic data types

 */

/*@{*/

typedef enum

{

    SDL_FALSE = 0,

    SDL_TRUE = 1

} SDL_bool;

/**

 * \brief A signed 8-bit integer type.

 */

typedef int8_t Sint8;

/**

 * \brief An unsigned 8-bit integer type.

 */

typedef uint8_t Uint8;

/**

 * \brief A signed 16-bit integer type.

 */

typedef int16_t Sint16;

/**

 * \brief An unsigned 16-bit integer type.

 */

typedef uint16_t Uint16;

/**

 * \brief A signed 32-bit integer type.

 */

typedef int32_t Sint32;

/**

 * \brief An unsigned 32-bit integer type.

 */

typedef uint32_t Uint32;

#ifdef SDL_HAS_64BIT_TYPE

/**

 * \brief A signed 64-bit integer type.

 * \warning On platforms without any sort of 64-bit datatype, this is equivalent to Sint32!

 */

typedef int64_t Sint64;

/**

 * \brief An unsigned 64-bit integer type.

 * \warning On platforms without any sort of 64-bit datatype, this is equivalent to Uint32!

 */

typedef uint64_t Uint64;

#else

/* This is really just a hack to prevent the compiler from complaining */

typedef Sint32 Sint64;

typedef Uint32 Uint64;

#endif

/*@}*//*Basic data types*/

#define SDL_COMPILE_TIME_ASSERT(name, x)               \

       typedef int SDL_dummy_ ## name[(x) * 2 - 1]

/** \cond */

#ifndef DOXYGEN_SHOULD_IGNORE_THIS

SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);

SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);

SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);

SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);

SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);

SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);

#ifndef __NINTENDODS__          /* TODO: figure out why the following happens:

                                   include/SDL_stdinc.h:150: error: size of array 'SDL_dummy_uint64' is negative

                                   include/SDL_stdinc.h:151: error: size of array 'SDL_dummy_sint64' is negative */

SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);

SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);

#endif

#endif /* DOXYGEN_SHOULD_IGNORE_THIS */

/** \endcond */

/* Check to make sure enums are the size of ints, for structure packing.

   For both Watcom C/C++ and Borland C/C++ the compiler option that makes

   enums having the size of an int must be enabled.

   This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).

*/

/* Enable enums always int in CodeWarrior (for MPW use "-enum int") */

#ifdef __MWERKS__

#pragma enumsalwaysint on

#endif

/** \cond */

#ifndef DOXYGEN_SHOULD_IGNORE_THIS

#ifndef __NINTENDODS__          /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */

typedef enum

{

    DUMMY_ENUM_VALUE

} SDL_DUMMY_ENUM;

SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));

#endif

#endif /* DOXYGEN_SHOULD_IGNORE_THIS */

/** \endcond */

#include "begin_code.h"

/* Set up for C function definitions, even when using C++ */

#ifdef __cplusplus

/* *INDENT-OFF* */

extern "C" {

/* *INDENT-ON* */

#endif

#ifdef HAVE_MALLOC

#define SDL_malloc	malloc

#else

extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);

#endif

#ifdef HAVE_CALLOC

#define SDL_calloc	calloc

#else

extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);

#endif

#ifdef HAVE_REALLOC

#define SDL_realloc	realloc

#else

extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);

#endif

#ifdef HAVE_FREE

#define SDL_free	free

#else

extern DECLSPEC void SDLCALL SDL_free(void *mem);

#endif

#if defined(HAVE_ALLOCA) && !defined(alloca)

# if defined(HAVE_ALLOCA_H)

#  include <alloca.h>

# elif defined(__GNUC__)

#  define alloca __builtin_alloca

# elif defined(_MSC_VER)

#  include <malloc.h>

#  define alloca _alloca

# elif defined(__WATCOMC__)

#  include <malloc.h>

# elif defined(__BORLANDC__)

#  include <malloc.h>

# elif defined(__DMC__)

#  include <stdlib.h>

# elif defined(__AIX__)

#pragma alloca

# elif defined(__MRC__)

void *alloca(unsigned);

# else

char *alloca();

# endif

#endif

#ifdef HAVE_ALLOCA

#define SDL_stack_alloc(type, count)    (type*)alloca(sizeof(type)*(count))

#define SDL_stack_free(data)

#else

#define SDL_stack_alloc(type, count)    (type*)SDL_malloc(sizeof(type)*(count))

#define SDL_stack_free(data)            SDL_free(data)

#endif

#ifdef HAVE_GETENV

#define SDL_getenv	getenv

#else

extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);

#endif

/* SDL_putenv() has moved to SDL_compat. */

#ifdef HAVE_SETENV

#define SDL_setenv	setenv

#else

extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value,

                                       int overwrite);

#endif

#ifdef HAVE_QSORT

#define SDL_qsort	qsort

#else

extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size,

                                       int (*compare) (const void *,

                                                       const void *));

#endif

#ifdef HAVE_ABS

#define SDL_abs		abs

#else

#define SDL_abs(X)	((X) < 0 ? -(X) : (X))

#endif

#define SDL_min(x, y)	(((x) < (y)) ? (x) : (y))

#define SDL_max(x, y)	(((x) > (y)) ? (x) : (y))

#ifdef HAVE_CTYPE_H

#define SDL_isdigit(X)  isdigit(X)

#define SDL_isspace(X)  isspace(X)

#define SDL_toupper(X)  toupper(X)

#define SDL_tolower(X)  tolower(X)

#else

#define SDL_isdigit(X)  (((X) >= '0') && ((X) <= '9'))

#define SDL_isspace(X)  (((X) == ' ') || ((X) == '\t') || ((X) == '\r') || ((X) == '\n'))

#define SDL_toupper(X)  (((X) >= 'a') && ((X) <= 'z') ? ('A'+((X)-'a')) : (X))

#define SDL_tolower(X)  (((X) >= 'A') && ((X) <= 'Z') ? ('a'+((X)-'A')) : (X))

#endif

#ifdef HAVE_MEMSET

#define SDL_memset      memset

#else

extern DECLSPEC void *SDLCALL SDL_memset(void *dst, int c, size_t len);

#endif

#define SDL_zero(x)	SDL_memset(&(x), 0, sizeof((x)))

#define SDL_zerop(x)	SDL_memset((x), 0, sizeof(*(x)))

#if defined(__GNUC__) && defined(i386)

#define SDL_memset4(dst, val, len)				\

do {								\

	int u0, u1, u2;						\

	__asm__ __volatile__ (					\

		"cld\n\t"					\

		"rep ; stosl\n\t"				\

		: "=&D" (u0), "=&a" (u1), "=&c" (u2)		\

		: "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, len))	\

		: "memory" );					\

} while(0)

#endif

#ifndef SDL_memset4

#define SDL_memset4(dst, val, len)		\

do {						\

	unsigned _count = (len);		\

	unsigned _n = (_count + 3) / 4;		\

	Uint32 *_p = SDL_static_cast(Uint32 *, dst);		\

	Uint32 _val = (val);			\

	if (len == 0) break;			\

        switch (_count % 4) {			\

        case 0: do {    *_p++ = _val;		\

        case 3:         *_p++ = _val;		\

        case 2:         *_p++ = _val;		\

        case 1:         *_p++ = _val;		\

		} while ( --_n );		\

	}					\

} while(0)

#endif

/* We can count on memcpy existing on Mac OS X and being well-tuned. */

#if defined(__MACH__) && defined(__APPLE__)

#define SDL_memcpy(dst, src, len) memcpy(dst, src, len)

#elif defined(__GNUC__) && defined(i386)

#define SDL_memcpy(dst, src, len)					  \

do {									  \

	int u0, u1, u2;						  	  \

	__asm__ __volatile__ (						  \

		"cld\n\t"						  \

		"rep ; movsl\n\t"					  \

		"testb $2,%b4\n\t"					  \

		"je 1f\n\t"						  \

		"movsw\n"						  \

		"1:\ttestb $1,%b4\n\t"					  \

		"je 2f\n\t"						  \

		"movsb\n"						  \

		"2:"							  \

		: "=&c" (u0), "=&D" (u1), "=&S" (u2)			  \

		: "0" (SDL_static_cast(unsigned, len)/4), "q" (len), "1" (dst),"2" (src) \

		: "memory" );						  \

} while(0)

#endif

#ifndef SDL_memcpy

#ifdef HAVE_MEMCPY

#define SDL_memcpy      memcpy

#elif defined(HAVE_BCOPY)

#define SDL_memcpy(d, s, n)	bcopy((s), (d), (n))

#else

extern DECLSPEC void *SDLCALL SDL_memcpy(void *dst, const void *src,

                                         size_t len);

#endif

#endif

/* We can count on memcpy existing on Mac OS X and being well-tuned. */

#if defined(__MACH__) && defined(__APPLE__)

#define SDL_memcpy4(dst, src, len) memcpy(dst, src, (len)*4)

#elif defined(__GNUC__) && defined(i386)

#define SDL_memcpy4(dst, src, len)				\

do {								\

	int ecx, edi, esi;					\

	__asm__ __volatile__ (					\

		"cld\n\t"					\

		"rep ; movsl"					\

		: "=&c" (ecx), "=&D" (edi), "=&S" (esi)		\

		: "0" (SDL_static_cast(unsigned, len)), "1" (dst), "2" (src)	\

		: "memory" );					\

} while(0)

#endif

#ifndef SDL_memcpy4

#define SDL_memcpy4(dst, src, len)	SDL_memcpy(dst, src, (len) << 2)

#endif

#if defined(__GNUC__) && defined(i386)

#define SDL_revcpy(dst, src, len)			\

do {							\

	int u0, u1, u2;					\

	char *dstp = SDL_static_cast(char *, dst);			\

	char *srcp = SDL_static_cast(char *, src);			\

	int n = (len);					\

	if ( n >= 4 ) {					\

	__asm__ __volatile__ (				\

		"std\n\t"				\

		"rep ; movsl\n\t"			\

		"cld\n\t"				\

		: "=&c" (u0), "=&D" (u1), "=&S" (u2)	\

		: "0" (n >> 2),				\

		  "1" (dstp+(n-4)), "2" (srcp+(n-4))	\

		: "memory" );				\

	}						\

	switch (n & 3) {				\

		case 3: dstp[2] = srcp[2];		\

		case 2: dstp[1] = srcp[1];		\

		case 1: dstp[0] = srcp[0];		\

			break;				\

		default:				\

			break;				\

	}						\

} while(0)

#endif

#ifndef SDL_revcpy

extern DECLSPEC void *SDLCALL SDL_revcpy(void *dst, const void *src,

                                         size_t len);

#endif

#ifdef HAVE_MEMMOVE

#define SDL_memmove     memmove

#elif defined(HAVE_BCOPY)

#define SDL_memmove(d, s, n)	bcopy((s), (d), (n))

#else

#define SDL_memmove(dst, src, len)			\

do {							\

	if ( dst < src ) {				\

		SDL_memcpy(dst, src, len);		\

	} else {					\

		SDL_revcpy(dst, src, len);		\

	}						\

} while(0)

#endif

#ifdef HAVE_MEMCMP

#define SDL_memcmp      memcmp

#else

extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2,

                                       size_t len);

#endif

#ifdef HAVE_STRLEN

#define SDL_strlen      strlen

#else

extern DECLSPEC size_t SDLCALL SDL_strlen(const char *string);

#endif

#ifdef HAVE_WCSLEN

#define SDL_wcslen      wcslen

#else

#if !defined(wchar_t) && defined(__NINTENDODS__)

#define wchar_t short           /* TODO: figure out why libnds doesn't have this */

#endif

extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t * string);

#endif

#ifdef HAVE_STRLCPY

#define SDL_strlcpy     strlcpy

#else

extern DECLSPEC size_t SDLCALL SDL_strlcpy(char *dst, const char *src,

                                           size_t maxlen);

#endif

#ifdef HAVE_STRLCAT

#define SDL_strlcat    strlcat

#else

extern DECLSPEC size_t SDLCALL SDL_strlcat(char *dst, const char *src,

                                           size_t maxlen);

#endif

#ifdef HAVE_STRDUP

#define SDL_strdup     strdup

#else

extern DECLSPEC char *SDLCALL SDL_strdup(const char *string);

#endif

#ifdef HAVE__STRREV

#define SDL_strrev      _strrev

#else

extern DECLSPEC char *SDLCALL SDL_strrev(char *string);

#endif

#ifdef HAVE__STRUPR

#define SDL_strupr      _strupr

#else

extern DECLSPEC char *SDLCALL SDL_strupr(char *string);

#endif

#ifdef HAVE__STRLWR

#define SDL_strlwr      _strlwr

#else