include/SDL_stdinc.h
author Ryan C. Gordon <icculus@icculus.org>
Sun, 12 Apr 2015 20:28:28 -0400
changeset 9553 75dca0c33be6
parent 9473 61f57bbbc2f3
child 9619 b94b6d0bff0f
permissions -rw-r--r--
Merged.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
     4 
     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.
     8 
     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:
    12 
    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.
    20 */
    21 
    22 /**
    23  *  \file SDL_stdinc.h
    24  *
    25  *  This is a general header that includes C language support.
    26  */
    27 
    28 #ifndef _SDL_stdinc_h
    29 #define _SDL_stdinc_h
    30 
    31 #include "SDL_config.h"
    32 
    33 #ifdef HAVE_SYS_TYPES_H
    34 #include <sys/types.h>
    35 #endif
    36 #ifdef HAVE_STDIO_H
    37 #include <stdio.h>
    38 #endif
    39 #if defined(STDC_HEADERS)
    40 # include <stdlib.h>
    41 # include <stddef.h>
    42 # include <stdarg.h>
    43 #else
    44 # if defined(HAVE_STDLIB_H)
    45 #  include <stdlib.h>
    46 # elif defined(HAVE_MALLOC_H)
    47 #  include <malloc.h>
    48 # endif
    49 # if defined(HAVE_STDDEF_H)
    50 #  include <stddef.h>
    51 # endif
    52 # if defined(HAVE_STDARG_H)
    53 #  include <stdarg.h>
    54 # endif
    55 #endif
    56 #ifdef HAVE_STRING_H
    57 # if !defined(STDC_HEADERS) && defined(HAVE_MEMORY_H)
    58 #  include <memory.h>
    59 # endif
    60 # include <string.h>
    61 #endif
    62 #ifdef HAVE_STRINGS_H
    63 # include <strings.h>
    64 #endif
    65 #if defined(HAVE_INTTYPES_H)
    66 # include <inttypes.h>
    67 #elif defined(HAVE_STDINT_H)
    68 # include <stdint.h>
    69 #endif
    70 #ifdef HAVE_CTYPE_H
    71 # include <ctype.h>
    72 #endif
    73 #ifdef HAVE_MATH_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
    77    for more information.
    78 */
    79 #  define _USE_MATH_DEFINES
    80 # endif
    81 # include <math.h>
    82 #endif
    83 #ifdef HAVE_FLOAT_H
    84 # include <float.h>
    85 #endif
    86 #if defined(HAVE_ICONV) && defined(HAVE_ICONV_H)
    87 # include <iconv.h>
    88 #endif
    89 
    90 /**
    91  *  The number of elements in an array.
    92  */
    93 #define SDL_arraysize(array)    (sizeof(array)/sizeof(array[0]))
    94 #define SDL_TABLESIZE(table)    SDL_arraysize(table)
    95 
    96 /**
    97  *  \name Cast operators
    98  *
    99  *  Use proper C++ casts when compiled as C++ to be compatible with the option
   100  *  -Wold-style-cast of GCC (and -Werror=old-style-cast in GCC 4.2 and above).
   101  */
   102 /* @{ */
   103 #ifdef __cplusplus
   104 #define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression)
   105 #define SDL_static_cast(type, expression) static_cast<type>(expression)
   106 #define SDL_const_cast(type, expression) const_cast<type>(expression)
   107 #else
   108 #define SDL_reinterpret_cast(type, expression) ((type)(expression))
   109 #define SDL_static_cast(type, expression) ((type)(expression))
   110 #define SDL_const_cast(type, expression) ((type)(expression))
   111 #endif
   112 /* @} *//* Cast operators */
   113 
   114 /* Define a four character code as a Uint32 */
   115 #define SDL_FOURCC(A, B, C, D) \
   116     ((SDL_static_cast(Uint32, SDL_static_cast(Uint8, (A))) << 0) | \
   117      (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (B))) << 8) | \
   118      (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (C))) << 16) | \
   119      (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (D))) << 24))
   120 
   121 /**
   122  *  \name Basic data types
   123  */
   124 /* @{ */
   125 
   126 typedef enum
   127 {
   128     SDL_FALSE = 0,
   129     SDL_TRUE = 1
   130 } SDL_bool;
   131 
   132 /**
   133  * \brief A signed 8-bit integer type.
   134  */
   135 typedef int8_t Sint8;
   136 /**
   137  * \brief An unsigned 8-bit integer type.
   138  */
   139 typedef uint8_t Uint8;
   140 /**
   141  * \brief A signed 16-bit integer type.
   142  */
   143 typedef int16_t Sint16;
   144 /**
   145  * \brief An unsigned 16-bit integer type.
   146  */
   147 typedef uint16_t Uint16;
   148 /**
   149  * \brief A signed 32-bit integer type.
   150  */
   151 typedef int32_t Sint32;
   152 /**
   153  * \brief An unsigned 32-bit integer type.
   154  */
   155 typedef uint32_t Uint32;
   156 
   157 /**
   158  * \brief A signed 64-bit integer type.
   159  */
   160 typedef int64_t Sint64;
   161 /**
   162  * \brief An unsigned 64-bit integer type.
   163  */
   164 typedef uint64_t Uint64;
   165 
   166 /* @} *//* Basic data types */
   167 
   168 /* Make sure we have macros for printing 64 bit values.
   169  * <stdint.h> should define these but this is not true all platforms.
   170  * (for example win32) */
   171 #ifndef SDL_PRIs64
   172 #ifdef PRIs64
   173 #define SDL_PRIs64 PRIs64
   174 #elif defined(__WIN32__)
   175 #define SDL_PRIs64 "I64d"
   176 #elif defined(__LINUX__) && defined(__LP64__)
   177 #define SDL_PRIs64 "ld"
   178 #else
   179 #define SDL_PRIs64 "lld"
   180 #endif
   181 #endif
   182 #ifndef SDL_PRIu64
   183 #ifdef PRIu64
   184 #define SDL_PRIu64 PRIu64
   185 #elif defined(__WIN32__)
   186 #define SDL_PRIu64 "I64u"
   187 #elif defined(__LINUX__) && defined(__LP64__)
   188 #define SDL_PRIu64 "lu"
   189 #else
   190 #define SDL_PRIu64 "llu"
   191 #endif
   192 #endif
   193 #ifndef SDL_PRIx64
   194 #ifdef PRIx64
   195 #define SDL_PRIx64 PRIx64
   196 #elif defined(__WIN32__)
   197 #define SDL_PRIx64 "I64x"
   198 #elif defined(__LINUX__) && defined(__LP64__)
   199 #define SDL_PRIx64 "lx"
   200 #else
   201 #define SDL_PRIx64 "llx"
   202 #endif
   203 #endif
   204 #ifndef SDL_PRIX64
   205 #ifdef PRIX64
   206 #define SDL_PRIX64 PRIX64
   207 #elif defined(__WIN32__)
   208 #define SDL_PRIX64 "I64X"
   209 #elif defined(__LINUX__) && defined(__LP64__)
   210 #define SDL_PRIX64 "lX"
   211 #else
   212 #define SDL_PRIX64 "llX"
   213 #endif
   214 #endif
   215 
   216 /* Annotations to help code analysis tools */
   217 #ifdef SDL_DISABLE_ANALYZE_MACROS
   218 #define SDL_IN_BYTECAP(x)
   219 #define SDL_INOUT_Z_CAP(x)
   220 #define SDL_OUT_Z_CAP(x)
   221 #define SDL_OUT_CAP(x)
   222 #define SDL_OUT_BYTECAP(x)
   223 #define SDL_OUT_Z_BYTECAP(x)
   224 #define SDL_PRINTF_FORMAT_STRING
   225 #define SDL_SCANF_FORMAT_STRING
   226 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
   227 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
   228 #else
   229 #if defined(_MSC_VER) && (_MSC_VER >= 1600) /* VS 2010 and above */
   230 #include <sal.h>
   231 
   232 #define SDL_IN_BYTECAP(x) _In_bytecount_(x)
   233 #define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x)
   234 #define SDL_OUT_Z_CAP(x) _Out_z_cap_(x)
   235 #define SDL_OUT_CAP(x) _Out_cap_(x)
   236 #define SDL_OUT_BYTECAP(x) _Out_bytecap_(x)
   237 #define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x)
   238 
   239 #define SDL_PRINTF_FORMAT_STRING _Printf_format_string_
   240 #define SDL_SCANF_FORMAT_STRING _Scanf_format_string_impl_
   241 #else
   242 #define SDL_IN_BYTECAP(x)
   243 #define SDL_INOUT_Z_CAP(x)
   244 #define SDL_OUT_Z_CAP(x)
   245 #define SDL_OUT_CAP(x)
   246 #define SDL_OUT_BYTECAP(x)
   247 #define SDL_OUT_Z_BYTECAP(x)
   248 #define SDL_PRINTF_FORMAT_STRING
   249 #define SDL_SCANF_FORMAT_STRING
   250 #endif
   251 #if defined(__GNUC__)
   252 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __printf__, fmtargnumber, fmtargnumber+1 )))
   253 #define SDL_SCANF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __scanf__, fmtargnumber, fmtargnumber+1 )))
   254 #else
   255 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
   256 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
   257 #endif
   258 #endif /* SDL_DISABLE_ANALYZE_MACROS */
   259 
   260 #define SDL_COMPILE_TIME_ASSERT(name, x)               \
   261        typedef int SDL_dummy_ ## name[(x) * 2 - 1]
   262 /** \cond */
   263 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
   264 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
   265 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
   266 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
   267 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
   268 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
   269 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
   270 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
   271 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
   272 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
   273 /** \endcond */
   274 
   275 /* Check to make sure enums are the size of ints, for structure packing.
   276    For both Watcom C/C++ and Borland C/C++ the compiler option that makes
   277    enums having the size of an int must be enabled.
   278    This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
   279 */
   280 
   281 /** \cond */
   282 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
   283 #if !defined(__ANDROID__)
   284    /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */
   285 typedef enum
   286 {
   287     DUMMY_ENUM_VALUE
   288 } SDL_DUMMY_ENUM;
   289 
   290 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
   291 #endif
   292 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
   293 /** \endcond */
   294 
   295 #include "begin_code.h"
   296 /* Set up for C function definitions, even when using C++ */
   297 #ifdef __cplusplus
   298 extern "C" {
   299 #endif
   300 
   301 #if defined(HAVE_ALLOCA) && !defined(alloca)
   302 # if defined(HAVE_ALLOCA_H)
   303 #  include <alloca.h>
   304 # elif defined(__GNUC__)
   305 #  define alloca __builtin_alloca
   306 # elif defined(_MSC_VER)
   307 #  include <malloc.h>
   308 #  define alloca _alloca
   309 # elif defined(__WATCOMC__)
   310 #  include <malloc.h>
   311 # elif defined(__BORLANDC__)
   312 #  include <malloc.h>
   313 # elif defined(__DMC__)
   314 #  include <stdlib.h>
   315 # elif defined(__AIX__)
   316 #pragma alloca
   317 # elif defined(__MRC__)
   318 void *alloca(unsigned);
   319 # else
   320 char *alloca();
   321 # endif
   322 #endif
   323 #ifdef HAVE_ALLOCA
   324 #define SDL_stack_alloc(type, count)    (type*)alloca(sizeof(type)*(count))
   325 #define SDL_stack_free(data)
   326 #else
   327 #define SDL_stack_alloc(type, count)    (type*)SDL_malloc(sizeof(type)*(count))
   328 #define SDL_stack_free(data)            SDL_free(data)
   329 #endif
   330 
   331 extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
   332 extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
   333 extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
   334 extern DECLSPEC void SDLCALL SDL_free(void *mem);
   335 
   336 extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
   337 extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value, int overwrite);
   338 
   339 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, int (*compare) (const void *, const void *));
   340 
   341 extern DECLSPEC int SDLCALL SDL_abs(int x);
   342 
   343 /* !!! FIXME: these have side effects. You probably shouldn't use them. */
   344 /* !!! FIXME: Maybe we do forceinline functions of SDL_mini, SDL_minf, etc? */
   345 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
   346 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
   347 
   348 extern DECLSPEC int SDLCALL SDL_isdigit(int x);
   349 extern DECLSPEC int SDLCALL SDL_isspace(int x);
   350 extern DECLSPEC int SDLCALL SDL_toupper(int x);
   351 extern DECLSPEC int SDLCALL SDL_tolower(int x);
   352 
   353 extern DECLSPEC void *SDLCALL SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len);
   354 
   355 #define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
   356 #define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
   357 
   358 /* Note that memset() is a byte assignment and this is a 32-bit assignment, so they're not directly equivalent. */
   359 SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
   360 {
   361 #if defined(__GNUC__) && defined(i386)
   362     int u0, u1, u2;
   363     __asm__ __volatile__ (
   364         "cld \n\t"
   365         "rep ; stosl \n\t"
   366         : "=&D" (u0), "=&a" (u1), "=&c" (u2)
   367         : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, dwords))
   368         : "memory"
   369     );
   370 #else
   371     size_t _n = (dwords + 3) / 4;
   372     Uint32 *_p = SDL_static_cast(Uint32 *, dst);
   373     Uint32 _val = (val);
   374     if (dwords == 0)
   375         return;
   376     switch (dwords % 4)
   377     {
   378         case 0: do {    *_p++ = _val;
   379         case 3:         *_p++ = _val;
   380         case 2:         *_p++ = _val;
   381         case 1:         *_p++ = _val;
   382         } while ( --_n );
   383     }
   384 #endif
   385 }
   386 
   387 
   388 extern DECLSPEC void *SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
   389 
   390 extern DECLSPEC void *SDLCALL SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
   391 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
   392 
   393 extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr);
   394 extern DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
   395 extern DECLSPEC size_t SDLCALL SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
   396 
   397 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *str);
   398 extern DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
   399 extern DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes);
   400 extern DECLSPEC size_t SDLCALL SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
   401 extern DECLSPEC char *SDLCALL SDL_strdup(const char *str);
   402 extern DECLSPEC char *SDLCALL SDL_strrev(char *str);
   403 extern DECLSPEC char *SDLCALL SDL_strupr(char *str);
   404 extern DECLSPEC char *SDLCALL SDL_strlwr(char *str);
   405 extern DECLSPEC char *SDLCALL SDL_strchr(const char *str, int c);
   406 extern DECLSPEC char *SDLCALL SDL_strrchr(const char *str, int c);
   407 extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack, const char *needle);
   408 
   409 extern DECLSPEC char *SDLCALL SDL_itoa(int value, char *str, int radix);
   410 extern DECLSPEC char *SDLCALL SDL_uitoa(unsigned int value, char *str, int radix);
   411 extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *str, int radix);
   412 extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *str, int radix);
   413 extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *str, int radix);
   414 extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *str, int radix);
   415 
   416 extern DECLSPEC int SDLCALL SDL_atoi(const char *str);
   417 extern DECLSPEC double SDLCALL SDL_atof(const char *str);
   418 extern DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base);
   419 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base);
   420 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *str, char **endp, int base);
   421 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *str, char **endp, int base);
   422 extern DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp);
   423 
   424 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
   425 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
   426 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
   427 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t len);
   428 
   429 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, ...) SDL_SCANF_VARARG_FUNC(2);
   430 extern DECLSPEC int SDLCALL SDL_vsscanf(const char *text, const char *fmt, va_list ap);
   431 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);
   432 extern DECLSPEC int SDLCALL SDL_vsnprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, va_list ap);
   433 
   434 #ifndef HAVE_M_PI
   435 #ifndef M_PI
   436 #define M_PI    3.14159265358979323846264338327950288   /* pi */
   437 #endif
   438 #endif
   439 
   440 extern DECLSPEC double SDLCALL SDL_acos(double x);
   441 extern DECLSPEC double SDLCALL SDL_asin(double x);
   442 extern DECLSPEC double SDLCALL SDL_atan(double x);
   443 extern DECLSPEC double SDLCALL SDL_atan2(double x, double y);
   444 extern DECLSPEC double SDLCALL SDL_ceil(double x);
   445 extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
   446 extern DECLSPEC double SDLCALL SDL_cos(double x);
   447 extern DECLSPEC float SDLCALL SDL_cosf(float x);
   448 extern DECLSPEC double SDLCALL SDL_fabs(double x);
   449 extern DECLSPEC double SDLCALL SDL_floor(double x);
   450 extern DECLSPEC double SDLCALL SDL_log(double x);
   451 extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
   452 extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
   453 extern DECLSPEC double SDLCALL SDL_sin(double x);
   454 extern DECLSPEC float SDLCALL SDL_sinf(float x);
   455 extern DECLSPEC double SDLCALL SDL_sqrt(double x);
   456 extern DECLSPEC float SDLCALL SDL_sqrtf(float x);
   457 extern DECLSPEC double SDLCALL SDL_tan(double x);
   458 extern DECLSPEC float SDLCALL SDL_tanf(float x);
   459 
   460 /* The SDL implementation of iconv() returns these error codes */
   461 #define SDL_ICONV_ERROR     (size_t)-1
   462 #define SDL_ICONV_E2BIG     (size_t)-2
   463 #define SDL_ICONV_EILSEQ    (size_t)-3
   464 #define SDL_ICONV_EINVAL    (size_t)-4
   465 
   466 /* SDL_iconv_* are now always real symbols/types, not macros or inlined. */
   467 typedef struct _SDL_iconv_t *SDL_iconv_t;
   468 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
   469                                                    const char *fromcode);
   470 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
   471 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
   472                                          size_t * inbytesleft, char **outbuf,
   473                                          size_t * outbytesleft);
   474 /**
   475  *  This function converts a string between encodings in one pass, returning a
   476  *  string that must be freed with SDL_free() or NULL on error.
   477  */
   478 extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
   479                                                const char *fromcode,
   480                                                const char *inbuf,
   481                                                size_t inbytesleft);
   482 #define SDL_iconv_utf8_locale(S)    SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
   483 #define SDL_iconv_utf8_ucs2(S)      (Uint16 *)SDL_iconv_string("UCS-2-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
   484 #define SDL_iconv_utf8_ucs4(S)      (Uint32 *)SDL_iconv_string("UCS-4-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
   485 
   486 /* force builds using Clang's static analysis tools to use literal C runtime
   487    here, since there are possibly tests that are ineffective otherwise. */
   488 #if defined(__clang_analyzer__) && !defined(SDL_DISABLE_ANALYZE_MACROS)
   489 #define SDL_malloc malloc
   490 #define SDL_calloc calloc
   491 #define SDL_realloc realloc
   492 #define SDL_free free
   493 #define SDL_memset memset
   494 #define SDL_memcpy memcpy
   495 #define SDL_memmove memmove
   496 #define SDL_memcmp memcmp
   497 #define SDL_strlen strlen
   498 #define SDL_strlcpy strlcpy
   499 #define SDL_strlcat strlcat
   500 #define SDL_strdup strdup
   501 #define SDL_strchr strchr
   502 #define SDL_strrchr strrchr
   503 #define SDL_strstr strstr
   504 #define SDL_strcmp strcmp
   505 #define SDL_strncmp strncmp
   506 #define SDL_strcasecmp strcasecmp
   507 #define SDL_strncasecmp strncasecmp
   508 #define SDL_sscanf sscanf
   509 #define SDL_vsscanf vsscanf
   510 #define SDL_snprintf snprintf
   511 #define SDL_vsnprintf vsnprintf
   512 #endif
   513 
   514 SDL_FORCE_INLINE void *SDL_memcpy4(SDL_OUT_BYTECAP(dwords*4) void *dst, SDL_IN_BYTECAP(dwords*4) const void *src, size_t dwords)
   515 {
   516     return SDL_memcpy(dst, src, dwords * 4);
   517 }
   518 
   519 /* Ends C function definitions when using C++ */
   520 #ifdef __cplusplus
   521 }
   522 #endif
   523 #include "close_code.h"
   524 
   525 #endif /* _SDL_stdinc_h */
   526 
   527 /* vi: set ts=4 sw=4 expandtab: */