include/SDL_stdinc.h
author Edward Rudd <urkle@outoforder.cc>
Wed, 03 Dec 2014 12:23:17 -0500
changeset 9260 039714172dc3
parent 9080 2e4e71ec140f
child 9261 ac20d283fe41
permissions -rw-r--r--
switch to use SDL_PRI* macros for long long formatting everywhere.
     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 "I64"
   176 #else
   177 #define SDL_PRIs64 "lld"
   178 #endif
   179 #endif
   180 #ifndef SDL_PRIu64
   181 #ifdef PRIu64
   182 #define SDL_PRIu64 PRIu64
   183 #elif defined(__WIN32__)
   184 #define SDL_PRIu64 "I64u"
   185 #else
   186 #define SDL_PRIu64 "llu"
   187 #endif
   188 #endif
   189 #ifndef SDL_PRIx64
   190 #ifdef PRIx64
   191 #define SDL_PRIx64 PRIx64
   192 #elif defined(__WIN32__)
   193 #define SDL_PRIx64 "I64x"
   194 #else
   195 #define SDL_PRIx64 "llx"
   196 #endif
   197 #endif
   198 #ifndef SDL_PRIX64
   199 #ifdef PRIX64
   200 #define SDL_PRIX64 PRIX64
   201 #elif defined(__WIN32__)
   202 #define SDL_PRIX64 "I64X"
   203 #else
   204 #define SDL_PRIX64 "llX"
   205 #endif
   206 #endif
   207 
   208 /* Annotations to help code analysis tools */
   209 #ifdef SDL_DISABLE_ANALYZE_MACROS
   210 #define SDL_IN_BYTECAP(x)
   211 #define SDL_INOUT_Z_CAP(x)
   212 #define SDL_OUT_Z_CAP(x)
   213 #define SDL_OUT_CAP(x)
   214 #define SDL_OUT_BYTECAP(x)
   215 #define SDL_OUT_Z_BYTECAP(x)
   216 #define SDL_PRINTF_FORMAT_STRING
   217 #define SDL_SCANF_FORMAT_STRING
   218 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
   219 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
   220 #else
   221 #if _MSC_VER >= 1600 /* VS 2010 and above */
   222 #include <sal.h>
   223 
   224 #define SDL_IN_BYTECAP(x) _In_bytecount_(x)
   225 #define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x)
   226 #define SDL_OUT_Z_CAP(x) _Out_z_cap_(x)
   227 #define SDL_OUT_CAP(x) _Out_cap_(x)
   228 #define SDL_OUT_BYTECAP(x) _Out_bytecap_(x)
   229 #define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x)
   230 
   231 #define SDL_PRINTF_FORMAT_STRING _Printf_format_string_
   232 #define SDL_SCANF_FORMAT_STRING _Scanf_format_string_impl_
   233 #else
   234 #define SDL_IN_BYTECAP(x)
   235 #define SDL_INOUT_Z_CAP(x)
   236 #define SDL_OUT_Z_CAP(x)
   237 #define SDL_OUT_CAP(x)
   238 #define SDL_OUT_BYTECAP(x)
   239 #define SDL_OUT_Z_BYTECAP(x)
   240 #define SDL_PRINTF_FORMAT_STRING
   241 #define SDL_SCANF_FORMAT_STRING
   242 #endif
   243 #if defined(__GNUC__)
   244 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __printf__, fmtargnumber, fmtargnumber+1 )))
   245 #define SDL_SCANF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __scanf__, fmtargnumber, fmtargnumber+1 )))
   246 #else
   247 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
   248 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
   249 #endif
   250 #endif /* SDL_DISABLE_ANALYZE_MACROS */
   251 
   252 #define SDL_COMPILE_TIME_ASSERT(name, x)               \
   253        typedef int SDL_dummy_ ## name[(x) * 2 - 1]
   254 /** \cond */
   255 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
   256 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
   257 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
   258 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
   259 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
   260 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
   261 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
   262 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
   263 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
   264 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
   265 /** \endcond */
   266 
   267 /* Check to make sure enums are the size of ints, for structure packing.
   268    For both Watcom C/C++ and Borland C/C++ the compiler option that makes
   269    enums having the size of an int must be enabled.
   270    This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
   271 */
   272 
   273 /** \cond */
   274 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
   275 #if !defined(__ANDROID__)
   276    /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */
   277 typedef enum
   278 {
   279     DUMMY_ENUM_VALUE
   280 } SDL_DUMMY_ENUM;
   281 
   282 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
   283 #endif
   284 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
   285 /** \endcond */
   286 
   287 #include "begin_code.h"
   288 /* Set up for C function definitions, even when using C++ */
   289 #ifdef __cplusplus
   290 extern "C" {
   291 #endif
   292 
   293 #if defined(HAVE_ALLOCA) && !defined(alloca)
   294 # if defined(HAVE_ALLOCA_H)
   295 #  include <alloca.h>
   296 # elif defined(__GNUC__)
   297 #  define alloca __builtin_alloca
   298 # elif defined(_MSC_VER)
   299 #  include <malloc.h>
   300 #  define alloca _alloca
   301 # elif defined(__WATCOMC__)
   302 #  include <malloc.h>
   303 # elif defined(__BORLANDC__)
   304 #  include <malloc.h>
   305 # elif defined(__DMC__)
   306 #  include <stdlib.h>
   307 # elif defined(__AIX__)
   308 #pragma alloca
   309 # elif defined(__MRC__)
   310 void *alloca(unsigned);
   311 # else
   312 char *alloca();
   313 # endif
   314 #endif
   315 #ifdef HAVE_ALLOCA
   316 #define SDL_stack_alloc(type, count)    (type*)alloca(sizeof(type)*(count))
   317 #define SDL_stack_free(data)
   318 #else
   319 #define SDL_stack_alloc(type, count)    (type*)SDL_malloc(sizeof(type)*(count))
   320 #define SDL_stack_free(data)            SDL_free(data)
   321 #endif
   322 
   323 extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
   324 extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
   325 extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
   326 extern DECLSPEC void SDLCALL SDL_free(void *mem);
   327 
   328 extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
   329 extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value, int overwrite);
   330 
   331 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, int (*compare) (const void *, const void *));
   332 
   333 extern DECLSPEC int SDLCALL SDL_abs(int x);
   334 
   335 /* !!! FIXME: these have side effects. You probably shouldn't use them. */
   336 /* !!! FIXME: Maybe we do forceinline functions of SDL_mini, SDL_minf, etc? */
   337 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
   338 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
   339 
   340 extern DECLSPEC int SDLCALL SDL_isdigit(int x);
   341 extern DECLSPEC int SDLCALL SDL_isspace(int x);
   342 extern DECLSPEC int SDLCALL SDL_toupper(int x);
   343 extern DECLSPEC int SDLCALL SDL_tolower(int x);
   344 
   345 extern DECLSPEC void *SDLCALL SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len);
   346 
   347 #define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
   348 #define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
   349 
   350 /* Note that memset() is a byte assignment and this is a 32-bit assignment, so they're not directly equivalent. */
   351 SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
   352 {
   353 #if defined(__GNUC__) && defined(i386)
   354     int u0, u1, u2;
   355     __asm__ __volatile__ (
   356         "cld \n\t"
   357         "rep ; stosl \n\t"
   358         : "=&D" (u0), "=&a" (u1), "=&c" (u2)
   359         : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, dwords))
   360         : "memory"
   361     );
   362 #else
   363     size_t _n = (dwords + 3) / 4;
   364     Uint32 *_p = SDL_static_cast(Uint32 *, dst);
   365     Uint32 _val = (val);
   366     if (dwords == 0)
   367         return;
   368     switch (dwords % 4)
   369     {
   370         case 0: do {    *_p++ = _val;
   371         case 3:         *_p++ = _val;
   372         case 2:         *_p++ = _val;
   373         case 1:         *_p++ = _val;
   374         } while ( --_n );
   375     }
   376 #endif
   377 }
   378 
   379 
   380 extern DECLSPEC void *SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
   381 
   382 SDL_FORCE_INLINE void *SDL_memcpy4(SDL_OUT_BYTECAP(dwords*4) void *dst, SDL_IN_BYTECAP(dwords*4) const void *src, size_t dwords)
   383 {
   384     return SDL_memcpy(dst, src, dwords * 4);
   385 }
   386 
   387 extern DECLSPEC void *SDLCALL SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
   388 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
   389 
   390 extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr);
   391 extern DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
   392 extern DECLSPEC size_t SDLCALL SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
   393 
   394 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *str);
   395 extern DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
   396 extern DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes);
   397 extern DECLSPEC size_t SDLCALL SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
   398 extern DECLSPEC char *SDLCALL SDL_strdup(const char *str);
   399 extern DECLSPEC char *SDLCALL SDL_strrev(char *str);
   400 extern DECLSPEC char *SDLCALL SDL_strupr(char *str);
   401 extern DECLSPEC char *SDLCALL SDL_strlwr(char *str);
   402 extern DECLSPEC char *SDLCALL SDL_strchr(const char *str, int c);
   403 extern DECLSPEC char *SDLCALL SDL_strrchr(const char *str, int c);
   404 extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack, const char *needle);
   405 
   406 extern DECLSPEC char *SDLCALL SDL_itoa(int value, char *str, int radix);
   407 extern DECLSPEC char *SDLCALL SDL_uitoa(unsigned int value, char *str, int radix);
   408 extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *str, int radix);
   409 extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *str, int radix);
   410 extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *str, int radix);
   411 extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *str, int radix);
   412 
   413 extern DECLSPEC int SDLCALL SDL_atoi(const char *str);
   414 extern DECLSPEC double SDLCALL SDL_atof(const char *str);
   415 extern DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base);
   416 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base);
   417 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *str, char **endp, int base);
   418 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *str, char **endp, int base);
   419 extern DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp);
   420 
   421 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
   422 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
   423 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
   424 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t len);
   425 
   426 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, ...) SDL_SCANF_VARARG_FUNC(2);
   427 extern DECLSPEC int SDLCALL SDL_vsscanf(const char *text, const char *fmt, va_list ap);
   428 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);
   429 extern DECLSPEC int SDLCALL SDL_vsnprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, va_list ap);
   430 
   431 #ifndef HAVE_M_PI
   432 #ifndef M_PI
   433 #define M_PI    3.14159265358979323846264338327950288   /* pi */
   434 #endif
   435 #endif
   436 
   437 extern DECLSPEC double SDLCALL SDL_acos(double x);
   438 extern DECLSPEC double SDLCALL SDL_asin(double x);
   439 extern DECLSPEC double SDLCALL SDL_atan(double x);
   440 extern DECLSPEC double SDLCALL SDL_atan2(double x, double y);
   441 extern DECLSPEC double SDLCALL SDL_ceil(double x);
   442 extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
   443 extern DECLSPEC double SDLCALL SDL_cos(double x);
   444 extern DECLSPEC float SDLCALL SDL_cosf(float x);
   445 extern DECLSPEC double SDLCALL SDL_fabs(double x);
   446 extern DECLSPEC double SDLCALL SDL_floor(double x);
   447 extern DECLSPEC double SDLCALL SDL_log(double x);
   448 extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
   449 extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
   450 extern DECLSPEC double SDLCALL SDL_sin(double x);
   451 extern DECLSPEC float SDLCALL SDL_sinf(float x);
   452 extern DECLSPEC double SDLCALL SDL_sqrt(double x);
   453 extern DECLSPEC float SDLCALL SDL_sqrtf(float x);
   454 extern DECLSPEC double SDLCALL SDL_tan(double x);
   455 extern DECLSPEC float SDLCALL SDL_tanf(float x);
   456 
   457 /* The SDL implementation of iconv() returns these error codes */
   458 #define SDL_ICONV_ERROR     (size_t)-1
   459 #define SDL_ICONV_E2BIG     (size_t)-2
   460 #define SDL_ICONV_EILSEQ    (size_t)-3
   461 #define SDL_ICONV_EINVAL    (size_t)-4
   462 
   463 /* SDL_iconv_* are now always real symbols/types, not macros or inlined. */
   464 typedef struct _SDL_iconv_t *SDL_iconv_t;
   465 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
   466                                                    const char *fromcode);
   467 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
   468 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
   469                                          size_t * inbytesleft, char **outbuf,
   470                                          size_t * outbytesleft);
   471 /**
   472  *  This function converts a string between encodings in one pass, returning a
   473  *  string that must be freed with SDL_free() or NULL on error.
   474  */
   475 extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
   476                                                const char *fromcode,
   477                                                const char *inbuf,
   478                                                size_t inbytesleft);
   479 #define SDL_iconv_utf8_locale(S)    SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
   480 #define SDL_iconv_utf8_ucs2(S)      (Uint16 *)SDL_iconv_string("UCS-2-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
   481 #define SDL_iconv_utf8_ucs4(S)      (Uint32 *)SDL_iconv_string("UCS-4-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
   482 
   483 /* Ends C function definitions when using C++ */
   484 #ifdef __cplusplus
   485 }
   486 #endif
   487 #include "close_code.h"
   488 
   489 #endif /* _SDL_stdinc_h */
   490 
   491 /* vi: set ts=4 sw=4 expandtab: */