2 SDL - Simple DirectMedia Layer
3 Copyright (C) 1997-2006 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
26 * This is a general header that includes C language support
32 #include "SDL_config.h"
35 #ifdef HAVE_SYS_TYPES_H
36 #include <sys/types.h>
41 #if defined(STDC_HEADERS)
46 # if defined(HAVE_STDLIB_H)
48 # elif defined(HAVE_MALLOC_H)
51 # if defined(HAVE_STDDEF_H)
54 # if defined(HAVE_STDARG_H)
59 # if !defined(STDC_HEADERS) && defined(HAVE_MEMORY_H)
67 #if defined(HAVE_INTTYPES_H)
68 # include <inttypes.h>
69 #elif defined(HAVE_STDINT_H)
79 /* The number of elements in an array */
80 #define SDL_arraysize(array) (sizeof(array)/sizeof(array[0]))
81 #define SDL_TABLESIZE(table) SDL_arraysize(table)
83 /* Basic data types */
92 * \brief A signed 8-bit integer type.
97 * \brief An unsigned 8-bit integer type.
99 typedef uint8_t Uint8;
102 * \brief A signed 16-bit integer type.
104 typedef int16_t Sint16;
107 * \brief An unsigned 16-bit integer type.
109 typedef uint16_t Uint16;
112 * \brief A signed 32-bit integer type.
114 typedef int32_t Sint32;
117 * \brief An unsigned 32-bit integer type.
119 typedef uint32_t Uint32;
121 #ifdef SDL_HAS_64BIT_TYPE
124 * \brief A signed 64-bit integer type.
125 * \warning On platforms without any sort of 64-bit datatype, this is equivalent to Sint32!
127 typedef int64_t Sint64;
130 * \brief An unsigned 64-bit integer type.
131 * \warning On platforms without any sort of 64-bit datatype, this is equivalent to Uint32!
133 typedef uint64_t Uint64;
135 /* This is really just a hack to prevent the compiler from complaining */
136 typedef Sint32 Sint64;
137 typedef Uint32 Uint64;
140 /* Make sure the types really have the right sizes */
141 #define SDL_COMPILE_TIME_ASSERT(name, x) \
142 typedef int SDL_dummy_ ## name[(x) * 2 - 1]
143 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
144 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
145 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
146 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
147 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
148 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
149 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
150 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
151 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
152 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
154 /* Check to make sure enums are the size of ints, for structure packing.
155 For both Watcom C/C++ and Borland C/C++ the compiler option that makes
156 enums having the size of an int must be enabled.
157 This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
159 /* Enable enums always int in CodeWarrior (for MPW use "-enum int") */
161 #pragma enumsalwaysint on
164 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
170 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
171 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
173 #include "begin_code.h"
174 /* Set up for C function definitions, even when using C++ */
182 #define SDL_malloc malloc
184 extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
188 #define SDL_calloc calloc
190 extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
194 #define SDL_realloc realloc
196 extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
200 #define SDL_free free
202 extern DECLSPEC void SDLCALL SDL_free(void *mem);
205 #if defined(HAVE_ALLOCA) && !defined(alloca)
206 # if defined(HAVE_ALLOCA_H)
208 # elif defined(__GNUC__)
209 # define alloca __builtin_alloca
210 # elif defined(_MSC_VER)
212 # define alloca _alloca
213 # elif defined(__WATCOMC__)
215 # elif defined(__BORLANDC__)
217 # elif defined(__DMC__)
219 # elif defined(__AIX__)
221 # elif defined(__MRC__)
222 void *alloca(unsigned);
228 #define SDL_stack_alloc(type, count) (type*)alloca(sizeof(type)*(count))
229 #define SDL_stack_free(data)
231 #define SDL_stack_alloc(type, count) (type*)SDL_malloc(sizeof(type)*(count))
232 #define SDL_stack_free(data) SDL_free(data)
236 #define SDL_getenv getenv
238 extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
242 #define SDL_putenv putenv
244 extern DECLSPEC int SDLCALL SDL_putenv(const char *variable);
248 #define SDL_qsort qsort
250 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size,
251 int (*compare) (const void *,
258 #define SDL_abs(X) ((X) < 0 ? -(X) : (X))
261 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
262 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
265 #define SDL_isdigit(X) isdigit(X)
266 #define SDL_isspace(X) isspace(X)
267 #define SDL_toupper(X) toupper(X)
268 #define SDL_tolower(X) tolower(X)
270 #define SDL_isdigit(X) (((X) >= '0') && ((X) <= '9'))
271 #define SDL_isspace(X) (((X) == ' ') || ((X) == '\t') || ((X) == '\r') || ((X) == '\n'))
272 #define SDL_toupper(X) (((X) >= 'a') && ((X) <= 'z') ? ('A'+((X)-'a')) : (X))
273 #define SDL_tolower(X) (((X) >= 'A') && ((X) <= 'Z') ? ('a'+((X)-'A')) : (X))
277 #define SDL_memset memset
279 extern DECLSPEC void *SDLCALL SDL_memset(void *dst, int c, size_t len);
281 #define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
282 #define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
284 #if defined(__GNUC__) && defined(i386)
285 #define SDL_memset4(dst, val, len) \
288 __asm__ __volatile__ ( \
291 : "=&D" (u0), "=&a" (u1), "=&c" (u2) \
292 : "0" (dst), "1" (val), "2" ((Uint32)(len)) \
297 #define SDL_memset4(dst, val, len) \
299 unsigned _count = (len); \
300 unsigned _n = (_count + 3) / 4; \
301 Uint32 *_p = (Uint32 *)(dst); \
302 Uint32 _val = (val); \
303 switch (_count % 4) { \
304 case 0: do { *_p++ = _val; \
305 case 3: *_p++ = _val; \
306 case 2: *_p++ = _val; \
307 case 1: *_p++ = _val; \
313 /* We can count on memcpy existing on Mac OS X and being well-tuned. */
314 #if defined(__MACH__) && defined(__APPLE__)
315 #define SDL_memcpy(dst, src, len) memcpy(dst, src, len)
316 #elif defined(__GNUC__) && defined(i386)
317 #define SDL_memcpy(dst, src, len) \
320 __asm__ __volatile__ ( \
326 "1:\ttestb $1,%b4\n\t" \
330 : "=&c" (u0), "=&D" (u1), "=&S" (u2) \
331 : "0" ((unsigned)(len)/4), "q" (len), "1" (dst),"2" (src) \
337 #define SDL_memcpy memcpy
338 #elif defined(HAVE_BCOPY)
339 #define SDL_memcpy(d, s, n) bcopy((s), (d), (n))
341 extern DECLSPEC void *SDLCALL SDL_memcpy(void *dst, const void *src,
346 /* We can count on memcpy existing on Mac OS X and being well-tuned. */
347 #if defined(__MACH__) && defined(__APPLE__)
348 #define SDL_memcpy4(dst, src, len) memcpy(dst, src, (len)*4)
349 #elif defined(__GNUC__) && defined(i386)
350 #define SDL_memcpy4(dst, src, len) \
353 __asm__ __volatile__ ( \
356 : "=&c" (ecx), "=&D" (edi), "=&S" (esi) \
357 : "0" ((unsigned)(len)), "1" (dst), "2" (src) \
362 #define SDL_memcpy4(dst, src, len) SDL_memcpy(dst, src, (len) << 2)
365 #if defined(__GNUC__) && defined(i386)
366 #define SDL_revcpy(dst, src, len) \
369 char *dstp = (char *)(dst); \
370 char *srcp = (char *)(src); \
373 __asm__ __volatile__ ( \
376 : "=&c" (u0), "=&D" (u1), "=&S" (u2) \
378 "1" (dstp+(n-4)), "2" (srcp+(n-4)) \
382 case 3: dstp[2] = srcp[2]; \
383 case 2: dstp[1] = srcp[1]; \
384 case 1: dstp[0] = srcp[0]; \
392 extern DECLSPEC void *SDLCALL SDL_revcpy(void *dst, const void *src,
397 #define SDL_memmove memmove
398 #elif defined(HAVE_BCOPY)
399 #define SDL_memmove(d, s, n) bcopy((s), (d), (n))
401 #define SDL_memmove(dst, src, len) \
404 SDL_memcpy(dst, src, len); \
406 SDL_revcpy(dst, src, len); \
412 #define SDL_memcmp memcmp
414 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2,
419 #define SDL_strlen strlen
421 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *string);
425 #define SDL_wcslen wcslen
427 extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t * string);
431 #define SDL_strlcpy strlcpy
433 extern DECLSPEC size_t SDLCALL SDL_strlcpy(char *dst, const char *src,
438 #define SDL_strlcat strlcat
440 extern DECLSPEC size_t SDLCALL SDL_strlcat(char *dst, const char *src,
445 #define SDL_strdup strdup
447 extern DECLSPEC char *SDLCALL SDL_strdup(const char *string);
451 #define SDL_strrev _strrev
453 extern DECLSPEC char *SDLCALL SDL_strrev(char *string);
457 #define SDL_strupr _strupr
459 extern DECLSPEC char *SDLCALL SDL_strupr(char *string);
463 #define SDL_strlwr _strlwr
465 extern DECLSPEC char *SDLCALL SDL_strlwr(char *string);
469 #define SDL_strchr strchr
470 #elif defined(HAVE_INDEX)
471 #define SDL_strchr index
473 extern DECLSPEC char *SDLCALL SDL_strchr(const char *string, int c);
477 #define SDL_strrchr strrchr
478 #elif defined(HAVE_RINDEX)
479 #define SDL_strrchr rindex
481 extern DECLSPEC char *SDLCALL SDL_strrchr(const char *string, int c);
485 #define SDL_strstr strstr
487 extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack,
492 #define SDL_itoa itoa
494 #define SDL_itoa(value, string, radix) SDL_ltoa((long)value, string, radix)
498 #define SDL_ltoa _ltoa
500 extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *string, int radix);
504 #define SDL_uitoa _uitoa
506 #define SDL_uitoa(value, string, radix) SDL_ultoa((long)value, string, radix)
510 #define SDL_ultoa _ultoa
512 extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *string,
517 #define SDL_strtol strtol
519 extern DECLSPEC long SDLCALL SDL_strtol(const char *string, char **endp,
524 #define SDL_strtoul strtoul
526 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *string,
527 char **endp, int base);
530 #ifdef SDL_HAS_64BIT_TYPE
533 #define SDL_lltoa _i64toa
535 extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *string,
540 #define SDL_ulltoa _ui64toa
542 extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *string,
547 #define SDL_strtoll strtoll
549 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *string, char **endp,
554 #define SDL_strtoull strtoull
556 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *string, char **endp,
560 #endif /* SDL_HAS_64BIT_TYPE */
563 #define SDL_strtod strtod
565 extern DECLSPEC double SDLCALL SDL_strtod(const char *string, char **endp);
569 #define SDL_atoi atoi
571 #define SDL_atoi(X) SDL_strtol(X, NULL, 0)
575 #define SDL_atof atof
577 #define SDL_atof(X) SDL_strtod(X, NULL)
581 #define SDL_strcmp strcmp
583 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
587 #define SDL_strncmp strncmp
589 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2,
593 #ifdef HAVE_STRCASECMP
594 #define SDL_strcasecmp strcasecmp
595 #elif defined(HAVE__STRICMP)
596 #define SDL_strcasecmp _stricmp
598 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1,
602 #ifdef HAVE_STRNCASECMP
603 #define SDL_strncasecmp strncasecmp
604 #elif defined(HAVE__STRNICMP)
605 #define SDL_strncasecmp _strnicmp
607 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1,
608 const char *str2, size_t maxlen);
612 #define SDL_sscanf sscanf
614 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, const char *fmt,
619 #define SDL_snprintf snprintf
621 extern DECLSPEC int SDLCALL SDL_snprintf(char *text, size_t maxlen,
622 const char *fmt, ...);
625 #ifdef HAVE_VSNPRINTF
626 #define SDL_vsnprintf vsnprintf
628 extern DECLSPEC int SDLCALL SDL_vsnprintf(char *text, size_t maxlen,
629 const char *fmt, va_list ap);
632 /* The SDL implementation of iconv() returns these error codes */
633 #define SDL_ICONV_ERROR (size_t)-1
634 #define SDL_ICONV_E2BIG (size_t)-2
635 #define SDL_ICONV_EILSEQ (size_t)-3
636 #define SDL_ICONV_EINVAL (size_t)-4
639 #define SDL_iconv_t iconv_t
640 #define SDL_iconv_open iconv_open
641 #define SDL_iconv_close iconv_close
643 typedef struct _SDL_iconv_t *SDL_iconv_t;
644 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
645 const char *fromcode);
646 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
648 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
649 size_t * inbytesleft, char **outbuf,
650 size_t * outbytesleft);
651 /* This function converts a string between encodings in one pass, returning a
652 string that must be freed with SDL_free() or NULL on error.
654 extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
655 const char *fromcode,
658 #define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
659 #define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2", "UTF-8", S, SDL_strlen(S)+1)
660 #define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4", "UTF-8", S, SDL_strlen(S)+1)
662 /* Ends C function definitions when using C++ */
668 #include "close_code.h"
670 #endif /* _SDL_stdinc_h */
672 /* vi: set ts=4 sw=4 expandtab: */