pyerrors.h 11.1 KB
Newer Older
1 2 3 4 5 6
#ifndef Py_ERRORS_H
#define Py_ERRORS_H
#ifdef __cplusplus
extern "C" {
#endif

7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
/* Error objects */

typedef struct {
    PyObject_HEAD
    PyObject *dict;
    PyObject *args;
    PyObject *message;
} PyBaseExceptionObject;

typedef struct {
    PyObject_HEAD
    PyObject *dict;
    PyObject *args;
    PyObject *message;
    PyObject *msg;
    PyObject *filename;
    PyObject *lineno;
    PyObject *offset;
    PyObject *text;
    PyObject *print_file_and_line;
} PySyntaxErrorObject;

#ifdef Py_USING_UNICODE
typedef struct {
    PyObject_HEAD
    PyObject *dict;
    PyObject *args;
    PyObject *message;
    PyObject *encoding;
    PyObject *object;
37 38
    Py_ssize_t start;
    Py_ssize_t end;
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
    PyObject *reason;
} PyUnicodeErrorObject;
#endif

typedef struct {
    PyObject_HEAD
    PyObject *dict;
    PyObject *args;
    PyObject *message;
    PyObject *code;
} PySystemExitObject;

typedef struct {
    PyObject_HEAD
    PyObject *dict;
    PyObject *args;
    PyObject *message;
    PyObject *myerrno;
    PyObject *strerror;
    PyObject *filename;
} PyEnvironmentErrorObject;

#ifdef MS_WINDOWS
typedef struct {
    PyObject_HEAD
    PyObject *dict;
    PyObject *args;
    PyObject *message;
    PyObject *myerrno;
    PyObject *strerror;
    PyObject *filename;
    PyObject *winerror;
} PyWindowsErrorObject;
#endif
73

Guido van Rossum's avatar
Guido van Rossum committed
74 75
/* Error handling definitions */

76 77 78 79 80 81 82
PyAPI_FUNC(void) PyErr_SetNone(PyObject *);
PyAPI_FUNC(void) PyErr_SetObject(PyObject *, PyObject *);
PyAPI_FUNC(void) PyErr_SetString(PyObject *, const char *);
PyAPI_FUNC(PyObject *) PyErr_Occurred(void);
PyAPI_FUNC(void) PyErr_Clear(void);
PyAPI_FUNC(void) PyErr_Fetch(PyObject **, PyObject **, PyObject **);
PyAPI_FUNC(void) PyErr_Restore(PyObject *, PyObject *, PyObject *);
Guido van Rossum's avatar
Guido van Rossum committed
83

84 85 86 87 88 89
#ifdef Py_DEBUG
#define _PyErr_OCCURRED() PyErr_Occurred()
#else
#define _PyErr_OCCURRED() (_PyThreadState_Current->curexc_type)
#endif

90
/* Error testing and normalization */
91 92 93
PyAPI_FUNC(int) PyErr_GivenExceptionMatches(PyObject *, PyObject *);
PyAPI_FUNC(int) PyErr_ExceptionMatches(PyObject *);
PyAPI_FUNC(void) PyErr_NormalizeException(PyObject**, PyObject**, PyObject**);
94

95
/* */
96

97
#define PyExceptionClass_Check(x)					\
98 99
	(PyClass_Check((x)) || (PyType_Check((x)) &&			\
	  PyType_FastSubclass((PyTypeObject*)(x), Py_TPFLAGS_BASE_EXC_SUBCLASS)))
100 101 102

#define PyExceptionInstance_Check(x)			\
	(PyInstance_Check((x)) ||			\
103
	 PyType_FastSubclass((x)->ob_type, Py_TPFLAGS_BASE_EXC_SUBCLASS))
104 105 106

#define PyExceptionClass_Name(x)				   \
	(PyClass_Check((x))					   \
107
	 ? PyString_AS_STRING(((PyClassObject*)(x))->cl_name)	   \
108 109 110 111 112 113 114 115
	 : (char *)(((PyTypeObject*)(x))->tp_name))

#define PyExceptionInstance_Class(x)					\
	((PyInstance_Check((x))						\
	  ? (PyObject*)((PyInstanceObject*)(x))->in_class		\
	  : (PyObject*)((x)->ob_type)))

	
Guido van Rossum's avatar
Guido van Rossum committed
116
/* Predefined exceptions */
117

118
PyAPI_DATA(PyObject *) PyExc_BaseException;
119 120
PyAPI_DATA(PyObject *) PyExc_Exception;
PyAPI_DATA(PyObject *) PyExc_StopIteration;
121
PyAPI_DATA(PyObject *) PyExc_GeneratorExit;
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
PyAPI_DATA(PyObject *) PyExc_StandardError;
PyAPI_DATA(PyObject *) PyExc_ArithmeticError;
PyAPI_DATA(PyObject *) PyExc_LookupError;

PyAPI_DATA(PyObject *) PyExc_AssertionError;
PyAPI_DATA(PyObject *) PyExc_AttributeError;
PyAPI_DATA(PyObject *) PyExc_EOFError;
PyAPI_DATA(PyObject *) PyExc_FloatingPointError;
PyAPI_DATA(PyObject *) PyExc_EnvironmentError;
PyAPI_DATA(PyObject *) PyExc_IOError;
PyAPI_DATA(PyObject *) PyExc_OSError;
PyAPI_DATA(PyObject *) PyExc_ImportError;
PyAPI_DATA(PyObject *) PyExc_IndexError;
PyAPI_DATA(PyObject *) PyExc_KeyError;
PyAPI_DATA(PyObject *) PyExc_KeyboardInterrupt;
PyAPI_DATA(PyObject *) PyExc_MemoryError;
PyAPI_DATA(PyObject *) PyExc_NameError;
PyAPI_DATA(PyObject *) PyExc_OverflowError;
PyAPI_DATA(PyObject *) PyExc_RuntimeError;
PyAPI_DATA(PyObject *) PyExc_NotImplementedError;
PyAPI_DATA(PyObject *) PyExc_SyntaxError;
PyAPI_DATA(PyObject *) PyExc_IndentationError;
PyAPI_DATA(PyObject *) PyExc_TabError;
PyAPI_DATA(PyObject *) PyExc_ReferenceError;
PyAPI_DATA(PyObject *) PyExc_SystemError;
PyAPI_DATA(PyObject *) PyExc_SystemExit;
PyAPI_DATA(PyObject *) PyExc_TypeError;
PyAPI_DATA(PyObject *) PyExc_UnboundLocalError;
PyAPI_DATA(PyObject *) PyExc_UnicodeError;
151 152 153
PyAPI_DATA(PyObject *) PyExc_UnicodeEncodeError;
PyAPI_DATA(PyObject *) PyExc_UnicodeDecodeError;
PyAPI_DATA(PyObject *) PyExc_UnicodeTranslateError;
154 155
PyAPI_DATA(PyObject *) PyExc_ValueError;
PyAPI_DATA(PyObject *) PyExc_ZeroDivisionError;
156
#ifdef MS_WINDOWS
157
PyAPI_DATA(PyObject *) PyExc_WindowsError;
158
#endif
159
#ifdef __VMS
160
PyAPI_DATA(PyObject *) PyExc_VMSError;
161
#endif
162

163 164
PyAPI_DATA(PyObject *) PyExc_BufferError;

165
PyAPI_DATA(PyObject *) PyExc_MemoryErrorInst;
166
PyAPI_DATA(PyObject *) PyExc_RecursionErrorInst;
167

168
/* Predefined warning categories */
169 170 171 172 173 174
PyAPI_DATA(PyObject *) PyExc_Warning;
PyAPI_DATA(PyObject *) PyExc_UserWarning;
PyAPI_DATA(PyObject *) PyExc_DeprecationWarning;
PyAPI_DATA(PyObject *) PyExc_PendingDeprecationWarning;
PyAPI_DATA(PyObject *) PyExc_SyntaxWarning;
PyAPI_DATA(PyObject *) PyExc_RuntimeWarning;
175
PyAPI_DATA(PyObject *) PyExc_FutureWarning;
176
PyAPI_DATA(PyObject *) PyExc_ImportWarning;
177
PyAPI_DATA(PyObject *) PyExc_UnicodeWarning;
Christian Heimes's avatar
Christian Heimes committed
178
PyAPI_DATA(PyObject *) PyExc_BytesWarning;
179

180

181 182
/* Convenience functions */

183 184 185
PyAPI_FUNC(int) PyErr_BadArgument(void);
PyAPI_FUNC(PyObject *) PyErr_NoMemory(void);
PyAPI_FUNC(PyObject *) PyErr_SetFromErrno(PyObject *);
186 187
PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilenameObject(
	PyObject *, PyObject *);
188
PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilename(PyObject *, char *);
189 190 191 192 193
#ifdef Py_WIN_WIDE_FILENAMES
PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithUnicodeFilename(
	PyObject *, Py_UNICODE *);
#endif /* Py_WIN_WIDE_FILENAMES */

194
PyAPI_FUNC(PyObject *) PyErr_Format(PyObject *, const char *, ...)
195
			Py_GCC_ATTRIBUTE((format(printf, 2, 3)));
196

197
#ifdef MS_WINDOWS
198 199 200 201 202 203 204 205
PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithFilenameObject(
	int, const char *);
PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithFilename(
	int, const char *);
#ifdef Py_WIN_WIDE_FILENAMES
PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithUnicodeFilename(
	int, const Py_UNICODE *);
#endif /* Py_WIN_WIDE_FILENAMES */
206
PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErr(int);
207 208
PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilenameObject(
	PyObject *,int, PyObject *);
209
PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilename(
210
	PyObject *,int, const char *);
211 212 213 214
#ifdef Py_WIN_WIDE_FILENAMES
PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithUnicodeFilename(
	PyObject *,int, const Py_UNICODE *);
#endif /* Py_WIN_WIDE_FILENAMES */
215
PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErr(PyObject *, int);
216
#endif /* MS_WINDOWS */
217

218
/* Export the old function so that the existing API remains available: */
219 220
PyAPI_FUNC(void) PyErr_BadInternalCall(void);
PyAPI_FUNC(void) _PyErr_BadInternalCall(char *filename, int lineno);
221 222 223
/* Mask the old API with a call to the new API for code compiled under
   Python 2.0: */
#define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__)
224

225
/* Function to create a new exception */
226
PyAPI_FUNC(PyObject *) PyErr_NewException(char *name, PyObject *base,
227
                                         PyObject *dict);
228
PyAPI_FUNC(void) PyErr_WriteUnraisable(PyObject *);
229

230
/* In sigcheck.c or signalmodule.c */
231 232
PyAPI_FUNC(int) PyErr_CheckSignals(void);
PyAPI_FUNC(void) PyErr_SetInterrupt(void);
233

234 235 236
/* In signalmodule.c */
int PySignal_SetWakeupFd(int fd);

237
/* Support for adding program text to SyntaxErrors */
238 239
PyAPI_FUNC(void) PyErr_SyntaxLocation(const char *, int);
PyAPI_FUNC(PyObject *) PyErr_ProgramText(const char *, int);
240

241
#ifdef Py_USING_UNICODE
242 243
/* The following functions are used to create and modify unicode
   exceptions from C */
244

245 246
/* create a UnicodeDecodeError object */
PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_Create(
Martin v. Löwis's avatar
Martin v. Löwis committed
247
	const char *, const char *, Py_ssize_t, Py_ssize_t, Py_ssize_t, const char *);
248 249 250

/* create a UnicodeEncodeError object */
PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_Create(
Martin v. Löwis's avatar
Martin v. Löwis committed
251
	const char *, const Py_UNICODE *, Py_ssize_t, Py_ssize_t, Py_ssize_t, const char *);
252 253 254

/* create a UnicodeTranslateError object */
PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_Create(
Martin v. Löwis's avatar
Martin v. Löwis committed
255
	const Py_UNICODE *, Py_ssize_t, Py_ssize_t, Py_ssize_t, const char *);
256 257 258 259 260 261 262 263 264 265 266 267

/* get the encoding attribute */
PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetEncoding(PyObject *);
PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetEncoding(PyObject *);

/* get the object attribute */
PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetObject(PyObject *);
PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetObject(PyObject *);
PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetObject(PyObject *);

/* get the value of the start attribute (the int * may not be NULL)
   return 0 on success, -1 on failure */
Martin v. Löwis's avatar
Martin v. Löwis committed
268 269 270
PyAPI_FUNC(int) PyUnicodeEncodeError_GetStart(PyObject *, Py_ssize_t *);
PyAPI_FUNC(int) PyUnicodeDecodeError_GetStart(PyObject *, Py_ssize_t *);
PyAPI_FUNC(int) PyUnicodeTranslateError_GetStart(PyObject *, Py_ssize_t *);
271 272 273

/* assign a new value to the start attribute
   return 0 on success, -1 on failure */
Martin v. Löwis's avatar
Martin v. Löwis committed
274 275 276
PyAPI_FUNC(int) PyUnicodeEncodeError_SetStart(PyObject *, Py_ssize_t);
PyAPI_FUNC(int) PyUnicodeDecodeError_SetStart(PyObject *, Py_ssize_t);
PyAPI_FUNC(int) PyUnicodeTranslateError_SetStart(PyObject *, Py_ssize_t);
277 278 279

/* get the value of the end attribute (the int *may not be NULL)
 return 0 on success, -1 on failure */
Martin v. Löwis's avatar
Martin v. Löwis committed
280 281 282
PyAPI_FUNC(int) PyUnicodeEncodeError_GetEnd(PyObject *, Py_ssize_t *);
PyAPI_FUNC(int) PyUnicodeDecodeError_GetEnd(PyObject *, Py_ssize_t *);
PyAPI_FUNC(int) PyUnicodeTranslateError_GetEnd(PyObject *, Py_ssize_t *);
283 284 285

/* assign a new value to the end attribute
   return 0 on success, -1 on failure */
Martin v. Löwis's avatar
Martin v. Löwis committed
286 287 288
PyAPI_FUNC(int) PyUnicodeEncodeError_SetEnd(PyObject *, Py_ssize_t);
PyAPI_FUNC(int) PyUnicodeDecodeError_SetEnd(PyObject *, Py_ssize_t);
PyAPI_FUNC(int) PyUnicodeTranslateError_SetEnd(PyObject *, Py_ssize_t);
289 290 291 292 293 294 295 296 297 298 299 300 301 302

/* get the value of the reason attribute */
PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetReason(PyObject *);
PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetReason(PyObject *);
PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetReason(PyObject *);

/* assign a new value to the reason attribute
   return 0 on success, -1 on failure */
PyAPI_FUNC(int) PyUnicodeEncodeError_SetReason(
	PyObject *, const char *);
PyAPI_FUNC(int) PyUnicodeDecodeError_SetReason(
	PyObject *, const char *);
PyAPI_FUNC(int) PyUnicodeTranslateError_SetReason(
	PyObject *, const char *);
303
#endif
304 305


306 307 308
/* These APIs aren't really part of the error implementation, but
   often needed to format error messages; the native C lib APIs are
   not available on all platforms, which is why we provide emulations
309 310 311 312 313
   for those platforms in Python/mysnprintf.c,
   WARNING:  The return value of snprintf varies across platforms; do
   not rely on any particular behavior; eventually the C99 defn may
   be reliable.
*/
314 315 316 317 318
#if defined(MS_WIN32) && !defined(HAVE_SNPRINTF)
# define HAVE_SNPRINTF
# define snprintf _snprintf
# define vsnprintf _vsnprintf
#endif
319

320
#include <stdarg.h>
321
PyAPI_FUNC(int) PyOS_snprintf(char *str, size_t size, const char  *format, ...)
322
			Py_GCC_ATTRIBUTE((format(printf, 3, 4)));
323
PyAPI_FUNC(int) PyOS_vsnprintf(char *str, size_t size, const char  *format, va_list va)
324
			Py_GCC_ATTRIBUTE((format(printf, 3, 0)));
325

326 327 328 329
#ifdef __cplusplus
}
#endif
#endif /* !Py_ERRORS_H */