include/SDL_stdinc.h
author Sam Lantinga <slouken@libsdl.org>
Thu, 12 Oct 2017 13:44:28 -0700
changeset 11610 6dea196ecbcb
parent 11459 a09ca9e8938c
child 11618 bbbc6db5a2b3
permissions -rw-r--r--
Added functions to query and set the SDL memory allocation functions:
SDL_GetMemoryFunctions()
SDL_SetMemoryFunctions()
SDL_GetNumAllocations()
slouken@4761
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@10737
     3
  Copyright (C) 1997-2017 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
slouken@4761
    89
slouken@4761
    90
/**
slouken@4761
    91
 *  The number of elements in an array.
slouken@4761
    92
 */
slouken@7191
    93
#define SDL_arraysize(array)    (sizeof(array)/sizeof(array[0]))
slouken@7191
    94
#define SDL_TABLESIZE(table)    SDL_arraysize(table)
slouken@4761
    95
slouken@4761
    96
/**
slouken@10393
    97
 *  Macro useful for building other macros with strings in them
slouken@10393
    98
 *
slouken@10393
    99
 *  e.g. #define LOG_ERROR(X) OutputDebugString(SDL_STRINGIFY_ARG(__FUNCTION__) ": " X "\n")
slouken@10393
   100
 */
slouken@10393
   101
#define SDL_STRINGIFY_ARG(arg)  #arg
slouken@10393
   102
slouken@10393
   103
/**
slouken@4761
   104
 *  \name Cast operators
slouken@7191
   105
 *
slouken@4761
   106
 *  Use proper C++ casts when compiled as C++ to be compatible with the option
slouken@4761
   107
 *  -Wold-style-cast of GCC (and -Werror=old-style-cast in GCC 4.2 and above).
slouken@4761
   108
 */
gabomdq@7678
   109
/* @{ */
slouken@4761
   110
#ifdef __cplusplus
slouken@4761
   111
#define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression)
slouken@4761
   112
#define SDL_static_cast(type, expression) static_cast<type>(expression)
icculus@7076
   113
#define SDL_const_cast(type, expression) const_cast<type>(expression)
slouken@4761
   114
#else
slouken@4761
   115
#define SDL_reinterpret_cast(type, expression) ((type)(expression))
slouken@4761
   116
#define SDL_static_cast(type, expression) ((type)(expression))
icculus@7076
   117
#define SDL_const_cast(type, expression) ((type)(expression))
slouken@4761
   118
#endif
gabomdq@7678
   119
/* @} *//* Cast operators */
slouken@4761
   120
slouken@4761
   121
/* Define a four character code as a Uint32 */
slouken@4761
   122
#define SDL_FOURCC(A, B, C, D) \
slouken@4761
   123
    ((SDL_static_cast(Uint32, SDL_static_cast(Uint8, (A))) << 0) | \
slouken@4761
   124
     (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (B))) << 8) | \
slouken@4761
   125
     (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (C))) << 16) | \
slouken@4761
   126
     (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (D))) << 24))
slouken@4761
   127
slouken@4761
   128
/**
slouken@4761
   129
 *  \name Basic data types
slouken@4761
   130
 */
gabomdq@7678
   131
/* @{ */
slouken@4761
   132
icculus@10926
   133
#ifdef __CC_ARM
icculus@10926
   134
/* ARM's compiler throws warnings if we use an enum: like "SDL_bool x = a < b;" */
icculus@10926
   135
#define SDL_FALSE 0
icculus@10926
   136
#define SDL_TRUE 1
icculus@10926
   137
typedef int SDL_bool;
icculus@10926
   138
#else
slouken@4761
   139
typedef enum
slouken@4761
   140
{
slouken@4761
   141
    SDL_FALSE = 0,
slouken@4761
   142
    SDL_TRUE = 1
slouken@4761
   143
} SDL_bool;
icculus@10926
   144
#endif
slouken@4761
   145
slouken@4761
   146
/**
slouken@4761
   147
 * \brief A signed 8-bit integer type.
slouken@4761
   148
 */
slouken@4761
   149
typedef int8_t Sint8;
slouken@4761
   150
/**
slouken@4761
   151
 * \brief An unsigned 8-bit integer type.
slouken@4761
   152
 */
slouken@4761
   153
