2 SDL - Simple DirectMedia Layer
3 Copyright (C) 1997-2009 Sam Lantinga
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with this library; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
23 /** @file SDL_stdinc.h
24 * This is a general header that includes C language support
30 #include "SDL_config.h"
33 #ifdef HAVE_SYS_TYPES_H
34 #include <sys/types.h>
39 #if defined(STDC_HEADERS)
44 # if defined(HAVE_STDLIB_H)
46 # elif defined(HAVE_MALLOC_H)
49 # if defined(HAVE_STDDEF_H)
52 # if defined(HAVE_STDARG_H)
57 # if !defined(STDC_HEADERS) && defined(HAVE_MEMORY_H)
65 #if defined(HAVE_INTTYPES_H)
66 # include <inttypes.h>
67 #elif defined(HAVE_STDINT_H)
73 #if defined(HAVE_ICONV) && defined(HAVE_ICONV_H)
77 /** The number of elements in an array */
78 #define SDL_arraysize(array) (sizeof(array)/sizeof(array[0]))
79 #define SDL_TABLESIZE(table) SDL_arraysize(table)
81 /* Use proper C++ casts when compiled as C++ to be compatible with the option
82 -Wold-style-cast of GCC (and -Werror=old-style-cast in GCC 4.2 and above. */
84 #define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression)
85 #define SDL_static_cast(type, expression) static_cast<type>(expression)
87 #define SDL_reinterpret_cast(type, expression) ((type)(expression))
88 #define SDL_static_cast(type, expression) ((type)(expression))
91 /** @name Basic data types */
99 typedef uint8_t Uint8;
100 typedef int16_t Sint16;
101 typedef uint16_t Uint16;
102 typedef int32_t Sint32;
103 typedef uint32_t Uint32;
105 #ifdef SDL_HAS_64BIT_TYPE
106 typedef int64_t Sint64;
107 #ifndef SYMBIAN32_GCCE
108 typedef uint64_t Uint64;
111 /* This is really just a hack to prevent the compiler from complaining */
120 /** @name Make sure the types really have the right sizes */
122 #define SDL_COMPILE_TIME_ASSERT(name, x) \
123 typedef int SDL_dummy_ ## name[(x) * 2 - 1]
125 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
126 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
127 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
128 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
129 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
130 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
131 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
132 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
135 /** @name Enum Size Check
136 * Check to make sure enums are the size of ints, for structure packing.
137 * For both Watcom C/C++ and Borland C/C++ the compiler option that makes
138 * enums having the size of an int must be enabled.
139 * This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
141 /* Enable enums always int in CodeWarrior (for MPW use "-enum int") */
143 #pragma enumsalwaysint on
151 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
155 #include "begin_code.h"
156 /* Set up for C function definitions, even when using C++ */
162 #define SDL_malloc malloc
164 extern DECLSPEC void * SDLCALL SDL_malloc(size_t size);
168 #define SDL_calloc calloc
170 extern DECLSPEC void * SDLCALL SDL_calloc(size_t nmemb, size_t size);
174 #define SDL_realloc realloc
176 extern DECLSPEC void * SDLCALL SDL_realloc(void *mem, size_t size);
180 #define SDL_free free
182 extern DECLSPEC void SDLCALL SDL_free(void *mem);
185 #if defined(HAVE_ALLOCA) && !defined(alloca)
186 # if defined(HAVE_ALLOCA_H)
188 # elif defined(__GNUC__)
189 # define alloca __builtin_alloca
190 # elif defined(_MSC_VER)
192 # define alloca _alloca
193 # elif defined(__WATCOMC__)
195 # elif defined(__BORLANDC__)
197 # elif defined(__DMC__)
199 # elif defined(__AIX__)
201 # elif defined(__MRC__)
202 void *alloca (unsigned);
208 #define SDL_stack_alloc(type, count) (type*)alloca(sizeof(type)*(count))
209 #define SDL_stack_free(data)
211 #define SDL_stack_alloc(type, count) (type*)SDL_malloc(sizeof(type)*(count))
212 #define SDL_stack_free(data) SDL_free(data)
216 #define SDL_getenv getenv
218 extern DECLSPEC char * SDLCALL SDL_getenv(const char *name);
222 #define SDL_putenv putenv
224 extern DECLSPEC int SDLCALL SDL_putenv(const char *variable);
228 #define SDL_qsort qsort
230 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size,
231 int (*compare)(const void *, const void *));
237 #define SDL_abs(X) ((X) < 0 ? -(X) : (X))
240 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
241 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
244 #define SDL_isdigit(X) isdigit(X)
245 #define SDL_isspace(X) isspace(X)
246 #define SDL_toupper(X) toupper(X)
247 #define SDL_tolower(X) tolower(X)
249 #define SDL_isdigit(X) (((X) >= '0') && ((X) <= '9'))
250 #define SDL_isspace(X) (((X) == ' ') || ((X) == '\t') || ((X) == '\r') || ((X) == '\n'))
251 #define SDL_toupper(X) (((X) >= 'a') && ((X) <= 'z') ? ('A'+((X)-'a')) : (X))
252 #define SDL_tolower(X) (((X) >= 'A') && ((X) <= 'Z') ? ('a'+((X)-'A')) : (X))
256 #define SDL_memset memset
258 extern DECLSPEC void * SDLCALL SDL_memset(void *dst, int c, size_t len);
261 #if defined(__GNUC__) && defined(i386)
262 #define SDL_memset4(dst, val, len) \
265 __asm__ __volatile__ ( \
268 : "=&D" (u0), "=&a" (u1), "=&c" (u2) \
269 : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, len)) \
274 #define SDL_memset4(dst, val, len) \
276 unsigned _count = (len); \
277 unsigned _n = (_count + 3) / 4; \
278 Uint32 *_p = SDL_static_cast(Uint32 *, dst); \
279 Uint32 _val = (val); \
280 if (len == 0) break; \
281 switch (_count % 4) { \
282 case 0: do { *_p++ = _val; \
283 case 3: *_p++ = _val; \
284 case 2: *_p++ = _val; \
285 case 1: *_p++ = _val; \
291 /* We can count on memcpy existing on Mac OS X and being well-tuned. */
292 #if defined(__MACH__) && defined(__APPLE__)
293 #define SDL_memcpy(dst, src, len) memcpy(dst, src, len)
294 #elif defined(__GNUC__) && defined(i386)
295 #define SDL_memcpy(dst, src, len) \
298 __asm__ __volatile__ ( \
304 "1:\ttestb $1,%b4\n\t" \
308 : "=&c" (u0), "=&D" (u1), "=&S" (u2) \
309 : "0" (SDL_static_cast(unsigned, len)/4), "q" (len), "1" (dst),"2" (src) \
315 #define SDL_memcpy memcpy
316 #elif defined(HAVE_BCOPY)
317 #define SDL_memcpy(d, s, n) bcopy((s), (d), (n))
319 extern DECLSPEC void * SDLCALL SDL_memcpy(void *dst, const void *src, size_t len);
323 /* We can count on memcpy existing on Mac OS X and being well-tuned. */
324 #if defined(__MACH__) && defined(__APPLE__)
325 #define SDL_memcpy4(dst, src, len) memcpy(dst, src, (len)*4)
326 #elif defined(__GNUC__) && defined(i386)
327 #define SDL_memcpy4(dst, src, len) \
330 __asm__ __volatile__ ( \
333 : "=&c" (ecx), "=&D" (edi), "=&S" (esi) \
334 : "0" (SDL_static_cast(unsigned, len)), "1" (dst), "2" (src) \
339 #define SDL_memcpy4(dst, src, len) SDL_memcpy(dst, src, (len) << 2)
342 #if defined(__GNUC__) && defined(i386)
343 #define SDL_revcpy(dst, src, len) \
346 char *dstp = SDL_static_cast(char *, dst); \
347 char *srcp = SDL_static_cast(char *, src); \
350 __asm__ __volatile__ ( \
354 : "=&c" (u0), "=&D" (u1), "=&S" (u2) \
356 "1" (dstp+(n-4)), "2" (srcp+(n-4)) \
360 case 3: dstp[2] = srcp[2]; \
361 case 2: dstp[1] = srcp[1]; \
362 case 1: dstp[0] = srcp[0]; \
370 extern DECLSPEC void * SDLCALL SDL_revcpy(void *dst, const void *src, size_t len);
374 #define SDL_memmove memmove
375 #elif defined(HAVE_BCOPY)
376 #define SDL_memmove(d, s, n) bcopy((s), (d), (n))
378 #define SDL_memmove(dst, src, len) \
381 SDL_memcpy(dst, src, len); \
383 SDL_revcpy(dst, src, len); \
389 #define SDL_memcmp memcmp
391 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
395 #define SDL_strlen strlen
397 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *string);
401 #define SDL_strlcpy strlcpy
403 extern DECLSPEC size_t SDLCALL SDL_strlcpy(char *dst, const char *src, size_t maxlen);
407 #define SDL_strlcat strlcat
409 extern DECLSPEC size_t SDLCALL SDL_strlcat(char *dst, const char *src, size_t maxlen);
413 #define SDL_strdup strdup
415 extern DECLSPEC char * SDLCALL SDL_strdup(const char *string);
419 #define SDL_strrev _strrev
421 extern DECLSPEC char * SDLCALL SDL_strrev(char *string);
425 #define SDL_strupr _strupr
427 extern DECLSPEC char * SDLCALL SDL_strupr(char *string);
431 #define SDL_strlwr _strlwr
433 extern DECLSPEC char * SDLCALL SDL_strlwr(char *string);
437 #define SDL_strchr strchr
438 #elif defined(HAVE_INDEX)
439 #define SDL_strchr index
441 extern DECLSPEC char * SDLCALL SDL_strchr(const char *string, int c);
445 #define SDL_strrchr strrchr
446 #elif defined(HAVE_RINDEX)
447 #define SDL_strrchr rindex
449 extern DECLSPEC char * SDLCALL SDL_strrchr(const char *string, int c);
453 #define SDL_strstr strstr
455 extern DECLSPEC char * SDLCALL SDL_strstr(const char *haystack, const char *needle);
459 #define SDL_itoa itoa
461 #define SDL_itoa(value, string, radix) SDL_ltoa((long)value, string, radix)
465 #define SDL_ltoa _ltoa
467 extern DECLSPEC char * SDLCALL SDL_ltoa(long value, char *string, int radix);
471 #define SDL_uitoa _uitoa
473 #define SDL_uitoa(value, string, radix) SDL_ultoa((long)value, string, radix)
477 #define SDL_ultoa _ultoa
479 extern DECLSPEC char * SDLCALL SDL_ultoa(unsigned long value, char *string, int radix);
483 #define SDL_strtol strtol
485 extern DECLSPEC long SDLCALL SDL_strtol(const char *string, char **endp, int base);
489 #define SDL_strtoul strtoul
491 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *string, char **endp, int base);
494 #ifdef SDL_HAS_64BIT_TYPE
497 #define SDL_lltoa _i64toa
499 extern DECLSPEC char* SDLCALL SDL_lltoa(Sint64 value, char *string, int radix);
503 #define SDL_ulltoa _ui64toa
505 extern DECLSPEC char* SDLCALL SDL_ulltoa(Uint64 value, char *string, int radix);
509 #define SDL_strtoll strtoll
511 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *string, char **endp, int base);
515 #define SDL_strtoull strtoull
517 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *string, char **endp, int base);
520 #endif /* SDL_HAS_64BIT_TYPE */
523 #define SDL_strtod strtod
525 extern DECLSPEC double SDLCALL SDL_strtod(const char *string, char **endp);
529 #define SDL_atoi atoi
531 #define SDL_atoi(X) SDL_strtol(X, NULL, 0)
535 #define SDL_atof atof
537 #define SDL_atof(X) SDL_strtod(X, NULL)
541 #define SDL_strcmp strcmp
543 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
547 #define SDL_strncmp strncmp
549 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
552 #ifdef HAVE_STRCASECMP
553 #define SDL_strcasecmp strcasecmp
554 #elif defined(HAVE__STRICMP)
555 #define SDL_strcasecmp _stricmp
557 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
560 #ifdef HAVE_STRNCASECMP
561 #define SDL_strncasecmp strncasecmp
562 #elif defined(HAVE__STRNICMP)
563 #define SDL_strncasecmp _strnicmp
565 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t maxlen);
569 #define SDL_sscanf sscanf
571 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, const char *fmt, ...);
575 #define SDL_snprintf snprintf
577 extern DECLSPEC int SDLCALL SDL_snprintf(char *text, size_t maxlen, const char *fmt, ...);
580 #ifdef HAVE_VSNPRINTF
581 #define SDL_vsnprintf vsnprintf
583 extern DECLSPEC int SDLCALL SDL_vsnprintf(char *text, size_t maxlen, const char *fmt, va_list ap);
586 /** @name SDL_ICONV Error Codes
587 * The SDL implementation of iconv() returns these error codes
590 #define SDL_ICONV_ERROR (size_t)-1
591 #define SDL_ICONV_E2BIG (size_t)-2
592 #define SDL_ICONV_EILSEQ (size_t)-3
593 #define SDL_ICONV_EINVAL (size_t)-4
596 #if defined(HAVE_ICONV) && defined(HAVE_ICONV_H)
597 #define SDL_iconv_t iconv_t
598 #define SDL_iconv_open iconv_open
599 #define SDL_iconv_close iconv_close
601 typedef struct _SDL_iconv_t *SDL_iconv_t;
602 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode, const char *fromcode);
603 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
605 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft);
606 /** This function converts a string between encodings in one pass, returning a
607 * string that must be freed with SDL_free() or NULL on error.
609 extern DECLSPEC char * SDLCALL SDL_iconv_string(const char *tocode, const char *fromcode, const char *inbuf, size_t inbytesleft);
610 #define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
611 #define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2", "UTF-8", S, SDL_strlen(S)+1)
612 #define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4", "UTF-8", S, SDL_strlen(S)+1)
614 /* Ends C function definitions when using C++ */
618 #include "close_code.h"
620 #endif /* _SDL_stdinc_h */