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
23 /* This is a general header that includes C language support */
28 #include "SDL_config.h"
31 #ifdef HAVE_SYS_TYPES_H
32 #include <sys/types.h>
37 #if defined(STDC_HEADERS)
42 # if defined(HAVE_STDLIB_H)
44 # elif defined(HAVE_MALLOC_H)
47 # if defined(HAVE_STDDEF_H)
50 # if defined(HAVE_STDARG_H)
55 # if !defined(STDC_HEADERS) && defined(HAVE_MEMORY_H)
63 #if defined(HAVE_INTTYPES_H)
64 # include <inttypes.h>
65 #elif defined(HAVE_STDINT_H)
75 /* The number of elements in an array */
76 #define SDL_arraysize(array) (sizeof(array)/sizeof(array[0]))
77 #define SDL_TABLESIZE(table) SDL_arraysize(table)
79 /* Basic data types */
80 typedef enum SDL_bool {
86 typedef uint8_t Uint8;
87 typedef int16_t Sint16;
88 typedef uint16_t Uint16;
89 typedef int32_t Sint32;
90 typedef uint32_t Uint32;
92 #ifdef SDL_HAS_64BIT_TYPE
93 typedef int64_t Sint64;
94 #ifndef SYMBIAN32_GCCE
95 typedef uint64_t Uint64;
98 /* This is really just a hack to prevent the compiler from complaining */
105 /* Make sure the types really have the right sizes */
106 #define SDL_COMPILE_TIME_ASSERT(name, x) \
107 typedef int SDL_dummy_ ## name[(x) * 2 - 1]
109 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
110 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
111 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
112 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
113 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
114 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
115 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
116 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
118 /* Check to make sure enums are the size of ints, for structure packing.
119 For both Watcom C/C++ and Borland C/C++ the compiler option that makes
120 enums having the size of an int must be enabled.
121 This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
123 /* Enable enums always int in CodeWarrior (for MPW use "-enum int") */
125 #pragma enumsalwaysint on
133 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
137 #include "begin_code.h"
138 /* Set up for C function definitions, even when using C++ */
144 #define SDL_malloc malloc
146 extern DECLSPEC void * SDLCALL SDL_malloc(size_t size);
150 #define SDL_calloc calloc
152 extern DECLSPEC void * SDLCALL SDL_calloc(size_t nmemb, size_t size);
156 #define SDL_realloc realloc
158 extern DECLSPEC void * SDLCALL SDL_realloc(void *mem, size_t size);
162 #define SDL_free free
164 extern DECLSPEC void SDLCALL SDL_free(void *mem);
167 #if defined(HAVE_ALLOCA) && !defined(alloca)
168 # if defined(HAVE_ALLOCA_H)
170 # elif defined(__GNUC__)
171 # define alloca __builtin_alloca
172 # elif defined(_MSC_VER)
174 # define alloca _alloca
175 # elif defined(__WATCOMC__)
177 # elif defined(__DMC__)
179 # elif defined(__AIX__)
181 # elif defined(__MRC__)
182 void *alloca (unsigned);
188 #define SDL_stack_alloc(type, count) (type*)alloca(sizeof(type)*(count))
189 #define SDL_stack_free(data)
191 #define SDL_stack_alloc(type, count) (type*)SDL_malloc(sizeof(type)*(count))
192 #define SDL_stack_free(data) SDL_free(data)
196 #define SDL_getenv getenv
198 extern DECLSPEC char * SDLCALL SDL_getenv(const char *name);
202 #define SDL_putenv putenv
204 extern DECLSPEC int SDLCALL SDL_putenv(const char *variable);
208 #define SDL_qsort qsort
210 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size,
211 int (*compare)(const void *, const void *));
217 #define SDL_abs(X) ((X) < 0 ? -(X) : (X))
220 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
221 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
224 #define SDL_isdigit(X) isdigit(X)
225 #define SDL_isspace(X) isspace(X)
226 #define SDL_toupper(X) toupper(X)
227 #define SDL_tolower(X) tolower(X)
229 #define SDL_isdigit(X) (((X) >= '0') && ((X) <= '9'))
230 #define SDL_isspace(X) (((X) == ' ') || ((X) == '\t') || ((X) == '\r') || ((X) == '\n'))
231 #define SDL_toupper(X) (((X) >= 'a') && ((X) <= 'z') ? ('A'+((X)-'a')) : (X))
232 #define SDL_tolower(X) (((X) >= 'A') && ((X) <= 'Z') ? ('a'+((X)-'A')) : (X))
236 #define SDL_memset memset
238 extern DECLSPEC void * SDLCALL SDL_memset(void *dst, int c, size_t len);
241 #if defined(__GNUC__) && defined(i386)
242 #define SDL_memset4(dst, val, len) \
245 __asm__ __volatile__ ( \
248 : "=&D" (u0), "=&a" (u1), "=&c" (u2) \
249 : "0" (dst), "1" (val), "2" ((Uint32)(len)) \
254 #define SDL_memset4(dst, val, len) \
256 unsigned _count = (len); \
257 unsigned _n = (_count + 3) / 4; \
258 Uint32 *_p = (Uint32 *)(dst); \
259 Uint32 _val = (val); \
260 switch (_count % 4) { \
261 case 0: do { *_p++ = _val; \
262 case 3: *_p++ = _val; \
263 case 2: *_p++ = _val; \
264 case 1: *_p++ = _val; \
270 /* We can count on memcpy existing on Mac OS X and being well-tuned. */
271 #if defined(__MACH__) && defined(__APPLE__)
272 #define SDL_memcpy(dst, src, len) memcpy(dst, src, len)
273 #elif defined(__GNUC__) && defined(i386)
274 #define SDL_memcpy(dst, src, len) \
277 __asm__ __volatile__ ( \
283 "1:\ttestb $1,%b4\n\t" \
287 : "=&c" (u0), "=&D" (u1), "=&S" (u2) \
288 : "0" ((unsigned)(len)/4), "q" (len), "1" (dst),"2" (src) \
294 #define SDL_memcpy memcpy
295 #elif defined(HAVE_BCOPY)
296 #define SDL_memcpy(d, s, n) bcopy((s), (d), (n))
298 extern DECLSPEC void * SDLCALL SDL_memcpy(void *dst, const void *src, size_t len);
302 /* We can count on memcpy existing on Mac OS X and being well-tuned. */
303 #if defined(__MACH__) && defined(__APPLE__)
304 #define SDL_memcpy4(dst, src, len) memcpy(dst, src, (len)*4)
305 #elif defined(__GNUC__) && defined(i386)
306 #define SDL_memcpy4(dst, src, len) \
309 __asm__ __volatile__ ( \
312 : "=&c" (ecx), "=&D" (edi), "=&S" (esi) \
313 : "0" ((unsigned)(len)), "1" (dst), "2" (src) \
318 #define SDL_memcpy4(dst, src, len) SDL_memcpy(dst, src, (len) << 2)
321 #if defined(__GNUC__) && defined(i386)
322 #define SDL_revcpy(dst, src, len) \
325 char *dstp = (char *)(dst); \
326 char *srcp = (char *)(src); \
329 __asm__ __volatile__ ( \
332 : "=&c" (u0), "=&D" (u1), "=&S" (u2) \
334 "1" (dstp+(n-4)), "2" (srcp+(n-4)) \
338 case 3: dstp[2] = srcp[2]; \
339 case 2: dstp[1] = srcp[1]; \
340 case 1: dstp[0] = srcp[0]; \
348 extern DECLSPEC void * SDLCALL SDL_revcpy(void *dst, const void *src, size_t len);
352 #define SDL_memmove memmove
353 #elif defined(HAVE_BCOPY)
354 #define SDL_memmove(d, s, n) bcopy((s), (d), (n))
356 #define SDL_memmove(dst, src, len) \
359 SDL_memcpy(dst, src, len); \
361 SDL_revcpy(dst, src, len); \
367 #define SDL_memcmp memcmp
369 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
373 #define SDL_strlen strlen
375 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *string);
379 #define SDL_strlcpy strlcpy
381 extern DECLSPEC size_t SDLCALL SDL_strlcpy(char *dst, const char *src, size_t maxlen);
385 #define SDL_strlcat strlcat
387 extern DECLSPEC size_t SDLCALL SDL_strlcat(char *dst, const char *src, size_t maxlen);
391 #define SDL_strdup strdup
393 extern DECLSPEC char * SDLCALL SDL_strdup(const char *string);
397 #define SDL_strrev _strrev
399 extern DECLSPEC char * SDLCALL SDL_strrev(char *string);
403 #define SDL_strupr _strupr
405 extern DECLSPEC char * SDLCALL SDL_strupr(char *string);
409 #define SDL_strlwr _strlwr
411 extern DECLSPEC char * SDLCALL SDL_strlwr(char *string);
415 #define SDL_strchr strchr
416 #elif defined(HAVE_INDEX)
417 #define SDL_strchr index
419 extern DECLSPEC char * SDLCALL SDL_strchr(const char *string, int c);
423 #define SDL_strrchr strrchr
424 #elif defined(HAVE_RINDEX)
425 #define SDL_strrchr rindex
427 extern DECLSPEC char * SDLCALL SDL_strrchr(const char *string, int c);
431 #define SDL_strstr strstr
433 extern DECLSPEC char * SDLCALL SDL_strstr(const char *haystack, const char *needle);
437 #define SDL_itoa itoa
439 #define SDL_itoa(value, string, radix) SDL_ltoa((long)value, string, radix)
443 #define SDL_ltoa _ltoa
445 extern DECLSPEC char * SDLCALL SDL_ltoa(long value, char *string, int radix);
449 #define SDL_uitoa _uitoa
451 #define SDL_uitoa(value, string, radix) SDL_ultoa((long)value, string, radix)
455 #define SDL_ultoa _ultoa
457 extern DECLSPEC char * SDLCALL SDL_ultoa(unsigned long value, char *string, int radix);
461 #define SDL_strtol strtol
463 extern DECLSPEC long SDLCALL SDL_strtol(const char *string, char **endp, int base);
467 #define SDL_strtoul strtoul
469 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *string, char **endp, int base);
472 #ifdef SDL_HAS_64BIT_TYPE
475 #define SDL_lltoa _i64toa
477 extern DECLSPEC char* SDLCALL SDL_lltoa(Sint64 value, char *string, int radix);
481 #define SDL_ulltoa _ui64toa
483 extern DECLSPEC char* SDLCALL SDL_ulltoa(Uint64 value, char *string, int radix);
487 #define SDL_strtoll strtoll
489 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *string, char **endp, int base);
493 #define SDL_strtoull strtoull
495 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *string, char **endp, int base);
498 #endif /* SDL_HAS_64BIT_TYPE */
501 #define SDL_strtod strtod
503 extern DECLSPEC double SDLCALL SDL_strtod(const char *string, char **endp);
507 #define SDL_atoi atoi
509 #define SDL_atoi(X) SDL_strtol(X, NULL, 0)
513 #define SDL_atof atof
515 #define SDL_atof(X) SDL_strtod(X, NULL)
519 #define SDL_strcmp strcmp
521 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
525 #define SDL_strncmp strncmp
527 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
530 #ifdef HAVE_STRCASECMP
531 #define SDL_strcasecmp strcasecmp
532 #elif defined(HAVE__STRICMP)
533 #define SDL_strcasecmp _stricmp
535 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
538 #ifdef HAVE_STRNCASECMP
539 #define SDL_strncasecmp strncasecmp
540 #elif defined(HAVE__STRNICMP)
541 #define SDL_strncasecmp _strnicmp
543 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t maxlen);
547 #define SDL_sscanf sscanf
549 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, const char *fmt, ...);
553 #define SDL_snprintf snprintf
555 extern DECLSPEC int SDLCALL SDL_snprintf(char *text, size_t maxlen, const char *fmt, ...);
558 #ifdef HAVE_VSNPRINTF
559 #define SDL_vsnprintf vsnprintf
561 extern DECLSPEC int SDLCALL SDL_vsnprintf(char *text, size_t maxlen, const char *fmt, va_list ap);
564 /* The SDL implementation of iconv() returns these error codes */
565 #define SDL_ICONV_ERROR (size_t)-1
566 #define SDL_ICONV_E2BIG (size_t)-2
567 #define SDL_ICONV_EILSEQ (size_t)-3
568 #define SDL_ICONV_EINVAL (size_t)-4
571 #define SDL_iconv_t iconv_t
572 #define SDL_iconv_open iconv_open
573 #define SDL_iconv_close iconv_close
575 typedef struct _SDL_iconv_t *SDL_iconv_t;
576 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode, const char *fromcode);
577 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
579 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft);
580 /* This function converts a string between encodings in one pass, returning a
581 string that must be freed with SDL_free() or NULL on error.
583 extern DECLSPEC char * SDLCALL SDL_iconv_string(const char *tocode, const char *fromcode, const char *inbuf, size_t inbytesleft);
584 #define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
585 #define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2", "UTF-8", S, SDL_strlen(S)+1)
586 #define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4", "UTF-8", S, SDL_strlen(S)+1)
588 /* Ends C function definitions when using C++ */
592 #include "close_code.h"
594 #endif /* _SDL_stdinc_h */