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 /* Make sure we have macros for printing width-based integers.
238  * <stdint.h> should define these but this is not true all platforms.
239  * (for example win32) */
240 #ifndef SDL_PRIs64
241 #ifdef PRIs64
242 #define SDL_PRIs64 PRIs64
243 #elif defined(__WIN32__)
244 #define SDL_PRIs64 "I64d"
245 #elif defined(__LINUX__) && defined(__LP64__)
246 #define SDL_PRIs64 "ld"
247 #else
248 #define SDL_PRIs64 "lld"
249 #endif
250 #endif
251 #ifndef SDL_PRIu64
252 #ifdef PRIu64
253 #define SDL_PRIu64 PRIu64
254 #elif defined(__WIN32__)
255 #define SDL_PRIu64 "I64u"
256 #elif defined(__LINUX__) && defined(__LP64__)
257 #define SDL_PRIu64 "lu"
258 #else
259 #define SDL_PRIu64 "llu"
260 #endif
261 #endif
262 #ifndef SDL_PRIx64
263 #ifdef PRIx64
264 #define SDL_PRIx64 PRIx64
265 #elif defined(__WIN32__)
266 #define SDL_PRIx64 "I64x"
267 #elif defined(__LINUX__) && defined(__LP64__)
268 #define SDL_PRIx64 "lx"
269 #else
270 #define SDL_PRIx64 "llx"
271 #endif
272 #endif
273 #ifndef SDL_PRIX64
274 #ifdef PRIX64
275 #define SDL_PRIX64 PRIX64
276 #elif defined(__WIN32__)
277 #define SDL_PRIX64 "I64X"
278 #elif defined(__LINUX__) && defined(__LP64__)
279 #define SDL_PRIX64 "lX"
280 #else
281 #define SDL_PRIX64 "llX"
282 #endif
283 #endif
284 #ifndef SDL_PRIs32
285 #ifdef PRId32
286 #define SDL_PRIs32 PRId32
287 #else
288 #define SDL_PRIs32 "d"
289 #endif
290 #endif
291 #ifndef SDL_PRIu32
292 #ifdef PRIu32
293 #define SDL_PRIu32 PRIu32
294 #else
295 #define SDL_PRIu32 "u"
296 #endif
297 #endif
298 #ifndef SDL_PRIx32
299 #ifdef PRIx32
300 #define SDL_PRIx32 PRIx32
301 #else
302 #define SDL_PRIx32 "x"
303 #endif
304 #endif
305 #ifndef SDL_PRIX32
306 #ifdef PRIX32
307 #define SDL_PRIX32 PRIX32
308 #else
309 #define SDL_PRIX32 "X"
310 #endif
311 #endif
312 
313 /* Annotations to help code analysis tools */
314 #ifdef SDL_DISABLE_ANALYZE_MACROS
315 #define SDL_IN_BYTECAP(x)
316 #define SDL_INOUT_Z_CAP(x)
317 #define SDL_OUT_Z_CAP(x)
318 #define SDL_OUT_CAP(x)
319 #define SDL_OUT_BYTECAP(x)
320 #define SDL_OUT_Z_BYTECAP(x)
321 #define SDL_PRINTF_FORMAT_STRING
322 #define SDL_SCANF_FORMAT_STRING
323 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
324 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
325 #else
326 #if defined(_MSC_VER) && (_MSC_VER >= 1600) /* VS 2010 and above */
327 #include <sal.h>
328 
329 #define SDL_IN_BYTECAP(x) _In_bytecount_(x)
330 #define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x)
331 #define SDL_OUT_Z_CAP(x) _Out_z_cap_(x)
332 #define SDL_OUT_CAP(x) _Out_cap_(x)
333 #define SDL_OUT_BYTECAP(x) _Out_bytecap_(x)
334 #define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x)
335 
336 #define SDL_PRINTF_FORMAT_STRING _Printf_format_string_
337 #define SDL_SCANF_FORMAT_STRING _Scanf_format_string_impl_
338 #else
339 #define SDL_IN_BYTECAP(x)
340 #define SDL_INOUT_Z_CAP(x)
341 #define SDL_OUT_Z_CAP(x)
342 #define SDL_OUT_CAP(x)
343 #define SDL_OUT_BYTECAP(x)
344 #define SDL_OUT_Z_BYTECAP(x)
345 #define SDL_PRINTF_FORMAT_STRING
346 #define SDL_SCANF_FORMAT_STRING
347 #endif
348 #if defined(__GNUC__)
349 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __printf__, fmtargnumber, fmtargnumber+1 )))
350 #define SDL_SCANF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __scanf__, fmtargnumber, fmtargnumber+1 )))
351 #else
352 #define SDL_PRINTF_VARARG_FUNC( fmtargnumber )
353 #define SDL_SCANF_VARARG_FUNC( fmtargnumber )
354 #endif
355 #endif /* SDL_DISABLE_ANALYZE_MACROS */
356 
357 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
358 #define SDL_COMPILE_TIME_ASSERT(name, x) _Static_assert(x, #x)
359 #elif defined(__cplusplus) && (__cplusplus >= 201103L)
360 #define SDL_COMPILE_TIME_ASSERT(name, x) static_assert(x, #x)
361 #else /* universal, but may trigger -Wunused-local-typedefs */
362 #define SDL_COMPILE_TIME_ASSERT(name, x) \
363  typedef int SDL_compile_time_assert_ ## name[(x) * 2 - 1]
364 #endif
365 /** \cond */
366 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
367 SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
368 SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
369 SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
370 SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
371 SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
372 SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
373 SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
374 SDL_COMPILE_TIME_ASSERT(sint64, sizeof(Sint64) == 8);
375 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
376 /** \endcond */
377 
378 /* Check to make sure enums are the size of ints, for structure packing.
379  For both Watcom C/C++ and Borland C/C++ the compiler option that makes
380  enums having the size of an int must be enabled.
381  This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11).
382 */
383 
384 /** \cond */
385 #ifndef DOXYGEN_SHOULD_IGNORE_THIS
386 #if !defined(__ANDROID__) && !defined(__VITA__)
387  /* TODO: include/SDL_stdinc.h:174: error: size of array 'SDL_dummy_enum' is negative */
388 typedef enum
389 {
390  DUMMY_ENUM_VALUE
391 } SDL_DUMMY_ENUM;
392 
393 SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int));
394 #endif
395 #endif /* DOXYGEN_SHOULD_IGNORE_THIS */
396 /** \endcond */
397 
398 #include "begin_code.h"
399 /* Set up for C function definitions, even when using C++ */
400 #ifdef __cplusplus
401 extern "C" {
402 #endif
403 
404 #ifdef HAVE_ALLOCA
405 #define SDL_stack_alloc(type, count) (type*)alloca(sizeof(type)*(count))
406 #define SDL_stack_free(data)
407 #else
408 #define SDL_stack_alloc(type, count) (type*)SDL_malloc(sizeof(type)*(count))
409 #define SDL_stack_free(data) SDL_free(data)
410 #endif
411 
412 extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
413 extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
414 extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
415 extern DECLSPEC void SDLCALL SDL_free(void *mem);
416 
417 typedef void *(SDLCALL *SDL_malloc_func)(size_t size);
418 typedef void *(SDLCALL *SDL_calloc_func)(size_t nmemb, size_t size);
419 typedef void *(SDLCALL *SDL_realloc_func)(void *mem, size_t size);
420 typedef void (SDLCALL *SDL_free_func)(void *mem);
421 
422 /**
423  * Get the current set of SDL memory functions
424  *
425  * \since This function is available since SDL 2.0.7.
426  */
427 extern DECLSPEC void SDLCALL SDL_GetMemoryFunctions(SDL_malloc_func *malloc_func,
428  SDL_calloc_func *calloc_func,
429  SDL_realloc_func *realloc_func,
430  SDL_free_func *free_func);
431 
432 /**
433  * Replace SDL's memory allocation functions with a custom set
434  *
435  * \since This function is available since SDL 2.0.7.
436  */
437 extern DECLSPEC int SDLCALL SDL_SetMemoryFunctions(SDL_malloc_func malloc_func,
438  SDL_calloc_func calloc_func,
439  SDL_realloc_func realloc_func,
440  SDL_free_func free_func);
441 
442 /**
443  * Get the number of outstanding (unfreed) allocations
444  *
445  * \since This function is available since SDL 2.0.7.
446  */
447 extern DECLSPEC int SDLCALL SDL_GetNumAllocations(void);
448 
449 extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
450 extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value, int overwrite);
451 
452 extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, int (*compare) (const void *, const void *));
453 
454 extern DECLSPEC int SDLCALL SDL_abs(int x);
455 
456 /* NOTE: these double-evaluate their arguments, so you should never have side effects in the parameters */
457 #define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
458 #define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
459 #define SDL_clamp(x, a, b) (((x) < (a)) ? (a) : (((x) > (b)) ? (b) : (x)))
460 
461 extern DECLSPEC int SDLCALL SDL_isalpha(int x);
462 extern DECLSPEC int SDLCALL SDL_isalnum(int x);
463 extern DECLSPEC int SDLCALL SDL_isblank(int x);
464 extern DECLSPEC int SDLCALL SDL_iscntrl(int x);
465 extern DECLSPEC int SDLCALL SDL_isdigit(int x);
466 extern DECLSPEC int SDLCALL SDL_isxdigit(int x);
467 extern DECLSPEC int SDLCALL SDL_ispunct(int x);
468 extern DECLSPEC int SDLCALL SDL_isspace(int x);
469 extern DECLSPEC int SDLCALL SDL_isupper(int x);
470 extern DECLSPEC int SDLCALL SDL_islower(int x);
471 extern DECLSPEC int SDLCALL SDL_isprint(int x);
472 extern DECLSPEC int SDLCALL SDL_isgraph(int x);
473 extern DECLSPEC int SDLCALL SDL_toupper(int x);
474 extern DECLSPEC int SDLCALL SDL_tolower(int x);
475 
476 extern DECLSPEC Uint32 SDLCALL SDL_crc32(Uint32 crc, const void *data, size_t len);
477 
478 extern DECLSPEC void *SDLCALL SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len);
479 
480 #define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
481 #define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
482 #define SDL_zeroa(x) SDL_memset((x), 0, sizeof((x)))
483 
484 /* Note that memset() is a byte assignment and this is a 32-bit assignment, so they're not directly equivalent. */
485 SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
486 {
487 #ifdef __APPLE__
488  memset_pattern4(dst, &val, dwords * 4);
489 #elif defined(__GNUC__) && defined(__i386__)
490  int u0, u1, u2;
491  __asm__ __volatile__ (
492  "cld \n\t"
493  "rep ; stosl \n\t"
494  : "=&D" (u0), "=&a" (u1), "=&c" (u2)
495  : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, dwords))
496  : "memory"
497  );
498 #else
499  size_t _n = (dwords + 3) / 4;
500  Uint32 *_p = SDL_static_cast(Uint32 *, dst);
501  Uint32 _val = (val);
502  if (dwords == 0) {
503  return;
504  }
505  switch (dwords % 4) {
506  case 0: do { *_p++ = _val; SDL_FALLTHROUGH;
507  case 3: *_p++ = _val; SDL_FALLTHROUGH;
508  case 2: *_p++ = _val; SDL_FALLTHROUGH;
509  case 1: *_p++ = _val;
510  } while ( --_n );
511  }
512 #endif
513 }
514 
515 extern DECLSPEC void *SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
516 
517 extern DECLSPEC void *SDLCALL SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
518 extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
519 
520 extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr);
521 extern DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
522 extern DECLSPEC size_t SDLCALL SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
523 extern DECLSPEC wchar_t *SDLCALL SDL_wcsdup(const wchar_t *wstr);
524 extern DECLSPEC wchar_t *SDLCALL SDL_wcsstr(const wchar_t *haystack, const wchar_t *needle);
525 
526 extern DECLSPEC int SDLCALL SDL_wcscmp(const wchar_t *str1, const wchar_t *str2);
527 extern DECLSPEC int SDLCALL SDL_wcsncmp(const wchar_t *str1, const wchar_t *str2, size_t maxlen);
528 extern DECLSPEC int SDLCALL SDL_wcscasecmp(const wchar_t *str1, const wchar_t *str2);
529 extern DECLSPEC int SDLCALL SDL_wcsncasecmp(const wchar_t *str1, const wchar_t *str2, size_t len);
530 
531 extern DECLSPEC size_t SDLCALL SDL_strlen(const char *str);
532 extern DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
533 extern DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes);
534 extern DECLSPEC size_t SDLCALL SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
535 extern DECLSPEC char *SDLCALL SDL_strdup(const char *str);
536 extern DECLSPEC char *SDLCALL SDL_strrev(char *str);
537 extern DECLSPEC char *SDLCALL SDL_strupr(char *str);
538 extern DECLSPEC char *SDLCALL SDL_strlwr(char *str);
539 extern DECLSPEC char *SDLCALL SDL_strchr(const char *str, int c);
540 extern DECLSPEC char *SDLCALL SDL_strrchr(const char *str, int c);
541 extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack, const char *needle);
542 extern DECLSPEC char *SDLCALL SDL_strtokr(char *s1, const char *s2, char **saveptr);
543 extern DECLSPEC size_t SDLCALL SDL_utf8strlen(const char *str);
544 
545 extern DECLSPEC char *SDLCALL SDL_itoa(int value, char *str, int radix);
546 extern DECLSPEC char *SDLCALL SDL_uitoa(unsigned int value, char *str, int radix);
547 extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *str, int radix);
548 extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *str, int radix);
549 extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *str, int radix);
550 extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *str, int radix);
551 
552 extern DECLSPEC int SDLCALL SDL_atoi(const char *str);
553 extern DECLSPEC double SDLCALL SDL_atof(const char *str);
554 extern DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base);
555 extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base);
556 extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *str, char **endp, int base);
557 extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *str, char **endp, int base);
558 extern DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp);
559 
560 extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
561 extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
562 extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
563 extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t len);
564 
565 extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, ...) SDL_SCANF_VARARG_FUNC(2);
566 extern DECLSPEC int SDLCALL SDL_vsscanf(const char *text, const char *fmt, va_list ap);
567 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);
568 extern DECLSPEC int SDLCALL SDL_vsnprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, va_list ap);
569 extern DECLSPEC int SDLCALL SDL_asprintf(char **strp, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2);
570 extern DECLSPEC int SDLCALL SDL_vasprintf(char **strp, const char *fmt, va_list ap);
571 
572 #ifndef HAVE_M_PI
573 #ifndef M_PI
574 #define M_PI 3.14159265358979323846264338327950288 /**< pi */
575 #endif
576 #endif
577 
578 /**
579  * Use this function to compute arc cosine of `x`.
580  *
581  * The definition of `y = acos(x)` is `x = cos(y)`.
582  *
583  * Domain: `-1 <= x <= 1`
584  *
585  * Range: `0 <= y <= Pi`
586  *
587  * \param x floating point value, in radians.
588  * \returns arc cosine of `x`.
589  *
590  * \since This function is available since SDL 2.0.2.
591  */
592 extern DECLSPEC double SDLCALL SDL_acos(double x);
593 extern DECLSPEC float SDLCALL SDL_acosf(float x);
594 extern DECLSPEC double SDLCALL SDL_asin(double x);
595 extern DECLSPEC float SDLCALL SDL_asinf(float x);
596 extern DECLSPEC double SDLCALL SDL_atan(double x);
597 extern DECLSPEC float SDLCALL SDL_atanf(float x);
598 extern DECLSPEC double SDLCALL SDL_atan2(double y, double x);
599 extern DECLSPEC float SDLCALL SDL_atan2f(float y, float x);
600 extern DECLSPEC double SDLCALL SDL_ceil(double x);
601 extern DECLSPEC float SDLCALL SDL_ceilf(float x);
602 extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
603 extern DECLSPEC float SDLCALL SDL_copysignf(float x, float y);
604 extern DECLSPEC double SDLCALL SDL_cos(double x);
605 extern DECLSPEC float SDLCALL SDL_cosf(float x);
606 extern DECLSPEC double SDLCALL SDL_exp(double x);
607 extern DECLSPEC float SDLCALL SDL_expf(float x);
608 extern DECLSPEC double SDLCALL SDL_fabs(double x);
609 extern DECLSPEC float SDLCALL SDL_fabsf(float x);
610 extern DECLSPEC double SDLCALL SDL_floor(double x);
611 extern DECLSPEC float SDLCALL SDL_floorf(float x);
612 extern DECLSPEC double SDLCALL SDL_trunc(double x);
613 extern DECLSPEC float SDLCALL SDL_truncf(float x);
614 extern DECLSPEC double SDLCALL SDL_fmod(double x, double y);
615 extern DECLSPEC float SDLCALL SDL_fmodf(float x, float y);
616 extern DECLSPEC double SDLCALL SDL_log(double x);
617 extern DECLSPEC float SDLCALL SDL_logf(float x);
618 extern DECLSPEC double SDLCALL SDL_log10(double x);
619 extern DECLSPEC float SDLCALL SDL_log10f(float x);
620 extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
621 extern DECLSPEC float SDLCALL SDL_powf(float x, float y);
622 extern DECLSPEC double SDLCALL SDL_round(double x);
623 extern DECLSPEC float SDLCALL SDL_roundf(float x);
624 extern DECLSPEC long SDLCALL SDL_lround(double x);
625 extern DECLSPEC long SDLCALL SDL_lroundf(float x);
626 extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
627 extern DECLSPEC float SDLCALL SDL_scalbnf(float x, int n);
628 extern DECLSPEC double SDLCALL SDL_sin(double x);
629 extern DECLSPEC float SDLCALL SDL_sinf(float x);
630 extern DECLSPEC double SDLCALL SDL_sqrt(double x);
631 extern DECLSPEC float SDLCALL SDL_sqrtf(float x);
632 extern DECLSPEC double SDLCALL SDL_tan(double x);
633 extern DECLSPEC float SDLCALL SDL_tanf(float x);
634 
635 /* The SDL implementation of iconv() returns these error codes */
636 #define SDL_ICONV_ERROR (size_t)-1
637 #define SDL_ICONV_E2BIG (size_t)-2
638 #define SDL_ICONV_EILSEQ (size_t)-3
639 #define SDL_ICONV_EINVAL (size_t)-4
640 
641 /* SDL_iconv_* are now always real symbols/types, not macros or inlined. */
642 typedef struct _SDL_iconv_t *SDL_iconv_t;
643 extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
644  const char *fromcode);
645 extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
646 extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
647  size_t * inbytesleft, char **outbuf,
648  size_t * outbytesleft);
649 
650 /**
651  * This function converts a string between encodings in one pass, returning a
652  * string that must be freed with SDL_free() or NULL on error.
653  *
654  * \since This function is available since SDL 2.0.0.
655  */
656 extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
657  const char *fromcode,
658  const char *inbuf,
659  size_t inbytesleft);
660 #define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
661 #define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
662 #define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4-INTERNAL", "UTF-8", S, SDL_strlen(S)+1)
663 #define SDL_iconv_wchar_utf8(S) SDL_iconv_string("UTF-8", "WCHAR_T", (char *)S, (SDL_wcslen(S)+1)*sizeof(wchar_t))
664 
665 /* force builds using Clang's static analysis tools to use literal C runtime
666  here, since there are possibly tests that are ineffective otherwise. */
667 #if defined(__clang_analyzer__) && !defined(SDL_DISABLE_ANALYZE_MACROS)
668 
669 /* The analyzer knows about strlcpy even when the system doesn't provide it */
670 #ifndef HAVE_STRLCPY
671 size_t strlcpy(char* dst, const char* src, size_t size);
672 #endif
673 
674 /* The analyzer knows about strlcat even when the system doesn't provide it */
675 #ifndef HAVE_STRLCAT
676 size_t strlcat(char* dst, const char* src, size_t size);
677 #endif
678 
679 #define SDL_malloc malloc
680 #define SDL_calloc calloc
681 #define SDL_realloc realloc
682 #define SDL_free free
683 #define SDL_memset memset
684 #define SDL_memcpy memcpy
685 #define SDL_memmove memmove
686 #define SDL_memcmp memcmp
687 #define SDL_strlcpy strlcpy
688 #define SDL_strlcat strlcat
689 #define SDL_strlen strlen
690 #define SDL_wcslen wcslen
691 #define SDL_wcslcpy wcslcpy
692 #define SDL_wcslcat wcslcat
693 #define SDL_strdup strdup
694 #define SDL_wcsdup wcsdup
695 #define SDL_strchr strchr
696 #define SDL_strrchr strrchr
697 #define SDL_strstr strstr
698 #define SDL_wcsstr wcsstr
699 #define SDL_strtokr strtok_r
700 #define SDL_strcmp strcmp
701 #define SDL_wcscmp wcscmp
702 #define SDL_strncmp strncmp
703 #define SDL_wcsncmp wcsncmp
704 #define SDL_strcasecmp strcasecmp
705 #define SDL_strncasecmp strncasecmp
706 #define SDL_sscanf sscanf
707 #define SDL_vsscanf vsscanf
708 #define SDL_snprintf snprintf
709 #define SDL_vsnprintf vsnprintf
710 #endif
711 
712 SDL_FORCE_INLINE void *SDL_memcpy4(SDL_OUT_BYTECAP(dwords*4) void *dst, SDL_IN_BYTECAP(dwords*4) const void *src, size_t dwords)
713 {
714  return SDL_memcpy(dst, src, dwords * 4);
715 }
716 
717 /* Ends C function definitions when using C++ */
718 #ifdef __cplusplus
719 }
720 #endif
721 #include "close_code.h"
722 
723 #endif /* SDL_stdinc_h_ */
724 
725 /* 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:712
float SDL_tanf(float x)
SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
Definition: SDL_stdinc.h:485
int SDL_isspace(int x)
int SDL_isalnum(int x)
int SDL_tolower(int x)
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:420
float SDL_ceilf(float x)
int64_t Sint64
Definition: SDL_stdinc.h:227
#define SDL_OUT_BYTECAP(x)
Definition: SDL_stdinc.h:343
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:642
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:419
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:339
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:346
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:340
double SDL_scalbn(double x, int n)
void *(* SDL_malloc_func)(size_t size)
Definition: SDL_stdinc.h:417
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:345
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:352
#define SDL_COMPILE_TIME_ASSERT(name, x)
Definition: SDL_stdinc.h:362
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:353
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:418
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:341
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