diff options
Diffstat (limited to 'src/contrib/SDL-3.2.20/include/SDL3/SDL_stdinc.h')
-rw-r--r-- | src/contrib/SDL-3.2.20/include/SDL3/SDL_stdinc.h | 6137 |
1 files changed, 6137 insertions, 0 deletions
diff --git a/src/contrib/SDL-3.2.20/include/SDL3/SDL_stdinc.h b/src/contrib/SDL-3.2.20/include/SDL3/SDL_stdinc.h new file mode 100644 index 0000000..7df253f --- /dev/null +++ b/src/contrib/SDL-3.2.20/include/SDL3/SDL_stdinc.h | |||
@@ -0,0 +1,6137 @@ | |||
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 | /** | ||
23 | * # CategoryStdinc | ||
24 | * | ||
25 | * SDL provides its own implementation of some of the most important C runtime | ||
26 | * functions. | ||
27 | * | ||
28 | * Using these functions allows an app to have access to common C | ||
29 | * functionality without depending on a specific C runtime (or a C runtime at | ||
30 | * all). More importantly, the SDL implementations work identically across | ||
31 | * platforms, so apps can avoid surprises like snprintf() behaving differently | ||
32 | * between Windows and Linux builds, or itoa() only existing on some | ||
33 | * platforms. | ||
34 | * | ||
35 | * For many of the most common functions, like SDL_memcpy, SDL might just call | ||
36 | * through to the usual C runtime behind the scenes, if it makes sense to do | ||
37 | * so (if it's faster and always available/reliable on a given platform), | ||
38 | * reducing library size and offering the most optimized option. | ||
39 | * | ||
40 | * SDL also offers other C-runtime-adjacent functionality in this header that | ||
41 | * either isn't, strictly speaking, part of any C runtime standards, like | ||
42 | * SDL_crc32() and SDL_reinterpret_cast, etc. It also offers a few better | ||
43 | * options, like SDL_strlcpy(), which functions as a safer form of strcpy(). | ||
44 | */ | ||
45 | |||
46 | #ifndef SDL_stdinc_h_ | ||
47 | #define SDL_stdinc_h_ | ||
48 | |||
49 | #include <SDL3/SDL_platform_defines.h> | ||
50 | |||
51 | #include <stdarg.h> | ||
52 | #include <stdint.h> | ||
53 | #include <string.h> | ||
54 | #include <wchar.h> | ||
55 | |||
56 | #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \ | ||
57 | defined(SDL_INCLUDE_INTTYPES_H) | ||
58 | #include <inttypes.h> | ||
59 | #endif | ||
60 | |||
61 | #ifndef __cplusplus | ||
62 | #if defined(__has_include) && !defined(SDL_INCLUDE_STDBOOL_H) | ||
63 | #if __has_include(<stdbool.h>) | ||
64 | #define SDL_INCLUDE_STDBOOL_H | ||
65 | #endif | ||
66 | #endif | ||
67 | #if (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L) || \ | ||
68 | (defined(_MSC_VER) && (_MSC_VER >= 1910 /* Visual Studio 2017 */)) || \ | ||
69 | defined(SDL_INCLUDE_STDBOOL_H) | ||
70 | #include <stdbool.h> | ||
71 | #elif !defined(__bool_true_false_are_defined) && !defined(bool) | ||
72 | #define bool unsigned char | ||
73 | #define false 0 | ||
74 | #define true 1 | ||
75 | #define __bool_true_false_are_defined 1 | ||
76 | #endif | ||
77 | #endif /* !__cplusplus */ | ||
78 | |||
79 | #ifndef SDL_DISABLE_ALLOCA | ||
80 | # ifndef alloca | ||
81 | # ifdef HAVE_ALLOCA_H | ||
82 | # include <alloca.h> | ||
83 | # elif defined(SDL_PLATFORM_NETBSD) | ||
84 | # if defined(__STRICT_ANSI__) | ||
85 | # define SDL_DISABLE_ALLOCA | ||
86 | # else | ||
87 | # include <stdlib.h> | ||
88 | # endif | ||
89 | # elif defined(__GNUC__) | ||
90 | # define alloca __builtin_alloca | ||
91 | # elif defined(_MSC_VER) | ||
92 | # include <malloc.h> | ||
93 | # define alloca _alloca | ||
94 | # elif defined(__WATCOMC__) | ||
95 | # include <malloc.h> | ||
96 | # elif defined(__BORLANDC__) | ||
97 | # include <malloc.h> | ||
98 | # elif defined(__DMC__) | ||
99 | # include <stdlib.h> | ||
100 | # elif defined(SDL_PLATFORM_AIX) | ||
101 | # pragma alloca | ||
102 | # elif defined(__MRC__) | ||
103 | void *alloca(unsigned); | ||
104 | # else | ||
105 | void *alloca(size_t); | ||
106 | # endif | ||
107 | # endif | ||
108 | #endif | ||
109 | |||
110 | |||
111 | #ifdef SDL_WIKI_DOCUMENTATION_SECTION | ||
112 | |||
113 | /** | ||
114 | * Don't let SDL use "long long" C types. | ||
115 | * | ||
116 | * SDL will define this if it believes the compiler doesn't understand the | ||
117 | * "long long" syntax for C datatypes. This can happen on older compilers. | ||
118 | * | ||
119 | * If _your_ compiler doesn't support "long long" but SDL doesn't know it, it | ||
120 | * is safe to define this yourself to build against the SDL headers. | ||
121 | * | ||
122 | * If this is defined, it will remove access to some C runtime support | ||
123 | * functions, like SDL_ulltoa and SDL_strtoll that refer to this datatype | ||
124 | * explicitly. The rest of SDL will still be available. | ||
125 | * | ||
126 | * SDL's own source code cannot be built with a compiler that has this | ||
127 | * defined, for various technical reasons. | ||
128 | */ | ||
129 | #define SDL_NOLONGLONG 1 | ||
130 | |||
131 | #elif defined(_MSC_VER) && (_MSC_VER < 1310) /* long long introduced in Visual Studio.NET 2003 */ | ||
132 | # define SDL_NOLONGLONG 1 | ||
133 | #endif | ||
134 | |||
135 | |||
136 | #ifdef SDL_WIKI_DOCUMENTATION_SECTION | ||
137 | |||
138 | /** | ||
139 | * The largest value that a `size_t` can hold for the target platform. | ||
140 | * | ||
141 | * `size_t` is generally the same size as a pointer in modern times, but this | ||
142 | * can get weird on very old and very esoteric machines. For example, on a | ||
143 | * 16-bit Intel 286, you might have a 32-bit "far" pointer (16-bit segment | ||
144 | * plus 16-bit offset), but `size_t` is 16 bits, because it can only deal with | ||
145 | * the offset into an individual segment. | ||
146 | * | ||
147 | * In modern times, it's generally expected to cover an entire linear address | ||
148 | * space. But be careful! | ||
149 | * | ||
150 | * \since This macro is available since SDL 3.2.0. | ||
151 | */ | ||
152 | #define SDL_SIZE_MAX SIZE_MAX | ||
153 | |||
154 | #elif defined(SIZE_MAX) | ||
155 | # define SDL_SIZE_MAX SIZE_MAX | ||
156 | #else | ||
157 | # define SDL_SIZE_MAX ((size_t) -1) | ||
158 | #endif | ||
159 | |||
160 | #ifndef SDL_COMPILE_TIME_ASSERT | ||
161 | #ifdef SDL_WIKI_DOCUMENTATION_SECTION | ||
162 | |||
163 | /** | ||
164 | * A compile-time assertion. | ||
165 | * | ||
166 | * This can check constant values _known to the compiler at build time_ for | ||
167 | * correctness, and end the compile with the error if they fail. | ||
168 | * | ||
169 | * Often times these are used to verify basic truths, like the size of a | ||
170 | * datatype is what is expected: | ||
171 | * | ||
172 | * ```c | ||
173 | * SDL_COMPILE_TIME_ASSERT(uint32_size, sizeof(Uint32) == 4); | ||
174 | * ``` | ||
175 | * | ||
176 | * The `name` parameter must be a valid C symbol, and must be unique across | ||
177 | * all compile-time asserts in the same compilation unit (one run of the | ||
178 | * compiler), or the build might fail with cryptic errors on some targets. | ||
179 | * This is used with a C language trick that works on older compilers that | ||
180 | * don't support better assertion techniques. | ||
181 | * | ||
182 | * If you need an assertion that operates at runtime, on variable data, you | ||
183 | * should try SDL_assert instead. | ||
184 | * | ||
185 | * \param name a unique identifier for this assertion. | ||
186 | * \param x the value to test. Must be a boolean value. | ||
187 | * | ||
188 | * \threadsafety This macro doesn't generate any code to run. | ||
189 | * | ||
190 | * \since This macro is available since SDL 3.2.0. | ||
191 | * | ||
192 | * \sa SDL_assert | ||
193 | */ | ||
194 | #define SDL_COMPILE_TIME_ASSERT(name, x) FailToCompileIf_x_IsFalse(x) | ||
195 | #elif defined(__cplusplus) | ||
196 | /* Keep C++ case alone: Some versions of gcc will define __STDC_VERSION__ even when compiling in C++ mode. */ | ||
197 | #if (__cplusplus >= 201103L) | ||
198 | #define SDL_COMPILE_TIME_ASSERT(name, x) static_assert(x, #x) | ||
199 | #endif | ||
200 | #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 202311L) | ||
201 | #define SDL_COMPILE_TIME_ASSERT(name, x) static_assert(x, #x) | ||
202 | #elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) | ||
203 | #define SDL_COMPILE_TIME_ASSERT(name, x) _Static_assert(x, #x) | ||
204 | #endif | ||
205 | #endif /* !SDL_COMPILE_TIME_ASSERT */ | ||
206 | |||
207 | #ifndef SDL_COMPILE_TIME_ASSERT | ||
208 | /* universal, but may trigger -Wunused-local-typedefs */ | ||
209 | #define SDL_COMPILE_TIME_ASSERT(name, x) \ | ||
210 | typedef int SDL_compile_time_assert_ ## name[(x) * 2 - 1] | ||
211 | #endif | ||
212 | |||
213 | /** | ||
214 | * The number of elements in a static array. | ||
215 | * | ||
216 | * This will compile but return incorrect results for a pointer to an array; | ||
217 | * it has to be an array the compiler knows the size of. | ||
218 | * | ||
219 | * This macro looks like it double-evaluates the argument, but it does so | ||
220 | * inside of `sizeof`, so there are no side-effects here, as expressions do | ||
221 | * not actually run any code in these cases. | ||
222 | * | ||
223 | * \since This macro is available since SDL 3.2.0. | ||
224 | */ | ||
225 | #define SDL_arraysize(array) (sizeof(array)/sizeof(array[0])) | ||
226 | |||
227 | /** | ||
228 | * Macro useful for building other macros with strings in them. | ||
229 | * | ||
230 | * For example: | ||
231 | * | ||
232 | * ```c | ||
233 | * #define LOG_ERROR(X) OutputDebugString(SDL_STRINGIFY_ARG(__FUNCTION__) ": " X "\n")` | ||
234 | * ``` | ||
235 | * | ||
236 | * \param arg the text to turn into a string literal. | ||
237 | * | ||
238 | * \since This macro is available since SDL 3.2.0. | ||
239 | */ | ||
240 | #define SDL_STRINGIFY_ARG(arg) #arg | ||
241 | |||
242 | /** | ||
243 | * \name Cast operators | ||
244 | * | ||
245 | * Use proper C++ casts when compiled as C++ to be compatible with the option | ||
246 | * -Wold-style-cast of GCC (and -Werror=old-style-cast in GCC 4.2 and above). | ||
247 | */ | ||
248 | /* @{ */ | ||
249 | |||
250 | #ifdef SDL_WIKI_DOCUMENTATION_SECTION | ||
251 | |||
252 | /** | ||
253 | * Handle a Reinterpret Cast properly whether using C or C++. | ||
254 | * | ||
255 | * If compiled as C++, this macro offers a proper C++ reinterpret_cast<>. | ||
256 | * | ||
257 | * If compiled as C, this macro does a normal C-style cast. | ||
258 | * | ||
259 | * This is helpful to avoid compiler warnings in C++. | ||
260 | * | ||
261 | * \param type the type to cast the expression to. | ||
262 | * \param expression the expression to cast to a different type. | ||
263 | * \returns `expression`, cast to `type`. | ||
264 | * | ||
265 | * \threadsafety It is safe to call this macro from any thread. | ||
266 | * | ||
267 | * \since This macro is available since SDL 3.2.0. | ||
268 | * | ||
269 | * \sa SDL_static_cast | ||
270 | * \sa SDL_const_cast | ||
271 | */ | ||
272 | #define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression) /* or `((type)(expression))` in C */ | ||
273 | |||
274 | /** | ||
275 | * Handle a Static Cast properly whether using C or C++. | ||
276 | * | ||
277 | * If compiled as C++, this macro offers a proper C++ static_cast<>. | ||
278 | * | ||
279 | * If compiled as C, this macro does a normal C-style cast. | ||
280 | * | ||
281 | * This is helpful to avoid compiler warnings in C++. | ||
282 | * | ||
283 | * \param type the type to cast the expression to. | ||
284 | * \param expression the expression to cast to a different type. | ||
285 | * \returns `expression`, cast to `type`. | ||
286 | * | ||
287 | * \threadsafety It is safe to call this macro from any thread. | ||
288 | * | ||
289 | * \since This macro is available since SDL 3.2.0. | ||
290 | * | ||
291 | * \sa SDL_reinterpret_cast | ||
292 | * \sa SDL_const_cast | ||
293 | */ | ||
294 | #define SDL_static_cast(type, expression) static_cast<type>(expression) /* or `((type)(expression))` in C */ | ||
295 | |||
296 | /** | ||
297 | * Handle a Const Cast properly whether using C or C++. | ||
298 | * | ||
299 | * If compiled as C++, this macro offers a proper C++ const_cast<>. | ||
300 | * | ||
301 | * If compiled as C, this macro does a normal C-style cast. | ||
302 | * | ||
303 | * This is helpful to avoid compiler warnings in C++. | ||
304 | * | ||
305 | * \param type the type to cast the expression to. | ||
306 | * \param expression the expression to cast to a different type. | ||
307 | * \returns `expression`, cast to `type`. | ||
308 | * | ||
309 | * \threadsafety It is safe to call this macro from any thread. | ||
310 | * | ||
311 | * \since This macro is available since SDL 3.2.0. | ||
312 | * | ||
313 | * \sa SDL_reinterpret_cast | ||
314 | * \sa SDL_static_cast | ||
315 | */ | ||
316 | #define SDL_const_cast(type, expression) const_cast<type>(expression) /* or `((type)(expression))` in C */ | ||
317 | |||
318 | #elif defined(__cplusplus) | ||
319 | #define SDL_reinterpret_cast(type, expression) reinterpret_cast<type>(expression) | ||
320 | #define SDL_static_cast(type, expression) static_cast<type>(expression) | ||
321 | #define SDL_const_cast(type, expression) const_cast<type>(expression) | ||
322 | #else | ||
323 | #define SDL_reinterpret_cast(type, expression) ((type)(expression)) | ||
324 | #define SDL_static_cast(type, expression) ((type)(expression)) | ||
325 | #define SDL_const_cast(type, expression) ((type)(expression)) | ||
326 | #endif | ||
327 | |||
328 | /* @} *//* Cast operators */ | ||
329 | |||
330 | /** | ||
331 | * Define a four character code as a Uint32. | ||
332 | * | ||
333 | * \param A the first ASCII character. | ||
334 | * \param B the second ASCII character. | ||
335 | * \param C the third ASCII character. | ||
336 | * \param D the fourth ASCII character. | ||
337 | * \returns the four characters converted into a Uint32, one character | ||
338 | * per-byte. | ||
339 | * | ||
340 | * \threadsafety It is safe to call this macro from any thread. | ||
341 | * | ||
342 | * \since This macro is available since SDL 3.2.0. | ||
343 | */ | ||
344 | #define SDL_FOURCC(A, B, C, D) \ | ||
345 | ((SDL_static_cast(Uint32, SDL_static_cast(Uint8, (A))) << 0) | \ | ||
346 | (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (B))) << 8) | \ | ||
347 | (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (C))) << 16) | \ | ||
348 | (SDL_static_cast(Uint32, SDL_static_cast(Uint8, (D))) << 24)) | ||
349 | |||
350 | #ifdef SDL_WIKI_DOCUMENTATION_SECTION | ||
351 | |||
352 | /** | ||
353 | * Append the 64 bit integer suffix to a signed integer literal. | ||
354 | * | ||
355 | * This helps compilers that might believe a integer literal larger than | ||
356 | * 0xFFFFFFFF is overflowing a 32-bit value. Use `SDL_SINT64_C(0xFFFFFFFF1)` | ||
357 | * instead of `0xFFFFFFFF1` by itself. | ||
358 | * | ||
359 | * \since This macro is available since SDL 3.2.0. | ||
360 | * | ||
361 | * \sa SDL_UINT64_C | ||
362 | */ | ||
363 | #define SDL_SINT64_C(c) c ## LL /* or whatever the current compiler uses. */ | ||
364 | |||
365 | /** | ||
366 | * Append the 64 bit integer suffix to an unsigned integer literal. | ||
367 | * | ||
368 | * This helps compilers that might believe a integer literal larger than | ||
369 | * 0xFFFFFFFF is overflowing a 32-bit value. Use `SDL_UINT64_C(0xFFFFFFFF1)` | ||
370 | * instead of `0xFFFFFFFF1` by itself. | ||
371 | * | ||
372 | * \since This macro is available since SDL 3.2.0. | ||
373 | * | ||
374 | * \sa SDL_SINT64_C | ||
375 | */ | ||
376 | #define SDL_UINT64_C(c) c ## ULL /* or whatever the current compiler uses. */ | ||
377 | |||
378 | #else /* !SDL_WIKI_DOCUMENTATION_SECTION */ | ||
379 | |||
380 | #ifndef SDL_SINT64_C | ||
381 | #if defined(INT64_C) | ||
382 | #define SDL_SINT64_C(c) INT64_C(c) | ||
383 | #elif defined(_MSC_VER) | ||
384 | #define SDL_SINT64_C(c) c ## i64 | ||
385 | #elif defined(__LP64__) || defined(_LP64) | ||
386 | #define SDL_SINT64_C(c) c ## L | ||
387 | #else | ||
388 | #define SDL_SINT64_C(c) c ## LL | ||
389 | #endif | ||
390 | #endif /* !SDL_SINT64_C */ | ||
391 | |||
392 | #ifndef SDL_UINT64_C | ||
393 | #if defined(UINT64_C) | ||
394 | #define SDL_UINT64_C(c) UINT64_C(c) | ||
395 | #elif defined(_MSC_VER) | ||
396 | #define SDL_UINT64_C(c) c ## ui64 | ||
397 | #elif defined(__LP64__) || defined(_LP64) | ||
398 | #define SDL_UINT64_C(c) c ## UL | ||
399 | #else | ||
400 | #define SDL_UINT64_C(c) c ## ULL | ||
401 | #endif | ||
402 | #endif /* !SDL_UINT64_C */ | ||
403 | |||
404 | #endif /* !SDL_WIKI_DOCUMENTATION_SECTION */ | ||
405 | |||
406 | /** | ||
407 | * \name Basic data types | ||
408 | */ | ||
409 | /* @{ */ | ||
410 | |||
411 | /** | ||
412 | * A signed 8-bit integer type. | ||
413 | * | ||
414 | * \since This macro is available since SDL 3.2.0. | ||
415 | */ | ||
416 | typedef int8_t Sint8; | ||
417 | #define SDL_MAX_SINT8 ((Sint8)0x7F) /* 127 */ | ||
418 | #define SDL_MIN_SINT8 ((Sint8)(~0x7F)) /* -128 */ | ||
419 | |||
420 | /** | ||
421 | * An unsigned 8-bit integer type. | ||
422 | * | ||
423 | * \since This macro is available since SDL 3.2.0. | ||
424 | */ | ||
425 | typedef uint8_t Uint8; | ||
426 | #define SDL_MAX_UINT8 ((Uint8)0xFF) /* 255 */ | ||
427 | #define SDL_MIN_UINT8 ((Uint8)0x00) /* 0 */ | ||
428 | |||
429 | /** | ||
430 | * A signed 16-bit integer type. | ||
431 | * | ||
432 | * \since This macro is available since SDL 3.2.0. | ||
433 | */ | ||
434 | typedef int16_t Sint16; | ||
435 | #define SDL_MAX_SINT16 ((Sint16)0x7FFF) /* 32767 */ | ||
436 | #define SDL_MIN_SINT16 ((Sint16)(~0x7FFF)) /* -32768 */ | ||
437 | |||
438 | /** | ||
439 | * An unsigned 16-bit integer type. | ||
440 | * | ||
441 | * \since This macro is available since SDL 3.2.0. | ||
442 | */ | ||
443 | typedef uint16_t Uint16; | ||
444 | #define SDL_MAX_UINT16 ((Uint16)0xFFFF) /* 65535 */ | ||
445 | #define SDL_MIN_UINT16 ((Uint16)0x0000) /* 0 */ | ||
446 | |||
447 | /** | ||
448 | * A signed 32-bit integer type. | ||
449 | * | ||
450 | * \since This macro is available since SDL 3.2.0. | ||
451 | */ | ||
452 | typedef int32_t Sint32; | ||
453 | #define SDL_MAX_SINT32 ((Sint32)0x7FFFFFFF) /* 2147483647 */ | ||
454 | #define SDL_MIN_SINT32 ((Sint32)(~0x7FFFFFFF)) /* -2147483648 */ | ||
455 | |||
456 | /** | ||
457 | * An unsigned 32-bit integer type. | ||
458 | * | ||
459 | * \since This macro is available since SDL 3.2.0. | ||
460 | */ | ||
461 | typedef uint32_t Uint32; | ||
462 | #define SDL_MAX_UINT32 ((Uint32)0xFFFFFFFFu) /* 4294967295 */ | ||
463 | #define SDL_MIN_UINT32 ((Uint32)0x00000000) /* 0 */ | ||
464 | |||
465 | /** | ||
466 | * A signed 64-bit integer type. | ||
467 | * | ||
468 | * \since This macro is available since SDL 3.2.0. | ||
469 | * | ||
470 | * \sa SDL_SINT64_C | ||
471 | */ | ||
472 | typedef int64_t Sint64; | ||
473 | #define SDL_MAX_SINT64 SDL_SINT64_C(0x7FFFFFFFFFFFFFFF) /* 9223372036854775807 */ | ||
474 | #define SDL_MIN_SINT64 ~SDL_SINT64_C(0x7FFFFFFFFFFFFFFF) /* -9223372036854775808 */ | ||
475 | |||
476 | /** | ||
477 | * An unsigned 64-bit integer type. | ||
478 | * | ||
479 | * \since This macro is available since SDL 3.2.0. | ||
480 | * | ||
481 | * \sa SDL_UINT64_C | ||
482 | */ | ||
483 | typedef uint64_t Uint64; | ||
484 | #define SDL_MAX_UINT64 SDL_UINT64_C(0xFFFFFFFFFFFFFFFF) /* 18446744073709551615 */ | ||
485 | #define SDL_MIN_UINT64 SDL_UINT64_C(0x0000000000000000) /* 0 */ | ||
486 | |||
487 | /** | ||
488 | * SDL times are signed, 64-bit integers representing nanoseconds since the | ||
489 | * Unix epoch (Jan 1, 1970). | ||
490 | * | ||
491 | * They can be converted between POSIX time_t values with SDL_NS_TO_SECONDS() | ||
492 | * and SDL_SECONDS_TO_NS(), and between Windows FILETIME values with | ||
493 | * SDL_TimeToWindows() and SDL_TimeFromWindows(). | ||
494 | * | ||
495 | * \since This macro is available since SDL 3.2.0. | ||
496 | * | ||
497 | * \sa SDL_MAX_SINT64 | ||
498 | * \sa SDL_MIN_SINT64 | ||
499 | */ | ||
500 | typedef Sint64 SDL_Time; | ||
501 | #define SDL_MAX_TIME SDL_MAX_SINT64 | ||
502 | #define SDL_MIN_TIME SDL_MIN_SINT64 | ||
503 | |||
504 | /* @} *//* Basic data types */ | ||
505 | |||
506 | /** | ||
507 | * \name Floating-point constants | ||
508 | */ | ||
509 | /* @{ */ | ||
510 | |||
511 | #ifdef FLT_EPSILON | ||
512 | #define SDL_FLT_EPSILON FLT_EPSILON | ||
513 | #else | ||
514 | |||
515 | /** | ||
516 | * Epsilon constant, used for comparing floating-point numbers. | ||
517 | * | ||
518 | * Equals by default to platform-defined `FLT_EPSILON`, or | ||
519 | * `1.1920928955078125e-07F` if that's not available. | ||
520 | * | ||
521 | * \since This macro is available since SDL 3.2.0. | ||
522 | */ | ||
523 | #define SDL_FLT_EPSILON 1.1920928955078125e-07F /* 0x0.000002p0 */ | ||
524 | #endif | ||
525 | |||
526 | /* @} *//* Floating-point constants */ | ||
527 | |||
528 | #ifdef SDL_WIKI_DOCUMENTATION_SECTION | ||
529 | |||
530 | /** | ||
531 | * A printf-formatting string for an Sint64 value. | ||
532 | * | ||
533 | * Use it like this: | ||
534 | * | ||
535 | * ```c | ||
536 | * SDL_Log("There are %" SDL_PRIs64 " bottles of beer on the wall.", bottles); | ||
537 | * ``` | ||
538 | * | ||
539 | * \since This macro is available since SDL 3.2.0. | ||
540 | */ | ||
541 | #define SDL_PRIs64 "lld" | ||
542 | |||
543 | /** | ||
544 | * A printf-formatting string for a Uint64 value. | ||
545 | * | ||
546 | * Use it like this: | ||
547 | * | ||
548 | * ```c | ||
549 | * SDL_Log("There are %" SDL_PRIu64 " bottles of beer on the wall.", bottles); | ||
550 | * ``` | ||
551 | * | ||
552 | * \since This macro is available since SDL 3.2.0. | ||
553 | */ | ||
554 | #define SDL_PRIu64 "llu" | ||
555 | |||
556 | /** | ||
557 | * A printf-formatting string for a Uint64 value as lower-case hexadecimal. | ||
558 | * | ||
559 | * Use it like this: | ||
560 | * | ||
561 | * ```c | ||
562 | * SDL_Log("There are %" SDL_PRIx64 " bottles of beer on the wall.", bottles); | ||
563 | * ``` | ||
564 | * | ||
565 | * \since This macro is available since SDL 3.2.0. | ||
566 | */ | ||
567 | #define SDL_PRIx64 "llx" | ||
568 | |||
569 | /** | ||
570 | * A printf-formatting string for a Uint64 value as upper-case hexadecimal. | ||
571 | * | ||
572 | * Use it like this: | ||
573 | * | ||
574 | * ```c | ||
575 | * SDL_Log("There are %" SDL_PRIX64 " bottles of beer on the wall.", bottles); | ||
576 | * ``` | ||
577 | * | ||
578 | * \since This macro is available since SDL 3.2.0. | ||
579 | */ | ||
580 | #define SDL_PRIX64 "llX" | ||
581 | |||
582 | /** | ||
583 | * A printf-formatting string for an Sint32 value. | ||
584 | * | ||
585 | * Use it like this: | ||
586 | * | ||
587 | * ```c | ||
588 | * SDL_Log("There are %" SDL_PRIs32 " bottles of beer on the wall.", bottles); | ||
589 | * ``` | ||
590 | * | ||
591 | * \since This macro is available since SDL 3.2.0. | ||
592 | */ | ||
593 | #define SDL_PRIs32 "d" | ||
594 | |||
595 | /** | ||
596 | * A printf-formatting string for a Uint32 value. | ||
597 | * | ||
598 | * Use it like this: | ||
599 | * | ||
600 | * ```c | ||
601 | * SDL_Log("There are %" SDL_PRIu32 " bottles of beer on the wall.", bottles); | ||
602 | * ``` | ||
603 | * | ||
604 | * \since This macro is available since SDL 3.2.0. | ||
605 | */ | ||
606 | #define SDL_PRIu32 "u" | ||
607 | |||
608 | /** | ||
609 | * A printf-formatting string for a Uint32 value as lower-case hexadecimal. | ||
610 | * | ||
611 | * Use it like this: | ||
612 | * | ||
613 | * ```c | ||
614 | * SDL_Log("There are %" SDL_PRIx32 " bottles of beer on the wall.", bottles); | ||
615 | * ``` | ||
616 | * | ||
617 | * \since This macro is available since SDL 3.2.0. | ||
618 | */ | ||
619 | #define SDL_PRIx32 "x" | ||
620 | |||
621 | /** | ||
622 | * A printf-formatting string for a Uint32 value as upper-case hexadecimal. | ||
623 | * | ||
624 | * Use it like this: | ||
625 | * | ||
626 | * ```c | ||
627 | * SDL_Log("There are %" SDL_PRIX32 " bottles of beer on the wall.", bottles); | ||
628 | * ``` | ||
629 | * | ||
630 | * \since This macro is available since SDL 3.2.0. | ||
631 | */ | ||
632 | #define SDL_PRIX32 "X" | ||
633 | |||
634 | /** | ||
635 | * A printf-formatting string prefix for a `long long` value. | ||
636 | * | ||
637 | * This is just the prefix! You probably actually want SDL_PRILLd, SDL_PRILLu, | ||
638 | * SDL_PRILLx, or SDL_PRILLX instead. | ||
639 | * | ||
640 | * Use it like this: | ||
641 | * | ||
642 | * ```c | ||
643 | * SDL_Log("There are %" SDL_PRILL_PREFIX "d bottles of beer on the wall.", bottles); | ||
644 | * ``` | ||
645 | * | ||
646 | * \since This macro is available since SDL 3.2.0. | ||
647 | */ | ||
648 | #define SDL_PRILL_PREFIX "ll" | ||
649 | |||
650 | /** | ||
651 | * A printf-formatting string for a `long long` value. | ||
652 | * | ||
653 | * Use it like this: | ||
654 | * | ||
655 | * ```c | ||
656 | * SDL_Log("There are %" SDL_PRILLd " bottles of beer on the wall.", bottles); | ||
657 | * ``` | ||
658 | * | ||
659 | * \since This macro is available since SDL 3.2.0. | ||
660 | */ | ||
661 | #define SDL_PRILLd SDL_PRILL_PREFIX "d" | ||
662 | |||
663 | /** | ||
664 | * A printf-formatting string for a `unsigned long long` value. | ||
665 | * | ||
666 | * Use it like this: | ||
667 | * | ||
668 | * ```c | ||
669 | * SDL_Log("There are %" SDL_PRILLu " bottles of beer on the wall.", bottles); | ||
670 | * ``` | ||
671 | * | ||
672 | * \since This macro is available since SDL 3.2.0. | ||
673 | */ | ||
674 | #define SDL_PRILLu SDL_PRILL_PREFIX "u" | ||
675 | |||
676 | /** | ||
677 | * A printf-formatting string for an `unsigned long long` value as lower-case | ||
678 | * hexadecimal. | ||
679 | * | ||
680 | * Use it like this: | ||
681 | * | ||
682 | * ```c | ||
683 | * SDL_Log("There are %" SDL_PRILLx " bottles of beer on the wall.", bottles); | ||
684 | * ``` | ||
685 | * | ||
686 | * \since This macro is available since SDL 3.2.0. | ||
687 | */ | ||
688 | #define SDL_PRILLx SDL_PRILL_PREFIX "x" | ||
689 | |||
690 | /** | ||
691 | * A printf-formatting string for an `unsigned long long` value as upper-case | ||
692 | * hexadecimal. | ||
693 | * | ||
694 | * Use it like this: | ||
695 | * | ||
696 | * ```c | ||
697 | * SDL_Log("There are %" SDL_PRILLX " bottles of beer on the wall.", bottles); | ||
698 | * ``` | ||
699 | * | ||
700 | * \since This macro is available since SDL 3.2.0. | ||
701 | */ | ||
702 | #define SDL_PRILLX SDL_PRILL_PREFIX "X" | ||
703 | #endif /* SDL_WIKI_DOCUMENTATION_SECTION */ | ||
704 | |||
705 | /* Make sure we have macros for printing width-based integers. | ||
706 | * <inttypes.h> should define these but this is not true all platforms. | ||
707 | * (for example win32) */ | ||
708 | #ifndef SDL_PRIs64 | ||
709 | #if defined(SDL_PLATFORM_WINDOWS) | ||
710 | #define SDL_PRIs64 "I64d" | ||
711 | #elif defined(PRId64) | ||
712 | #define SDL_PRIs64 PRId64 | ||
713 | #elif defined(__LP64__) && !defined(SDL_PLATFORM_APPLE) && !defined(__EMSCRIPTEN__) | ||
714 | #define SDL_PRIs64 "ld" | ||
715 | #else | ||
716 | #define SDL_PRIs64 "lld" | ||
717 | #endif | ||
718 | #endif | ||
719 | #ifndef SDL_PRIu64 | ||
720 | #if defined(SDL_PLATFORM_WINDOWS) | ||
721 | #define SDL_PRIu64 "I64u" | ||
722 | #elif defined(PRIu64) | ||
723 | #define SDL_PRIu64 PRIu64 | ||
724 | #elif defined(__LP64__) && !defined(SDL_PLATFORM_APPLE) && !defined(__EMSCRIPTEN__) | ||
725 | #define SDL_PRIu64 "lu" | ||
726 | #else | ||
727 | #define SDL_PRIu64 "llu" | ||
728 | #endif | ||
729 | #endif | ||
730 | #ifndef SDL_PRIx64 | ||
731 | #if defined(SDL_PLATFORM_WINDOWS) | ||
732 | #define SDL_PRIx64 "I64x" | ||
733 | #elif defined(PRIx64) | ||
734 | #define SDL_PRIx64 PRIx64 | ||
735 | #elif defined(__LP64__) && !defined(SDL_PLATFORM_APPLE) | ||
736 | #define SDL_PRIx64 "lx" | ||
737 | #else | ||
738 | #define SDL_PRIx64 "llx" | ||
739 | #endif | ||
740 | #endif | ||
741 | #ifndef SDL_PRIX64 | ||
742 | #if defined(SDL_PLATFORM_WINDOWS) | ||
743 | #define SDL_PRIX64 "I64X" | ||
744 | #elif defined(PRIX64) | ||
745 | #define SDL_PRIX64 PRIX64 | ||
746 | #elif defined(__LP64__) && !defined(SDL_PLATFORM_APPLE) | ||
747 | #define SDL_PRIX64 "lX" | ||
748 | #else | ||
749 | #define SDL_PRIX64 "llX" | ||
750 | #endif | ||
751 | #endif | ||
752 | #ifndef SDL_PRIs32 | ||
753 | #ifdef PRId32 | ||
754 | #define SDL_PRIs32 PRId32 | ||
755 | #else | ||
756 | #define SDL_PRIs32 "d" | ||
757 | #endif | ||
758 | #endif | ||
759 | #ifndef SDL_PRIu32 | ||
760 | #ifdef PRIu32 | ||
761 | #define SDL_PRIu32 PRIu32 | ||
762 | #else | ||
763 | #define SDL_PRIu32 "u" | ||
764 | #endif | ||
765 | #endif | ||
766 | #ifndef SDL_PRIx32 | ||
767 | #ifdef PRIx32 | ||
768 | #define SDL_PRIx32 PRIx32 | ||
769 | #else | ||
770 | #define SDL_PRIx32 "x" | ||
771 | #endif | ||
772 | #endif | ||
773 | #ifndef SDL_PRIX32 | ||
774 | #ifdef PRIX32 | ||
775 | #define SDL_PRIX32 PRIX32 | ||
776 | #else | ||
777 | #define SDL_PRIX32 "X" | ||
778 | #endif | ||
779 | #endif | ||
780 | /* Specifically for the `long long` -- SDL-specific. */ | ||
781 | #ifdef SDL_PLATFORM_WINDOWS | ||
782 | #ifndef SDL_NOLONGLONG | ||
783 | SDL_COMPILE_TIME_ASSERT(longlong_size64, sizeof(long long) == 8); /* using I64 for windows - make sure `long long` is 64 bits. */ | ||
784 | #endif | ||
785 | #define SDL_PRILL_PREFIX "I64" | ||
786 | #else | ||
787 | #define SDL_PRILL_PREFIX "ll" | ||
788 | #endif | ||
789 | #ifndef SDL_PRILLd | ||
790 | #define SDL_PRILLd SDL_PRILL_PREFIX "d" | ||
791 | #endif | ||
792 | #ifndef SDL_PRILLu | ||
793 | #define SDL_PRILLu SDL_PRILL_PREFIX "u" | ||
794 | #endif | ||
795 | #ifndef SDL_PRILLx | ||
796 | #define SDL_PRILLx SDL_PRILL_PREFIX "x" | ||
797 | #endif | ||
798 | #ifndef SDL_PRILLX | ||
799 | #define SDL_PRILLX SDL_PRILL_PREFIX "X" | ||
800 | #endif | ||
801 | |||
802 | /* Annotations to help code analysis tools */ | ||
803 | #ifdef SDL_WIKI_DOCUMENTATION_SECTION | ||
804 | |||
805 | /** | ||
806 | * Macro that annotates function params with input buffer size. | ||
807 | * | ||
808 | * If we were to annotate `memcpy`: | ||
809 | * | ||
810 | * ```c | ||
811 | * void *memcpy(void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len); | ||
812 | * ``` | ||
813 | * | ||
814 | * This notes that `src` should be `len` bytes in size and is only read by the | ||
815 | * function. The compiler or other analysis tools can warn when this doesn't | ||
816 | * appear to be the case. | ||
817 | * | ||
818 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
819 | * | ||
820 | * \since This macro is available since SDL 3.2.0. | ||
821 | */ | ||
822 | #define SDL_IN_BYTECAP(x) _In_bytecount_(x) | ||
823 | |||
824 | /** | ||
825 | * Macro that annotates function params with input/output string buffer size. | ||
826 | * | ||
827 | * If we were to annotate `strlcat`: | ||
828 | * | ||
829 | * ```c | ||
830 | * size_t strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen); | ||
831 | * ``` | ||
832 | * | ||
833 | * This notes that `dst` is a null-terminated C string, should be `maxlen` | ||
834 | * bytes in size, and is both read from and written to by the function. The | ||
835 | * compiler or other analysis tools can warn when this doesn't appear to be | ||
836 | * the case. | ||
837 | * | ||
838 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
839 | * | ||
840 | * \since This macro is available since SDL 3.2.0. | ||
841 | */ | ||
842 | #define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x) | ||
843 | |||
844 | /** | ||
845 | * Macro that annotates function params with output string buffer size. | ||
846 | * | ||
847 | * If we were to annotate `snprintf`: | ||
848 | * | ||
849 | * ```c | ||
850 | * int snprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, ...); | ||
851 | * ``` | ||
852 | * | ||
853 | * This notes that `text` is a null-terminated C string, should be `maxlen` | ||
854 | * bytes in size, and is only written to by the function. The compiler or | ||
855 | * other analysis tools can warn when this doesn't appear to be the case. | ||
856 | * | ||
857 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
858 | * | ||
859 | * \since This macro is available since SDL 3.2.0. | ||
860 | */ | ||
861 | #define SDL_OUT_Z_CAP(x) _Out_z_cap_(x) | ||
862 | |||
863 | /** | ||
864 | * Macro that annotates function params with output buffer size. | ||
865 | * | ||
866 | * If we were to annotate `wcsncpy`: | ||
867 | * | ||
868 | * ```c | ||
869 | * char *wcscpy(SDL_OUT_CAP(bufsize) wchar_t *dst, const wchar_t *src, size_t bufsize); | ||
870 | * ``` | ||
871 | * | ||
872 | * This notes that `dst` should have a capacity of `bufsize` wchar_t in size, | ||
873 | * and is only written to by the function. The compiler or other analysis | ||
874 | * tools can warn when this doesn't appear to be the case. | ||
875 | * | ||
876 | * This operates on counts of objects, not bytes. Use SDL_OUT_BYTECAP for | ||
877 | * bytes. | ||
878 | * | ||
879 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
880 | * | ||
881 | * \since This macro is available since SDL 3.2.0. | ||
882 | */ | ||
883 | #define SDL_OUT_CAP(x) _Out_cap_(x) | ||
884 | |||
885 | /** | ||
886 | * Macro that annotates function params with output buffer size. | ||
887 | * | ||
888 | * If we were to annotate `memcpy`: | ||
889 | * | ||
890 | * ```c | ||
891 | * void *memcpy(SDL_OUT_BYTECAP(bufsize) void *dst, const void *src, size_t bufsize); | ||
892 | * ``` | ||
893 | * | ||
894 | * This notes that `dst` should have a capacity of `bufsize` bytes in size, | ||
895 | * and is only written to by the function. The compiler or other analysis | ||
896 | * tools can warn when this doesn't appear to be the case. | ||
897 | * | ||
898 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
899 | * | ||
900 | * \since This macro is available since SDL 3.2.0. | ||
901 | */ | ||
902 | #define SDL_OUT_BYTECAP(x) _Out_bytecap_(x) | ||
903 | |||
904 | /** | ||
905 | * Macro that annotates function params with output buffer string size. | ||
906 | * | ||
907 | * If we were to annotate `strcpy`: | ||
908 | * | ||
909 | * ```c | ||
910 | * char *strcpy(SDL_OUT_Z_BYTECAP(bufsize) char *dst, const char *src, size_t bufsize); | ||
911 | * ``` | ||
912 | * | ||
913 | * This notes that `dst` should have a capacity of `bufsize` bytes in size, | ||
914 | * and a zero-terminated string is written to it by the function. The compiler | ||
915 | * or other analysis tools can warn when this doesn't appear to be the case. | ||
916 | * | ||
917 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
918 | * | ||
919 | * \since This macro is available since SDL 3.2.0. | ||
920 | */ | ||
921 | #define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x) | ||
922 | |||
923 | /** | ||
924 | * Macro that annotates function params as printf-style format strings. | ||
925 | * | ||
926 | * If we were to annotate `fprintf`: | ||
927 | * | ||
928 | * ```c | ||
929 | * int fprintf(FILE *f, SDL_PRINTF_FORMAT_STRING const char *fmt, ...); | ||
930 | * ``` | ||
931 | * | ||
932 | * This notes that `fmt` should be a printf-style format string. The compiler | ||
933 | * or other analysis tools can warn when this doesn't appear to be the case. | ||
934 | * | ||
935 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
936 | * | ||
937 | * \since This macro is available since SDL 3.2.0. | ||
938 | */ | ||
939 | #define SDL_PRINTF_FORMAT_STRING _Printf_format_string_ | ||
940 | |||
941 | /** | ||
942 | * Macro that annotates function params as scanf-style format strings. | ||
943 | * | ||
944 | * If we were to annotate `fscanf`: | ||
945 | * | ||
946 | * ```c | ||
947 | * int fscanf(FILE *f, SDL_SCANF_FORMAT_STRING const char *fmt, ...); | ||
948 | * ``` | ||
949 | * | ||
950 | * This notes that `fmt` should be a scanf-style format string. The compiler | ||
951 | * or other analysis tools can warn when this doesn't appear to be the case. | ||
952 | * | ||
953 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
954 | * | ||
955 | * \since This macro is available since SDL 3.2.0. | ||
956 | */ | ||
957 | #define SDL_SCANF_FORMAT_STRING _Scanf_format_string_impl_ | ||
958 | |||
959 | /** | ||
960 | * Macro that annotates a vararg function that operates like printf. | ||
961 | * | ||
962 | * If we were to annotate `fprintf`: | ||
963 | * | ||
964 | * ```c | ||
965 | * int fprintf(FILE *f, const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2); | ||
966 | * ``` | ||
967 | * | ||
968 | * This notes that the second parameter should be a printf-style format | ||
969 | * string, followed by `...`. The compiler or other analysis tools can warn | ||
970 | * when this doesn't appear to be the case. | ||
971 | * | ||
972 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
973 | * | ||
974 | * This can (and should) be used with SDL_PRINTF_FORMAT_STRING as well, which | ||
975 | * between them will cover at least Visual Studio, GCC, and Clang. | ||
976 | * | ||
977 | * \since This macro is available since SDL 3.2.0. | ||
978 | */ | ||
979 | #define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __printf__, fmtargnumber, fmtargnumber+1 ))) | ||
980 | |||
981 | /** | ||
982 | * Macro that annotates a va_list function that operates like printf. | ||
983 | * | ||
984 | * If we were to annotate `vfprintf`: | ||
985 | * | ||
986 | * ```c | ||
987 | * int vfprintf(FILE *f, const char *fmt, va_list ap) SDL_PRINTF_VARARG_FUNCV(2); | ||
988 | * ``` | ||
989 | * | ||
990 | * This notes that the second parameter should be a printf-style format | ||
991 | * string, followed by a va_list. The compiler or other analysis tools can | ||
992 | * warn when this doesn't appear to be the case. | ||
993 | * | ||
994 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
995 | * | ||
996 | * This can (and should) be used with SDL_PRINTF_FORMAT_STRING as well, which | ||
997 | * between them will cover at least Visual Studio, GCC, and Clang. | ||
998 | * | ||
999 | * \since This macro is available since SDL 3.2.0. | ||
1000 | */ | ||
1001 | #define SDL_PRINTF_VARARG_FUNCV( fmtargnumber ) __attribute__(( format( __printf__, fmtargnumber, 0 ))) | ||
1002 | |||
1003 | /** | ||
1004 | * Macro that annotates a vararg function that operates like scanf. | ||
1005 | * | ||
1006 | * If we were to annotate `fscanf`: | ||
1007 | * | ||
1008 | * ```c | ||
1009 | * int fscanf(FILE *f, const char *fmt, ...) SDL_PRINTF_VARARG_FUNCV(2); | ||
1010 | * ``` | ||
1011 | * | ||
1012 | * This notes that the second parameter should be a scanf-style format string, | ||
1013 | * followed by `...`. The compiler or other analysis tools can warn when this | ||
1014 | * doesn't appear to be the case. | ||
1015 | * | ||
1016 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
1017 | * | ||
1018 | * This can (and should) be used with SDL_SCANF_FORMAT_STRING as well, which | ||
1019 | * between them will cover at least Visual Studio, GCC, and Clang. | ||
1020 | * | ||
1021 | * \since This macro is available since SDL 3.2.0. | ||
1022 | */ | ||
1023 | #define SDL_SCANF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __scanf__, fmtargnumber, fmtargnumber+1 ))) | ||
1024 | |||
1025 | /** | ||
1026 | * Macro that annotates a va_list function that operates like scanf. | ||
1027 | * | ||
1028 | * If we were to annotate `vfscanf`: | ||
1029 | * | ||
1030 | * ```c | ||
1031 | * int vfscanf(FILE *f, const char *fmt, va_list ap) SDL_PRINTF_VARARG_FUNCV(2); | ||
1032 | * ``` | ||
1033 | * | ||
1034 | * This notes that the second parameter should be a scanf-style format string, | ||
1035 | * followed by a va_list. The compiler or other analysis tools can warn when | ||
1036 | * this doesn't appear to be the case. | ||
1037 | * | ||
1038 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
1039 | * | ||
1040 | * This can (and should) be used with SDL_SCANF_FORMAT_STRING as well, which | ||
1041 | * between them will cover at least Visual Studio, GCC, and Clang. | ||
1042 | * | ||
1043 | * \since This macro is available since SDL 3.2.0. | ||
1044 | */ | ||
1045 | #define SDL_SCANF_VARARG_FUNCV( fmtargnumber ) __attribute__(( format( __scanf__, fmtargnumber, 0 ))) | ||
1046 | |||
1047 | /** | ||
1048 | * Macro that annotates a vararg function that operates like wprintf. | ||
1049 | * | ||
1050 | * If we were to annotate `fwprintf`: | ||
1051 | * | ||
1052 | * ```c | ||
1053 | * int fwprintf(FILE *f, const wchar_t *fmt, ...) SDL_WPRINTF_VARARG_FUNC(2); | ||
1054 | * ``` | ||
1055 | * | ||
1056 | * This notes that the second parameter should be a wprintf-style format wide | ||
1057 | * string, followed by `...`. The compiler or other analysis tools can warn | ||
1058 | * when this doesn't appear to be the case. | ||
1059 | * | ||
1060 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
1061 | * | ||
1062 | * This can (and should) be used with SDL_PRINTF_FORMAT_STRING as well, which | ||
1063 | * between them will cover at least Visual Studio, GCC, and Clang. | ||
1064 | * | ||
1065 | * \since This macro is available since SDL 3.2.0. | ||
1066 | */ | ||
1067 | #define SDL_WPRINTF_VARARG_FUNC( fmtargnumber ) /* __attribute__ (( format( __wprintf__, fmtargnumber, fmtargnumber+1 ))) */ | ||
1068 | |||
1069 | /** | ||
1070 | * Macro that annotates a va_list function that operates like wprintf. | ||
1071 | * | ||
1072 | * If we were to annotate `vfwprintf`: | ||
1073 | * | ||
1074 | * ```c | ||
1075 | * int vfwprintf(FILE *f, const wchar_t *fmt, va_list ap) SDL_WPRINTF_VARARG_FUNC(2); | ||
1076 | * ``` | ||
1077 | * | ||
1078 | * This notes that the second parameter should be a wprintf-style format wide | ||
1079 | * string, followed by a va_list. The compiler or other analysis tools can | ||
1080 | * warn when this doesn't appear to be the case. | ||
1081 | * | ||
1082 | * On compilers without this annotation mechanism, this is defined to nothing. | ||
1083 | * | ||
1084 | * This can (and should) be used with SDL_PRINTF_FORMAT_STRING as well, which | ||
1085 | * between them will cover at least Visual Studio, GCC, and Clang. | ||
1086 | * | ||
1087 | * \since This macro is available since SDL 3.2.0. | ||
1088 | */ | ||
1089 | #define SDL_WPRINTF_VARARG_FUNCV( fmtargnumber ) /* __attribute__ (( format( __wprintf__, fmtargnumber, 0 ))) */ | ||
1090 | |||
1091 | #elif defined(SDL_DISABLE_ANALYZE_MACROS) | ||
1092 | #define SDL_IN_BYTECAP(x) | ||
1093 | #define SDL_INOUT_Z_CAP(x) | ||
1094 | #define SDL_OUT_Z_CAP(x) | ||
1095 | #define SDL_OUT_CAP(x) | ||
1096 | #define SDL_OUT_BYTECAP(x) | ||
1097 | #define SDL_OUT_Z_BYTECAP(x) | ||
1098 | #define SDL_PRINTF_FORMAT_STRING | ||
1099 | #define SDL_SCANF_FORMAT_STRING | ||
1100 | #define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) | ||
1101 | #define SDL_PRINTF_VARARG_FUNCV( fmtargnumber ) | ||
1102 | #define SDL_SCANF_VARARG_FUNC( fmtargnumber ) | ||
1103 | #define SDL_SCANF_VARARG_FUNCV( fmtargnumber ) | ||
1104 | #define SDL_WPRINTF_VARARG_FUNC( fmtargnumber ) | ||
1105 | #define SDL_WPRINTF_VARARG_FUNCV( fmtargnumber ) | ||
1106 | #else | ||
1107 | #if defined(_MSC_VER) && (_MSC_VER >= 1600) /* VS 2010 and above */ | ||
1108 | #include <sal.h> | ||
1109 | |||
1110 | #define SDL_IN_BYTECAP(x) _In_bytecount_(x) | ||
1111 | #define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x) | ||
1112 | #define SDL_OUT_Z_CAP(x) _Out_z_cap_(x) | ||
1113 | #define SDL_OUT_CAP(x) _Out_cap_(x) | ||
1114 | #define SDL_OUT_BYTECAP(x) _Out_bytecap_(x) | ||
1115 | #define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x) | ||
1116 | |||
1117 | #define SDL_PRINTF_FORMAT_STRING _Printf_format_string_ | ||
1118 | #define SDL_SCANF_FORMAT_STRING _Scanf_format_string_impl_ | ||
1119 | #else | ||
1120 | #define SDL_IN_BYTECAP(x) | ||
1121 | #define SDL_INOUT_Z_CAP(x) | ||
1122 | #define SDL_OUT_Z_CAP(x) | ||
1123 | #define SDL_OUT_CAP(x) | ||
1124 | #define SDL_OUT_BYTECAP(x) | ||
1125 | #define SDL_OUT_Z_BYTECAP(x) | ||
1126 | #define SDL_PRINTF_FORMAT_STRING | ||
1127 | #define SDL_SCANF_FORMAT_STRING | ||
1128 | #endif | ||
1129 | #if defined(__GNUC__) || defined(__clang__) | ||
1130 | #define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __printf__, fmtargnumber, fmtargnumber+1 ))) | ||
1131 | #define SDL_PRINTF_VARARG_FUNCV( fmtargnumber ) __attribute__(( format( __printf__, fmtargnumber, 0 ))) | ||
1132 | #define SDL_SCANF_VARARG_FUNC( fmtargnumber ) __attribute__ (( format( __scanf__, fmtargnumber, fmtargnumber+1 ))) | ||
1133 | #define SDL_SCANF_VARARG_FUNCV( fmtargnumber ) __attribute__(( format( __scanf__, fmtargnumber, 0 ))) | ||
1134 | #define SDL_WPRINTF_VARARG_FUNC( fmtargnumber ) /* __attribute__ (( format( __wprintf__, fmtargnumber, fmtargnumber+1 ))) */ | ||
1135 | #define SDL_WPRINTF_VARARG_FUNCV( fmtargnumber ) /* __attribute__ (( format( __wprintf__, fmtargnumber, 0 ))) */ | ||
1136 | #else | ||
1137 | #define SDL_PRINTF_VARARG_FUNC( fmtargnumber ) | ||
1138 | #define SDL_PRINTF_VARARG_FUNCV( fmtargnumber ) | ||
1139 | #define SDL_SCANF_VARARG_FUNC( fmtargnumber ) | ||
1140 | #define SDL_SCANF_VARARG_FUNCV( fmtargnumber ) | ||
1141 | #define SDL_WPRINTF_VARARG_FUNC( fmtargnumber ) | ||
1142 | #define SDL_WPRINTF_VARARG_FUNCV( fmtargnumber ) | ||
1143 | #endif | ||
1144 | #endif /* SDL_DISABLE_ANALYZE_MACROS */ | ||
1145 | |||
1146 | /** \cond */ | ||
1147 | #ifndef DOXYGEN_SHOULD_IGNORE_THIS | ||
1148 | SDL_COMPILE_TIME_ASSERT(bool_size, sizeof(bool) == 1); | ||
1149 | SDL_COMPILE_TIME_ASSERT(uint8_size, sizeof(Uint8) == 1); | ||
1150 | SDL_COMPILE_TIME_ASSERT(sint8_size, sizeof(Sint8) == 1); | ||
1151 | SDL_COMPILE_TIME_ASSERT(uint16_size, sizeof(Uint16) == 2); | ||
1152 | SDL_COMPILE_TIME_ASSERT(sint16_size, sizeof(Sint16) == 2); | ||
1153 | SDL_COMPILE_TIME_ASSERT(uint32_size, sizeof(Uint32) == 4); | ||
1154 | SDL_COMPILE_TIME_ASSERT(sint32_size, sizeof(Sint32) == 4); | ||
1155 | SDL_COMPILE_TIME_ASSERT(uint64_size, sizeof(Uint64) == 8); | ||
1156 | SDL_COMPILE_TIME_ASSERT(sint64_size, sizeof(Sint64) == 8); | ||
1157 | #ifndef SDL_NOLONGLONG | ||
1158 | SDL_COMPILE_TIME_ASSERT(uint64_longlong, sizeof(Uint64) <= sizeof(unsigned long long)); | ||
1159 | SDL_COMPILE_TIME_ASSERT(size_t_longlong, sizeof(size_t) <= sizeof(unsigned long long)); | ||
1160 | #endif | ||
1161 | typedef struct SDL_alignment_test | ||
1162 | { | ||
1163 | Uint8 a; | ||
1164 | void *b; | ||
1165 | } SDL_alignment_test; | ||
1166 | SDL_COMPILE_TIME_ASSERT(struct_alignment, sizeof(SDL_alignment_test) == (2 * sizeof(void *))); | ||
1167 | SDL_COMPILE_TIME_ASSERT(two_s_complement, (int)~(int)0 == (int)(-1)); | ||
1168 | #endif /* DOXYGEN_SHOULD_IGNORE_THIS */ | ||
1169 | /** \endcond */ | ||
1170 | |||
1171 | /* Check to make sure enums are the size of ints, for structure packing. | ||
1172 | For both Watcom C/C++ and Borland C/C++ the compiler option that makes | ||
1173 | enums having the size of an int must be enabled. | ||
1174 | This is "-b" for Borland C/C++ and "-ei" for Watcom C/C++ (v11). | ||
1175 | */ | ||
1176 | |||
1177 | /** \cond */ | ||
1178 | #ifndef DOXYGEN_SHOULD_IGNORE_THIS | ||
1179 | #if !defined(SDL_PLATFORM_VITA) && !defined(SDL_PLATFORM_3DS) | ||
1180 | /* TODO: include/SDL_stdinc.h:390: error: size of array 'SDL_dummy_enum' is negative */ | ||
1181 | typedef enum SDL_DUMMY_ENUM | ||
1182 | { | ||
1183 | DUMMY_ENUM_VALUE | ||
1184 | } SDL_DUMMY_ENUM; | ||
1185 | |||
1186 | SDL_COMPILE_TIME_ASSERT(enum, sizeof(SDL_DUMMY_ENUM) == sizeof(int)); | ||
1187 | #endif | ||
1188 | #endif /* DOXYGEN_SHOULD_IGNORE_THIS */ | ||
1189 | /** \endcond */ | ||
1190 | |||
1191 | #include <SDL3/SDL_begin_code.h> | ||
1192 | /* Set up for C function definitions, even when using C++ */ | ||
1193 | #ifdef __cplusplus | ||
1194 | extern "C" { | ||
1195 | #endif | ||
1196 | |||
1197 | /** | ||
1198 | * A macro to initialize an SDL interface. | ||
1199 | * | ||
1200 | * This macro will initialize an SDL interface structure and should be called | ||
1201 | * before you fill out the fields with your implementation. | ||
1202 | * | ||
1203 | * You can use it like this: | ||
1204 | * | ||
1205 | * ```c | ||
1206 | * SDL_IOStreamInterface iface; | ||
1207 | * | ||
1208 | * SDL_INIT_INTERFACE(&iface); | ||
1209 | * | ||
1210 | * // Fill in the interface function pointers with your implementation | ||
1211 | * iface.seek = ... | ||
1212 | * | ||
1213 | * stream = SDL_OpenIO(&iface, NULL); | ||
1214 | * ``` | ||
1215 | * | ||
1216 | * If you are using designated initializers, you can use the size of the | ||
1217 | * interface as the version, e.g. | ||
1218 | * | ||
1219 | * ```c | ||
1220 | * SDL_IOStreamInterface iface = { | ||
1221 | * .version = sizeof(iface), | ||
1222 | * .seek = ... | ||
1223 | * }; | ||
1224 | * stream = SDL_OpenIO(&iface, NULL); | ||
1225 | * ``` | ||
1226 | * | ||
1227 | * \threadsafety It is safe to call this macro from any thread. | ||
1228 | * | ||
1229 | * \since This macro is available since SDL 3.2.0. | ||
1230 | * | ||
1231 | * \sa SDL_IOStreamInterface | ||
1232 | * \sa SDL_StorageInterface | ||
1233 | * \sa SDL_VirtualJoystickDesc | ||
1234 | */ | ||
1235 | #define SDL_INIT_INTERFACE(iface) \ | ||
1236 | do { \ | ||
1237 | SDL_zerop(iface); \ | ||
1238 | (iface)->version = sizeof(*(iface)); \ | ||
1239 | } while (0) | ||
1240 | |||
1241 | |||
1242 | #ifdef SDL_WIKI_DOCUMENTATION_SECTION | ||
1243 | |||
1244 | /** | ||
1245 | * Allocate memory on the stack (maybe). | ||
1246 | * | ||
1247 | * If SDL knows how to access alloca() on the current platform, it will use it | ||
1248 | * to stack-allocate memory here. If it doesn't, it will use SDL_malloc() to | ||
1249 | * heap-allocate memory. | ||
1250 | * | ||
1251 | * Since this might not be stack memory at all, it's important that you check | ||
1252 | * the returned pointer for NULL, and that you call SDL_stack_free on the | ||
1253 | * memory when done with it. Since this might be stack memory, it's important | ||
1254 | * that you don't allocate large amounts of it, or allocate in a loop without | ||
1255 | * returning from the function, so the stack doesn't overflow. | ||
1256 | * | ||
1257 | * \param type the datatype of the memory to allocate. | ||
1258 | * \param count the number of `type` objects to allocate. | ||
1259 | * \returns newly-allocated memory, or NULL on failure. | ||
1260 | * | ||
1261 | * \threadsafety It is safe to call this macro from any thread. | ||
1262 | * | ||
1263 | * \since This macro is available since SDL 3.2.0. | ||
1264 | * | ||
1265 | * \sa SDL_stack_free | ||
1266 | */ | ||
1267 | #define SDL_stack_alloc(type, count) (type*)alloca(sizeof(type)*(count)) | ||
1268 | |||
1269 | /** | ||
1270 | * Free memory previously allocated with SDL_stack_alloc. | ||
1271 | * | ||
1272 | * If SDL used alloca() to allocate this memory, this macro does nothing and | ||
1273 | * the allocated memory will be automatically released when the function that | ||
1274 | * called SDL_stack_alloc() returns. If SDL used SDL_malloc(), it will | ||
1275 | * SDL_free the memory immediately. | ||
1276 | * | ||
1277 | * \param data the pointer, from SDL_stack_alloc(), to free. | ||
1278 | * | ||
1279 | * \threadsafety It is safe to call this macro from any thread. | ||
1280 | * | ||
1281 | * \since This macro is available since SDL 3.2.0. | ||
1282 | * | ||
1283 | * \sa SDL_stack_alloc | ||
1284 | */ | ||
1285 | #define SDL_stack_free(data) | ||
1286 | #elif !defined(SDL_DISABLE_ALLOCA) | ||
1287 | #define SDL_stack_alloc(type, count) (type*)alloca(sizeof(type)*(count)) | ||
1288 | #define SDL_stack_free(data) | ||
1289 | #else | ||
1290 | #define SDL_stack_alloc(type, count) (type*)SDL_malloc(sizeof(type)*(count)) | ||
1291 | #define SDL_stack_free(data) SDL_free(data) | ||
1292 | #endif | ||
1293 | |||
1294 | /** | ||
1295 | * Allocate uninitialized memory. | ||
1296 | * | ||
1297 | * The allocated memory returned by this function must be freed with | ||
1298 | * SDL_free(). | ||
1299 | * | ||
1300 | * If `size` is 0, it will be set to 1. | ||
1301 | * | ||
1302 | * If the allocation is successful, the returned pointer is guaranteed to be | ||
1303 | * aligned to either the *fundamental alignment* (`alignof(max_align_t)` in | ||
1304 | * C11 and later) or `2 * sizeof(void *)`, whichever is smaller. Use | ||
1305 | * SDL_aligned_alloc() if you need to allocate memory aligned to an alignment | ||
1306 | * greater than this guarantee. | ||
1307 | * | ||
1308 | * \param size the size to allocate. | ||
1309 | * \returns a pointer to the allocated memory, or NULL if allocation failed. | ||
1310 | * | ||
1311 | * \threadsafety It is safe to call this function from any thread. | ||
1312 | * | ||
1313 | * \since This function is available since SDL 3.2.0. | ||
1314 | * | ||
1315 | * \sa SDL_free | ||
1316 | * \sa SDL_calloc | ||
1317 | * \sa SDL_realloc | ||
1318 | * \sa SDL_aligned_alloc | ||
1319 | */ | ||
1320 | extern SDL_DECLSPEC SDL_MALLOC void * SDLCALL SDL_malloc(size_t size); | ||
1321 | |||
1322 | /** | ||
1323 | * Allocate a zero-initialized array. | ||
1324 | * | ||
1325 | * The memory returned by this function must be freed with SDL_free(). | ||
1326 | * | ||
1327 | * If either of `nmemb` or `size` is 0, they will both be set to 1. | ||
1328 | * | ||
1329 | * If the allocation is successful, the returned pointer is guaranteed to be | ||
1330 | * aligned to either the *fundamental alignment* (`alignof(max_align_t)` in | ||
1331 | * C11 and later) or `2 * sizeof(void *)`, whichever is smaller. | ||
1332 | * | ||
1333 | * \param nmemb the number of elements in the array. | ||
1334 | * \param size the size of each element of the array. | ||
1335 | * \returns a pointer to the allocated array, or NULL if allocation failed. | ||
1336 | * | ||
1337 | * \threadsafety It is safe to call this function from any thread. | ||
1338 | * | ||
1339 | * \since This function is available since SDL 3.2.0. | ||
1340 | * | ||
1341 | * \sa SDL_free | ||
1342 | * \sa SDL_malloc | ||
1343 | * \sa SDL_realloc | ||
1344 | */ | ||
1345 | extern SDL_DECLSPEC SDL_MALLOC SDL_ALLOC_SIZE2(1, 2) void * SDLCALL SDL_calloc(size_t nmemb, size_t size); | ||
1346 | |||
1347 | /** | ||
1348 | * Change the size of allocated memory. | ||
1349 | * | ||
1350 | * The memory returned by this function must be freed with SDL_free(). | ||
1351 | * | ||
1352 | * If `size` is 0, it will be set to 1. Note that this is unlike some other C | ||
1353 | * runtime `realloc` implementations, which may treat `realloc(mem, 0)` the | ||
1354 | * same way as `free(mem)`. | ||
1355 | * | ||
1356 | * If `mem` is NULL, the behavior of this function is equivalent to | ||
1357 | * SDL_malloc(). Otherwise, the function can have one of three possible | ||
1358 | * outcomes: | ||
1359 | * | ||
1360 | * - If it returns the same pointer as `mem`, it means that `mem` was resized | ||
1361 | * in place without freeing. | ||
1362 | * - If it returns a different non-NULL pointer, it means that `mem` was freed | ||
1363 | * and cannot be dereferenced anymore. | ||
1364 | * - If it returns NULL (indicating failure), then `mem` will remain valid and | ||
1365 | * must still be freed with SDL_free(). | ||
1366 | * | ||
1367 | * If the allocation is successfully resized, the returned pointer is | ||
1368 | * guaranteed to be aligned to either the *fundamental alignment* | ||
1369 | * (`alignof(max_align_t)` in C11 and later) or `2 * sizeof(void *)`, | ||
1370 | * whichever is smaller. | ||
1371 | * | ||
1372 | * \param mem a pointer to allocated memory to reallocate, or NULL. | ||
1373 | * \param size the new size of the memory. | ||
1374 | * \returns a pointer to the newly allocated memory, or NULL if allocation | ||
1375 | * failed. | ||
1376 | * | ||
1377 | * \threadsafety It is safe to call this function from any thread. | ||
1378 | * | ||
1379 | * \since This function is available since SDL 3.2.0. | ||
1380 | * | ||
1381 | * \sa SDL_free | ||
1382 | * \sa SDL_malloc | ||
1383 | * \sa SDL_calloc | ||
1384 | */ | ||
1385 | extern SDL_DECLSPEC SDL_ALLOC_SIZE(2) void * SDLCALL SDL_realloc(void *mem, size_t size); | ||
1386 | |||
1387 | /** | ||
1388 | * Free allocated memory. | ||
1389 | * | ||
1390 | * The pointer is no longer valid after this call and cannot be dereferenced | ||
1391 | * anymore. | ||
1392 | * | ||
1393 | * If `mem` is NULL, this function does nothing. | ||
1394 | * | ||
1395 | * \param mem a pointer to allocated memory, or NULL. | ||
1396 | * | ||
1397 | * \threadsafety It is safe to call this function from any thread. | ||
1398 | * | ||
1399 | * \since This function is available since SDL 3.2.0. | ||
1400 | * | ||
1401 | * \sa SDL_malloc | ||
1402 | * \sa SDL_calloc | ||
1403 | * \sa SDL_realloc | ||
1404 | */ | ||
1405 | extern SDL_DECLSPEC void SDLCALL SDL_free(void *mem); | ||
1406 | |||
1407 | /** | ||
1408 | * A callback used to implement SDL_malloc(). | ||
1409 | * | ||
1410 | * SDL will always ensure that the passed `size` is greater than 0. | ||
1411 | * | ||
1412 | * \param size the size to allocate. | ||
1413 | * \returns a pointer to the allocated memory, or NULL if allocation failed. | ||
1414 | * | ||
1415 | * \threadsafety It should be safe to call this callback from any thread. | ||
1416 | * | ||
1417 | * \since This datatype is available since SDL 3.2.0. | ||
1418 | * | ||
1419 | * \sa SDL_malloc | ||
1420 | * \sa SDL_GetOriginalMemoryFunctions | ||
1421 | * \sa SDL_GetMemoryFunctions | ||
1422 | * \sa SDL_SetMemoryFunctions | ||
1423 | */ | ||
1424 | typedef void *(SDLCALL *SDL_malloc_func)(size_t size); | ||
1425 | |||
1426 | /** | ||
1427 | * A callback used to implement SDL_calloc(). | ||
1428 | * | ||
1429 | * SDL will always ensure that the passed `nmemb` and `size` are both greater | ||
1430 | * than 0. | ||
1431 | * | ||
1432 | * \param nmemb the number of elements in the array. | ||
1433 | * \param size the size of each element of the array. | ||
1434 | * \returns a pointer to the allocated array, or NULL if allocation failed. | ||
1435 | * | ||
1436 | * \threadsafety It should be safe to call this callback from any thread. | ||
1437 | * | ||
1438 | * \since This datatype is available since SDL 3.2.0. | ||
1439 | * | ||
1440 | * \sa SDL_calloc | ||
1441 | * \sa SDL_GetOriginalMemoryFunctions | ||
1442 | * \sa SDL_GetMemoryFunctions | ||
1443 | * \sa SDL_SetMemoryFunctions | ||
1444 | */ | ||
1445 | typedef void *(SDLCALL *SDL_calloc_func)(size_t nmemb, size_t size); | ||
1446 | |||
1447 | /** | ||
1448 | * A callback used to implement SDL_realloc(). | ||
1449 | * | ||
1450 | * SDL will always ensure that the passed `size` is greater than 0. | ||
1451 | * | ||
1452 | * \param mem a pointer to allocated memory to reallocate, or NULL. | ||
1453 | * \param size the new size of the memory. | ||
1454 | * \returns a pointer to the newly allocated memory, or NULL if allocation | ||
1455 | * failed. | ||
1456 | * | ||
1457 | * \threadsafety It should be safe to call this callback from any thread. | ||
1458 | * | ||
1459 | * \since This datatype is available since SDL 3.2.0. | ||
1460 | * | ||
1461 | * \sa SDL_realloc | ||
1462 | * \sa SDL_GetOriginalMemoryFunctions | ||
1463 | * \sa SDL_GetMemoryFunctions | ||
1464 | * \sa SDL_SetMemoryFunctions | ||
1465 | */ | ||
1466 | typedef void *(SDLCALL *SDL_realloc_func)(void *mem, size_t size); | ||
1467 | |||
1468 | /** | ||
1469 | * A callback used to implement SDL_free(). | ||
1470 | * | ||
1471 | * SDL will always ensure that the passed `mem` is a non-NULL pointer. | ||
1472 | * | ||
1473 | * \param mem a pointer to allocated memory. | ||
1474 | * | ||
1475 | * \threadsafety It should be safe to call this callback from any thread. | ||
1476 | * | ||
1477 | * \since This datatype is available since SDL 3.2.0. | ||
1478 | * | ||
1479 | * \sa SDL_free | ||
1480 | * \sa SDL_GetOriginalMemoryFunctions | ||
1481 | * \sa SDL_GetMemoryFunctions | ||
1482 | * \sa SDL_SetMemoryFunctions | ||
1483 | */ | ||
1484 | typedef void (SDLCALL *SDL_free_func)(void *mem); | ||
1485 | |||
1486 | /** | ||
1487 | * Get the original set of SDL memory functions. | ||
1488 | * | ||
1489 | * This is what SDL_malloc and friends will use by default, if there has been | ||
1490 | * no call to SDL_SetMemoryFunctions. This is not necessarily using the C | ||
1491 | * runtime's `malloc` functions behind the scenes! Different platforms and | ||
1492 | * build configurations might do any number of unexpected things. | ||
1493 | * | ||
1494 | * \param malloc_func filled with malloc function. | ||
1495 | * \param calloc_func filled with calloc function. | ||
1496 | * \param realloc_func filled with realloc function. | ||
1497 | * \param free_func filled with free function. | ||
1498 | * | ||
1499 | * \threadsafety It is safe to call this function from any thread. | ||
1500 | * | ||
1501 | * \since This function is available since SDL 3.2.0. | ||
1502 | */ | ||
1503 | extern SDL_DECLSPEC void SDLCALL SDL_GetOriginalMemoryFunctions(SDL_malloc_func *malloc_func, | ||
1504 | SDL_calloc_func *calloc_func, | ||
1505 | SDL_realloc_func *realloc_func, | ||
1506 | SDL_free_func *free_func); | ||
1507 | |||
1508 | /** | ||
1509 | * Get the current set of SDL memory functions. | ||
1510 | * | ||
1511 | * \param malloc_func filled with malloc function. | ||
1512 | * \param calloc_func filled with calloc function. | ||
1513 | * \param realloc_func filled with realloc function. | ||
1514 | * \param free_func filled with free function. | ||
1515 | * | ||
1516 | * \threadsafety This does not hold a lock, so do not call this in the | ||
1517 | * unlikely event of a background thread calling | ||
1518 | * SDL_SetMemoryFunctions simultaneously. | ||
1519 | * | ||
1520 | * \since This function is available since SDL 3.2.0. | ||
1521 | * | ||
1522 | * \sa SDL_SetMemoryFunctions | ||
1523 | * \sa SDL_GetOriginalMemoryFunctions | ||
1524 | */ | ||
1525 | extern SDL_DECLSPEC void SDLCALL SDL_GetMemoryFunctions(SDL_malloc_func *malloc_func, | ||
1526 | SDL_calloc_func *calloc_func, | ||
1527 | SDL_realloc_func *realloc_func, | ||
1528 | SDL_free_func *free_func); | ||
1529 | |||
1530 | /** | ||
1531 | * Replace SDL's memory allocation functions with a custom set. | ||
1532 | * | ||
1533 | * It is not safe to call this function once any allocations have been made, | ||
1534 | * as future calls to SDL_free will use the new allocator, even if they came | ||
1535 | * from an SDL_malloc made with the old one! | ||
1536 | * | ||
1537 | * If used, usually this needs to be the first call made into the SDL library, | ||
1538 | * if not the very first thing done at program startup time. | ||
1539 | * | ||
1540 | * \param malloc_func custom malloc function. | ||
1541 | * \param calloc_func custom calloc function. | ||
1542 | * \param realloc_func custom realloc function. | ||
1543 | * \param free_func custom free function. | ||
1544 | * \returns true on success or false on failure; call SDL_GetError() for more | ||
1545 | * information. | ||
1546 | * | ||
1547 | * \threadsafety It is safe to call this function from any thread, but one | ||
1548 | * should not replace the memory functions once any allocations | ||
1549 | * are made! | ||
1550 | * | ||
1551 | * \since This function is available since SDL 3.2.0. | ||
1552 | * | ||
1553 | * \sa SDL_GetMemoryFunctions | ||
1554 | * \sa SDL_GetOriginalMemoryFunctions | ||
1555 | */ | ||
1556 | extern SDL_DECLSPEC bool SDLCALL SDL_SetMemoryFunctions(SDL_malloc_func malloc_func, | ||
1557 | SDL_calloc_func calloc_func, | ||
1558 | SDL_realloc_func realloc_func, | ||
1559 | SDL_free_func free_func); | ||
1560 | |||
1561 | /** | ||
1562 | * Allocate memory aligned to a specific alignment. | ||
1563 | * | ||
1564 | * The memory returned by this function must be freed with SDL_aligned_free(), | ||
1565 | * _not_ SDL_free(). | ||
1566 | * | ||
1567 | * If `alignment` is less than the size of `void *`, it will be increased to | ||
1568 | * match that. | ||
1569 | * | ||
1570 | * The returned memory address will be a multiple of the alignment value, and | ||
1571 | * the size of the memory allocated will be a multiple of the alignment value. | ||
1572 | * | ||
1573 | * \param alignment the alignment of the memory. | ||
1574 | * \param size the size to allocate. | ||
1575 | * \returns a pointer to the aligned memory, or NULL if allocation failed. | ||
1576 | * | ||
1577 | * \threadsafety It is safe to call this function from any thread. | ||
1578 | * | ||
1579 | * \since This function is available since SDL 3.2.0. | ||
1580 | * | ||
1581 | * \sa SDL_aligned_free | ||
1582 | */ | ||
1583 | extern SDL_DECLSPEC SDL_MALLOC void * SDLCALL SDL_aligned_alloc(size_t alignment, size_t size); | ||
1584 | |||
1585 | /** | ||
1586 | * Free memory allocated by SDL_aligned_alloc(). | ||
1587 | * | ||
1588 | * The pointer is no longer valid after this call and cannot be dereferenced | ||
1589 | * anymore. | ||
1590 | * | ||
1591 | * If `mem` is NULL, this function does nothing. | ||
1592 | * | ||
1593 | * \param mem a pointer previously returned by SDL_aligned_alloc(), or NULL. | ||
1594 | * | ||
1595 | * \threadsafety It is safe to call this function from any thread. | ||
1596 | * | ||
1597 | * \since This function is available since SDL 3.2.0. | ||
1598 | * | ||
1599 | * \sa SDL_aligned_alloc | ||
1600 | */ | ||
1601 | extern SDL_DECLSPEC void SDLCALL SDL_aligned_free(void *mem); | ||
1602 | |||
1603 | /** | ||
1604 | * Get the number of outstanding (unfreed) allocations. | ||
1605 | * | ||
1606 | * \returns the number of allocations or -1 if allocation counting is | ||
1607 | * disabled. | ||
1608 | * | ||
1609 | * \threadsafety It is safe to call this function from any thread. | ||
1610 | * | ||
1611 | * \since This function is available since SDL 3.2.0. | ||
1612 | */ | ||
1613 | extern SDL_DECLSPEC int SDLCALL SDL_GetNumAllocations(void); | ||
1614 | |||
1615 | /** | ||
1616 | * A thread-safe set of environment variables | ||
1617 | * | ||
1618 | * \since This struct is available since SDL 3.2.0. | ||
1619 | * | ||
1620 | * \sa SDL_GetEnvironment | ||
1621 | * \sa SDL_CreateEnvironment | ||
1622 | * \sa SDL_GetEnvironmentVariable | ||
1623 | * \sa SDL_GetEnvironmentVariables | ||
1624 | * \sa SDL_SetEnvironmentVariable | ||
1625 | * \sa SDL_UnsetEnvironmentVariable | ||
1626 | * \sa SDL_DestroyEnvironment | ||
1627 | */ | ||
1628 | typedef struct SDL_Environment SDL_Environment; | ||
1629 | |||
1630 | /** | ||
1631 | * Get the process environment. | ||
1632 | * | ||
1633 | * This is initialized at application start and is not affected by setenv() | ||
1634 | * and unsetenv() calls after that point. Use SDL_SetEnvironmentVariable() and | ||
1635 | * SDL_UnsetEnvironmentVariable() if you want to modify this environment, or | ||
1636 | * SDL_setenv_unsafe() or SDL_unsetenv_unsafe() if you want changes to persist | ||
1637 | * in the C runtime environment after SDL_Quit(). | ||
1638 | * | ||
1639 | * \returns a pointer to the environment for the process or NULL on failure; | ||
1640 | * call SDL_GetError() for more information. | ||
1641 | * | ||
1642 | * \threadsafety It is safe to call this function from any thread. | ||
1643 | * | ||
1644 | * \since This function is available since SDL 3.2.0. | ||
1645 | * | ||
1646 | * \sa SDL_GetEnvironmentVariable | ||
1647 | * \sa SDL_GetEnvironmentVariables | ||
1648 | * \sa SDL_SetEnvironmentVariable | ||
1649 | * \sa SDL_UnsetEnvironmentVariable | ||
1650 | */ | ||
1651 | extern SDL_DECLSPEC SDL_Environment * SDLCALL SDL_GetEnvironment(void); | ||
1652 | |||
1653 | /** | ||
1654 | * Create a set of environment variables | ||
1655 | * | ||
1656 | * \param populated true to initialize it from the C runtime environment, | ||
1657 | * false to create an empty environment. | ||
1658 | * \returns a pointer to the new environment or NULL on failure; call | ||
1659 | * SDL_GetError() for more information. | ||
1660 | * | ||
1661 | * \threadsafety If `populated` is false, it is safe to call this function | ||
1662 | * from any thread, otherwise it is safe if no other threads are | ||
1663 | * calling setenv() or unsetenv() | ||
1664 | * | ||
1665 | * \since This function is available since SDL 3.2.0. | ||
1666 | * | ||
1667 | * \sa SDL_GetEnvironmentVariable | ||
1668 | * \sa SDL_GetEnvironmentVariables | ||
1669 | * \sa SDL_SetEnvironmentVariable | ||
1670 | * \sa SDL_UnsetEnvironmentVariable | ||
1671 | * \sa SDL_DestroyEnvironment | ||
1672 | */ | ||
1673 | extern SDL_DECLSPEC SDL_Environment * SDLCALL SDL_CreateEnvironment(bool populated); | ||
1674 | |||
1675 | /** | ||
1676 | * Get the value of a variable in the environment. | ||
1677 | * | ||
1678 | * \param env the environment to query. | ||
1679 | * \param name the name of the variable to get. | ||
1680 | * \returns a pointer to the value of the variable or NULL if it can't be | ||
1681 | * found. | ||
1682 | * | ||
1683 | * \threadsafety It is safe to call this function from any thread. | ||
1684 | * | ||
1685 | * \since This function is available since SDL 3.2.0. | ||
1686 | * | ||
1687 | * \sa SDL_GetEnvironment | ||
1688 | * \sa SDL_CreateEnvironment | ||
1689 | * \sa SDL_GetEnvironmentVariables | ||
1690 | * \sa SDL_SetEnvironmentVariable | ||
1691 | * \sa SDL_UnsetEnvironmentVariable | ||
1692 | */ | ||
1693 | extern SDL_DECLSPEC const char * SDLCALL SDL_GetEnvironmentVariable(SDL_Environment *env, const char *name); | ||
1694 | |||
1695 | /** | ||
1696 | * Get all variables in the environment. | ||
1697 | * | ||
1698 | * \param env the environment to query. | ||
1699 | * \returns a NULL terminated array of pointers to environment variables in | ||
1700 | * the form "variable=value" or NULL on failure; call SDL_GetError() | ||
1701 | * for more information. This is a single allocation that should be | ||
1702 | * freed with SDL_free() when it is no longer needed. | ||
1703 | * | ||
1704 | * \threadsafety It is safe to call this function from any thread. | ||
1705 | * | ||
1706 | * \since This function is available since SDL 3.2.0. | ||
1707 | * | ||
1708 | * \sa SDL_GetEnvironment | ||
1709 | * \sa SDL_CreateEnvironment | ||
1710 | * \sa SDL_GetEnvironmentVariables | ||
1711 | * \sa SDL_SetEnvironmentVariable | ||
1712 | * \sa SDL_UnsetEnvironmentVariable | ||
1713 | */ | ||
1714 | extern SDL_DECLSPEC char ** SDLCALL SDL_GetEnvironmentVariables(SDL_Environment *env); | ||
1715 | |||
1716 | /** | ||
1717 | * Set the value of a variable in the environment. | ||
1718 | * | ||
1719 | * \param env the environment to modify. | ||
1720 | * \param name the name of the variable to set. | ||
1721 | * \param value the value of the variable to set. | ||
1722 | * \param overwrite true to overwrite the variable if it exists, false to | ||
1723 | * return success without setting the variable if it already | ||
1724 | * exists. | ||
1725 | * \returns true on success or false on failure; call SDL_GetError() for more | ||
1726 | * information. | ||
1727 | * | ||
1728 | * \threadsafety It is safe to call this function from any thread. | ||
1729 | * | ||
1730 | * \since This function is available since SDL 3.2.0. | ||
1731 | * | ||
1732 | * \sa SDL_GetEnvironment | ||
1733 | * \sa SDL_CreateEnvironment | ||
1734 | * \sa SDL_GetEnvironmentVariable | ||
1735 | * \sa SDL_GetEnvironmentVariables | ||
1736 | * \sa SDL_UnsetEnvironmentVariable | ||
1737 | */ | ||
1738 | extern SDL_DECLSPEC bool SDLCALL SDL_SetEnvironmentVariable(SDL_Environment *env, const char *name, const char *value, bool overwrite); | ||
1739 | |||
1740 | /** | ||
1741 | * Clear a variable from the environment. | ||
1742 | * | ||
1743 | * \param env the environment to modify. | ||
1744 | * \param name the name of the variable to unset. | ||
1745 | * \returns true on success or false on failure; call SDL_GetError() for more | ||
1746 | * information. | ||
1747 | * | ||
1748 | * \threadsafety It is safe to call this function from any thread. | ||
1749 | * | ||
1750 | * \since This function is available since SDL 3.2.0. | ||
1751 | * | ||
1752 | * \sa SDL_GetEnvironment | ||
1753 | * \sa SDL_CreateEnvironment | ||
1754 | * \sa SDL_GetEnvironmentVariable | ||
1755 | * \sa SDL_GetEnvironmentVariables | ||
1756 | * \sa SDL_SetEnvironmentVariable | ||
1757 | * \sa SDL_UnsetEnvironmentVariable | ||
1758 | */ | ||
1759 | extern SDL_DECLSPEC bool SDLCALL SDL_UnsetEnvironmentVariable(SDL_Environment *env, const char *name); | ||
1760 | |||
1761 | /** | ||
1762 | * Destroy a set of environment variables. | ||
1763 | * | ||
1764 | * \param env the environment to destroy. | ||
1765 | * | ||
1766 | * \threadsafety It is safe to call this function from any thread, as long as | ||
1767 | * the environment is no longer in use. | ||
1768 | * | ||
1769 | * \since This function is available since SDL 3.2.0. | ||
1770 | * | ||
1771 | * \sa SDL_CreateEnvironment | ||
1772 | */ | ||
1773 | extern SDL_DECLSPEC void SDLCALL SDL_DestroyEnvironment(SDL_Environment *env); | ||
1774 | |||
1775 | /** | ||
1776 | * Get the value of a variable in the environment. | ||
1777 | * | ||
1778 | * This function uses SDL's cached copy of the environment and is thread-safe. | ||
1779 | * | ||
1780 | * \param name the name of the variable to get. | ||
1781 | * \returns a pointer to the value of the variable or NULL if it can't be | ||
1782 | * found. | ||
1783 | * | ||
1784 | * \threadsafety It is safe to call this function from any thread. | ||
1785 | * | ||
1786 | * \since This function is available since SDL 3.2.0. | ||
1787 | */ | ||
1788 | extern SDL_DECLSPEC const char * SDLCALL SDL_getenv(const char *name); | ||
1789 | |||
1790 | /** | ||
1791 | * Get the value of a variable in the environment. | ||
1792 | * | ||
1793 | * This function bypasses SDL's cached copy of the environment and is not | ||
1794 | * thread-safe. | ||
1795 | * | ||
1796 | * \param name the name of the variable to get. | ||
1797 | * \returns a pointer to the value of the variable or NULL if it can't be | ||
1798 | * found. | ||
1799 | * | ||
1800 | * \threadsafety This function is not thread safe, consider using SDL_getenv() | ||
1801 | * instead. | ||
1802 | * | ||
1803 | * \since This function is available since SDL 3.2.0. | ||
1804 | * | ||
1805 | * \sa SDL_getenv | ||
1806 | */ | ||
1807 | extern SDL_DECLSPEC const char * SDLCALL SDL_getenv_unsafe(const char *name); | ||
1808 | |||
1809 | /** | ||
1810 | * Set the value of a variable in the environment. | ||
1811 | * | ||
1812 | * \param name the name of the variable to set. | ||
1813 | * \param value the value of the variable to set. | ||
1814 | * \param overwrite 1 to overwrite the variable if it exists, 0 to return | ||
1815 | * success without setting the variable if it already exists. | ||
1816 | * \returns 0 on success, -1 on error. | ||
1817 | * | ||
1818 | * \threadsafety This function is not thread safe, consider using | ||
1819 | * SDL_SetEnvironmentVariable() instead. | ||
1820 | * | ||
1821 | * \since This function is available since SDL 3.2.0. | ||
1822 | * | ||
1823 | * \sa SDL_SetEnvironmentVariable | ||
1824 | */ | ||
1825 | extern SDL_DECLSPEC int SDLCALL SDL_setenv_unsafe(const char *name, const char *value, int overwrite); | ||
1826 | |||
1827 | /** | ||
1828 | * Clear a variable from the environment. | ||
1829 | * | ||
1830 | * \param name the name of the variable to unset. | ||
1831 | * \returns 0 on success, -1 on error. | ||
1832 | * | ||
1833 | * \threadsafety This function is not thread safe, consider using | ||
1834 | * SDL_UnsetEnvironmentVariable() instead. | ||
1835 | * | ||
1836 | * \since This function is available since SDL 3.2.0. | ||
1837 | * | ||
1838 | * \sa SDL_UnsetEnvironmentVariable | ||
1839 | */ | ||
1840 | extern SDL_DECLSPEC int SDLCALL SDL_unsetenv_unsafe(const char *name); | ||
1841 | |||
1842 | /** | ||
1843 | * A callback used with SDL sorting and binary search functions. | ||
1844 | * | ||
1845 | * \param a a pointer to the first element being compared. | ||
1846 | * \param b a pointer to the second element being compared. | ||
1847 | * \returns -1 if `a` should be sorted before `b`, 1 if `b` should be sorted | ||
1848 | * before `a`, 0 if they are equal. If two elements are equal, their | ||
1849 | * order in the sorted array is undefined. | ||
1850 | * | ||
1851 | * \since This callback is available since SDL 3.2.0. | ||
1852 | * | ||
1853 | * \sa SDL_bsearch | ||
1854 | * \sa SDL_qsort | ||
1855 | */ | ||
1856 | typedef int (SDLCALL *SDL_CompareCallback)(const void *a, const void *b); | ||
1857 | |||
1858 | /** | ||
1859 | * Sort an array. | ||
1860 | * | ||
1861 | * For example: | ||
1862 | * | ||
1863 | * ```c | ||
1864 | * typedef struct { | ||
1865 | * int key; | ||
1866 | * const char *string; | ||
1867 | * } data; | ||
1868 | * | ||
1869 | * int SDLCALL compare(const void *a, const void *b) | ||
1870 | * { | ||
1871 | * const data *A = (const data *)a; | ||
1872 | * const data *B = (const data *)b; | ||
1873 | * | ||
1874 | * if (A->n < B->n) { | ||
1875 | * return -1; | ||
1876 | * } else if (B->n < A->n) { | ||
1877 | * return 1; | ||
1878 | * } else { | ||
1879 | * return 0; | ||
1880 | * } | ||
1881 | * } | ||
1882 | * | ||
1883 | * data values[] = { | ||
1884 | * { 3, "third" }, { 1, "first" }, { 2, "second" } | ||
1885 | * }; | ||
1886 | * | ||
1887 | * SDL_qsort(values, SDL_arraysize(values), sizeof(values[0]), compare); | ||
1888 | * ``` | ||
1889 | * | ||
1890 | * \param base a pointer to the start of the array. | ||
1891 | * \param nmemb the number of elements in the array. | ||
1892 | * \param size the size of the elements in the array. | ||
1893 | * \param compare a function used to compare elements in the array. | ||
1894 | * | ||
1895 | * \threadsafety It is safe to call this function from any thread. | ||
1896 | * | ||
1897 | * \since This function is available since SDL 3.2.0. | ||
1898 | * | ||
1899 | * \sa SDL_bsearch | ||
1900 | * \sa SDL_qsort_r | ||
1901 | */ | ||
1902 | extern SDL_DECLSPEC void SDLCALL SDL_qsort(void *base, size_t nmemb, size_t size, SDL_CompareCallback compare); | ||
1903 | |||
1904 | /** | ||
1905 | * Perform a binary search on a previously sorted array. | ||
1906 | * | ||
1907 | * For example: | ||
1908 | * | ||
1909 | * ```c | ||
1910 | * typedef struct { | ||
1911 | * int key; | ||
1912 | * const char *string; | ||
1913 | * } data; | ||
1914 | * | ||
1915 | * int SDLCALL compare(const void *a, const void *b) | ||
1916 | * { | ||
1917 | * const data *A = (const data *)a; | ||
1918 | * const data *B = (const data *)b; | ||
1919 | * | ||
1920 | * if (A->n < B->n) { | ||
1921 | * return -1; | ||
1922 | * } else if (B->n < A->n) { | ||
1923 | * return 1; | ||
1924 | * } else { | ||
1925 | * return 0; | ||
1926 | * } | ||
1927 | * } | ||
1928 | * | ||
1929 | * data values[] = { | ||
1930 | * { 1, "first" }, { 2, "second" }, { 3, "third" } | ||
1931 | * }; | ||
1932 | * data key = { 2, NULL }; | ||
1933 | * | ||
1934 | * data *result = SDL_bsearch(&key, values, SDL_arraysize(values), sizeof(values[0]), compare); | ||
1935 | * ``` | ||
1936 | * | ||
1937 | * \param key a pointer to a key equal to the element being searched for. | ||
1938 | * \param base a pointer to the start of the array. | ||
1939 | * \param nmemb the number of elements in the array. | ||
1940 | * \param size the size of the elements in the array. | ||
1941 | * \param compare a function used to compare elements in the array. | ||
1942 | * \returns a pointer to the matching element in the array, or NULL if not | ||
1943 | * found. | ||
1944 | * | ||
1945 | * \threadsafety It is safe to call this function from any thread. | ||
1946 | * | ||
1947 | * \since This function is available since SDL 3.2.0. | ||
1948 | * | ||
1949 | * \sa SDL_bsearch_r | ||
1950 | * \sa SDL_qsort | ||
1951 | */ | ||
1952 | extern SDL_DECLSPEC void * SDLCALL SDL_bsearch(const void *key, const void *base, size_t nmemb, size_t size, SDL_CompareCallback compare); | ||
1953 | |||
1954 | /** | ||
1955 | * A callback used with SDL sorting and binary search functions. | ||
1956 | * | ||
1957 | * \param userdata the `userdata` pointer passed to the sort function. | ||
1958 | * \param a a pointer to the first element being compared. | ||
1959 | * \param b a pointer to the second element being compared. | ||
1960 | * \returns -1 if `a` should be sorted before `b`, 1 if `b` should be sorted | ||
1961 | * before `a`, 0 if they are equal. If two elements are equal, their | ||
1962 | * order in the sorted array is undefined. | ||
1963 | * | ||
1964 | * \since This callback is available since SDL 3.2.0. | ||
1965 | * | ||
1966 | * \sa SDL_qsort_r | ||
1967 | * \sa SDL_bsearch_r | ||
1968 | */ | ||
1969 | typedef int (SDLCALL *SDL_CompareCallback_r)(void *userdata, const void *a, const void *b); | ||
1970 | |||
1971 | /** | ||
1972 | * Sort an array, passing a userdata pointer to the compare function. | ||
1973 | * | ||
1974 | * For example: | ||
1975 | * | ||
1976 | * ```c | ||
1977 | * typedef enum { | ||
1978 | * sort_increasing, | ||
1979 | * sort_decreasing, | ||
1980 | * } sort_method; | ||
1981 | * | ||
1982 | * typedef struct { | ||
1983 | * int key; | ||
1984 | * const char *string; | ||
1985 | * } data; | ||
1986 | * | ||
1987 | * int SDLCALL compare(const void *userdata, const void *a, const void *b) | ||
1988 | * { | ||
1989 | * sort_method method = (sort_method)(uintptr_t)userdata; | ||
1990 | * const data *A = (const data *)a; | ||
1991 | * const data *B = (const data *)b; | ||
1992 | * | ||
1993 | * if (A->key < B->key) { | ||
1994 | * return (method == sort_increasing) ? -1 : 1; | ||
1995 | * } else if (B->key < A->key) { | ||
1996 | * return (method == sort_increasing) ? 1 : -1; | ||
1997 | * } else { | ||
1998 | * return 0; | ||
1999 | * } | ||
2000 | * } | ||
2001 | * | ||
2002 | * data values[] = { | ||
2003 | * { 3, "third" }, { 1, "first" }, { 2, "second" } | ||
2004 | * }; | ||
2005 | * | ||
2006 | * SDL_qsort_r(values, SDL_arraysize(values), sizeof(values[0]), compare, (const void *)(uintptr_t)sort_increasing); | ||
2007 | * ``` | ||
2008 | * | ||
2009 | * \param base a pointer to the start of the array. | ||
2010 | * \param nmemb the number of elements in the array. | ||
2011 | * \param size the size of the elements in the array. | ||
2012 | * \param compare a function used to compare elements in the array. | ||
2013 | * \param userdata a pointer to pass to the compare function. | ||
2014 | * | ||
2015 | * \threadsafety It is safe to call this function from any thread. | ||
2016 | * | ||
2017 | * \since This function is available since SDL 3.2.0. | ||
2018 | * | ||
2019 | * \sa SDL_bsearch_r | ||
2020 | * \sa SDL_qsort | ||
2021 | */ | ||
2022 | extern SDL_DECLSPEC void SDLCALL SDL_qsort_r(void *base, size_t nmemb, size_t size, SDL_CompareCallback_r compare, void *userdata); | ||
2023 | |||
2024 | /** | ||
2025 | * Perform a binary search on a previously sorted array, passing a userdata | ||
2026 | * pointer to the compare function. | ||
2027 | * | ||
2028 | * For example: | ||
2029 | * | ||
2030 | * ```c | ||
2031 | * typedef enum { | ||
2032 | * sort_increasing, | ||
2033 | * sort_decreasing, | ||
2034 | * } sort_method; | ||
2035 | * | ||
2036 | * typedef struct { | ||
2037 | * int key; | ||
2038 | * const char *string; | ||
2039 | * } data; | ||
2040 | * | ||
2041 | * int SDLCALL compare(const void *userdata, const void *a, const void *b) | ||
2042 | * { | ||
2043 | * sort_method method = (sort_method)(uintptr_t)userdata; | ||
2044 | * const data *A = (const data *)a; | ||
2045 | * const data *B = (const data *)b; | ||
2046 | * | ||
2047 | * if (A->key < B->key) { | ||
2048 | * return (method == sort_increasing) ? -1 : 1; | ||
2049 | * } else if (B->key < A->key) { | ||
2050 | * return (method == sort_increasing) ? 1 : -1; | ||
2051 | * } else { | ||
2052 | * return 0; | ||
2053 | * } | ||
2054 | * } | ||
2055 | * | ||
2056 | * data values[] = { | ||
2057 | * { 1, "first" }, { 2, "second" }, { 3, "third" } | ||
2058 | * }; | ||
2059 | * data key = { 2, NULL }; | ||
2060 | * | ||
2061 | * data *result = SDL_bsearch_r(&key, values, SDL_arraysize(values), sizeof(values[0]), compare, (const void *)(uintptr_t)sort_increasing); | ||
2062 | * ``` | ||
2063 | * | ||
2064 | * \param key a pointer to a key equal to the element being searched for. | ||
2065 | * \param base a pointer to the start of the array. | ||
2066 | * \param nmemb the number of elements in the array. | ||
2067 | * \param size the size of the elements in the array. | ||
2068 | * \param compare a function used to compare elements in the array. | ||
2069 | * \param userdata a pointer to pass to the compare function. | ||
2070 | * \returns a pointer to the matching element in the array, or NULL if not | ||
2071 | * found. | ||
2072 | * | ||
2073 | * \threadsafety It is safe to call this function from any thread. | ||
2074 | * | ||
2075 | * \since This function is available since SDL 3.2.0. | ||
2076 | * | ||
2077 | * \sa SDL_bsearch | ||
2078 | * \sa SDL_qsort_r | ||
2079 | */ | ||
2080 | extern SDL_DECLSPEC void * SDLCALL SDL_bsearch_r(const void *key, const void *base, size_t nmemb, size_t size, SDL_CompareCallback_r compare, void *userdata); | ||
2081 | |||
2082 | /** | ||
2083 | * Compute the absolute value of `x`. | ||
2084 | * | ||
2085 | * \param x an integer value. | ||
2086 | * \returns the absolute value of x. | ||
2087 | * | ||
2088 | * \threadsafety It is safe to call this function from any thread. | ||
2089 | * | ||
2090 | * \since This function is available since SDL 3.2.0. | ||
2091 | */ | ||
2092 | extern SDL_DECLSPEC int SDLCALL SDL_abs(int x); | ||
2093 | |||
2094 | /** | ||
2095 | * Return the lesser of two values. | ||
2096 | * | ||
2097 | * This is a helper macro that might be more clear than writing out the | ||
2098 | * comparisons directly, and works with any type that can be compared with the | ||
2099 | * `<` operator. However, it double-evaluates both its parameters, so do not | ||
2100 | * use expressions with side-effects here. | ||
2101 | * | ||
2102 | * \param x the first value to compare. | ||
2103 | * \param y the second value to compare. | ||
2104 | * \returns the lesser of `x` and `y`. | ||
2105 | * | ||
2106 | * \threadsafety It is safe to call this macro from any thread. | ||
2107 | * | ||
2108 | * \since This macro is available since SDL 3.2.0. | ||
2109 | */ | ||
2110 | #define SDL_min(x, y) (((x) < (y)) ? (x) : (y)) | ||
2111 | |||
2112 | /** | ||
2113 | * Return the greater of two values. | ||
2114 | * | ||
2115 | * This is a helper macro that might be more clear than writing out the | ||
2116 | * comparisons directly, and works with any type that can be compared with the | ||
2117 | * `>` operator. However, it double-evaluates both its parameters, so do not | ||
2118 | * use expressions with side-effects here. | ||
2119 | * | ||
2120 | * \param x the first value to compare. | ||
2121 | * \param y the second value to compare. | ||
2122 | * \returns the lesser of `x` and `y`. | ||
2123 | * | ||
2124 | * \threadsafety It is safe to call this macro from any thread. | ||
2125 | * | ||
2126 | * \since This macro is available since SDL 3.2.0. | ||
2127 | */ | ||
2128 | #define SDL_max(x, y) (((x) > (y)) ? (x) : (y)) | ||
2129 | |||
2130 | /** | ||
2131 | * Return a value clamped to a range. | ||
2132 | * | ||
2133 | * If `x` is outside the range a values between `a` and `b`, the returned | ||
2134 | * value will be `a` or `b` as appropriate. Otherwise, `x` is returned. | ||
2135 | * | ||
2136 | * This macro will produce incorrect results if `b` is less than `a`. | ||
2137 | * | ||
2138 | * This is a helper macro that might be more clear than writing out the | ||
2139 | * comparisons directly, and works with any type that can be compared with the | ||
2140 | * `<` and `>` operators. However, it double-evaluates all its parameters, so | ||
2141 | * do not use expressions with side-effects here. | ||
2142 | * | ||
2143 | * \param x the value to compare. | ||
2144 | * \param a the low end value. | ||
2145 | * \param b the high end value. | ||
2146 | * \returns x, clamped between a and b. | ||
2147 | * | ||
2148 | * \threadsafety It is safe to call this macro from any thread. | ||
2149 | * | ||
2150 | * \since This macro is available since SDL 3.2.0. | ||
2151 | */ | ||
2152 | #define SDL_clamp(x, a, b) (((x) < (a)) ? (a) : (((x) > (b)) ? (b) : (x))) | ||
2153 | |||
2154 | /** | ||
2155 | * Query if a character is alphabetic (a letter). | ||
2156 | * | ||
2157 | * **WARNING**: Regardless of system locale, this will only treat ASCII values | ||
2158 | * for English 'a-z' and 'A-Z' as true. | ||
2159 | * | ||
2160 | * \param x character value to check. | ||
2161 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2162 | * | ||
2163 | * \threadsafety It is safe to call this function from any thread. | ||
2164 | * | ||
2165 | * \since This function is available since SDL 3.2.0. | ||
2166 | */ | ||
2167 | extern SDL_DECLSPEC int SDLCALL SDL_isalpha(int x); | ||
2168 | |||
2169 | /** | ||
2170 | * Query if a character is alphabetic (a letter) or a number. | ||
2171 | * | ||
2172 | * **WARNING**: Regardless of system locale, this will only treat ASCII values | ||
2173 | * for English 'a-z', 'A-Z', and '0-9' as true. | ||
2174 | * | ||
2175 | * \param x character value to check. | ||
2176 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2177 | * | ||
2178 | * \threadsafety It is safe to call this function from any thread. | ||
2179 | * | ||
2180 | * \since This function is available since SDL 3.2.0. | ||
2181 | */ | ||
2182 | extern SDL_DECLSPEC int SDLCALL SDL_isalnum(int x); | ||
2183 | |||
2184 | /** | ||
2185 | * Report if a character is blank (a space or tab). | ||
2186 | * | ||
2187 | * **WARNING**: Regardless of system locale, this will only treat ASCII values | ||
2188 | * 0x20 (space) or 0x9 (tab) as true. | ||
2189 | * | ||
2190 | * \param x character value to check. | ||
2191 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2192 | * | ||
2193 | * \threadsafety It is safe to call this function from any thread. | ||
2194 | * | ||
2195 | * \since This function is available since SDL 3.2.0. | ||
2196 | */ | ||
2197 | extern SDL_DECLSPEC int SDLCALL SDL_isblank(int x); | ||
2198 | |||
2199 | /** | ||
2200 | * Report if a character is a control character. | ||
2201 | * | ||
2202 | * **WARNING**: Regardless of system locale, this will only treat ASCII values | ||
2203 | * 0 through 0x1F, and 0x7F, as true. | ||
2204 | * | ||
2205 | * \param x character value to check. | ||
2206 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2207 | * | ||
2208 | * \threadsafety It is safe to call this function from any thread. | ||
2209 | * | ||
2210 | * \since This function is available since SDL 3.2.0. | ||
2211 | */ | ||
2212 | extern SDL_DECLSPEC int SDLCALL SDL_iscntrl(int x); | ||
2213 | |||
2214 | /** | ||
2215 | * Report if a character is a numeric digit. | ||
2216 | * | ||
2217 | * **WARNING**: Regardless of system locale, this will only treat ASCII values | ||
2218 | * '0' (0x30) through '9' (0x39), as true. | ||
2219 | * | ||
2220 | * \param x character value to check. | ||
2221 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2222 | * | ||
2223 | * \threadsafety It is safe to call this function from any thread. | ||
2224 | * | ||
2225 | * \since This function is available since SDL 3.2.0. | ||
2226 | */ | ||
2227 | extern SDL_DECLSPEC int SDLCALL SDL_isdigit(int x); | ||
2228 | |||
2229 | /** | ||
2230 | * Report if a character is a hexadecimal digit. | ||
2231 | * | ||
2232 | * **WARNING**: Regardless of system locale, this will only treat ASCII values | ||
2233 | * 'A' through 'F', 'a' through 'f', and '0' through '9', as true. | ||
2234 | * | ||
2235 | * \param x character value to check. | ||
2236 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2237 | * | ||
2238 | * \threadsafety It is safe to call this function from any thread. | ||
2239 | * | ||
2240 | * \since This function is available since SDL 3.2.0. | ||
2241 | */ | ||
2242 | extern SDL_DECLSPEC int SDLCALL SDL_isxdigit(int x); | ||
2243 | |||
2244 | /** | ||
2245 | * Report if a character is a punctuation mark. | ||
2246 | * | ||
2247 | * **WARNING**: Regardless of system locale, this is equivalent to | ||
2248 | * `((SDL_isgraph(x)) && (!SDL_isalnum(x)))`. | ||
2249 | * | ||
2250 | * \param x character value to check. | ||
2251 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2252 | * | ||
2253 | * \threadsafety It is safe to call this function from any thread. | ||
2254 | * | ||
2255 | * \since This function is available since SDL 3.2.0. | ||
2256 | * | ||
2257 | * \sa SDL_isgraph | ||
2258 | * \sa SDL_isalnum | ||
2259 | */ | ||
2260 | extern SDL_DECLSPEC int SDLCALL SDL_ispunct(int x); | ||
2261 | |||
2262 | /** | ||
2263 | * Report if a character is whitespace. | ||
2264 | * | ||
2265 | * **WARNING**: Regardless of system locale, this will only treat the | ||
2266 | * following ASCII values as true: | ||
2267 | * | ||
2268 | * - space (0x20) | ||
2269 | * - tab (0x09) | ||
2270 | * - newline (0x0A) | ||
2271 | * - vertical tab (0x0B) | ||
2272 | * - form feed (0x0C) | ||
2273 | * - return (0x0D) | ||
2274 | * | ||
2275 | * \param x character value to check. | ||
2276 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2277 | * | ||
2278 | * \threadsafety It is safe to call this function from any thread. | ||
2279 | * | ||
2280 | * \since This function is available since SDL 3.2.0. | ||
2281 | */ | ||
2282 | extern SDL_DECLSPEC int SDLCALL SDL_isspace(int x); | ||
2283 | |||
2284 | /** | ||
2285 | * Report if a character is upper case. | ||
2286 | * | ||
2287 | * **WARNING**: Regardless of system locale, this will only treat ASCII values | ||
2288 | * 'A' through 'Z' as true. | ||
2289 | * | ||
2290 | * \param x character value to check. | ||
2291 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2292 | * | ||
2293 | * \threadsafety It is safe to call this function from any thread. | ||
2294 | * | ||
2295 | * \since This function is available since SDL 3.2.0. | ||
2296 | */ | ||
2297 | extern SDL_DECLSPEC int SDLCALL SDL_isupper(int x); | ||
2298 | |||
2299 | /** | ||
2300 | * Report if a character is lower case. | ||
2301 | * | ||
2302 | * **WARNING**: Regardless of system locale, this will only treat ASCII values | ||
2303 | * 'a' through 'z' as true. | ||
2304 | * | ||
2305 | * \param x character value to check. | ||
2306 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2307 | * | ||
2308 | * \threadsafety It is safe to call this function from any thread. | ||
2309 | * | ||
2310 | * \since This function is available since SDL 3.2.0. | ||
2311 | */ | ||
2312 | extern SDL_DECLSPEC int SDLCALL SDL_islower(int x); | ||
2313 | |||
2314 | /** | ||
2315 | * Report if a character is "printable". | ||
2316 | * | ||
2317 | * Be advised that "printable" has a definition that goes back to text | ||
2318 | * terminals from the dawn of computing, making this a sort of special case | ||
2319 | * function that is not suitable for Unicode (or most any) text management. | ||
2320 | * | ||
2321 | * **WARNING**: Regardless of system locale, this will only treat ASCII values | ||
2322 | * ' ' (0x20) through '~' (0x7E) as true. | ||
2323 | * | ||
2324 | * \param x character value to check. | ||
2325 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2326 | * | ||
2327 | * \threadsafety It is safe to call this function from any thread. | ||
2328 | * | ||
2329 | * \since This function is available since SDL 3.2.0. | ||
2330 | */ | ||
2331 | extern SDL_DECLSPEC int SDLCALL SDL_isprint(int x); | ||
2332 | |||
2333 | /** | ||
2334 | * Report if a character is any "printable" except space. | ||
2335 | * | ||
2336 | * Be advised that "printable" has a definition that goes back to text | ||
2337 | * terminals from the dawn of computing, making this a sort of special case | ||
2338 | * function that is not suitable for Unicode (or most any) text management. | ||
2339 | * | ||
2340 | * **WARNING**: Regardless of system locale, this is equivalent to | ||
2341 | * `(SDL_isprint(x)) && ((x) != ' ')`. | ||
2342 | * | ||
2343 | * \param x character value to check. | ||
2344 | * \returns non-zero if x falls within the character class, zero otherwise. | ||
2345 | * | ||
2346 | * \threadsafety It is safe to call this function from any thread. | ||
2347 | * | ||
2348 | * \since This function is available since SDL 3.2.0. | ||
2349 | * | ||
2350 | * \sa SDL_isprint | ||
2351 | */ | ||
2352 | extern SDL_DECLSPEC int SDLCALL SDL_isgraph(int x); | ||
2353 | |||
2354 | /** | ||
2355 | * Convert low-ASCII English letters to uppercase. | ||
2356 | * | ||
2357 | * **WARNING**: Regardless of system locale, this will only convert ASCII | ||
2358 | * values 'a' through 'z' to uppercase. | ||
2359 | * | ||
2360 | * This function returns the uppercase equivalent of `x`. If a character | ||
2361 | * cannot be converted, or is already uppercase, this function returns `x`. | ||
2362 | * | ||
2363 | * \param x character value to check. | ||
2364 | * \returns capitalized version of x, or x if no conversion available. | ||
2365 | * | ||
2366 | * \threadsafety It is safe to call this function from any thread. | ||
2367 | * | ||
2368 | * \since This function is available since SDL 3.2.0. | ||
2369 | */ | ||
2370 | extern SDL_DECLSPEC int SDLCALL SDL_toupper(int x); | ||
2371 | |||
2372 | /** | ||
2373 | * Convert low-ASCII English letters to lowercase. | ||
2374 | * | ||
2375 | * **WARNING**: Regardless of system locale, this will only convert ASCII | ||
2376 | * values 'A' through 'Z' to lowercase. | ||
2377 | * | ||
2378 | * This function returns the lowercase equivalent of `x`. If a character | ||
2379 | * cannot be converted, or is already lowercase, this function returns `x`. | ||
2380 | * | ||
2381 | * \param x character value to check. | ||
2382 | * \returns lowercase version of x, or x if no conversion available. | ||
2383 | * | ||
2384 | * \threadsafety It is safe to call this function from any thread. | ||
2385 | * | ||
2386 | * \since This function is available since SDL 3.2.0. | ||
2387 | */ | ||
2388 | extern SDL_DECLSPEC int SDLCALL SDL_tolower(int x); | ||
2389 | |||
2390 | /** | ||
2391 | * Calculate a CRC-16 value. | ||
2392 | * | ||
2393 | * https://en.wikipedia.org/wiki/Cyclic_redundancy_check | ||
2394 | * | ||
2395 | * This function can be called multiple times, to stream data to be | ||
2396 | * checksummed in blocks. Each call must provide the previous CRC-16 return | ||
2397 | * value to be updated with the next block. The first call to this function | ||
2398 | * for a set of blocks should pass in a zero CRC value. | ||
2399 | * | ||
2400 | * \param crc the current checksum for this data set, or 0 for a new data set. | ||
2401 | * \param data a new block of data to add to the checksum. | ||
2402 | * \param len the size, in bytes, of the new block of data. | ||
2403 | * \returns a CRC-16 checksum value of all blocks in the data set. | ||
2404 | * | ||
2405 | * \threadsafety It is safe to call this function from any thread. | ||
2406 | * | ||
2407 | * \since This function is available since SDL 3.2.0. | ||
2408 | */ | ||
2409 | extern SDL_DECLSPEC Uint16 SDLCALL SDL_crc16(Uint16 crc, const void *data, size_t len); | ||
2410 | |||
2411 | /** | ||
2412 | * Calculate a CRC-32 value. | ||
2413 | * | ||
2414 | * https://en.wikipedia.org/wiki/Cyclic_redundancy_check | ||
2415 | * | ||
2416 | * This function can be called multiple times, to stream data to be | ||
2417 | * checksummed in blocks. Each call must provide the previous CRC-32 return | ||
2418 | * value to be updated with the next block. The first call to this function | ||
2419 | * for a set of blocks should pass in a zero CRC value. | ||
2420 | * | ||
2421 | * \param crc the current checksum for this data set, or 0 for a new data set. | ||
2422 | * \param data a new block of data to add to the checksum. | ||
2423 | * \param len the size, in bytes, of the new block of data. | ||
2424 | * \returns a CRC-32 checksum value of all blocks in the data set. | ||
2425 | * | ||
2426 | * \threadsafety It is safe to call this function from any thread. | ||
2427 | * | ||
2428 | * \since This function is available since SDL 3.2.0. | ||
2429 | */ | ||
2430 | extern SDL_DECLSPEC Uint32 SDLCALL SDL_crc32(Uint32 crc, const void *data, size_t len); | ||
2431 | |||
2432 | /** | ||
2433 | * Calculate a 32-bit MurmurHash3 value for a block of data. | ||
2434 | * | ||
2435 | * https://en.wikipedia.org/wiki/MurmurHash | ||
2436 | * | ||
2437 | * A seed may be specified, which changes the final results consistently, but | ||
2438 | * this does not work like SDL_crc16 and SDL_crc32: you can't feed a previous | ||
2439 | * result from this function back into itself as the next seed value to | ||
2440 | * calculate a hash in chunks; it won't produce the same hash as it would if | ||
2441 | * the same data was provided in a single call. | ||
2442 | * | ||
2443 | * If you aren't sure what to provide for a seed, zero is fine. Murmur3 is not | ||
2444 | * cryptographically secure, so it shouldn't be used for hashing top-secret | ||
2445 | * data. | ||
2446 | * | ||
2447 | * \param data the data to be hashed. | ||
2448 | * \param len the size of data, in bytes. | ||
2449 | * \param seed a value that alters the final hash value. | ||
2450 | * \returns a Murmur3 32-bit hash value. | ||
2451 | * | ||
2452 | * \threadsafety It is safe to call this function from any thread. | ||
2453 | * | ||
2454 | * \since This function is available since SDL 3.2.0. | ||
2455 | */ | ||
2456 | extern SDL_DECLSPEC Uint32 SDLCALL SDL_murmur3_32(const void *data, size_t len, Uint32 seed); | ||
2457 | |||
2458 | /** | ||
2459 | * Copy non-overlapping memory. | ||
2460 | * | ||
2461 | * The memory regions must not overlap. If they do, use SDL_memmove() instead. | ||
2462 | * | ||
2463 | * \param dst The destination memory region. Must not be NULL, and must not | ||
2464 | * overlap with `src`. | ||
2465 | * \param src The source memory region. Must not be NULL, and must not overlap | ||
2466 | * with `dst`. | ||
2467 | * \param len The length in bytes of both `dst` and `src`. | ||
2468 | * \returns `dst`. | ||
2469 | * | ||
2470 | * \threadsafety It is safe to call this function from any thread. | ||
2471 | * | ||
2472 | * \since This function is available since SDL 3.2.0. | ||
2473 | * | ||
2474 | * \sa SDL_memmove | ||
2475 | */ | ||
2476 | extern SDL_DECLSPEC void * SDLCALL SDL_memcpy(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len); | ||
2477 | |||
2478 | /* Take advantage of compiler optimizations for memcpy */ | ||
2479 | #ifndef SDL_SLOW_MEMCPY | ||
2480 | #ifdef SDL_memcpy | ||
2481 | #undef SDL_memcpy | ||
2482 | #endif | ||
2483 | #define SDL_memcpy memcpy | ||
2484 | #endif | ||
2485 | |||
2486 | |||
2487 | /** | ||
2488 | * A macro to copy memory between objects, with basic type checking. | ||
2489 | * | ||
2490 | * SDL_memcpy and SDL_memmove do not care where you copy memory to and from, | ||
2491 | * which can lead to bugs. This macro aims to avoid most of those bugs by | ||
2492 | * making sure that the source and destination are both pointers to objects | ||
2493 | * that are the same size. It does not check that the objects are the same | ||
2494 | * _type_, just that the copy will not overflow either object. | ||
2495 | * | ||
2496 | * The size check happens at compile time, and the compiler will throw an | ||
2497 | * error if the objects are different sizes. | ||
2498 | * | ||
2499 | * Generally this is intended to copy a single object, not an array. | ||
2500 | * | ||
2501 | * This macro looks like it double-evaluates its parameters, but the extras | ||
2502 | * them are in `sizeof` sections, which generate no code nor side-effects. | ||
2503 | * | ||
2504 | * \param dst a pointer to the destination object. Must not be NULL. | ||
2505 | * \param src a pointer to the source object. Must not be NULL. | ||
2506 | * | ||
2507 | * \threadsafety It is safe to call this function from any thread. | ||
2508 | * | ||
2509 | * \since This function is available since SDL 3.2.0. | ||
2510 | */ | ||
2511 | #define SDL_copyp(dst, src) \ | ||
2512 | { SDL_COMPILE_TIME_ASSERT(SDL_copyp, sizeof (*(dst)) == sizeof (*(src))); } \ | ||
2513 | SDL_memcpy((dst), (src), sizeof(*(src))) | ||
2514 | |||
2515 | /** | ||
2516 | * Copy memory ranges that might overlap. | ||
2517 | * | ||
2518 | * It is okay for the memory regions to overlap. If you are confident that the | ||
2519 | * regions never overlap, using SDL_memcpy() may improve performance. | ||
2520 | * | ||
2521 | * \param dst The destination memory region. Must not be NULL. | ||
2522 | * \param src The source memory region. Must not be NULL. | ||
2523 | * \param len The length in bytes of both `dst` and `src`. | ||
2524 | * \returns `dst`. | ||
2525 | * | ||
2526 | * \threadsafety It is safe to call this function from any thread. | ||
2527 | * | ||
2528 | * \since This function is available since SDL 3.2.0. | ||
2529 | * | ||
2530 | * \sa SDL_memcpy | ||
2531 | */ | ||
2532 | extern SDL_DECLSPEC void * SDLCALL SDL_memmove(SDL_OUT_BYTECAP(len) void *dst, SDL_IN_BYTECAP(len) const void *src, size_t len); | ||
2533 | |||
2534 | /* Take advantage of compiler optimizations for memmove */ | ||
2535 | #ifndef SDL_SLOW_MEMMOVE | ||
2536 | #ifdef SDL_memmove | ||
2537 | #undef SDL_memmove | ||
2538 | #endif | ||
2539 | #define SDL_memmove memmove | ||
2540 | #endif | ||
2541 | |||
2542 | /** | ||
2543 | * Initialize all bytes of buffer of memory to a specific value. | ||
2544 | * | ||
2545 | * This function will set `len` bytes, pointed to by `dst`, to the value | ||
2546 | * specified in `c`. | ||
2547 | * | ||
2548 | * Despite `c` being an `int` instead of a `char`, this only operates on | ||
2549 | * bytes; `c` must be a value between 0 and 255, inclusive. | ||
2550 | * | ||
2551 | * \param dst the destination memory region. Must not be NULL. | ||
2552 | * \param c the byte value to set. | ||
2553 | * \param len the length, in bytes, to set in `dst`. | ||
2554 | * \returns `dst`. | ||
2555 | * | ||
2556 | * \threadsafety It is safe to call this function from any thread. | ||
2557 | * | ||
2558 | * \since This function is available since SDL 3.2.0. | ||
2559 | */ | ||
2560 | extern SDL_DECLSPEC void * SDLCALL SDL_memset(SDL_OUT_BYTECAP(len) void *dst, int c, size_t len); | ||
2561 | |||
2562 | /** | ||
2563 | * Initialize all 32-bit words of buffer of memory to a specific value. | ||
2564 | * | ||
2565 | * This function will set a buffer of `dwords` Uint32 values, pointed to by | ||
2566 | * `dst`, to the value specified in `val`. | ||
2567 | * | ||
2568 | * Unlike SDL_memset, this sets 32-bit values, not bytes, so it's not limited | ||
2569 | * to a range of 0-255. | ||
2570 | * | ||
2571 | * \param dst the destination memory region. Must not be NULL. | ||
2572 | * \param val the Uint32 value to set. | ||
2573 | * \param dwords the number of Uint32 values to set in `dst`. | ||
2574 | * \returns `dst`. | ||
2575 | * | ||
2576 | * \threadsafety It is safe to call this function from any thread. | ||
2577 | * | ||
2578 | * \since This function is available since SDL 3.2.0. | ||
2579 | */ | ||
2580 | extern SDL_DECLSPEC void * SDLCALL SDL_memset4(void *dst, Uint32 val, size_t dwords); | ||
2581 | |||
2582 | /* Take advantage of compiler optimizations for memset */ | ||
2583 | #ifndef SDL_SLOW_MEMSET | ||
2584 | #ifdef SDL_memset | ||
2585 | #undef SDL_memset | ||
2586 | #endif | ||
2587 | #define SDL_memset memset | ||
2588 | #endif | ||
2589 | |||
2590 | /** | ||
2591 | * Clear an object's memory to zero. | ||
2592 | * | ||
2593 | * This is wrapper over SDL_memset that handles calculating the object size, | ||
2594 | * so there's no chance of copy/paste errors, and the code is cleaner. | ||
2595 | * | ||
2596 | * This requires an object, not a pointer to an object, nor an array. | ||
2597 | * | ||
2598 | * \param x the object to clear. | ||
2599 | * | ||
2600 | * \threadsafety It is safe to call this macro from any thread. | ||
2601 | * | ||
2602 | * \since This macro is available since SDL 3.2.0. | ||
2603 | * | ||
2604 | * \sa SDL_zerop | ||
2605 | * \sa SDL_zeroa | ||
2606 | */ | ||
2607 | #define SDL_zero(x) SDL_memset(&(x), 0, sizeof((x))) | ||
2608 | |||
2609 | /** | ||
2610 | * Clear an object's memory to zero, using a pointer. | ||
2611 | * | ||
2612 | * This is wrapper over SDL_memset that handles calculating the object size, | ||
2613 | * so there's no chance of copy/paste errors, and the code is cleaner. | ||
2614 | * | ||
2615 | * This requires a pointer to an object, not an object itself, nor an array. | ||
2616 | * | ||
2617 | * \param x a pointer to the object to clear. | ||
2618 | * | ||
2619 | * \threadsafety It is safe to call this macro from any thread. | ||
2620 | * | ||
2621 | * \since This macro is available since SDL 3.2.0. | ||
2622 | * | ||
2623 | * \sa SDL_zero | ||
2624 | * \sa SDL_zeroa | ||
2625 | */ | ||
2626 | #define SDL_zerop(x) SDL_memset((x), 0, sizeof(*(x))) | ||
2627 | |||
2628 | /** | ||
2629 | * Clear an array's memory to zero. | ||
2630 | * | ||
2631 | * This is wrapper over SDL_memset that handles calculating the array size, so | ||
2632 | * there's no chance of copy/paste errors, and the code is cleaner. | ||
2633 | * | ||
2634 | * This requires an array, not an object, nor a pointer to an object. | ||
2635 | * | ||
2636 | * \param x an array to clear. | ||
2637 | * | ||
2638 | * \threadsafety It is safe to call this macro from any thread. | ||
2639 | * | ||
2640 | * \since This macro is available since SDL 3.2.0. | ||
2641 | * | ||
2642 | * \sa SDL_zero | ||
2643 | * \sa SDL_zeroa | ||
2644 | */ | ||
2645 | #define SDL_zeroa(x) SDL_memset((x), 0, sizeof((x))) | ||
2646 | |||
2647 | |||
2648 | /** | ||
2649 | * Compare two buffers of memory. | ||
2650 | * | ||
2651 | * \param s1 the first buffer to compare. NULL is not permitted! | ||
2652 | * \param s2 the second buffer to compare. NULL is not permitted! | ||
2653 | * \param len the number of bytes to compare between the buffers. | ||
2654 | * \returns less than zero if s1 is "less than" s2, greater than zero if s1 is | ||
2655 | * "greater than" s2, and zero if the buffers match exactly for `len` | ||
2656 | * bytes. | ||
2657 | * | ||
2658 | * \threadsafety It is safe to call this function from any thread. | ||
2659 | * | ||
2660 | * \since This function is available since SDL 3.2.0. | ||
2661 | */ | ||
2662 | extern SDL_DECLSPEC int SDLCALL SDL_memcmp(const void *s1, const void *s2, size_t len); | ||
2663 | |||
2664 | /** | ||
2665 | * This works exactly like wcslen() but doesn't require access to a C runtime. | ||
2666 | * | ||
2667 | * Counts the number of wchar_t values in `wstr`, excluding the null | ||
2668 | * terminator. | ||
2669 | * | ||
2670 | * Like SDL_strlen only counts bytes and not codepoints in a UTF-8 string, | ||
2671 | * this counts wchar_t values in a string, even if the string's encoding is of | ||
2672 | * variable width, like UTF-16. | ||
2673 | * | ||
2674 | * Also be aware that wchar_t is different sizes on different platforms (4 | ||
2675 | * bytes on Linux, 2 on Windows, etc). | ||
2676 | * | ||
2677 | * \param wstr The null-terminated wide string to read. Must not be NULL. | ||
2678 | * \returns the length (in wchar_t values, excluding the null terminator) of | ||
2679 | * `wstr`. | ||
2680 | * | ||
2681 | * \threadsafety It is safe to call this function from any thread. | ||
2682 | * | ||
2683 | * \since This function is available since SDL 3.2.0. | ||
2684 | * | ||
2685 | * \sa SDL_wcsnlen | ||
2686 | * \sa SDL_utf8strlen | ||
2687 | * \sa SDL_utf8strnlen | ||
2688 | */ | ||
2689 | extern SDL_DECLSPEC size_t SDLCALL SDL_wcslen(const wchar_t *wstr); | ||
2690 | |||
2691 | /** | ||
2692 | * This works exactly like wcsnlen() but doesn't require access to a C | ||
2693 | * runtime. | ||
2694 | * | ||
2695 | * Counts up to a maximum of `maxlen` wchar_t values in `wstr`, excluding the | ||
2696 | * null terminator. | ||
2697 | * | ||
2698 | * Like SDL_strnlen only counts bytes and not codepoints in a UTF-8 string, | ||
2699 | * this counts wchar_t values in a string, even if the string's encoding is of | ||
2700 | * variable width, like UTF-16. | ||
2701 | * | ||
2702 | * Also be aware that wchar_t is different sizes on different platforms (4 | ||
2703 | * bytes on Linux, 2 on Windows, etc). | ||
2704 | * | ||
2705 | * Also, `maxlen` is a count of wide characters, not bytes! | ||
2706 | * | ||
2707 | * \param wstr The null-terminated wide string to read. Must not be NULL. | ||
2708 | * \param maxlen The maximum amount of wide characters to count. | ||
2709 | * \returns the length (in wide characters, excluding the null terminator) of | ||
2710 | * `wstr` but never more than `maxlen`. | ||
2711 | * | ||
2712 | * \threadsafety It is safe to call this function from any thread. | ||
2713 | * | ||
2714 | * \since This function is available since SDL 3.2.0. | ||
2715 | * | ||
2716 | * \sa SDL_wcslen | ||
2717 | * \sa SDL_utf8strlen | ||
2718 | * \sa SDL_utf8strnlen | ||
2719 | */ | ||
2720 | extern SDL_DECLSPEC size_t SDLCALL SDL_wcsnlen(const wchar_t *wstr, size_t maxlen); | ||
2721 | |||
2722 | /** | ||
2723 | * Copy a wide string. | ||
2724 | * | ||
2725 | * This function copies `maxlen` - 1 wide characters from `src` to `dst`, then | ||
2726 | * appends a null terminator. | ||
2727 | * | ||
2728 | * `src` and `dst` must not overlap. | ||
2729 | * | ||
2730 | * If `maxlen` is 0, no wide characters are copied and no null terminator is | ||
2731 | * written. | ||
2732 | * | ||
2733 | * \param dst The destination buffer. Must not be NULL, and must not overlap | ||
2734 | * with `src`. | ||
2735 | * \param src The null-terminated wide string to copy. Must not be NULL, and | ||
2736 | * must not overlap with `dst`. | ||
2737 | * \param maxlen The length (in wide characters) of the destination buffer. | ||
2738 | * \returns the length (in wide characters, excluding the null terminator) of | ||
2739 | * `src`. | ||
2740 | * | ||
2741 | * \threadsafety It is safe to call this function from any thread. | ||
2742 | * | ||
2743 | * \since This function is available since SDL 3.2.0. | ||
2744 | * | ||
2745 | * \sa SDL_wcslcat | ||
2746 | */ | ||
2747 | extern SDL_DECLSPEC size_t SDLCALL SDL_wcslcpy(SDL_OUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen); | ||
2748 | |||
2749 | /** | ||
2750 | * Concatenate wide strings. | ||
2751 | * | ||
2752 | * This function appends up to `maxlen` - SDL_wcslen(dst) - 1 wide characters | ||
2753 | * from `src` to the end of the wide string in `dst`, then appends a null | ||
2754 | * terminator. | ||
2755 | * | ||
2756 | * `src` and `dst` must not overlap. | ||
2757 | * | ||
2758 | * If `maxlen` - SDL_wcslen(dst) - 1 is less than or equal to 0, then `dst` is | ||
2759 | * unmodified. | ||
2760 | * | ||
2761 | * \param dst The destination buffer already containing the first | ||
2762 | * null-terminated wide string. Must not be NULL and must not | ||
2763 | * overlap with `src`. | ||
2764 | * \param src The second null-terminated wide string. Must not be NULL, and | ||
2765 | * must not overlap with `dst`. | ||
2766 | * \param maxlen The length (in wide characters) of the destination buffer. | ||
2767 | * \returns the length (in wide characters, excluding the null terminator) of | ||
2768 | * the string in `dst` plus the length of `src`. | ||
2769 | * | ||
2770 | * \threadsafety It is safe to call this function from any thread. | ||
2771 | * | ||
2772 | * \since This function is available since SDL 3.2.0. | ||
2773 | * | ||
2774 | * \sa SDL_wcslcpy | ||
2775 | */ | ||
2776 | extern SDL_DECLSPEC size_t SDLCALL SDL_wcslcat(SDL_INOUT_Z_CAP(maxlen) wchar_t *dst, const wchar_t *src, size_t maxlen); | ||
2777 | |||
2778 | /** | ||
2779 | * Allocate a copy of a wide string. | ||
2780 | * | ||
2781 | * This allocates enough space for a null-terminated copy of `wstr`, using | ||
2782 | * SDL_malloc, and then makes a copy of the string into this space. | ||
2783 | * | ||
2784 | * The returned string is owned by the caller, and should be passed to | ||
2785 | * SDL_free when no longer needed. | ||
2786 | * | ||
2787 | * \param wstr the string to copy. | ||
2788 | * \returns a pointer to the newly-allocated wide string. | ||
2789 | * | ||
2790 | * \threadsafety It is safe to call this function from any thread. | ||
2791 | * | ||
2792 | * \since This function is available since SDL 3.2.0. | ||
2793 | */ | ||
2794 | extern SDL_DECLSPEC wchar_t * SDLCALL SDL_wcsdup(const wchar_t *wstr); | ||
2795 | |||
2796 | /** | ||
2797 | * Search a wide string for the first instance of a specific substring. | ||
2798 | * | ||
2799 | * The search ends once it finds the requested substring, or a null terminator | ||
2800 | * byte to end the string. | ||
2801 | * | ||
2802 | * Note that this looks for strings of _wide characters_, not _codepoints_, so | ||
2803 | * it's legal to search for malformed and incomplete UTF-16 sequences. | ||
2804 | * | ||
2805 | * \param haystack the wide string to search. Must not be NULL. | ||
2806 | * \param needle the wide string to search for. Must not be NULL. | ||
2807 | * \returns a pointer to the first instance of `needle` in the string, or NULL | ||
2808 | * if not found. | ||
2809 | * | ||
2810 | * \threadsafety It is safe to call this function from any thread. | ||
2811 | * | ||
2812 | * \since This function is available since SDL 3.2.0. | ||
2813 | */ | ||
2814 | extern SDL_DECLSPEC wchar_t * SDLCALL SDL_wcsstr(const wchar_t *haystack, const wchar_t *needle); | ||
2815 | |||
2816 | /** | ||
2817 | * Search a wide string, up to n wide chars, for the first instance of a | ||
2818 | * specific substring. | ||
2819 | * | ||
2820 | * The search ends once it finds the requested substring, or a null terminator | ||
2821 | * value to end the string, or `maxlen` wide character have been examined. It | ||
2822 | * is possible to use this function on a wide string without a null | ||
2823 | * terminator. | ||
2824 | * | ||
2825 | * Note that this looks for strings of _wide characters_, not _codepoints_, so | ||
2826 | * it's legal to search for malformed and incomplete UTF-16 sequences. | ||
2827 | * | ||
2828 | * \param haystack the wide string to search. Must not be NULL. | ||
2829 | * \param needle the wide string to search for. Must not be NULL. | ||
2830 | * \param maxlen the maximum number of wide characters to search in | ||
2831 | * `haystack`. | ||
2832 | * \returns a pointer to the first instance of `needle` in the string, or NULL | ||
2833 | * if not found. | ||
2834 | * | ||
2835 | * \threadsafety It is safe to call this function from any thread. | ||
2836 | * | ||
2837 | * \since This function is available since SDL 3.2.0. | ||
2838 | */ | ||
2839 | extern SDL_DECLSPEC wchar_t * SDLCALL SDL_wcsnstr(const wchar_t *haystack, const wchar_t *needle, size_t maxlen); | ||
2840 | |||
2841 | /** | ||
2842 | * Compare two null-terminated wide strings. | ||
2843 | * | ||
2844 | * This only compares wchar_t values until it hits a null-terminating | ||
2845 | * character; it does not care if the string is well-formed UTF-16 (or UTF-32, | ||
2846 | * depending on your platform's wchar_t size), or uses valid Unicode values. | ||
2847 | * | ||
2848 | * \param str1 the first string to compare. NULL is not permitted! | ||
2849 | * \param str2 the second string to compare. NULL is not permitted! | ||
2850 | * \returns less than zero if str1 is "less than" str2, greater than zero if | ||
2851 | * str1 is "greater than" str2, and zero if the strings match | ||
2852 | * exactly. | ||
2853 | * | ||
2854 | * \threadsafety It is safe to call this function from any thread. | ||
2855 | * | ||
2856 | * \since This function is available since SDL 3.2.0. | ||
2857 | */ | ||
2858 | extern SDL_DECLSPEC int SDLCALL SDL_wcscmp(const wchar_t *str1, const wchar_t *str2); | ||
2859 | |||
2860 | /** | ||
2861 | * Compare two wide strings up to a number of wchar_t values. | ||
2862 | * | ||
2863 | * This only compares wchar_t values; it does not care if the string is | ||
2864 | * well-formed UTF-16 (or UTF-32, depending on your platform's wchar_t size), | ||
2865 | * or uses valid Unicode values. | ||
2866 | * | ||
2867 | * Note that while this function is intended to be used with UTF-16 (or | ||
2868 | * UTF-32, depending on your platform's definition of wchar_t), it is | ||
2869 | * comparing raw wchar_t values and not Unicode codepoints: `maxlen` specifies | ||
2870 | * a wchar_t limit! If the limit lands in the middle of a multi-wchar UTF-16 | ||
2871 | * sequence, it will only compare a portion of the final character. | ||
2872 | * | ||
2873 | * `maxlen` specifies a maximum number of wchar_t to compare; if the strings | ||
2874 | * match to this number of wide chars (or both have matched to a | ||
2875 | * null-terminator character before this count), they will be considered | ||
2876 | * equal. | ||
2877 | * | ||
2878 | * \param str1 the first string to compare. NULL is not permitted! | ||
2879 | * \param str2 the second string to compare. NULL is not permitted! | ||
2880 | * \param maxlen the maximum number of wchar_t to compare. | ||
2881 | * \returns less than zero if str1 is "less than" str2, greater than zero if | ||
2882 | * str1 is "greater than" str2, and zero if the strings match | ||
2883 | * exactly. | ||
2884 | * | ||
2885 | * \threadsafety It is safe to call this function from any thread. | ||
2886 | * | ||
2887 | * \since This function is available since SDL 3.2.0. | ||
2888 | */ | ||
2889 | extern SDL_DECLSPEC int SDLCALL SDL_wcsncmp(const wchar_t *str1, const wchar_t *str2, size_t maxlen); | ||
2890 | |||
2891 | /** | ||
2892 | * Compare two null-terminated wide strings, case-insensitively. | ||
2893 | * | ||
2894 | * This will work with Unicode strings, using a technique called | ||
2895 | * "case-folding" to handle the vast majority of case-sensitive human | ||
2896 | * languages regardless of system locale. It can deal with expanding values: a | ||
2897 | * German Eszett character can compare against two ASCII 's' chars and be | ||
2898 | * considered a match, for example. A notable exception: it does not handle | ||
2899 | * the Turkish 'i' character; human language is complicated! | ||
2900 | * | ||
2901 | * Depending on your platform, "wchar_t" might be 2 bytes, and expected to be | ||
2902 | * UTF-16 encoded (like Windows), or 4 bytes in UTF-32 format. Since this | ||
2903 | * handles Unicode, it expects the string to be well-formed and not a | ||
2904 | * null-terminated string of arbitrary bytes. Characters that are not valid | ||
2905 | * UTF-16 (or UTF-32) are treated as Unicode character U+FFFD (REPLACEMENT | ||
2906 | * CHARACTER), which is to say two strings of random bits may turn out to | ||
2907 | * match if they convert to the same amount of replacement characters. | ||
2908 | * | ||
2909 | * \param str1 the first string to compare. NULL is not permitted! | ||
2910 | * \param str2 the second string to compare. NULL is not permitted! | ||
2911 | * \returns less than zero if str1 is "less than" str2, greater than zero if | ||
2912 | * str1 is "greater than" str2, and zero if the strings match | ||
2913 | * exactly. | ||
2914 | * | ||
2915 | * \threadsafety It is safe to call this function from any thread. | ||
2916 | * | ||
2917 | * \since This function is available since SDL 3.2.0. | ||
2918 | */ | ||
2919 | extern SDL_DECLSPEC int SDLCALL SDL_wcscasecmp(const wchar_t *str1, const wchar_t *str2); | ||
2920 | |||
2921 | /** | ||
2922 | * Compare two wide strings, case-insensitively, up to a number of wchar_t. | ||
2923 | * | ||
2924 | * This will work with Unicode strings, using a technique called | ||
2925 | * "case-folding" to handle the vast majority of case-sensitive human | ||
2926 | * languages regardless of system locale. It can deal with expanding values: a | ||
2927 | * German Eszett character can compare against two ASCII 's' chars and be | ||
2928 | * considered a match, for example. A notable exception: it does not handle | ||
2929 | * the Turkish 'i' character; human language is complicated! | ||
2930 | * | ||
2931 | * Depending on your platform, "wchar_t" might be 2 bytes, and expected to be | ||
2932 | * UTF-16 encoded (like Windows), or 4 bytes in UTF-32 format. Since this | ||
2933 | * handles Unicode, it expects the string to be well-formed and not a | ||
2934 | * null-terminated string of arbitrary bytes. Characters that are not valid | ||
2935 | * UTF-16 (or UTF-32) are treated as Unicode character U+FFFD (REPLACEMENT | ||
2936 | * CHARACTER), which is to say two strings of random bits may turn out to | ||
2937 | * match if they convert to the same amount of replacement characters. | ||
2938 | * | ||
2939 | * Note that while this function might deal with variable-sized characters, | ||
2940 | * `maxlen` specifies a _wchar_ limit! If the limit lands in the middle of a | ||
2941 | * multi-byte UTF-16 sequence, it may convert a portion of the final character | ||
2942 | * to one or more Unicode character U+FFFD (REPLACEMENT CHARACTER) so as not | ||
2943 | * to overflow a buffer. | ||
2944 | * | ||
2945 | * `maxlen` specifies a maximum number of wchar_t values to compare; if the | ||
2946 | * strings match to this number of wchar_t (or both have matched to a | ||
2947 | * null-terminator character before this number of bytes), they will be | ||
2948 | * considered equal. | ||
2949 | * | ||
2950 | * \param str1 the first string to compare. NULL is not permitted! | ||
2951 | * \param str2 the second string to compare. NULL is not permitted! | ||
2952 | * \param maxlen the maximum number of wchar_t values to compare. | ||
2953 | * \returns less than zero if str1 is "less than" str2, greater than zero if | ||
2954 | * str1 is "greater than" str2, and zero if the strings match | ||
2955 | * exactly. | ||
2956 | * | ||
2957 | * \threadsafety It is safe to call this function from any thread. | ||
2958 | * | ||
2959 | * \since This function is available since SDL 3.2.0. | ||
2960 | */ | ||
2961 | extern SDL_DECLSPEC int SDLCALL SDL_wcsncasecmp(const wchar_t *str1, const wchar_t *str2, size_t maxlen); | ||
2962 | |||
2963 | /** | ||
2964 | * Parse a `long` from a wide string. | ||
2965 | * | ||
2966 | * If `str` starts with whitespace, then those whitespace characters are | ||
2967 | * skipped before attempting to parse the number. | ||
2968 | * | ||
2969 | * If the parsed number does not fit inside a `long`, the result is clamped to | ||
2970 | * the minimum and maximum representable `long` values. | ||
2971 | * | ||
2972 | * \param str The null-terminated wide string to read. Must not be NULL. | ||
2973 | * \param endp If not NULL, the address of the first invalid wide character | ||
2974 | * (i.e. the next character after the parsed number) will be | ||
2975 | * written to this pointer. | ||
2976 | * \param base The base of the integer to read. Supported values are 0 and 2 | ||
2977 | * to 36 inclusive. If 0, the base will be inferred from the | ||
2978 | * number's prefix (0x for hexadecimal, 0 for octal, decimal | ||
2979 | * otherwise). | ||
2980 | * \returns the parsed `long`, or 0 if no number could be parsed. | ||
2981 | * | ||
2982 | * \threadsafety It is safe to call this function from any thread. | ||
2983 | * | ||
2984 | * \since This function is available since SDL 3.2.0. | ||
2985 | * | ||
2986 | * \sa SDL_strtol | ||
2987 | */ | ||
2988 | extern SDL_DECLSPEC long SDLCALL SDL_wcstol(const wchar_t *str, wchar_t **endp, int base); | ||
2989 | |||
2990 | /** | ||
2991 | * This works exactly like strlen() but doesn't require access to a C runtime. | ||
2992 | * | ||
2993 | * Counts the bytes in `str`, excluding the null terminator. | ||
2994 | * | ||
2995 | * If you need the length of a UTF-8 string, consider using SDL_utf8strlen(). | ||
2996 | * | ||
2997 | * \param str The null-terminated string to read. Must not be NULL. | ||
2998 | * \returns the length (in bytes, excluding the null terminator) of `src`. | ||
2999 | * | ||
3000 | * \threadsafety It is safe to call this function from any thread. | ||
3001 | * | ||
3002 | * \since This function is available since SDL 3.2.0. | ||
3003 | * | ||
3004 | * \sa SDL_strnlen | ||
3005 | * \sa SDL_utf8strlen | ||
3006 | * \sa SDL_utf8strnlen | ||
3007 | */ | ||
3008 | extern SDL_DECLSPEC size_t SDLCALL SDL_strlen(const char *str); | ||
3009 | |||
3010 | /** | ||
3011 | * This works exactly like strnlen() but doesn't require access to a C | ||
3012 | * runtime. | ||
3013 | * | ||
3014 | * Counts up to a maximum of `maxlen` bytes in `str`, excluding the null | ||
3015 | * terminator. | ||
3016 | * | ||
3017 | * If you need the length of a UTF-8 string, consider using SDL_utf8strnlen(). | ||
3018 | * | ||
3019 | * \param str The null-terminated string to read. Must not be NULL. | ||
3020 | * \param maxlen The maximum amount of bytes to count. | ||
3021 | * \returns the length (in bytes, excluding the null terminator) of `src` but | ||
3022 | * never more than `maxlen`. | ||
3023 | * | ||
3024 | * \threadsafety It is safe to call this function from any thread. | ||
3025 | * | ||
3026 | * \since This function is available since SDL 3.2.0. | ||
3027 | * | ||
3028 | * \sa SDL_strlen | ||
3029 | * \sa SDL_utf8strlen | ||
3030 | * \sa SDL_utf8strnlen | ||
3031 | */ | ||
3032 | extern SDL_DECLSPEC size_t SDLCALL SDL_strnlen(const char *str, size_t maxlen); | ||
3033 | |||
3034 | /** | ||
3035 | * Copy a string. | ||
3036 | * | ||
3037 | * This function copies up to `maxlen` - 1 characters from `src` to `dst`, | ||
3038 | * then appends a null terminator. | ||
3039 | * | ||
3040 | * If `maxlen` is 0, no characters are copied and no null terminator is | ||
3041 | * written. | ||
3042 | * | ||
3043 | * If you want to copy an UTF-8 string but need to ensure that multi-byte | ||
3044 | * sequences are not truncated, consider using SDL_utf8strlcpy(). | ||
3045 | * | ||
3046 | * \param dst The destination buffer. Must not be NULL, and must not overlap | ||
3047 | * with `src`. | ||
3048 | * \param src The null-terminated string to copy. Must not be NULL, and must | ||
3049 | * not overlap with `dst`. | ||
3050 | * \param maxlen The length (in characters) of the destination buffer. | ||
3051 | * \returns the length (in characters, excluding the null terminator) of | ||
3052 | * `src`. | ||
3053 | * | ||
3054 | * \threadsafety It is safe to call this function from any thread. | ||
3055 | * | ||
3056 | * \since This function is available since SDL 3.2.0. | ||
3057 | * | ||
3058 | * \sa SDL_strlcat | ||
3059 | * \sa SDL_utf8strlcpy | ||
3060 | */ | ||
3061 | extern SDL_DECLSPEC size_t SDLCALL SDL_strlcpy(SDL_OUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen); | ||
3062 | |||
3063 | /** | ||
3064 | * Copy an UTF-8 string. | ||
3065 | * | ||
3066 | * This function copies up to `dst_bytes` - 1 bytes from `src` to `dst` while | ||
3067 | * also ensuring that the string written to `dst` does not end in a truncated | ||
3068 | * multi-byte sequence. Finally, it appends a null terminator. | ||
3069 | * | ||
3070 | * `src` and `dst` must not overlap. | ||
3071 | * | ||
3072 | * Note that unlike SDL_strlcpy(), this function returns the number of bytes | ||
3073 | * written, not the length of `src`. | ||
3074 | * | ||
3075 | * \param dst The destination buffer. Must not be NULL, and must not overlap | ||
3076 | * with `src`. | ||
3077 | * \param src The null-terminated UTF-8 string to copy. Must not be NULL, and | ||
3078 | * must not overlap with `dst`. | ||
3079 | * \param dst_bytes The length (in bytes) of the destination buffer. Must not | ||
3080 | * be 0. | ||
3081 | * \returns the number of bytes written, excluding the null terminator. | ||
3082 | * | ||
3083 | * \threadsafety It is safe to call this function from any thread. | ||
3084 | * | ||
3085 | * \since This function is available since SDL 3.2.0. | ||
3086 | * | ||
3087 | * \sa SDL_strlcpy | ||
3088 | */ | ||
3089 | extern SDL_DECLSPEC size_t SDLCALL SDL_utf8strlcpy(SDL_OUT_Z_CAP(dst_bytes) char *dst, const char *src, size_t dst_bytes); | ||
3090 | |||
3091 | /** | ||
3092 | * Concatenate strings. | ||
3093 | * | ||
3094 | * This function appends up to `maxlen` - SDL_strlen(dst) - 1 characters from | ||
3095 | * `src` to the end of the string in `dst`, then appends a null terminator. | ||
3096 | * | ||
3097 | * `src` and `dst` must not overlap. | ||
3098 | * | ||
3099 | * If `maxlen` - SDL_strlen(dst) - 1 is less than or equal to 0, then `dst` is | ||
3100 | * unmodified. | ||
3101 | * | ||
3102 | * \param dst The destination buffer already containing the first | ||
3103 | * null-terminated string. Must not be NULL and must not overlap | ||
3104 | * with `src`. | ||
3105 | * \param src The second null-terminated string. Must not be NULL, and must | ||
3106 | * not overlap with `dst`. | ||
3107 | * \param maxlen The length (in characters) of the destination buffer. | ||
3108 | * \returns the length (in characters, excluding the null terminator) of the | ||
3109 | * string in `dst` plus the length of `src`. | ||
3110 | * | ||
3111 | * \threadsafety It is safe to call this function from any thread. | ||
3112 | * | ||
3113 | * \since This function is available since SDL 3.2.0. | ||
3114 | * | ||
3115 | * \sa SDL_strlcpy | ||
3116 | */ | ||
3117 | extern SDL_DECLSPEC size_t SDLCALL SDL_strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen); | ||
3118 | |||
3119 | /** | ||
3120 | * Allocate a copy of a string. | ||
3121 | * | ||
3122 | * This allocates enough space for a null-terminated copy of `str`, using | ||
3123 | * SDL_malloc, and then makes a copy of the string into this space. | ||
3124 | * | ||
3125 | * The returned string is owned by the caller, and should be passed to | ||
3126 | * SDL_free when no longer needed. | ||
3127 | * | ||
3128 | * \param str the string to copy. | ||
3129 | * \returns a pointer to the newly-allocated string. | ||
3130 | * | ||
3131 | * \threadsafety It is safe to call this function from any thread. | ||
3132 | * | ||
3133 | * \since This function is available since SDL 3.2.0. | ||
3134 | */ | ||
3135 | extern SDL_DECLSPEC SDL_MALLOC char * SDLCALL SDL_strdup(const char *str); | ||
3136 | |||
3137 | /** | ||
3138 | * Allocate a copy of a string, up to n characters. | ||
3139 | * | ||
3140 | * This allocates enough space for a null-terminated copy of `str`, up to | ||
3141 | * `maxlen` bytes, using SDL_malloc, and then makes a copy of the string into | ||
3142 | * this space. | ||
3143 | * | ||
3144 | * If the string is longer than `maxlen` bytes, the returned string will be | ||
3145 | * `maxlen` bytes long, plus a null-terminator character that isn't included | ||
3146 | * in the count. | ||
3147 | * | ||
3148 | * The returned string is owned by the caller, and should be passed to | ||
3149 | * SDL_free when no longer needed. | ||
3150 | * | ||
3151 | * \param str the string to copy. | ||
3152 | * \param maxlen the maximum length of the copied string, not counting the | ||
3153 | * null-terminator character. | ||
3154 | * \returns a pointer to the newly-allocated string. | ||
3155 | * | ||
3156 | * \threadsafety It is safe to call this function from any thread. | ||
3157 | * | ||
3158 | * \since This function is available since SDL 3.2.0. | ||
3159 | */ | ||
3160 | extern SDL_DECLSPEC SDL_MALLOC char * SDLCALL SDL_strndup(const char *str, size_t maxlen); | ||
3161 | |||
3162 | /** | ||
3163 | * Reverse a string's contents. | ||
3164 | * | ||
3165 | * This reverses a null-terminated string in-place. Only the content of the | ||
3166 | * string is reversed; the null-terminator character remains at the end of the | ||
3167 | * reversed string. | ||
3168 | * | ||
3169 | * **WARNING**: This function reverses the _bytes_ of the string, not the | ||
3170 | * codepoints. If `str` is a UTF-8 string with Unicode codepoints > 127, this | ||
3171 | * will ruin the string data. You should only use this function on strings | ||
3172 | * that are completely comprised of low ASCII characters. | ||
3173 | * | ||
3174 | * \param str the string to reverse. | ||
3175 | * \returns `str`. | ||
3176 | * | ||
3177 | * \threadsafety It is safe to call this function from any thread. | ||
3178 | * | ||
3179 | * \since This function is available since SDL 3.2.0. | ||
3180 | */ | ||
3181 | extern SDL_DECLSPEC char * SDLCALL SDL_strrev(char *str); | ||
3182 | |||
3183 | /** | ||
3184 | * Convert a string to uppercase. | ||
3185 | * | ||
3186 | * **WARNING**: Regardless of system locale, this will only convert ASCII | ||
3187 | * values 'A' through 'Z' to uppercase. | ||
3188 | * | ||
3189 | * This function operates on a null-terminated string of bytes--even if it is | ||
3190 | * malformed UTF-8!--and converts ASCII characters 'a' through 'z' to their | ||
3191 | * uppercase equivalents in-place, returning the original `str` pointer. | ||
3192 | * | ||
3193 | * \param str the string to convert in-place. Can not be NULL. | ||
3194 | * \returns the `str` pointer passed into this function. | ||
3195 | * | ||
3196 | * \threadsafety It is safe to call this function from any thread. | ||
3197 | * | ||
3198 | * \since This function is available since SDL 3.2.0. | ||
3199 | * | ||
3200 | * \sa SDL_strlwr | ||
3201 | */ | ||
3202 | extern SDL_DECLSPEC char * SDLCALL SDL_strupr(char *str); | ||
3203 | |||
3204 | /** | ||
3205 | * Convert a string to lowercase. | ||
3206 | * | ||
3207 | * **WARNING**: Regardless of system locale, this will only convert ASCII | ||
3208 | * values 'A' through 'Z' to lowercase. | ||
3209 | * | ||
3210 | * This function operates on a null-terminated string of bytes--even if it is | ||
3211 | * malformed UTF-8!--and converts ASCII characters 'A' through 'Z' to their | ||
3212 | * lowercase equivalents in-place, returning the original `str` pointer. | ||
3213 | * | ||
3214 | * \param str the string to convert in-place. Can not be NULL. | ||
3215 | * \returns the `str` pointer passed into this function. | ||
3216 | * | ||
3217 | * \threadsafety It is safe to call this function from any thread. | ||
3218 | * | ||
3219 | * \since This function is available since SDL 3.2.0. | ||
3220 | * | ||
3221 | * \sa SDL_strupr | ||
3222 | */ | ||
3223 | extern SDL_DECLSPEC char * SDLCALL SDL_strlwr(char *str); | ||
3224 | |||
3225 | /** | ||
3226 | * Search a string for the first instance of a specific byte. | ||
3227 | * | ||
3228 | * The search ends once it finds the requested byte value, or a null | ||
3229 | * terminator byte to end the string. | ||
3230 | * | ||
3231 | * Note that this looks for _bytes_, not _characters_, so you cannot match | ||
3232 | * against a Unicode codepoint > 255, regardless of character encoding. | ||
3233 | * | ||
3234 | * \param str the string to search. Must not be NULL. | ||
3235 | * \param c the byte value to search for. | ||
3236 | * \returns a pointer to the first instance of `c` in the string, or NULL if | ||
3237 | * not found. | ||
3238 | * | ||
3239 | * \threadsafety It is safe to call this function from any thread. | ||
3240 | * | ||
3241 | * \since This function is available since SDL 3.2.0. | ||
3242 | */ | ||
3243 | extern SDL_DECLSPEC char * SDLCALL SDL_strchr(const char *str, int c); | ||
3244 | |||
3245 | /** | ||
3246 | * Search a string for the last instance of a specific byte. | ||
3247 | * | ||
3248 | * The search must go until it finds a null terminator byte to end the string. | ||
3249 | * | ||
3250 | * Note that this looks for _bytes_, not _characters_, so you cannot match | ||
3251 | * against a Unicode codepoint > 255, regardless of character encoding. | ||
3252 | * | ||
3253 | * \param str the string to search. Must not be NULL. | ||
3254 | * \param c the byte value to search for. | ||
3255 | * \returns a pointer to the last instance of `c` in the string, or NULL if | ||
3256 | * not found. | ||
3257 | * | ||
3258 | * \threadsafety It is safe to call this function from any thread. | ||
3259 | * | ||
3260 | * \since This function is available since SDL 3.2.0. | ||
3261 | */ | ||
3262 | extern SDL_DECLSPEC char * SDLCALL SDL_strrchr(const char *str, int c); | ||
3263 | |||
3264 | /** | ||
3265 | * Search a string for the first instance of a specific substring. | ||
3266 | * | ||
3267 | * The search ends once it finds the requested substring, or a null terminator | ||
3268 | * byte to end the string. | ||
3269 | * | ||
3270 | * Note that this looks for strings of _bytes_, not _characters_, so it's | ||
3271 | * legal to search for malformed and incomplete UTF-8 sequences. | ||
3272 | * | ||
3273 | * \param haystack the string to search. Must not be NULL. | ||
3274 | * \param needle the string to search for. Must not be NULL. | ||
3275 | * \returns a pointer to the first instance of `needle` in the string, or NULL | ||
3276 | * if not found. | ||
3277 | * | ||
3278 | * \threadsafety It is safe to call this function from any thread. | ||
3279 | * | ||
3280 | * \since This function is available since SDL 3.2.0. | ||
3281 | */ | ||
3282 | extern SDL_DECLSPEC char * SDLCALL SDL_strstr(const char *haystack, const char *needle); | ||
3283 | |||
3284 | /** | ||
3285 | * Search a string, up to n bytes, for the first instance of a specific | ||
3286 | * substring. | ||
3287 | * | ||
3288 | * The search ends once it finds the requested substring, or a null terminator | ||
3289 | * byte to end the string, or `maxlen` bytes have been examined. It is | ||
3290 | * possible to use this function on a string without a null terminator. | ||
3291 | * | ||
3292 | * Note that this looks for strings of _bytes_, not _characters_, so it's | ||
3293 | * legal to search for malformed and incomplete UTF-8 sequences. | ||
3294 | * | ||
3295 | * \param haystack the string to search. Must not be NULL. | ||
3296 | * \param needle the string to search for. Must not be NULL. | ||
3297 | * \param maxlen the maximum number of bytes to search in `haystack`. | ||
3298 | * \returns a pointer to the first instance of `needle` in the string, or NULL | ||
3299 | * if not found. | ||
3300 | * | ||
3301 | * \threadsafety It is safe to call this function from any thread. | ||
3302 | * | ||
3303 | * \since This function is available since SDL 3.2.0. | ||
3304 | */ | ||
3305 | extern SDL_DECLSPEC char * SDLCALL SDL_strnstr(const char *haystack, const char *needle, size_t maxlen); | ||
3306 | |||
3307 | /** | ||
3308 | * Search a UTF-8 string for the first instance of a specific substring, | ||
3309 | * case-insensitively. | ||
3310 | * | ||
3311 | * This will work with Unicode strings, using a technique called | ||
3312 | * "case-folding" to handle the vast majority of case-sensitive human | ||
3313 | * languages regardless of system locale. It can deal with expanding values: a | ||
3314 | * German Eszett character can compare against two ASCII 's' chars and be | ||
3315 | * considered a match, for example. A notable exception: it does not handle | ||
3316 | * the Turkish 'i' character; human language is complicated! | ||
3317 | * | ||
3318 | * Since this handles Unicode, it expects the strings to be well-formed UTF-8 | ||
3319 | * and not a null-terminated string of arbitrary bytes. Bytes that are not | ||
3320 | * valid UTF-8 are treated as Unicode character U+FFFD (REPLACEMENT | ||
3321 | * CHARACTER), which is to say two strings of random bits may turn out to | ||
3322 | * match if they convert to the same amount of replacement characters. | ||
3323 | * | ||
3324 | * \param haystack the string to search. Must not be NULL. | ||
3325 | * \param needle the string to search for. Must not be NULL. | ||
3326 | * \returns a pointer to the first instance of `needle` in the string, or NULL | ||
3327 | * if not found. | ||
3328 | * | ||
3329 | * \threadsafety It is safe to call this function from any thread. | ||
3330 | * | ||
3331 | * \since This function is available since SDL 3.2.0. | ||
3332 | */ | ||
3333 | extern SDL_DECLSPEC char * SDLCALL SDL_strcasestr(const char *haystack, const char *needle); | ||
3334 | |||
3335 | /** | ||
3336 | * This works exactly like strtok_r() but doesn't require access to a C | ||
3337 | * runtime. | ||
3338 | * | ||
3339 | * Break a string up into a series of tokens. | ||
3340 | * | ||
3341 | * To start tokenizing a new string, `str` should be the non-NULL address of | ||
3342 | * the string to start tokenizing. Future calls to get the next token from the | ||
3343 | * same string should specify a NULL. | ||
3344 | * | ||
3345 | * Note that this function will overwrite pieces of `str` with null chars to | ||
3346 | * split it into tokens. This function cannot be used with const/read-only | ||
3347 | * strings! | ||
3348 | * | ||
3349 | * `saveptr` just needs to point to a `char *` that can be overwritten; SDL | ||
3350 | * will use this to save tokenizing state between calls. It is initialized if | ||
3351 | * `str` is non-NULL, and used to resume tokenizing when `str` is NULL. | ||
3352 | * | ||
3353 | * \param str the string to tokenize, or NULL to continue tokenizing. | ||
3354 | * \param delim the delimiter string that separates tokens. | ||
3355 | * \param saveptr pointer to a char *, used for ongoing state. | ||
3356 | * \returns A pointer to the next token, or NULL if no tokens remain. | ||
3357 | * | ||
3358 | * \threadsafety It is safe to call this function from any thread. | ||
3359 | * | ||
3360 | * \since This function is available since SDL 3.2.0. | ||
3361 | */ | ||
3362 | extern SDL_DECLSPEC char * SDLCALL SDL_strtok_r(char *str, const char *delim, char **saveptr); | ||
3363 | |||
3364 | /** | ||
3365 | * Count the number of codepoints in a UTF-8 string. | ||
3366 | * | ||
3367 | * Counts the _codepoints_, not _bytes_, in `str`, excluding the null | ||
3368 | * terminator. | ||
3369 | * | ||
3370 | * If you need to count the bytes in a string instead, consider using | ||
3371 | * SDL_strlen(). | ||
3372 | * | ||
3373 | * Since this handles Unicode, it expects the strings to be well-formed UTF-8 | ||
3374 | * and not a null-terminated string of arbitrary bytes. Bytes that are not | ||
3375 | * valid UTF-8 are treated as Unicode character U+FFFD (REPLACEMENT | ||
3376 | * CHARACTER), so a malformed or incomplete UTF-8 sequence might increase the | ||
3377 | * count by several replacement characters. | ||
3378 | * | ||
3379 | * \param str The null-terminated UTF-8 string to read. Must not be NULL. | ||
3380 | * \returns The length (in codepoints, excluding the null terminator) of | ||
3381 | * `src`. | ||
3382 | * | ||
3383 | * \threadsafety It is safe to call this function from any thread. | ||
3384 | * | ||
3385 | * \since This function is available since SDL 3.2.0. | ||
3386 | * | ||
3387 | * \sa SDL_utf8strnlen | ||
3388 | * \sa SDL_strlen | ||
3389 | */ | ||
3390 | extern SDL_DECLSPEC size_t SDLCALL SDL_utf8strlen(const char *str); | ||
3391 | |||
3392 | /** | ||
3393 | * Count the number of codepoints in a UTF-8 string, up to n bytes. | ||
3394 | * | ||
3395 | * Counts the _codepoints_, not _bytes_, in `str`, excluding the null | ||
3396 | * terminator. | ||
3397 | * | ||
3398 | * If you need to count the bytes in a string instead, consider using | ||
3399 | * SDL_strnlen(). | ||
3400 | * | ||
3401 | * The counting stops at `bytes` bytes (not codepoints!). This seems | ||
3402 | * counterintuitive, but makes it easy to express the total size of the | ||
3403 | * string's buffer. | ||
3404 | * | ||
3405 | * Since this handles Unicode, it expects the strings to be well-formed UTF-8 | ||
3406 | * and not a null-terminated string of arbitrary bytes. Bytes that are not | ||
3407 | * valid UTF-8 are treated as Unicode character U+FFFD (REPLACEMENT | ||
3408 | * CHARACTER), so a malformed or incomplete UTF-8 sequence might increase the | ||
3409 | * count by several replacement characters. | ||
3410 | * | ||
3411 | * \param str The null-terminated UTF-8 string to read. Must not be NULL. | ||
3412 | * \param bytes The maximum amount of bytes to count. | ||
3413 | * \returns The length (in codepoints, excluding the null terminator) of `src` | ||
3414 | * but never more than `maxlen`. | ||
3415 | * | ||
3416 | * \threadsafety It is safe to call this function from any thread. | ||
3417 | * | ||
3418 | * \since This function is available since SDL 3.2.0. | ||
3419 | * | ||
3420 | * \sa SDL_utf8strlen | ||
3421 | * \sa SDL_strnlen | ||
3422 | */ | ||
3423 | extern SDL_DECLSPEC size_t SDLCALL SDL_utf8strnlen(const char *str, size_t bytes); | ||
3424 | |||
3425 | /** | ||
3426 | * Convert an integer into a string. | ||
3427 | * | ||
3428 | * This requires a radix to specified for string format. Specifying 10 | ||
3429 | * produces a decimal number, 16 hexidecimal, etc. Must be in the range of 2 | ||
3430 | * to 36. | ||
3431 | * | ||
3432 | * Note that this function will overflow a buffer if `str` is not large enough | ||
3433 | * to hold the output! It may be safer to use SDL_snprintf to clamp output, or | ||
3434 | * SDL_asprintf to allocate a buffer. Otherwise, it doesn't hurt to allocate | ||
3435 | * much more space than you expect to use (and don't forget possible negative | ||
3436 | * signs, null terminator bytes, etc). | ||
3437 | * | ||
3438 | * \param value the integer to convert. | ||
3439 | * \param str the buffer to write the string into. | ||
3440 | * \param radix the radix to use for string generation. | ||
3441 | * \returns `str`. | ||
3442 | * | ||
3443 | * \threadsafety It is safe to call this function from any thread. | ||
3444 | * | ||
3445 | * \since This function is available since SDL 3.2.0. | ||
3446 | * | ||
3447 | * \sa SDL_uitoa | ||
3448 | * \sa SDL_ltoa | ||
3449 | * \sa SDL_lltoa | ||
3450 | */ | ||
3451 | extern SDL_DECLSPEC char * SDLCALL SDL_itoa(int value, char *str, int radix); | ||
3452 | |||
3453 | /** | ||
3454 | * Convert an unsigned integer into a string. | ||
3455 | * | ||
3456 | * This requires a radix to specified for string format. Specifying 10 | ||
3457 | * produces a decimal number, 16 hexidecimal, etc. Must be in the range of 2 | ||
3458 | * to 36. | ||
3459 | * | ||
3460 | * Note that this function will overflow a buffer if `str` is not large enough | ||
3461 | * to hold the output! It may be safer to use SDL_snprintf to clamp output, or | ||
3462 | * SDL_asprintf to allocate a buffer. Otherwise, it doesn't hurt to allocate | ||
3463 | * much more space than you expect to use (and don't forget null terminator | ||
3464 | * bytes, etc). | ||
3465 | * | ||
3466 | * \param value the unsigned integer to convert. | ||
3467 | * \param str the buffer to write the string into. | ||
3468 | * \param radix the radix to use for string generation. | ||
3469 | * \returns `str`. | ||
3470 | * | ||
3471 | * \threadsafety It is safe to call this function from any thread. | ||
3472 | * | ||
3473 | * \since This function is available since SDL 3.2.0. | ||
3474 | * | ||
3475 | * \sa SDL_itoa | ||
3476 | * \sa SDL_ultoa | ||
3477 | * \sa SDL_ulltoa | ||
3478 | */ | ||
3479 | extern SDL_DECLSPEC char * SDLCALL SDL_uitoa(unsigned int value, char *str, int radix); | ||
3480 | |||
3481 | /** | ||
3482 | * Convert a long integer into a string. | ||
3483 | * | ||
3484 | * This requires a radix to specified for string format. Specifying 10 | ||
3485 | * produces a decimal number, 16 hexidecimal, etc. Must be in the range of 2 | ||
3486 | * to 36. | ||
3487 | * | ||
3488 | * Note that this function will overflow a buffer if `str` is not large enough | ||
3489 | * to hold the output! It may be safer to use SDL_snprintf to clamp output, or | ||
3490 | * SDL_asprintf to allocate a buffer. Otherwise, it doesn't hurt to allocate | ||
3491 | * much more space than you expect to use (and don't forget possible negative | ||
3492 | * signs, null terminator bytes, etc). | ||
3493 | * | ||
3494 | * \param value the long integer to convert. | ||
3495 | * \param str the buffer to write the string into. | ||
3496 | * \param radix the radix to use for string generation. | ||
3497 | * \returns `str`. | ||
3498 | * | ||
3499 | * \threadsafety It is safe to call this function from any thread. | ||
3500 | * | ||
3501 | * \since This function is available since SDL 3.2.0. | ||
3502 | * | ||
3503 | * \sa SDL_ultoa | ||
3504 | * \sa SDL_itoa | ||
3505 | * \sa SDL_lltoa | ||
3506 | */ | ||
3507 | extern SDL_DECLSPEC char * SDLCALL SDL_ltoa(long value, char *str, int radix); | ||
3508 | |||
3509 | /** | ||
3510 | * Convert an unsigned long integer into a string. | ||
3511 | * | ||
3512 | * This requires a radix to specified for string format. Specifying 10 | ||
3513 | * produces a decimal number, 16 hexidecimal, etc. Must be in the range of 2 | ||
3514 | * to 36. | ||
3515 | * | ||
3516 | * Note that this function will overflow a buffer if `str` is not large enough | ||
3517 | * to hold the output! It may be safer to use SDL_snprintf to clamp output, or | ||
3518 | * SDL_asprintf to allocate a buffer. Otherwise, it doesn't hurt to allocate | ||
3519 | * much more space than you expect to use (and don't forget null terminator | ||
3520 | * bytes, etc). | ||
3521 | * | ||
3522 | * \param value the unsigned long integer to convert. | ||
3523 | * \param str the buffer to write the string into. | ||
3524 | * \param radix the radix to use for string generation. | ||
3525 | * \returns `str`. | ||
3526 | * | ||
3527 | * \threadsafety It is safe to call this function from any thread. | ||
3528 | * | ||
3529 | * \since This function is available since SDL 3.2.0. | ||
3530 | * | ||
3531 | * \sa SDL_ltoa | ||
3532 | * \sa SDL_uitoa | ||
3533 | * \sa SDL_ulltoa | ||
3534 | */ | ||
3535 | extern SDL_DECLSPEC char * SDLCALL SDL_ultoa(unsigned long value, char *str, int radix); | ||
3536 | |||
3537 | #ifndef SDL_NOLONGLONG | ||
3538 | |||
3539 | /** | ||
3540 | * Convert a long long integer into a string. | ||
3541 | * | ||
3542 | * This requires a radix to specified for string format. Specifying 10 | ||
3543 | * produces a decimal number, 16 hexidecimal, etc. Must be in the range of 2 | ||
3544 | * to 36. | ||
3545 | * | ||
3546 | * Note that this function will overflow a buffer if `str` is not large enough | ||
3547 | * to hold the output! It may be safer to use SDL_snprintf to clamp output, or | ||
3548 | * SDL_asprintf to allocate a buffer. Otherwise, it doesn't hurt to allocate | ||
3549 | * much more space than you expect to use (and don't forget possible negative | ||
3550 | * signs, null terminator bytes, etc). | ||
3551 | * | ||
3552 | * \param value the long long integer to convert. | ||
3553 | * \param str the buffer to write the string into. | ||
3554 | * \param radix the radix to use for string generation. | ||
3555 | * \returns `str`. | ||
3556 | * | ||
3557 | * \threadsafety It is safe to call this function from any thread. | ||
3558 | * | ||
3559 | * \since This function is available since SDL 3.2.0. | ||
3560 | * | ||
3561 | * \sa SDL_ulltoa | ||
3562 | * \sa SDL_itoa | ||
3563 | * \sa SDL_ltoa | ||
3564 | */ | ||
3565 | extern SDL_DECLSPEC char * SDLCALL SDL_lltoa(long long value, char *str, int radix); | ||
3566 | |||
3567 | /** | ||
3568 | * Convert an unsigned long long integer into a string. | ||
3569 | * | ||
3570 | * This requires a radix to specified for string format. Specifying 10 | ||
3571 | * produces a decimal number, 16 hexidecimal, etc. Must be in the range of 2 | ||
3572 | * to 36. | ||
3573 | * | ||
3574 | * Note that this function will overflow a buffer if `str` is not large enough | ||
3575 | * to hold the output! It may be safer to use SDL_snprintf to clamp output, or | ||
3576 | * SDL_asprintf to allocate a buffer. Otherwise, it doesn't hurt to allocate | ||
3577 | * much more space than you expect to use (and don't forget null terminator | ||
3578 | * bytes, etc). | ||
3579 | * | ||
3580 | * \param value the unsigned long long integer to convert. | ||
3581 | * \param str the buffer to write the string into. | ||
3582 | * \param radix the radix to use for string generation. | ||
3583 | * \returns `str`. | ||
3584 | * | ||
3585 | * \threadsafety It is safe to call this function from any thread. | ||
3586 | * | ||
3587 | * \since This function is available since SDL 3.2.0. | ||
3588 | * | ||
3589 | * \sa SDL_lltoa | ||
3590 | * \sa SDL_uitoa | ||
3591 | * \sa SDL_ultoa | ||
3592 | */ | ||
3593 | extern SDL_DECLSPEC char * SDLCALL SDL_ulltoa(unsigned long long value, char *str, int radix); | ||
3594 | #endif | ||
3595 | |||
3596 | /** | ||
3597 | * Parse an `int` from a string. | ||
3598 | * | ||
3599 | * The result of calling `SDL_atoi(str)` is equivalent to | ||
3600 | * `(int)SDL_strtol(str, NULL, 10)`. | ||
3601 | * | ||
3602 | * \param str The null-terminated string to read. Must not be NULL. | ||
3603 | * \returns the parsed `int`. | ||
3604 | * | ||
3605 | * \threadsafety It is safe to call this function from any thread. | ||
3606 | * | ||
3607 | * \since This function is available since SDL 3.2.0. | ||
3608 | * | ||
3609 | * \sa SDL_atof | ||
3610 | * \sa SDL_strtol | ||
3611 | * \sa SDL_strtoul | ||
3612 | * \sa SDL_strtoll | ||
3613 | * \sa SDL_strtoull | ||
3614 | * \sa SDL_strtod | ||
3615 | * \sa SDL_itoa | ||
3616 | */ | ||
3617 | extern SDL_DECLSPEC int SDLCALL SDL_atoi(const char *str); | ||
3618 | |||
3619 | /** | ||
3620 | * Parse a `double` from a string. | ||
3621 | * | ||
3622 | * The result of calling `SDL_atof(str)` is equivalent to `SDL_strtod(str, | ||
3623 | * NULL)`. | ||
3624 | * | ||
3625 | * \param str The null-terminated string to read. Must not be NULL. | ||
3626 | * \returns the parsed `double`. | ||
3627 | * | ||
3628 | * \threadsafety It is safe to call this function from any thread. | ||
3629 | * | ||
3630 | * \since This function is available since SDL 3.2.0. | ||
3631 | * | ||
3632 | * \sa SDL_atoi | ||
3633 | * \sa SDL_strtol | ||
3634 | * \sa SDL_strtoul | ||
3635 | * \sa SDL_strtoll | ||
3636 | * \sa SDL_strtoull | ||
3637 | * \sa SDL_strtod | ||
3638 | */ | ||
3639 | extern SDL_DECLSPEC double SDLCALL SDL_atof(const char *str); | ||
3640 | |||
3641 | /** | ||
3642 | * Parse a `long` from a string. | ||
3643 | * | ||
3644 | * If `str` starts with whitespace, then those whitespace characters are | ||
3645 | * skipped before attempting to parse the number. | ||
3646 | * | ||
3647 | * If the parsed number does not fit inside a `long`, the result is clamped to | ||
3648 | * the minimum and maximum representable `long` values. | ||
3649 | * | ||
3650 | * \param str The null-terminated string to read. Must not be NULL. | ||
3651 | * \param endp If not NULL, the address of the first invalid character (i.e. | ||
3652 | * the next character after the parsed number) will be written to | ||
3653 | * this pointer. | ||
3654 | * \param base The base of the integer to read. Supported values are 0 and 2 | ||
3655 | * to 36 inclusive. If 0, the base will be inferred from the | ||
3656 | * number's prefix (0x for hexadecimal, 0 for octal, decimal | ||
3657 | * otherwise). | ||
3658 | * \returns the parsed `long`, or 0 if no number could be parsed. | ||
3659 | * | ||
3660 | * \threadsafety It is safe to call this function from any thread. | ||
3661 | * | ||
3662 | * \since This function is available since SDL 3.2.0. | ||
3663 | * | ||
3664 | * \sa SDL_atoi | ||
3665 | * \sa SDL_atof | ||
3666 | * \sa SDL_strtoul | ||
3667 | * \sa SDL_strtoll | ||
3668 | * \sa SDL_strtoull | ||
3669 | * \sa SDL_strtod | ||
3670 | * \sa SDL_ltoa | ||
3671 | * \sa SDL_wcstol | ||
3672 | */ | ||
3673 | extern SDL_DECLSPEC long SDLCALL SDL_strtol(const char *str, char **endp, int base); | ||
3674 | |||
3675 | /** | ||
3676 | * Parse an `unsigned long` from a string. | ||
3677 | * | ||
3678 | * If `str` starts with whitespace, then those whitespace characters are | ||
3679 | * skipped before attempting to parse the number. | ||
3680 | * | ||
3681 | * If the parsed number does not fit inside an `unsigned long`, the result is | ||
3682 | * clamped to the maximum representable `unsigned long` value. | ||
3683 | * | ||
3684 | * \param str The null-terminated string to read. Must not be NULL. | ||
3685 | * \param endp If not NULL, the address of the first invalid character (i.e. | ||
3686 | * the next character after the parsed number) will be written to | ||
3687 | * this pointer. | ||
3688 | * \param base The base of the integer to read. Supported values are 0 and 2 | ||
3689 | * to 36 inclusive. If 0, the base will be inferred from the | ||
3690 | * number's prefix (0x for hexadecimal, 0 for octal, decimal | ||
3691 | * otherwise). | ||
3692 | * \returns the parsed `unsigned long`, or 0 if no number could be parsed. | ||
3693 | * | ||
3694 | * \threadsafety It is safe to call this function from any thread. | ||
3695 | * | ||
3696 | * \since This function is available since SDL 3.2.0. | ||
3697 | * | ||
3698 | * \sa SDL_atoi | ||
3699 | * \sa SDL_atof | ||
3700 | * \sa SDL_strtol | ||
3701 | * \sa SDL_strtoll | ||
3702 | * \sa SDL_strtoull | ||
3703 | * \sa SDL_strtod | ||
3704 | * \sa SDL_ultoa | ||
3705 | */ | ||
3706 | extern SDL_DECLSPEC unsigned long SDLCALL SDL_strtoul(const char *str, char **endp, int base); | ||
3707 | |||
3708 | #ifndef SDL_NOLONGLONG | ||
3709 | |||
3710 | /** | ||
3711 | * Parse a `long long` from a string. | ||
3712 | * | ||
3713 | * If `str` starts with whitespace, then those whitespace characters are | ||
3714 | * skipped before attempting to parse the number. | ||
3715 | * | ||
3716 | * If the parsed number does not fit inside a `long long`, the result is | ||
3717 | * clamped to the minimum and maximum representable `long long` values. | ||
3718 | * | ||
3719 | * \param str The null-terminated string to read. Must not be NULL. | ||
3720 | * \param endp If not NULL, the address of the first invalid character (i.e. | ||
3721 | * the next character after the parsed number) will be written to | ||
3722 | * this pointer. | ||
3723 | * \param base The base of the integer to read. Supported values are 0 and 2 | ||
3724 | * to 36 inclusive. If 0, the base will be inferred from the | ||
3725 | * number's prefix (0x for hexadecimal, 0 for octal, decimal | ||
3726 | * otherwise). | ||
3727 | * \returns the parsed `long long`, or 0 if no number could be parsed. | ||
3728 | * | ||
3729 | * \threadsafety It is safe to call this function from any thread. | ||
3730 | * | ||
3731 | * \since This function is available since SDL 3.2.0. | ||
3732 | * | ||
3733 | * \sa SDL_atoi | ||
3734 | * \sa SDL_atof | ||
3735 | * \sa SDL_strtol | ||
3736 | * \sa SDL_strtoul | ||
3737 | * \sa SDL_strtoull | ||
3738 | * \sa SDL_strtod | ||
3739 | * \sa SDL_lltoa | ||
3740 | */ | ||
3741 | extern SDL_DECLSPEC long long SDLCALL SDL_strtoll(const char *str, char **endp, int base); | ||
3742 | |||
3743 | /** | ||
3744 | * Parse an `unsigned long long` from a string. | ||
3745 | * | ||
3746 | * If `str` starts with whitespace, then those whitespace characters are | ||
3747 | * skipped before attempting to parse the number. | ||
3748 | * | ||
3749 | * If the parsed number does not fit inside an `unsigned long long`, the | ||
3750 | * result is clamped to the maximum representable `unsigned long long` value. | ||
3751 | * | ||
3752 | * \param str The null-terminated string to read. Must not be NULL. | ||
3753 | * \param endp If not NULL, the address of the first invalid character (i.e. | ||
3754 | * the next character after the parsed number) will be written to | ||
3755 | * this pointer. | ||
3756 | * \param base The base of the integer to read. Supported values are 0 and 2 | ||
3757 | * to 36 inclusive. If 0, the base will be inferred from the | ||
3758 | * number's prefix (0x for hexadecimal, 0 for octal, decimal | ||
3759 | * otherwise). | ||
3760 | * \returns the parsed `unsigned long long`, or 0 if no number could be | ||
3761 | * parsed. | ||
3762 | * | ||
3763 | * \threadsafety It is safe to call this function from any thread. | ||
3764 | * | ||
3765 | * \since This function is available since SDL 3.2.0. | ||
3766 | * | ||
3767 | * \sa SDL_atoi | ||
3768 | * \sa SDL_atof | ||
3769 | * \sa SDL_strtol | ||
3770 | * \sa SDL_strtoll | ||
3771 | * \sa SDL_strtoul | ||
3772 | * \sa SDL_strtod | ||
3773 | * \sa SDL_ulltoa | ||
3774 | */ | ||
3775 | extern SDL_DECLSPEC unsigned long long SDLCALL SDL_strtoull(const char *str, char **endp, int base); | ||
3776 | #endif | ||
3777 | |||
3778 | /** | ||
3779 | * Parse a `double` from a string. | ||
3780 | * | ||
3781 | * This function makes fewer guarantees than the C runtime `strtod`: | ||
3782 | * | ||
3783 | * - Only decimal notation is guaranteed to be supported. The handling of | ||
3784 | * scientific and hexadecimal notation is unspecified. | ||
3785 | * - Whether or not INF and NAN can be parsed is unspecified. | ||
3786 | * - The precision of the result is unspecified. | ||
3787 | * | ||
3788 | * \param str the null-terminated string to read. Must not be NULL. | ||
3789 | * \param endp if not NULL, the address of the first invalid character (i.e. | ||
3790 | * the next character after the parsed number) will be written to | ||
3791 | * this pointer. | ||
3792 | * \returns the parsed `double`, or 0 if no number could be parsed. | ||
3793 | * | ||
3794 | * \threadsafety It is safe to call this function from any thread. | ||
3795 | * | ||
3796 | * \since This function is available since SDL 3.2.0. | ||
3797 | * | ||
3798 | * \sa SDL_atoi | ||
3799 | * \sa SDL_atof | ||
3800 | * \sa SDL_strtol | ||
3801 | * \sa SDL_strtoll | ||
3802 | * \sa SDL_strtoul | ||
3803 | * \sa SDL_strtoull | ||
3804 | */ | ||
3805 | extern SDL_DECLSPEC double SDLCALL SDL_strtod(const char *str, char **endp); | ||
3806 | |||
3807 | /** | ||
3808 | * Compare two null-terminated UTF-8 strings. | ||
3809 | * | ||
3810 | * Due to the nature of UTF-8 encoding, this will work with Unicode strings, | ||
3811 | * since effectively this function just compares bytes until it hits a | ||
3812 | * null-terminating character. Also due to the nature of UTF-8, this can be | ||
3813 | * used with SDL_qsort() to put strings in (roughly) alphabetical order. | ||
3814 | * | ||
3815 | * \param str1 the first string to compare. NULL is not permitted! | ||
3816 | * \param str2 the second string to compare. NULL is not permitted! | ||
3817 | * \returns less than zero if str1 is "less than" str2, greater than zero if | ||
3818 | * str1 is "greater than" str2, and zero if the strings match | ||
3819 | * exactly. | ||
3820 | * | ||
3821 | * \threadsafety It is safe to call this function from any thread. | ||
3822 | * | ||
3823 | * \since This function is available since SDL 3.2.0. | ||
3824 | */ | ||
3825 | extern SDL_DECLSPEC int SDLCALL SDL_strcmp(const char *str1, const char *str2); | ||
3826 | |||
3827 | /** | ||
3828 | * Compare two UTF-8 strings up to a number of bytes. | ||
3829 | * | ||
3830 | * Due to the nature of UTF-8 encoding, this will work with Unicode strings, | ||
3831 | * since effectively this function just compares bytes until it hits a | ||
3832 | * null-terminating character. Also due to the nature of UTF-8, this can be | ||
3833 | * used with SDL_qsort() to put strings in (roughly) alphabetical order. | ||
3834 | * | ||
3835 | * Note that while this function is intended to be used with UTF-8, it is | ||
3836 | * doing a bytewise comparison, and `maxlen` specifies a _byte_ limit! If the | ||
3837 | * limit lands in the middle of a multi-byte UTF-8 sequence, it will only | ||
3838 | * compare a portion of the final character. | ||
3839 | * | ||
3840 | * `maxlen` specifies a maximum number of bytes to compare; if the strings | ||
3841 | * match to this number of bytes (or both have matched to a null-terminator | ||
3842 | * character before this number of bytes), they will be considered equal. | ||
3843 | * | ||
3844 | * \param str1 the first string to compare. NULL is not permitted! | ||
3845 | * \param str2 the second string to compare. NULL is not permitted! | ||
3846 | * \param maxlen the maximum number of _bytes_ to compare. | ||
3847 | * \returns less than zero if str1 is "less than" str2, greater than zero if | ||
3848 | * str1 is "greater than" str2, and zero if the strings match | ||
3849 | * exactly. | ||
3850 | * | ||
3851 | * \threadsafety It is safe to call this function from any thread. | ||
3852 | * | ||
3853 | * \since This function is available since SDL 3.2.0. | ||
3854 | */ | ||
3855 | extern SDL_DECLSPEC int SDLCALL SDL_strncmp(const char *str1, const char *str2, size_t maxlen); | ||
3856 | |||
3857 | /** | ||
3858 | * Compare two null-terminated UTF-8 strings, case-insensitively. | ||
3859 | * | ||
3860 | * This will work with Unicode strings, using a technique called | ||
3861 | * "case-folding" to handle the vast majority of case-sensitive human | ||
3862 | * languages regardless of system locale. It can deal with expanding values: a | ||
3863 | * German Eszett character can compare against two ASCII 's' chars and be | ||
3864 | * considered a match, for example. A notable exception: it does not handle | ||
3865 | * the Turkish 'i' character; human language is complicated! | ||
3866 | * | ||
3867 | * Since this handles Unicode, it expects the string to be well-formed UTF-8 | ||
3868 | * and not a null-terminated string of arbitrary bytes. Bytes that are not | ||
3869 | * valid UTF-8 are treated as Unicode character U+FFFD (REPLACEMENT | ||
3870 | * CHARACTER), which is to say two strings of random bits may turn out to | ||
3871 | * match if they convert to the same amount of replacement characters. | ||
3872 | * | ||
3873 | * \param str1 the first string to compare. NULL is not permitted! | ||
3874 | * \param str2 the second string to compare. NULL is not permitted! | ||
3875 | * \returns less than zero if str1 is "less than" str2, greater than zero if | ||
3876 | * str1 is "greater than" str2, and zero if the strings match | ||
3877 | * exactly. | ||
3878 | * | ||
3879 | * \threadsafety It is safe to call this function from any thread. | ||
3880 | * | ||
3881 | * \since This function is available since SDL 3.2.0. | ||
3882 | */ | ||
3883 | extern SDL_DECLSPEC int SDLCALL SDL_strcasecmp(const char *str1, const char *str2); | ||
3884 | |||
3885 | |||
3886 | /** | ||
3887 | * Compare two UTF-8 strings, case-insensitively, up to a number of bytes. | ||
3888 | * | ||
3889 | * This will work with Unicode strings, using a technique called | ||
3890 | * "case-folding" to handle the vast majority of case-sensitive human | ||
3891 | * languages regardless of system locale. It can deal with expanding values: a | ||
3892 | * German Eszett character can compare against two ASCII 's' chars and be | ||
3893 | * considered a match, for example. A notable exception: it does not handle | ||
3894 | * the Turkish 'i' character; human language is complicated! | ||
3895 | * | ||
3896 | * Since this handles Unicode, it expects the string to be well-formed UTF-8 | ||
3897 | * and not a null-terminated string of arbitrary bytes. Bytes that are not | ||
3898 | * valid UTF-8 are treated as Unicode character U+FFFD (REPLACEMENT | ||
3899 | * CHARACTER), which is to say two strings of random bits may turn out to | ||
3900 | * match if they convert to the same amount of replacement characters. | ||
3901 | * | ||
3902 | * Note that while this function is intended to be used with UTF-8, `maxlen` | ||
3903 | * specifies a _byte_ limit! If the limit lands in the middle of a multi-byte | ||
3904 | * UTF-8 sequence, it may convert a portion of the final character to one or | ||
3905 | * more Unicode character U+FFFD (REPLACEMENT CHARACTER) so as not to overflow | ||
3906 | * a buffer. | ||
3907 | * | ||
3908 | * `maxlen` specifies a maximum number of bytes to compare; if the strings | ||
3909 | * match to this number of bytes (or both have matched to a null-terminator | ||
3910 | * character before this number of bytes), they will be considered equal. | ||
3911 | * | ||
3912 | * \param str1 the first string to compare. NULL is not permitted! | ||
3913 | * \param str2 the second string to compare. NULL is not permitted! | ||
3914 | * \param maxlen the maximum number of bytes to compare. | ||
3915 | * \returns less than zero if str1 is "less than" str2, greater than zero if | ||
3916 | * str1 is "greater than" str2, and zero if the strings match | ||
3917 | * exactly. | ||
3918 | * | ||
3919 | * \threadsafety It is safe to call this function from any thread. | ||
3920 | * | ||
3921 | * \since This function is available since SDL 3.2.0. | ||
3922 | */ | ||
3923 | extern SDL_DECLSPEC int SDLCALL SDL_strncasecmp(const char *str1, const char *str2, size_t maxlen); | ||
3924 | |||
3925 | /** | ||
3926 | * Searches a string for the first occurence of any character contained in a | ||
3927 | * breakset, and returns a pointer from the string to that character. | ||
3928 | * | ||
3929 | * \param str The null-terminated string to be searched. Must not be NULL, and | ||
3930 | * must not overlap with `breakset`. | ||
3931 | * \param breakset A null-terminated string containing the list of characters | ||
3932 | * to look for. Must not be NULL, and must not overlap with | ||
3933 | * `str`. | ||
3934 | * \returns A pointer to the location, in str, of the first occurence of a | ||
3935 | * character present in the breakset, or NULL if none is found. | ||
3936 | * | ||
3937 | * \threadsafety It is safe to call this function from any thread. | ||
3938 | * | ||
3939 | * \since This function is available since SDL 3.2.0. | ||
3940 | */ | ||
3941 | extern SDL_DECLSPEC char * SDLCALL SDL_strpbrk(const char *str, const char *breakset); | ||
3942 | |||
3943 | /** | ||
3944 | * The Unicode REPLACEMENT CHARACTER codepoint. | ||
3945 | * | ||
3946 | * SDL_StepUTF8() and SDL_StepBackUTF8() report this codepoint when they | ||
3947 | * encounter a UTF-8 string with encoding errors. | ||
3948 | * | ||
3949 | * This tends to render as something like a question mark in most places. | ||
3950 | * | ||
3951 | * \since This macro is available since SDL 3.2.0. | ||
3952 | * | ||
3953 | * \sa SDL_StepBackUTF8 | ||
3954 | * \sa SDL_StepUTF8 | ||
3955 | */ | ||
3956 | #define SDL_INVALID_UNICODE_CODEPOINT 0xFFFD | ||
3957 | |||
3958 | /** | ||
3959 | * Decode a UTF-8 string, one Unicode codepoint at a time. | ||
3960 | * | ||
3961 | * This will return the first Unicode codepoint in the UTF-8 encoded string in | ||
3962 | * `*pstr`, and then advance `*pstr` past any consumed bytes before returning. | ||
3963 | * | ||
3964 | * It will not access more than `*pslen` bytes from the string. `*pslen` will | ||
3965 | * be adjusted, as well, subtracting the number of bytes consumed. | ||
3966 | * | ||
3967 | * `pslen` is allowed to be NULL, in which case the string _must_ be | ||
3968 | * NULL-terminated, as the function will blindly read until it sees the NULL | ||
3969 | * char. | ||
3970 | * | ||
3971 | * if `*pslen` is zero, it assumes the end of string is reached and returns a | ||
3972 | * zero codepoint regardless of the contents of the string buffer. | ||
3973 | * | ||
3974 | * If the resulting codepoint is zero (a NULL terminator), or `*pslen` is | ||
3975 | * zero, it will not advance `*pstr` or `*pslen` at all. | ||
3976 | * | ||
3977 | * Generally this function is called in a loop until it returns zero, | ||
3978 | * adjusting its parameters each iteration. | ||
3979 | * | ||
3980 | * If an invalid UTF-8 sequence is encountered, this function returns | ||
3981 | * SDL_INVALID_UNICODE_CODEPOINT and advances the string/length by one byte | ||
3982 | * (which is to say, a multibyte sequence might produce several | ||
3983 | * SDL_INVALID_UNICODE_CODEPOINT returns before it syncs to the next valid | ||
3984 | * UTF-8 sequence). | ||
3985 | * | ||
3986 | * Several things can generate invalid UTF-8 sequences, including overlong | ||
3987 | * encodings, the use of UTF-16 surrogate values, and truncated data. Please | ||
3988 | * refer to | ||
3989 | * [RFC3629](https://www.ietf.org/rfc/rfc3629.txt) | ||
3990 | * for details. | ||
3991 | * | ||
3992 | * \param pstr a pointer to a UTF-8 string pointer to be read and adjusted. | ||
3993 | * \param pslen a pointer to the number of bytes in the string, to be read and | ||
3994 | * adjusted. NULL is allowed. | ||
3995 | * \returns the first Unicode codepoint in the string. | ||
3996 | * | ||
3997 | * \threadsafety It is safe to call this function from any thread. | ||
3998 | * | ||
3999 | * \since This function is available since SDL 3.2.0. | ||
4000 | */ | ||
4001 | extern SDL_DECLSPEC Uint32 SDLCALL SDL_StepUTF8(const char **pstr, size_t *pslen); | ||
4002 | |||
4003 | /** | ||
4004 | * Decode a UTF-8 string in reverse, one Unicode codepoint at a time. | ||
4005 | * | ||
4006 | * This will go to the start of the previous Unicode codepoint in the string, | ||
4007 | * move `*pstr` to that location and return that codepoint. | ||
4008 | * | ||
4009 | * If `*pstr` is already at the start of the string), it will not advance | ||
4010 | * `*pstr` at all. | ||
4011 | * | ||
4012 | * Generally this function is called in a loop until it returns zero, | ||
4013 | * adjusting its parameter each iteration. | ||
4014 | * | ||
4015 | * If an invalid UTF-8 sequence is encountered, this function returns | ||
4016 | * SDL_INVALID_UNICODE_CODEPOINT. | ||
4017 | * | ||
4018 | * Several things can generate invalid UTF-8 sequences, including overlong | ||
4019 | * encodings, the use of UTF-16 surrogate values, and truncated data. Please | ||
4020 | * refer to | ||
4021 | * [RFC3629](https://www.ietf.org/rfc/rfc3629.txt) | ||
4022 | * for details. | ||
4023 | * | ||
4024 | * \param start a pointer to the beginning of the UTF-8 string. | ||
4025 | * \param pstr a pointer to a UTF-8 string pointer to be read and adjusted. | ||
4026 | * \returns the previous Unicode codepoint in the string. | ||
4027 | * | ||
4028 | * \threadsafety It is safe to call this function from any thread. | ||
4029 | * | ||
4030 | * \since This function is available since SDL 3.2.0. | ||
4031 | */ | ||
4032 | extern SDL_DECLSPEC Uint32 SDLCALL SDL_StepBackUTF8(const char *start, const char **pstr); | ||
4033 | |||
4034 | /** | ||
4035 | * Convert a single Unicode codepoint to UTF-8. | ||
4036 | * | ||
4037 | * The buffer pointed to by `dst` must be at least 4 bytes long, as this | ||
4038 | * function may generate between 1 and 4 bytes of output. | ||
4039 | * | ||
4040 | * This function returns the first byte _after_ the newly-written UTF-8 | ||
4041 | * sequence, which is useful for encoding multiple codepoints in a loop, or | ||
4042 | * knowing where to write a NULL-terminator character to end the string (in | ||
4043 | * either case, plan to have a buffer of _more_ than 4 bytes!). | ||
4044 | * | ||
4045 | * If `codepoint` is an invalid value (outside the Unicode range, or a UTF-16 | ||
4046 | * surrogate value, etc), this will use U+FFFD (REPLACEMENT CHARACTER) for the | ||
4047 | * codepoint instead, and not set an error. | ||
4048 | * | ||
4049 | * If `dst` is NULL, this returns NULL immediately without writing to the | ||
4050 | * pointer and without setting an error. | ||
4051 | * | ||
4052 | * \param codepoint a Unicode codepoint to convert to UTF-8. | ||
4053 | * \param dst the location to write the encoded UTF-8. Must point to at least | ||
4054 | * 4 bytes! | ||
4055 | * \returns the first byte past the newly-written UTF-8 sequence. | ||
4056 | * | ||
4057 | * \threadsafety It is safe to call this function from any thread. | ||
4058 | * | ||
4059 | * \since This function is available since SDL 3.2.0. | ||
4060 | */ | ||
4061 | extern SDL_DECLSPEC char * SDLCALL SDL_UCS4ToUTF8(Uint32 codepoint, char *dst); | ||
4062 | |||
4063 | /** | ||
4064 | * This works exactly like sscanf() but doesn't require access to a C runtime. | ||
4065 | * | ||
4066 | * Scan a string, matching a format string, converting each '%' item and | ||
4067 | * storing it to pointers provided through variable arguments. | ||
4068 | * | ||
4069 | * \param text the string to scan. Must not be NULL. | ||
4070 | * \param fmt a printf-style format string. Must not be NULL. | ||
4071 | * \param ... a list of pointers to values to be filled in with scanned items. | ||
4072 | * \returns the number of items that matched the format string. | ||
4073 | * | ||
4074 | * \threadsafety It is safe to call this function from any thread. | ||
4075 | * | ||
4076 | * \since This function is available since SDL 3.2.0. | ||
4077 | */ | ||
4078 | extern SDL_DECLSPEC int SDLCALL SDL_sscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, ...) SDL_SCANF_VARARG_FUNC(2); | ||
4079 | |||
4080 | /** | ||
4081 | * This works exactly like vsscanf() but doesn't require access to a C | ||
4082 | * runtime. | ||
4083 | * | ||
4084 | * Functions identically to SDL_sscanf(), except it takes a `va_list` instead | ||
4085 | * of using `...` variable arguments. | ||
4086 | * | ||
4087 | * \param text the string to scan. Must not be NULL. | ||
4088 | * \param fmt a printf-style format string. Must not be NULL. | ||
4089 | * \param ap a `va_list` of pointers to values to be filled in with scanned | ||
4090 | * items. | ||
4091 | * \returns the number of items that matched the format string. | ||
4092 | * | ||
4093 | * \threadsafety It is safe to call this function from any thread. | ||
4094 | * | ||
4095 | * \since This function is available since SDL 3.2.0. | ||
4096 | */ | ||
4097 | extern SDL_DECLSPEC int SDLCALL SDL_vsscanf(const char *text, SDL_SCANF_FORMAT_STRING const char *fmt, va_list ap) SDL_SCANF_VARARG_FUNCV(2); | ||
4098 | |||
4099 | /** | ||
4100 | * This works exactly like snprintf() but doesn't require access to a C | ||
4101 | * runtime. | ||
4102 | * | ||
4103 | * Format a string of up to `maxlen`-1 bytes, converting each '%' item with | ||
4104 | * values provided through variable arguments. | ||
4105 | * | ||
4106 | * While some C runtimes differ on how to deal with too-large strings, this | ||
4107 | * function null-terminates the output, by treating the null-terminator as | ||
4108 | * part of the `maxlen` count. Note that if `maxlen` is zero, however, no | ||
4109 | * bytes will be written at all. | ||
4110 | * | ||
4111 | * This function returns the number of _bytes_ (not _characters_) that should | ||
4112 | * be written, excluding the null-terminator character. If this returns a | ||
4113 | * number >= `maxlen`, it means the output string was truncated. A negative | ||
4114 | * return value means an error occurred. | ||
4115 | * | ||
4116 | * Referencing the output string's pointer with a format item is undefined | ||
4117 | * behavior. | ||
4118 | * | ||
4119 | * \param text the buffer to write the string into. Must not be NULL. | ||
4120 | * \param maxlen the maximum bytes to write, including the null-terminator. | ||
4121 | * \param fmt a printf-style format string. Must not be NULL. | ||
4122 | * \param ... a list of values to be used with the format string. | ||
4123 | * \returns the number of bytes that should be written, not counting the | ||
4124 | * null-terminator char, or a negative value on error. | ||
4125 | * | ||
4126 | * \threadsafety It is safe to call this function from any thread. | ||
4127 | * | ||
4128 | * \since This function is available since SDL 3.2.0. | ||
4129 | */ | ||
4130 | extern SDL_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); | ||
4131 | |||
4132 | /** | ||
4133 | * This works exactly like swprintf() but doesn't require access to a C | ||
4134 | * runtime. | ||
4135 | * | ||
4136 | * Format a wide string of up to `maxlen`-1 wchar_t values, converting each | ||
4137 | * '%' item with values provided through variable arguments. | ||
4138 | * | ||
4139 | * While some C runtimes differ on how to deal with too-large strings, this | ||
4140 | * function null-terminates the output, by treating the null-terminator as | ||
4141 | * part of the `maxlen` count. Note that if `maxlen` is zero, however, no wide | ||
4142 | * characters will be written at all. | ||
4143 | * | ||
4144 | * This function returns the number of _wide characters_ (not _codepoints_) | ||
4145 | * that should be written, excluding the null-terminator character. If this | ||
4146 | * returns a number >= `maxlen`, it means the output string was truncated. A | ||
4147 | * negative return value means an error occurred. | ||
4148 | * | ||
4149 | * Referencing the output string's pointer with a format item is undefined | ||
4150 | * behavior. | ||
4151 | * | ||
4152 | * \param text the buffer to write the wide string into. Must not be NULL. | ||
4153 | * \param maxlen the maximum wchar_t values to write, including the | ||
4154 | * null-terminator. | ||
4155 | * \param fmt a printf-style format string. Must not be NULL. | ||
4156 | * \param ... a list of values to be used with the format string. | ||
4157 | * \returns the number of wide characters that should be written, not counting | ||
4158 | * the null-terminator char, or a negative value on error. | ||
4159 | * | ||
4160 | * \threadsafety It is safe to call this function from any thread. | ||
4161 | * | ||
4162 | * \since This function is available since SDL 3.2.0. | ||
4163 | */ | ||
4164 | extern SDL_DECLSPEC int SDLCALL SDL_swprintf(SDL_OUT_Z_CAP(maxlen) wchar_t *text, size_t maxlen, SDL_PRINTF_FORMAT_STRING const wchar_t *fmt, ...) SDL_WPRINTF_VARARG_FUNC(3); | ||
4165 | |||
4166 | /** | ||
4167 | * This works exactly like vsnprintf() but doesn't require access to a C | ||
4168 | * runtime. | ||
4169 | * | ||
4170 | * Functions identically to SDL_snprintf(), except it takes a `va_list` | ||
4171 | * instead of using `...` variable arguments. | ||
4172 | * | ||
4173 | * \param text the buffer to write the string into. Must not be NULL. | ||
4174 | * \param maxlen the maximum bytes to write, including the null-terminator. | ||
4175 | * \param fmt a printf-style format string. Must not be NULL. | ||
4176 | * \param ap a `va_list` values to be used with the format string. | ||
4177 | * \returns the number of bytes that should be written, not counting the | ||
4178 | * null-terminator char, or a negative value on error. | ||
4179 | * | ||
4180 | * \threadsafety It is safe to call this function from any thread. | ||
4181 | * | ||
4182 | * \since This function is available since SDL 3.2.0. | ||
4183 | */ | ||
4184 | extern SDL_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); | ||
4185 | |||
4186 | /** | ||
4187 | * This works exactly like vswprintf() but doesn't require access to a C | ||
4188 | * runtime. | ||
4189 | * | ||
4190 | * Functions identically to SDL_swprintf(), except it takes a `va_list` | ||
4191 | * instead of using `...` variable arguments. | ||
4192 | * | ||
4193 | * \param text the buffer to write the string into. Must not be NULL. | ||
4194 | * \param maxlen the maximum wide characters to write, including the | ||
4195 | * null-terminator. | ||
4196 | * \param fmt a printf-style format wide string. Must not be NULL. | ||
4197 | * \param ap a `va_list` values to be used with the format string. | ||
4198 | * \returns the number of wide characters that should be written, not counting | ||
4199 | * the null-terminator char, or a negative value on error. | ||
4200 | * | ||
4201 | * \threadsafety It is safe to call this function from any thread. | ||
4202 | * | ||
4203 | * \since This function is available since SDL 3.2.0. | ||
4204 | */ | ||
4205 | extern SDL_DECLSPEC int SDLCALL SDL_vswprintf(SDL_OUT_Z_CAP(maxlen) wchar_t *text, size_t maxlen, SDL_PRINTF_FORMAT_STRING const wchar_t *fmt, va_list ap) SDL_WPRINTF_VARARG_FUNCV(3); | ||
4206 | |||
4207 | /** | ||
4208 | * This works exactly like asprintf() but doesn't require access to a C | ||
4209 | * runtime. | ||
4210 | * | ||
4211 | * Functions identically to SDL_snprintf(), except it allocates a buffer large | ||
4212 | * enough to hold the output string on behalf of the caller. | ||
4213 | * | ||
4214 | * On success, this function returns the number of bytes (not characters) | ||
4215 | * comprising the output string, not counting the null-terminator character, | ||
4216 | * and sets `*strp` to the newly-allocated string. | ||
4217 | * | ||
4218 | * On error, this function returns a negative number, and the value of `*strp` | ||
4219 | * is undefined. | ||
4220 | * | ||
4221 | * The returned string is owned by the caller, and should be passed to | ||
4222 | * SDL_free when no longer needed. | ||
4223 | * | ||
4224 | * \param strp on output, is set to the new string. Must not be NULL. | ||
4225 | * \param fmt a printf-style format string. Must not be NULL. | ||
4226 | * \param ... a list of values to be used with the format string. | ||
4227 | * \returns the number of bytes in the newly-allocated string, not counting | ||
4228 | * the null-terminator char, or a negative value on error. | ||
4229 | * | ||
4230 | * \threadsafety It is safe to call this function from any thread. | ||
4231 | * | ||
4232 | * \since This function is available since SDL 3.2.0. | ||
4233 | */ | ||
4234 | extern SDL_DECLSPEC int SDLCALL SDL_asprintf(char **strp, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2); | ||
4235 | |||
4236 | /** | ||
4237 | * This works exactly like vasprintf() but doesn't require access to a C | ||
4238 | * runtime. | ||
4239 | * | ||
4240 | * Functions identically to SDL_asprintf(), except it takes a `va_list` | ||
4241 | * instead of using `...` variable arguments. | ||
4242 | * | ||
4243 | * \param strp on output, is set to the new string. Must not be NULL. | ||
4244 | * \param fmt a printf-style format string. Must not be NULL. | ||
4245 | * \param ap a `va_list` values to be used with the format string. | ||
4246 | * \returns the number of bytes in the newly-allocated string, not counting | ||
4247 | * the null-terminator char, or a negative value on error. | ||
4248 | * | ||
4249 | * \threadsafety It is safe to call this function from any thread. | ||
4250 | * | ||
4251 | * \since This function is available since SDL 3.2.0. | ||
4252 | */ | ||
4253 | extern SDL_DECLSPEC int SDLCALL SDL_vasprintf(char **strp, SDL_PRINTF_FORMAT_STRING const char *fmt, va_list ap) SDL_PRINTF_VARARG_FUNCV(2); | ||
4254 | |||
4255 | /** | ||
4256 | * Seeds the pseudo-random number generator. | ||
4257 | * | ||
4258 | * Reusing the seed number will cause SDL_rand() to repeat the same stream of | ||
4259 | * 'random' numbers. | ||
4260 | * | ||
4261 | * \param seed the value to use as a random number seed, or 0 to use | ||
4262 | * SDL_GetPerformanceCounter(). | ||
4263 | * | ||
4264 | * \threadsafety This should be called on the same thread that calls | ||
4265 | * SDL_rand() | ||
4266 | * | ||
4267 | * \since This function is available since SDL 3.2.0. | ||
4268 | * | ||
4269 | * \sa SDL_rand | ||
4270 | * \sa SDL_rand_bits | ||
4271 | * \sa SDL_randf | ||
4272 | */ | ||
4273 | extern SDL_DECLSPEC void SDLCALL SDL_srand(Uint64 seed); | ||
4274 | |||
4275 | /** | ||
4276 | * Generate a pseudo-random number less than n for positive n | ||
4277 | * | ||
4278 | * The method used is faster and of better quality than `rand() % n`. Odds are | ||
4279 | * roughly 99.9% even for n = 1 million. Evenness is better for smaller n, and | ||
4280 | * much worse as n gets bigger. | ||
4281 | * | ||
4282 | * Example: to simulate a d6 use `SDL_rand(6) + 1` The +1 converts 0..5 to | ||
4283 | * 1..6 | ||
4284 | * | ||
4285 | * If you want to generate a pseudo-random number in the full range of Sint32, | ||
4286 | * you should use: (Sint32)SDL_rand_bits() | ||
4287 | * | ||
4288 | * If you want reproducible output, be sure to initialize with SDL_srand() | ||
4289 | * first. | ||
4290 | * | ||
4291 | * There are no guarantees as to the quality of the random sequence produced, | ||
4292 | * and this should not be used for security (cryptography, passwords) or where | ||
4293 | * money is on the line (loot-boxes, casinos). There are many random number | ||
4294 | * libraries available with different characteristics and you should pick one | ||
4295 | * of those to meet any serious needs. | ||
4296 | * | ||
4297 | * \param n the number of possible outcomes. n must be positive. | ||
4298 | * \returns a random value in the range of [0 .. n-1]. | ||
4299 | * | ||
4300 | * \threadsafety All calls should be made from a single thread | ||
4301 | * | ||
4302 | * \since This function is available since SDL 3.2.0. | ||
4303 | * | ||
4304 | * \sa SDL_srand | ||
4305 | * \sa SDL_randf | ||
4306 | */ | ||
4307 | extern SDL_DECLSPEC Sint32 SDLCALL SDL_rand(Sint32 n); | ||
4308 | |||
4309 | /** | ||
4310 | * Generate a uniform pseudo-random floating point number less than 1.0 | ||
4311 | * | ||
4312 | * If you want reproducible output, be sure to initialize with SDL_srand() | ||
4313 | * first. | ||
4314 | * | ||
4315 | * There are no guarantees as to the quality of the random sequence produced, | ||
4316 | * and this should not be used for security (cryptography, passwords) or where | ||
4317 | * money is on the line (loot-boxes, casinos). There are many random number | ||
4318 | * libraries available with different characteristics and you should pick one | ||
4319 | * of those to meet any serious needs. | ||
4320 | * | ||
4321 | * \returns a random value in the range of [0.0, 1.0). | ||
4322 | * | ||
4323 | * \threadsafety All calls should be made from a single thread | ||
4324 | * | ||
4325 | * \since This function is available since SDL 3.2.0. | ||
4326 | * | ||
4327 | * \sa SDL_srand | ||
4328 | * \sa SDL_rand | ||
4329 | */ | ||
4330 | extern SDL_DECLSPEC float SDLCALL SDL_randf(void); | ||
4331 | |||
4332 | /** | ||
4333 | * Generate 32 pseudo-random bits. | ||
4334 | * | ||
4335 | * You likely want to use SDL_rand() to get a psuedo-random number instead. | ||
4336 | * | ||
4337 | * There are no guarantees as to the quality of the random sequence produced, | ||
4338 | * and this should not be used for security (cryptography, passwords) or where | ||
4339 | * money is on the line (loot-boxes, casinos). There are many random number | ||
4340 | * libraries available with different characteristics and you should pick one | ||
4341 | * of those to meet any serious needs. | ||
4342 | * | ||
4343 | * \returns a random value in the range of [0-SDL_MAX_UINT32]. | ||
4344 | * | ||
4345 | * \threadsafety All calls should be made from a single thread | ||
4346 | * | ||
4347 | * \since This function is available since SDL 3.2.0. | ||
4348 | * | ||
4349 | * \sa SDL_rand | ||
4350 | * \sa SDL_randf | ||
4351 | * \sa SDL_srand | ||
4352 | */ | ||
4353 | extern SDL_DECLSPEC Uint32 SDLCALL SDL_rand_bits(void); | ||
4354 | |||
4355 | /** | ||
4356 | * Generate a pseudo-random number less than n for positive n | ||
4357 | * | ||
4358 | * The method used is faster and of better quality than `rand() % n`. Odds are | ||
4359 | * roughly 99.9% even for n = 1 million. Evenness is better for smaller n, and | ||
4360 | * much worse as n gets bigger. | ||
4361 | * | ||
4362 | * Example: to simulate a d6 use `SDL_rand_r(state, 6) + 1` The +1 converts | ||
4363 | * 0..5 to 1..6 | ||
4364 | * | ||
4365 | * If you want to generate a pseudo-random number in the full range of Sint32, | ||
4366 | * you should use: (Sint32)SDL_rand_bits_r(state) | ||
4367 | * | ||
4368 | * There are no guarantees as to the quality of the random sequence produced, | ||
4369 | * and this should not be used for security (cryptography, passwords) or where | ||
4370 | * money is on the line (loot-boxes, casinos). There are many random number | ||
4371 | * libraries available with different characteristics and you should pick one | ||
4372 | * of those to meet any serious needs. | ||
4373 | * | ||
4374 | * \param state a pointer to the current random number state, this may not be | ||
4375 | * NULL. | ||
4376 | * \param n the number of possible outcomes. n must be positive. | ||
4377 | * \returns a random value in the range of [0 .. n-1]. | ||
4378 | * | ||
4379 | * \threadsafety This function is thread-safe, as long as the state pointer | ||
4380 | * isn't shared between threads. | ||
4381 | * | ||
4382 | * \since This function is available since SDL 3.2.0. | ||
4383 | * | ||
4384 | * \sa SDL_rand | ||
4385 | * \sa SDL_rand_bits_r | ||
4386 | * \sa SDL_randf_r | ||
4387 | */ | ||
4388 | extern SDL_DECLSPEC Sint32 SDLCALL SDL_rand_r(Uint64 *state, Sint32 n); | ||
4389 | |||
4390 | /** | ||
4391 | * Generate a uniform pseudo-random floating point number less than 1.0 | ||
4392 | * | ||
4393 | * If you want reproducible output, be sure to initialize with SDL_srand() | ||
4394 | * first. | ||
4395 | * | ||
4396 | * There are no guarantees as to the quality of the random sequence produced, | ||
4397 | * and this should not be used for security (cryptography, passwords) or where | ||
4398 | * money is on the line (loot-boxes, casinos). There are many random number | ||
4399 | * libraries available with different characteristics and you should pick one | ||
4400 | * of those to meet any serious needs. | ||
4401 | * | ||
4402 | * \param state a pointer to the current random number state, this may not be | ||
4403 | * NULL. | ||
4404 | * \returns a random value in the range of [0.0, 1.0). | ||
4405 | * | ||
4406 | * \threadsafety This function is thread-safe, as long as the state pointer | ||
4407 | * isn't shared between threads. | ||
4408 | * | ||
4409 | * \since This function is available since SDL 3.2.0. | ||
4410 | * | ||
4411 | * \sa SDL_rand_bits_r | ||
4412 | * \sa SDL_rand_r | ||
4413 | * \sa SDL_randf | ||
4414 | */ | ||
4415 | extern SDL_DECLSPEC float SDLCALL SDL_randf_r(Uint64 *state); | ||
4416 | |||
4417 | /** | ||
4418 | * Generate 32 pseudo-random bits. | ||
4419 | * | ||
4420 | * You likely want to use SDL_rand_r() to get a psuedo-random number instead. | ||
4421 | * | ||
4422 | * There are no guarantees as to the quality of the random sequence produced, | ||
4423 | * and this should not be used for security (cryptography, passwords) or where | ||
4424 | * money is on the line (loot-boxes, casinos). There are many random number | ||
4425 | * libraries available with different characteristics and you should pick one | ||
4426 | * of those to meet any serious needs. | ||
4427 | * | ||
4428 | * \param state a pointer to the current random number state, this may not be | ||
4429 | * NULL. | ||
4430 | * \returns a random value in the range of [0-SDL_MAX_UINT32]. | ||
4431 | * | ||
4432 | * \threadsafety This function is thread-safe, as long as the state pointer | ||
4433 | * isn't shared between threads. | ||
4434 | * | ||
4435 | * \since This function is available since SDL 3.2.0. | ||
4436 | * | ||
4437 | * \sa SDL_rand_r | ||
4438 | * \sa SDL_randf_r | ||
4439 | */ | ||
4440 | extern SDL_DECLSPEC Uint32 SDLCALL SDL_rand_bits_r(Uint64 *state); | ||
4441 | |||
4442 | #ifndef SDL_PI_D | ||
4443 | |||
4444 | /** | ||
4445 | * The value of Pi, as a double-precision floating point literal. | ||
4446 | * | ||
4447 | * \since This macro is available since SDL 3.2.0. | ||
4448 | * | ||
4449 | * \sa SDL_PI_F | ||
4450 | */ | ||
4451 | #define SDL_PI_D 3.141592653589793238462643383279502884 /**< pi (double) */ | ||
4452 | #endif | ||
4453 | |||
4454 | #ifndef SDL_PI_F | ||
4455 | |||
4456 | /** | ||
4457 | * The value of Pi, as a single-precision floating point literal. | ||
4458 | * | ||
4459 | * \since This macro is available since SDL 3.2.0. | ||
4460 | * | ||
4461 | * \sa SDL_PI_D | ||
4462 | */ | ||
4463 | #define SDL_PI_F 3.141592653589793238462643383279502884F /**< pi (float) */ | ||
4464 | #endif | ||
4465 | |||
4466 | /** | ||
4467 | * Compute the arc cosine of `x`. | ||
4468 | * | ||
4469 | * The definition of `y = acos(x)` is `x = cos(y)`. | ||
4470 | * | ||
4471 | * Domain: `-1 <= x <= 1` | ||
4472 | * | ||
4473 | * Range: `0 <= y <= Pi` | ||
4474 | * | ||
4475 | * This function operates on double-precision floating point values, use | ||
4476 | * SDL_acosf for single-precision floats. | ||
4477 | * | ||
4478 | * This function may use a different approximation across different versions, | ||
4479 | * platforms and configurations. i.e, it can return a different value given | ||
4480 | * the same input on different machines or operating systems, or if SDL is | ||
4481 | * updated. | ||
4482 | * | ||
4483 | * \param x floating point value. | ||
4484 | * \returns arc cosine of `x`, in radians. | ||
4485 | * | ||
4486 | * \threadsafety It is safe to call this function from any thread. | ||
4487 | * | ||
4488 | * \since This function is available since SDL 3.2.0. | ||
4489 | * | ||
4490 | * \sa SDL_acosf | ||
4491 | * \sa SDL_asin | ||
4492 | * \sa SDL_cos | ||
4493 | */ | ||
4494 | extern SDL_DECLSPEC double SDLCALL SDL_acos(double x); | ||
4495 | |||
4496 | /** | ||
4497 | * Compute the arc cosine of `x`. | ||
4498 | * | ||
4499 | * The definition of `y = acos(x)` is `x = cos(y)`. | ||
4500 | * | ||
4501 | * Domain: `-1 <= x <= 1` | ||
4502 | * | ||
4503 | * Range: `0 <= y <= Pi` | ||
4504 | * | ||
4505 | * This function operates on single-precision floating point values, use | ||
4506 | * SDL_acos for double-precision floats. | ||
4507 | * | ||
4508 | * This function may use a different approximation across different versions, | ||
4509 | * platforms and configurations. i.e, it can return a different value given | ||
4510 | * the same input on different machines or operating systems, or if SDL is | ||
4511 | * updated. | ||
4512 | * | ||
4513 | * \param x floating point value. | ||
4514 | * \returns arc cosine of `x`, in radians. | ||
4515 | * | ||
4516 | * \threadsafety It is safe to call this function from any thread. | ||
4517 | * | ||
4518 | * \since This function is available since SDL 3.2.0. | ||
4519 | * | ||
4520 | * \sa SDL_acos | ||
4521 | * \sa SDL_asinf | ||
4522 | * \sa SDL_cosf | ||
4523 | */ | ||
4524 | extern SDL_DECLSPEC float SDLCALL SDL_acosf(float x); | ||
4525 | |||
4526 | /** | ||
4527 | * Compute the arc sine of `x`. | ||
4528 | * | ||
4529 | * The definition of `y = asin(x)` is `x = sin(y)`. | ||
4530 | * | ||
4531 | * Domain: `-1 <= x <= 1` | ||
4532 | * | ||
4533 | * Range: `-Pi/2 <= y <= Pi/2` | ||
4534 | * | ||
4535 | * This function operates on double-precision floating point values, use | ||
4536 | * SDL_asinf for single-precision floats. | ||
4537 | * | ||
4538 | * This function may use a different approximation across different versions, | ||
4539 | * platforms and configurations. i.e, it can return a different value given | ||
4540 | * the same input on different machines or operating systems, or if SDL is | ||
4541 | * updated. | ||
4542 | * | ||
4543 | * \param x floating point value. | ||
4544 | * \returns arc sine of `x`, in radians. | ||
4545 | * | ||
4546 | * \threadsafety It is safe to call this function from any thread. | ||
4547 | * | ||
4548 | * \since This function is available since SDL 3.2.0. | ||
4549 | * | ||
4550 | * \sa SDL_asinf | ||
4551 | * \sa SDL_acos | ||
4552 | * \sa SDL_sin | ||
4553 | */ | ||
4554 | extern SDL_DECLSPEC double SDLCALL SDL_asin(double x); | ||
4555 | |||
4556 | /** | ||
4557 | * Compute the arc sine of `x`. | ||
4558 | * | ||
4559 | * The definition of `y = asin(x)` is `x = sin(y)`. | ||
4560 | * | ||
4561 | * Domain: `-1 <= x <= 1` | ||
4562 | * | ||
4563 | * Range: `-Pi/2 <= y <= Pi/2` | ||
4564 | * | ||
4565 | * This function operates on single-precision floating point values, use | ||
4566 | * SDL_asin for double-precision floats. | ||
4567 | * | ||
4568 | * This function may use a different approximation across different versions, | ||
4569 | * platforms and configurations. i.e, it can return a different value given | ||
4570 | * the same input on different machines or operating systems, or if SDL is | ||
4571 | * updated. | ||
4572 | * | ||
4573 | * \param x floating point value. | ||
4574 | * \returns arc sine of `x`, in radians. | ||
4575 | * | ||
4576 | * \threadsafety It is safe to call this function from any thread. | ||
4577 | * | ||
4578 | * \since This function is available since SDL 3.2.0. | ||
4579 | * | ||
4580 | * \sa SDL_asin | ||
4581 | * \sa SDL_acosf | ||
4582 | * \sa SDL_sinf | ||
4583 | */ | ||
4584 | extern SDL_DECLSPEC float SDLCALL SDL_asinf(float x); | ||
4585 | |||
4586 | /** | ||
4587 | * Compute the arc tangent of `x`. | ||
4588 | * | ||
4589 | * The definition of `y = atan(x)` is `x = tan(y)`. | ||
4590 | * | ||
4591 | * Domain: `-INF <= x <= INF` | ||
4592 | * | ||
4593 | * Range: `-Pi/2 <= y <= Pi/2` | ||
4594 | * | ||
4595 | * This function operates on double-precision floating point values, use | ||
4596 | * SDL_atanf for single-precision floats. | ||
4597 | * | ||
4598 | * To calculate the arc tangent of y / x, use SDL_atan2. | ||
4599 | * | ||
4600 | * This function may use a different approximation across different versions, | ||
4601 | * platforms and configurations. i.e, it can return a different value given | ||
4602 | * the same input on different machines or operating systems, or if SDL is | ||
4603 | * updated. | ||
4604 | * | ||
4605 | * \param x floating point value. | ||
4606 | * \returns arc tangent of of `x` in radians, or 0 if `x = 0`. | ||
4607 | * | ||
4608 | * \threadsafety It is safe to call this function from any thread. | ||
4609 | * | ||
4610 | * \since This function is available since SDL 3.2.0. | ||
4611 | * | ||
4612 | * \sa SDL_atanf | ||
4613 | * \sa SDL_atan2 | ||
4614 | * \sa SDL_tan | ||
4615 | */ | ||
4616 | extern SDL_DECLSPEC double SDLCALL SDL_atan(double x); | ||
4617 | |||
4618 | /** | ||
4619 | * Compute the arc tangent of `x`. | ||
4620 | * | ||
4621 | * The definition of `y = atan(x)` is `x = tan(y)`. | ||
4622 | * | ||
4623 | * Domain: `-INF <= x <= INF` | ||
4624 | * | ||
4625 | * Range: `-Pi/2 <= y <= Pi/2` | ||
4626 | * | ||
4627 | * This function operates on single-precision floating point values, use | ||
4628 | * SDL_atan for dboule-precision floats. | ||
4629 | * | ||
4630 | * To calculate the arc tangent of y / x, use SDL_atan2f. | ||
4631 | * | ||
4632 | * This function may use a different approximation across different versions, | ||
4633 | * platforms and configurations. i.e, it can return a different value given | ||
4634 | * the same input on different machines or operating systems, or if SDL is | ||
4635 | * updated. | ||
4636 | * | ||
4637 | * \param x floating point value. | ||
4638 | * \returns arc tangent of of `x` in radians, or 0 if `x = 0`. | ||
4639 | * | ||
4640 | * \threadsafety It is safe to call this function from any thread. | ||
4641 | * | ||
4642 | * \since This function is available since SDL 3.2.0. | ||
4643 | * | ||
4644 | * \sa SDL_atan | ||
4645 | * \sa SDL_atan2f | ||
4646 | * \sa SDL_tanf | ||
4647 | */ | ||
4648 | extern SDL_DECLSPEC float SDLCALL SDL_atanf(float x); | ||
4649 | |||
4650 | /** | ||
4651 | * Compute the arc tangent of `y / x`, using the signs of x and y to adjust | ||
4652 | * the result's quadrant. | ||
4653 | * | ||
4654 | * The definition of `z = atan2(x, y)` is `y = x tan(z)`, where the quadrant | ||
4655 | * of z is determined based on the signs of x and y. | ||
4656 | * | ||
4657 | * Domain: `-INF <= x <= INF`, `-INF <= y <= INF` | ||
4658 | * | ||
4659 | * Range: `-Pi <= y <= Pi` | ||
4660 | * | ||
4661 | * This function operates on double-precision floating point values, use | ||
4662 | * SDL_atan2f for single-precision floats. | ||
4663 | * | ||
4664 | * To calculate the arc tangent of a single value, use SDL_atan. | ||
4665 | * | ||
4666 | * This function may use a different approximation across different versions, | ||
4667 | * platforms and configurations. i.e, it can return a different value given | ||
4668 | * the same input on different machines or operating systems, or if SDL is | ||
4669 | * updated. | ||
4670 | * | ||
4671 | * \param y floating point value of the numerator (y coordinate). | ||
4672 | * \param x floating point value of the denominator (x coordinate). | ||
4673 | * \returns arc tangent of of `y / x` in radians, or, if `x = 0`, either | ||
4674 | * `-Pi/2`, `0`, or `Pi/2`, depending on the value of `y`. | ||
4675 | * | ||
4676 | * \threadsafety It is safe to call this function from any thread. | ||
4677 | * | ||
4678 | * \since This function is available since SDL 3.2.0. | ||
4679 | * | ||
4680 | * \sa SDL_atan2f | ||
4681 | * \sa SDL_atan | ||
4682 | * \sa SDL_tan | ||
4683 | */ | ||
4684 | extern SDL_DECLSPEC double SDLCALL SDL_atan2(double y, double x); | ||
4685 | |||
4686 | /** | ||
4687 | * Compute the arc tangent of `y / x`, using the signs of x and y to adjust | ||
4688 | * the result's quadrant. | ||
4689 | * | ||
4690 | * The definition of `z = atan2(x, y)` is `y = x tan(z)`, where the quadrant | ||
4691 | * of z is determined based on the signs of x and y. | ||
4692 | * | ||
4693 | * Domain: `-INF <= x <= INF`, `-INF <= y <= INF` | ||
4694 | * | ||
4695 | * Range: `-Pi <= y <= Pi` | ||
4696 | * | ||
4697 | * This function operates on single-precision floating point values, use | ||
4698 | * SDL_atan2 for double-precision floats. | ||
4699 | * | ||
4700 | * To calculate the arc tangent of a single value, use SDL_atanf. | ||
4701 | * | ||
4702 | * This function may use a different approximation across different versions, | ||
4703 | * platforms and configurations. i.e, it can return a different value given | ||
4704 | * the same input on different machines or operating systems, or if SDL is | ||
4705 | * updated. | ||
4706 | * | ||
4707 | * \param y floating point value of the numerator (y coordinate). | ||
4708 | * \param x floating point value of the denominator (x coordinate). | ||
4709 | * \returns arc tangent of of `y / x` in radians, or, if `x = 0`, either | ||
4710 | * `-Pi/2`, `0`, or `Pi/2`, depending on the value of `y`. | ||
4711 | * | ||
4712 | * \threadsafety It is safe to call this function from any thread. | ||
4713 | * | ||
4714 | * \since This function is available since SDL 3.2.0. | ||
4715 | * | ||
4716 | * \sa SDL_atan2 | ||
4717 | * \sa SDL_atan | ||
4718 | * \sa SDL_tan | ||
4719 | */ | ||
4720 | extern SDL_DECLSPEC float SDLCALL SDL_atan2f(float y, float x); | ||
4721 | |||
4722 | /** | ||
4723 | * Compute the ceiling of `x`. | ||
4724 | * | ||
4725 | * The ceiling of `x` is the smallest integer `y` such that `y > x`, i.e `x` | ||
4726 | * rounded up to the nearest integer. | ||
4727 | * | ||
4728 | * Domain: `-INF <= x <= INF` | ||
4729 | * | ||
4730 | * Range: `-INF <= y <= INF`, y integer | ||
4731 | * | ||
4732 | * This function operates on double-precision floating point values, use | ||
4733 | * SDL_ceilf for single-precision floats. | ||
4734 | * | ||
4735 | * \param x floating point value. | ||
4736 | * \returns the ceiling of `x`. | ||
4737 | * | ||
4738 | * \threadsafety It is safe to call this function from any thread. | ||
4739 | * | ||
4740 | * \since This function is available since SDL 3.2.0. | ||
4741 | * | ||
4742 | * \sa SDL_ceilf | ||
4743 | * \sa SDL_floor | ||
4744 | * \sa SDL_trunc | ||
4745 | * \sa SDL_round | ||
4746 | * \sa SDL_lround | ||
4747 | */ | ||
4748 | extern SDL_DECLSPEC double SDLCALL SDL_ceil(double x); | ||
4749 | |||
4750 | /** | ||
4751 | * Compute the ceiling of `x`. | ||
4752 | * | ||
4753 | * The ceiling of `x` is the smallest integer `y` such that `y > x`, i.e `x` | ||
4754 | * rounded up to the nearest integer. | ||
4755 | * | ||
4756 | * Domain: `-INF <= x <= INF` | ||
4757 | * | ||
4758 | * Range: `-INF <= y <= INF`, y integer | ||
4759 | * | ||
4760 | * This function operates on single-precision floating point values, use | ||
4761 | * SDL_ceil for double-precision floats. | ||
4762 | * | ||
4763 | * \param x floating point value. | ||
4764 | * \returns the ceiling of `x`. | ||
4765 | * | ||
4766 | * \threadsafety It is safe to call this function from any thread. | ||
4767 | * | ||
4768 | * \since This function is available since SDL 3.2.0. | ||
4769 | * | ||
4770 | * \sa SDL_ceil | ||
4771 | * \sa SDL_floorf | ||
4772 | * \sa SDL_truncf | ||
4773 | * \sa SDL_roundf | ||
4774 | * \sa SDL_lroundf | ||
4775 | */ | ||
4776 | extern SDL_DECLSPEC float SDLCALL SDL_ceilf(float x); | ||
4777 | |||
4778 | /** | ||
4779 | * Copy the sign of one floating-point value to another. | ||
4780 | * | ||
4781 | * The definition of copysign is that ``copysign(x, y) = abs(x) * sign(y)``. | ||
4782 | * | ||
4783 | * Domain: `-INF <= x <= INF`, ``-INF <= y <= f`` | ||
4784 | * | ||
4785 | * Range: `-INF <= z <= INF` | ||
4786 | * | ||
4787 | * This function operates on double-precision floating point values, use | ||
4788 | * SDL_copysignf for single-precision floats. | ||
4789 | * | ||
4790 | * \param x floating point value to use as the magnitude. | ||
4791 | * \param y floating point value to use as the sign. | ||
4792 | * \returns the floating point value with the sign of y and the magnitude of | ||
4793 | * x. | ||
4794 | * | ||
4795 | * \threadsafety It is safe to call this function from any thread. | ||
4796 | * | ||
4797 | * \since This function is available since SDL 3.2.0. | ||
4798 | * | ||
4799 | * \sa SDL_copysignf | ||
4800 | * \sa SDL_fabs | ||
4801 | */ | ||
4802 | extern SDL_DECLSPEC double SDLCALL SDL_copysign(double x, double y); | ||
4803 | |||
4804 | /** | ||
4805 | * Copy the sign of one floating-point value to another. | ||
4806 | * | ||
4807 | * The definition of copysign is that ``copysign(x, y) = abs(x) * sign(y)``. | ||
4808 | * | ||
4809 | * Domain: `-INF <= x <= INF`, ``-INF <= y <= f`` | ||
4810 | * | ||
4811 | * Range: `-INF <= z <= INF` | ||
4812 | * | ||
4813 | * This function operates on single-precision floating point values, use | ||
4814 | * SDL_copysign for double-precision floats. | ||
4815 | * | ||
4816 | * \param x floating point value to use as the magnitude. | ||
4817 | * \param y floating point value to use as the sign. | ||
4818 | * \returns the floating point value with the sign of y and the magnitude of | ||
4819 | * x. | ||
4820 | * | ||
4821 | * \threadsafety It is safe to call this function from any thread. | ||
4822 | * | ||
4823 | * \since This function is available since SDL 3.2.0. | ||
4824 | * | ||
4825 | * \sa SDL_copysign | ||
4826 | * \sa SDL_fabsf | ||
4827 | */ | ||
4828 | extern SDL_DECLSPEC float SDLCALL SDL_copysignf(float x, float y); | ||
4829 | |||
4830 | /** | ||
4831 | * Compute the cosine of `x`. | ||
4832 | * | ||
4833 | * Domain: `-INF <= x <= INF` | ||
4834 | * | ||
4835 | * Range: `-1 <= y <= 1` | ||
4836 | * | ||
4837 | * This function operates on double-precision floating point values, use | ||
4838 | * SDL_cosf for single-precision floats. | ||
4839 | * | ||
4840 | * This function may use a different approximation across different versions, | ||
4841 | * platforms and configurations. i.e, it can return a different value given | ||
4842 | * the same input on different machines or operating systems, or if SDL is | ||
4843 | * updated. | ||
4844 | * | ||
4845 | * \param x floating point value, in radians. | ||
4846 | * \returns cosine of `x`. | ||
4847 | * | ||
4848 | * \threadsafety It is safe to call this function from any thread. | ||
4849 | * | ||
4850 | * \since This function is available since SDL 3.2.0. | ||
4851 | * | ||
4852 | * \sa SDL_cosf | ||
4853 | * \sa SDL_acos | ||
4854 | * \sa SDL_sin | ||
4855 | */ | ||
4856 | extern SDL_DECLSPEC double SDLCALL SDL_cos(double x); | ||
4857 | |||
4858 | /** | ||
4859 | * Compute the cosine of `x`. | ||
4860 | * | ||
4861 | * Domain: `-INF <= x <= INF` | ||
4862 | * | ||
4863 | * Range: `-1 <= y <= 1` | ||
4864 | * | ||
4865 | * This function operates on single-precision floating point values, use | ||
4866 | * SDL_cos for double-precision floats. | ||
4867 | * | ||
4868 | * This function may use a different approximation across different versions, | ||
4869 | * platforms and configurations. i.e, it can return a different value given | ||
4870 | * the same input on different machines or operating systems, or if SDL is | ||
4871 | * updated. | ||
4872 | * | ||
4873 | * \param x floating point value, in radians. | ||
4874 | * \returns cosine of `x`. | ||
4875 | * | ||
4876 | * \threadsafety It is safe to call this function from any thread. | ||
4877 | * | ||
4878 | * \since This function is available since SDL 3.2.0. | ||
4879 | * | ||
4880 | * \sa SDL_cos | ||
4881 | * \sa SDL_acosf | ||
4882 | * \sa SDL_sinf | ||
4883 | */ | ||
4884 | extern SDL_DECLSPEC float SDLCALL SDL_cosf(float x); | ||
4885 | |||
4886 | /** | ||
4887 | * Compute the exponential of `x`. | ||
4888 | * | ||
4889 | * The definition of `y = exp(x)` is `y = e^x`, where `e` is the base of the | ||
4890 | * natural logarithm. The inverse is the natural logarithm, SDL_log. | ||
4891 | * | ||
4892 | * Domain: `-INF <= x <= INF` | ||
4893 | * | ||
4894 | * Range: `0 <= y <= INF` | ||
4895 | * | ||
4896 | * The output will overflow if `exp(x)` is too large to be represented. | ||
4897 | * | ||
4898 | * This function operates on double-precision floating point values, use | ||
4899 | * SDL_expf for single-precision floats. | ||
4900 | * | ||
4901 | * This function may use a different approximation across different versions, | ||
4902 | * platforms and configurations. i.e, it can return a different value given | ||
4903 | * the same input on different machines or operating systems, or if SDL is | ||
4904 | * updated. | ||
4905 | * | ||
4906 | * \param x floating point value. | ||
4907 | * \returns value of `e^x`. | ||
4908 | * | ||
4909 | * \threadsafety It is safe to call this function from any thread. | ||
4910 | * | ||
4911 | * \since This function is available since SDL 3.2.0. | ||
4912 | * | ||
4913 | * \sa SDL_expf | ||
4914 | * \sa SDL_log | ||
4915 | */ | ||
4916 | extern SDL_DECLSPEC double SDLCALL SDL_exp(double x); | ||
4917 | |||
4918 | /** | ||
4919 | * Compute the exponential of `x`. | ||
4920 | * | ||
4921 | * The definition of `y = exp(x)` is `y = e^x`, where `e` is the base of the | ||
4922 | * natural logarithm. The inverse is the natural logarithm, SDL_logf. | ||
4923 | * | ||
4924 | * Domain: `-INF <= x <= INF` | ||
4925 | * | ||
4926 | * Range: `0 <= y <= INF` | ||
4927 | * | ||
4928 | * The output will overflow if `exp(x)` is too large to be represented. | ||
4929 | * | ||
4930 | * This function operates on single-precision floating point values, use | ||
4931 | * SDL_exp for double-precision floats. | ||
4932 | * | ||
4933 | * This function may use a different approximation across different versions, | ||
4934 | * platforms and configurations. i.e, it can return a different value given | ||
4935 | * the same input on different machines or operating systems, or if SDL is | ||
4936 | * updated. | ||
4937 | * | ||
4938 | * \param x floating point value. | ||
4939 | * \returns value of `e^x`. | ||
4940 | * | ||
4941 | * \threadsafety It is safe to call this function from any thread. | ||
4942 | * | ||
4943 | * \since This function is available since SDL 3.2.0. | ||
4944 | * | ||
4945 | * \sa SDL_exp | ||
4946 | * \sa SDL_logf | ||
4947 | */ | ||
4948 | extern SDL_DECLSPEC float SDLCALL SDL_expf(float x); | ||
4949 | |||
4950 | /** | ||
4951 | * Compute the absolute value of `x` | ||
4952 | * | ||
4953 | * Domain: `-INF <= x <= INF` | ||
4954 | * | ||
4955 | * Range: `0 <= y <= INF` | ||
4956 | * | ||
4957 | * This function operates on double-precision floating point values, use | ||
4958 | * SDL_fabsf for single-precision floats. | ||
4959 | * | ||
4960 | * \param x floating point value to use as the magnitude. | ||
4961 | * \returns the absolute value of `x`. | ||
4962 | * | ||
4963 | * \threadsafety It is safe to call this function from any thread. | ||
4964 | * | ||
4965 | * \since This function is available since SDL 3.2.0. | ||
4966 | * | ||
4967 | * \sa SDL_fabsf | ||
4968 | */ | ||
4969 | extern SDL_DECLSPEC double SDLCALL SDL_fabs(double x); | ||
4970 | |||
4971 | /** | ||
4972 | * Compute the absolute value of `x` | ||
4973 | * | ||
4974 | * Domain: `-INF <= x <= INF` | ||
4975 | * | ||
4976 | * Range: `0 <= y <= INF` | ||
4977 | * | ||
4978 | * This function operates on single-precision floating point values, use | ||
4979 | * SDL_fabs for double-precision floats. | ||
4980 | * | ||
4981 | * \param x floating point value to use as the magnitude. | ||
4982 | * \returns the absolute value of `x`. | ||
4983 | * | ||
4984 | * \threadsafety It is safe to call this function from any thread. | ||
4985 | * | ||
4986 | * \since This function is available since SDL 3.2.0. | ||
4987 | * | ||
4988 | * \sa SDL_fabs | ||
4989 | */ | ||
4990 | extern SDL_DECLSPEC float SDLCALL SDL_fabsf(float x); | ||
4991 | |||
4992 | /** | ||
4993 | * Compute the floor of `x`. | ||
4994 | * | ||
4995 | * The floor of `x` is the largest integer `y` such that `y > x`, i.e `x` | ||
4996 | * rounded down to the nearest integer. | ||
4997 | * | ||
4998 | * Domain: `-INF <= x <= INF` | ||
4999 | * | ||
5000 | * Range: `-INF <= y <= INF`, y integer | ||
5001 | * | ||
5002 | * This function operates on double-precision floating point values, use | ||
5003 | * SDL_floorf for single-precision floats. | ||
5004 | * | ||
5005 | * \param x floating point value. | ||
5006 | * \returns the floor of `x`. | ||
5007 | * | ||
5008 | * \threadsafety It is safe to call this function from any thread. | ||
5009 | * | ||
5010 | * \since This function is available since SDL 3.2.0. | ||
5011 | * | ||
5012 | * \sa SDL_floorf | ||
5013 | * \sa SDL_ceil | ||
5014 | * \sa SDL_trunc | ||
5015 | * \sa SDL_round | ||
5016 | * \sa SDL_lround | ||
5017 | */ | ||
5018 | extern SDL_DECLSPEC double SDLCALL SDL_floor(double x); | ||
5019 | |||
5020 | /** | ||
5021 | * Compute the floor of `x`. | ||
5022 | * | ||
5023 | * The floor of `x` is the largest integer `y` such that `y > x`, i.e `x` | ||
5024 | * rounded down to the nearest integer. | ||
5025 | * | ||
5026 | * Domain: `-INF <= x <= INF` | ||
5027 | * | ||
5028 | * Range: `-INF <= y <= INF`, y integer | ||
5029 | * | ||
5030 | * This function operates on single-precision floating point values, use | ||
5031 | * SDL_floor for double-precision floats. | ||
5032 | * | ||
5033 | * \param x floating point value. | ||
5034 | * \returns the floor of `x`. | ||
5035 | * | ||
5036 | * \threadsafety It is safe to call this function from any thread. | ||
5037 | * | ||
5038 | * \since This function is available since SDL 3.2.0. | ||
5039 | * | ||
5040 | * \sa SDL_floor | ||
5041 | * \sa SDL_ceilf | ||
5042 | * \sa SDL_truncf | ||
5043 | * \sa SDL_roundf | ||
5044 | * \sa SDL_lroundf | ||
5045 | */ | ||
5046 | extern SDL_DECLSPEC float SDLCALL SDL_floorf(float x); | ||
5047 | |||
5048 | /** | ||
5049 | * Truncate `x` to an integer. | ||
5050 | * | ||
5051 | * Rounds `x` to the next closest integer to 0. This is equivalent to removing | ||
5052 | * the fractional part of `x`, leaving only the integer part. | ||
5053 | * | ||
5054 | * Domain: `-INF <= x <= INF` | ||
5055 | * | ||
5056 | * Range: `-INF <= y <= INF`, y integer | ||
5057 | * | ||
5058 | * This function operates on double-precision floating point values, use | ||
5059 | * SDL_truncf for single-precision floats. | ||
5060 | * | ||
5061 | * \param x floating point value. | ||
5062 | * \returns `x` truncated to an integer. | ||
5063 | * | ||
5064 | * \threadsafety It is safe to call this function from any thread. | ||
5065 | * | ||
5066 | * \since This function is available since SDL 3.2.0. | ||
5067 | * | ||
5068 | * \sa SDL_truncf | ||
5069 | * \sa SDL_fmod | ||
5070 | * \sa SDL_ceil | ||
5071 | * \sa SDL_floor | ||
5072 | * \sa SDL_round | ||
5073 | * \sa SDL_lround | ||
5074 | */ | ||
5075 | extern SDL_DECLSPEC double SDLCALL SDL_trunc(double x); | ||
5076 | |||
5077 | /** | ||
5078 | * Truncate `x` to an integer. | ||
5079 | * | ||
5080 | * Rounds `x` to the next closest integer to 0. This is equivalent to removing | ||
5081 | * the fractional part of `x`, leaving only the integer part. | ||
5082 | * | ||
5083 | * Domain: `-INF <= x <= INF` | ||
5084 | * | ||
5085 | * Range: `-INF <= y <= INF`, y integer | ||
5086 | * | ||
5087 | * This function operates on single-precision floating point values, use | ||
5088 | * SDL_trunc for double-precision floats. | ||
5089 | * | ||
5090 | * \param x floating point value. | ||
5091 | * \returns `x` truncated to an integer. | ||
5092 | * | ||
5093 | * \threadsafety It is safe to call this function from any thread. | ||
5094 | * | ||
5095 | * \since This function is available since SDL 3.2.0. | ||
5096 | * | ||
5097 | * \sa SDL_trunc | ||
5098 | * \sa SDL_fmodf | ||
5099 | * \sa SDL_ceilf | ||
5100 | * \sa SDL_floorf | ||
5101 | * \sa SDL_roundf | ||
5102 | * \sa SDL_lroundf | ||
5103 | */ | ||
5104 | extern SDL_DECLSPEC float SDLCALL SDL_truncf(float x); | ||
5105 | |||
5106 | /** | ||
5107 | * Return the floating-point remainder of `x / y` | ||
5108 | * | ||
5109 | * Divides `x` by `y`, and returns the remainder. | ||
5110 | * | ||
5111 | * Domain: `-INF <= x <= INF`, `-INF <= y <= INF`, `y != 0` | ||
5112 | * | ||
5113 | * Range: `-y <= z <= y` | ||
5114 | * | ||
5115 | * This function operates on double-precision floating point values, use | ||
5116 | * SDL_fmodf for single-precision floats. | ||
5117 | * | ||
5118 | * \param x the numerator. | ||
5119 | * \param y the denominator. Must not be 0. | ||
5120 | * \returns the remainder of `x / y`. | ||
5121 | * | ||
5122 | * \threadsafety It is safe to call this function from any thread. | ||
5123 | * | ||
5124 | * \since This function is available since SDL 3.2.0. | ||
5125 | * | ||
5126 | * \sa SDL_fmodf | ||
5127 | * \sa SDL_modf | ||
5128 | * \sa SDL_trunc | ||
5129 | * \sa SDL_ceil | ||
5130 | * \sa SDL_floor | ||
5131 | * \sa SDL_round | ||
5132 | * \sa SDL_lround | ||
5133 | */ | ||
5134 | extern SDL_DECLSPEC double SDLCALL SDL_fmod(double x, double y); | ||
5135 | |||
5136 | /** | ||
5137 | * Return the floating-point remainder of `x / y` | ||
5138 | * | ||
5139 | * Divides `x` by `y`, and returns the remainder. | ||
5140 | * | ||
5141 | * Domain: `-INF <= x <= INF`, `-INF <= y <= INF`, `y != 0` | ||
5142 | * | ||
5143 | * Range: `-y <= z <= y` | ||
5144 | * | ||
5145 | * This function operates on single-precision floating point values, use | ||
5146 | * SDL_fmod for double-precision floats. | ||
5147 | * | ||
5148 | * \param x the numerator. | ||
5149 | * \param y the denominator. Must not be 0. | ||
5150 | * \returns the remainder of `x / y`. | ||
5151 | * | ||
5152 | * \threadsafety It is safe to call this function from any thread. | ||
5153 | * | ||
5154 | * \since This function is available since SDL 3.2.0. | ||
5155 | * | ||
5156 | * \sa SDL_fmod | ||
5157 | * \sa SDL_truncf | ||
5158 | * \sa SDL_modff | ||
5159 | * \sa SDL_ceilf | ||
5160 | * \sa SDL_floorf | ||
5161 | * \sa SDL_roundf | ||
5162 | * \sa SDL_lroundf | ||
5163 | */ | ||
5164 | extern SDL_DECLSPEC float SDLCALL SDL_fmodf(float x, float y); | ||
5165 | |||
5166 | /** | ||
5167 | * Return whether the value is infinity. | ||
5168 | * | ||
5169 | * \param x double-precision floating point value. | ||
5170 | * \returns non-zero if the value is infinity, 0 otherwise. | ||
5171 | * | ||
5172 | * \threadsafety It is safe to call this function from any thread. | ||
5173 | * | ||
5174 | * \since This function is available since SDL 3.2.0. | ||
5175 | * | ||
5176 | * \sa SDL_isinff | ||
5177 | */ | ||
5178 | extern SDL_DECLSPEC int SDLCALL SDL_isinf(double x); | ||
5179 | |||
5180 | /** | ||
5181 | * Return whether the value is infinity. | ||
5182 | * | ||
5183 | * \param x floating point value. | ||
5184 | * \returns non-zero if the value is infinity, 0 otherwise. | ||
5185 | * | ||
5186 | * \threadsafety It is safe to call this function from any thread. | ||
5187 | * | ||
5188 | * \since This function is available since SDL 3.2.0. | ||
5189 | * | ||
5190 | * \sa SDL_isinf | ||
5191 | */ | ||
5192 | extern SDL_DECLSPEC int SDLCALL SDL_isinff(float x); | ||
5193 | |||
5194 | /** | ||
5195 | * Return whether the value is NaN. | ||
5196 | * | ||
5197 | * \param x double-precision floating point value. | ||
5198 | * \returns non-zero if the value is NaN, 0 otherwise. | ||
5199 | * | ||
5200 | * \threadsafety It is safe to call this function from any thread. | ||
5201 | * | ||
5202 | * \since This function is available since SDL 3.2.0. | ||
5203 | * | ||
5204 | * \sa SDL_isnanf | ||
5205 | */ | ||
5206 | extern SDL_DECLSPEC int SDLCALL SDL_isnan(double x); | ||
5207 | |||
5208 | /** | ||
5209 | * Return whether the value is NaN. | ||
5210 | * | ||
5211 | * \param x floating point value. | ||
5212 | * \returns non-zero if the value is NaN, 0 otherwise. | ||
5213 | * | ||
5214 | * \threadsafety It is safe to call this function from any thread. | ||
5215 | * | ||
5216 | * \since This function is available since SDL 3.2.0. | ||
5217 | * | ||
5218 | * \sa SDL_isnan | ||
5219 | */ | ||
5220 | extern SDL_DECLSPEC int SDLCALL SDL_isnanf(float x); | ||
5221 | |||
5222 | /** | ||
5223 | * Compute the natural logarithm of `x`. | ||
5224 | * | ||
5225 | * Domain: `0 < x <= INF` | ||
5226 | * | ||
5227 | * Range: `-INF <= y <= INF` | ||
5228 | * | ||
5229 | * It is an error for `x` to be less than or equal to 0. | ||
5230 | * | ||
5231 | * This function operates on double-precision floating point values, use | ||
5232 | * SDL_logf for single-precision floats. | ||
5233 | * | ||
5234 | * This function may use a different approximation across different versions, | ||
5235 | * platforms and configurations. i.e, it can return a different value given | ||
5236 | * the same input on different machines or operating systems, or if SDL is | ||
5237 | * updated. | ||
5238 | * | ||
5239 | * \param x floating point value. Must be greater than 0. | ||
5240 | * \returns the natural logarithm of `x`. | ||
5241 | * | ||
5242 | * \threadsafety It is safe to call this function from any thread. | ||
5243 | * | ||
5244 | * \since This function is available since SDL 3.2.0. | ||
5245 | * | ||
5246 | * \sa SDL_logf | ||
5247 | * \sa SDL_log10 | ||
5248 | * \sa SDL_exp | ||
5249 | */ | ||
5250 | extern SDL_DECLSPEC double SDLCALL SDL_log(double x); | ||
5251 | |||
5252 | /** | ||
5253 | * Compute the natural logarithm of `x`. | ||
5254 | * | ||
5255 | * Domain: `0 < x <= INF` | ||
5256 | * | ||
5257 | * Range: `-INF <= y <= INF` | ||
5258 | * | ||
5259 | * It is an error for `x` to be less than or equal to 0. | ||
5260 | * | ||
5261 | * This function operates on single-precision floating point values, use | ||
5262 | * SDL_log for double-precision floats. | ||
5263 | * | ||
5264 | * This function may use a different approximation across different versions, | ||
5265 | * platforms and configurations. i.e, it can return a different value given | ||
5266 | * the same input on different machines or operating systems, or if SDL is | ||
5267 | * updated. | ||
5268 | * | ||
5269 | * \param x floating point value. Must be greater than 0. | ||
5270 | * \returns the natural logarithm of `x`. | ||
5271 | * | ||
5272 | * \threadsafety It is safe to call this function from any thread. | ||
5273 | * | ||
5274 | * \since This function is available since SDL 3.2.0. | ||
5275 | * | ||
5276 | * \sa SDL_log | ||
5277 | * \sa SDL_expf | ||
5278 | */ | ||
5279 | extern SDL_DECLSPEC float SDLCALL SDL_logf(float x); | ||
5280 | |||
5281 | /** | ||
5282 | * Compute the base-10 logarithm of `x`. | ||
5283 | * | ||
5284 | * Domain: `0 < x <= INF` | ||
5285 | * | ||
5286 | * Range: `-INF <= y <= INF` | ||
5287 | * | ||
5288 | * It is an error for `x` to be less than or equal to 0. | ||
5289 | * | ||
5290 | * This function operates on double-precision floating point values, use | ||
5291 | * SDL_log10f for single-precision floats. | ||
5292 | * | ||
5293 | * This function may use a different approximation across different versions, | ||
5294 | * platforms and configurations. i.e, it can return a different value given | ||
5295 | * the same input on different machines or operating systems, or if SDL is | ||
5296 | * updated. | ||
5297 | * | ||
5298 | * \param x floating point value. Must be greater than 0. | ||
5299 | * \returns the logarithm of `x`. | ||
5300 | * | ||
5301 | * \threadsafety It is safe to call this function from any thread. | ||
5302 | * | ||
5303 | * \since This function is available since SDL 3.2.0. | ||
5304 | * | ||
5305 | * \sa SDL_log10f | ||
5306 | * \sa SDL_log | ||
5307 | * \sa SDL_pow | ||
5308 | */ | ||
5309 | extern SDL_DECLSPEC double SDLCALL SDL_log10(double x); | ||
5310 | |||
5311 | /** | ||
5312 | * Compute the base-10 logarithm of `x`. | ||
5313 | * | ||
5314 | * Domain: `0 < x <= INF` | ||
5315 | * | ||
5316 | * Range: `-INF <= y <= INF` | ||
5317 | * | ||
5318 | * It is an error for `x` to be less than or equal to 0. | ||
5319 | * | ||
5320 | * This function operates on single-precision floating point values, use | ||
5321 | * SDL_log10 for double-precision floats. | ||
5322 | * | ||
5323 | * This function may use a different approximation across different versions, | ||
5324 | * platforms and configurations. i.e, it can return a different value given | ||
5325 | * the same input on different machines or operating systems, or if SDL is | ||
5326 | * updated. | ||
5327 | * | ||
5328 | * \param x floating point value. Must be greater than 0. | ||
5329 | * \returns the logarithm of `x`. | ||
5330 | * | ||
5331 | * \threadsafety It is safe to call this function from any thread. | ||
5332 | * | ||
5333 | * \since This function is available since SDL 3.2.0. | ||
5334 | * | ||
5335 | * \sa SDL_log10 | ||
5336 | * \sa SDL_logf | ||
5337 | * \sa SDL_powf | ||
5338 | */ | ||
5339 | extern SDL_DECLSPEC float SDLCALL SDL_log10f(float x); | ||
5340 | |||
5341 | /** | ||
5342 | * Split `x` into integer and fractional parts | ||
5343 | * | ||
5344 | * This function operates on double-precision floating point values, use | ||
5345 | * SDL_modff for single-precision floats. | ||
5346 | * | ||
5347 | * \param x floating point value. | ||
5348 | * \param y output pointer to store the integer part of `x`. | ||
5349 | * \returns the fractional part of `x`. | ||
5350 | * | ||
5351 | * \threadsafety It is safe to call this function from any thread. | ||
5352 | * | ||
5353 | * \since This function is available since SDL 3.2.0. | ||
5354 | * | ||
5355 | * \sa SDL_modff | ||
5356 | * \sa SDL_trunc | ||
5357 | * \sa SDL_fmod | ||
5358 | */ | ||
5359 | extern SDL_DECLSPEC double SDLCALL SDL_modf(double x, double *y); | ||
5360 | |||
5361 | /** | ||
5362 | * Split `x` into integer and fractional parts | ||
5363 | * | ||
5364 | * This function operates on single-precision floating point values, use | ||
5365 | * SDL_modf for double-precision floats. | ||
5366 | * | ||
5367 | * \param x floating point value. | ||
5368 | * \param y output pointer to store the integer part of `x`. | ||
5369 | * \returns the fractional part of `x`. | ||
5370 | * | ||
5371 | * \threadsafety It is safe to call this function from any thread. | ||
5372 | * | ||
5373 | * \since This function is available since SDL 3.2.0. | ||
5374 | * | ||
5375 | * \sa SDL_modf | ||
5376 | * \sa SDL_truncf | ||
5377 | * \sa SDL_fmodf | ||
5378 | */ | ||
5379 | extern SDL_DECLSPEC float SDLCALL SDL_modff(float x, float *y); | ||
5380 | |||
5381 | /** | ||
5382 | * Raise `x` to the power `y` | ||
5383 | * | ||
5384 | * Domain: `-INF <= x <= INF`, `-INF <= y <= INF` | ||
5385 | * | ||
5386 | * Range: `-INF <= z <= INF` | ||
5387 | * | ||
5388 | * If `y` is the base of the natural logarithm (e), consider using SDL_exp | ||
5389 | * instead. | ||
5390 | * | ||
5391 | * This function operates on double-precision floating point values, use | ||
5392 | * SDL_powf for single-precision floats. | ||
5393 | * | ||
5394 | * This function may use a different approximation across different versions, | ||
5395 | * platforms and configurations. i.e, it can return a different value given | ||
5396 | * the same input on different machines or operating systems, or if SDL is | ||
5397 | * updated. | ||
5398 | * | ||
5399 | * \param x the base. | ||
5400 | * \param y the exponent. | ||
5401 | * \returns `x` raised to the power `y`. | ||
5402 | * | ||
5403 | * \threadsafety It is safe to call this function from any thread. | ||
5404 | * | ||
5405 | * \since This function is available since SDL 3.2.0. | ||
5406 | * | ||
5407 | * \sa SDL_powf | ||
5408 | * \sa SDL_exp | ||
5409 | * \sa SDL_log | ||
5410 | */ | ||
5411 | extern SDL_DECLSPEC double SDLCALL SDL_pow(double x, double y); | ||
5412 | |||
5413 | /** | ||
5414 | * Raise `x` to the power `y` | ||
5415 | * | ||
5416 | * Domain: `-INF <= x <= INF`, `-INF <= y <= INF` | ||
5417 | * | ||
5418 | * Range: `-INF <= z <= INF` | ||
5419 | * | ||
5420 | * If `y` is the base of the natural logarithm (e), consider using SDL_exp | ||
5421 | * instead. | ||
5422 | * | ||
5423 | * This function operates on single-precision floating point values, use | ||
5424 | * SDL_pow for double-precision floats. | ||
5425 | * | ||
5426 | * This function may use a different approximation across different versions, | ||
5427 | * platforms and configurations. i.e, it can return a different value given | ||
5428 | * the same input on different machines or operating systems, or if SDL is | ||
5429 | * updated. | ||
5430 | * | ||
5431 | * \param x the base. | ||
5432 | * \param y the exponent. | ||
5433 | * \returns `x` raised to the power `y`. | ||
5434 | * | ||
5435 | * \threadsafety It is safe to call this function from any thread. | ||
5436 | * | ||
5437 | * \since This function is available since SDL 3.2.0. | ||
5438 | * | ||
5439 | * \sa SDL_pow | ||
5440 | * \sa SDL_expf | ||
5441 | * \sa SDL_logf | ||
5442 | */ | ||
5443 | extern SDL_DECLSPEC float SDLCALL SDL_powf(float x, float y); | ||
5444 | |||
5445 | /** | ||
5446 | * Round `x` to the nearest integer. | ||
5447 | * | ||
5448 | * Rounds `x` to the nearest integer. Values halfway between integers will be | ||
5449 | * rounded away from zero. | ||
5450 | * | ||
5451 | * Domain: `-INF <= x <= INF` | ||
5452 | * | ||
5453 | * Range: `-INF <= y <= INF`, y integer | ||
5454 | * | ||
5455 | * This function operates on double-precision floating point values, use | ||
5456 | * SDL_roundf for single-precision floats. To get the result as an integer | ||
5457 | * type, use SDL_lround. | ||
5458 | * | ||
5459 | * \param x floating point value. | ||
5460 | * \returns the nearest integer to `x`. | ||
5461 | * | ||
5462 | * \threadsafety It is safe to call this function from any thread. | ||
5463 | * | ||
5464 | * \since This function is available since SDL 3.2.0. | ||
5465 | * | ||
5466 | * \sa SDL_roundf | ||
5467 | * \sa SDL_lround | ||
5468 | * \sa SDL_floor | ||
5469 | * \sa SDL_ceil | ||
5470 | * \sa SDL_trunc | ||
5471 | */ | ||
5472 | extern SDL_DECLSPEC double SDLCALL SDL_round(double x); | ||
5473 | |||
5474 | /** | ||
5475 | * Round `x` to the nearest integer. | ||
5476 | * | ||
5477 | * Rounds `x` to the nearest integer. Values halfway between integers will be | ||
5478 | * rounded away from zero. | ||
5479 | * | ||
5480 | * Domain: `-INF <= x <= INF` | ||
5481 | * | ||
5482 | * Range: `-INF <= y <= INF`, y integer | ||
5483 | * | ||
5484 | * This function operates on single-precision floating point values, use | ||
5485 | * SDL_round for double-precision floats. To get the result as an integer | ||
5486 | * type, use SDL_lroundf. | ||
5487 | * | ||
5488 | * \param x floating point value. | ||
5489 | * \returns the nearest integer to `x`. | ||
5490 | * | ||
5491 | * \threadsafety It is safe to call this function from any thread. | ||
5492 | * | ||
5493 | * \since This function is available since SDL 3.2.0. | ||
5494 | * | ||
5495 | * \sa SDL_round | ||
5496 | * \sa SDL_lroundf | ||
5497 | * \sa SDL_floorf | ||
5498 | * \sa SDL_ceilf | ||
5499 | * \sa SDL_truncf | ||
5500 | */ | ||
5501 | extern SDL_DECLSPEC float SDLCALL SDL_roundf(float x); | ||
5502 | |||
5503 | /** | ||
5504 | * Round `x` to the nearest integer representable as a long | ||
5505 | * | ||
5506 | * Rounds `x` to the nearest integer. Values halfway between integers will be | ||
5507 | * rounded away from zero. | ||
5508 | * | ||
5509 | * Domain: `-INF <= x <= INF` | ||
5510 | * | ||
5511 | * Range: `MIN_LONG <= y <= MAX_LONG` | ||
5512 | * | ||
5513 | * This function operates on double-precision floating point values, use | ||
5514 | * SDL_lroundf for single-precision floats. To get the result as a | ||
5515 | * floating-point type, use SDL_round. | ||
5516 | * | ||
5517 | * \param x floating point value. | ||
5518 | * \returns the nearest integer to `x`. | ||
5519 | * | ||
5520 | * \threadsafety It is safe to call this function from any thread. | ||
5521 | * | ||
5522 | * \since This function is available since SDL 3.2.0. | ||
5523 | * | ||
5524 | * \sa SDL_lroundf | ||
5525 | * \sa SDL_round | ||
5526 | * \sa SDL_floor | ||
5527 | * \sa SDL_ceil | ||
5528 | * \sa SDL_trunc | ||
5529 | */ | ||
5530 | extern SDL_DECLSPEC long SDLCALL SDL_lround(double x); | ||
5531 | |||
5532 | /** | ||
5533 | * Round `x` to the nearest integer representable as a long | ||
5534 | * | ||
5535 | * Rounds `x` to the nearest integer. Values halfway between integers will be | ||
5536 | * rounded away from zero. | ||
5537 | * | ||
5538 | * Domain: `-INF <= x <= INF` | ||
5539 | * | ||
5540 | * Range: `MIN_LONG <= y <= MAX_LONG` | ||
5541 | * | ||
5542 | * This function operates on single-precision floating point values, use | ||
5543 | * SDL_lround for double-precision floats. To get the result as a | ||
5544 | * floating-point type, use SDL_roundf. | ||
5545 | * | ||
5546 | * \param x floating point value. | ||
5547 | * \returns the nearest integer to `x`. | ||
5548 | * | ||
5549 | * \threadsafety It is safe to call this function from any thread. | ||
5550 | * | ||
5551 | * \since This function is available since SDL 3.2.0. | ||
5552 | * | ||
5553 | * \sa SDL_lround | ||
5554 | * \sa SDL_roundf | ||
5555 | * \sa SDL_floorf | ||
5556 | * \sa SDL_ceilf | ||
5557 | * \sa SDL_truncf | ||
5558 | */ | ||
5559 | extern SDL_DECLSPEC long SDLCALL SDL_lroundf(float x); | ||
5560 | |||
5561 | /** | ||
5562 | * Scale `x` by an integer power of two. | ||
5563 | * | ||
5564 | * Multiplies `x` by the `n`th power of the floating point radix (always 2). | ||
5565 | * | ||
5566 | * Domain: `-INF <= x <= INF`, `n` integer | ||
5567 | * | ||
5568 | * Range: `-INF <= y <= INF` | ||
5569 | * | ||
5570 | * This function operates on double-precision floating point values, use | ||
5571 | * SDL_scalbnf for single-precision floats. | ||
5572 | * | ||
5573 | * \param x floating point value to be scaled. | ||
5574 | * \param n integer exponent. | ||
5575 | * \returns `x * 2^n`. | ||
5576 | * | ||
5577 | * \threadsafety It is safe to call this function from any thread. | ||
5578 | * | ||
5579 | * \since This function is available since SDL 3.2.0. | ||
5580 | * | ||
5581 | * \sa SDL_scalbnf | ||
5582 | * \sa SDL_pow | ||
5583 | */ | ||
5584 | extern SDL_DECLSPEC double SDLCALL SDL_scalbn(double x, int n); | ||
5585 | |||
5586 | /** | ||
5587 | * Scale `x` by an integer power of two. | ||
5588 | * | ||
5589 | * Multiplies `x` by the `n`th power of the floating point radix (always 2). | ||
5590 | * | ||
5591 | * Domain: `-INF <= x <= INF`, `n` integer | ||
5592 | * | ||
5593 | * Range: `-INF <= y <= INF` | ||
5594 | * | ||
5595 | * This function operates on single-precision floating point values, use | ||
5596 | * SDL_scalbn for double-precision floats. | ||
5597 | * | ||
5598 | * \param x floating point value to be scaled. | ||
5599 | * \param n integer exponent. | ||
5600 | * \returns `x * 2^n`. | ||
5601 | * | ||
5602 | * \threadsafety It is safe to call this function from any thread. | ||
5603 | * | ||
5604 | * \since This function is available since SDL 3.2.0. | ||
5605 | * | ||
5606 | * \sa SDL_scalbn | ||
5607 | * \sa SDL_powf | ||
5608 | */ | ||
5609 | extern SDL_DECLSPEC float SDLCALL SDL_scalbnf(float x, int n); | ||
5610 | |||
5611 | /** | ||
5612 | * Compute the sine of `x`. | ||
5613 | * | ||
5614 | * Domain: `-INF <= x <= INF` | ||
5615 | * | ||
5616 | * Range: `-1 <= y <= 1` | ||
5617 | * | ||
5618 | * This function operates on double-precision floating point values, use | ||
5619 | * SDL_sinf for single-precision floats. | ||
5620 | * | ||
5621 | * This function may use a different approximation across different versions, | ||
5622 | * platforms and configurations. i.e, it can return a different value given | ||
5623 | * the same input on different machines or operating systems, or if SDL is | ||
5624 | * updated. | ||
5625 | * | ||
5626 | * \param x floating point value, in radians. | ||
5627 | * \returns sine of `x`. | ||
5628 | * | ||
5629 | * \threadsafety It is safe to call this function from any thread. | ||
5630 | * | ||
5631 | * \since This function is available since SDL 3.2.0. | ||
5632 | * | ||
5633 | * \sa SDL_sinf | ||
5634 | * \sa SDL_asin | ||
5635 | * \sa SDL_cos | ||
5636 | */ | ||
5637 | extern SDL_DECLSPEC double SDLCALL SDL_sin(double x); | ||
5638 | |||
5639 | /** | ||
5640 | * Compute the sine of `x`. | ||
5641 | * | ||
5642 | * Domain: `-INF <= x <= INF` | ||
5643 | * | ||
5644 | * Range: `-1 <= y <= 1` | ||
5645 | * | ||
5646 | * This function operates on single-precision floating point values, use | ||
5647 | * SDL_sin for double-precision floats. | ||
5648 | * | ||
5649 | * This function may use a different approximation across different versions, | ||
5650 | * platforms and configurations. i.e, it can return a different value given | ||
5651 | * the same input on different machines or operating systems, or if SDL is | ||
5652 | * updated. | ||
5653 | * | ||
5654 | * \param x floating point value, in radians. | ||
5655 | * \returns sine of `x`. | ||
5656 | * | ||
5657 | * \threadsafety It is safe to call this function from any thread. | ||
5658 | * | ||
5659 | * \since This function is available since SDL 3.2.0. | ||
5660 | * | ||
5661 | * \sa SDL_sin | ||
5662 | * \sa SDL_asinf | ||
5663 | * \sa SDL_cosf | ||
5664 | */ | ||
5665 | extern SDL_DECLSPEC float SDLCALL SDL_sinf(float x); | ||
5666 | |||
5667 | /** | ||
5668 | * Compute the square root of `x`. | ||
5669 | * | ||
5670 | * Domain: `0 <= x <= INF` | ||
5671 | * | ||
5672 | * Range: `0 <= y <= INF` | ||
5673 | * | ||
5674 | * This function operates on double-precision floating point values, use | ||
5675 | * SDL_sqrtf for single-precision floats. | ||
5676 | * | ||
5677 | * This function may use a different approximation across different versions, | ||
5678 | * platforms and configurations. i.e, it can return a different value given | ||
5679 | * the same input on different machines or operating systems, or if SDL is | ||
5680 | * updated. | ||
5681 | * | ||
5682 | * \param x floating point value. Must be greater than or equal to 0. | ||
5683 | * \returns square root of `x`. | ||
5684 | * | ||
5685 | * \threadsafety It is safe to call this function from any thread. | ||
5686 | * | ||
5687 | * \since This function is available since SDL 3.2.0. | ||
5688 | * | ||
5689 | * \sa SDL_sqrtf | ||
5690 | */ | ||
5691 | extern SDL_DECLSPEC double SDLCALL SDL_sqrt(double x); | ||
5692 | |||
5693 | /** | ||
5694 | * Compute the square root of `x`. | ||
5695 | * | ||
5696 | * Domain: `0 <= x <= INF` | ||
5697 | * | ||
5698 | * Range: `0 <= y <= INF` | ||
5699 | * | ||
5700 | * This function operates on single-precision floating point values, use | ||
5701 | * SDL_sqrt for double-precision floats. | ||
5702 | * | ||
5703 | * This function may use a different approximation across different versions, | ||
5704 | * platforms and configurations. i.e, it can return a different value given | ||
5705 | * the same input on different machines or operating systems, or if SDL is | ||
5706 | * updated. | ||
5707 | * | ||
5708 | * \param x floating point value. Must be greater than or equal to 0. | ||
5709 | * \returns square root of `x`. | ||
5710 | * | ||
5711 | * \threadsafety It is safe to call this function from any thread. | ||
5712 | * | ||
5713 | * \since This function is available since SDL 3.2.0. | ||
5714 | * | ||
5715 | * \sa SDL_sqrt | ||
5716 | */ | ||
5717 | extern SDL_DECLSPEC float SDLCALL SDL_sqrtf(float x); | ||
5718 | |||
5719 | /** | ||
5720 | * Compute the tangent of `x`. | ||
5721 | * | ||
5722 | * Domain: `-INF <= x <= INF` | ||
5723 | * | ||
5724 | * Range: `-INF <= y <= INF` | ||
5725 | * | ||
5726 | * This function operates on double-precision floating point values, use | ||
5727 | * SDL_tanf for single-precision floats. | ||
5728 | * | ||
5729 | * This function may use a different approximation across different versions, | ||
5730 | * platforms and configurations. i.e, it can return a different value given | ||
5731 | * the same input on different machines or operating systems, or if SDL is | ||
5732 | * updated. | ||
5733 | * | ||
5734 | * \param x floating point value, in radians. | ||
5735 | * \returns tangent of `x`. | ||
5736 | * | ||
5737 | * \threadsafety It is safe to call this function from any thread. | ||
5738 | * | ||
5739 | * \since This function is available since SDL 3.2.0. | ||
5740 | * | ||
5741 | * \sa SDL_tanf | ||
5742 | * \sa SDL_sin | ||
5743 | * \sa SDL_cos | ||
5744 | * \sa SDL_atan | ||
5745 | * \sa SDL_atan2 | ||
5746 | */ | ||
5747 | extern SDL_DECLSPEC double SDLCALL SDL_tan(double x); | ||
5748 | |||
5749 | /** | ||
5750 | * Compute the tangent of `x`. | ||
5751 | * | ||
5752 | * Domain: `-INF <= x <= INF` | ||
5753 | * | ||
5754 | * Range: `-INF <= y <= INF` | ||
5755 | * | ||
5756 | * This function operates on single-precision floating point values, use | ||
5757 | * SDL_tan for double-precision floats. | ||
5758 | * | ||
5759 | * This function may use a different approximation across different versions, | ||
5760 | * platforms and configurations. i.e, it can return a different value given | ||
5761 | * the same input on different machines or operating systems, or if SDL is | ||
5762 | * updated. | ||
5763 | * | ||
5764 | * \param x floating point value, in radians. | ||
5765 | * \returns tangent of `x`. | ||
5766 | * | ||
5767 | * \threadsafety It is safe to call this function from any thread. | ||
5768 | * | ||
5769 | * \since This function is available since SDL 3.2.0. | ||
5770 | * | ||
5771 | * \sa SDL_tan | ||
5772 | * \sa SDL_sinf | ||
5773 | * \sa SDL_cosf | ||
5774 | * \sa SDL_atanf | ||
5775 | * \sa SDL_atan2f | ||
5776 | */ | ||
5777 | extern SDL_DECLSPEC float SDLCALL SDL_tanf(float x); | ||
5778 | |||
5779 | /** | ||
5780 | * An opaque handle representing string encoding conversion state. | ||
5781 | * | ||
5782 | * \since This datatype is available since SDL 3.2.0. | ||
5783 | * | ||
5784 | * \sa SDL_iconv_open | ||
5785 | */ | ||
5786 | typedef struct SDL_iconv_data_t *SDL_iconv_t; | ||
5787 | |||
5788 | /** | ||
5789 | * This function allocates a context for the specified character set | ||
5790 | * conversion. | ||
5791 | * | ||
5792 | * \param tocode The target character encoding, must not be NULL. | ||
5793 | * \param fromcode The source character encoding, must not be NULL. | ||
5794 | * \returns a handle that must be freed with SDL_iconv_close, or | ||
5795 | * SDL_ICONV_ERROR on failure. | ||
5796 | * | ||
5797 | * \since This function is available since SDL 3.2.0. | ||
5798 | * | ||
5799 | * \sa SDL_iconv | ||
5800 | * \sa SDL_iconv_close | ||
5801 | * \sa SDL_iconv_string | ||
5802 | */ | ||
5803 | extern SDL_DECLSPEC SDL_iconv_t SDLCALL SDL_iconv_open(const char *tocode, | ||
5804 | const char *fromcode); | ||
5805 | |||
5806 | /** | ||
5807 | * This function frees a context used for character set conversion. | ||
5808 | * | ||
5809 | * \param cd The character set conversion handle. | ||
5810 | * \returns 0 on success, or -1 on failure. | ||
5811 | * | ||
5812 | * \since This function is available since SDL 3.2.0. | ||
5813 | * | ||
5814 | * \sa SDL_iconv | ||
5815 | * \sa SDL_iconv_open | ||
5816 | * \sa SDL_iconv_string | ||
5817 | */ | ||
5818 | extern SDL_DECLSPEC int SDLCALL SDL_iconv_close(SDL_iconv_t cd); | ||
5819 | |||
5820 | /** | ||
5821 | * This function converts text between encodings, reading from and writing to | ||
5822 | * a buffer. | ||
5823 | * | ||
5824 | * It returns the number of succesful conversions on success. On error, | ||
5825 | * SDL_ICONV_E2BIG is returned when the output buffer is too small, or | ||
5826 | * SDL_ICONV_EILSEQ is returned when an invalid input sequence is encountered, | ||
5827 | * or SDL_ICONV_EINVAL is returned when an incomplete input sequence is | ||
5828 | * encountered. | ||
5829 | * | ||
5830 | * On exit: | ||
5831 | * | ||
5832 | * - inbuf will point to the beginning of the next multibyte sequence. On | ||
5833 | * error, this is the location of the problematic input sequence. On | ||
5834 | * success, this is the end of the input sequence. | ||
5835 | * - inbytesleft will be set to the number of bytes left to convert, which | ||
5836 | * will be 0 on success. | ||
5837 | * - outbuf will point to the location where to store the next output byte. | ||
5838 | * - outbytesleft will be set to the number of bytes left in the output | ||
5839 | * buffer. | ||
5840 | * | ||
5841 | * \param cd The character set conversion context, created in | ||
5842 | * SDL_iconv_open(). | ||
5843 | * \param inbuf Address of variable that points to the first character of the | ||
5844 | * input sequence. | ||
5845 | * \param inbytesleft The number of bytes in the input buffer. | ||
5846 | * \param outbuf Address of variable that points to the output buffer. | ||
5847 | * \param outbytesleft The number of bytes in the output buffer. | ||
5848 | * \returns the number of conversions on success, or a negative error code. | ||
5849 | * | ||
5850 | * \since This function is available since SDL 3.2.0. | ||
5851 | * | ||
5852 | * \sa SDL_iconv_open | ||
5853 | * \sa SDL_iconv_close | ||
5854 | * \sa SDL_iconv_string | ||
5855 | */ | ||
5856 | extern SDL_DECLSPEC size_t SDLCALL SDL_iconv(SDL_iconv_t cd, const char **inbuf, | ||
5857 | size_t *inbytesleft, char **outbuf, | ||
5858 | size_t *outbytesleft); | ||
5859 | |||
5860 | #define SDL_ICONV_ERROR (size_t)-1 /**< Generic error. Check SDL_GetError()? */ | ||
5861 | #define SDL_ICONV_E2BIG (size_t)-2 /**< Output buffer was too small. */ | ||
5862 | #define SDL_ICONV_EILSEQ (size_t)-3 /**< Invalid input sequence was encountered. */ | ||
5863 | #define SDL_ICONV_EINVAL (size_t)-4 /**< Incomplete input sequence was encountered. */ | ||
5864 | |||
5865 | |||
5866 | /** | ||
5867 | * Helper function to convert a string's encoding in one call. | ||
5868 | * | ||
5869 | * This function converts a buffer or string between encodings in one pass. | ||
5870 | * | ||
5871 | * The string does not need to be NULL-terminated; this function operates on | ||
5872 | * the number of bytes specified in `inbytesleft` whether there is a NULL | ||
5873 | * character anywhere in the buffer. | ||
5874 | * | ||
5875 | * The returned string is owned by the caller, and should be passed to | ||
5876 | * SDL_free when no longer needed. | ||
5877 | * | ||
5878 | * \param tocode the character encoding of the output string. Examples are | ||
5879 | * "UTF-8", "UCS-4", etc. | ||
5880 | * \param fromcode the character encoding of data in `inbuf`. | ||
5881 | * \param inbuf the string to convert to a different encoding. | ||
5882 | * \param inbytesleft the size of the input string _in bytes_. | ||
5883 | * \returns a new string, converted to the new encoding, or NULL on error. | ||
5884 | * | ||
5885 | * \since This function is available since SDL 3.2.0. | ||
5886 | * | ||
5887 | * \sa SDL_iconv_open | ||
5888 | * \sa SDL_iconv_close | ||
5889 | * \sa SDL_iconv | ||
5890 | */ | ||
5891 | extern SDL_DECLSPEC char * SDLCALL SDL_iconv_string(const char *tocode, | ||
5892 | const char *fromcode, | ||
5893 | const char *inbuf, | ||
5894 | size_t inbytesleft); | ||
5895 | |||
5896 | /* Some helper macros for common SDL_iconv_string cases... */ | ||
5897 | |||
5898 | /** | ||
5899 | * Convert a UTF-8 string to the current locale's character encoding. | ||
5900 | * | ||
5901 | * This is a helper macro that might be more clear than calling | ||
5902 | * SDL_iconv_string directly. However, it double-evaluates its parameter, so | ||
5903 | * do not use an expression with side-effects here. | ||
5904 | * | ||
5905 | * \param S the string to convert. | ||
5906 | * \returns a new string, converted to the new encoding, or NULL on error. | ||
5907 | * | ||
5908 | * \since This macro is available since SDL 3.2.0. | ||
5909 | */ | ||
5910 | #define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1) | ||
5911 | |||
5912 | /** | ||
5913 | * Convert a UTF-8 string to UCS-2. | ||
5914 | * | ||
5915 | * This is a helper macro that might be more clear than calling | ||
5916 | * SDL_iconv_string directly. However, it double-evaluates its parameter, so | ||
5917 | * do not use an expression with side-effects here. | ||
5918 | * | ||
5919 | * \param S the string to convert. | ||
5920 | * \returns a new string, converted to the new encoding, or NULL on error. | ||
5921 | * | ||
5922 | * \since This macro is available since SDL 3.2.0. | ||
5923 | */ | ||
5924 | #define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2", "UTF-8", S, SDL_strlen(S)+1) | ||
5925 | |||
5926 | /** | ||
5927 | * Convert a UTF-8 string to UCS-4. | ||
5928 | * | ||
5929 | * This is a helper macro that might be more clear than calling | ||
5930 | * SDL_iconv_string directly. However, it double-evaluates its parameter, so | ||
5931 | * do not use an expression with side-effects here. | ||
5932 | * | ||
5933 | * \param S the string to convert. | ||
5934 | * \returns a new string, converted to the new encoding, or NULL on error. | ||
5935 | * | ||
5936 | * \since This macro is available since SDL 3.2.0. | ||
5937 | */ | ||
5938 | #define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4", "UTF-8", S, SDL_strlen(S)+1) | ||
5939 | |||
5940 | /** | ||
5941 | * Convert a wchar_t string to UTF-8. | ||
5942 | * | ||
5943 | * This is a helper macro that might be more clear than calling | ||
5944 | * SDL_iconv_string directly. However, it double-evaluates its parameter, so | ||
5945 | * do not use an expression with side-effects here. | ||
5946 | * | ||
5947 | * \param S the string to convert. | ||
5948 | * \returns a new string, converted to the new encoding, or NULL on error. | ||
5949 | * | ||
5950 | * \since This macro is available since SDL 3.2.0. | ||
5951 | */ | ||
5952 | #define SDL_iconv_wchar_utf8(S) SDL_iconv_string("UTF-8", "WCHAR_T", (char *)S, (SDL_wcslen(S)+1)*sizeof(wchar_t)) | ||
5953 | |||
5954 | |||
5955 | /* force builds using Clang's static analysis tools to use literal C runtime | ||
5956 | here, since there are possibly tests that are ineffective otherwise. */ | ||
5957 | #if defined(__clang_analyzer__) && !defined(SDL_DISABLE_ANALYZE_MACROS) | ||
5958 | |||
5959 | /* The analyzer knows about strlcpy even when the system doesn't provide it */ | ||
5960 | #if !defined(HAVE_STRLCPY) && !defined(strlcpy) | ||
5961 | size_t strlcpy(char *dst, const char *src, size_t size); | ||
5962 | #endif | ||
5963 | |||
5964 | /* The analyzer knows about strlcat even when the system doesn't provide it */ | ||
5965 | #if !defined(HAVE_STRLCAT) && !defined(strlcat) | ||
5966 | size_t strlcat(char *dst, const char *src, size_t size); | ||
5967 | #endif | ||
5968 | |||
5969 | #if !defined(HAVE_WCSLCPY) && !defined(wcslcpy) | ||
5970 | size_t wcslcpy(wchar_t *dst, const wchar_t *src, size_t size); | ||
5971 | #endif | ||
5972 | |||
5973 | #if !defined(HAVE_WCSLCAT) && !defined(wcslcat) | ||
5974 | size_t wcslcat(wchar_t *dst, const wchar_t *src, size_t size); | ||
5975 | #endif | ||
5976 | |||
5977 | #ifndef _WIN32 | ||
5978 | /* strdup is not ANSI but POSIX, and its prototype might be hidden... */ | ||
5979 | /* not for windows: might conflict with string.h where strdup may have | ||
5980 | * dllimport attribute: https://github.com/libsdl-org/SDL/issues/12948 */ | ||
5981 | char *strdup(const char *str); | ||
5982 | #endif | ||
5983 | |||
5984 | /* Starting LLVM 16, the analyser errors out if these functions do not have | ||
5985 | their prototype defined (clang-diagnostic-implicit-function-declaration) */ | ||
5986 | #include <stdio.h> | ||
5987 | #include <stdlib.h> | ||
5988 | |||
5989 | #define SDL_malloc malloc | ||
5990 | #define SDL_calloc calloc | ||
5991 | #define SDL_realloc realloc | ||
5992 | #define SDL_free free | ||
5993 | #ifndef SDL_memcpy | ||
5994 | #define SDL_memcpy memcpy | ||
5995 | #endif | ||
5996 | #ifndef SDL_memmove | ||
5997 | #define SDL_memmove memmove | ||
5998 | #endif | ||
5999 | #ifndef SDL_memset | ||
6000 | #define SDL_memset memset | ||
6001 | #endif | ||
6002 | #define SDL_memcmp memcmp | ||
6003 | #define SDL_strlcpy strlcpy | ||
6004 | #define SDL_strlcat strlcat | ||
6005 | #define SDL_strlen strlen | ||
6006 | #define SDL_wcslen wcslen | ||
6007 | #define SDL_wcslcpy wcslcpy | ||
6008 | #define SDL_wcslcat wcslcat | ||
6009 | #define SDL_strdup strdup | ||
6010 | #define SDL_wcsdup wcsdup | ||
6011 | #define SDL_strchr strchr | ||
6012 | #define SDL_strrchr strrchr | ||
6013 | #define SDL_strstr strstr | ||
6014 | #define SDL_wcsstr wcsstr | ||
6015 | #define SDL_strtok_r strtok_r | ||
6016 | #define SDL_strcmp strcmp | ||
6017 | #define SDL_wcscmp wcscmp | ||
6018 | #define SDL_strncmp strncmp | ||
6019 | #define SDL_wcsncmp wcsncmp | ||
6020 | #define SDL_strcasecmp strcasecmp | ||
6021 | #define SDL_strncasecmp strncasecmp | ||
6022 | #define SDL_strpbrk strpbrk | ||
6023 | #define SDL_sscanf sscanf | ||
6024 | #define SDL_vsscanf vsscanf | ||
6025 | #define SDL_snprintf snprintf | ||
6026 | #define SDL_vsnprintf vsnprintf | ||
6027 | #endif | ||
6028 | |||
6029 | /** | ||
6030 | * Multiply two integers, checking for overflow. | ||
6031 | * | ||
6032 | * If `a * b` would overflow, return false. | ||
6033 | * | ||
6034 | * Otherwise store `a * b` via ret and return true. | ||
6035 | * | ||
6036 | * \param a the multiplicand. | ||
6037 | * \param b the multiplier. | ||
6038 | * \param ret on non-overflow output, stores the multiplication result, may | ||
6039 | * not be NULL. | ||
6040 | * \returns false on overflow, true if result is multiplied without overflow. | ||
6041 | * | ||
6042 | * \threadsafety It is safe to call this function from any thread. | ||
6043 | * | ||
6044 | * \since This function is available since SDL 3.2.0. | ||
6045 | */ | ||
6046 | SDL_FORCE_INLINE bool SDL_size_mul_check_overflow(size_t a, size_t b, size_t *ret) | ||
6047 | { | ||
6048 | if (a != 0 && b > SDL_SIZE_MAX / a) { | ||
6049 | return false; | ||
6050 | } | ||
6051 | *ret = a * b; | ||
6052 | return true; | ||
6053 | } | ||
6054 | |||
6055 | #ifndef SDL_WIKI_DOCUMENTATION_SECTION | ||
6056 | #if SDL_HAS_BUILTIN(__builtin_mul_overflow) | ||
6057 | /* This needs to be wrapped in an inline rather than being a direct #define, | ||
6058 | * because __builtin_mul_overflow() is type-generic, but we want to be | ||
6059 | * consistent about interpreting a and b as size_t. */ | ||
6060 | SDL_FORCE_INLINE bool SDL_size_mul_check_overflow_builtin(size_t a, size_t b, size_t *ret) | ||
6061 | { | ||
6062 | return (__builtin_mul_overflow(a, b, ret) == 0); | ||
6063 | } | ||
6064 | #define SDL_size_mul_check_overflow(a, b, ret) SDL_size_mul_check_overflow_builtin(a, b, ret) | ||
6065 | #endif | ||
6066 | #endif | ||
6067 | |||
6068 | /** | ||
6069 | * Add two integers, checking for overflow. | ||
6070 | * | ||
6071 | * If `a + b` would overflow, return false. | ||
6072 | * | ||
6073 | * Otherwise store `a + b` via ret and return true. | ||
6074 | * | ||
6075 | * \param a the first addend. | ||
6076 | * \param b the second addend. | ||
6077 | * \param ret on non-overflow output, stores the addition result, may not be | ||
6078 | * NULL. | ||
6079 | * \returns false on overflow, true if result is added without overflow. | ||
6080 | * | ||
6081 | * \threadsafety It is safe to call this function from any thread. | ||
6082 | * | ||
6083 | * \since This function is available since SDL 3.2.0. | ||
6084 | */ | ||
6085 | SDL_FORCE_INLINE bool SDL_size_add_check_overflow(size_t a, size_t b, size_t *ret) | ||
6086 | { | ||
6087 | if (b > SDL_SIZE_MAX - a) { | ||
6088 | return false; | ||
6089 | } | ||
6090 | *ret = a + b; | ||
6091 | return true; | ||
6092 | } | ||
6093 | |||
6094 | #ifndef SDL_WIKI_DOCUMENTATION_SECTION | ||
6095 | #if SDL_HAS_BUILTIN(__builtin_add_overflow) | ||
6096 | /* This needs to be wrapped in an inline rather than being a direct #define, | ||
6097 | * the same as the call to __builtin_mul_overflow() above. */ | ||
6098 | SDL_FORCE_INLINE bool SDL_size_add_check_overflow_builtin(size_t a, size_t b, size_t *ret) | ||
6099 | { | ||
6100 | return (__builtin_add_overflow(a, b, ret) == 0); | ||
6101 | } | ||
6102 | #define SDL_size_add_check_overflow(a, b, ret) SDL_size_add_check_overflow_builtin(a, b, ret) | ||
6103 | #endif | ||
6104 | #endif | ||
6105 | |||
6106 | /* This is a generic function pointer which should be cast to the type you expect */ | ||
6107 | #ifdef SDL_WIKI_DOCUMENTATION_SECTION | ||
6108 | |||
6109 | /** | ||
6110 | * A generic function pointer. | ||
6111 | * | ||
6112 | * In theory, generic function pointers should use this, instead of `void *`, | ||
6113 | * since some platforms could treat code addresses differently than data | ||
6114 | * addresses. Although in current times no popular platforms make this | ||
6115 | * distinction, it is more correct and portable to use the correct type for a | ||
6116 | * generic pointer. | ||
6117 | * | ||
6118 | * If for some reason you need to force this typedef to be an actual `void *`, | ||
6119 | * perhaps to work around a compiler or existing code, you can define | ||
6120 | * `SDL_FUNCTION_POINTER_IS_VOID_POINTER` before including any SDL headers. | ||
6121 | * | ||
6122 | * \since This datatype is available since SDL 3.2.0. | ||
6123 | */ | ||
6124 | typedef void (*SDL_FunctionPointer)(void); | ||
6125 | #elif defined(SDL_FUNCTION_POINTER_IS_VOID_POINTER) | ||
6126 | typedef void *SDL_FunctionPointer; | ||
6127 | #else | ||
6128 | typedef void (*SDL_FunctionPointer)(void); | ||
6129 | #endif | ||
6130 | |||
6131 | /* Ends C function definitions when using C++ */ | ||
6132 | #ifdef __cplusplus | ||
6133 | } | ||
6134 | #endif | ||
6135 | #include <SDL3/SDL_close_code.h> | ||
6136 | |||
6137 | #endif /* SDL_stdinc_h_ */ | ||