Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | #ifndef Py_ERRORS_H |
2 | #define Py_ERRORS_H | |
3 | #ifdef __cplusplus | |
4 | extern "C" { | |
5 | #endif | |
6 | ||
7 | ||
8 | /* Error handling definitions */ | |
9 | ||
10 | PyAPI_FUNC(void) PyErr_SetNone(PyObject *); | |
11 | PyAPI_FUNC(void) PyErr_SetObject(PyObject *, PyObject *); | |
12 | PyAPI_FUNC(void) PyErr_SetString(PyObject *, const char *); | |
13 | PyAPI_FUNC(PyObject *) PyErr_Occurred(void); | |
14 | PyAPI_FUNC(void) PyErr_Clear(void); | |
15 | PyAPI_FUNC(void) PyErr_Fetch(PyObject **, PyObject **, PyObject **); | |
16 | PyAPI_FUNC(void) PyErr_Restore(PyObject *, PyObject *, PyObject *); | |
17 | ||
18 | /* Error testing and normalization */ | |
19 | PyAPI_FUNC(int) PyErr_GivenExceptionMatches(PyObject *, PyObject *); | |
20 | PyAPI_FUNC(int) PyErr_ExceptionMatches(PyObject *); | |
21 | PyAPI_FUNC(void) PyErr_NormalizeException(PyObject**, PyObject**, PyObject**); | |
22 | ||
23 | ||
24 | /* Predefined exceptions */ | |
25 | ||
26 | PyAPI_DATA(PyObject *) PyExc_Exception; | |
27 | PyAPI_DATA(PyObject *) PyExc_StopIteration; | |
28 | PyAPI_DATA(PyObject *) PyExc_StandardError; | |
29 | PyAPI_DATA(PyObject *) PyExc_ArithmeticError; | |
30 | PyAPI_DATA(PyObject *) PyExc_LookupError; | |
31 | ||
32 | PyAPI_DATA(PyObject *) PyExc_AssertionError; | |
33 | PyAPI_DATA(PyObject *) PyExc_AttributeError; | |
34 | PyAPI_DATA(PyObject *) PyExc_EOFError; | |
35 | PyAPI_DATA(PyObject *) PyExc_FloatingPointError; | |
36 | PyAPI_DATA(PyObject *) PyExc_EnvironmentError; | |
37 | PyAPI_DATA(PyObject *) PyExc_IOError; | |
38 | PyAPI_DATA(PyObject *) PyExc_OSError; | |
39 | PyAPI_DATA(PyObject *) PyExc_ImportError; | |
40 | PyAPI_DATA(PyObject *) PyExc_IndexError; | |
41 | PyAPI_DATA(PyObject *) PyExc_KeyError; | |
42 | PyAPI_DATA(PyObject *) PyExc_KeyboardInterrupt; | |
43 | PyAPI_DATA(PyObject *) PyExc_MemoryError; | |
44 | PyAPI_DATA(PyObject *) PyExc_NameError; | |
45 | PyAPI_DATA(PyObject *) PyExc_OverflowError; | |
46 | PyAPI_DATA(PyObject *) PyExc_RuntimeError; | |
47 | PyAPI_DATA(PyObject *) PyExc_NotImplementedError; | |
48 | PyAPI_DATA(PyObject *) PyExc_SyntaxError; | |
49 | PyAPI_DATA(PyObject *) PyExc_IndentationError; | |
50 | PyAPI_DATA(PyObject *) PyExc_TabError; | |
51 | PyAPI_DATA(PyObject *) PyExc_ReferenceError; | |
52 | PyAPI_DATA(PyObject *) PyExc_SystemError; | |
53 | PyAPI_DATA(PyObject *) PyExc_SystemExit; | |
54 | PyAPI_DATA(PyObject *) PyExc_TypeError; | |
55 | PyAPI_DATA(PyObject *) PyExc_UnboundLocalError; | |
56 | PyAPI_DATA(PyObject *) PyExc_UnicodeError; | |
57 | PyAPI_DATA(PyObject *) PyExc_UnicodeEncodeError; | |
58 | PyAPI_DATA(PyObject *) PyExc_UnicodeDecodeError; | |
59 | PyAPI_DATA(PyObject *) PyExc_UnicodeTranslateError; | |
60 | PyAPI_DATA(PyObject *) PyExc_ValueError; | |
61 | PyAPI_DATA(PyObject *) PyExc_ZeroDivisionError; | |
62 | #ifdef MS_WINDOWS | |
63 | PyAPI_DATA(PyObject *) PyExc_WindowsError; | |
64 | #endif | |
65 | #ifdef __VMS | |
66 | PyAPI_DATA(PyObject *) PyExc_VMSError; | |
67 | #endif | |
68 | ||
69 | PyAPI_DATA(PyObject *) PyExc_MemoryErrorInst; | |
70 | ||
71 | /* Predefined warning categories */ | |
72 | PyAPI_DATA(PyObject *) PyExc_Warning; | |
73 | PyAPI_DATA(PyObject *) PyExc_UserWarning; | |
74 | PyAPI_DATA(PyObject *) PyExc_DeprecationWarning; | |
75 | PyAPI_DATA(PyObject *) PyExc_PendingDeprecationWarning; | |
76 | PyAPI_DATA(PyObject *) PyExc_SyntaxWarning; | |
77 | /* PyExc_OverflowWarning will go away for Python 2.5 */ | |
78 | PyAPI_DATA(PyObject *) PyExc_OverflowWarning; | |
79 | PyAPI_DATA(PyObject *) PyExc_RuntimeWarning; | |
80 | PyAPI_DATA(PyObject *) PyExc_FutureWarning; | |
81 | ||
82 | ||
83 | /* Convenience functions */ | |
84 | ||
85 | PyAPI_FUNC(int) PyErr_BadArgument(void); | |
86 | PyAPI_FUNC(PyObject *) PyErr_NoMemory(void); | |
87 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrno(PyObject *); | |
88 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilenameObject( | |
89 | PyObject *, PyObject *); | |
90 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilename(PyObject *, char *); | |
91 | #ifdef Py_WIN_WIDE_FILENAMES | |
92 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithUnicodeFilename( | |
93 | PyObject *, Py_UNICODE *); | |
94 | #endif /* Py_WIN_WIDE_FILENAMES */ | |
95 | ||
96 | PyAPI_FUNC(PyObject *) PyErr_Format(PyObject *, const char *, ...) | |
97 | Py_GCC_ATTRIBUTE((format(printf, 2, 3))); | |
98 | ||
99 | #ifdef MS_WINDOWS | |
100 | PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithFilenameObject( | |
101 | int, const char *); | |
102 | PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithFilename( | |
103 | int, const char *); | |
104 | #ifdef Py_WIN_WIDE_FILENAMES | |
105 | PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithUnicodeFilename( | |
106 | int, const Py_UNICODE *); | |
107 | #endif /* Py_WIN_WIDE_FILENAMES */ | |
108 | PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErr(int); | |
109 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilenameObject( | |
110 | PyObject *,int, PyObject *); | |
111 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilename( | |
112 | PyObject *,int, const char *); | |
113 | #ifdef Py_WIN_WIDE_FILENAMES | |
114 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithUnicodeFilename( | |
115 | PyObject *,int, const Py_UNICODE *); | |
116 | #endif /* Py_WIN_WIDE_FILENAMES */ | |
117 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErr(PyObject *, int); | |
118 | #endif /* MS_WINDOWS */ | |
119 | ||
120 | /* Export the old function so that the existing API remains available: */ | |
121 | PyAPI_FUNC(void) PyErr_BadInternalCall(void); | |
122 | PyAPI_FUNC(void) _PyErr_BadInternalCall(char *filename, int lineno); | |
123 | /* Mask the old API with a call to the new API for code compiled under | |
124 | Python 2.0: */ | |
125 | #define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__) | |
126 | ||
127 | /* Function to create a new exception */ | |
128 | PyAPI_FUNC(PyObject *) PyErr_NewException(char *name, PyObject *base, | |
129 | PyObject *dict); | |
130 | PyAPI_FUNC(void) PyErr_WriteUnraisable(PyObject *); | |
131 | ||
132 | /* Issue a warning or exception */ | |
133 | PyAPI_FUNC(int) PyErr_Warn(PyObject *, char *); | |
134 | PyAPI_FUNC(int) PyErr_WarnExplicit(PyObject *, const char *, | |
135 | const char *, int, | |
136 | const char *, PyObject *); | |
137 | ||
138 | /* In sigcheck.c or signalmodule.c */ | |
139 | PyAPI_FUNC(int) PyErr_CheckSignals(void); | |
140 | PyAPI_FUNC(void) PyErr_SetInterrupt(void); | |
141 | ||
142 | /* Support for adding program text to SyntaxErrors */ | |
143 | PyAPI_FUNC(void) PyErr_SyntaxLocation(const char *, int); | |
144 | PyAPI_FUNC(PyObject *) PyErr_ProgramText(const char *, int); | |
145 | ||
146 | #ifdef Py_USING_UNICODE | |
147 | /* The following functions are used to create and modify unicode | |
148 | exceptions from C */ | |
149 | ||
150 | /* create a UnicodeDecodeError object */ | |
151 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_Create( | |
152 | const char *, const char *, int, int, int, const char *); | |
153 | ||
154 | /* create a UnicodeEncodeError object */ | |
155 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_Create( | |
156 | const char *, const Py_UNICODE *, int, int, int, const char *); | |
157 | ||
158 | /* create a UnicodeTranslateError object */ | |
159 | PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_Create( | |
160 | const Py_UNICODE *, int, int, int, const char *); | |
161 | ||
162 | /* get the encoding attribute */ | |
163 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetEncoding(PyObject *); | |
164 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetEncoding(PyObject *); | |
165 | ||
166 | /* get the object attribute */ | |
167 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetObject(PyObject *); | |
168 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetObject(PyObject *); | |
169 | PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetObject(PyObject *); | |
170 | ||
171 | /* get the value of the start attribute (the int * may not be NULL) | |
172 | return 0 on success, -1 on failure */ | |
173 | PyAPI_FUNC(int) PyUnicodeEncodeError_GetStart(PyObject *, int *); | |
174 | PyAPI_FUNC(int) PyUnicodeDecodeError_GetStart(PyObject *, int *); | |
175 | PyAPI_FUNC(int) PyUnicodeTranslateError_GetStart(PyObject *, int *); | |
176 | ||
177 | /* assign a new value to the start attribute | |
178 | return 0 on success, -1 on failure */ | |
179 | PyAPI_FUNC(int) PyUnicodeEncodeError_SetStart(PyObject *, int); | |
180 | PyAPI_FUNC(int) PyUnicodeDecodeError_SetStart(PyObject *, int); | |
181 | PyAPI_FUNC(int) PyUnicodeTranslateError_SetStart(PyObject *, int); | |
182 | ||
183 | /* get the value of the end attribute (the int *may not be NULL) | |
184 | return 0 on success, -1 on failure */ | |
185 | PyAPI_FUNC(int) PyUnicodeEncodeError_GetEnd(PyObject *, int *); | |
186 | PyAPI_FUNC(int) PyUnicodeDecodeError_GetEnd(PyObject *, int *); | |
187 | PyAPI_FUNC(int) PyUnicodeTranslateError_GetEnd(PyObject *, int *); | |
188 | ||
189 | /* assign a new value to the end attribute | |
190 | return 0 on success, -1 on failure */ | |
191 | PyAPI_FUNC(int) PyUnicodeEncodeError_SetEnd(PyObject *, int); | |
192 | PyAPI_FUNC(int) PyUnicodeDecodeError_SetEnd(PyObject *, int); | |
193 | PyAPI_FUNC(int) PyUnicodeTranslateError_SetEnd(PyObject *, int); | |
194 | ||
195 | /* get the value of the reason attribute */ | |
196 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetReason(PyObject *); | |
197 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetReason(PyObject *); | |
198 | PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetReason(PyObject *); | |
199 | ||
200 | /* assign a new value to the reason attribute | |
201 | return 0 on success, -1 on failure */ | |
202 | PyAPI_FUNC(int) PyUnicodeEncodeError_SetReason( | |
203 | PyObject *, const char *); | |
204 | PyAPI_FUNC(int) PyUnicodeDecodeError_SetReason( | |
205 | PyObject *, const char *); | |
206 | PyAPI_FUNC(int) PyUnicodeTranslateError_SetReason( | |
207 | PyObject *, const char *); | |
208 | #endif | |
209 | ||
210 | ||
211 | /* These APIs aren't really part of the error implementation, but | |
212 | often needed to format error messages; the native C lib APIs are | |
213 | not available on all platforms, which is why we provide emulations | |
214 | for those platforms in Python/mysnprintf.c, | |
215 | WARNING: The return value of snprintf varies across platforms; do | |
216 | not rely on any particular behavior; eventually the C99 defn may | |
217 | be reliable. | |
218 | */ | |
219 | #if defined(MS_WIN32) && !defined(HAVE_SNPRINTF) | |
220 | # define HAVE_SNPRINTF | |
221 | # define snprintf _snprintf | |
222 | # define vsnprintf _vsnprintf | |
223 | #endif | |
224 | ||
225 | #include <stdarg.h> | |
226 | PyAPI_FUNC(int) PyOS_snprintf(char *str, size_t size, const char *format, ...) | |
227 | Py_GCC_ATTRIBUTE((format(printf, 3, 4))); | |
228 | PyAPI_FUNC(int) PyOS_vsnprintf(char *str, size_t size, const char *format, va_list va) | |
229 | Py_GCC_ATTRIBUTE((format(printf, 3, 0))); | |
230 | ||
231 | #ifdef __cplusplus | |
232 | } | |
233 | #endif | |
234 | #endif /* !Py_ERRORS_H */ |