include/SDL_stdinc.h
author Sam Lantinga <slouken@libsdl.org>
Wed, 12 Jun 2019 10:38:49 -0700
changeset 12848 a9a7c1e48f0b
parent 12503 806492103856
child 12966 0262d439e9c6
permissions -rw-r--r--
Better patch to make it more clear what's going on
slouken@4761
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@12503
     3
  Copyright (C) 1997-2019 Sam Lantinga <slouken@libsdl.org>
slouken@4761
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@4761
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@4761
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@4761
    20
*/
slouken@4761
    21
slouken@4761
    22
/**
slouken@4761
    23
 *  \file SDL_stdinc.h
slouken@7191
    24
 *
slouken@4761
    25
 *  This is a general header that includes C language support.
slouken@4761
    26
 */
slouken@4761
    27
slouken@10638
    28
#ifndef SDL_stdinc_h_
slouken@10638
    29
#define SDL_stdinc_h_
slouken@4761
    30
slouken@4761
    31
#include "SDL_config.h"
slouken@4761
    32
slouken@4761
    33
#ifdef HAVE_SYS_TYPES_H
slouken@4761
    34
#include <sys/types.h>
slouken@4761
    35
#endif
slouken@4761
    36
#ifdef HAVE_STDIO_H
slouken@4761
    37
#include <stdio.h>
slouken@4761
    38
#endif
slouken@4761
    39
#if defined(STDC_HEADERS)
slouken@4761
    40
# include <stdlib.h>
slouken@4761
    41
# include <stddef.h>
slouken@4761
    42
# include <stdarg.h>
slouken@4761
    43
#else
slouken@4761
    44
# if defined(HAVE_STDLIB_H)
slouken@4761
    45
#  include <stdlib.h>
slouken@4761
    46
# elif defined(HAVE_MALLOC_H)
slouken@4761
    47
#  include <malloc.h>
slouken@4761
    48
# endif
slouken@4761
    49
# if defined(HAVE_STDDEF_H)
slouken@4761
    50
#  include <stddef.h>
slouken@4761
    51
# endif
slouken@4761
    52
# if defined(HAVE_STDARG_H)
slouken@4761
    53
#  include <stdarg.h>
slouken@4761
    54
# endif
slouken@4761
    55
#endif
slouken@4761
    56
#ifdef HAVE_STRING_H
slouken@4761
    57
# if !defined(STDC_HEADERS) && defined(HAVE_MEMORY_H)
slouken@4761
    58
#  include <memory.h>
slouken@4761
    59
# endif
slouken@4761
    60
# include <string.h>
slouken@4761
    61
#endif
slouken@4761
    62
#ifdef HAVE_STRINGS_H
slouken@4761
    63
# include <strings.h>
slouken@4761
    64
#endif
slouken@11280
    65
#ifdef HAVE_WCHAR_H
slouken@11280
    66
# include <wchar.h>
slouken@11280
    67
#endif
slouken@4761
    68
#if defined(HAVE_INTTYPES_H)
slouken@4761
    69
# include <inttypes.h>
slouken@4761
    70
#elif defined(HAVE_STDINT_H)
slouken@4761
    71
# include <stdint.h>
slouken@4761
    72
#endif
slouken@4761
    73
#ifdef HAVE_CTYPE_H
slouken@4761
    74
# include <ctype.h>
slouken@4761
    75
#endif
slouken@4761
    76
#ifdef HAVE_MATH_H
dludwig@8316
    77
# if defined(__WINRT__)
dludwig@8316
    78
/* Defining _USE_MATH_DEFINES is required to get M_PI to be defined on
dludwig@8500
    79
   WinRT.  See http://msdn.microsoft.com/en-us/library/4hwaceh6.aspx
dludwig@8316
    80
   for more information.
dludwig@8316
    81
*/
dludwig@8316
    82
#  define _USE_MATH_DEFINES
dludwig@8316
    83
# endif
slouken@4761
    84
# include <math.h>
slouken@4761
    85
#endif
dludwig@8478
    86
#ifdef HAVE_FLOAT_H
dludwig@8478
    87
# include <float.h>
dludwig@8478
    88
#endif
sezeroz@11961
    89
#if defined(HAVE_ALLOCA) && !defined(alloca)
sezeroz@11961
    90
# if defined(HAVE_ALLOCA_H)
sezeroz@11961
    91
#  include <alloca.h>
sezeroz@11961
    92
# elif defined(__GNUC__)
sezeroz@11961
    93
#  define alloca __builtin_alloca
sezeroz@11961
    94
# elif defined(_MSC_VER)
sezeroz@11961
    95
#  include <malloc.h>
sezeroz@11961
    96
#  define alloca _alloca
sezeroz@11961
    97
