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