Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 1 | #ifndef Py_ERRORS_H |
| 2 | #define Py_ERRORS_H |
| 3 | #ifdef __cplusplus |
| 4 | extern "C" { |
| 5 | #endif |
| 6 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 7 | /* Error objects */ |
| 8 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 9 | #ifndef Py_LIMITED_API |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 10 | /* PyException_HEAD defines the initial segment of every exception class. */ |
Collin Winter | 231ff0e | 2007-08-31 00:59:38 +0000 | [diff] [blame] | 11 | #define PyException_HEAD PyObject_HEAD PyObject *dict;\ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 12 | PyObject *args; PyObject *traceback;\ |
Benjamin Peterson | d5a1c44 | 2012-05-14 22:09:31 -0700 | [diff] [blame] | 13 | PyObject *context; PyObject *cause;\ |
Benjamin Peterson | 1a1367b | 2012-08-08 17:22:50 -0700 | [diff] [blame] | 14 | char suppress_context; |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 15 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 16 | typedef struct { |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 17 | PyException_HEAD |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 18 | } PyBaseExceptionObject; |
| 19 | |
| 20 | typedef struct { |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 21 | PyException_HEAD |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 22 | PyObject *msg; |
| 23 | PyObject *filename; |
| 24 | PyObject *lineno; |
| 25 | PyObject *offset; |
| 26 | PyObject *text; |
| 27 | PyObject *print_file_and_line; |
| 28 | } PySyntaxErrorObject; |
| 29 | |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 30 | typedef struct { |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 31 | PyException_HEAD |
Benjamin Peterson | 633b32a | 2012-04-12 21:50:35 -0400 | [diff] [blame] | 32 | PyObject *msg; |
| 33 | PyObject *name; |
| 34 | PyObject *path; |
| 35 | } PyImportErrorObject; |
| 36 | |
| 37 | typedef struct { |
| 38 | PyException_HEAD |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 39 | PyObject *encoding; |
| 40 | PyObject *object; |
Guido van Rossum | 7eaf822 | 2007-06-18 17:58:50 +0000 | [diff] [blame] | 41 | Py_ssize_t start; |
| 42 | Py_ssize_t end; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 43 | PyObject *reason; |
| 44 | } PyUnicodeErrorObject; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 45 | |
| 46 | typedef struct { |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 47 | PyException_HEAD |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 48 | PyObject *code; |
| 49 | } PySystemExitObject; |
| 50 | |
| 51 | typedef struct { |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 52 | PyException_HEAD |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 53 | PyObject *myerrno; |
| 54 | PyObject *strerror; |
| 55 | PyObject *filename; |
Larry Hastings | b082731 | 2014-02-09 22:05:19 -0800 | [diff] [blame] | 56 | PyObject *filename2; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 57 | #ifdef MS_WINDOWS |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 58 | PyObject *winerror; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 59 | #endif |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 60 | Py_ssize_t written; /* only for BlockingIOError, -1 otherwise */ |
| 61 | } PyOSErrorObject; |
| 62 | |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 63 | typedef struct { |
| 64 | PyException_HEAD |
| 65 | PyObject *value; |
| 66 | } PyStopIterationObject; |
| 67 | |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 68 | /* Compatibility typedefs */ |
| 69 | typedef PyOSErrorObject PyEnvironmentErrorObject; |
| 70 | #ifdef MS_WINDOWS |
| 71 | typedef PyOSErrorObject PyWindowsErrorObject; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 72 | #endif |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 73 | #endif /* !Py_LIMITED_API */ |
Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 74 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 75 | /* Error handling definitions */ |
| 76 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 77 | PyAPI_FUNC(void) PyErr_SetNone(PyObject *); |
| 78 | PyAPI_FUNC(void) PyErr_SetObject(PyObject *, PyObject *); |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 79 | #ifndef Py_LIMITED_API |
Raymond Hettinger | 69492da | 2013-09-02 15:59:26 -0700 | [diff] [blame] | 80 | PyAPI_FUNC(void) _PyErr_SetKeyError(PyObject *); |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 81 | #endif |
Victor Stinner | 257d38f | 2010-10-09 10:12:11 +0000 | [diff] [blame] | 82 | PyAPI_FUNC(void) PyErr_SetString( |
| 83 | PyObject *exception, |
| 84 | const char *string /* decoded from utf-8 */ |
| 85 | ); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 86 | PyAPI_FUNC(PyObject *) PyErr_Occurred(void); |
| 87 | PyAPI_FUNC(void) PyErr_Clear(void); |
| 88 | PyAPI_FUNC(void) PyErr_Fetch(PyObject **, PyObject **, PyObject **); |
| 89 | PyAPI_FUNC(void) PyErr_Restore(PyObject *, PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 90 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000 |
Martin v. Löwis | aa2efcb | 2012-04-19 14:33:43 +0200 | [diff] [blame] | 91 | PyAPI_FUNC(void) PyErr_GetExcInfo(PyObject **, PyObject **, PyObject **); |
| 92 | PyAPI_FUNC(void) PyErr_SetExcInfo(PyObject *, PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 93 | #endif |
Brett Cannon | b94767f | 2011-02-22 20:15:44 +0000 | [diff] [blame] | 94 | |
| 95 | #if defined(__clang__) || \ |
Benjamin Peterson | ca75b00 | 2012-06-03 18:15:15 -0700 | [diff] [blame] | 96 | (defined(__GNUC_MAJOR__) && \ |
Brett Cannon | b94767f | 2011-02-22 20:15:44 +0000 | [diff] [blame] | 97 | ((__GNUC_MAJOR__ >= 3) || \ |
| 98 | (__GNUC_MAJOR__ == 2) && (__GNUC_MINOR__ >= 5))) |
| 99 | #define _Py_NO_RETURN __attribute__((__noreturn__)) |
| 100 | #else |
| 101 | #define _Py_NO_RETURN |
| 102 | #endif |
| 103 | |
Nick Coghlan | d600951 | 2014-11-20 21:39:37 +1000 | [diff] [blame] | 104 | /* Defined in Python/pylifecycle.c */ |
Brett Cannon | b94767f | 2011-02-22 20:15:44 +0000 | [diff] [blame] | 105 | PyAPI_FUNC(void) Py_FatalError(const char *message) _Py_NO_RETURN; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 106 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 107 | #if defined(Py_DEBUG) || defined(Py_LIMITED_API) |
Raymond Hettinger | 5ba0cbe | 2005-08-06 18:31:24 +0000 | [diff] [blame] | 108 | #define _PyErr_OCCURRED() PyErr_Occurred() |
| 109 | #else |
Antoine Pitrou | 59c900d | 2013-10-07 20:38:51 +0200 | [diff] [blame] | 110 | #define _PyErr_OCCURRED() (PyThreadState_GET()->curexc_type) |
Raymond Hettinger | 5ba0cbe | 2005-08-06 18:31:24 +0000 | [diff] [blame] | 111 | #endif |
| 112 | |
Barry Warsaw | c0dc92a | 1997-08-22 21:22:58 +0000 | [diff] [blame] | 113 | /* Error testing and normalization */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 114 | PyAPI_FUNC(int) PyErr_GivenExceptionMatches(PyObject *, PyObject *); |
| 115 | PyAPI_FUNC(int) PyErr_ExceptionMatches(PyObject *); |
| 116 | PyAPI_FUNC(void) PyErr_NormalizeException(PyObject**, PyObject**, PyObject**); |
Barry Warsaw | c0dc92a | 1997-08-22 21:22:58 +0000 | [diff] [blame] | 117 | |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 118 | /* Traceback manipulation (PEP 3134) */ |
| 119 | PyAPI_FUNC(int) PyException_SetTraceback(PyObject *, PyObject *); |
| 120 | PyAPI_FUNC(PyObject *) PyException_GetTraceback(PyObject *); |
| 121 | |
| 122 | /* Cause manipulation (PEP 3134) */ |
| 123 | PyAPI_FUNC(PyObject *) PyException_GetCause(PyObject *); |
| 124 | PyAPI_FUNC(void) PyException_SetCause(PyObject *, PyObject *); |
| 125 | |
| 126 | /* Context manipulation (PEP 3134) */ |
| 127 | PyAPI_FUNC(PyObject *) PyException_GetContext(PyObject *); |
| 128 | PyAPI_FUNC(void) PyException_SetContext(PyObject *, PyObject *); |
Serhiy Storchaka | e2bd2a7 | 2014-10-08 22:31:52 +0300 | [diff] [blame] | 129 | #ifndef Py_LIMITED_API |
| 130 | PyAPI_FUNC(void) _PyErr_ChainExceptions(PyObject *, PyObject *, PyObject *); |
| 131 | #endif |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 132 | |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 133 | /* */ |
Barry Warsaw | c0dc92a | 1997-08-22 21:22:58 +0000 | [diff] [blame] | 134 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 135 | #define PyExceptionClass_Check(x) \ |
| 136 | (PyType_Check((x)) && \ |
| 137 | PyType_FastSubclass((PyTypeObject*)(x), Py_TPFLAGS_BASE_EXC_SUBCLASS)) |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 138 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 139 | #define PyExceptionInstance_Check(x) \ |
| 140 | PyType_FastSubclass((x)->ob_type, Py_TPFLAGS_BASE_EXC_SUBCLASS) |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 141 | |
Guido van Rossum | 45aecf4 | 2006-03-15 04:58:47 +0000 | [diff] [blame] | 142 | #define PyExceptionClass_Name(x) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 143 | ((char *)(((PyTypeObject*)(x))->tp_name)) |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 144 | |
Guido van Rossum | 45aecf4 | 2006-03-15 04:58:47 +0000 | [diff] [blame] | 145 | #define PyExceptionInstance_Class(x) ((PyObject*)((x)->ob_type)) |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 146 | |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 147 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 148 | /* Predefined exceptions */ |
Guido van Rossum | 5c600e1 | 1990-10-14 20:00:25 +0000 | [diff] [blame] | 149 | |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 150 | PyAPI_DATA(PyObject *) PyExc_BaseException; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 151 | PyAPI_DATA(PyObject *) PyExc_Exception; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 152 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000 |
Yury Selivanov | 7544508 | 2015-05-11 22:57:16 -0400 | [diff] [blame] | 153 | PyAPI_DATA(PyObject *) PyExc_StopAsyncIteration; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 154 | #endif |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 155 | PyAPI_DATA(PyObject *) PyExc_StopIteration; |
Phillip J. Eby | 0d6615f | 2005-08-02 00:46:46 +0000 | [diff] [blame] | 156 | PyAPI_DATA(PyObject *) PyExc_GeneratorExit; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 157 | PyAPI_DATA(PyObject *) PyExc_ArithmeticError; |
| 158 | PyAPI_DATA(PyObject *) PyExc_LookupError; |
Barry Warsaw | 392d827 | 1997-08-29 21:56:07 +0000 | [diff] [blame] | 159 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 160 | PyAPI_DATA(PyObject *) PyExc_AssertionError; |
| 161 | PyAPI_DATA(PyObject *) PyExc_AttributeError; |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 162 | PyAPI_DATA(PyObject *) PyExc_BufferError; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 163 | PyAPI_DATA(PyObject *) PyExc_EOFError; |
| 164 | PyAPI_DATA(PyObject *) PyExc_FloatingPointError; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 165 | PyAPI_DATA(PyObject *) PyExc_OSError; |
| 166 | PyAPI_DATA(PyObject *) PyExc_ImportError; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 167 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03060000 |
Eric Snow | c943265 | 2016-09-07 15:42:32 -0700 | [diff] [blame] | 168 | PyAPI_DATA(PyObject *) PyExc_ModuleNotFoundError; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 169 | #endif |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 170 | PyAPI_DATA(PyObject *) PyExc_IndexError; |
| 171 | PyAPI_DATA(PyObject *) PyExc_KeyError; |
| 172 | PyAPI_DATA(PyObject *) PyExc_KeyboardInterrupt; |
| 173 | PyAPI_DATA(PyObject *) PyExc_MemoryError; |
| 174 | PyAPI_DATA(PyObject *) PyExc_NameError; |
| 175 | PyAPI_DATA(PyObject *) PyExc_OverflowError; |
| 176 | PyAPI_DATA(PyObject *) PyExc_RuntimeError; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 177 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000 |
Yury Selivanov | f488fb4 | 2015-07-03 01:04:23 -0400 | [diff] [blame] | 178 | PyAPI_DATA(PyObject *) PyExc_RecursionError; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 179 | #endif |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 180 | PyAPI_DATA(PyObject *) PyExc_NotImplementedError; |
| 181 | PyAPI_DATA(PyObject *) PyExc_SyntaxError; |
| 182 | PyAPI_DATA(PyObject *) PyExc_IndentationError; |
| 183 | PyAPI_DATA(PyObject *) PyExc_TabError; |
| 184 | PyAPI_DATA(PyObject *) PyExc_ReferenceError; |
| 185 | PyAPI_DATA(PyObject *) PyExc_SystemError; |
| 186 | PyAPI_DATA(PyObject *) PyExc_SystemExit; |
| 187 | PyAPI_DATA(PyObject *) PyExc_TypeError; |
| 188 | PyAPI_DATA(PyObject *) PyExc_UnboundLocalError; |
| 189 | PyAPI_DATA(PyObject *) PyExc_UnicodeError; |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 190 | PyAPI_DATA(PyObject *) PyExc_UnicodeEncodeError; |
| 191 | PyAPI_DATA(PyObject *) PyExc_UnicodeDecodeError; |
| 192 | PyAPI_DATA(PyObject *) PyExc_UnicodeTranslateError; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 193 | PyAPI_DATA(PyObject *) PyExc_ValueError; |
| 194 | PyAPI_DATA(PyObject *) PyExc_ZeroDivisionError; |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 195 | |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 196 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000 |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 197 | PyAPI_DATA(PyObject *) PyExc_BlockingIOError; |
| 198 | PyAPI_DATA(PyObject *) PyExc_BrokenPipeError; |
| 199 | PyAPI_DATA(PyObject *) PyExc_ChildProcessError; |
| 200 | PyAPI_DATA(PyObject *) PyExc_ConnectionError; |
| 201 | PyAPI_DATA(PyObject *) PyExc_ConnectionAbortedError; |
| 202 | PyAPI_DATA(PyObject *) PyExc_ConnectionRefusedError; |
| 203 | PyAPI_DATA(PyObject *) PyExc_ConnectionResetError; |
| 204 | PyAPI_DATA(PyObject *) PyExc_FileExistsError; |
| 205 | PyAPI_DATA(PyObject *) PyExc_FileNotFoundError; |
| 206 | PyAPI_DATA(PyObject *) PyExc_InterruptedError; |
| 207 | PyAPI_DATA(PyObject *) PyExc_IsADirectoryError; |
| 208 | PyAPI_DATA(PyObject *) PyExc_NotADirectoryError; |
| 209 | PyAPI_DATA(PyObject *) PyExc_PermissionError; |
| 210 | PyAPI_DATA(PyObject *) PyExc_ProcessLookupError; |
| 211 | PyAPI_DATA(PyObject *) PyExc_TimeoutError; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 212 | #endif |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 213 | |
| 214 | |
| 215 | /* Compatibility aliases */ |
| 216 | PyAPI_DATA(PyObject *) PyExc_EnvironmentError; |
| 217 | PyAPI_DATA(PyObject *) PyExc_IOError; |
Guido van Rossum | db0c9f7 | 2000-02-17 15:17:18 +0000 | [diff] [blame] | 218 | #ifdef MS_WINDOWS |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 219 | PyAPI_DATA(PyObject *) PyExc_WindowsError; |
Guido van Rossum | db0c9f7 | 2000-02-17 15:17:18 +0000 | [diff] [blame] | 220 | #endif |
Guido van Rossum | 3e55cb6 | 1990-10-21 22:09:30 +0000 | [diff] [blame] | 221 | |
Thomas Wouters | 89d996e | 2007-09-08 17:39:28 +0000 | [diff] [blame] | 222 | PyAPI_DATA(PyObject *) PyExc_RecursionErrorInst; |
Barry Warsaw | 392d827 | 1997-08-29 21:56:07 +0000 | [diff] [blame] | 223 | |
Guido van Rossum | 3fc3037 | 2000-12-15 21:57:34 +0000 | [diff] [blame] | 224 | /* Predefined warning categories */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 225 | PyAPI_DATA(PyObject *) PyExc_Warning; |
| 226 | PyAPI_DATA(PyObject *) PyExc_UserWarning; |
| 227 | PyAPI_DATA(PyObject *) PyExc_DeprecationWarning; |
| 228 | PyAPI_DATA(PyObject *) PyExc_PendingDeprecationWarning; |
| 229 | PyAPI_DATA(PyObject *) PyExc_SyntaxWarning; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 230 | PyAPI_DATA(PyObject *) PyExc_RuntimeWarning; |
Barry Warsaw | 9f00739 | 2002-08-14 15:51:29 +0000 | [diff] [blame] | 231 | PyAPI_DATA(PyObject *) PyExc_FutureWarning; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 232 | PyAPI_DATA(PyObject *) PyExc_ImportWarning; |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 233 | PyAPI_DATA(PyObject *) PyExc_UnicodeWarning; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 234 | PyAPI_DATA(PyObject *) PyExc_BytesWarning; |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 235 | PyAPI_DATA(PyObject *) PyExc_ResourceWarning; |
Guido van Rossum | 3fc3037 | 2000-12-15 21:57:34 +0000 | [diff] [blame] | 236 | |
Barry Warsaw | 392d827 | 1997-08-29 21:56:07 +0000 | [diff] [blame] | 237 | |
Guido van Rossum | 5c600e1 | 1990-10-14 20:00:25 +0000 | [diff] [blame] | 238 | /* Convenience functions */ |
| 239 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 240 | PyAPI_FUNC(int) PyErr_BadArgument(void); |
| 241 | PyAPI_FUNC(PyObject *) PyErr_NoMemory(void); |
| 242 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrno(PyObject *); |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 243 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilenameObject( |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 244 | PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 245 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03040000 |
Larry Hastings | b082731 | 2014-02-09 22:05:19 -0800 | [diff] [blame] | 246 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilenameObjects( |
| 247 | PyObject *, PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 248 | #endif |
Benjamin Peterson | 78565b2 | 2009-06-28 19:19:51 +0000 | [diff] [blame] | 249 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilename( |
Victor Stinner | 257d38f | 2010-10-09 10:12:11 +0000 | [diff] [blame] | 250 | PyObject *exc, |
| 251 | const char *filename /* decoded from the filesystem encoding */ |
| 252 | ); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 253 | #if defined(MS_WINDOWS) && !defined(Py_LIMITED_API) |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 254 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithUnicodeFilename( |
Serhiy Storchaka | 460bd0d | 2016-11-20 12:16:46 +0200 | [diff] [blame] | 255 | PyObject *, const Py_UNICODE *) Py_DEPRECATED(3.3); |
Hirokazu Yamamoto | 8223c24 | 2009-05-17 04:21:53 +0000 | [diff] [blame] | 256 | #endif /* MS_WINDOWS */ |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 257 | |
Victor Stinner | 1205f27 | 2010-09-11 00:54:47 +0000 | [diff] [blame] | 258 | PyAPI_FUNC(PyObject *) PyErr_Format( |
| 259 | PyObject *exception, |
| 260 | const char *format, /* ASCII-encoded string */ |
| 261 | ... |
| 262 | ); |
Antoine Pitrou | 0676a40 | 2014-09-30 21:16:27 +0200 | [diff] [blame] | 263 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000 |
| 264 | PyAPI_FUNC(PyObject *) PyErr_FormatV( |
| 265 | PyObject *exception, |
| 266 | const char *format, |
| 267 | va_list vargs); |
| 268 | #endif |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 269 | |
Serhiy Storchaka | 467ab19 | 2016-10-21 17:09:17 +0300 | [diff] [blame] | 270 | #ifndef Py_LIMITED_API |
| 271 | /* Like PyErr_Format(), but saves current exception as __context__ and |
| 272 | __cause__. |
| 273 | */ |
| 274 | PyAPI_FUNC(PyObject *) _PyErr_FormatFromCause( |
| 275 | PyObject *exception, |
| 276 | const char *format, /* ASCII-encoded string */ |
| 277 | ... |
| 278 | ); |
| 279 | #endif |
| 280 | |
Guido van Rossum | db0c9f7 | 2000-02-17 15:17:18 +0000 | [diff] [blame] | 281 | #ifdef MS_WINDOWS |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 282 | PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithFilename( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 283 | int ierr, |
Victor Stinner | b9cb21e | 2010-12-28 00:59:03 +0000 | [diff] [blame] | 284 | const char *filename /* decoded from the filesystem encoding */ |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 285 | ); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 286 | #ifndef Py_LIMITED_API |
| 287 | /* XXX redeclare to use WSTRING */ |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 288 | PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithUnicodeFilename( |
Serhiy Storchaka | 460bd0d | 2016-11-20 12:16:46 +0200 | [diff] [blame] | 289 | int, const Py_UNICODE *) Py_DEPRECATED(3.3); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 290 | #endif |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 291 | PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErr(int); |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 292 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilenameObject( |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 293 | PyObject *,int, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 294 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03040000 |
Larry Hastings | b082731 | 2014-02-09 22:05:19 -0800 | [diff] [blame] | 295 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilenameObjects( |
| 296 | PyObject *,int, PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 297 | #endif |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 298 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilename( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 299 | PyObject *exc, |
| 300 | int ierr, |
Victor Stinner | b9cb21e | 2010-12-28 00:59:03 +0000 | [diff] [blame] | 301 | const char *filename /* decoded from the filesystem encoding */ |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 302 | ); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 303 | #ifndef Py_LIMITED_API |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 304 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithUnicodeFilename( |
Serhiy Storchaka | 460bd0d | 2016-11-20 12:16:46 +0200 | [diff] [blame] | 305 | PyObject *,int, const Py_UNICODE *) Py_DEPRECATED(3.3); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 306 | #endif |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 307 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErr(PyObject *, int); |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 308 | #endif /* MS_WINDOWS */ |
Guido van Rossum | 3e55cb6 | 1990-10-21 22:09:30 +0000 | [diff] [blame] | 309 | |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 310 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03060000 |
Eric Snow | 46f97b8 | 2016-09-07 16:56:15 -0700 | [diff] [blame] | 311 | PyAPI_FUNC(PyObject *) PyErr_SetImportErrorSubclass(PyObject *, PyObject *, |
| 312 | PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 313 | #endif |
| 314 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000 |
Brian Curtin | 09b86d1 | 2012-04-17 16:57:09 -0500 | [diff] [blame] | 315 | PyAPI_FUNC(PyObject *) PyErr_SetImportError(PyObject *, PyObject *, |
| 316 | PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 317 | #endif |
Brett Cannon | 79ec55e | 2012-04-12 20:24:54 -0400 | [diff] [blame] | 318 | |
Fred Drake | 6d63adf | 2000-08-24 22:38:39 +0000 | [diff] [blame] | 319 | /* Export the old function so that the existing API remains available: */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 320 | PyAPI_FUNC(void) PyErr_BadInternalCall(void); |
Neal Norwitz | b382b84 | 2007-08-24 20:00:37 +0000 | [diff] [blame] | 321 | PyAPI_FUNC(void) _PyErr_BadInternalCall(const char *filename, int lineno); |
Fred Drake | 6d63adf | 2000-08-24 22:38:39 +0000 | [diff] [blame] | 322 | /* Mask the old API with a call to the new API for code compiled under |
| 323 | Python 2.0: */ |
| 324 | #define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__) |
Guido van Rossum | 2583165 | 1993-05-19 14:50:45 +0000 | [diff] [blame] | 325 | |
Guido van Rossum | 2d2c344 | 1997-09-16 21:50:37 +0000 | [diff] [blame] | 326 | /* Function to create a new exception */ |
Georg Brandl | 1e28a27 | 2009-12-28 08:41:01 +0000 | [diff] [blame] | 327 | PyAPI_FUNC(PyObject *) PyErr_NewException( |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 328 | const char *name, PyObject *base, PyObject *dict); |
Georg Brandl | 1e28a27 | 2009-12-28 08:41:01 +0000 | [diff] [blame] | 329 | PyAPI_FUNC(PyObject *) PyErr_NewExceptionWithDoc( |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 330 | const char *name, const char *doc, PyObject *base, PyObject *dict); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 331 | PyAPI_FUNC(void) PyErr_WriteUnraisable(PyObject *); |
Guido van Rossum | 2d2c344 | 1997-09-16 21:50:37 +0000 | [diff] [blame] | 332 | |
Nick Coghlan | 8b097b4 | 2013-11-13 23:49:21 +1000 | [diff] [blame] | 333 | /* In exceptions.c */ |
| 334 | #ifndef Py_LIMITED_API |
| 335 | /* Helper that attempts to replace the current exception with one of the |
| 336 | * same type but with a prefix added to the exception text. The resulting |
| 337 | * exception description looks like: |
| 338 | * |
| 339 | * prefix (exc_type: original_exc_str) |
| 340 | * |
| 341 | * Only some exceptions can be safely replaced. If the function determines |
| 342 | * it isn't safe to perform the replacement, it will leave the original |
| 343 | * unmodified exception in place. |
| 344 | * |
| 345 | * Returns a borrowed reference to the new exception (if any), NULL if the |
| 346 | * existing exception was left in place. |
| 347 | */ |
| 348 | PyAPI_FUNC(PyObject *) _PyErr_TrySetFromCause( |
| 349 | const char *prefix_format, /* ASCII-encoded string */ |
| 350 | ... |
| 351 | ); |
| 352 | #endif |
| 353 | |
| 354 | |
Barry Warsaw | f3f41a9 | 1997-01-03 00:15:03 +0000 | [diff] [blame] | 355 | /* In sigcheck.c or signalmodule.c */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 356 | PyAPI_FUNC(int) PyErr_CheckSignals(void); |
| 357 | PyAPI_FUNC(void) PyErr_SetInterrupt(void); |
Jeremy Hylton | ad3d3f2 | 2001-02-28 17:47:12 +0000 | [diff] [blame] | 358 | |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 359 | /* In signalmodule.c */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 360 | #ifndef Py_LIMITED_API |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 361 | int PySignal_SetWakeupFd(int fd); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 362 | #endif |
Christian Heimes | 5fb7c2a | 2007-12-24 08:52:31 +0000 | [diff] [blame] | 363 | |
Jeremy Hylton | ad3d3f2 | 2001-02-28 17:47:12 +0000 | [diff] [blame] | 364 | /* Support for adding program text to SyntaxErrors */ |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 365 | PyAPI_FUNC(void) PyErr_SyntaxLocation( |
| 366 | const char *filename, /* decoded from the filesystem encoding */ |
| 367 | int lineno); |
| 368 | PyAPI_FUNC(void) PyErr_SyntaxLocationEx( |
| 369 | const char *filename, /* decoded from the filesystem encoding */ |
| 370 | int lineno, |
| 371 | int col_offset); |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 372 | #ifndef Py_LIMITED_API |
Victor Stinner | 14e461d | 2013-08-26 22:28:21 +0200 | [diff] [blame] | 373 | PyAPI_FUNC(void) PyErr_SyntaxLocationObject( |
| 374 | PyObject *filename, |
| 375 | int lineno, |
| 376 | int col_offset); |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 377 | #endif |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 378 | PyAPI_FUNC(PyObject *) PyErr_ProgramText( |
| 379 | const char *filename, /* decoded from the filesystem encoding */ |
| 380 | int lineno); |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 381 | #ifndef Py_LIMITED_API |
Victor Stinner | 14e461d | 2013-08-26 22:28:21 +0200 | [diff] [blame] | 382 | PyAPI_FUNC(PyObject *) PyErr_ProgramTextObject( |
| 383 | PyObject *filename, |
| 384 | int lineno); |
Martin v. Löwis | 1c0689c | 2014-01-03 21:36:49 +0100 | [diff] [blame] | 385 | #endif |
Tim Peters | a437d45 | 2001-11-28 16:51:49 +0000 | [diff] [blame] | 386 | |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 387 | /* The following functions are used to create and modify unicode |
| 388 | exceptions from C */ |
Walter Dörwald | bf73db8 | 2002-11-21 20:08:33 +0000 | [diff] [blame] | 389 | |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 390 | /* create a UnicodeDecodeError object */ |
| 391 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_Create( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 392 | const char *encoding, /* UTF-8 encoded string */ |
| 393 | const char *object, |
| 394 | Py_ssize_t length, |
| 395 | Py_ssize_t start, |
| 396 | Py_ssize_t end, |
| 397 | const char *reason /* UTF-8 encoded string */ |
| 398 | ); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 399 | |
| 400 | /* create a UnicodeEncodeError object */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 401 | #ifndef Py_LIMITED_API |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 402 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_Create( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 403 | const char *encoding, /* UTF-8 encoded string */ |
| 404 | const Py_UNICODE *object, |
| 405 | Py_ssize_t length, |
| 406 | Py_ssize_t start, |
| 407 | Py_ssize_t end, |
| 408 | const char *reason /* UTF-8 encoded string */ |
Serhiy Storchaka | 460bd0d | 2016-11-20 12:16:46 +0200 | [diff] [blame] | 409 | ) Py_DEPRECATED(3.3); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 410 | #endif |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 411 | |
| 412 | /* create a UnicodeTranslateError object */ |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 413 | #ifndef Py_LIMITED_API |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 414 | PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_Create( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 415 | const Py_UNICODE *object, |
| 416 | Py_ssize_t length, |
| 417 | Py_ssize_t start, |
| 418 | Py_ssize_t end, |
| 419 | const char *reason /* UTF-8 encoded string */ |
Serhiy Storchaka | 460bd0d | 2016-11-20 12:16:46 +0200 | [diff] [blame] | 420 | ) Py_DEPRECATED(3.3); |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 421 | PyAPI_FUNC(PyObject *) _PyUnicodeTranslateError_Create( |
| 422 | PyObject *object, |
| 423 | Py_ssize_t start, |
| 424 | Py_ssize_t end, |
| 425 | const char *reason /* UTF-8 encoded string */ |
| 426 | ); |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 427 | #endif |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 428 | |
| 429 | /* get the encoding attribute */ |
| 430 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetEncoding(PyObject *); |
| 431 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetEncoding(PyObject *); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 432 | |
| 433 | /* get the object attribute */ |
| 434 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetObject(PyObject *); |
| 435 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetObject(PyObject *); |
| 436 | PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetObject(PyObject *); |
| 437 | |
| 438 | /* get the value of the start attribute (the int * may not be NULL) |
| 439 | return 0 on success, -1 on failure */ |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 440 | PyAPI_FUNC(int) PyUnicodeEncodeError_GetStart(PyObject *, Py_ssize_t *); |
| 441 | PyAPI_FUNC(int) PyUnicodeDecodeError_GetStart(PyObject *, Py_ssize_t *); |
| 442 | PyAPI_FUNC(int) PyUnicodeTranslateError_GetStart(PyObject *, Py_ssize_t *); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 443 | |
| 444 | /* assign a new value to the start attribute |
| 445 | return 0 on success, -1 on failure */ |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 446 | PyAPI_FUNC(int) PyUnicodeEncodeError_SetStart(PyObject *, Py_ssize_t); |
| 447 | PyAPI_FUNC(int) PyUnicodeDecodeError_SetStart(PyObject *, Py_ssize_t); |
| 448 | PyAPI_FUNC(int) PyUnicodeTranslateError_SetStart(PyObject *, Py_ssize_t); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 449 | |
| 450 | /* get the value of the end attribute (the int *may not be NULL) |
| 451 | return 0 on success, -1 on failure */ |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 452 | PyAPI_FUNC(int) PyUnicodeEncodeError_GetEnd(PyObject *, Py_ssize_t *); |
| 453 | PyAPI_FUNC(int) PyUnicodeDecodeError_GetEnd(PyObject *, Py_ssize_t *); |
| 454 | PyAPI_FUNC(int) PyUnicodeTranslateError_GetEnd(PyObject *, Py_ssize_t *); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 455 | |
| 456 | /* assign a new value to the end attribute |
| 457 | return 0 on success, -1 on failure */ |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 458 | PyAPI_FUNC(int) PyUnicodeEncodeError_SetEnd(PyObject *, Py_ssize_t); |
| 459 | PyAPI_FUNC(int) PyUnicodeDecodeError_SetEnd(PyObject *, Py_ssize_t); |
| 460 | PyAPI_FUNC(int) PyUnicodeTranslateError_SetEnd(PyObject *, Py_ssize_t); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 461 | |
| 462 | /* get the value of the reason attribute */ |
| 463 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetReason(PyObject *); |
| 464 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetReason(PyObject *); |
| 465 | PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetReason(PyObject *); |
| 466 | |
| 467 | /* assign a new value to the reason attribute |
| 468 | return 0 on success, -1 on failure */ |
| 469 | PyAPI_FUNC(int) PyUnicodeEncodeError_SetReason( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 470 | PyObject *exc, |
| 471 | const char *reason /* UTF-8 encoded string */ |
| 472 | ); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 473 | PyAPI_FUNC(int) PyUnicodeDecodeError_SetReason( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 474 | PyObject *exc, |
| 475 | const char *reason /* UTF-8 encoded string */ |
| 476 | ); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 477 | PyAPI_FUNC(int) PyUnicodeTranslateError_SetReason( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 478 | PyObject *exc, |
| 479 | const char *reason /* UTF-8 encoded string */ |
| 480 | ); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 481 | |
Marc-André Lemburg | e5006eb | 2001-07-31 13:24:44 +0000 | [diff] [blame] | 482 | /* These APIs aren't really part of the error implementation, but |
| 483 | often needed to format error messages; the native C lib APIs are |
| 484 | not available on all platforms, which is why we provide emulations |
Tim Peters | a437d45 | 2001-11-28 16:51:49 +0000 | [diff] [blame] | 485 | for those platforms in Python/mysnprintf.c, |
| 486 | WARNING: The return value of snprintf varies across platforms; do |
| 487 | not rely on any particular behavior; eventually the C99 defn may |
| 488 | be reliable. |
| 489 | */ |
Marc-André Lemburg | e5006eb | 2001-07-31 13:24:44 +0000 | [diff] [blame] | 490 | #if defined(MS_WIN32) && !defined(HAVE_SNPRINTF) |
| 491 | # define HAVE_SNPRINTF |
| 492 | # define snprintf _snprintf |
| 493 | # define vsnprintf _vsnprintf |
| 494 | #endif |
Marc-André Lemburg | 03d1b18 | 2001-07-31 18:05:33 +0000 | [diff] [blame] | 495 | |
Marc-André Lemburg | cecd9e0 | 2001-07-31 14:23:52 +0000 | [diff] [blame] | 496 | #include <stdarg.h> |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 497 | PyAPI_FUNC(int) PyOS_snprintf(char *str, size_t size, const char *format, ...) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 498 | Py_GCC_ATTRIBUTE((format(printf, 3, 4))); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 499 | PyAPI_FUNC(int) PyOS_vsnprintf(char *str, size_t size, const char *format, va_list va) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 500 | Py_GCC_ATTRIBUTE((format(printf, 3, 0))); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 501 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 502 | #ifdef __cplusplus |
| 503 | } |
| 504 | #endif |
| 505 | #endif /* !Py_ERRORS_H */ |