typedef uint8_t Uint8;
slouken@4761
   154
/**
slouken@4761
   155
 * \brief A signed 16-bit integer type.
slouken@4761
   156
 */
slouken@4761
   157
typedef int16_t Sint16;
slouken@4761
   158
/**
slouken@4761
   159
 * \brief An unsigned 16-bit integer type.
slouken@4761
   160
 */
slouken@4761
   161
typedef uint16_t Uint16;
slouken@4761
   162
/**
slouken@4761
   163
 * \brief A signed 32-bit integer type.
slouken@4761
   164
 */
slouken@4761
   165
typedef int32_t Sint32;
slouken@4761
   166
/**
slouken@4761
   167
 * \brief An unsigned 32-bit integer type.
slouken@4761
   168
 */
slouken@4761
   169
typedef uint32_t Uint32;
slouken@4761
   170
slouken@4761
   171
/**
slouken@4761
   172
 * \brief A signed 64-bit integer type.
slouken@4761
   173
 */
slouken@4761
   174
typedef int64_t Sint64;
slouken@4761
   175
/**
slouken@4761
   176
 * \brief An unsigned 64-bit integer type.
slouken@4761
   177
 */
slouken@4761
   178
typedef uint64_t Uint64;
slouken@4761
   179
gabomdq@7678
   180
/* @} *//* Basic data types */
slouken@4761
   181
slouken@8883
   182
/* Make sure we have macros for printing 64 bit values.
slouken@8883
   183
 * <stdint.h> should define these but this is not true all platforms.
slouken@8883
   184
 * (for example win32) */
slouken@8917
   185
#ifndef SDL_PRIs64
slouken@8917
   186
#ifdef PRIs64
slouken@8917
   187
#define SDL_PRIs64 PRIs64
slouken@8917
   188
#elif defined(__WIN32__)
urkle@9261
   189
#define SDL_PRIs64 "I64d"
icculus@9376
   190
#elif defined(__LINUX__) && defined(__LP64__)
icculus@9376
   191
#define SDL_PRIs64 "ld"
slouken@8883
   192
#else
slouken@8917
   193
#define SDL_PRIs64 "lld"
slouken@8883
   194
#endif
slouken@8883
   195
#endif
slouken@8917
   196
#ifndef SDL_PRIu64
slouken@8917
   197
#ifdef PRIu64
slouken@8917
   198
#define SDL_PRIu64 PRIu64
slouken@8917
   199
#elif defined(__WIN32__)
slouken@8917
   200
#define SDL_PRIu64 "I64u"
icculus@9376
   201
#elif defined(__LINUX__) && defined(__LP64__)
icculus@9376
   202
#define SDL_PRIu64 "lu"
slouken@8883
   203
#else
slouken@8917
   204
#define SDL_PRIu64 "llu"
slouken@8883
   205
#endif
slouken@8883
   206
#endif
urkle@9260
   207
#ifndef SDL_PRIx64
urkle@9260
   208
#ifdef PRIx64
urkle@9260
   209
#define SDL_PRIx64 PRIx64
urkle@9260
   210
#elif defined(__WIN32__)
urkle@9260
   211
#define SDL_PRIx64 "I64x"
icculus@9376
   212
#elif defined(__LINUX__) && defined(__LP64__)
icculus@9376
   213
#define SDL_PRIx64 "lx"
urkle@9260
   214
#else
urkle@9260
   215
#define SDL_PRIx64 "llx"
urkle@9260
   216
#endif
urkle@9260
   217
#endif
urkle@9260
   218
#ifndef SDL_PRIX64
urkle@9260
   219
#ifdef PRIX64
urkle@9260
   220
#define SDL_PRIX64 PRIX64
urkle@9260
   221
#elif defined(__WIN32__)
urkle@9260
   222
#define SDL_PRIX64 "I64X"
icculus@9376
   223
#elif defined(__LINUX__) && defined(__LP64__)
icculus@9376
   224
#define SDL_PRIX64 "lX"
urkle@9260
   225
#else
urkle@9260
   226
#define SDL_PRIX64 "llX"
urkle@9260
   227
#endif
urkle@9260
   228
#endif
slouken@4761
   229
slouken@8820
   230
/* Annotations to help code analysis tools */
slouken@8820
   231
#ifdef SDL_DISABLE_ANALYZE_MACROS
slouken@8820
   232
