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 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 7 | /* Error handling definitions */ |
| 8 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 9 | PyAPI_FUNC(void) PyErr_SetNone(PyObject *); |
| 10 | PyAPI_FUNC(void) PyErr_SetObject(PyObject *, PyObject *); |
Victor Stinner | 257d38f | 2010-10-09 10:12:11 +0000 | [diff] [blame] | 11 | PyAPI_FUNC(void) PyErr_SetString( |
| 12 | PyObject *exception, |
| 13 | const char *string /* decoded from utf-8 */ |
| 14 | ); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 15 | PyAPI_FUNC(PyObject *) PyErr_Occurred(void); |
| 16 | PyAPI_FUNC(void) PyErr_Clear(void); |
| 17 | PyAPI_FUNC(void) PyErr_Fetch(PyObject **, PyObject **, PyObject **); |
| 18 | PyAPI_FUNC(void) PyErr_Restore(PyObject *, PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 19 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000 |
Martin v. Löwis | aa2efcb | 2012-04-19 14:33:43 +0200 | [diff] [blame] | 20 | PyAPI_FUNC(void) PyErr_GetExcInfo(PyObject **, PyObject **, PyObject **); |
| 21 | PyAPI_FUNC(void) PyErr_SetExcInfo(PyObject *, PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 22 | #endif |
Brett Cannon | b94767f | 2011-02-22 20:15:44 +0000 | [diff] [blame] | 23 | |
Nick Coghlan | d600951 | 2014-11-20 21:39:37 +1000 | [diff] [blame] | 24 | /* Defined in Python/pylifecycle.c */ |
Victor Stinner | cfc8831 | 2018-08-01 16:41:25 +0200 | [diff] [blame] | 25 | PyAPI_FUNC(void) _Py_NO_RETURN Py_FatalError(const char *message); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 26 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 27 | #if defined(Py_DEBUG) || defined(Py_LIMITED_API) |
Raymond Hettinger | 5ba0cbe | 2005-08-06 18:31:24 +0000 | [diff] [blame] | 28 | #define _PyErr_OCCURRED() PyErr_Occurred() |
| 29 | #else |
Antoine Pitrou | 59c900d | 2013-10-07 20:38:51 +0200 | [diff] [blame] | 30 | #define _PyErr_OCCURRED() (PyThreadState_GET()->curexc_type) |
Raymond Hettinger | 5ba0cbe | 2005-08-06 18:31:24 +0000 | [diff] [blame] | 31 | #endif |
| 32 | |
Barry Warsaw | c0dc92a | 1997-08-22 21:22:58 +0000 | [diff] [blame] | 33 | /* Error testing and normalization */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 34 | PyAPI_FUNC(int) PyErr_GivenExceptionMatches(PyObject *, PyObject *); |
| 35 | PyAPI_FUNC(int) PyErr_ExceptionMatches(PyObject *); |
| 36 | PyAPI_FUNC(void) PyErr_NormalizeException(PyObject**, PyObject**, PyObject**); |
Barry Warsaw | c0dc92a | 1997-08-22 21:22:58 +0000 | [diff] [blame] | 37 | |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 38 | /* Traceback manipulation (PEP 3134) */ |
| 39 | PyAPI_FUNC(int) PyException_SetTraceback(PyObject *, PyObject *); |
| 40 | PyAPI_FUNC(PyObject *) PyException_GetTraceback(PyObject *); |
| 41 | |
| 42 | /* Cause manipulation (PEP 3134) */ |
| 43 | PyAPI_FUNC(PyObject *) PyException_GetCause(PyObject *); |
| 44 | PyAPI_FUNC(void) PyException_SetCause(PyObject *, PyObject *); |
| 45 | |
| 46 | /* Context manipulation (PEP 3134) */ |
| 47 | PyAPI_FUNC(PyObject *) PyException_GetContext(PyObject *); |
| 48 | PyAPI_FUNC(void) PyException_SetContext(PyObject *, PyObject *); |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 49 | |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 50 | /* */ |
Barry Warsaw | c0dc92a | 1997-08-22 21:22:58 +0000 | [diff] [blame] | 51 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 52 | #define PyExceptionClass_Check(x) \ |
| 53 | (PyType_Check((x)) && \ |
| 54 | PyType_FastSubclass((PyTypeObject*)(x), Py_TPFLAGS_BASE_EXC_SUBCLASS)) |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 55 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 56 | #define PyExceptionInstance_Check(x) \ |
| 57 | PyType_FastSubclass((x)->ob_type, Py_TPFLAGS_BASE_EXC_SUBCLASS) |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 58 | |
Serhiy Storchaka | ceeef10 | 2018-06-15 11:09:43 +0300 | [diff] [blame] | 59 | PyAPI_FUNC(const char *) PyExceptionClass_Name(PyObject *); |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 60 | |
Guido van Rossum | 45aecf4 | 2006-03-15 04:58:47 +0000 | [diff] [blame] | 61 | #define PyExceptionInstance_Class(x) ((PyObject*)((x)->ob_type)) |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 62 | |
Collin Winter | 828f04a | 2007-08-31 00:04:24 +0000 | [diff] [blame] | 63 | |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 64 | /* Predefined exceptions */ |
Guido van Rossum | 5c600e1 | 1990-10-14 20:00:25 +0000 | [diff] [blame] | 65 | |
Brett Cannon | bf36409 | 2006-03-01 04:25:17 +0000 | [diff] [blame] | 66 | PyAPI_DATA(PyObject *) PyExc_BaseException; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 67 | PyAPI_DATA(PyObject *) PyExc_Exception; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 68 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000 |
Yury Selivanov | 7544508 | 2015-05-11 22:57:16 -0400 | [diff] [blame] | 69 | PyAPI_DATA(PyObject *) PyExc_StopAsyncIteration; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 70 | #endif |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 71 | PyAPI_DATA(PyObject *) PyExc_StopIteration; |
Phillip J. Eby | 0d6615f | 2005-08-02 00:46:46 +0000 | [diff] [blame] | 72 | PyAPI_DATA(PyObject *) PyExc_GeneratorExit; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 73 | PyAPI_DATA(PyObject *) PyExc_ArithmeticError; |
| 74 | PyAPI_DATA(PyObject *) PyExc_LookupError; |
Barry Warsaw | 392d827 | 1997-08-29 21:56:07 +0000 | [diff] [blame] | 75 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 76 | PyAPI_DATA(PyObject *) PyExc_AssertionError; |
| 77 | PyAPI_DATA(PyObject *) PyExc_AttributeError; |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 78 | PyAPI_DATA(PyObject *) PyExc_BufferError; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 79 | PyAPI_DATA(PyObject *) PyExc_EOFError; |
| 80 | PyAPI_DATA(PyObject *) PyExc_FloatingPointError; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 81 | PyAPI_DATA(PyObject *) PyExc_OSError; |
| 82 | PyAPI_DATA(PyObject *) PyExc_ImportError; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 83 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03060000 |
Eric Snow | c943265 | 2016-09-07 15:42:32 -0700 | [diff] [blame] | 84 | PyAPI_DATA(PyObject *) PyExc_ModuleNotFoundError; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 85 | #endif |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 86 | PyAPI_DATA(PyObject *) PyExc_IndexError; |
| 87 | PyAPI_DATA(PyObject *) PyExc_KeyError; |
| 88 | PyAPI_DATA(PyObject *) PyExc_KeyboardInterrupt; |
| 89 | PyAPI_DATA(PyObject *) PyExc_MemoryError; |
| 90 | PyAPI_DATA(PyObject *) PyExc_NameError; |
| 91 | PyAPI_DATA(PyObject *) PyExc_OverflowError; |
| 92 | PyAPI_DATA(PyObject *) PyExc_RuntimeError; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 93 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000 |
Yury Selivanov | f488fb4 | 2015-07-03 01:04:23 -0400 | [diff] [blame] | 94 | PyAPI_DATA(PyObject *) PyExc_RecursionError; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 95 | #endif |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 96 | PyAPI_DATA(PyObject *) PyExc_NotImplementedError; |
| 97 | PyAPI_DATA(PyObject *) PyExc_SyntaxError; |
| 98 | PyAPI_DATA(PyObject *) PyExc_IndentationError; |
| 99 | PyAPI_DATA(PyObject *) PyExc_TabError; |
Emily Morehouse | 8f59ee0 | 2019-01-24 16:49:56 -0700 | [diff] [blame] | 100 | PyAPI_DATA(PyObject *) PyExc_TargetScopeError; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 101 | PyAPI_DATA(PyObject *) PyExc_ReferenceError; |
| 102 | PyAPI_DATA(PyObject *) PyExc_SystemError; |
| 103 | PyAPI_DATA(PyObject *) PyExc_SystemExit; |
| 104 | PyAPI_DATA(PyObject *) PyExc_TypeError; |
| 105 | PyAPI_DATA(PyObject *) PyExc_UnboundLocalError; |
| 106 | PyAPI_DATA(PyObject *) PyExc_UnicodeError; |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 107 | PyAPI_DATA(PyObject *) PyExc_UnicodeEncodeError; |
| 108 | PyAPI_DATA(PyObject *) PyExc_UnicodeDecodeError; |
| 109 | PyAPI_DATA(PyObject *) PyExc_UnicodeTranslateError; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 110 | PyAPI_DATA(PyObject *) PyExc_ValueError; |
| 111 | PyAPI_DATA(PyObject *) PyExc_ZeroDivisionError; |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 112 | |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 113 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000 |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 114 | PyAPI_DATA(PyObject *) PyExc_BlockingIOError; |
| 115 | PyAPI_DATA(PyObject *) PyExc_BrokenPipeError; |
| 116 | PyAPI_DATA(PyObject *) PyExc_ChildProcessError; |
| 117 | PyAPI_DATA(PyObject *) PyExc_ConnectionError; |
| 118 | PyAPI_DATA(PyObject *) PyExc_ConnectionAbortedError; |
| 119 | PyAPI_DATA(PyObject *) PyExc_ConnectionRefusedError; |
| 120 | PyAPI_DATA(PyObject *) PyExc_ConnectionResetError; |
| 121 | PyAPI_DATA(PyObject *) PyExc_FileExistsError; |
| 122 | PyAPI_DATA(PyObject *) PyExc_FileNotFoundError; |
| 123 | PyAPI_DATA(PyObject *) PyExc_InterruptedError; |
| 124 | PyAPI_DATA(PyObject *) PyExc_IsADirectoryError; |
| 125 | PyAPI_DATA(PyObject *) PyExc_NotADirectoryError; |
| 126 | PyAPI_DATA(PyObject *) PyExc_PermissionError; |
| 127 | PyAPI_DATA(PyObject *) PyExc_ProcessLookupError; |
| 128 | PyAPI_DATA(PyObject *) PyExc_TimeoutError; |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 129 | #endif |
Antoine Pitrou | 6b4883d | 2011-10-12 02:54:14 +0200 | [diff] [blame] | 130 | |
| 131 | |
| 132 | /* Compatibility aliases */ |
| 133 | PyAPI_DATA(PyObject *) PyExc_EnvironmentError; |
| 134 | PyAPI_DATA(PyObject *) PyExc_IOError; |
Guido van Rossum | db0c9f7 | 2000-02-17 15:17:18 +0000 | [diff] [blame] | 135 | #ifdef MS_WINDOWS |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 136 | PyAPI_DATA(PyObject *) PyExc_WindowsError; |
Guido van Rossum | db0c9f7 | 2000-02-17 15:17:18 +0000 | [diff] [blame] | 137 | #endif |
Guido van Rossum | 3e55cb6 | 1990-10-21 22:09:30 +0000 | [diff] [blame] | 138 | |
Guido van Rossum | 3fc3037 | 2000-12-15 21:57:34 +0000 | [diff] [blame] | 139 | /* Predefined warning categories */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 140 | PyAPI_DATA(PyObject *) PyExc_Warning; |
| 141 | PyAPI_DATA(PyObject *) PyExc_UserWarning; |
| 142 | PyAPI_DATA(PyObject *) PyExc_DeprecationWarning; |
| 143 | PyAPI_DATA(PyObject *) PyExc_PendingDeprecationWarning; |
| 144 | PyAPI_DATA(PyObject *) PyExc_SyntaxWarning; |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 145 | PyAPI_DATA(PyObject *) PyExc_RuntimeWarning; |
Barry Warsaw | 9f00739 | 2002-08-14 15:51:29 +0000 | [diff] [blame] | 146 | PyAPI_DATA(PyObject *) PyExc_FutureWarning; |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 147 | PyAPI_DATA(PyObject *) PyExc_ImportWarning; |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 148 | PyAPI_DATA(PyObject *) PyExc_UnicodeWarning; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 149 | PyAPI_DATA(PyObject *) PyExc_BytesWarning; |
Georg Brandl | 08be72d | 2010-10-24 15:11:22 +0000 | [diff] [blame] | 150 | PyAPI_DATA(PyObject *) PyExc_ResourceWarning; |
Guido van Rossum | 3fc3037 | 2000-12-15 21:57:34 +0000 | [diff] [blame] | 151 | |
Barry Warsaw | 392d827 | 1997-08-29 21:56:07 +0000 | [diff] [blame] | 152 | |
Guido van Rossum | 5c600e1 | 1990-10-14 20:00:25 +0000 | [diff] [blame] | 153 | /* Convenience functions */ |
| 154 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 155 | PyAPI_FUNC(int) PyErr_BadArgument(void); |
| 156 | PyAPI_FUNC(PyObject *) PyErr_NoMemory(void); |
| 157 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrno(PyObject *); |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 158 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilenameObject( |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 159 | PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 160 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03040000 |
Larry Hastings | b082731 | 2014-02-09 22:05:19 -0800 | [diff] [blame] | 161 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilenameObjects( |
| 162 | PyObject *, PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 163 | #endif |
Benjamin Peterson | 78565b2 | 2009-06-28 19:19:51 +0000 | [diff] [blame] | 164 | PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilename( |
Victor Stinner | 257d38f | 2010-10-09 10:12:11 +0000 | [diff] [blame] | 165 | PyObject *exc, |
| 166 | const char *filename /* decoded from the filesystem encoding */ |
| 167 | ); |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 168 | |
Victor Stinner | 1205f27 | 2010-09-11 00:54:47 +0000 | [diff] [blame] | 169 | PyAPI_FUNC(PyObject *) PyErr_Format( |
| 170 | PyObject *exception, |
| 171 | const char *format, /* ASCII-encoded string */ |
| 172 | ... |
| 173 | ); |
Antoine Pitrou | 0676a40 | 2014-09-30 21:16:27 +0200 | [diff] [blame] | 174 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000 |
| 175 | PyAPI_FUNC(PyObject *) PyErr_FormatV( |
| 176 | PyObject *exception, |
| 177 | const char *format, |
| 178 | va_list vargs); |
| 179 | #endif |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 180 | |
Guido van Rossum | db0c9f7 | 2000-02-17 15:17:18 +0000 | [diff] [blame] | 181 | #ifdef MS_WINDOWS |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 182 | PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithFilename( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 183 | int ierr, |
Victor Stinner | b9cb21e | 2010-12-28 00:59:03 +0000 | [diff] [blame] | 184 | const char *filename /* decoded from the filesystem encoding */ |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 185 | ); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 186 | PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErr(int); |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 187 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilenameObject( |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 188 | PyObject *,int, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 189 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03040000 |
Larry Hastings | b082731 | 2014-02-09 22:05:19 -0800 | [diff] [blame] | 190 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilenameObjects( |
| 191 | PyObject *,int, PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 192 | #endif |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 193 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilename( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 194 | PyObject *exc, |
| 195 | int ierr, |
Victor Stinner | b9cb21e | 2010-12-28 00:59:03 +0000 | [diff] [blame] | 196 | const char *filename /* decoded from the filesystem encoding */ |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 197 | ); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 198 | PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErr(PyObject *, int); |
Mark Hammond | c2e85bd | 2002-10-03 05:10:39 +0000 | [diff] [blame] | 199 | #endif /* MS_WINDOWS */ |
Guido van Rossum | 3e55cb6 | 1990-10-21 22:09:30 +0000 | [diff] [blame] | 200 | |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 201 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03060000 |
Eric Snow | 46f97b8 | 2016-09-07 16:56:15 -0700 | [diff] [blame] | 202 | PyAPI_FUNC(PyObject *) PyErr_SetImportErrorSubclass(PyObject *, PyObject *, |
| 203 | PyObject *, PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 204 | #endif |
| 205 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000 |
Brian Curtin | 09b86d1 | 2012-04-17 16:57:09 -0500 | [diff] [blame] | 206 | PyAPI_FUNC(PyObject *) PyErr_SetImportError(PyObject *, PyObject *, |
| 207 | PyObject *); |
Serhiy Storchaka | 34d0ac8 | 2016-12-27 14:57:39 +0200 | [diff] [blame] | 208 | #endif |
Brett Cannon | 79ec55e | 2012-04-12 20:24:54 -0400 | [diff] [blame] | 209 | |
Fred Drake | 6d63adf | 2000-08-24 22:38:39 +0000 | [diff] [blame] | 210 | /* Export the old function so that the existing API remains available: */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 211 | PyAPI_FUNC(void) PyErr_BadInternalCall(void); |
Neal Norwitz | b382b84 | 2007-08-24 20:00:37 +0000 | [diff] [blame] | 212 | PyAPI_FUNC(void) _PyErr_BadInternalCall(const char *filename, int lineno); |
Fred Drake | 6d63adf | 2000-08-24 22:38:39 +0000 | [diff] [blame] | 213 | /* Mask the old API with a call to the new API for code compiled under |
| 214 | Python 2.0: */ |
| 215 | #define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__) |
Guido van Rossum | 2583165 | 1993-05-19 14:50:45 +0000 | [diff] [blame] | 216 | |
Guido van Rossum | 2d2c344 | 1997-09-16 21:50:37 +0000 | [diff] [blame] | 217 | /* Function to create a new exception */ |
Georg Brandl | 1e28a27 | 2009-12-28 08:41:01 +0000 | [diff] [blame] | 218 | PyAPI_FUNC(PyObject *) PyErr_NewException( |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 219 | const char *name, PyObject *base, PyObject *dict); |
Georg Brandl | 1e28a27 | 2009-12-28 08:41:01 +0000 | [diff] [blame] | 220 | PyAPI_FUNC(PyObject *) PyErr_NewExceptionWithDoc( |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 221 | const char *name, const char *doc, PyObject *base, PyObject *dict); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 222 | PyAPI_FUNC(void) PyErr_WriteUnraisable(PyObject *); |
Guido van Rossum | 2d2c344 | 1997-09-16 21:50:37 +0000 | [diff] [blame] | 223 | |
Nick Coghlan | 8b097b4 | 2013-11-13 23:49:21 +1000 | [diff] [blame] | 224 | |
Segev Finer | 7ff1e88 | 2017-05-25 14:00:18 +0300 | [diff] [blame] | 225 | /* In signalmodule.c */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 226 | PyAPI_FUNC(int) PyErr_CheckSignals(void); |
| 227 | PyAPI_FUNC(void) PyErr_SetInterrupt(void); |
Jeremy Hylton | ad3d3f2 | 2001-02-28 17:47:12 +0000 | [diff] [blame] | 228 | |
| 229 | /* Support for adding program text to SyntaxErrors */ |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 230 | PyAPI_FUNC(void) PyErr_SyntaxLocation( |
| 231 | const char *filename, /* decoded from the filesystem encoding */ |
| 232 | int lineno); |
| 233 | PyAPI_FUNC(void) PyErr_SyntaxLocationEx( |
| 234 | const char *filename, /* decoded from the filesystem encoding */ |
| 235 | int lineno, |
| 236 | int col_offset); |
| 237 | PyAPI_FUNC(PyObject *) PyErr_ProgramText( |
| 238 | const char *filename, /* decoded from the filesystem encoding */ |
| 239 | int lineno); |
Tim Peters | a437d45 | 2001-11-28 16:51:49 +0000 | [diff] [blame] | 240 | |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 241 | /* The following functions are used to create and modify unicode |
| 242 | exceptions from C */ |
Walter Dörwald | bf73db8 | 2002-11-21 20:08:33 +0000 | [diff] [blame] | 243 | |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 244 | /* create a UnicodeDecodeError object */ |
| 245 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_Create( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 246 | const char *encoding, /* UTF-8 encoded string */ |
| 247 | const char *object, |
| 248 | Py_ssize_t length, |
| 249 | Py_ssize_t start, |
| 250 | Py_ssize_t end, |
| 251 | const char *reason /* UTF-8 encoded string */ |
| 252 | ); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 253 | |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 254 | /* get the encoding attribute */ |
| 255 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetEncoding(PyObject *); |
| 256 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetEncoding(PyObject *); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 257 | |
| 258 | /* get the object attribute */ |
| 259 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetObject(PyObject *); |
| 260 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetObject(PyObject *); |
| 261 | PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetObject(PyObject *); |
| 262 | |
| 263 | /* get the value of the start attribute (the int * may not be NULL) |
| 264 | return 0 on success, -1 on failure */ |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 265 | PyAPI_FUNC(int) PyUnicodeEncodeError_GetStart(PyObject *, Py_ssize_t *); |
| 266 | PyAPI_FUNC(int) PyUnicodeDecodeError_GetStart(PyObject *, Py_ssize_t *); |
| 267 | PyAPI_FUNC(int) PyUnicodeTranslateError_GetStart(PyObject *, Py_ssize_t *); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 268 | |
| 269 | /* assign a new value to the start attribute |
| 270 | return 0 on success, -1 on failure */ |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 271 | PyAPI_FUNC(int) PyUnicodeEncodeError_SetStart(PyObject *, Py_ssize_t); |
| 272 | PyAPI_FUNC(int) PyUnicodeDecodeError_SetStart(PyObject *, Py_ssize_t); |
| 273 | PyAPI_FUNC(int) PyUnicodeTranslateError_SetStart(PyObject *, Py_ssize_t); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 274 | |
| 275 | /* get the value of the end attribute (the int *may not be NULL) |
| 276 | return 0 on success, -1 on failure */ |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 277 | PyAPI_FUNC(int) PyUnicodeEncodeError_GetEnd(PyObject *, Py_ssize_t *); |
| 278 | PyAPI_FUNC(int) PyUnicodeDecodeError_GetEnd(PyObject *, Py_ssize_t *); |
| 279 | PyAPI_FUNC(int) PyUnicodeTranslateError_GetEnd(PyObject *, Py_ssize_t *); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 280 | |
| 281 | /* assign a new value to the end attribute |
| 282 | return 0 on success, -1 on failure */ |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 283 | PyAPI_FUNC(int) PyUnicodeEncodeError_SetEnd(PyObject *, Py_ssize_t); |
| 284 | PyAPI_FUNC(int) PyUnicodeDecodeError_SetEnd(PyObject *, Py_ssize_t); |
| 285 | PyAPI_FUNC(int) PyUnicodeTranslateError_SetEnd(PyObject *, Py_ssize_t); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 286 | |
| 287 | /* get the value of the reason attribute */ |
| 288 | PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetReason(PyObject *); |
| 289 | PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetReason(PyObject *); |
| 290 | PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetReason(PyObject *); |
| 291 | |
| 292 | /* assign a new value to the reason attribute |
| 293 | return 0 on success, -1 on failure */ |
| 294 | PyAPI_FUNC(int) PyUnicodeEncodeError_SetReason( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 295 | PyObject *exc, |
| 296 | const char *reason /* UTF-8 encoded string */ |
| 297 | ); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 298 | PyAPI_FUNC(int) PyUnicodeDecodeError_SetReason( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 299 | PyObject *exc, |
| 300 | const char *reason /* UTF-8 encoded string */ |
| 301 | ); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 302 | PyAPI_FUNC(int) PyUnicodeTranslateError_SetReason( |
Victor Stinner | 555a24f | 2010-12-27 01:49:26 +0000 | [diff] [blame] | 303 | PyObject *exc, |
| 304 | const char *reason /* UTF-8 encoded string */ |
| 305 | ); |
Walter Dörwald | 3aeb632 | 2002-09-02 13:14:32 +0000 | [diff] [blame] | 306 | |
Marc-André Lemburg | e5006eb | 2001-07-31 13:24:44 +0000 | [diff] [blame] | 307 | /* These APIs aren't really part of the error implementation, but |
| 308 | often needed to format error messages; the native C lib APIs are |
| 309 | not available on all platforms, which is why we provide emulations |
Tim Peters | a437d45 | 2001-11-28 16:51:49 +0000 | [diff] [blame] | 310 | for those platforms in Python/mysnprintf.c, |
| 311 | WARNING: The return value of snprintf varies across platforms; do |
| 312 | not rely on any particular behavior; eventually the C99 defn may |
| 313 | be reliable. |
| 314 | */ |
Marc-André Lemburg | e5006eb | 2001-07-31 13:24:44 +0000 | [diff] [blame] | 315 | #if defined(MS_WIN32) && !defined(HAVE_SNPRINTF) |
| 316 | # define HAVE_SNPRINTF |
| 317 | # define snprintf _snprintf |
| 318 | # define vsnprintf _vsnprintf |
| 319 | #endif |
Marc-André Lemburg | 03d1b18 | 2001-07-31 18:05:33 +0000 | [diff] [blame] | 320 | |
Marc-André Lemburg | cecd9e0 | 2001-07-31 14:23:52 +0000 | [diff] [blame] | 321 | #include <stdarg.h> |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 322 | 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] | 323 | Py_GCC_ATTRIBUTE((format(printf, 3, 4))); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 324 | 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] | 325 | Py_GCC_ATTRIBUTE((format(printf, 3, 0))); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 326 | |
Victor Stinner | 5a8c240 | 2018-11-26 22:11:25 +0100 | [diff] [blame] | 327 | #ifndef Py_LIMITED_API |
| 328 | # define Py_CPYTHON_ERRORS_H |
| 329 | # include "cpython/pyerrors.h" |
| 330 | # undef Py_CPYTHON_ERRORS_H |
| 331 | #endif |
| 332 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 333 | #ifdef __cplusplus |
| 334 | } |
| 335 | #endif |
| 336 | #endif /* !Py_ERRORS_H */ |