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__)
110void *alloca(unsigned);
111# else
112void *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
184typedef int SDL_bool;
185#else
186typedef 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 */
196typedef 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 */
203typedef 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 */
210typedef 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 */
217typedef 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 */
224typedef 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 */
231typedef 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 */
238typedef 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 */
245typedef 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
412SDL_COMPILE_TIME_ASSERT(uint8, sizeof(Uint8) == 1);
413SDL_COMPILE_TIME_ASSERT(sint8, sizeof(Sint8) == 1);
414SDL_COMPILE_TIME_ASSERT(uint16, sizeof(Uint16) == 2);
415SDL_COMPILE_TIME_ASSERT(sint16, sizeof(Sint16) == 2);
416SDL_COMPILE_TIME_ASSERT(uint32, sizeof(Uint32) == 4);
417SDL_COMPILE_TIME_ASSERT(sint32, sizeof(Sint32) == 4);
418SDL_COMPILE_TIME_ASSERT(uint64, sizeof(Uint64) == 8);
419SDL_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 */
433typedef enum
434{
435 DUMMY_ENUM_VALUE
436} SDL_DUMMY_ENUM;
437
438SDL_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
446extern "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
457extern DECLSPEC void *SDLCALL SDL_malloc(size_t size);
458extern DECLSPEC void *SDLCALL SDL_calloc(size_t nmemb, size_t size);
459extern DECLSPEC void *SDLCALL SDL_realloc(void *mem, size_t size);
460extern DECLSPEC void SDLCALL SDL_free(void *mem);
461
462typedef void *(SDLCALL *SDL_malloc_func)(size_t size);
463typedef void *(SDLCALL *SDL_calloc_func)(size_t nmemb, size_t size);
464typedef void *(SDLCALL *SDL_realloc_func)(void *mem, size_t size);
465typedef void (SDLCALL *SDL_free_func)(void *mem);
466
467/**
468 * Get the original set of SDL memory functions
469 *
470 * \param malloc_func filled with malloc function.
471 * \param calloc_func filled with calloc function.
472 * \param realloc_func filled with realloc function.
473 * \param free_func filled with free function.
474 *
475 * \since This function is available since SDL 2.24.0.
476 */
477extern DECLSPEC void SDLCALL SDL_GetOriginalMemoryFunctions(SDL_malloc_func *malloc_func,
478 SDL_calloc_func *calloc_func,
479 SDL_realloc_func *realloc_func,
480 SDL_free_func *free_func);
481
482/**
483 * Get the current set of SDL memory functions
484 *
485 * \param malloc_func filled with malloc function.
486 * \param calloc_func filled with calloc function.
487 * \param realloc_func filled with realloc function.
488 * \param free_func filled with free function.
489 *
490 * \since This function is available since SDL 2.0.7.
491 */
492extern DECLSPEC void SDLCALL SDL_GetMemoryFunctions(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 * Replace SDL's memory allocation functions with a custom set
499 *
500 * \param malloc_func custom malloc function.
501 * \param calloc_func custom calloc function.
502 * \param realloc_func custom realloc function.
503 * \param free_func custom free function.
504 * \returns 0 on success or -1 on failure; call SDL_GetError() for more
505 * information.
506 *
507 * \since This function is available since SDL 2.0.7.
508 */
509extern DECLSPEC int SDLCALL SDL_SetMemoryFunctions(SDL_malloc_func malloc_func,
510 SDL_calloc_func calloc_func,
511 SDL_realloc_func realloc_func,
512 SDL_free_func free_func);
513
514/**
515 * Get the number of outstanding (unfreed) allocations
516 *
517 * \returns number of unfreed allocations.
518 *
519 * \since This function is available since SDL 2.0.7.
520 */
521extern DECLSPEC int SDLCALL SDL_GetNumAllocations(void);
522
523extern DECLSPEC char *SDLCALL SDL_getenv(const char *name);
524extern DECLSPEC int SDLCALL SDL_setenv(const char *name, const char *value, int overwrite);
525
526typedef int (SDLCALL *SDL_CompareCallback)(const void *, const void *);
527extern DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, SDL_CompareCallback compare);
528extern DECLSPEC void * SDLCALL SDL_bsearch(const void *key, const void *base, size_t nmemb, size_t size, SDL_CompareCallback compare);
529
530extern DECLSPEC int SDLCALL SDL_abs(int x);
531
532/* NOTE: these double-evaluate their arguments, so you should never have side effects in the parameters */
533#define SDL_min(x, y) (((x) < (y)) ? (x) : (y))
534#define SDL_max(x, y) (((x) > (y)) ? (x) : (y))
535#define SDL_clamp(x, a, b) (((x) < (a)) ? (a) : (((x) > (b)) ? (b) : (x)))
536
537extern DECLSPEC int SDLCALL SDL_isalpha(int x);
538extern DECLSPEC int SDLCALL SDL_isalnum(int x);
539extern DECLSPEC int SDLCALL SDL_isblank(int x);
540extern DECLSPEC int SDLCALL SDL_iscntrl(int x);
541extern DECLSPEC int SDLCALL SDL_isdigit(int x);
542extern DECLSPEC int SDLCALL SDL_isxdigit(int x);
543extern DECLSPEC int SDLCALL SDL_ispunct(int x);
544extern DECLSPEC int SDLCALL SDL_isspace(int x);
545extern DECLSPEC int SDLCALL SDL_isupper(int x);
546extern DECLSPEC int SDLCALL SDL_islower(int x);
547extern DECLSPEC int SDLCALL SDL_isprint(int x);
548extern DECLSPEC int SDLCALL SDL_isgraph(int x);
549extern DECLSPEC int SDLCALL SDL_toupper(int x);
550extern DECLSPEC int SDLCALL SDL_tolower(int x);
551
552extern DECLSPEC Uint16 SDLCALL SDL_crc16(Uint16 crc, const void *data, size_t len);
553extern DECLSPEC Uint32 SDLCALL SDL_crc32(Uint32 crc, const void *data, size_t len);
554
555extern DECLSPEC void *SDLCALL SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len);
556
557/* Some safe(r) macros for zero'ing structures... */
558#define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x)))
559#define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x)))
560#define SDL_zeroa(x) SDL_memset((x), 0, sizeof((x)))
561
562#define SDL_copyp(dst, src) \
563 { SDL_COMPILE_TIME_ASSERT(SDL_copyp, sizeof (*(dst)) == sizeof (*(src))); } \
564 SDL_memcpy((dst), (src), sizeof (*(src)))
565
566
567/* Note that memset() is a byte assignment and this is a 32-bit assignment, so they're not directly equivalent. */
568SDL_FORCE_INLINE void SDL_memset4(void *dst, Uint32 val, size_t dwords)
569{
570#if defined(__GNUC__) && defined(__i386__)
571 int u0, u1, u2;
572 __asm__ __volatile__ (
573 "cld \n\t"
574 "rep ; stosl \n\t"
575 : "=&D" (u0), "=&a" (u1), "=&c" (u2)
576 : "0" (dst), "1" (val), "2" (SDL_static_cast(Uint32, dwords))
577 : "memory"
578 );
579#else
580 size_t _n = (dwords + 3) / 4;
581 Uint32 *_p = SDL_static_cast(Uint32 *, dst);
582 Uint32 _val = (val);
583 if (dwords == 0) {
584 return;
585 }
586 switch (dwords % 4) {
587 default:
588 case 0: do { *_p++ = _val; SDL_FALLTHROUGH;
589 case 3: *_p++ = _val; SDL_FALLTHROUGH;
590 case 2: *_p++ = _val; SDL_FALLTHROUGH;
591 case 1: *_p++ = _val;
592 } while ( --_n );
593 }
594#endif
595}
596
597extern DECLSPEC void *SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
598
599extern DECLSPEC void *SDLCALL SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len);
600extern DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len);
601
602extern DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr);
603extern DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
604extern DECLSPEC size_t SDLCALL SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen);
605extern DECLSPEC wchar_t *SDLCALL SDL_wcsdup(const wchar_t *wstr);
606extern DECLSPEC wchar_t *SDLCALL SDL_wcsstr(const wchar_t *haystack, const wchar_t *needle);
607
608extern DECLSPEC int SDLCALL SDL_wcscmp(const wchar_t *str1, const wchar_t *str2);
609extern DECLSPEC int SDLCALL SDL_wcsncmp(const wchar_t *str1, const wchar_t *str2, size_t maxlen);
610extern DECLSPEC int SDLCALL SDL_wcscasecmp(const wchar_t *str1, const wchar_t *str2);
611extern DECLSPEC int SDLCALL SDL_wcsncasecmp(const wchar_t *str1, const wchar_t *str2, size_t len);
612
613extern DECLSPEC size_t SDLCALL SDL_strlen(const char *str);
614extern DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
615extern DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes);
616extern DECLSPEC size_t SDLCALL SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
617extern DECLSPEC char *SDLCALL SDL_strdup(const char *str);
618extern DECLSPEC char *SDLCALL SDL_strrev(char *str);
619extern DECLSPEC char *SDLCALL SDL_strupr(char *str);
620extern DECLSPEC char *SDLCALL SDL_strlwr(char *str);
621extern DECLSPEC char *SDLCALL SDL_strchr(const char *str, int c);
622extern DECLSPEC char *SDLCALL SDL_strrchr(const char *str, int c);
623extern DECLSPEC char *SDLCALL SDL_strstr(const char *haystack, const char *needle);
624extern DECLSPEC char *SDLCALL SDL_strcasestr(const char *haystack, const char *needle);
625extern DECLSPEC char *SDLCALL SDL_strtokr(char *s1, const char *s2, char **saveptr);
626extern DECLSPEC size_t SDLCALL SDL_utf8strlen(const char *str);
627extern DECLSPEC size_t SDLCALL SDL_utf8strnlen(const char *str, size_t bytes);
628
629extern DECLSPEC char *SDLCALL SDL_itoa(int value, char *str, int radix);
630extern DECLSPEC char *SDLCALL SDL_uitoa(unsigned int value, char *str, int radix);
631extern DECLSPEC char *SDLCALL SDL_ltoa(long value, char *str, int radix);
632extern DECLSPEC char *SDLCALL SDL_ultoa(unsigned long value, char *str, int radix);
633extern DECLSPEC char *SDLCALL SDL_lltoa(Sint64 value, char *str, int radix);
634extern DECLSPEC char *SDLCALL SDL_ulltoa(Uint64 value, char *str, int radix);
635
636extern DECLSPEC int SDLCALL SDL_atoi(const char *str);
637extern DECLSPEC double SDLCALL SDL_atof(const char *str);
638extern DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base);
639extern DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base);
640extern DECLSPEC Sint64 SDLCALL SDL_strtoll(const char *str, char **endp, int base);
641extern DECLSPEC Uint64 SDLCALL SDL_strtoull(const char *str, char **endp, int base);
642extern DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp);
643
644extern DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2);
645extern DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen);
646extern DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2);
647extern DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t len);
648
649extern DECLSPEC int SDLCALL SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, ...) SDL_SCANF_VARARG_FUNC(2);
650extern DECLSPEC int SDLCALL SDL_vsscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, va_list ap) SDL_SCANF_VARARG_FUNCV(2);
651extern 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);
652extern 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);
653extern DECLSPEC int SDLCALL SDL_asprintf(char **strp, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2);
654extern DECLSPEC int SDLCALL SDL_vasprintf(char **strp, SDL_PRINTF_FORMAT_STRING const char *fmt, va_list ap) SDL_PRINTF_VARARG_FUNCV(2);
655
656#ifndef HAVE_M_PI
657#ifndef M_PI
658#define M_PI 3.14159265358979323846264338327950288 /**< pi */
659#endif
660#endif
661
662/**
663 * Use this function to compute arc cosine of `x`.
664 *
665 * The definition of `y = acos(x)` is `x = cos(y)`.
666 *
667 * Domain: `-1 <= x <= 1`
668 *
669 * Range: `0 <= y <= Pi`
670 *
671 * \param x floating point value, in radians.
672 * \returns arc cosine of `x`.
673 *
674 * \since This function is available since SDL 2.0.2.
675 */
676extern DECLSPEC double SDLCALL SDL_acos(double x);
677extern DECLSPEC float SDLCALL SDL_acosf(float x);
678extern DECLSPEC double SDLCALL SDL_asin(double x);
679extern DECLSPEC float SDLCALL SDL_asinf(float x);
680extern DECLSPEC double SDLCALL SDL_atan(double x);
681extern DECLSPEC float SDLCALL SDL_atanf(float x);
682extern DECLSPEC double SDLCALL SDL_atan2(double y, double x);
683extern DECLSPEC float SDLCALL SDL_atan2f(float y, float x);
684extern DECLSPEC double SDLCALL SDL_ceil(double x);
685extern DECLSPEC float SDLCALL SDL_ceilf(float x);
686extern DECLSPEC double SDLCALL SDL_copysign(double x, double y);
687extern DECLSPEC float SDLCALL SDL_copysignf(float x, float y);
688extern DECLSPEC double SDLCALL SDL_cos(double x);
689extern DECLSPEC float SDLCALL SDL_cosf(float x);
690extern DECLSPEC double SDLCALL SDL_exp(double x);
691extern DECLSPEC float SDLCALL SDL_expf(float x);
692extern DECLSPEC double SDLCALL SDL_fabs(double x);
693extern DECLSPEC float SDLCALL SDL_fabsf(float x);
694extern DECLSPEC double SDLCALL SDL_floor(double x);
695extern DECLSPEC float SDLCALL SDL_floorf(float x);
696extern DECLSPEC double SDLCALL SDL_trunc(double x);
697extern DECLSPEC float SDLCALL SDL_truncf(float x);
698extern DECLSPEC double SDLCALL SDL_fmod(double x, double y);
699extern DECLSPEC float SDLCALL SDL_fmodf(float x, float y);
700extern DECLSPEC double SDLCALL SDL_log(double x);
701extern DECLSPEC float SDLCALL SDL_logf(float x);
702extern DECLSPEC double SDLCALL SDL_log10(double x);
703extern DECLSPEC float SDLCALL SDL_log10f(float x);
704extern DECLSPEC double SDLCALL SDL_pow(double x, double y);
705extern DECLSPEC float SDLCALL SDL_powf(float x, float y);
706extern DECLSPEC double SDLCALL SDL_round(double x);
707extern DECLSPEC float SDLCALL SDL_roundf(float x);
708extern DECLSPEC long SDLCALL SDL_lround(double x);
709extern DECLSPEC long SDLCALL SDL_lroundf(float x);
710extern DECLSPEC double SDLCALL SDL_scalbn(double x, int n);
711extern DECLSPEC float SDLCALL SDL_scalbnf(float x, int n);
712extern DECLSPEC double SDLCALL SDL_sin(double x);
713extern DECLSPEC float SDLCALL SDL_sinf(float x);
714extern DECLSPEC double SDLCALL SDL_sqrt(double x);
715extern DECLSPEC float SDLCALL SDL_sqrtf(float x);
716extern DECLSPEC double SDLCALL SDL_tan(double x);
717extern DECLSPEC float SDLCALL SDL_tanf(float x);
718
719/* The SDL implementation of iconv() returns these error codes */
720#define SDL_ICONV_ERROR (size_t)-1
721#define SDL_ICONV_E2BIG (size_t)-2
722#define SDL_ICONV_EILSEQ (size_t)-3
723#define SDL_ICONV_EINVAL (size_t)-4
724
725/* SDL_iconv_* are now always real symbols/types, not macros or inlined. */
726typedef struct _SDL_iconv_t *SDL_iconv_t;
727extern DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode,
728 const char *fromcode);
729extern DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd);
730extern DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf,
731 size_t * inbytesleft, char **outbuf,
732 size_t * outbytesleft);
733
734/**
735 * This function converts a buffer or string between encodings in one pass,
736 * returning a string that must be freed with SDL_free() or NULL on error.
737 *
738 * \param tocode the character encoding of the output string.
739 * \param fromcode the character encoding of data in `inbuf`.
740 * \param inbuf the string to convert to a different encoding.
741 * \param inbytesleft the size of the input string _in bytes_.
742 * \returns a new string, converted to the new encoding, or NULL on error.
743 *
744 * \since This function is available since SDL 2.0.0.
745 */
746extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
747 const char *fromcode,
748 const char *inbuf,
749 size_t inbytesleft);
750
751/* Some helper macros for common cases... */
752#define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
753#define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2", "UTF-8", S, SDL_strlen(S)+1)
754#define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4", "UTF-8", S, SDL_strlen(S)+1)
755#define SDL_iconv_wchar_utf8(S) SDL_iconv_string("UTF-8", "WCHAR_T", (char *)S, (SDL_wcslen(S)+1)*sizeof(wchar_t))
756
757/* force builds using Clang's static analysis tools to use literal C runtime
758 here, since there are possibly tests that are ineffective otherwise. */
759#if defined(__clang_analyzer__) && !defined(SDL_DISABLE_ANALYZE_MACROS)
760
761/* The analyzer knows about strlcpy even when the system doesn't provide it */
762#ifndef HAVE_STRLCPY
763size_t strlcpy(char* dst, const char* src, size_t size);
764#endif
765
766/* The analyzer knows about strlcat even when the system doesn't provide it */
767#ifndef HAVE_STRLCAT
768size_t strlcat(char* dst, const char* src, size_t size);
769#endif
770
771#ifndef HAVE_WCSLCPY
772size_t wcslcpy(wchar_t *dst, const wchar_t *src, size_t size);
773#endif
774
775#ifndef HAVE_WCSLCAT
776size_t wcslcat(wchar_t *dst, const wchar_t *src, size_t size);
777#endif
778
779#ifndef _WIN32
780/* strdup is not ANSI but POSIX, and its prototype might be hidden... */
781/* not for windows: might conflict with string.h where strdup may have
782 * dllimport attribute: https://github.com/libsdl-org/SDL/issues/12948 */
783char *strdup(const char *str);
784#endif
785
786/* Starting LLVM 16, the analyser errors out if these functions do not have
787 their prototype defined (clang-diagnostic-implicit-function-declaration) */
788#include <stdlib.h>
789#include <string.h>
790#include <stdio.h>
791
792#define SDL_malloc malloc
793#define SDL_calloc calloc
794#define SDL_realloc realloc
795#define SDL_free free
796#define SDL_memset memset
797#define SDL_memcpy memcpy
798#define SDL_memmove memmove
799#define SDL_memcmp memcmp
800#define SDL_strlcpy strlcpy
801#define SDL_strlcat strlcat
802#define SDL_strlen strlen
803#define SDL_wcslen wcslen
804#define SDL_wcslcpy wcslcpy
805#define SDL_wcslcat wcslcat
806#define SDL_strdup strdup
807#define SDL_wcsdup wcsdup
808#define SDL_strchr strchr
809#define SDL_strrchr strrchr
810#define SDL_strstr strstr
811#define SDL_wcsstr wcsstr
812#define SDL_strtokr strtok_r
813#define SDL_strcmp strcmp
814#define SDL_wcscmp wcscmp
815#define SDL_strncmp strncmp
816#define SDL_wcsncmp wcsncmp
817#define SDL_strcasecmp strcasecmp
818#define SDL_strncasecmp strncasecmp
819#define SDL_sscanf sscanf
820#define SDL_vsscanf vsscanf
821#define SDL_snprintf snprintf
822#define SDL_vsnprintf vsnprintf
823#endif
824
825SDL_FORCE_INLINE void *SDL_memcpy4(SDL_OUT_BYTECAP(dwords*4) void *dst, SDL_IN_BYTECAP(dwords*4) const void *src, size_t dwords)
826{
827 return SDL_memcpy(dst, src, len: dwords * 4);
828}
829
830/**
831 * If a * b would overflow, return -1.
832 *
833 * Otherwise store a * b via ret and return 0.
834 *
835 * \param a the multiplicand.
836 * \param b the multiplier.
837 * \param ret on non-overflow output, stores the multiplication result.
838 * \returns -1 on overflow, 0 if result is multiplied without overflow.
839 *
840 * \since This function is available since SDL 2.24.0.
841 */
842SDL_FORCE_INLINE int SDL_size_mul_overflow (size_t a,
843 size_t b,
844 size_t *ret)
845{
846 if (a != 0 && b > SDL_SIZE_MAX / a) {
847 return -1;
848 }
849 *ret = a * b;
850 return 0;
851}
852
853#if _SDL_HAS_BUILTIN(__builtin_mul_overflow)
854/* This needs to be wrapped in an inline rather than being a direct #define,
855 * because __builtin_mul_overflow() is type-generic, but we want to be
856 * consistent about interpreting a and b as size_t. */
857SDL_FORCE_INLINE int _SDL_size_mul_overflow_builtin (size_t a,
858 size_t b,
859 size_t *ret)
860{
861 return __builtin_mul_overflow(a, b, ret) == 0 ? 0 : -1;
862}
863#define SDL_size_mul_overflow(a, b, ret) (_SDL_size_mul_overflow_builtin(a, b, ret))
864#endif
865
866/**
867 * If a + b would overflow, return -1.
868 *
869 * Otherwise store a + b via ret and return 0.
870 *
871 * \param a the first addend.
872 * \param b the second addend.
873 * \param ret on non-overflow output, stores the addition result.
874 * \returns false on overflow, true if result is added without overflow.
875 *
876 * \since This function is available since SDL 2.24.0.
877 */
878SDL_FORCE_INLINE int SDL_size_add_overflow (size_t a,
879 size_t b,
880 size_t *ret)
881{
882 if (b > SDL_SIZE_MAX - a) {
883 return -1;
884 }
885 *ret = a + b;
886 return 0;
887}
888
889#if _SDL_HAS_BUILTIN(__builtin_add_overflow)
890/* This needs to be wrapped in an inline rather than being a direct #define,
891 * the same as the call to __builtin_mul_overflow() above. */
892SDL_FORCE_INLINE int _SDL_size_add_overflow_builtin (size_t a,
893 size_t b,
894 size_t *ret)
895{
896 return __builtin_add_overflow(a, b, ret) == 0 ? 0 : -1;
897}
898#define SDL_size_add_overflow(a, b, ret) (_SDL_size_add_overflow_builtin(a, b, ret))
899#endif
900
901/* Ends C function definitions when using C++ */
902#ifdef __cplusplus
903}
904#endif
905#include "close_code.h"
906
907#endif /* SDL_stdinc_h_ */
908
909/* vi: set ts=4 sw=4 expandtab: */
910