#define SDL_IN_BYTECAP(x)
slouken@8820
   233
#define SDL_INOUT_Z_CAP(x)
slouken@8820
   234
#define SDL_OUT_Z_CAP(x)
slouken@8820
   235
#define SDL_OUT_CAP(x)
slouken@8820
   236
#define SDL_OUT_BYTECAP(x)
slouken@8820
   237
#define SDL_OUT_Z_BYTECAP(x)
slouken@8820
   238
#define SDL_PRINTF_FORMAT_STRING
slouken@8820
   239
#define SDL_SCANF_FORMAT_STRING
slouken@8820
   240
#define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
slouken@8820
   241
#define SDL_SCANF_VARARG_FUNC( fmtargnumber )
slouken@8820
   242
#else
icculus@9473
   243
#if defined(_MSC_VER) && (_MSC_VER >= 1600) /* VS 2010 and above */
slouken@8820
   244
#include <sal.h>
slouken@8820
   245
slouken@8820
   246
#define SDL_IN_BYTECAP(x) _In_bytecount_(x)
slouken@8820
   247
#define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x)
slouken@8820
   248
#define SDL_OUT_Z_CAP(x) _Out_z_cap_(x)
slouken@8820
   249
#define SDL_OUT_CAP(x) _Out_cap_(x)
slouken@8820
   250
#define SDL_OUT_BYTECAP(x) _Out_bytecap_(x)
slouken@8820
   251
#define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x)
slouken@8820
   252
slouken@8820
   253
#define SDL_PRINTF_FORMAT_STRING _Printf_format_string_
slouken@8820
   254
#define SDL_SCANF_FORMAT_STRING _Scanf_format_string_impl_
slouken@8820
   255
#else
slouken@8820
   256
#define SDL_IN_BYTECAP(x)
slouken@8820
   257
#define SDL_INOUT_Z_CAP(x)
slouken@8820
   258
#define SDL_OUT_Z_CAP(x)
slouken@8820
   259
#define SDL_OUT_CAP(x)
slouken@8820
   260
#define SDL_OUT_BYTECAP(x)
slouken@8820
   261
#define SDL_OUT_Z_BYTECAP(x)
slouken@8820
   262
#define SDL_PRINTF_FORMAT_STRING
slouken@8820
   263
#define SDL_SCANF_FORMAT_STRING
slouken@8820
   264
#endif
slouken@8820
   265
#if defined(__GNUC__)
slouken@8820
   266
#define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __printf__, fmtargnumber, fmtargnumber+1 )))
slouken@8820
   267
#define SDL_SCANF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __scanf__, fmtargnumber, fmtargnumber+1 )))
slouken@8820
   268
#else
slouken@8820
   269
#define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
slouken@8820
   270
#define SDL_SCANF_VARARG_FUNC( fmtargnumber )
slouken@8820
   271
#endif
philipp@8844
   272
#endif /* SDL_DISABLE_ANALYZE_MACROS */
slouken@8820
   273
slouken@4761
   274
#define SDL_COMPILE_TIME_ASSERT(name, x)               \
icculus@11087
   275
       typedef int SDL_compile_time_assert_ ## name[(x) * 2 - 1]
slouken@4761
   276
/** \cond */
slouken@4761
   277
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
slouken@4761
   278
SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
slouken@4761
   279
SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
slouken@4761
   280
SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
slouken@4761
   281
SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
slouken@4761
   282
SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
slouken@4761
   283
SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
slouken@4761
   284
SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
slouken@4761
   285
SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
slouken@4761
   286
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
slouken@4761
   287
/** \endcond */
slouken@4761
   288
slouken@4761
   289
/* Check to make sure enums are the size of ints, for structure packing.
slouken@4761
   290
   For both Watcom C/C++ and Borland C/C++ the compiler option that makes
slouken@4761
   291
   enums having the size of an int must be enabled.
slouken@4761
   292
   This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
slouken@4761
   293
*/
slouken@4761
   294
slouken@4761
   295
/** \cond */
slouken@4761
   296
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
slouken@7191
   297
#if !defined(__ANDROID__)
paul@4697
   298
   /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */
slouken@4761
   299
