Include/pyerrors.h

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