mirror of
https://github.com/libsdl-org/SDL.git
synced 2025-05-15 01:08:26 +00:00
e23257307e
This declares that any `const char *` returned from SDL is owned by SDL, and promises to be valid _at least_ until the next time the event queue runs, or SDL_Quit() is called, even if the thing that owns the string gets destroyed or changed before then. This is noted in the headers as "the SDL_GetStringRule", so this will both be greppable to find a detailed explaination in docs/README-strings.md and wikiheaders will automatically turn it into a link we can point at the appropriate documentation. Fixes #9902. (and several FIXMEs, both known and yet-undocumented.)
144 lines
4.4 KiB
C
144 lines
4.4 KiB
C
/*
|
|
Simple DirectMedia Layer
|
|
Copyright (C) 1997-2024 Sam Lantinga <slouken@libsdl.org>
|
|
|
|
This software is provided 'as-is', without any express or implied
|
|
warranty. In no event will the authors be held liable for any damages
|
|
arising from the use of this software.
|
|
|
|
Permission is granted to anyone to use this software for any purpose,
|
|
including commercial applications, and to alter it and redistribute it
|
|
freely, subject to the following restrictions:
|
|
|
|
1. The origin of this software must not be misrepresented; you must not
|
|
claim that you wrote the original software. If you use this software
|
|
in a product, an acknowledgment in the product documentation would be
|
|
appreciated but is not required.
|
|
2. Altered source versions must be plainly marked as such, and must not be
|
|
misrepresented as being the original software.
|
|
3. This notice may not be removed or altered from any source distribution.
|
|
*/
|
|
|
|
/**
|
|
* # CategoryError
|
|
*
|
|
* Simple error message routines for SDL.
|
|
*/
|
|
|
|
#ifndef SDL_error_h_
|
|
#define SDL_error_h_
|
|
|
|
#include <SDL3/SDL_stdinc.h>
|
|
|
|
#include <SDL3/SDL_begin_code.h>
|
|
/* Set up for C function definitions, even when using C++ */
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Public functions */
|
|
|
|
|
|
/**
|
|
* Set the SDL error message for the current thread.
|
|
*
|
|
* Calling this function will replace any previous error message that was set.
|
|
*
|
|
* This function always returns -1, since SDL frequently uses -1 to signify an
|
|
* failing result, leading to this idiom:
|
|
*
|
|
* ```c
|
|
* if (error_code) {
|
|
* return SDL_SetError("This operation has failed: %d", error_code);
|
|
* }
|
|
* ```
|
|
*
|
|
* \param fmt a printf()-style message format string
|
|
* \param ... additional parameters matching % tokens in the `fmt` string, if
|
|
* any
|
|
* \returns always -1.
|
|
*
|
|
* \since This function is available since SDL 3.0.0.
|
|
*
|
|
* \sa SDL_ClearError
|
|
* \sa SDL_GetError
|
|
*/
|
|
extern SDL_DECLSPEC int SDLCALL SDL_SetError(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);
|
|
|
|
/**
|
|
* Set an error indicating that memory allocation failed.
|
|
*
|
|
* This function does not do any memory allocation.
|
|
*
|
|
* \returns -1
|
|
*
|
|
* \since This function is available since SDL 3.0.0.
|
|
*/
|
|
extern SDL_DECLSPEC int SDLCALL SDL_OutOfMemory(void);
|
|
|
|
/**
|
|
* Retrieve a message about the last error that occurred on the current
|
|
* thread.
|
|
*
|
|
* It is possible for multiple errors to occur before calling SDL_GetError().
|
|
* Only the last error is returned.
|
|
*
|
|
* The message is only applicable when an SDL function has signaled an error.
|
|
* You must check the return values of SDL function calls to determine when to
|
|
* appropriately call SDL_GetError(). You should *not* use the results of
|
|
* SDL_GetError() to decide if an error has occurred! Sometimes SDL will set
|
|
* an error string even when reporting success.
|
|
*
|
|
* SDL will *not* clear the error string for successful API calls. You *must*
|
|
* check return values for failure cases before you can assume the error
|
|
* string applies.
|
|
*
|
|
* Error strings are set per-thread, so an error set in a different thread
|
|
* will not interfere with the current thread's operation.
|
|
*
|
|
* The returned string does **NOT** follow the SDL_GetStringRule! The
|
|
* pointer is valid until the current thread's error string is changed, so
|
|
* the caller should make a copy if the string is to be used after calling
|
|
* into SDL again.
|
|
*
|
|
* \returns a message with information about the specific error that occurred,
|
|
* or an empty string if there hasn't been an error message set since
|
|
* the last call to SDL_ClearError().
|
|
*
|
|
* \since This function is available since SDL 3.0.0.
|
|
*
|
|
* \sa SDL_ClearError
|
|
* \sa SDL_SetError
|
|
*/
|
|
extern SDL_DECLSPEC const char *SDLCALL SDL_GetError(void);
|
|
|
|
/**
|
|
* Clear any previous error message for this thread.
|
|
*
|
|
* \returns 0
|
|
*
|
|
* \since This function is available since SDL 3.0.0.
|
|
*
|
|
* \sa SDL_GetError
|
|
* \sa SDL_SetError
|
|
*/
|
|
extern SDL_DECLSPEC int SDLCALL SDL_ClearError(void);
|
|
|
|
/**
|
|
* \name Internal error functions
|
|
*
|
|
* \internal
|
|
* Private error reporting function - used internally.
|
|
*/
|
|
/* @{ */
|
|
#define SDL_Unsupported() SDL_SetError("That operation is not supported")
|
|
#define SDL_InvalidParamError(param) SDL_SetError("Parameter '%s' is invalid", (param))
|
|
/* @} *//* Internal error functions */
|
|
|
|
/* Ends C function definitions when using C++ */
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#include <SDL3/SDL_close_code.h>
|
|
|
|
#endif /* SDL_error_h_ */
|