typedef enum
slouken@4761
   300
{
slouken@4761
   301
    DUMMY_ENUM_VALUE
slouken@4761
   302
} SDL_DUMMY_ENUM;
slouken@4761
   303
slouken@4761
   304
SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
slouken@4761
   305
#endif
slouken@4761
   306
#endif /* DOXYGEN_SHOULD_IGNORE_THIS */
slouken@4761
   307
/** \endcond */
slouken@4761
   308
slouken@4761
   309
#include "begin_code.h"
slouken@4761
   310
/* Set up for C function definitions, even when using C++ */
slouken@4761
   311
#ifdef __cplusplus
slouken@4761
   312
extern "C" {
slouken@4761
   313
#endif
slouken@4761
   314
slouken@4761
   315
#if defined(HAVE_ALLOCA) && !defined(alloca)
slouken@4761
   316
# if defined(HAVE_ALLOCA_H)
slouken@4761
   317
#  include <alloca.h>
slouken@4761
   318
# elif defined(__GNUC__)
slouken@4761
   319
#  define alloca __builtin_alloca
slouken@4761
   320
# elif defined(_MSC_VER)
slouken@4761
   321
#  include <malloc.h>
slouken@4761
   322
#  define alloca _alloca
slouken@4761
   323
# elif defined(__WATCOMC__)
slouken@4761
   324
#  include <malloc.h>
slouken@4761
   325
# elif defined(__BORLANDC__)
slouken@4761
   326
#  include <malloc.h>
slouken@4761
   327
# elif defined(__DMC__)
slouken@4761
   328
#  include <stdlib.h>
slouken@4761
   329
# elif defined(__AIX__)
slouken@4761
   330
#pragma alloca
slouken@4761
   331
# elif defined(__MRC__)
slouken@4761
   332
void *alloca(unsigned);
slouken@4761
   333
# else
slouken@4761
   334
char *alloca();
slouken@4761
   335
# endif
slouken@4761
   336
#endif
slouken@4761
   337
#ifdef HAVE_ALLOCA
slouken@4761
   338
#define SDL_stack_alloc(type, count)    (type*)alloca(sizeof(type)*(count))
slouken@4761
   339
#define SDL_stack_free(data)
slouken@4761
   340
#else
slouken@4761
   341
#define SDL_stack_alloc(type, count)    (type*)SDL_malloc(sizeof(type)*(count))
slouken@4761
   342
#define SDL_stack_free(data)            SDL_free(data)
slouken@4761
   343
#endif
slouken@4761
   344
icculus@7003
   345
extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
icculus@7003
   346
extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
icculus@7003
   347
extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
icculus@7003
   348
extern DECLSPEC void SDLCALL SDL_free(void *mem);
slouken@4761
   349
slouken@11610
   350
typedef void *(SDLCALL *SDL_malloc_func)(size_t size);
slouken@11610
   351
typedef void *(SDLCALL *SDL_calloc_func)(size_t nmemb, size_t size);
slouken@11610
   352
typedef void *(SDLCALL *SDL_realloc_func)(void *mem, size_t size);
slouken@11610
   353
typedef void (SDLCALL *SDL_free_func)(void *mem);
slouken@11610
   354
slouken@11610
   355
/**
slouken@11610
   356
 *  \brief Get the current set of SDL memory functions
slouken@11610
   357
 */
slouken@11610
   358
extern DECLSPEC void SDLCALL SDL_GetMemoryFunctions(SDL_malloc_func *malloc_func,
slouken@11610
   359
                                                    SDL_calloc_func *calloc_func,
slouken@11610
   360
                                                    SDL_realloc_func *realloc_func,
slouken@11610
   361
                                                    SDL_free_func *free_func);
slouken@11610
   362
slouken@11610
   363
/**
slouken@11610
   364
 *  \brief Replace SDL's memory allocation functions with a custom set
slouken@11610
   365
 *
slouken@11610
   366
 *  \note If you are replacing SDL's memory functions, you should call
slouken@11610
   367
 *        SDL_GetNumAllocations() and be very careful if it returns non-zero.
slouken@11610
   368
 *        That means that your free function will be called with memory
slouken@11610
   369
 *        allocated by the previous memory allocation functions.
slouken@11610
   370
 */
slouken@11610
   371
extern DECLSPEC int SDLCALL SDL_SetMemoryFunctions(SDL_malloc_func malloc_func,
slouken@11610
   372
                                                   SDL_calloc_func calloc_func,
slouken@11610
   373
                                                   SDL_realloc_func realloc_func,
slouken@11610
   374
                                                   SDL_free_func free_func);
slouken@11610
   375
slouken@11610
   376
/**
slouken@11610
   377
 *  \brief Get the number of outstanding (unfreed) allocations
slouken@11610
   378
 */
slouken@11610
   379
extern DECLSPEC int SDLCALL SDL_GetNumAllocations();
slouken@11610
   380
icculus@7003
   381
extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
icculus@7003
   382
extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value, int overwrite);
slouken@4761
   383
