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 /* 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 extern DL_IMPORT(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 PyAPI_DATA(PyObject *) PyExc_OverflowWarning;
  78 PyAPI_DATA(PyObject *) PyExc_RuntimeWarning;
  79 PyAPI_DATA(PyObject *) PyExc_FutureWarning;
  80
  81
  82 /* Convenience functions */
  83
  84 PyAPI_FUNC(int) PyErr_BadArgument(void);
  85 PyAPI_FUNC(PyObject *) PyErr_NoMemory(void);
  86 PyAPI_FUNC(PyObject *) PyErr_SetFromErrno(PyObject *);
  87 PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilenameObject(
  88         PyObject *, PyObject *);
  89 PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilename(PyObject *, char *);
  90 #ifdef Py_WIN_WIDE_FILENAMES
  91 PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithUnicodeFilename(
  92         PyObject *, Py_UNICODE *);
  93 #endif /* Py_WIN_WIDE_FILENAMES */
  94
  95 PyAPI_FUNC(PyObject *) PyErr_Format(PyObject *, const char *, ...)
  96                         Py_GCC_ATTRIBUTE((format(printf, 2, 3)));
  97
  98 #ifdef MS_WINDOWS
  99 PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithFilenameObject(
 100         int, const char *);
 101 PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithFilename(
 102         int, const char *);
 103 #ifdef Py_WIN_WIDE_FILENAMES
 104 PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithUnicodeFilename(
 105         int, const Py_UNICODE *);
 106 #endif /* Py_WIN_WIDE_FILENAMES */
 107 PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErr(int);
 108 PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilenameObject(
 109         PyObject *,int, PyObject *);
 110 PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilename(
 111         PyObject *,int, const char *);
 112 #ifdef Py_WIN_WIDE_FILENAMES
 113 PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithUnicodeFilename(
 114         PyObject *,int, const Py_UNICODE *);
 115 #endif /* Py_WIN_WIDE_FILENAMES */
 116 PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErr(PyObject *, int);
 117 #endif /* MS_WINDOWS */
 118
 119 /* Export the old function so that the existing API remains available: */
 120 PyAPI_FUNC(void) PyErr_BadInternalCall(void);
 121 PyAPI_FUNC(void) _PyErr_BadInternalCall(char *filename, int lineno);
 122 /* Mask the old API with a call to the new API for code compiled under
 123    Python 2.0: */
 124 #define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__)
 125
 126 /* Function to create a new exception */
 127 PyAPI_FUNC(PyObject *) PyErr_NewException(char *name, PyObject *base,
 128                                          PyObject *dict);
 129 PyAPI_FUNC(void) PyErr_WriteUnraisable(PyObject *);
 130
 131 /* Issue a warning or exception */
 132 PyAPI_FUNC(int) PyErr_Warn(PyObject *, char *);
 133 PyAPI_FUNC(int) PyErr_WarnExplicit(PyObject *, const char *,
 134                                    const char *, int,
 135                                    const char *, PyObject *);
 136
 137 /* In sigcheck.c or signalmodule.c */
 138 PyAPI_FUNC(int) PyErr_CheckSignals(void);
 139 PyAPI_FUNC(void) PyErr_SetInterrupt(void);
 140
 141 /* Support for adding program text to SyntaxErrors */
 142 PyAPI_FUNC(void) PyErr_SyntaxLocation(const char *, int);
 143 PyAPI_FUNC(PyObject *) PyErr_ProgramText(const char *, int);
 144
 145 #ifdef Py_USING_UNICODE
 146 /* The following functions are used to create and modify unicode
 147    exceptions from C */
 148
 149 /* create a UnicodeDecodeError object */
 150 PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_Create(
 151         const char *, const char *, int, int, int, const char *);
 152
 153 /* create a UnicodeEncodeError object */
 154 PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_Create(
 155         const char *, const Py_UNICODE *, int, int, int, const char *);
 156
 157 /* create a UnicodeTranslateError object */
 158 PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_Create(
 159         const Py_UNICODE *, int, int, int, const char *);
 160
 161 /* get the encoding attribute */
 162 PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetEncoding(PyObject *);
 163 PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetEncoding(PyObject *);
 164
 165 /* get the object attribute */
 166 PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetObject(PyObject *);
 167 PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetObject(PyObject *);
 168 PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetObject(PyObject *);
 169
 170 /* get the value of the start attribute (the int * may not be NULL)
 171    return 0 on success, -1 on failure */
 172 PyAPI_FUNC(int) PyUnicodeEncodeError_GetStart(PyObject *, int *);
 173 PyAPI_FUNC(int) PyUnicodeDecodeError_GetStart(PyObject *, int *);
 174 PyAPI_FUNC(int) PyUnicodeTranslateError_GetStart(PyObject *, int *);
 175
 176 /* assign a new value to the start attribute
 177    return 0 on success, -1 on failure */
 178 PyAPI_FUNC(int) PyUnicodeEncodeError_SetStart(PyObject *, int);
 179 PyAPI_FUNC(int) PyUnicodeDecodeError_SetStart(PyObject *, int);
 180 PyAPI_FUNC(int) PyUnicodeTranslateError_SetStart(PyObject *, int);
 181
 182 /* get the value of the end attribute (the int *may not be NULL)
 183  return 0 on success, -1 on failure */
 184 PyAPI_FUNC(int) PyUnicodeEncodeError_GetEnd(PyObject *, int *);
 185 PyAPI_FUNC(int) PyUnicodeDecodeError_GetEnd(PyObject *, int *);
 186 PyAPI_FUNC(int) PyUnicodeTranslateError_GetEnd(PyObject *, int *);
 187
 188 /* assign a new value to the end attribute
 189    return 0 on success, -1 on failure */
 190 PyAPI_FUNC(int) PyUnicodeEncodeError_SetEnd(PyObject *, int);
 191 PyAPI_FUNC(int) PyUnicodeDecodeError_SetEnd(PyObject *, int);
 192 PyAPI_FUNC(int) PyUnicodeTranslateError_SetEnd(PyObject *, int);
 193
 194 /* get the value of the reason attribute */
 195 PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetReason(PyObject *);
 196 PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetReason(PyObject *);
 197 PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetReason(PyObject *);
 198
 199 /* assign a new value to the reason attribute
 200    return 0 on success, -1 on failure */
 201 PyAPI_FUNC(int) PyUnicodeEncodeError_SetReason(
 202         PyObject *, const char *);
 203 PyAPI_FUNC(int) PyUnicodeDecodeError_SetReason(
 204         PyObject *, const char *);
 205 PyAPI_FUNC(int) PyUnicodeTranslateError_SetReason(
 206         PyObject *, const char *);
 207 #endif
 208
 209
 210 /* These APIs aren't really part of the error implementation, but
 211    often needed to format error messages; the native C lib APIs are
 212    not available on all platforms, which is why we provide emulations
 213    for those platforms in Python/mysnprintf.c,
 214    WARNING:  The return value of snprintf varies across platforms; do
 215    not rely on any particular behavior; eventually the C99 defn may
 216    be reliable.
 217 */
 218 #if defined(MS_WIN32) && !defined(HAVE_SNPRINTF)
 219 # define HAVE_SNPRINTF
 220 # define snprintf _snprintf
 221 # define vsnprintf _vsnprintf
 222 #endif
 223
 224 #include <stdarg.h>
 225 PyAPI_FUNC(int) PyOS_snprintf(char *str, size_t size, const char  *format, ...)
 226                         Py_GCC_ATTRIBUTE((format(printf, 3, 4)));
 227 PyAPI_FUNC(int) PyOS_vsnprintf(char *str, size_t size, const char  *format, va_list va)
 228                         Py_GCC_ATTRIBUTE((format(printf, 3, 0)));
 229
 230 #ifdef __cplusplus
 231 }
 232 #endif
 233 #endif /* !Py_ERRORS_H */