# elif defined(__WATCOMC__)
sezeroz@11961
    98
#  include <malloc.h>
sezeroz@11961
    99
# elif defined(__BORLANDC__)
sezeroz@11961
   100
#  include <malloc.h>
sezeroz@11961
   101
# elif defined(__DMC__)
sezeroz@11961
   102
#  include <stdlib.h>
sezeroz@11961
   103
# elif defined(__AIX__)
sezeroz@11961
   104
#pragma alloca
sezeroz@11961
   105
# elif defined(__MRC__)
sezeroz@11961
   106
void *alloca(unsigned);
sezeroz@11961
   107
# else
sezeroz@11961
   108
char *alloca();
sezeroz@11961
   109
# endif
sezeroz@11961
   110
#endif
slouken@4761
   111
slouken@4761
   112
/**
slouken@4761
   113
 *  The number of elements in an array.
slouken@4761
   114
 */
slouken@7191
   115
#define SDL_arraysize(array)    (sizeof(array)/sizeof(array[0]))
slouken@7191
   116
#define SDL_TABLESIZE(table)    SDL_arraysize(table)
slouken@4761
   117
slouken@4761
   118
/**
slouken@10393
   119
 *  Macro useful for building other macros with strings in them
slouken@10393
   120
 *
slouken@10393
   121
 *  e.g. #define LOG_ERROR(X) OutputDebugString(SDL_STRINGIFY_ARG(__FUNCTION__) ": " X "\n")
slouken@10393
   122
 */
slouken@10393
   123
#define SDL_STRINGIFY_ARG(arg)  #arg
slouken@10393
   124
slouken@10393
   125
/**
slouken@4761
   126
 *  \name Cast operators
slouken@7191
   127
 *
slouken@4761
   128
 *  Use proper C++ casts when compiled as C++ to be compatible with the option
slouken@4761
   129
 *  -Wold-style-cast of GCC (and -Werror=old-style-cast in GCC 4.2 and above).
slouken@4761
   130
 */
gabomdq@7678
   131
/* @{ */
slouken@4761
   132
#ifdef __cplusplus
slouken@4761
   133
#define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression)
slouken@4761
   134
#define SDL_static_cast(type, expression) static_cast<type>(expression)
icculus@7076
   135
#define SDL_const_cast(type, expression) const_cast<type>(expression)
slouken@4761
   136
#else
slouken@4761
   137
#define SDL_reinterpret_cast(type, expression) ((type)(expression))
slouken@4761
   138
#define SDL_static_cast(type, expression) ((type)(expression))
icculus@7076
   139
#define SDL_const_cast(type, expression) ((type)(expression))
slouken@4761
   140
#endif
gabomdq@7678
   141
/* @} *//* Cast operators */
slouken@4761
   142
slouken@4761
   143
/* Define a four character code as a Uint32 */
slouken@4761
   144
#define SDL_FOURCC(A, B, C, D) \
slouken@4761
   145
    ((SDL_static_cast(Uint32, SDL_static_cast(Uint8, (A))) << 0) | \
slouken@4761
   146
     (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (B))) << 8) | \
slouken@4761
   147
     (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (C))) << 16) | \
slouken@4761
   148
     (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (D))) << 24))
slouken@4761
   149
slouken@4761
   150
/**
slouken@4761
   151
 *  \name Basic data types
slouken@4761
   152
 */
gabomdq@7678
   153
/* @{ */
slouken@4761
   154
icculus@10926
   155
#ifdef __CC_ARM
icculus@10926
   156
/* ARM's compiler throws warnings if we use an enum: like "SDL_bool x = a < b;" */
icculus@10926
   157
#define SDL_FALSE 0
icculus@10926
   158
#define SDL_TRUE 1
icculus@10926
   159
typedef int SDL_bool;
icculus@10926
   160
#else
slouken@4761
   161
typedef enum
slouken@4761
   162
{
slouken@4761
   163
    SDL_FALSE = 0,
slouken@4761
   164
    SDL_TRUE = 1
slouken@4761
   165
} SDL_bool;
icculus@10926
   166
#endif
slouken@4761
   167
slouken@4761
   168
/**
slouken@4761
   169
 * \brief A signed 8-bit integer type.
slouken@4761
   170
 */
slouken@11627
   171
#define SDL_MAX_SINT8   ((Sint8)0x7F)           /* 127 */
slouken@11627
   172
#define SDL_MIN_SINT8   ((Sint8)(~0x7F))        /* -128 */
slouken@4761
   173
typedef int8_t Sint8;
slouken@4761
   174
/**
slouken@4761
   175
 * \brief An unsigned 8-bit integer type.
slouken@4761
   176
 */
slouken@11627
   177