icculus@7003
   384
extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, int (*compare) (const void *, const void *));
slouken@4761
   385
icculus@7003
   386
extern DECLSPEC int SDLCALL SDL_abs(int x);
icculus@7003
   387
icculus@7003
   388
/* !!! FIXME: these have side effects. You probably shouldn't use them. */
icculus@7003
   389
/* !!! FIXME: Maybe we do forceinline functions of SDL_mini, SDL_minf, etc? */
icculus@7003
   390
#define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
icculus@7003
   391
#define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
icculus@7003
   392
icculus@7003
   393
extern DECLSPEC int SDLCALL SDL_isdigit(int x);
icculus@7003
   394
extern DECLSPEC int SDLCALL SDL_isspace(int x);
icculus@7003
   395
extern DECLSPEC int SDLCALL SDL_toupper(int x);
icculus@7003
   396
extern DECLSPEC int SDLCALL SDL_tolower(int x);
icculus@7003
   397
slouken@8820
   398
extern DECLSPEC void *SDLCALL SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len);
slouken@4761
   399
icculus@7003
   400
#define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
icculus@7003
   401
#define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
icculus@7003
   402
slouken@7386
   403
/* Note that memset() is a byte assignment and this is a 32-bit assignment, so they're not directly equivalent. */
slouken@7901
   404
SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
icculus@7003
   405
{
slouken@7385
   406
#if defined(__GNUC__) && defined(i386)
slouken@7385
   407
    int u0, u1, u2;
slouken@7385
   408
    __asm__ __volatile__ (
slouken@7385
   409
        "cld \n\t"
slouken@7385
   410
        "rep ; stosl \n\t"
slouken@7385
   411
        : "=&D" (u0), "=&a" (u1), "=&c" (u2)
slouken@7385
   412
        : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, dwords))
slouken@7385
   413
        : "memory"
slouken@7385
   414
    );
slouken@7385
   415
#else
slouken@7385
   416
    size_t _n = (dwords + 3) / 4;
slouken@7385
   417
    Uint32 *_p = SDL_static_cast(Uint32 *, dst);
slouken@7385
   418
    Uint32 _val = (val);
slouken@7385
   419
    if (dwords == 0)
slouken@7385
   420
        return;
slouken@7385
   421
    switch (dwords % 4)
slouken@7385
   422
    {
slouken@11459
   423
        case 0: do {    *_p++ = _val;   /* fallthrough */
slouken@11459
   424
        case 3:         *_p++ = _val;   /* fallthrough */
slouken@11459
   425
        case 2:         *_p++ = _val;   /* fallthrough */
slouken@11459
   426
        case 1:         *_p++ = _val;   /* fallthrough */
slouken@7385
   427
        } while ( --_n );
slouken@7385
   428
    }
slouken@7385
   429
#endif
icculus@7003
   430
}
icculus@7003
   431
slouken@7385
   432
slouken@8820
   433
extern DECLSPEC void *SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
icculus@7003
   434
slouken@8820
   435
extern DECLSPEC void *SDLCALL SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
slouken@7351
   436
extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
slouken@4761
   437
slouken@7351
   438
extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr);
slouken@8820
   439
extern DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
slouken@8820
   440
extern DECLSPEC size_t SDLCALL SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
slouken@11265
   441
extern DECLSPEC int SDLCALL SDL_wcscmp(const wchar_t *str1, const wchar_t *str2);
slouken@4761
   442
icculus@7003
   443
extern DECLSPEC size_t SDLCALL SDL_strlen(const char *str);
slouken@8820
   444
extern DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
slouken@8820
   445
extern DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes);
slouken@8820
   446
