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