2 Simple DirectMedia Layer
3 Copyright (C) 1997-2020 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"
34 #define _DARWIN_C_SOURCE /* for memset_pattern4() */
37 #ifdef HAVE_SYS_TYPES_H
38 #include <sys/types.h>
43 #if defined(STDC_HEADERS)
48 # if defined(HAVE_STDLIB_H)
50 # elif defined(HAVE_MALLOC_H)
53 # if defined(HAVE_STDDEF_H)
56 # if defined(HAVE_STDARG_H)
61 # if !defined(STDC_HEADERS) && defined(HAVE_MEMORY_H)
72 #if defined(HAVE_INTTYPES_H)
73 # include <inttypes.h>
74 #elif defined(HAVE_STDINT_H)
81 # if defined(__WINRT__)
82 /* Defining _USE_MATH_DEFINES is required to get M_PI to be defined on
83 WinRT. See http://msdn.microsoft.com/en-us/library/4hwaceh6.aspx
86 # define _USE_MATH_DEFINES
93 #if defined(HAVE_ALLOCA) && !defined(alloca)
94 # if defined(HAVE_ALLOCA_H)
96 # elif defined(__GNUC__)
97 # define alloca __builtin_alloca
98 # elif defined(_MSC_VER)
100 # define alloca _alloca
101 # elif defined(__WATCOMC__)
103 # elif defined(__BORLANDC__)
105 # elif defined(__DMC__)
107 # elif defined(__AIX__)
109 # elif defined(__MRC__)
110 void *alloca(unsigned);
117 * The number of elements in an array.
119 #define SDL_arraysize(array) (sizeof(array)/sizeof(array[0]))
120 #define SDL_TABLESIZE(table) SDL_arraysize(table)
123 * Macro useful for building other macros with strings in them
125 * e.g. #define LOG_ERROR(X) OutputDebugString(SDL_STRINGIFY_ARG(__FUNCTION__) ": " X "\n")
127 #define SDL_STRINGIFY_ARG(arg) #arg
130 * \name Cast operators
132 * Use proper C++ casts when compiled as C++ to be compatible with the option
133 * -Wold-style-cast of GCC (and -Werror=old-style-cast in GCC 4.2 and above).
137 #define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression)
138 #define SDL_static_cast(type, expression) static_cast<type>(expression)
139 #define SDL_const_cast(type, expression) const_cast<type>(expression)
141 #define SDL_reinterpret_cast(type, expression) ((type)(expression))
142 #define SDL_static_cast(type, expression) ((type)(expression))
143 #define SDL_const_cast(type, expression) ((type)(expression))
145 /* @} *//* Cast operators */
147 /* Define a four character code as a Uint32 */
148 #define SDL_FOURCC(A, B, C, D) \
149 ((SDL_static_cast(Uint32, SDL_static_cast(Uint8, (A))) << 0) | \
150 (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (B))) << 8) | \
151 (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (C))) << 16) | \
152 (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (D))) << 24))
155 * \name Basic data types
160 /* ARM's compiler throws warnings if we use an enum: like "SDL_bool x = a < b;" */
163 typedef int SDL_bool;
173 * \brief A signed 8-bit integer type.
175 #define SDL_MAX_SINT8 ((Sint8)0x7F) /* 127 */
176 #define SDL_MIN_SINT8 ((Sint8)(~0x7F)) /* -128 */
177 typedef int8_t Sint8;
179 * \brief An unsigned 8-bit integer type.
181 #define SDL_MAX_UINT8 ((Uint8)0xFF) /* 255 */
182 #define SDL_MIN_UINT8 ((Uint8)0x00) /* 0 */
183 typedef uint8_t Uint8;
185 * \brief A signed 16-bit integer type.
187 #define SDL_MAX_SINT16 ((Sint16)0x7FFF) /* 32767 */
188 #define SDL_MIN_SINT16 ((Sint16)(~0x7FFF)) /* -32768 */
189 typedef int16_t Sint16;
191 * \brief An unsigned 16-bit integer type.
193 #define SDL_MAX_UINT16 ((Uint16)0xFFFF) /* 65535 */
194 #define SDL_MIN_UINT16 ((Uint16)0x0000) /* 0 */
195 typedef uint16_t Uint16;
197 * \brief A signed 32-bit integer type.
199 #define SDL_MAX_SINT32 ((Sint32)0x7FFFFFFF) /* 2147483647 */
200 #define SDL_MIN_SINT32 ((Sint32)(~0x7FFFFFFF)) /* -2147483648 */
201 typedef int32_t Sint32;
203 * \brief An unsigned 32-bit integer type.
205 #define SDL_MAX_UINT32 ((Uint32)0xFFFFFFFFu) /* 4294967295 */
206 #define SDL_MIN_UINT32 ((Uint32)0x00000000) /* 0 */
207 typedef uint32_t Uint32;
210 * \brief A signed 64-bit integer type.
212 #define SDL_MAX_SINT64 ((Sint64)0x7FFFFFFFFFFFFFFFll) /* 9223372036854775807 */
213 #define SDL_MIN_SINT64 ((Sint64)(~0x7FFFFFFFFFFFFFFFll)) /* -9223372036854775808 */
214 typedef int64_t Sint64;
216 * \brief An unsigned 64-bit integer type.
218 #define SDL_MAX_UINT64 ((Uint64)0xFFFFFFFFFFFFFFFFull) /* 18446744073709551615 */
219 #define SDL_MIN_UINT64 ((Uint64)(0x0000000000000000ull)) /* 0 */
220 typedef uint64_t Uint64;
222 /* @} *//* Basic data types */
224 /* Make sure we have macros for printing 64 bit values.
225 * <stdint.h> should define these but this is not true all platforms.
226 * (for example win32) */
229 #define SDL_PRIs64 PRIs64
230 #elif defined(__WIN32__)
231 #define SDL_PRIs64 "I64d"
232 #elif defined(__LINUX__) && defined(__LP64__)
233 #define SDL_PRIs64 "ld"
235 #define SDL_PRIs64 "lld"
240 #define SDL_PRIu64 PRIu64
241 #elif defined(__WIN32__)
242 #define SDL_PRIu64 "I64u"
243 #elif defined(__LINUX__) && defined(__LP64__)
244 #define SDL_PRIu64 "lu"
246 #define SDL_PRIu64 "llu"
251 #define SDL_PRIx64 PRIx64
252 #elif defined(__WIN32__)
253 #define SDL_PRIx64 "I64x"
254 #elif defined(__LINUX__) && defined(__LP64__)
255 #define SDL_PRIx64 "lx"
257 #define SDL_PRIx64 "llx"
262 #define SDL_PRIX64 PRIX64
263 #elif defined(__WIN32__)
264 #define SDL_PRIX64 "I64X"
265 #elif defined(__LINUX__) && defined(__LP64__)
266 #define SDL_PRIX64 "lX"
268 #define SDL_PRIX64 "llX"
272 /* Annotations to help code analysis tools */
273 #ifdef SDL_DISABLE_ANALYZE_MACROS
274 #define SDL_IN_BYTECAP(x)
275 #define SDL_INOUT_Z_CAP(x)
276 #define SDL_OUT_Z_CAP(x)
277 #define SDL_OUT_CAP(x)
278 #define SDL_OUT_BYTECAP(x)
279 #define SDL_OUT_Z_BYTECAP(x)
280 #define SDL_PRINTF_FORMAT_STRING
281 #define SDL_SCANF_FORMAT_STRING
282 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
283 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
285 #if defined(_MSC_VER) && (_MSC_VER >= 1600) /* VS 2010 and above */
288 #define SDL_IN_BYTECAP(x) _In_bytecount_(x)
289 #define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x)
290 #define SDL_OUT_Z_CAP(x) _Out_z_cap_(x)
291 #define SDL_OUT_CAP(x) _Out_cap_(x)
292 #define SDL_OUT_BYTECAP(x) _Out_bytecap_(x)
293 #define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x)
295 #define SDL_PRINTF_FORMAT_STRING _Printf_format_string_
296 #define SDL_SCANF_FORMAT_STRING _Scanf_format_string_impl_
298 #define SDL_IN_BYTECAP(x)
299 #define SDL_INOUT_Z_CAP(x)
300 #define SDL_OUT_Z_CAP(x)
301 #define SDL_OUT_CAP(x)
302 #define SDL_OUT_BYTECAP(x)
303 #define SDL_OUT_Z_BYTECAP(x)
304 #define SDL_PRINTF_FORMAT_STRING
305 #define SDL_SCANF_FORMAT_STRING
307 #if defined(__GNUC__)
308 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __printf__, fmtargnumber, fmtargnumber+1 )))
309 #define SDL_SCANF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __scanf__, fmtargnumber, fmtargnumber+1 )))
311 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
312 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
314 #endif /* SDL_DISABLE_ANALYZE_MACROS */
316 #define SDL_COMPILE_TIME_ASSERT(name, x) \
317 typedef int SDL_compile_time_assert_ ## name[(x) * 2 - 1]
319 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
320 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
321 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
322 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
323 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
324 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
325 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
326 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
327 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
328 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
331 /* Check to make sure enums are the size of ints, for structure packing.
332 For both Watcom C/C++ and Borland C/C++ the compiler option that makes
333 enums having the size of an int must be enabled.
334 This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
338 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
339 #if !defined(__ANDROID__)
340 /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */
346 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
348 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
351 #include "begin_code.h"
352 /* Set up for C function definitions, even when using C++ */
358 #define SDL_stack_alloc(type, count) (type*)alloca(sizeof(type)*(count))
359 #define SDL_stack_free(data)
361 #define SDL_stack_alloc(type, count) (type*)SDL_malloc(sizeof(type)*(count))
362 #define SDL_stack_free(data) SDL_free(data)
365 extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
366 extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
367 extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
368 extern DECLSPEC void SDLCALL SDL_free(void *mem);
370 typedef void *(SDLCALL *SDL_malloc_func)(size_t size);
371 typedef void *(SDLCALL *SDL_calloc_func)(size_t nmemb, size_t size);
372 typedef void *(SDLCALL *SDL_realloc_func)(void *mem, size_t size);
373 typedef void (SDLCALL *SDL_free_func)(void *mem);
376 * \brief Get the current set of SDL memory functions
378 extern DECLSPEC void SDLCALL SDL_GetMemoryFunctions(SDL_malloc_func *malloc_func,
379 SDL_calloc_func *calloc_func,
380 SDL_realloc_func *realloc_func,
381 SDL_free_func *free_func);
384 * \brief Replace SDL's memory allocation functions with a custom set
386 * \note If you are replacing SDL's memory functions, you should call
387 * SDL_GetNumAllocations() and be very careful if it returns non-zero.
388 * That means that your free function will be called with memory
389 * allocated by the previous memory allocation functions.
391 extern DECLSPEC int SDLCALL SDL_SetMemoryFunctions(SDL_malloc_func malloc_func,
392 SDL_calloc_func calloc_func,
393 SDL_realloc_func realloc_func,
394 SDL_free_func free_func);
397 * \brief Get the number of outstanding (unfreed) allocations
399 extern DECLSPEC int SDLCALL SDL_GetNumAllocations(void);
401 extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
402 extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value, int overwrite);
404 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, int (*compare) (const void *, const void *));
406 extern DECLSPEC int SDLCALL SDL_abs(int x);
408 /* !!! FIXME: these have side effects. You probably shouldn't use them. */
409 /* !!! FIXME: Maybe we do forceinline functions of SDL_mini, SDL_minf, etc? */
410 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
411 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
413 extern DECLSPEC int SDLCALL SDL_isdigit(int x);
414 extern DECLSPEC int SDLCALL SDL_isspace(int x);
415 extern DECLSPEC int SDLCALL SDL_isupper(int x);
416 extern DECLSPEC int SDLCALL SDL_islower(int x);
417 extern DECLSPEC int SDLCALL SDL_toupper(int x);
418 extern DECLSPEC int SDLCALL SDL_tolower(int x);
420 extern DECLSPEC void *SDLCALL SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len);
422 #define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
423 #define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
424 #define SDL_zeroa(x) SDL_memset((x), 0, sizeof((x)))
426 /* Note that memset() is a byte assignment and this is a 32-bit assignment, so they're not directly equivalent. */
427 SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
430 memset_pattern4(dst, &val, dwords * 4);
431 #elif defined(__GNUC__) && defined(i386)
433 __asm__ __volatile__ (
436 : "=&D" (u0), "=&a" (u1), "=&c" (u2)
437 : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, dwords))
441 size_t _n = (dwords + 3) / 4;
442 Uint32 *_p = SDL_static_cast(Uint32 *, dst);
448 case 0: do { *_p++ = _val; /* fallthrough */
449 case 3: *_p++ = _val; /* fallthrough */
450 case 2: *_p++ = _val; /* fallthrough */
451 case 1: *_p++ = _val; /* fallthrough */
457 extern DECLSPEC void *SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
459 extern DECLSPEC void *SDLCALL SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
460 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
462 extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr);
463 extern DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
464 extern DECLSPEC size_t SDLCALL SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
465 extern DECLSPEC wchar_t *SDLCALL SDL_wcsdup(const wchar_t *wstr);
466 extern DECLSPEC wchar_t *SDLCALL SDL_wcsstr(const wchar_t *haystack, const wchar_t *needle);
468 extern DECLSPEC int SDLCALL SDL_wcscmp(const wchar_t *str1, const wchar_t *str2);
469 extern DECLSPEC int SDLCALL SDL_wcsncmp(const wchar_t *str1, const wchar_t *str2, size_t maxlen);
471 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *str);
472 extern DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
473 extern DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes);
474 extern DECLSPEC size_t SDLCALL SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
475 extern DECLSPEC char *SDLCALL SDL_strdup(const char *str);
476 extern DECLSPEC char *SDLCALL SDL_strrev(char *str);
477 extern DECLSPEC char *SDLCALL SDL_strupr(char *str);
478 extern DECLSPEC char *SDLCALL SDL_strlwr(char *str);
479 extern DECLSPEC char *SDLCALL SDL_strchr(const char *str, int c);
480 extern DECLSPEC char *SDLCALL SDL_strrchr(const char *str, int c);
481 extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack, const char *needle);
482 extern DECLSPEC char *SDLCALL SDL_strtokr(char *s1, const char *s2, char **saveptr);
483 extern DECLSPEC size_t SDLCALL SDL_utf8strlen(const char *str);
485 extern DECLSPEC char *SDLCALL SDL_itoa(int value, char *str, int radix);
486 extern DECLSPEC char *SDLCALL SDL_uitoa(unsigned int value, char *str, int radix);
487 extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *str, int radix);
488 extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *str, int radix);
489 extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *str, int radix);
490 extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *str, int radix);
492 extern DECLSPEC int SDLCALL SDL_atoi(const char *str);
493 extern DECLSPEC double SDLCALL SDL_atof(const char *str);
494 extern DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base);
495 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base);
496 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *str, char **endp, int base);
497 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *str, char **endp, int base);
498 extern DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp);
500 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
501 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
502 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
503 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t len);
505 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, ...) SDL_SCANF_VARARG_FUNC(2);
506 extern DECLSPEC int SDLCALL SDL_vsscanf(const char *text, const char *fmt, va_list ap);
507 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);
508 extern DECLSPEC int SDLCALL SDL_vsnprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, va_list ap);
512 #define M_PI 3.14159265358979323846264338327950288 /**< pi */
516 extern DECLSPEC double SDLCALL SDL_acos(double x);
517 extern DECLSPEC float SDLCALL SDL_acosf(float x);
518 extern DECLSPEC double SDLCALL SDL_asin(double x);
519 extern DECLSPEC float SDLCALL SDL_asinf(float x);
520 extern DECLSPEC double SDLCALL SDL_atan(double x);
521 extern DECLSPEC float SDLCALL SDL_atanf(float x);
522 extern DECLSPEC double SDLCALL SDL_atan2(double x, double y);
523 extern DECLSPEC float SDLCALL SDL_atan2f(float x, float y);
524 extern DECLSPEC double SDLCALL SDL_ceil(double x);
525 extern DECLSPEC float SDLCALL SDL_ceilf(float x);
526 extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
527 extern DECLSPEC float SDLCALL SDL_copysignf(float x, float y);
528 extern DECLSPEC double SDLCALL SDL_cos(double x);
529 extern DECLSPEC float SDLCALL SDL_cosf(float x);
530 extern DECLSPEC double SDLCALL SDL_exp(double x);
531 extern DECLSPEC float SDLCALL SDL_expf(float x);
532 extern DECLSPEC double SDLCALL SDL_fabs(double x);
533 extern DECLSPEC float SDLCALL SDL_fabsf(float x);
534 extern DECLSPEC double SDLCALL SDL_floor(double x);
535 extern DECLSPEC float SDLCALL SDL_floorf(float x);
536 extern DECLSPEC double SDLCALL SDL_trunc(double x);
537 extern DECLSPEC float SDLCALL SDL_truncf(float x);
538 extern DECLSPEC double SDLCALL SDL_fmod(double x, double y);
539 extern DECLSPEC float SDLCALL SDL_fmodf(float x, float y);
540 extern DECLSPEC double SDLCALL SDL_log(double x);
541 extern DECLSPEC float SDLCALL SDL_logf(float x);
542 extern DECLSPEC double SDLCALL SDL_log10(double x);
543 extern DECLSPEC float SDLCALL SDL_log10f(float x);
544 extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
545 extern DECLSPEC float SDLCALL SDL_powf(float x, float y);
546 extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
547 extern DECLSPEC float SDLCALL SDL_scalbnf(float x, int n);
548 extern DECLSPEC double SDLCALL SDL_sin(double x);
549 extern DECLSPEC float SDLCALL SDL_sinf(float x);
550 extern DECLSPEC double SDLCALL SDL_sqrt(double x);
551 extern DECLSPEC float SDLCALL SDL_sqrtf(float x);
552 extern DECLSPEC double SDLCALL SDL_tan(double x);
553 extern DECLSPEC float SDLCALL SDL_tanf(float x);
555 /* The SDL implementation of iconv() returns these error codes */
556 #define SDL_ICONV_ERROR (size_t)-1
557 #define SDL_ICONV_E2BIG (size_t)-2
558 #define SDL_ICONV_EILSEQ (size_t)-3
559 #define SDL_ICONV_EINVAL (size_t)-4
561 /* SDL_iconv_* are now always real symbols/types, not macros or inlined. */
562 typedef struct _SDL_iconv_t *SDL_iconv_t;
563 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
564 const char *fromcode);
565 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
566 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
567 size_t * inbytesleft, char **outbuf,
568 size_t * outbytesleft);
570 * This function converts a string between encodings in one pass, returning a
571 * string that must be freed with SDL_free() or NULL on error.
573 extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
574 const char *fromcode,
577 #define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
578 #define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
579 #define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
581 /* force builds using Clang's static analysis tools to use literal C runtime
582 here, since there are possibly tests that are ineffective otherwise. */
583 #if defined(__clang_analyzer__) && !defined(SDL_DISABLE_ANALYZE_MACROS)
585 /* The analyzer knows about strlcpy even when the system doesn't provide it */
587 size_t strlcpy(char* dst, const char* src, size_t size);
590 /* The analyzer knows about strlcat even when the system doesn't provide it */
592 size_t strlcat(char* dst, const char* src, size_t size);
595 #define SDL_malloc malloc
596 #define SDL_calloc calloc
597 #define SDL_realloc realloc
598 #define SDL_free free
599 #define SDL_memset memset
600 #define SDL_memcpy memcpy
601 #define SDL_memmove memmove
602 #define SDL_memcmp memcmp
603 #define SDL_strlcpy strlcpy
604 #define SDL_strlcat strlcat
605 #define SDL_strlen strlen
606 #define SDL_wcslen wcslen
607 #define SDL_wcslcpy wcslcpy
608 #define SDL_wcslcat wcslcat
609 #define SDL_strdup strdup
610 #define SDL_wcsdup wcsdup
611 #define SDL_strchr strchr
612 #define SDL_strrchr strrchr
613 #define SDL_strstr strstr
614 #define SDL_wcsstr wcsstr
615 #define SDL_strtokr strtok_r
616 #define SDL_strcmp strcmp
617 #define SDL_wcscmp wcscmp
618 #define SDL_strncmp strncmp
619 #define SDL_wcsncmp wcsncmp
620 #define SDL_strcasecmp strcasecmp
621 #define SDL_strncasecmp strncasecmp
622 #define SDL_sscanf sscanf
623 #define SDL_vsscanf vsscanf
624 #define SDL_snprintf snprintf
625 #define SDL_vsnprintf vsnprintf
628 SDL_FORCE_INLINE void *SDL_memcpy4(SDL_OUT_BYTECAP(dwords*4) void *dst, SDL_IN_BYTECAP(dwords*4) const void *src, size_t dwords)
630 return SDL_memcpy(dst, src, dwords * 4);
633 /* Ends C function definitions when using C++ */
637 #include "close_code.h"
639 #endif /* SDL_stdinc_h_ */
641 /* vi: set ts=4 sw=4 expandtab: */