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