2 SDL - Simple DirectMedia Layer
3 Copyright (C) 1997-2010 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)
78 #if defined(HAVE_ICONV) && defined(HAVE_ICONV_H)
83 * The number of elements in an array.
85 #define SDL_arraysize(array) (sizeof(array)/sizeof(array[0]))
86 #define SDL_TABLESIZE(table) SDL_arraysize(table)
89 * \name Cast operators
91 * Use proper C++ casts when compiled as C++ to be compatible with the option
92 * -Wold-style-cast of GCC (and -Werror=old-style-cast in GCC 4.2 and above).
96 #define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression)
97 #define SDL_static_cast(type, expression) static_cast<type>(expression)
99 #define SDL_reinterpret_cast(type, expression) ((type)(expression))
100 #define SDL_static_cast(type, expression) ((type)(expression))
102 /*@}*//*Cast operators*/
104 /* Define a four character code as a Uint32 */
105 #define SDL_FOURCC(A, B, C, D) \
106 ((SDL_static_cast(Uint32, SDL_static_cast(Uint8, (A))) << 0) | \
107 (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (B))) << 8) | \
108 (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (C))) << 16) | \
109 (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (D))) << 24))
112 * \name Basic data types
123 * \brief A signed 8-bit integer type.
125 typedef int8_t Sint8;
127 * \brief An unsigned 8-bit integer type.
129 typedef uint8_t Uint8;
131 * \brief A signed 16-bit integer type.
133 typedef int16_t Sint16;
135 * \brief An unsigned 16-bit integer type.
137 typedef uint16_t Uint16;
139 * \brief A signed 32-bit integer type.
141 typedef int32_t Sint32;
143 * \brief An unsigned 32-bit integer type.
145 typedef uint32_t Uint32;
147 #ifdef SDL_HAS_64BIT_TYPE
149 * \brief A signed 64-bit integer type.
150 * \warning On platforms without any sort of 64-bit datatype, this is equivalent to Sint32!
152 typedef int64_t Sint64;
154 * \brief An unsigned 64-bit integer type.
155 * \warning On platforms without any sort of 64-bit datatype, this is equivalent to Uint32!
157 typedef uint64_t Uint64;
159 /* This is really just a hack to prevent the compiler from complaining */
160 typedef Sint32 Sint64;
161 typedef Uint32 Uint64;
164 /*@}*//*Basic data types*/
167 #define SDL_COMPILE_TIME_ASSERT(name, x) \
168 typedef int SDL_dummy_ ## name[(x) * 2 - 1]
170 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
171 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
172 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
173 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
174 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
175 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
176 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
177 #ifndef __NINTENDODS__ /* TODO: figure out why the following happens:
178 include/SDL_stdinc.h:150: error: size of array 'SDL_dummy_uint64' is negative
179 include/SDL_stdinc.h:151: error: size of array 'SDL_dummy_sint64' is negative */
180 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
181 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
183 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
186 /* Check to make sure enums are the size of ints, for structure packing.
187 For both Watcom C/C++ and Borland C/C++ the compiler option that makes
188 enums having the size of an int must be enabled.
189 This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
191 /* Enable enums always int in CodeWarrior (for MPW use "-enum int") */
193 #pragma enumsalwaysint on
197 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
198 #ifndef __NINTENDODS__ /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */
204 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
206 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
209 #include "begin_code.h"
210 /* Set up for C function definitions, even when using C++ */
218 #define SDL_malloc malloc
220 extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
224 #define SDL_calloc calloc
226 extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
230 #define SDL_realloc realloc
232 extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
236 #define SDL_free free
238 extern DECLSPEC void SDLCALL SDL_free(void *mem);
241 #if defined(HAVE_ALLOCA) && !defined(alloca)
242 # if defined(HAVE_ALLOCA_H)
244 # elif defined(__GNUC__)
245 # define alloca __builtin_alloca
246 # elif defined(_MSC_VER)
248 # define alloca _alloca
249 # elif defined(__WATCOMC__)
251 # elif defined(__BORLANDC__)
253 # elif defined(__DMC__)
255 # elif defined(__AIX__)
257 # elif defined(__MRC__)
258 void *alloca(unsigned);
264 #define SDL_stack_alloc(type, count) (type*)alloca(sizeof(type)*(count))
265 #define SDL_stack_free(data)
267 #define SDL_stack_alloc(type, count) (type*)SDL_malloc(sizeof(type)*(count))
268 #define SDL_stack_free(data) SDL_free(data)
272 #define SDL_getenv getenv
274 extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
277 /* SDL_putenv() has moved to SDL_compat. */
279 #define SDL_setenv setenv
281 extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value,
286 #define SDL_qsort qsort
288 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size,
289 int (*compare) (const void *,
296 #define SDL_abs(X) ((X) < 0 ? -(X) : (X))
299 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
300 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
303 #define SDL_isdigit(X) isdigit(X)
304 #define SDL_isspace(X) isspace(X)
305 #define SDL_toupper(X) toupper(X)
306 #define SDL_tolower(X) tolower(X)
308 #define SDL_isdigit(X) (((X) >= '0') && ((X) <= '9'))
309 #define SDL_isspace(X) (((X) == ' ') || ((X) == '\t') || ((X) == '\r') || ((X) == '\n'))
310 #define SDL_toupper(X) (((X) >= 'a') && ((X) <= 'z') ? ('A'+((X)-'a')) : (X))
311 #define SDL_tolower(X) (((X) >= 'A') && ((X) <= 'Z') ? ('a'+((X)-'A')) : (X))
315 #define SDL_memset memset
317 extern DECLSPEC void *SDLCALL SDL_memset(void *dst, int c, size_t len);
319 #define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
320 #define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
322 #if defined(__GNUC__) && defined(i386)
323 #define SDL_memset4(dst, val, len) \
326 __asm__ __volatile__ ( \
329 : "=&D" (u0), "=&a" (u1), "=&c" (u2) \
330 : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, len)) \
335 #define SDL_memset4(dst, val, len) \
337 unsigned _count = (len); \
338 unsigned _n = (_count + 3) / 4; \
339 Uint32 *_p = SDL_static_cast(Uint32 *, dst); \
340 Uint32 _val = (val); \
341 if (len == 0) break; \
342 switch (_count % 4) { \
343 case 0: do { *_p++ = _val; \
344 case 3: *_p++ = _val; \
345 case 2: *_p++ = _val; \
346 case 1: *_p++ = _val; \
352 /* We can count on memcpy existing on Mac OS X and being well-tuned. */
353 #if defined(__MACH__) && defined(__APPLE__)
354 #define SDL_memcpy(dst, src, len) memcpy(dst, src, len)
355 #elif defined(__GNUC__) && defined(i386)
356 #define SDL_memcpy(dst, src, len) \
359 __asm__ __volatile__ ( \
365 "1:\ttestb $1,%b4\n\t" \
369 : "=&c" (u0), "=&D" (u1), "=&S" (u2) \
370 : "0" (SDL_static_cast(unsigned, len)/4), "q" (len), "1" (dst),"2" (src) \
376 #define SDL_memcpy memcpy
377 #elif defined(HAVE_BCOPY)
378 #define SDL_memcpy(d, s, n) bcopy((s), (d), (n))
380 extern DECLSPEC void *SDLCALL SDL_memcpy(void *dst, const void *src,
385 /* We can count on memcpy existing on Mac OS X and being well-tuned. */
386 #if defined(__MACH__) && defined(__APPLE__)
387 #define SDL_memcpy4(dst, src, len) memcpy(dst, src, (len)*4)
388 #elif defined(__GNUC__) && defined(i386)
389 #define SDL_memcpy4(dst, src, len) \
392 __asm__ __volatile__ ( \
395 : "=&c" (ecx), "=&D" (edi), "=&S" (esi) \
396 : "0" (SDL_static_cast(unsigned, len)), "1" (dst), "2" (src) \
401 #define SDL_memcpy4(dst, src, len) SDL_memcpy(dst, src, (len) << 2)
404 #if defined(__GNUC__) && defined(i386)
405 #define SDL_revcpy(dst, src, len) \
408 char *dstp = SDL_static_cast(char *, dst); \
409 char *srcp = SDL_static_cast(char *, src); \
412 __asm__ __volatile__ ( \
416 : "=&c" (u0), "=&D" (u1), "=&S" (u2) \
418 "1" (dstp+(n-4)), "2" (srcp+(n-4)) \
422 case 3: dstp[2] = srcp[2]; \
423 case 2: dstp[1] = srcp[1]; \
424 case 1: dstp[0] = srcp[0]; \
432 extern DECLSPEC void *SDLCALL SDL_revcpy(void *dst, const void *src,
437 #define SDL_memmove memmove
438 #elif defined(HAVE_BCOPY)
439 #define SDL_memmove(d, s, n) bcopy((s), (d), (n))
441 #define SDL_memmove(dst, src, len) \
444 SDL_memcpy(dst, src, len); \
446 SDL_revcpy(dst, src, len); \
452 #define SDL_memcmp memcmp
454 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2,
459 #define SDL_strlen strlen
461 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *string);
465 #define SDL_wcslen wcslen
467 #if !defined(wchar_t) && defined(__NINTENDODS__)
468 #define wchar_t short /* TODO: figure out why libnds doesn't have this */
470 extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t * string);
474 #define SDL_strlcpy strlcpy
476 extern DECLSPEC size_t SDLCALL SDL_strlcpy(char *dst, const char *src,
481 #define SDL_strlcat strlcat
483 extern DECLSPEC size_t SDLCALL SDL_strlcat(char *dst, const char *src,
488 #define SDL_strdup strdup
490 extern DECLSPEC char *SDLCALL SDL_strdup(const char *string);
494 #define SDL_strrev _strrev
496 extern DECLSPEC char *SDLCALL SDL_strrev(char *string);
500 #define SDL_strupr _strupr
502 extern DECLSPEC char *SDLCALL SDL_strupr(char *string);
506 #define SDL_strlwr _strlwr
508 extern DECLSPEC char *SDLCALL SDL_strlwr(char *string);
512 #define SDL_strchr strchr
513 #elif defined(HAVE_INDEX)
514 #define SDL_strchr index
516 extern DECLSPEC char *SDLCALL SDL_strchr(const char *string, int c);
520 #define SDL_strrchr strrchr
521 #elif defined(HAVE_RINDEX)
522 #define SDL_strrchr rindex
524 extern DECLSPEC char *SDLCALL SDL_strrchr(const char *string, int c);
528 #define SDL_strstr strstr
530 extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack,
535 #define SDL_itoa itoa
537 #define SDL_itoa(value, string, radix) SDL_ltoa((long)value, string, radix)
541 #define SDL_ltoa _ltoa
543 extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *string, int radix);
547 #define SDL_uitoa _uitoa
549 #define SDL_uitoa(value, string, radix) SDL_ultoa((long)value, string, radix)
553 #define SDL_ultoa _ultoa
555 extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *string,
560 #define SDL_strtol strtol
562 extern DECLSPEC long SDLCALL SDL_strtol(const char *string, char **endp,
567 #define SDL_strtoul strtoul
569 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *string,
570 char **endp, int base);
573 #ifdef SDL_HAS_64BIT_TYPE
576 #define SDL_lltoa _i64toa
578 extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *string,
583 #define SDL_ulltoa _ui64toa
585 extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *string,
590 #define SDL_strtoll strtoll
592 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *string, char **endp,
597 #define SDL_strtoull strtoull
599 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *string, char **endp,
603 #endif /* SDL_HAS_64BIT_TYPE */
606 #define SDL_strtod strtod
608 extern DECLSPEC double SDLCALL SDL_strtod(const char *string, char **endp);
612 #define SDL_atoi atoi
614 #define SDL_atoi(X) SDL_strtol(X, NULL, 0)
618 #define SDL_atof atof
620 #define SDL_atof(X) SDL_strtod(X, NULL)
624 #define SDL_strcmp strcmp
626 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
630 #define SDL_strncmp strncmp
632 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2,
636 #ifdef HAVE_STRCASECMP
637 #define SDL_strcasecmp strcasecmp
638 #elif defined(HAVE__STRICMP)
639 #define SDL_strcasecmp _stricmp
641 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1,
645 #ifdef HAVE_STRNCASECMP
646 #define SDL_strncasecmp strncasecmp
647 #elif defined(HAVE__STRNICMP)
648 #define SDL_strncasecmp _strnicmp
650 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1,
651 const char *str2, size_t maxlen);
655 #define SDL_sscanf sscanf
657 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, const char *fmt,
662 #define SDL_snprintf snprintf
664 extern DECLSPEC int SDLCALL SDL_snprintf(char *text, size_t maxlen,
665 const char *fmt, ...);
668 #ifdef HAVE_VSNPRINTF
669 #define SDL_vsnprintf vsnprintf
671 extern DECLSPEC int SDLCALL SDL_vsnprintf(char *text, size_t maxlen,
672 const char *fmt, va_list ap);
676 #define M_PI 3.14159265358979323846264338327950288 /* pi */
680 #define SDL_ceil ceil
682 #define SDL_ceil(x) ((double)(int)((x)+0.5))
686 #define SDL_copysign copysign
688 extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
694 extern DECLSPEC double SDLCALL SDL_cos(double x);
698 #define SDL_cosf cosf
700 #define SDL_cosf(x) (float)SDL_cos((double)x)
704 #define SDL_fabs fabs
706 extern DECLSPEC double SDLCALL SDL_fabs(double x);
710 #define SDL_floor floor
712 extern DECLSPEC double SDLCALL SDL_floor(double x);
718 extern DECLSPEC double SDLCALL SDL_log(double x);
724 extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
728 #define SDL_scalbn scalbn
730 extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
736 extern DECLSPEC double SDLCALL SDL_sin(double x);
740 #define SDL_sinf sinf
742 #define SDL_sinf(x) (float)SDL_sin((double)x)
746 #define SDL_sqrt sqrt
748 extern DECLSPEC double SDLCALL SDL_sqrt(double x);
751 /* The SDL implementation of iconv() returns these error codes */
752 #define SDL_ICONV_ERROR (size_t)-1
753 #define SDL_ICONV_E2BIG (size_t)-2
754 #define SDL_ICONV_EILSEQ (size_t)-3
755 #define SDL_ICONV_EINVAL (size_t)-4
757 #if defined(HAVE_ICONV) && defined(HAVE_ICONV_H)
758 #define SDL_iconv_t iconv_t
759 #define SDL_iconv_open iconv_open
760 #define SDL_iconv_close iconv_close
762 typedef struct _SDL_iconv_t *SDL_iconv_t;
763 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
764 const char *fromcode);
765 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
767 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
768 size_t * inbytesleft, char **outbuf,
769 size_t * outbytesleft);
771 * This function converts a string between encodings in one pass, returning a
772 * string that must be freed with SDL_free() or NULL on error.
774 extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
775 const char *fromcode,
778 #define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
779 #define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2", "UTF-8", S, SDL_strlen(S)+1)
780 #define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4", "UTF-8", S, SDL_strlen(S)+1)
782 /* Ends C function definitions when using C++ */
788 #include "close_code.h"
790 #endif /* _SDL_stdinc_h */
792 /* vi: set ts=4 sw=4 expandtab: */