2 Simple DirectMedia Layer
3 Copyright (C) 1997-2016 Sam Lantinga <slouken@libsdl.org>
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
25 * This is a general header that includes C language support.
31 #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)
74 # if defined(__WINRT__)
75 /* Defining _USE_MATH_DEFINES is required to get M_PI to be defined on
76 WinRT. See http://msdn.microsoft.com/en-us/library/4hwaceh6.aspx
79 # define _USE_MATH_DEFINES
88 * The number of elements in an array.
90 #define SDL_arraysize(array) (sizeof(array)/sizeof(array[0]))
91 #define SDL_TABLESIZE(table) SDL_arraysize(table)
94 * Macro useful for building other macros with strings in them
96 * e.g. #define LOG_ERROR(X) OutputDebugString(SDL_STRINGIFY_ARG(__FUNCTION__) ": " X "\n")
98 #define SDL_STRINGIFY_ARG(arg) #arg
101 * \name Cast operators
103 * Use proper C++ casts when compiled as C++ to be compatible with the option
104 * -Wold-style-cast of GCC (and -Werror=old-style-cast in GCC 4.2 and above).
108 #define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression)
109 #define SDL_static_cast(type, expression) static_cast<type>(expression)
110 #define SDL_const_cast(type, expression) const_cast<type>(expression)
112 #define SDL_reinterpret_cast(type, expression) ((type)(expression))
113 #define SDL_static_cast(type, expression) ((type)(expression))
114 #define SDL_const_cast(type, expression) ((type)(expression))
116 /* @} *//* Cast operators */
118 /* Define a four character code as a Uint32 */
119 #define SDL_FOURCC(A, B, C, D) \
120 ((SDL_static_cast(Uint32, SDL_static_cast(Uint8, (A))) << 0) | \
121 (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (B))) << 8) | \
122 (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (C))) << 16) | \
123 (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (D))) << 24))
126 * \name Basic data types
137 * \brief A signed 8-bit integer type.
139 typedef int8_t Sint8;
141 * \brief An unsigned 8-bit integer type.
143 typedef uint8_t Uint8;
145 * \brief A signed 16-bit integer type.
147 typedef int16_t Sint16;
149 * \brief An unsigned 16-bit integer type.
151 typedef uint16_t Uint16;
153 * \brief A signed 32-bit integer type.
155 typedef int32_t Sint32;
157 * \brief An unsigned 32-bit integer type.
159 typedef uint32_t Uint32;
162 * \brief A signed 64-bit integer type.
164 typedef int64_t Sint64;
166 * \brief An unsigned 64-bit integer type.
168 typedef uint64_t Uint64;
170 /* @} *//* Basic data types */
172 /* Make sure we have macros for printing 64 bit values.
173 * <stdint.h> should define these but this is not true all platforms.
174 * (for example win32) */
177 #define SDL_PRIs64 PRIs64
178 #elif defined(__WIN32__)
179 #define SDL_PRIs64 "I64d"
180 #elif defined(__LINUX__) && defined(__LP64__)
181 #define SDL_PRIs64 "ld"
183 #define SDL_PRIs64 "lld"
188 #define SDL_PRIu64 PRIu64
189 #elif defined(__WIN32__)
190 #define SDL_PRIu64 "I64u"
191 #elif defined(__LINUX__) && defined(__LP64__)
192 #define SDL_PRIu64 "lu"
194 #define SDL_PRIu64 "llu"
199 #define SDL_PRIx64 PRIx64
200 #elif defined(__WIN32__)
201 #define SDL_PRIx64 "I64x"
202 #elif defined(__LINUX__) && defined(__LP64__)
203 #define SDL_PRIx64 "lx"
205 #define SDL_PRIx64 "llx"
210 #define SDL_PRIX64 PRIX64
211 #elif defined(__WIN32__)
212 #define SDL_PRIX64 "I64X"
213 #elif defined(__LINUX__) && defined(__LP64__)
214 #define SDL_PRIX64 "lX"
216 #define SDL_PRIX64 "llX"
220 /* Annotations to help code analysis tools */
221 #ifdef SDL_DISABLE_ANALYZE_MACROS
222 #define SDL_IN_BYTECAP(x)
223 #define SDL_INOUT_Z_CAP(x)
224 #define SDL_OUT_Z_CAP(x)
225 #define SDL_OUT_CAP(x)
226 #define SDL_OUT_BYTECAP(x)
227 #define SDL_OUT_Z_BYTECAP(x)
228 #define SDL_PRINTF_FORMAT_STRING
229 #define SDL_SCANF_FORMAT_STRING
230 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
231 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
233 #if defined(_MSC_VER) && (_MSC_VER >= 1600) /* VS 2010 and above */
236 #define SDL_IN_BYTECAP(x) _In_bytecount_(x)
237 #define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x)
238 #define SDL_OUT_Z_CAP(x) _Out_z_cap_(x)
239 #define SDL_OUT_CAP(x) _Out_cap_(x)
240 #define SDL_OUT_BYTECAP(x) _Out_bytecap_(x)
241 #define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x)
243 #define SDL_PRINTF_FORMAT_STRING _Printf_format_string_
244 #define SDL_SCANF_FORMAT_STRING _Scanf_format_string_impl_
246 #define SDL_IN_BYTECAP(x)
247 #define SDL_INOUT_Z_CAP(x)
248 #define SDL_OUT_Z_CAP(x)
249 #define SDL_OUT_CAP(x)
250 #define SDL_OUT_BYTECAP(x)
251 #define SDL_OUT_Z_BYTECAP(x)
252 #define SDL_PRINTF_FORMAT_STRING
253 #define SDL_SCANF_FORMAT_STRING
255 #if defined(__GNUC__)
256 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __printf__, fmtargnumber, fmtargnumber+1 )))
257 #define SDL_SCANF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __scanf__, fmtargnumber, fmtargnumber+1 )))
259 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
260 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
262 #endif /* SDL_DISABLE_ANALYZE_MACROS */
264 #define SDL_COMPILE_TIME_ASSERT(name, x) \
265 typedef int SDL_dummy_ ## name[(x) * 2 - 1]
267 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
268 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
269 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
270 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
271 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
272 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
273 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
274 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
275 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
276 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
279 /* Check to make sure enums are the size of ints, for structure packing.
280 For both Watcom C/C++ and Borland C/C++ the compiler option that makes
281 enums having the size of an int must be enabled.
282 This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
286 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
287 #if !defined(__ANDROID__)
288 /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */
294 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
296 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
299 #include "begin_code.h"
300 /* Set up for C function definitions, even when using C++ */
305 #if defined(HAVE_ALLOCA) && !defined(alloca)
306 # if defined(HAVE_ALLOCA_H)
308 # elif defined(__GNUC__)
309 # define alloca __builtin_alloca
310 # elif defined(_MSC_VER)
312 # define alloca _alloca
313 # elif defined(__WATCOMC__)
315 # elif defined(__BORLANDC__)
317 # elif defined(__DMC__)
319 # elif defined(__AIX__)
321 # elif defined(__MRC__)
322 void *alloca(unsigned);
328 #define SDL_stack_alloc(type, count) (type*)alloca(sizeof(type)*(count))
329 #define SDL_stack_free(data)
331 #define SDL_stack_alloc(type, count) (type*)SDL_malloc(sizeof(type)*(count))
332 #define SDL_stack_free(data) SDL_free(data)
335 extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
336 extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
337 extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
338 extern DECLSPEC void SDLCALL SDL_free(void *mem);
340 extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
341 extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value, int overwrite);
343 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, int (*compare) (const void *, const void *));
345 extern DECLSPEC int SDLCALL SDL_abs(int x);
347 /* !!! FIXME: these have side effects. You probably shouldn't use them. */
348 /* !!! FIXME: Maybe we do forceinline functions of SDL_mini, SDL_minf, etc? */
349 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
350 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
352 extern DECLSPEC int SDLCALL SDL_isdigit(int x);
353 extern DECLSPEC int SDLCALL SDL_isspace(int x);
354 extern DECLSPEC int SDLCALL SDL_toupper(int x);
355 extern DECLSPEC int SDLCALL SDL_tolower(int x);
357 extern DECLSPEC void *SDLCALL SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len);
359 #define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
360 #define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
362 /* Note that memset() is a byte assignment and this is a 32-bit assignment, so they're not directly equivalent. */
363 SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
365 #if defined(__GNUC__) && defined(i386)
367 __asm__ __volatile__ (
370 : "=&D" (u0), "=&a" (u1), "=&c" (u2)
371 : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, dwords))
375 size_t _n = (dwords + 3) / 4;
376 Uint32 *_p = SDL_static_cast(Uint32 *, dst);
382 case 0: do { *_p++ = _val;
383 case 3: *_p++ = _val;
384 case 2: *_p++ = _val;
385 case 1: *_p++ = _val;
392 extern DECLSPEC void *SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
394 extern DECLSPEC void *SDLCALL SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
395 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
397 extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr);
398 extern DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
399 extern DECLSPEC size_t SDLCALL SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
401 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *str);
402 extern DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
403 extern DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes);
404 extern DECLSPEC size_t SDLCALL SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
405 extern DECLSPEC char *SDLCALL SDL_strdup(const char *str);
406 extern DECLSPEC char *SDLCALL SDL_strrev(char *str);
407 extern DECLSPEC char *SDLCALL SDL_strupr(char *str);
408 extern DECLSPEC char *SDLCALL SDL_strlwr(char *str);
409 extern DECLSPEC char *SDLCALL SDL_strchr(const char *str, int c);
410 extern DECLSPEC char *SDLCALL SDL_strrchr(const char *str, int c);
411 extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack, const char *needle);
413 extern DECLSPEC char *SDLCALL SDL_itoa(int value, char *str, int radix);
414 extern DECLSPEC char *SDLCALL SDL_uitoa(unsigned int value, char *str, int radix);
415 extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *str, int radix);
416 extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *str, int radix);
417 extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *str, int radix);
418 extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *str, int radix);
420 extern DECLSPEC int SDLCALL SDL_atoi(const char *str);
421 extern DECLSPEC double SDLCALL SDL_atof(const char *str);
422 extern DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base);
423 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base);
424 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *str, char **endp, int base);
425 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *str, char **endp, int base);
426 extern DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp);
428 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
429 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
430 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
431 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t len);
433 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, ...) SDL_SCANF_VARARG_FUNC(2);
434 extern DECLSPEC int SDLCALL SDL_vsscanf(const char *text, const char *fmt, va_list ap);
435 extern DECLSPEC int SDLCALL SDL_snprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, SDL_PRINTF_FORMAT_STRING const char *fmt, ... ) SDL_PRINTF_VARARG_FUNC(3);
436 extern DECLSPEC int SDLCALL SDL_vsnprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, va_list ap);
440 #define M_PI 3.14159265358979323846264338327950288 /* pi */
444 extern DECLSPEC double SDLCALL SDL_acos(double x);
445 extern DECLSPEC double SDLCALL SDL_asin(double x);
446 extern DECLSPEC double SDLCALL SDL_atan(double x);
447 extern DECLSPEC double SDLCALL SDL_atan2(double x, double y);
448 extern DECLSPEC double SDLCALL SDL_ceil(double x);
449 extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
450 extern DECLSPEC double SDLCALL SDL_cos(double x);
451 extern DECLSPEC float SDLCALL SDL_cosf(float x);
452 extern DECLSPEC double SDLCALL SDL_fabs(double x);
453 extern DECLSPEC double SDLCALL SDL_floor(double x);
454 extern DECLSPEC double SDLCALL SDL_log(double x);
455 extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
456 extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
457 extern DECLSPEC double SDLCALL SDL_sin(double x);
458 extern DECLSPEC float SDLCALL SDL_sinf(float x);
459 extern DECLSPEC double SDLCALL SDL_sqrt(double x);
460 extern DECLSPEC float SDLCALL SDL_sqrtf(float x);
461 extern DECLSPEC double SDLCALL SDL_tan(double x);
462 extern DECLSPEC float SDLCALL SDL_tanf(float x);
464 /* The SDL implementation of iconv() returns these error codes */
465 #define SDL_ICONV_ERROR (size_t)-1
466 #define SDL_ICONV_E2BIG (size_t)-2
467 #define SDL_ICONV_EILSEQ (size_t)-3
468 #define SDL_ICONV_EINVAL (size_t)-4
470 /* SDL_iconv_* are now always real symbols/types, not macros or inlined. */
471 typedef struct _SDL_iconv_t *SDL_iconv_t;
472 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
473 const char *fromcode);
474 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
475 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
476 size_t * inbytesleft, char **outbuf,
477 size_t * outbytesleft);
479 * This function converts a string between encodings in one pass, returning a
480 * string that must be freed with SDL_free() or NULL on error.
482 extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
483 const char *fromcode,
486 #define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
487 #define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
488 #define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
490 /* force builds using Clang's static analysis tools to use literal C runtime
491 here, since there are possibly tests that are ineffective otherwise. */
492 #if defined(__clang_analyzer__) && !defined(SDL_DISABLE_ANALYZE_MACROS)
493 #define SDL_malloc malloc
494 #define SDL_calloc calloc
495 #define SDL_realloc realloc
496 #define SDL_free free
497 #define SDL_memset memset
498 #define SDL_memcpy memcpy
499 #define SDL_memmove memmove
500 #define SDL_memcmp memcmp
501 #define SDL_strlen strlen
502 #define SDL_strlcpy strlcpy
503 #define SDL_strlcat strlcat
504 #define SDL_strdup strdup
505 #define SDL_strchr strchr
506 #define SDL_strrchr strrchr
507 #define SDL_strstr strstr
508 #define SDL_strcmp strcmp
509 #define SDL_strncmp strncmp
510 #define SDL_strcasecmp strcasecmp
511 #define SDL_strncasecmp strncasecmp
512 #define SDL_sscanf sscanf
513 #define SDL_vsscanf vsscanf
514 #define SDL_snprintf snprintf
515 #define SDL_vsnprintf vsnprintf
518 SDL_FORCE_INLINE void *SDL_memcpy4(SDL_OUT_BYTECAP(dwords*4) void *dst, SDL_IN_BYTECAP(dwords*4) const void *src, size_t dwords)
520 return SDL_memcpy(dst, src, dwords * 4);
523 /* Ends C function definitions when using C++ */
527 #include "close_code.h"
529 #endif /* _SDL_stdinc_h */
531 /* vi: set ts=4 sw=4 expandtab: */