extern DECLSPEC size_t SDLCALL SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
icculus@7003
   447
extern DECLSPEC char *SDLCALL SDL_strdup(const char *str);
icculus@7003
   448
extern DECLSPEC char *SDLCALL SDL_strrev(char *str);
icculus@7003
   449
extern DECLSPEC char *SDLCALL SDL_strupr(char *str);
icculus@7003
   450
extern DECLSPEC char *SDLCALL SDL_strlwr(char *str);
icculus@7003
   451
extern DECLSPEC char *SDLCALL SDL_strchr(const char *str, int c);
icculus@7003
   452
extern DECLSPEC char *SDLCALL SDL_strrchr(const char *str, int c);
icculus@7003
   453
extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack, const char *needle);
icculus@11049
   454
extern DECLSPEC size_t SDLCALL SDL_utf8strlen(const char *str);
slouken@4761
   455
icculus@7003
   456
extern DECLSPEC char *SDLCALL SDL_itoa(int value, char *str, int radix);
slouken@7351
   457
extern DECLSPEC char *SDLCALL SDL_uitoa(unsigned int value, char *str, int radix);
slouken@7351
   458
extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *str, int radix);
icculus@7003
   459
extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *str, int radix);
icculus@7003
   460
extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *str, int radix);
icculus@7003
   461
extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *str, int radix);
slouken@4761
   462
icculus@7003
   463
extern DECLSPEC int SDLCALL SDL_atoi(const char *str);
icculus@7003
   464
extern DECLSPEC double SDLCALL SDL_atof(const char *str);
slouken@7351
   465
extern DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base);
slouken@7351
   466
extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base);
slouken@7351
   467
extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *str, char **endp, int base);
slouken@7351
   468
extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *str, char **endp, int base);
slouken@7351
   469
extern DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp);
icculus@7003
   470
icculus@7003
   471
extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
slouken@7351
   472
extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
slouken@7351
   473
extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
slouken@7351
   474
extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t len);
slouken@4761
   475
slouken@8820
   476
extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, ...) SDL_SCANF_VARARG_FUNC(2);
icculus@8089
   477
extern DECLSPEC int SDLCALL SDL_vsscanf(const char *text, const char *fmt, va_list ap);
slouken@8820
   478
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
   479
extern DECLSPEC int SDLCALL SDL_vsnprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, va_list ap);
slouken@4761
   480
slouken@4761
   481
#ifndef HAVE_M_PI
slouken@6627
   482
#ifndef M_PI
philipp@11065
   483
#define M_PI    3.14159265358979323846264338327950288   /**< pi */
slouken@4761
   484
#endif
slouken@6627
   485
#endif
slouken@4761
   486
slouken@8004
   487
extern DECLSPEC double SDLCALL SDL_acos(double x);
slouken@8004
   488
extern DECLSPEC double SDLCALL SDL_asin(double x);
icculus@7003
   489
extern DECLSPEC double SDLCALL SDL_atan(double x);
icculus@7003
   490
extern DECLSPEC double SDLCALL SDL_atan2(double x, double y);
icculus@7003
   491
extern DECLSPEC double SDLCALL SDL_ceil(double x);
icculus@7003
   492
extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
icculus@7003
   493
extern DECLSPEC double SDLCALL SDL_cos(double x);
icculus@7003
   494
extern DECLSPEC float SDLCALL SDL_cosf(float x);
icculus@7003
   495
extern DECLSPEC double SDLCALL SDL_fabs(double x);
icculus@7003
   496
extern DECLSPEC double SDLCALL SDL_floor(double x);
icculus@7003
   497
extern DECLSPEC double SDLCALL SDL_log(double x);
icculus@7003
   498
extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
icculus@7003
   499
extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
icculus@7003
   500
extern DECLSPEC double SDLCALL SDL_sin(double x);
icculus@7003
   501
extern DECLSPEC float SDLCALL SDL_sinf(float x);
icculus@7003
   502
extern DECLSPEC double SDLCALL SDL_sqrt(double x);
slouken@8840
   503
extern DECLSPEC float SDLCALL SDL_sqrtf(float x);
slouken@8840
   504
extern DECLSPEC double SDLCALL SDL_tan(double x);
slouken@8840
   505