#define SDL_MAX_UINT8   ((Uint8)0xFF)           /* 255 */
slouken@11627
   178
#define SDL_MIN_UINT8   ((Uint8)0x00)           /* 0 */
slouken@4761
   179
typedef uint8_t Uint8;
slouken@4761
   180
/**
slouken@4761
   181
 * \brief A signed 16-bit integer type.
slouken@4761
   182
 */
slouken@11627
   183
#define SDL_MAX_SINT16  ((Sint16)0x7FFF)        /* 32767 */
slouken@11627
   184
#define SDL_MIN_SINT16  ((Sint16)(~0x7FFF))     /* -32768 */
slouken@4761
   185
typedef int16_t Sint16;
slouken@4761
   186
/**
slouken@4761
   187
 * \brief An unsigned 16-bit integer type.
slouken@4761
   188
 */
slouken@11627
   189
#define SDL_MAX_UINT16  ((Uint16)0xFFFF)        /* 65535 */
slouken@11627
   190
#define SDL_MIN_UINT16  ((Uint16)0x0000)        /* 0 */
slouken@4761
   191
typedef uint16_t Uint16;
slouken@4761
   192
/**
slouken@4761
   193
 * \brief A signed 32-bit integer type.
slouken@4761
   194
 */
slouken@11627
   195
#define SDL_MAX_SINT32  ((Sint32)0x7FFFFFFF)    /* 2147483647 */
slouken@11627
   196
#define SDL_MIN_SINT32  ((Sint32)(~0x7FFFFFFF)) /* -2147483648 */
slouken@4761
   197
typedef int32_t Sint32;
slouken@4761
   198
/**
slouken@4761
   199
 * \brief An unsigned 32-bit integer type.
slouken@4761
   200
 */
slouken@11627
   201
#define SDL_MAX_UINT32  ((Uint32)0xFFFFFFFFu)   /* 4294967295 */
slouken@11627
   202
#define SDL_MIN_UINT32  ((Uint32)0x00000000)    /* 0 */
slouken@4761
   203
typedef uint32_t Uint32;
slouken@4761
   204
slouken@4761
   205
/**
slouken@4761
   206
 * \brief A signed 64-bit integer type.
slouken@4761
   207
 */
slouken@11627
   208
#define SDL_MAX_SINT64  ((Sint64)0x7FFFFFFFFFFFFFFFll)      /* 9223372036854775807 */
slouken@11627
   209
#define SDL_MIN_SINT64  ((Sint64)(~0x7FFFFFFFFFFFFFFFll))   /* -9223372036854775808 */
slouken@4761
   210
typedef int64_t Sint64;
slouken@4761
   211
/**
slouken@4761
   212
 * \brief An unsigned 64-bit integer type.
slouken@4761
   213
 */
slouken@11627
   214
#define SDL_MAX_UINT64  ((Uint64)0xFFFFFFFFFFFFFFFFull)     /* 18446744073709551615 */
slouken@11627
   215
#define SDL_MIN_UINT64  ((Uint64)(0x0000000000000000ull))   /* 0 */
slouken@4761
   216
typedef uint64_t Uint64;
slouken@4761
   217
gabomdq@7678
   218
/* @} *//* Basic data types */
slouken@4761
   219
slouken@8883
   220
/* Make sure we have macros for printing 64 bit values.
slouken@8883
   221
 * <stdint.h> should define these but this is not true all platforms.
slouken@8883
   222
 * (for example win32) */
slouken@8917
   223
#ifndef SDL_PRIs64
slouken@8917
   224
#ifdef PRIs64
slouken@8917
   225
#define SDL_PRIs64 PRIs64
slouken@8917
   226
#elif defined(__WIN32__)
urkle@9261
   227
#define SDL_PRIs64 "I64d"
icculus@9376
   228
#elif defined(__LINUX__) && defined(__LP64__)
icculus@9376
   229
#define SDL_PRIs64 "ld"
slouken@8883
   230
#else
slouken@8917
   231
#define SDL_PRIs64 "lld"
slouken@8883
   232
#endif
slouken@8883
   233
#endif
slouken@8917
   234
#ifndef SDL_PRIu64
slouken@8917
   235
#ifdef PRIu64
slouken@8917
   236
#define SDL_PRIu64 PRIu64
slouken@8917
   237
#elif defined(__WIN32__)
slouken@8917
   238
#define SDL_PRIu64 "I64u"
icculus@9376
   239
#elif defined(__LINUX__) && defined(__LP64__)
icculus@9376
   240
#define SDL_PRIu64 "lu"
slouken@8883
   241
#else
slouken@8917
   242
#define SDL_PRIu64 "llu"
slouken@8883
   243
#endif
slouken@8883
   244
#endif
urkle@9260
   245
