include/SDL_stdinc.h
author David Ludwig <dludwig@pobox.com>
Fri, 01 Nov 2013 22:54:39 -0400
changeset 8540 724af2cd53b8
parent 8535 e8ee0708ef5c
child 8543 b9dd3cf38585
permissions -rw-r--r--
WinRT: added support for SDL_HINT_RENDER_SCALE_QUALITY
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 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 
   169 #define SDL_COMPILE_TIME_ASSERT(name, x)               \
   170        typedef int SDL_dummy_ ## name[(x) * 2 - 1]
   171 /** \cond */
   172 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
   173 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
   174 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
   175 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
   176 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
   177 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
   178 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
   179 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
   180 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
   181 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
   182 /** \endcond */
   183 
   184 /* Check to make sure enums are the size of ints, for structure packing.
   185    For both Watcom C/C++ and Borland C/C++ the compiler option that makes
   186    enums having the size of an int must be enabled.
   187    This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
   188 */
   189 
   190 /** \cond */
   191 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
   192 #if !defined(__ANDROID__)
   193    /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */
   194 typedef enum
   195 {
   196     DUMMY_ENUM_VALUE
   197 } SDL_DUMMY_ENUM;
   198 
   199 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
   200 #endif
   201 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
   202 /** \endcond */
   203 
   204 #include "begin_code.h"
   205 /* Set up for C function definitions, even when using C++ */
   206 #ifdef __cplusplus
   207 extern "C" {
   208 #endif
   209 
   210 #if defined(HAVE_ALLOCA) && !defined(alloca)
   211 # if defined(HAVE_ALLOCA_H)
   212 #  include <alloca.h>
   213 # elif defined(__GNUC__)
   214 #  define alloca __builtin_alloca
   215 # elif defined(_MSC_VER)
   216 #  include <malloc.h>
   217 #  define alloca _alloca
   218 # elif defined(__WATCOMC__)
   219 #  include <malloc.h>
   220 # elif defined(__BORLANDC__)
   221 #  include <malloc.h>
   222 # elif defined(__DMC__)
   223 #  include <stdlib.h>
   224 # elif defined(__AIX__)
   225 #pragma alloca
   226 # elif defined(__MRC__)
   227 void *alloca(unsigned);
   228 # else
   229 char *alloca();
   230 # endif
   231 #endif
   232 #ifdef HAVE_ALLOCA
   233 #define SDL_stack_alloc(type, count)    (type*)alloca(sizeof(type)*(count))
   234 #define SDL_stack_free(data)
   235 #else
   236 #define SDL_stack_alloc(type, count)    (type*)SDL_malloc(sizeof(type)*(count))
   237 #define SDL_stack_free(data)            SDL_free(data)
   238 #endif
   239 
   240 extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
   241 extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
   242 extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
   243 extern DECLSPEC void SDLCALL SDL_free(void *mem);
   244 
   245 extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
   246 extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value, int overwrite);
   247 
   248 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, int (*compare) (const void *, const void *));
   249 
   250 extern DECLSPEC int SDLCALL SDL_abs(int x);
   251 
   252 /* !!! FIXME: these have side effects. You probably shouldn't use them. */
   253 /* !!! FIXME: Maybe we do forceinline functions of SDL_mini, SDL_minf, etc? */
   254 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
   255 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
   256 
   257 extern DECLSPEC int SDLCALL SDL_isdigit(int x);
   258 extern DECLSPEC int SDLCALL SDL_isspace(int x);
   259 extern DECLSPEC int SDLCALL SDL_toupper(int x);
   260 extern DECLSPEC int SDLCALL SDL_tolower(int x);
   261 
   262 extern DECLSPEC void *SDLCALL SDL_memset(void *dst, int c, size_t len);
   263 
   264 #define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
   265 #define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
   266 
   267 /* Note that memset() is a byte assignment and this is a 32-bit assignment, so they're not directly equivalent. */
   268 SDL_FORCE_INLINE void SDL_memset4(void *dst, int val, size_t dwords)
   269 {
   270 #if defined(__GNUC__) && defined(i386)
   271     int u0, u1, u2;
   272     __asm__ __volatile__ (
   273         "cld \n\t"
   274         "rep ; stosl \n\t"
   275         : "=&D" (u0), "=&a" (u1), "=&c" (u2)
   276         : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, dwords))
   277         : "memory"
   278     );
   279 #else
   280     size_t _n = (dwords + 3) / 4;
   281     Uint32 *_p = SDL_static_cast(Uint32 *, dst);
   282     Uint32 _val = (val);
   283     if (dwords == 0)
   284         return;
   285     switch (dwords % 4)
   286     {
   287         case 0: do {    *_p++ = _val;
   288         case 3:         *_p++ = _val;
   289         case 2:         *_p++ = _val;
   290         case 1:         *_p++ = _val;
   291         } while ( --_n );
   292     }
   293 #endif
   294 }
   295 
   296 
   297 extern DECLSPEC void *SDLCALL SDL_memcpy(void *dst, const void *src, size_t len);
   298 
   299 SDL_FORCE_INLINE void *SDL_memcpy4(void *dst, const void *src, size_t dwords)
   300 {
   301     return SDL_memcpy(dst, src, dwords * 4);
   302 }
   303 
   304 extern DECLSPEC void *SDLCALL SDL_memmove(void *dst, const void *src, size_t len);
   305 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
   306 
   307 extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr);
   308 extern DECLSPEC size_t SDLCALL SDL_wcslcpy(wchar_t *dst, const wchar_t *src, size_t maxlen);
   309 extern DECLSPEC size_t SDLCALL SDL_wcslcat(wchar_t *dst, const wchar_t *src, size_t maxlen);
   310 
   311 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *str);
   312 extern DECLSPEC size_t SDLCALL SDL_strlcpy(char *dst, const char *src, size_t maxlen);
   313 extern DECLSPEC size_t SDLCALL SDL_utf8strlcpy(char *dst, const char *src, size_t dst_bytes);
   314 extern DECLSPEC size_t SDLCALL SDL_strlcat(char *dst, const char *src, size_t maxlen);
   315 extern DECLSPEC char *SDLCALL SDL_strdup(const char *str);
   316 extern DECLSPEC char *SDLCALL SDL_strrev(char *str);
   317 extern DECLSPEC char *SDLCALL SDL_strupr(char *str);
   318 extern DECLSPEC char *SDLCALL SDL_strlwr(char *str);
   319 extern DECLSPEC char *SDLCALL SDL_strchr(const char *str, int c);
   320 extern DECLSPEC char *SDLCALL SDL_strrchr(const char *str, int c);
   321 extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack, const char *needle);
   322 
   323 extern DECLSPEC char *SDLCALL SDL_itoa(int value, char *str, int radix);
   324 extern DECLSPEC char *SDLCALL SDL_uitoa(unsigned int value, char *str, int radix);
   325 extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *str, int radix);
   326 extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *str, int radix);
   327 extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *str, int radix);
   328 extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *str, int radix);
   329 
   330 extern DECLSPEC int SDLCALL SDL_atoi(const char *str);
   331 extern DECLSPEC double SDLCALL SDL_atof(const char *str);
   332 extern DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base);
   333 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base);
   334 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *str, char **endp, int base);
   335 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *str, char **endp, int base);
   336 extern DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp);
   337 
   338 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
   339 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
   340 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
   341 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t len);
   342 
   343 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, const char *fmt, ...);
   344 extern DECLSPEC int SDLCALL SDL_snprintf(char *text, size_t maxlen, const char *fmt, ...);
   345 extern DECLSPEC int SDLCALL SDL_vsnprintf(char *text, size_t maxlen, const char *fmt, va_list ap);
   346 
   347 #ifndef HAVE_M_PI
   348 #ifndef M_PI
   349 #define M_PI    3.14159265358979323846264338327950288   /* pi */
   350 #endif
   351 #endif
   352 
   353 extern DECLSPEC double SDLCALL SDL_atan(double x);
   354 extern DECLSPEC double SDLCALL SDL_atan2(double x, double y);
   355 extern DECLSPEC double SDLCALL SDL_ceil(double x);
   356 extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
   357 extern DECLSPEC double SDLCALL SDL_cos(double x);
   358 extern DECLSPEC float SDLCALL SDL_cosf(float x);
   359 extern DECLSPEC double SDLCALL SDL_fabs(double x);
   360 extern DECLSPEC double SDLCALL SDL_floor(double x);
   361 extern DECLSPEC double SDLCALL SDL_log(double x);
   362 extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
   363 extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
   364 extern DECLSPEC double SDLCALL SDL_sin(double x);
   365 extern DECLSPEC float SDLCALL SDL_sinf(float x);
   366 extern DECLSPEC double SDLCALL SDL_sqrt(double x);
   367 
   368 /* The SDL implementation of iconv() returns these error codes */
   369 #define SDL_ICONV_ERROR     (size_t)-1
   370 #define SDL_ICONV_E2BIG     (size_t)-2
   371 #define SDL_ICONV_EILSEQ    (size_t)-3
   372 #define SDL_ICONV_EINVAL    (size_t)-4
   373 
   374 /* SDL_iconv_* are now always real symbols/types, not macros or inlined. */
   375 typedef struct _SDL_iconv_t *SDL_iconv_t;
   376 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
   377                                                    const char *fromcode);
   378 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
   379 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
   380                                          size_t * inbytesleft, char **outbuf,
   381                                          size_t * outbytesleft);
   382 /**
   383  *  This function converts a string between encodings in one pass, returning a
   384  *  string that must be freed with SDL_free() or NULL on error.
   385  */
   386 extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
   387                                                const char *fromcode,
   388                                                const char *inbuf,
   389                                                size_t inbytesleft);
   390 #define SDL_iconv_utf8_locale(S)    SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
   391 #define SDL_iconv_utf8_ucs2(S)      (Uint16 *)SDL_iconv_string("UCS-2-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
   392 #define SDL_iconv_utf8_ucs4(S)      (Uint32 *)SDL_iconv_string("UCS-4-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
   393 
   394 /* Ends C function definitions when using C++ */
   395 #ifdef __cplusplus
   396 }
   397 #endif
   398 #include "close_code.h"
   399 
   400 #endif /* _SDL_stdinc_h */
   401 
   402 /* vi: set ts=4 sw=4 expandtab: */