include/SDL_stdinc.h
author Ozkan Sezer
Thu, 29 Oct 2020 20:00:20 +0300
changeset 14209 467540bb2114
parent 13940 92ea0212b095
child 14309 dbc6eb98c6ad
permissions -rw-r--r--
SDL_stdinc.h: define _DARWIN_C_SOURCE on macOS for memset_pattern4()

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