SDL  2.0
SDL_stdinc.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
4 
5  This software is provided 'as-is', without any express or implied
6  warranty. In no event will the authors be held liable for any damages
7  arising from the use of this software.
8 
9  Permission is granted to anyone to use this software for any purpose,
10  including commercial applications, and to alter it and redistribute it
11  freely, subject to the following restrictions:
12 
13  1. The origin of this software must not be misrepresented; you must not
14  claim that you wrote the original software. If you use this software
15  in a product, an acknowledgment in the product documentation would be
16  appreciated but is not required.
17  2. Altered source versions must be plainly marked as such, and must not be
18  misrepresented as being the original software.
19  3. This notice may not be removed or altered from any source distribution.
20 */
21 
22 /**
23  * \file SDL_stdinc.h
24  *
25  * This is a general header that includes C language support.
26  */
27 
28 #ifndef SDL_stdinc_h_
29 #define SDL_stdinc_h_
30 
31 #include "SDL_config.h"
32 
33 #ifdef __APPLE__
34 #ifndef _DARWIN_C_SOURCE
35 #define _DARWIN_C_SOURCE 1 /* for memset_pattern4() */
36 #endif
37 #endif
38 
39 #ifdef HAVE_SYS_TYPES_H
40 #include <sys/types.h>
41 #endif
42 #ifdef HAVE_STDIO_H
43 #include <stdio.h>
44 #endif
45 #if defined(STDC_HEADERS)
46 # include <stdlib.h>
47 # include <stddef.h>
48 # include <stdarg.h>
49 #else
50 # if defined(HAVE_STDLIB_H)
51 # include <stdlib.h>
52 # elif defined(HAVE_MALLOC_H)
53 # include <malloc.h>
54 # endif
55 # if defined(HAVE_STDDEF_H)
56 # include <stddef.h>
57 # endif
58 # if defined(HAVE_STDARG_H)
59 # include <stdarg.h>
60 # endif
61 #endif
62 #ifdef HAVE_STRING_H
63 # if !defined(STDC_HEADERS) && defined(HAVE_MEMORY_H)
64 # include <memory.h>
65 # endif
66 # include <string.h>
67 #endif
68 #ifdef HAVE_STRINGS_H
69 # include <strings.h>
70 #endif
71 #ifdef HAVE_WCHAR_H
72 # include <wchar.h>
73 #endif
74 #if defined(HAVE_INTTYPES_H)
75 # include <inttypes.h>
76 #elif defined(HAVE_STDINT_H)
77 # include <stdint.h>
78 #endif
79 #ifdef HAVE_CTYPE_H
80 # include <ctype.h>
81 #endif
82 #ifdef HAVE_MATH_H
83 # if defined(__WINRT__)
84 /* Defining _USE_MATH_DEFINES is required to get M_PI to be defined on
85  WinRT. See http://msdn.microsoft.com/en-us/library/4hwaceh6.aspx
86  for more information.
87 */
88 # define _USE_MATH_DEFINES
89 # endif
90 # include <math.h>
91 #endif
92 #ifdef HAVE_FLOAT_H
93 # include <float.h>
94 #endif
95 #if defined(HAVE_ALLOCA) && !defined(alloca)
96 # if defined(HAVE_ALLOCA_H)
97 # include <alloca.h>
98 # elif defined(__GNUC__)
99 # define alloca __builtin_alloca
100 # elif defined(_MSC_VER)
101 # include <malloc.h>
102 # define alloca _alloca
103 # elif defined(__WATCOMC__)
104 # include <malloc.h>
105 # elif defined(__BORLANDC__)
106 # include <malloc.h>
107 # elif defined(__DMC__)
108 # include <stdlib.h>
109 # elif defined(__AIX__)
110 #pragma alloca
111 # elif defined(__MRC__)
112 void *alloca(unsigned);
113 # else
114 char *alloca();
115 # endif
116 #endif
117 
118 /**
119  * Check if the compiler supports a given builtin.
120  * Supported by virtually all clang versions and recent gcc. Use this
121  * instead of checking the clang version if possible.
122  */
123 #ifdef __has_builtin
124 #define _SDL_HAS_BUILTIN(x) __has_builtin(x)
125 #else
126 #define _SDL_HAS_BUILTIN(x) 0
127 #endif
128 
129 /**
130  * The number of elements in an array.
131  */
132 #define SDL_arraysize(array) (sizeof(array)/sizeof(array[0]))
133 #define SDL_TABLESIZE(table) SDL_arraysize(table)
134 
135 /**
136  * Macro useful for building other macros with strings in them
137  *
138  * e.g. #define LOG_ERROR(X) OutputDebugString(SDL_STRINGIFY_ARG(__FUNCTION__) ": " X "\n")
139  */
140 #define SDL_STRINGIFY_ARG(arg) #arg
141 
142 /**
143  * \name Cast operators
144  *
145  * Use proper C++ casts when compiled as C++ to be compatible with the option
146  * -Wold-style-cast of GCC (and -Werror=old-style-cast in GCC 4.2 and above).
147  */
148 /* @{ */
149 #ifdef __cplusplus
150 #define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression)
151 #define SDL_static_cast(type, expression) static_cast<type>(expression)
152 #define SDL_const_cast(type, expression) const_cast<type>(expression)
153 #else
154 #define SDL_reinterpret_cast(type, expression) ((type)(expression))
155 #define SDL_static_cast(type, expression) ((type)(expression))
156 #define SDL_const_cast(type, expression) ((type)(expression))
157 #endif
158 /* @} *//* Cast operators */
159 
160 /* Define a four character code as a Uint32 */
161 #define SDL_FOURCC(A, B, C, D) \
162  ((SDL_static_cast(Uint32, SDL_static_cast(Uint8, (A))) << 0) | \
163  (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (B))) << 8) | \
164  (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (C))) << 16) | \
165  (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (D))) << 24))
166 
167 /**
168  * \name Basic data types
169  */
170 /* @{ */
171 
172 #ifdef __CC_ARM
173 /* ARM's compiler throws warnings if we use an enum: like "SDL_bool x = a < b;" */
174 #define SDL_FALSE 0
175 #define SDL_TRUE 1
176 typedef int SDL_bool;
177 #else
178 typedef enum
179 {
181  SDL_TRUE = 1
183 #endif
184 
185 /**
186  * \brief A signed 8-bit integer type.
187  */
188 #define SDL_MAX_SINT8 ((Sint8)0x7F) /* 127 */
189 #define SDL_MIN_SINT8 ((Sint8)(~0x7F)) /* -128 */
190 typedef int8_t Sint8;
191 /**
192  * \brief An unsigned 8-bit integer type.
193  */
194 #define SDL_MAX_UINT8 ((Uint8)0xFF) /* 255 */
195 #define SDL_MIN_UINT8 ((Uint8)0x00) /* 0 */
196 typedef uint8_t Uint8;
197 /**
198  * \brief A signed 16-bit integer type.
199  */
200 #define SDL_MAX_SINT16 ((Sint16)0x7FFF) /* 32767 */
201 #define SDL_MIN_SINT16 ((Sint16)(~0x7FFF)) /* -32768 */
202 typedef int16_t Sint16;
203 /**
204  * \brief An unsigned 16-bit integer type.
205  */
206 #define SDL_MAX_UINT16 ((Uint16)0xFFFF) /* 65535 */
207 #define SDL_MIN_UINT16 ((Uint16)0x0000) /* 0 */
208 typedef uint16_t Uint16;
209 /**
210  * \brief A signed 32-bit integer type.
211  */
212 #define SDL_MAX_SINT32 ((Sint32)0x7FFFFFFF) /* 2147483647 */
213 #define SDL_MIN_SINT32 ((Sint32)(~0x7FFFFFFF)) /* -2147483648 */
214 typedef int32_t Sint32;
215 /**
216  * \brief An unsigned 32-bit integer type.
217  */
218 #define SDL_MAX_UINT32 ((Uint32)0xFFFFFFFFu) /* 4294967295 */
219 #define SDL_MIN_UINT32 ((Uint32)0x00000000) /* 0 */
220 typedef uint32_t Uint32;
221 
222 /**
223  * \brief A signed 64-bit integer type.
224  */
225 #define SDL_MAX_SINT64 ((Sint64)0x7FFFFFFFFFFFFFFFll) /* 9223372036854775807 */
226 #define SDL_MIN_SINT64 ((Sint64)(~0x7FFFFFFFFFFFFFFFll)) /* -9223372036854775808 */
227 typedef int64_t Sint64;
228 /**
229  * \brief An unsigned 64-bit integer type.
230  */
231 #define SDL_MAX_UINT64 ((Uint64)0xFFFFFFFFFFFFFFFFull) /* 18446744073709551615 */
232 #define SDL_MIN_UINT64 ((Uint64)(0x0000000000000000ull)) /* 0 */
233 typedef uint64_t Uint64;
234 
235 /* @} *//* Basic data types */
236 
237 /**
238  * \name Floating-point constants
239  */
240 /* @{ */
241 
242 #ifdef FLT_EPSILON
243 #define SDL_FLT_EPSILON FLT_EPSILON
244 #else
245 #define SDL_FLT_EPSILON 1.1920928955078125e-07F /* 0x0.000002p0 */
246 #endif
247 
248 /* @} *//* Floating-point constants */
249 
250 /* Make sure we have macros for printing width-based integers.
251  * <stdint.h> should define these but this is not true all platforms.
252  * (for example win32) */
253 #ifndef SDL_PRIs64
254 #ifdef PRIs64
255 #define SDL_PRIs64 PRIs64
256 #elif defined(__WIN32__)
257 #define SDL_PRIs64 "I64d"
258 #elif defined(__LINUX__) && defined(__LP64__)
259 #define SDL_PRIs64 "ld"
260 #else
261 #define SDL_PRIs64 "lld"
262 #endif
263 #endif
264 #ifndef SDL_PRIu64
265 #ifdef PRIu64
266 #define SDL_PRIu64 PRIu64
267 #elif defined(__WIN32__)
268 #define SDL_PRIu64 "I64u"
269 #elif defined(__LINUX__) && defined(__LP64__)
270 #define SDL_PRIu64 "lu"
271 #else
272 #define SDL_PRIu64 "llu"
273 #endif
274 #endif
275 #ifndef SDL_PRIx64
276 #ifdef PRIx64
277 #define SDL_PRIx64 PRIx64
278 #elif defined(__WIN32__)
279 #define SDL_PRIx64 "I64x"
280 #elif defined(__LINUX__) && defined(__LP64__)
281 #define SDL_PRIx64 "lx"
282 #else
283 #define SDL_PRIx64 "llx"
284 #endif
285 #endif
286 #ifndef SDL_PRIX64
287 #ifdef PRIX64
288 #define SDL_PRIX64 PRIX64
289 #elif defined(__WIN32__)
290 #define SDL_PRIX64 "I64X"
291 #elif defined(__LINUX__) && defined(__LP64__)
292 #define SDL_PRIX64 "lX"
293 #else
294 #define SDL_PRIX64 "llX"
295 #endif
296 #endif
297 #ifndef SDL_PRIs32
298 #ifdef PRId32
299 #define SDL_PRIs32 PRId32
300 #else
301 #define SDL_PRIs32 "d"
302 #endif
303 #endif
304 #ifndef SDL_PRIu32
305 #ifdef PRIu32
306 #define SDL_PRIu32 PRIu32
307 #else
308 #define SDL_PRIu32 "u"
309 #endif
310 #endif
311 #ifndef SDL_PRIx32
312 #ifdef PRIx32
313 #define SDL_PRIx32 PRIx32
314 #else
315 #define SDL_PRIx32 "x"
316 #endif
317 #endif
318 #ifndef SDL_PRIX32
319 #ifdef PRIX32
320 #define SDL_PRIX32 PRIX32
321 #else
322 #define SDL_PRIX32 "X"
323 #endif
324 #endif
325 
326 /* Annotations to help code analysis tools */
327 #ifdef SDL_DISABLE_ANALYZE_MACROS
328 #define SDL_IN_BYTECAP(x)
329 #define SDL_INOUT_Z_CAP(x)
330 #define SDL_OUT_Z_CAP(x)
331 #define SDL_OUT_CAP(x)
332 #define SDL_OUT_BYTECAP(x)
333 #define SDL_OUT_Z_BYTECAP(x)
334 #define SDL_PRINTF_FORMAT_STRING
335 #define SDL_SCANF_FORMAT_STRING
336 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
337 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
338 #else
339 #if defined(_MSC_VER) && (_MSC_VER >= 1600) /* VS 2010 and above */
340 #include <sal.h>
341 
342 #define SDL_IN_BYTECAP(x) _In_bytecount_(x)
343 #define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x)
344 #define SDL_OUT_Z_CAP(x) _Out_z_cap_(x)
345 #define SDL_OUT_CAP(x) _Out_cap_(x)
346 #define SDL_OUT_BYTECAP(x) _Out_bytecap_(x)
347 #define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x)
348 
349 #define SDL_PRINTF_FORMAT_STRING _Printf_format_string_
350 #define SDL_SCANF_FORMAT_STRING _Scanf_format_string_impl_
351 #else
352 #define SDL_IN_BYTECAP(x)
353 #define SDL_INOUT_Z_CAP(x)
354 #define SDL_OUT_Z_CAP(x)
355 #define SDL_OUT_CAP(x)
356 #define SDL_OUT_BYTECAP(x)
357 #define SDL_OUT_Z_BYTECAP(x)
358 #define SDL_PRINTF_FORMAT_STRING
359 #define SDL_SCANF_FORMAT_STRING
360 #endif
361 #if defined(__GNUC__)
362 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __printf__, fmtargnumber, fmtargnumber+1 )))
363 #define SDL_SCANF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __scanf__, fmtargnumber, fmtargnumber+1 )))
364 #else
365 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
366 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
367 #endif
368 #endif /* SDL_DISABLE_ANALYZE_MACROS */
369 
370 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
371 #define SDL_COMPILE_TIME_ASSERT(name, x) _Static_assert(x, #x)
372 #elif defined(__cplusplus) && (__cplusplus >= 201103L)
373 #define SDL_COMPILE_TIME_ASSERT(name, x) static_assert(x, #x)
374 #else /* universal, but may trigger -Wunused-local-typedefs */
375 #define SDL_COMPILE_TIME_ASSERT(name, x) \
376  typedef int SDL_compile_time_assert_ ## name[(x) * 2 - 1]
377 #endif
378 /** \cond */
379 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
380 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
381 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
382 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
383 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
384 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
385 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
386 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
387 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
388 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
389 /** \endcond */
390 
391 /* Check to make sure enums are the size of ints, for structure packing.
392  For both Watcom C/C++ and Borland C/C++ the compiler option that makes
393  enums having the size of an int must be enabled.
394  This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
395 */
396 
397 /** \cond */
398 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
399 #if !defined(__ANDROID__) && !defined(__VITA__)
400  /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */
401 typedef enum
402 {
403  DUMMY_ENUM_VALUE
404 } SDL_DUMMY_ENUM;
405 
406 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
407 #endif
408 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
409 /** \endcond */
410 
411 #include "begin_code.h"
412 /* Set up for C function definitions, even when using C++ */
413 #ifdef __cplusplus
414 extern "C" {
415 #endif
416 
417 #ifdef HAVE_ALLOCA
418 #define SDL_stack_alloc(type, count) (type*)alloca(sizeof(type)*(count))
419 #define SDL_stack_free(data)
420 #else
421 #define SDL_stack_alloc(type, count) (type*)SDL_malloc(sizeof(type)*(count))
422 #define SDL_stack_free(data) SDL_free(data)
423 #endif
424 
425 extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
426 extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
427 extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
428 extern DECLSPEC void SDLCALL SDL_free(void *mem);
429 
430 typedef void *(SDLCALL *SDL_malloc_func)(size_t size);
431 typedef void *(SDLCALL *SDL_calloc_func)(size_t nmemb, size_t size);
432 typedef void *(SDLCALL *SDL_realloc_func)(void *mem, size_t size);
433 typedef void (SDLCALL *SDL_free_func)(void *mem);
434 
435 /**
436  * Get the current set of SDL memory functions
437  *
438  * \since This function is available since SDL 2.0.7.
439  */
440 extern DECLSPEC void SDLCALL SDL_GetMemoryFunctions(SDL_malloc_func *malloc_func,
441  SDL_calloc_func *calloc_func,
442  SDL_realloc_func *realloc_func,
443  SDL_free_func *free_func);
444 
445 /**
446  * Replace SDL's memory allocation functions with a custom set
447  *
448  * \since This function is available since SDL 2.0.7.
449  */
450 extern DECLSPEC int SDLCALL SDL_SetMemoryFunctions(SDL_malloc_func malloc_func,
451  SDL_calloc_func calloc_func,
452  SDL_realloc_func realloc_func,
453  SDL_free_func free_func);
454 
455 /**
456  * Get the number of outstanding (unfreed) allocations
457  *
458  * \since This function is available since SDL 2.0.7.
459  */
460 extern DECLSPEC int SDLCALL SDL_GetNumAllocations(void);
461 
462 extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
463 extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value, int overwrite);
464 
465 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, int (*compare) (const void *, const void *));
466 extern DECLSPEC void * SDLCALL SDL_bsearch(const void *key, const void *base, size_t nmemb, size_t size, int (*compare) (const void *, const void *));
467 
468 extern DECLSPEC int SDLCALL SDL_abs(int x);
469 
470 /* NOTE: these double-evaluate their arguments, so you should never have side effects in the parameters */
471 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
472 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
473 #define SDL_clamp(x, a, b) (((x) < (a)) ? (a) : (((x) > (b)) ? (b) : (x)))
474 
475 extern DECLSPEC int SDLCALL SDL_isalpha(int x);
476 extern DECLSPEC int SDLCALL SDL_isalnum(int x);
477 extern DECLSPEC int SDLCALL SDL_isblank(int x);
478 extern DECLSPEC int SDLCALL SDL_iscntrl(int x);
479 extern DECLSPEC int SDLCALL SDL_isdigit(int x);
480 extern DECLSPEC int SDLCALL SDL_isxdigit(int x);
481 extern DECLSPEC int SDLCALL SDL_ispunct(int x);
482 extern DECLSPEC int SDLCALL SDL_isspace(int x);
483 extern DECLSPEC int SDLCALL SDL_isupper(int x);
484 extern DECLSPEC int SDLCALL SDL_islower(int x);
485 extern DECLSPEC int SDLCALL SDL_isprint(int x);
486 extern DECLSPEC int SDLCALL SDL_isgraph(int x);
487 extern DECLSPEC int SDLCALL SDL_toupper(int x);
488 extern DECLSPEC int SDLCALL SDL_tolower(int x);
489 
490 extern DECLSPEC Uint32 SDLCALL SDL_crc32(Uint32 crc, const void *data, size_t len);
491 
492 extern DECLSPEC void *SDLCALL SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len);
493 
494 #define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
495 #define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
496 #define SDL_zeroa(x) SDL_memset((x), 0, sizeof((x)))
497 
498 /* Note that memset() is a byte assignment and this is a 32-bit assignment, so they're not directly equivalent. */
499 SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
500 {
501 #ifdef __APPLE__
502  memset_pattern4(dst, &val, dwords * 4);
503 #elif defined(__GNUC__) && defined(__i386__)
504  int u0, u1, u2;
505  __asm__ __volatile__ (
506  "cld \n\t"
507  "rep ; stosl \n\t"
508  : "=&D" (u0), "=&a" (u1), "=&c" (u2)
509  : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, dwords))
510  : "memory"
511  );
512 #else
513  size_t _n = (dwords + 3) / 4;
514  Uint32 *_p = SDL_static_cast(Uint32 *, dst);
515  Uint32 _val = (val);
516  if (dwords == 0) {
517  return;
518  }
519  switch (dwords % 4) {
520  case 0: do { *_p++ = _val; SDL_FALLTHROUGH;
521  case 3: *_p++ = _val; SDL_FALLTHROUGH;
522  case 2: *_p++ = _val; SDL_FALLTHROUGH;
523  case 1: *_p++ = _val;
524  } while ( --_n );
525  }
526 #endif
527 }
528 
529 extern DECLSPEC void *SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
530 
531 extern DECLSPEC void *SDLCALL SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
532 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
533 
534 extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr);
535 extern DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
536 extern DECLSPEC size_t SDLCALL SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
537 extern DECLSPEC wchar_t *SDLCALL SDL_wcsdup(const wchar_t *wstr);
538 extern DECLSPEC wchar_t *SDLCALL SDL_wcsstr(const wchar_t *haystack, const wchar_t *needle);
539 
540 extern DECLSPEC int SDLCALL SDL_wcscmp(const wchar_t *str1, const wchar_t *str2);
541 extern DECLSPEC int SDLCALL SDL_wcsncmp(const wchar_t *str1, const wchar_t *str2, size_t maxlen);
542 extern DECLSPEC int SDLCALL SDL_wcscasecmp(const wchar_t *str1, const wchar_t *str2);
543 extern DECLSPEC int SDLCALL SDL_wcsncasecmp(const wchar_t *str1, const wchar_t *str2, size_t len);
544 
545 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *str);
546 extern DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
547 extern DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes);
548 extern DECLSPEC size_t SDLCALL SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
549 extern DECLSPEC char *SDLCALL SDL_strdup(const char *str);
550 extern DECLSPEC char *SDLCALL SDL_strrev(char *str);
551 extern DECLSPEC char *SDLCALL SDL_strupr(char *str);
552 extern DECLSPEC char *SDLCALL SDL_strlwr(char *str);
553 extern DECLSPEC char *SDLCALL SDL_strchr(const char *str, int c);
554 extern DECLSPEC char *SDLCALL SDL_strrchr(const char *str, int c);
555 extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack, const char *needle);
556 extern DECLSPEC char *SDLCALL SDL_strtokr(char *s1, const char *s2, char **saveptr);
557 extern DECLSPEC size_t SDLCALL SDL_utf8strlen(const char *str);
558 
559 extern DECLSPEC char *SDLCALL SDL_itoa(int value, char *str, int radix);
560 extern DECLSPEC char *SDLCALL SDL_uitoa(unsigned int value, char *str, int radix);
561 extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *str, int radix);
562 extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *str, int radix);
563 extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *str, int radix);
564 extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *str, int radix);
565 
566 extern DECLSPEC int SDLCALL SDL_atoi(const char *str);
567 extern DECLSPEC double SDLCALL SDL_atof(const char *str);
568 extern DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base);
569 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base);
570 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *str, char **endp, int base);
571 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *str, char **endp, int base);
572 extern DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp);
573 
574 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
575 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
576 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
577 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t len);
578 
579 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, ...) SDL_SCANF_VARARG_FUNC(2);
580 extern DECLSPEC int SDLCALL SDL_vsscanf(const char *text, const char *fmt, va_list ap);
581 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);
582 extern DECLSPEC int SDLCALL SDL_vsnprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, va_list ap);
583 extern DECLSPEC int SDLCALL SDL_asprintf(char **strp, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2);
584 extern DECLSPEC int SDLCALL SDL_vasprintf(char **strp, const char *fmt, va_list ap);
585 
586 #ifndef HAVE_M_PI
587 #ifndef M_PI
588 #define M_PI 3.14159265358979323846264338327950288 /**< pi */
589 #endif
590 #endif
591 
592 /**
593  * Use this function to compute arc cosine of `x`.
594  *
595  * The definition of `y = acos(x)` is `x = cos(y)`.
596  *
597  * Domain: `-1 <= x <= 1`
598  *
599  * Range: `0 <= y <= Pi`
600  *
601  * \param x floating point value, in radians.
602  * \returns arc cosine of `x`.
603  *
604  * \since This function is available since SDL 2.0.2.
605  */
606 extern DECLSPEC double SDLCALL SDL_acos(double x);
607 extern DECLSPEC float SDLCALL SDL_acosf(float x);
608 extern DECLSPEC double SDLCALL SDL_asin(double x);
609 extern DECLSPEC float SDLCALL SDL_asinf(float x);
610 extern DECLSPEC double SDLCALL SDL_atan(double x);
611 extern DECLSPEC float SDLCALL SDL_atanf(float x);
612 extern DECLSPEC double SDLCALL SDL_atan2(double y, double x);
613 extern DECLSPEC float SDLCALL SDL_atan2f(float y, float x);
614 extern DECLSPEC double SDLCALL SDL_ceil(double x);
615 extern DECLSPEC float SDLCALL SDL_ceilf(float x);
616 extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
617 extern DECLSPEC float SDLCALL SDL_copysignf(float x, float y);
618 extern DECLSPEC double SDLCALL SDL_cos(double x);
619 extern DECLSPEC float SDLCALL SDL_cosf(float x);
620 extern DECLSPEC double SDLCALL SDL_exp(double x);
621 extern DECLSPEC float SDLCALL SDL_expf(float x);
622 extern DECLSPEC double SDLCALL SDL_fabs(double x);
623 extern DECLSPEC float SDLCALL SDL_fabsf(float x);
624 extern DECLSPEC double SDLCALL SDL_floor(double x);
625 extern DECLSPEC float SDLCALL SDL_floorf(float x);
626 extern DECLSPEC double SDLCALL SDL_trunc(double x);
627 extern DECLSPEC float SDLCALL SDL_truncf(float x);
628 extern DECLSPEC double SDLCALL SDL_fmod(double x, double y);
629 extern DECLSPEC float SDLCALL SDL_fmodf(float x, float y);
630 extern DECLSPEC double SDLCALL SDL_log(double x);
631 extern DECLSPEC float SDLCALL SDL_logf(float x);
632 extern DECLSPEC double SDLCALL SDL_log10(double x);
633 extern DECLSPEC float SDLCALL SDL_log10f(float x);
634 extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
635 extern DECLSPEC float SDLCALL SDL_powf(float x, float y);
636 extern DECLSPEC double SDLCALL SDL_round(double x);
637 extern DECLSPEC float SDLCALL SDL_roundf(float x);
638 extern DECLSPEC long SDLCALL SDL_lround(double x);
639 extern DECLSPEC long SDLCALL SDL_lroundf(float x);
640 extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
641 extern DECLSPEC float SDLCALL SDL_scalbnf(float x, int n);
642 extern DECLSPEC double SDLCALL SDL_sin(double x);
643 extern DECLSPEC float SDLCALL SDL_sinf(float x);
644 extern DECLSPEC double SDLCALL SDL_sqrt(double x);
645 extern DECLSPEC float SDLCALL SDL_sqrtf(float x);
646 extern DECLSPEC double SDLCALL SDL_tan(double x);
647 extern DECLSPEC float SDLCALL SDL_tanf(float x);
648 
649 /* The SDL implementation of iconv() returns these error codes */
650 #define SDL_ICONV_ERROR (size_t)-1
651 #define SDL_ICONV_E2BIG (size_t)-2
652 #define SDL_ICONV_EILSEQ (size_t)-3
653 #define SDL_ICONV_EINVAL (size_t)-4
654 
655 /* SDL_iconv_* are now always real symbols/types, not macros or inlined. */
656 typedef struct _SDL_iconv_t *SDL_iconv_t;
657 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
658  const char *fromcode);
659 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
660 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
661  size_t * inbytesleft, char **outbuf,
662  size_t * outbytesleft);
663 
664 /**
665  * This function converts a string between encodings in one pass, returning a
666  * string that must be freed with SDL_free() or NULL on error.
667  *
668  * \since This function is available since SDL 2.0.0.
669  */
670 extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
671  const char *fromcode,
672  const char *inbuf,
673  size_t inbytesleft);
674 #define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
675 #define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
676 #define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
677 #define SDL_iconv_wchar_utf8(S) SDL_iconv_string("UTF-8", "WCHAR_T", (char *)S, (SDL_wcslen(S)+1)*sizeof(wchar_t))
678 
679 /* force builds using Clang's static analysis tools to use literal C runtime
680  here, since there are possibly tests that are ineffective otherwise. */
681 #if defined(__clang_analyzer__) && !defined(SDL_DISABLE_ANALYZE_MACROS)
682 
683 /* The analyzer knows about strlcpy even when the system doesn't provide it */
684 #ifndef HAVE_STRLCPY
685 size_t strlcpy(char* dst, const char* src, size_t size);
686 #endif
687 
688 /* The analyzer knows about strlcat even when the system doesn't provide it */
689 #ifndef HAVE_STRLCAT
690 size_t strlcat(char* dst, const char* src, size_t size);
691 #endif
692 
693 #define SDL_malloc malloc
694 #define SDL_calloc calloc
695 #define SDL_realloc realloc
696 #define SDL_free free
697 #define SDL_memset memset
698 #define SDL_memcpy memcpy
699 #define SDL_memmove memmove
700 #define SDL_memcmp memcmp
701 #define SDL_strlcpy strlcpy
702 #define SDL_strlcat strlcat
703 #define SDL_strlen strlen
704 #define SDL_wcslen wcslen
705 #define SDL_wcslcpy wcslcpy
706 #define SDL_wcslcat wcslcat
707 #define SDL_strdup strdup
708 #define SDL_wcsdup wcsdup
709 #define SDL_strchr strchr
710 #define SDL_strrchr strrchr
711 #define SDL_strstr strstr
712 #define SDL_wcsstr wcsstr
713 #define SDL_strtokr strtok_r
714 #define SDL_strcmp strcmp
715 #define SDL_wcscmp wcscmp
716 #define SDL_strncmp strncmp
717 #define SDL_wcsncmp wcsncmp
718 #define SDL_strcasecmp strcasecmp
719 #define SDL_strncasecmp strncasecmp
720 #define SDL_sscanf sscanf
721 #define SDL_vsscanf vsscanf
722 #define SDL_snprintf snprintf
723 #define SDL_vsnprintf vsnprintf
724 #endif
725 
726 SDL_FORCE_INLINE void *SDL_memcpy4(SDL_OUT_BYTECAP(dwords*4) void *dst, SDL_IN_BYTECAP(dwords*4) const void *src, size_t dwords)
727 {
728  return SDL_memcpy(dst, src, dwords * 4);
729 }
730 
731 /* Ends C function definitions when using C++ */
732 #ifdef __cplusplus
733 }
734 #endif
735 #include "close_code.h"
736 
737 #endif /* SDL_stdinc_h_ */
738 
739 /* vi: set ts=4 sw=4 expandtab: */
signed short int16_t
unsigned short uint16_t
unsigned int uint32_t
unsigned long long uint64_t
signed int int32_t
unsigned char uint8_t
signed long long int64_t
signed char int8_t
double SDL_sqrt(double x)
int SDL_atoi(const char *str)
SDL_iconv_t SDL_iconv_open(const char *tocode, const char *fromcode)
SDL_FORCE_INLINE void * SDL_memcpy4(SDL_OUT_BYTECAP(dwords *4) void *dst, SDL_IN_BYTECAP(dwords *4) const void *src, size_t dwords)
Definition: SDL_stdinc.h:726
float SDL_tanf(float x)
SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
Definition: SDL_stdinc.h:499
int SDL_isspace(int x)
int SDL_isalnum(int x)
int SDL_tolower(int x)
void * SDL_bsearch(const void *key, const void *base, size_t nmemb, size_t size, int(*compare)(const void *, const void *))
int SDL_abs(int x)
size_t SDL_iconv(SDL_iconv_t cd, const char **inbuf, size_t *inbytesleft, char **outbuf, size_t *outbytesleft)
wchar_t * SDL_wcsdup(const wchar_t *wstr)
double SDL_tan(double x)
uint8_t Uint8
Definition: SDL_stdinc.h:196
int SDL_isxdigit(int x)
void(* SDL_free_func)(void *mem)
Definition: SDL_stdinc.h:433
float SDL_ceilf(float x)
int64_t Sint64
Definition: SDL_stdinc.h:227
#define SDL_OUT_BYTECAP(x)
Definition: SDL_stdinc.h:356
int SDL_wcsncmp(const wchar_t *str1, const wchar_t *str2, size_t maxlen)
uint16_t Uint16
Definition: SDL_stdinc.h:208
int SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt,...) SDL_SCANF_VARARG_FUNC(2)
void SDL_qsort(void *base, size_t nmemb, size_t size, int(*compare)(const void *, const void *))
int SDL_vsnprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, va_list ap)
float SDL_atanf(float x)
int SDL_isprint(int x)
char * SDL_strchr(const char *str, int c)
struct _SDL_iconv_t * SDL_iconv_t
Definition: SDL_stdinc.h:656
int SDL_wcsncasecmp(const wchar_t *str1, const wchar_t *str2, size_t len)
float SDL_copysignf(float x, float y)
void *(* SDL_realloc_func)(void *mem, size_t size)
Definition: SDL_stdinc.h:432
float SDL_acosf(float x)
void * SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len)
int SDL_SetMemoryFunctions(SDL_malloc_func malloc_func, SDL_calloc_func calloc_func, SDL_realloc_func realloc_func, SDL_free_func free_func)
size_t SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen)
char * SDL_getenv(const char *name)
int SDL_strncmp(const char *str1, const char *str2, size_t maxlen)
#define SDL_IN_BYTECAP(x)
Definition: SDL_stdinc.h:352
void * SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len)
int SDL_isalpha(int x)
double SDL_round(double x)
long SDL_lround(double x)
int SDL_isdigit(int x)
int SDL_isblank(int x)
int SDL_iconv_close(SDL_iconv_t cd)
char * SDL_strstr(const char *haystack, const char *needle)
char * SDL_ltoa(long value, char *str, int radix)
double SDL_sin(double x)
float SDL_scalbnf(float x, int n)
double SDL_pow(double x, double y)
size_t SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes)
float SDL_asinf(float x)
double SDL_asin(double x)
double SDL_acos(double x)
int8_t Sint8
Definition: SDL_stdinc.h:190
void * SDL_calloc(size_t nmemb, size_t size)
char * SDL_uitoa(unsigned int value, char *str, int radix)
char * SDL_strlwr(char *str)
float SDL_sinf(float x)
double SDL_ceil(double x)
int SDL_strcasecmp(const char *str1, const char *str2)
#define SDL_SCANF_FORMAT_STRING
Definition: SDL_stdinc.h:359
int SDL_GetNumAllocations(void)
double SDL_exp(double x)
#define SDL_static_cast(type, expression)
Definition: SDL_stdinc.h:155
size_t SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen)
double SDL_atan(double x)
float SDL_sqrtf(float x)
size_t SDL_wcslen(const wchar_t *wstr)
int32_t Sint32
Definition: SDL_stdinc.h:214
int SDL_setenv(const char *name, const char *value, int overwrite)
size_t SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen)
#define SDL_INOUT_Z_CAP(x)
Definition: SDL_stdinc.h:353
double SDL_scalbn(double x, int n)
void *(* SDL_malloc_func)(size_t size)
Definition: SDL_stdinc.h:430
char * SDL_lltoa(Sint64 value, char *str, int radix)
int SDL_wcscasecmp(const wchar_t *str1, const wchar_t *str2)
double SDL_fmod(double x, double y)
double SDL_fabs(double x)
Sint64 SDL_strtoll(const char *str, char **endp, int base)
int SDL_ispunct(int x)
float SDL_truncf(float x)
double SDL_log10(double x)
float SDL_expf(float x)
char * SDL_strtokr(char *s1, const char *s2, char **saveptr)
char * SDL_itoa(int value, char *str, int radix)
double SDL_floor(double x)
int SDL_wcscmp(const wchar_t *str1, const wchar_t *str2)
long SDL_strtol(const char *str, char **endp, int base)
SDL_bool
Definition: SDL_stdinc.h:179
@ SDL_TRUE
Definition: SDL_stdinc.h:181
@ SDL_FALSE
Definition: SDL_stdinc.h:180
Uint32 SDL_crc32(Uint32 crc, const void *data, size_t len)
int SDL_islower(int x)
float SDL_logf(float x)
float SDL_log10f(float x)
int SDL_memcmp(const void *s1, const void *s2, size_t len)
int16_t Sint16
Definition: SDL_stdinc.h:202
float SDL_roundf(float x)
double SDL_strtod(const char *str, char **endp)
char * SDL_strdup(const char *str)
long SDL_lroundf(float x)
double SDL_atof(const char *str)
int SDL_vsscanf(const char *text, const char *fmt, va_list ap)
unsigned long SDL_strtoul(const char *str, char **endp, int base)
char * SDL_iconv_string(const char *tocode, const char *fromcode, const char *inbuf, size_t inbytesleft)
float SDL_floorf(float x)
int SDL_strcmp(const char *str1, const char *str2)
char * SDL_strupr(char *str)
void * SDL_malloc(size_t size)
double SDL_cos(double x)
wchar_t * SDL_wcsstr(const wchar_t *haystack, const wchar_t *needle)
#define SDL_PRINTF_FORMAT_STRING
Definition: SDL_stdinc.h:358
void * SDL_realloc(void *mem, size_t size)
float SDL_fmodf(float x, float y)
void SDL_GetMemoryFunctions(SDL_malloc_func *malloc_func, SDL_calloc_func *calloc_func, SDL_realloc_func *realloc_func, SDL_free_func *free_func)
#define SDL_PRINTF_VARARG_FUNC(fmtargnumber)
Definition: SDL_stdinc.h:365
#define SDL_COMPILE_TIME_ASSERT(name, x)
Definition: SDL_stdinc.h:375
float SDL_atan2f(float y, float x)
int SDL_isupper(int x)
float SDL_fabsf(float x)
char * SDL_strrev(char *str)
uint64_t Uint64
Definition: SDL_stdinc.h:233
char * SDL_strrchr(const char *str, int c)
int SDL_iscntrl(int x)
void SDL_free(void *mem)
#define SDL_SCANF_VARARG_FUNC(fmtargnumber)
Definition: SDL_stdinc.h:366
double SDL_atan2(double y, double x)
double SDL_log(double x)
char * SDL_ultoa(unsigned long value, char *str, int radix)
int SDL_toupper(int x)
void *(* SDL_calloc_func)(size_t nmemb, size_t size)
Definition: SDL_stdinc.h:431
uint32_t Uint32
Definition: SDL_stdinc.h:220
float SDL_powf(float x, float y)
size_t SDL_strlen(const char *str)
int SDL_snprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(3)
float SDL_cosf(float x)
void * SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len)
size_t SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen)
int SDL_vasprintf(char **strp, const char *fmt, va_list ap)
double SDL_copysign(double x, double y)
size_t SDL_utf8strlen(const char *str)
char * SDL_ulltoa(Uint64 value, char *str, int radix)
int SDL_isgraph(int x)
int SDL_strncasecmp(const char *str1, const char *str2, size_t len)
int SDL_asprintf(char **strp, SDL_PRINTF_FORMAT_STRING const char *fmt,...) SDL_PRINTF_VARARG_FUNC(2)
#define SDL_OUT_Z_CAP(x)
Definition: SDL_stdinc.h:354
Uint64 SDL_strtoull(const char *str, char **endp, int base)
double SDL_trunc(double x)
#define SDL_FALLTHROUGH
Definition: begin_code.h:183
#define SDL_FORCE_INLINE
Definition: begin_code.h:143