1 /*
2   Simple DirectMedia Layer
3   Copyright (C) 1997-2020 Sam Lantinga <slouken@libsdl.org>
4 
5   This software is provided 'as-is', without any express or implied
6   warranty.  In no event will the authors be held liable for any damages
7   arising from the use of this software.
8 
9   Permission is granted to anyone to use this software for any purpose,
10   including commercial applications, and to alter it and redistribute it
11   freely, subject to the following restrictions:
12 
13   1. The origin of this software must not be misrepresented; you must not
14      claim that you wrote the original software. If you use this software
15      in a product, an acknowledgment in the product documentation would be
16      appreciated but is not required.
17   2. Altered source versions must be plainly marked as such, and must not be
18      misrepresented as being the original software.
19   3. This notice may not be removed or altered from any source distribution.
20 */
21 
22 /**
23  *  \file SDL_error.h
24  *
25  *  Simple error message routines for SDL.
26  */
27 
28 #ifndef SDL_error_h_
29 #define SDL_error_h_
30 
31 #include "SDL_stdinc.h"
32 
33 #include "begin_code.h"
34 /* Set up for C function definitions, even when using C++ */
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38 
39 /* Public functions */
40 
41 
42 /**
43  *  \brief Set the error message for the current thread
44  *
45  *  \return -1, there is no error handling for this function
46  */
47 extern DECLSPEC int SDLCALL SDL_SetError(SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(1);
48 
49 /**
50  *  \brief Get the last error message that was set
51  *
52  * SDL API functions may set error messages and then succeed, so you should
53  * only use the error value if a function fails.
54  *
55  * This returns a pointer to a static buffer for convenience and should not
56  * be called by multiple threads simultaneously.
57  *
58  *  \return a pointer to the last error message that was set
59  */
60 extern DECLSPEC const char *SDLCALL SDL_GetError(void);
61 
62 /**
63  *  \brief Get the last error message that was set for the current thread
64  *
65  * SDL API functions may set error messages and then succeed, so you should
66  * only use the error value if a function fails.
67  *
68  *  \param errstr A buffer to fill with the last error message that was set
69  *                for the current thread
70  *  \param maxlen The size of the buffer pointed to by the errstr parameter
71  *
72  *  \return errstr
73  */
74 extern DECLSPEC char * SDLCALL SDL_GetErrorMsg(char *errstr, int maxlen);
75 
76 /**
77  *  \brief Clear the error message for the current thread
78  */
79 extern DECLSPEC void SDLCALL SDL_ClearError(void);
80 
81 /**
82  *  \name Internal error functions
83  *
84  *  \internal
85  *  Private error reporting function - used internally.
86  */
87 /* @{ */
88 #define SDL_OutOfMemory()   SDL_Error(SDL_ENOMEM)
89 #define SDL_Unsupported()   SDL_Error(SDL_UNSUPPORTED)
90 #define SDL_InvalidParamError(param)    SDL_SetError("Parameter '%s' is invalid", (param))
91 typedef enum
92 {
93     SDL_ENOMEM,
94     SDL_EFREAD,
95     SDL_EFWRITE,
96     SDL_EFSEEK,
97     SDL_UNSUPPORTED,
98     SDL_LASTERROR
99 } SDL_errorcode;
100 /* SDL_Error() unconditionally returns -1. */
101 extern DECLSPEC int SDLCALL SDL_Error(SDL_errorcode code);
102 /* @} *//* Internal error functions */
103 
104 /* Ends C function definitions when using C++ */
105 #ifdef __cplusplus
106 }
107 #endif
108 #include "close_code.h"
109 
110 #endif /* SDL_error_h_ */
111 
112 /* vi: set ts=4 sw=4 expandtab: */
113