#ifndef SDL_PRIx64
urkle@9260
   246
#ifdef PRIx64
urkle@9260
   247
#define SDL_PRIx64 PRIx64
urkle@9260
   248
#elif defined(__WIN32__)
urkle@9260
   249
#define SDL_PRIx64 "I64x"
icculus@9376
   250
#elif defined(__LINUX__) && defined(__LP64__)
icculus@9376
   251
#define SDL_PRIx64 "lx"
urkle@9260
   252
#else
urkle@9260
   253
#define SDL_PRIx64 "llx"
urkle@9260
   254
#endif
urkle@9260
   255
#endif
urkle@9260
   256
#ifndef SDL_PRIX64
urkle@9260
   257
#ifdef PRIX64
urkle@9260
   258
#define SDL_PRIX64 PRIX64
urkle@9260
   259
#elif defined(__WIN32__)
urkle@9260
   260
#define SDL_PRIX64 "I64X"
icculus@9376
   261
#elif defined(__LINUX__) && defined(__LP64__)
icculus@9376
   262
#define SDL_PRIX64 "lX"
urkle@9260
   263
#else
urkle@9260
   264
#define SDL_PRIX64 "llX"
urkle@9260
   265
#endif
urkle@9260
   266
#endif
slouken@4761
   267
slouken@8820
   268
/* Annotations to help code analysis tools */
slouken@8820
   269
#ifdef SDL_DISABLE_ANALYZE_MACROS
slouken@8820
   270
#define SDL_IN_BYTECAP(x)
slouken@8820
   271
#define SDL_INOUT_Z_CAP(x)
slouken@8820
   272
#define SDL_OUT_Z_CAP(x)
slouken@8820
   273
#define SDL_OUT_CAP(x)
slouken@8820
   274
#define SDL_OUT_BYTECAP(x)
slouken@8820
   275
#define SDL_OUT_Z_BYTECAP(x)
slouken@8820
   276
#define SDL_PRINTF_FORMAT_STRING
slouken@8820
   277
#define SDL_SCANF_FORMAT_STRING
slouken@8820
   278
#define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
slouken@8820
   279
#define SDL_SCANF_VARARG_FUNC( fmtargnumber )
slouken@8820
   280
#else
icculus@9473
   281
#if defined(_MSC_VER) && (_MSC_VER >= 1600) /* VS 2010 and above */
slouken@8820
   282
#include <sal.h>
slouken@8820
   283
slouken@8820
   284
#define SDL_IN_BYTECAP(x) _In_bytecount_(x)
slouken@8820
   285
#define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x)
slouken@8820
   286
#define SDL_OUT_Z_CAP(x) _Out_z_cap_(x)
slouken@8820
   287
#define SDL_OUT_CAP(x) _Out_cap_(x)
slouken@8820
   288
#define SDL_OUT_BYTECAP(x) _Out_bytecap_(x)
slouken@8820
   289
#define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x)
slouken@8820
   290
slouken@8820
   291
#define SDL_PRINTF_FORMAT_STRING _Printf_format_string_
slouken@8820
   292
#define SDL_SCANF_FORMAT_STRING _Scanf_format_string_impl_
slouken@8820
   293
#else
slouken@8820
   294
#define SDL_IN_BYTECAP(x)
slouken@8820
   295
#define SDL_INOUT_Z_CAP(x)
slouken@8820
   296
#define SDL_OUT_Z_CAP(x)
slouken@8820
   297
#define SDL_OUT_CAP(x)
slouken@8820
   298
#define SDL_OUT_BYTECAP(x)
slouken@8820
   299
#define SDL_OUT_Z_BYTECAP(x)
slouken@8820
   300
#define SDL_PRINTF_FORMAT_STRING
slouken@8820
   301
#define SDL_SCANF_FORMAT_STRING
slouken@8820
   302
#endif
slouken@8820
   303
#if defined(__GNUC__)
slouken@8820
   304
#define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __printf__, fmtargnumber, fmtargnumber+1 )))
slouken@8820
   305
#define SDL_SCANF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __scanf__, fmtargnumber, fmtargnumber+1 )))
slouken@8820
   306
#else
slouken@8820
   307
#define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
slouken@8820
   308
#define SDL_SCANF_VARARG_FUNC( fmtargnumber )
slouken@8820
   309
#endif
philipp@8844
   310
#endif /* SDL_DISABLE_ANALYZE_MACROS */
slouken@8820
   311
slouken@4761
   312
#define SDL_COMPILE_TIME_ASSERT(name, x)               \
icculus@11087
   313
       typedef int SDL_compile_time_assert_ ## name[(x) * 2 - 1]
slouken@4761
   314
/** \cond */
slouken@4761
   315
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
slouken@4761
   316
SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
slouken@4761
   317
SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
slouken@4761
   318
SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
slouken@4761
   319
SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
slouken@4761
   320
SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
slouken@4761
   321
SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
slouken@4761
   322
SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
slouken@4761
   323
SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
slouken@4761
   324
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
slouken@4761
   325
/** \endcond */
slouken@4761
   326
slouken@4761
   327
/* Check to make sure enums are the size of ints, for structure packing.
slouken@4761
   328
   For both Watcom C/C++ and Borland C/C++ the compiler option that makes
slouken@4761
   329
   enums having the size of an int must be enabled.
slouken@4761
   330
   This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
slouken@4761
   331
*/
slouken@4761
   332
slouken@4761
   333
/** \cond */
slouken@4761
   334
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
slouken@7191
   335
#if !defined(__ANDROID__)
paul@4697
   336
   /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */
slouken@4761
   337
typedef enum
slouken@4761
   338
{
slouken@4761
   339
    DUMMY_ENUM_VALUE
slouken@4761
   340
} SDL_DUMMY_ENUM;
slouken@4761
   341
slouken@4761
   342
SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
slouken@4761
   343
#endif
slouken@4761
   344
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
slouken@4761
   345
/** \endcond */
slouken@4761
   346
slouken@4761
   347
#include "begin_code.h"
slouken@4761
   348
/* Set up for C function definitions, even when using C++ */
slouken@4761
   349
#ifdef __cplusplus
slouken@4761
   350
extern "C" {
slouken@4761
   351
#endif
slouken@4761
   352
slouken@4761
   353
#ifdef HAVE_ALLOCA
slouken@4761
   354
#define SDL_stack_alloc(type, count)    (type*)alloca(sizeof(type)*(count))
slouken@4761
   355
#define SDL_stack_free(data)
slouken@4761
   356
#else
slouken@4761
   357
#define SDL_stack_alloc(type, count)    (type*)SDL_malloc(sizeof(type)*(count))
slouken@4761
   358
#define SDL_stack_free(data)            SDL_free(data)
slouken@4761
   359
#endif
slouken@4761
   360
icculus@7003
   361
extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
icculus@7003
   362
extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
icculus@7003
   363
extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
icculus@7003
   364
extern DECLSPEC void SDLCALL SDL_free(void *mem);
slouken@4761
   365
slouken@11610
   366
typedef void *(SDLCALL *SDL_malloc_func)(size_t size);
slouken@11610
   367
typedef void *(SDLCALL *SDL_calloc_func)(size_t nmemb, size_t size);
slouken@11610
   368
typedef void *(SDLCALL *SDL_realloc_func)(void *mem, size_t size);
slouken@11610
   369
typedef void (SDLCALL *SDL_free_func)(void *mem);
slouken@11610
   370
slouken@11610
   371
/**
slouken@11610
   372
 *  \brief Get the current set of SDL memory functions
slouken@11610
   373
 */
slouken@11610
   374
extern DECLSPEC void SDLCALL SDL_GetMemoryFunctions(SDL_malloc_func *malloc_func,
slouken@11610
   375
                                                    SDL_calloc_func *calloc_func,
slouken@11610
   376
                                                    SDL_realloc_func *realloc_func,
slouken@11610
   377
                                                    SDL_free_func *free_func);
slouken@11610
   378
slouken@11610
   379
/**
slouken@11610
   380
 *  \brief Replace SDL's memory allocation functions with a custom set
slouken@11610
   381
 *
slouken@11610
   382
 *  \note If you are replacing SDL's memory functions, you should call
slouken@11610
   383
 *        SDL_GetNumAllocations() and be very careful if it returns non-zero.
slouken@11610
   384
 *        That means that your free function will be called with memory
slouken@11610
   385
 *        allocated by the previous memory allocation functions.
slouken@11610
   386
 */
slouken@11610
   387
extern DECLSPEC int SDLCALL SDL_SetMemoryFunctions(SDL_malloc_func malloc_func,
slouken@11610
   388
                                                   SDL_calloc_func calloc_func,
slouken@11610
   389
                                                   SDL_realloc_func realloc_func,
slouken@11610
   390
                                                   SDL_free_func free_func);
slouken@11610
   391
slouken@11610
   392
/**
slouken@11610
   393
 *  \brief Get the number of outstanding (unfreed) allocations
slouken@11610
   394
 */
slouken@11618
   395
extern DECLSPEC int SDLCALL SDL_GetNumAllocations(void);
slouken@11610
   396
icculus@7003
   397
extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
icculus@7003
   398
extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value, int overwrite);
slouken@4761
   399
icculus@7003
   400
extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, int (*compare) (const void *, const void *));
slouken@4761
   401
