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