extern DECLSPEC float SDLCALL SDL_tanf(float x);
slouken@4761
   506
slouken@4761
   507
/* The SDL implementation of iconv() returns these error codes */
slouken@7191
   508
#define SDL_ICONV_ERROR     (size_t)-1
slouken@7191
   509
#define SDL_ICONV_E2BIG     (size_t)-2
slouken@7191
   510
#define SDL_ICONV_EILSEQ    (size_t)-3
slouken@7191
   511
#define SDL_ICONV_EINVAL    (size_t)-4
slouken@4761
   512
icculus@7003
   513
/* SDL_iconv_* are now always real symbols/types, not macros or inlined. */
slouken@4761
   514
typedef struct _SDL_iconv_t *SDL_iconv_t;
slouken@4761
   515
extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
slouken@4761
   516
                                                   const char *fromcode);
slouken@4761
   517
extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
slouken@4761
   518
extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
slouken@4761
   519
                                         size_t * inbytesleft, char **outbuf,
slouken@4761
   520
                                         size_t * outbytesleft);
slouken@4761
   521
/**
slouken@4761
   522
 *  This function converts a string between encodings in one pass, returning a
slouken@4761
   523
 *  string that must be freed with SDL_free() or NULL on error.
slouken@4761
   524
 */
slouken@4761
   525
extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
slouken@4761
   526
                                               const char *fromcode,
slouken@4761
   527
                                               const char *inbuf,
slouken@4761
   528
                                               size_t inbytesleft);
slouken@7191
   529
#define SDL_iconv_utf8_locale(S)    SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
slouken@7191
   530
#define SDL_iconv_utf8_ucs2(S)      (Uint16 *)SDL_iconv_string("UCS-2-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
slouken@7191
   531
#define SDL_iconv_utf8_ucs4(S)      (Uint32 *)SDL_iconv_string("UCS-4-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
slouken@4761
   532
icculus@9306
   533
/* force builds using Clang's static analysis tools to use literal C runtime
icculus@9306
   534
   here, since there are possibly tests that are ineffective otherwise. */
icculus@9306
   535
#if defined(__clang_analyzer__) && !defined(SDL_DISABLE_ANALYZE_MACROS)
icculus@9306
   536
#define SDL_malloc malloc
icculus@9306
   537
#define SDL_calloc calloc
icculus@9306
   538
#define SDL_realloc realloc
icculus@9306
   539
#define SDL_free free
icculus@9306
   540
#define SDL_memset memset
icculus@9306
   541
#define SDL_memcpy memcpy
icculus@9306
   542
#define SDL_memmove memmove
icculus@9306
   543
#define SDL_memcmp memcmp
icculus@9306
   544
#define SDL_strlen strlen
icculus@9306
   545
#define SDL_strlcpy strlcpy
icculus@9306
   546
#define SDL_strlcat strlcat
icculus@9306
   547
#define SDL_strdup strdup
icculus@9306
   548
#define SDL_strchr strchr
icculus@9306
   549
#define SDL_strrchr strrchr
icculus@9306
   550
#define SDL_strstr strstr
icculus@9306
   551
#define SDL_strcmp strcmp
icculus@9306
   552
#define SDL_strncmp strncmp
icculus@9306
   553
#define SDL_strcasecmp strcasecmp
icculus@9306
   554
#define SDL_strncasecmp strncasecmp
icculus@9306
   555
#define SDL_sscanf sscanf
icculus@9306
   556
#define SDL_vsscanf vsscanf
icculus@9306
   557
#define SDL_snprintf snprintf
icculus@9306
   558
#define SDL_vsnprintf vsnprintf
icculus@9306
   559
#endif
icculus@9306
   560
icculus@9306
   561
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
   562
{
icculus@9306
   563
    return SDL_memcpy(dst, src, dwords * 4);
icculus@9306
   564
}
icculus@9306
   565
slouken@4761
   566
/* Ends C function definitions when using C++ */
slouken@4761
   567
#ifdef __cplusplus
slouken@4761
   568
}
slouken@4761
   569
#endif
slouken@4761
   570
#include "close_code.h"
slouken@4761
   571
slouken@10638
   572
#endif /* SDL_stdinc_h_ */
slouken@4761
   573
slouken@4761
   574
/* vi: set ts=4 sw=4 expandtab: */