icculus@7003
   402
extern DECLSPEC int SDLCALL SDL_abs(int x);
icculus@7003
   403
icculus@7003
   404
/* !!! FIXME: these have side effects. You probably shouldn't use them. */
icculus@7003
   405
/* !!! FIXME: Maybe we do forceinline functions of SDL_mini, SDL_minf, etc? */
icculus@7003
   406
#define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
icculus@7003
   407
#define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
icculus@7003
   408
icculus@7003
   409
extern DECLSPEC int SDLCALL SDL_isdigit(int x);
icculus@7003
   410
extern DECLSPEC int SDLCALL SDL_isspace(int x);
icculus@7003
   411
extern DECLSPEC int SDLCALL SDL_toupper(int x);
icculus@7003
   412
extern DECLSPEC int SDLCALL SDL_tolower(int x);
icculus@7003
   413
slouken@8820
   414
extern DECLSPEC void *SDLCALL SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len);
slouken@4761
   415
icculus@7003
   416
#define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
icculus@7003
   417
#define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
icculus@7003
   418
slouken@7386
   419
/* Note that memset() is a byte assignment and this is a 32-bit assignment, so they're not directly equivalent. */
slouken@7901
   420
SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
icculus@7003
   421
{
slouken@7385
   422
#if defined(__GNUC__) && defined(i386)
slouken@7385
   423
    int u0, u1, u2;
slouken@7385
   424
    __asm__ __volatile__ (
slouken@7385
   425
        "cld \n\t"
slouken@7385
   426
        "rep ; stosl \n\t"
slouken@7385
   427
        : "=&D" (u0), "=&a" (u1), "=&c" (u2)
slouken@7385
   428
        : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, dwords))
slouken@7385
   429
        : "memory"
slouken@7385
   430
    );
slouken@7385
   431
#else
slouken@7385
   432
    size_t _n = (dwords + 3) / 4;
slouken@7385
   433
    Uint32 *_p = SDL_static_cast(Uint32 *, dst);
slouken@7385
   434
    Uint32 _val = (val);
slouken@7385
   435
    if (dwords == 0)
slouken@7385
   436
        return;
slouken@7385
   437
    switch (dwords % 4)
slouken@7385
   438
    {
slouken@11459
   439
        case 0: do {    *_p++ = _val;   /* fallthrough */
slouken@11459
   440
        case 3:         *_p++ = _val;   /* fallthrough */
slouken@11459
   441
        case 2:         *_p++ = _val;   /* fallthrough */
slouken@11459
   442
        case 1:         *_p++ = _val;   /* fallthrough */
slouken@7385
   443
        } while ( --_n );
slouken@7385
   444
    }
slouken@7385
   445
#endif
icculus@7003
   446
}
icculus@7003
   447
slouken@8820
   448
extern DECLSPEC void *SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
icculus@7003
   449
slouken@8820
   450
extern DECLSPEC void *SDLCALL SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
slouken@7351
   451
extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
slouken@4761
   452
slouken@12088
   453
extern DECLSPEC wchar_t *SDLCALL SDL_wcsdup(const wchar_t *wstr);
slouken@7351
   454
extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr);
slouken@8820
   455
extern DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
slouken@8820
   456
extern DECLSPEC size_t SDLCALL SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
slouken@11265
   457
extern DECLSPEC int SDLCALL SDL_wcscmp(const wchar_t *str1, const wchar_t *str2);
slouken@4761
   458
icculus@7003
   459
extern DECLSPEC size_t SDLCALL SDL_strlen(const char *str);
slouken@8820
   460
extern DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
slouken@8820
   461
extern DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes);
slouken@8820
   462
extern DECLSPEC size_t SDLCALL SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
icculus@7003
   463
extern DECLSPEC char *SDLCALL SDL_strdup(const char *str);
icculus@7003
   464
extern DECLSPEC char *SDLCALL SDL_strrev(char *str);
icculus@7003
   465
extern DECLSPEC char *SDLCALL SDL_strupr(char *str);
icculus@7003
   466
extern DECLSPEC char *SDLCALL SDL_strlwr(char *str);
icculus@7003
   467
extern DECLSPEC char *SDLCALL SDL_strchr(const char *str, int c);
icculus@7003
   468
extern DECLSPEC char *SDLCALL SDL_strrchr(const char *str, int c);
icculus@7003
   469
extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack, const char *needle);
icculus@11049
   470
extern DECLSPEC size_t SDLCALL SDL_utf8strlen(const char *str);
slouken@4761
   471
icculus@7003
   472
extern DECLSPEC char *SDLCALL SDL_itoa(int value, char *str, int radix);
slouken@7351
   473
extern DECLSPEC char *SDLCALL SDL_uitoa(unsigned int value, char *str, int radix);
slouken@7351
   474
extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *str, int radix);
icculus@7003
   475
extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *str, int radix);
icculus@7003
   476
extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *str, int radix);
icculus@7003
   477
extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *str, int radix);
slouken@4761
   478
icculus@7003
   479
extern DECLSPEC int SDLCALL SDL_atoi(const char *str);
icculus@7003
   480
extern DECLSPEC double SDLCALL SDL_atof(const char *str);
slouken@7351
   481
extern DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base);
slouken@7351
   482
extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base);
slouken@7351
   483
extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *str, char **endp, int base);
slouken@7351
   484
extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *str, char **endp, int base);
slouken@7351
   485
extern DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp);
icculus@7003
   486
icculus@7003
   487
extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
slouken@7351
   488
extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
slouken@7351
   489
extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
slouken@7351
   490
extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t len);
slouken@4761
   491
slouken@8820
   492
extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, ...) SDL_SCANF_VARARG_FUNC(2);
icculus@8089
   493
extern DECLSPEC int SDLCALL SDL_vsscanf(const char *text, const char *fmt, va_list ap);
slouken@8820
   494
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);
slouken@8820
   495
extern DECLSPEC int SDLCALL SDL_vsnprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, va_list ap);
slouken@4761
   496
slouken@4761
   497
#ifndef HAVE_M_PI
slouken@6627
   498
#ifndef M_PI
philipp@11065
   499
#define M_PI    3.14159265358979323846264338327950288   /**< pi */
slouken@4761
   500
#endif
slouken@6627
   501
#endif
slouken@4761
   502
slouken@8004
   503
extern DECLSPEC double SDLCALL SDL_acos(double x);
slouken@11682
   504
extern DECLSPEC float SDLCALL SDL_acosf(float x);
slouken@8004
   505
extern DECLSPEC double SDLCALL SDL_asin(double x);
slouken@11682
   506
extern DECLSPEC float SDLCALL SDL_asinf(float x);
icculus@7003
   507
extern DECLSPEC double SDLCALL SDL_atan(double x);
slouken@11682
   508
extern DECLSPEC float SDLCALL SDL_atanf(float x);
icculus@7003
   509
extern DECLSPEC double SDLCALL SDL_atan2(double x, double y);
slouken@11682
   510
extern DECLSPEC float SDLCALL SDL_atan2f(float x, float y);
icculus@7003
   511
extern DECLSPEC double SDLCALL SDL_ceil(double x);
slouken@11682
   512
extern DECLSPEC float SDLCALL SDL_ceilf(float x);
icculus@7003
   513
extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
slouken@11682
   514
extern DECLSPEC float SDLCALL SDL_copysignf(float x, float y);
icculus@7003
   515
extern DECLSPEC double SDLCALL SDL_cos(double x);
icculus@7003
   516
extern DECLSPEC float SDLCALL SDL_cosf(float x);
flibitijibibo@12072
   517
extern DECLSPEC double SDLCALL SDL_exp(double x);
flibitijibibo@12072
   518
extern DECLSPEC float SDLCALL SDL_expf(float x);
icculus@7003
   519
extern DECLSPEC double SDLCALL SDL_fabs(double x);
slouken@11682
   520
extern DECLSPEC float SDLCALL SDL_fabsf(float x);
icculus@7003
   521
extern DECLSPEC double SDLCALL SDL_floor(double x);
slouken@11682
   522
extern DECLSPEC float SDLCALL SDL_floorf(float x);
slouken@11684
   523
extern DECLSPEC double SDLCALL SDL_fmod(double x, double y);
slouken@11684
   524
extern DECLSPEC float SDLCALL SDL_fmodf(float x, float y);
icculus@7003
   525
extern DECLSPEC double SDLCALL SDL_log(double x);
slouken@11682
   526
extern DECLSPEC float SDLCALL SDL_logf(float x);
sezero@11856
   527
extern DECLSPEC double SDLCALL SDL_log10(double x);
sezero@11856
   528
extern DECLSPEC float SDLCALL SDL_log10f(float x);
icculus@7003
   529
extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
slouken@11682
   530
extern DECLSPEC float SDLCALL SDL_powf(float x, float y);
icculus@7003
   531
extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
slouken@11682
   532
extern DECLSPEC float SDLCALL SDL_scalbnf(float x, int n);
icculus@7003
   533
extern DECLSPEC double SDLCALL SDL_sin(double x);
icculus@7003
   534
extern DECLSPEC float SDLCALL SDL_sinf(float x);
icculus@7003
   535
extern DECLSPEC double SDLCALL SDL_sqrt(double x);
slouken@8840
   536
extern DECLSPEC float SDLCALL SDL_sqrtf(float x);
slouken@8840
   537
extern DECLSPEC double SDLCALL SDL_tan(double x);
slouken@8840
   538
extern DECLSPEC float SDLCALL SDL_tanf(float x);
slouken@4761
   539
slouken@4761
   540
/* The SDL implementation of iconv() returns these error codes */
slouken@7191
   541
#define SDL_ICONV_ERROR     (size_t)-1
slouken@7191
   542
#define SDL_ICONV_E2BIG     (size_t)-2
slouken@7191
   543
#define SDL_ICONV_EILSEQ    (size_t)-3
slouken@7191
   544
#define SDL_ICONV_EINVAL    (size_t)-4
slouken@4761
   545
icculus@7003
   546
/* SDL_iconv_* are now always real symbols/types, not macros or inlined. */
slouken@4761
   547
typedef struct _SDL_iconv_t *SDL_iconv_t;
slouken@4761
   548
extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
slouken@4761
   549
                                                   const char *fromcode);
slouken@4761
   550
extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
slouken@4761
   551
extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
slouken@4761
   552
                                         size_t * inbytesleft, char **outbuf,
slouken@4761
   553
                                         size_t * outbytesleft);
slouken@4761
   554
/**
slouken@4761
   555
 *  This function converts a string between encodings in one pass, returning a
slouken@4761
   556
 *  string that must be freed with SDL_free() or NULL on error.
slouken@4761
   557
 */
slouken@4761
   558
extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
slouken@4761
   559
                                               const char *fromcode,
slouken@4761
   560
                                               const char *inbuf,
slouken@4761
   561
                                               size_t inbytesleft);
slouken@7191
   562
#define SDL_iconv_utf8_locale(S)    SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
slouken@7191
   563
#define SDL_iconv_utf8_ucs2(S)      (Uint16 *)SDL_iconv_string("UCS-2-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
slouken@7191
   564
#define SDL_iconv_utf8_ucs4(S)      (Uint32 *)SDL_iconv_string("UCS-4-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
slouken@4761
   565
icculus@9306
   566
/* force builds using Clang's static analysis tools to use literal C runtime
icculus@9306
   567
   here, since there are possibly tests that are ineffective otherwise. */
icculus@9306
   568
#if defined(__clang_analyzer__) && !defined(SDL_DISABLE_ANALYZE_MACROS)
icculus@9306
   569
#define SDL_malloc malloc
icculus@9306
   570
#define SDL_calloc calloc
icculus@9306
   571
#define SDL_realloc realloc
icculus@9306
   572
#define SDL_free free
icculus@9306
   573
#define SDL_memset memset
icculus@9306
   574
#define SDL_memcpy memcpy
icculus@9306
   575
#define SDL_memmove memmove
icculus@9306
   576
#define SDL_memcmp memcmp
icculus@9306
   577
#define SDL_strlen strlen
icculus@9306
   578
#define SDL_strlcpy strlcpy
icculus@9306
   579
#define SDL_strlcat strlcat
icculus@9306
   580
#define SDL_strdup strdup
icculus@9306
   581
#define SDL_strchr strchr
icculus@9306
   582
#define SDL_strrchr strrchr
icculus@9306
   583
#define SDL_strstr strstr
icculus@9306
   584
#define SDL_strcmp strcmp
icculus@9306
   585
#define SDL_strncmp strncmp
icculus@9306
   586
#define SDL_strcasecmp strcasecmp
icculus@9306
   587
#define SDL_strncasecmp strncasecmp
icculus@9306
   588
#define SDL_sscanf sscanf
icculus@9306
   589
#define SDL_vsscanf vsscanf
icculus@9306
   590
#define SDL_snprintf snprintf
icculus@9306
   591
#define SDL_vsnprintf vsnprintf
icculus@9306
   592
#endif
icculus@9306
   593
icculus@9306
   594
SDL_FORCE_INLINE void *SDL_memcpy4(SDL_OUT_BYTECAP(dwords*4) void *dst, SDL_IN_BYTECAP(dwords*4) const void *src, size_t dwords)
icculus@9306
   595
{
icculus@9306
   596
    return SDL_memcpy(dst, src, dwords * 4);
icculus@9306
   597
}
icculus@9306
   598
slouken@4761
   599
/* Ends C function definitions when using C++ */
slouken@4761
   600
#ifdef __cplusplus
slouken@4761
   601
}
slouken@4761
   602
#endif
slouken@4761
   603
#include "close_code.h"
slouken@4761
   604
slouken@10638
   605
#endif /* SDL_stdinc_h_ */
slouken@4761
   606
slouken@4761
   607
/* vi: set ts=4 sw=4 expandtab: */