blob: 1bd04425465add568a5baab46ee65c907c981452 [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_ERRORS_H
2#define Py_ERRORS_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Thomas Wouters477c8d52006-05-27 19:21:47 +00007/* Error objects */
8
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00009#ifndef Py_LIMITED_API
Collin Winter828f04a2007-08-31 00:04:24 +000010/* PyException_HEAD defines the initial segment of every exception class. */
Collin Winter231ff0e2007-08-31 00:59:38 +000011#define PyException_HEAD PyObject_HEAD PyObject *dict;\
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000012 PyObject *args; PyObject *traceback;\
13 PyObject *context; PyObject *cause;
Collin Winter828f04a2007-08-31 00:04:24 +000014
Thomas Wouters477c8d52006-05-27 19:21:47 +000015typedef struct {
Collin Winter828f04a2007-08-31 00:04:24 +000016 PyException_HEAD
Thomas Wouters477c8d52006-05-27 19:21:47 +000017} PyBaseExceptionObject;
18
19typedef struct {
Collin Winter828f04a2007-08-31 00:04:24 +000020 PyException_HEAD
Thomas Wouters477c8d52006-05-27 19:21:47 +000021 PyObject *msg;
22 PyObject *filename;
23 PyObject *lineno;
24 PyObject *offset;
25 PyObject *text;
26 PyObject *print_file_and_line;
27} PySyntaxErrorObject;
28
Thomas Wouters477c8d52006-05-27 19:21:47 +000029typedef struct {
Collin Winter828f04a2007-08-31 00:04:24 +000030 PyException_HEAD
Thomas Wouters477c8d52006-05-27 19:21:47 +000031 PyObject *encoding;
32 PyObject *object;
Guido van Rossum7eaf8222007-06-18 17:58:50 +000033 Py_ssize_t start;
34 Py_ssize_t end;
Thomas Wouters477c8d52006-05-27 19:21:47 +000035 PyObject *reason;
36} PyUnicodeErrorObject;
Thomas Wouters477c8d52006-05-27 19:21:47 +000037
38typedef struct {
Collin Winter828f04a2007-08-31 00:04:24 +000039 PyException_HEAD
Thomas Wouters477c8d52006-05-27 19:21:47 +000040 PyObject *code;
41} PySystemExitObject;
42
43typedef struct {
Collin Winter828f04a2007-08-31 00:04:24 +000044 PyException_HEAD
Thomas Wouters477c8d52006-05-27 19:21:47 +000045 PyObject *myerrno;
46 PyObject *strerror;
47 PyObject *filename;
Thomas Wouters477c8d52006-05-27 19:21:47 +000048#ifdef MS_WINDOWS
Thomas Wouters477c8d52006-05-27 19:21:47 +000049 PyObject *winerror;
Thomas Wouters477c8d52006-05-27 19:21:47 +000050#endif
Antoine Pitrou6b4883d2011-10-12 02:54:14 +020051 Py_ssize_t written; /* only for BlockingIOError, -1 otherwise */
52} PyOSErrorObject;
53
Nick Coghlan1f7ce622012-01-13 21:43:40 +100054typedef struct {
55 PyException_HEAD
56 PyObject *value;
57} PyStopIterationObject;
58
Antoine Pitrou6b4883d2011-10-12 02:54:14 +020059/* Compatibility typedefs */
60typedef PyOSErrorObject PyEnvironmentErrorObject;
61#ifdef MS_WINDOWS
62typedef PyOSErrorObject PyWindowsErrorObject;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000063#endif
Antoine Pitrou6b4883d2011-10-12 02:54:14 +020064#endif /* !Py_LIMITED_API */
Guido van Rossumf70e43a1991-02-19 12:39:46 +000065
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000066/* Error handling definitions */
67
Mark Hammond91a681d2002-08-12 07:21:58 +000068PyAPI_FUNC(void) PyErr_SetNone(PyObject *);
69PyAPI_FUNC(void) PyErr_SetObject(PyObject *, PyObject *);
Victor Stinner257d38f2010-10-09 10:12:11 +000070PyAPI_FUNC(void) PyErr_SetString(
71 PyObject *exception,
72 const char *string /* decoded from utf-8 */
73 );
Mark Hammond91a681d2002-08-12 07:21:58 +000074PyAPI_FUNC(PyObject *) PyErr_Occurred(void);
75PyAPI_FUNC(void) PyErr_Clear(void);
76PyAPI_FUNC(void) PyErr_Fetch(PyObject **, PyObject **, PyObject **);
77PyAPI_FUNC(void) PyErr_Restore(PyObject *, PyObject *, PyObject *);
Brett Cannonb94767f2011-02-22 20:15:44 +000078
79#if defined(__clang__) || \
80 (defined(__GNUC__) && \
81 ((__GNUC_MAJOR__ >= 3) || \
82 (__GNUC_MAJOR__ == 2) && (__GNUC_MINOR__ >= 5)))
83#define _Py_NO_RETURN __attribute__((__noreturn__))
84#else
85#define _Py_NO_RETURN
86#endif
87
88PyAPI_FUNC(void) Py_FatalError(const char *message) _Py_NO_RETURN;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000089
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000090#if defined(Py_DEBUG) || defined(Py_LIMITED_API)
Raymond Hettinger5ba0cbe2005-08-06 18:31:24 +000091#define _PyErr_OCCURRED() PyErr_Occurred()
92#else
93#define _PyErr_OCCURRED() (_PyThreadState_Current->curexc_type)
94#endif
95
Barry Warsawc0dc92a1997-08-22 21:22:58 +000096/* Error testing and normalization */
Mark Hammond91a681d2002-08-12 07:21:58 +000097PyAPI_FUNC(int) PyErr_GivenExceptionMatches(PyObject *, PyObject *);
98PyAPI_FUNC(int) PyErr_ExceptionMatches(PyObject *);
99PyAPI_FUNC(void) PyErr_NormalizeException(PyObject**, PyObject**, PyObject**);
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000100
Collin Winter828f04a2007-08-31 00:04:24 +0000101/* Traceback manipulation (PEP 3134) */
102PyAPI_FUNC(int) PyException_SetTraceback(PyObject *, PyObject *);
103PyAPI_FUNC(PyObject *) PyException_GetTraceback(PyObject *);
104
105/* Cause manipulation (PEP 3134) */
106PyAPI_FUNC(PyObject *) PyException_GetCause(PyObject *);
107PyAPI_FUNC(void) PyException_SetCause(PyObject *, PyObject *);
108
109/* Context manipulation (PEP 3134) */
110PyAPI_FUNC(PyObject *) PyException_GetContext(PyObject *);
111PyAPI_FUNC(void) PyException_SetContext(PyObject *, PyObject *);
112
113
Brett Cannonbf364092006-03-01 04:25:17 +0000114/* */
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000115
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000116#define PyExceptionClass_Check(x) \
117 (PyType_Check((x)) && \
118 PyType_FastSubclass((PyTypeObject*)(x), Py_TPFLAGS_BASE_EXC_SUBCLASS))
Brett Cannonbf364092006-03-01 04:25:17 +0000119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000120#define PyExceptionInstance_Check(x) \
121 PyType_FastSubclass((x)->ob_type, Py_TPFLAGS_BASE_EXC_SUBCLASS)
Brett Cannonbf364092006-03-01 04:25:17 +0000122
Guido van Rossum45aecf42006-03-15 04:58:47 +0000123#define PyExceptionClass_Name(x) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000124 ((char *)(((PyTypeObject*)(x))->tp_name))
Brett Cannonbf364092006-03-01 04:25:17 +0000125
Guido van Rossum45aecf42006-03-15 04:58:47 +0000126#define PyExceptionInstance_Class(x) ((PyObject*)((x)->ob_type))
Brett Cannonbf364092006-03-01 04:25:17 +0000127
Collin Winter828f04a2007-08-31 00:04:24 +0000128
Guido van Rossum3f5da241990-12-20 15:06:42 +0000129/* Predefined exceptions */
Guido van Rossum5c600e11990-10-14 20:00:25 +0000130
Brett Cannonbf364092006-03-01 04:25:17 +0000131PyAPI_DATA(PyObject *) PyExc_BaseException;
Mark Hammond91a681d2002-08-12 07:21:58 +0000132PyAPI_DATA(PyObject *) PyExc_Exception;
133PyAPI_DATA(PyObject *) PyExc_StopIteration;
Phillip J. Eby0d6615f2005-08-02 00:46:46 +0000134PyAPI_DATA(PyObject *) PyExc_GeneratorExit;
Mark Hammond91a681d2002-08-12 07:21:58 +0000135PyAPI_DATA(PyObject *) PyExc_ArithmeticError;
136PyAPI_DATA(PyObject *) PyExc_LookupError;
Barry Warsaw392d8271997-08-29 21:56:07 +0000137
Mark Hammond91a681d2002-08-12 07:21:58 +0000138PyAPI_DATA(PyObject *) PyExc_AssertionError;
139PyAPI_DATA(PyObject *) PyExc_AttributeError;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200140PyAPI_DATA(PyObject *) PyExc_BufferError;
Mark Hammond91a681d2002-08-12 07:21:58 +0000141PyAPI_DATA(PyObject *) PyExc_EOFError;
142PyAPI_DATA(PyObject *) PyExc_FloatingPointError;
Mark Hammond91a681d2002-08-12 07:21:58 +0000143PyAPI_DATA(PyObject *) PyExc_OSError;
144PyAPI_DATA(PyObject *) PyExc_ImportError;
145PyAPI_DATA(PyObject *) PyExc_IndexError;
146PyAPI_DATA(PyObject *) PyExc_KeyError;
147PyAPI_DATA(PyObject *) PyExc_KeyboardInterrupt;
148PyAPI_DATA(PyObject *) PyExc_MemoryError;
149PyAPI_DATA(PyObject *) PyExc_NameError;
150PyAPI_DATA(PyObject *) PyExc_OverflowError;
151PyAPI_DATA(PyObject *) PyExc_RuntimeError;
152PyAPI_DATA(PyObject *) PyExc_NotImplementedError;
153PyAPI_DATA(PyObject *) PyExc_SyntaxError;
154PyAPI_DATA(PyObject *) PyExc_IndentationError;
155PyAPI_DATA(PyObject *) PyExc_TabError;
156PyAPI_DATA(PyObject *) PyExc_ReferenceError;
157PyAPI_DATA(PyObject *) PyExc_SystemError;
158PyAPI_DATA(PyObject *) PyExc_SystemExit;
159PyAPI_DATA(PyObject *) PyExc_TypeError;
160PyAPI_DATA(PyObject *) PyExc_UnboundLocalError;
161PyAPI_DATA(PyObject *) PyExc_UnicodeError;
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000162PyAPI_DATA(PyObject *) PyExc_UnicodeEncodeError;
163PyAPI_DATA(PyObject *) PyExc_UnicodeDecodeError;
164PyAPI_DATA(PyObject *) PyExc_UnicodeTranslateError;
Mark Hammond91a681d2002-08-12 07:21:58 +0000165PyAPI_DATA(PyObject *) PyExc_ValueError;
166PyAPI_DATA(PyObject *) PyExc_ZeroDivisionError;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200167
168PyAPI_DATA(PyObject *) PyExc_BlockingIOError;
169PyAPI_DATA(PyObject *) PyExc_BrokenPipeError;
170PyAPI_DATA(PyObject *) PyExc_ChildProcessError;
171PyAPI_DATA(PyObject *) PyExc_ConnectionError;
172PyAPI_DATA(PyObject *) PyExc_ConnectionAbortedError;
173PyAPI_DATA(PyObject *) PyExc_ConnectionRefusedError;
174PyAPI_DATA(PyObject *) PyExc_ConnectionResetError;
175PyAPI_DATA(PyObject *) PyExc_FileExistsError;
176PyAPI_DATA(PyObject *) PyExc_FileNotFoundError;
177PyAPI_DATA(PyObject *) PyExc_InterruptedError;
178PyAPI_DATA(PyObject *) PyExc_IsADirectoryError;
179PyAPI_DATA(PyObject *) PyExc_NotADirectoryError;
180PyAPI_DATA(PyObject *) PyExc_PermissionError;
181PyAPI_DATA(PyObject *) PyExc_ProcessLookupError;
182PyAPI_DATA(PyObject *) PyExc_TimeoutError;
183
184
185/* Compatibility aliases */
186PyAPI_DATA(PyObject *) PyExc_EnvironmentError;
187PyAPI_DATA(PyObject *) PyExc_IOError;
Guido van Rossumdb0c9f72000-02-17 15:17:18 +0000188#ifdef MS_WINDOWS
Mark Hammond91a681d2002-08-12 07:21:58 +0000189PyAPI_DATA(PyObject *) PyExc_WindowsError;
Guido van Rossumdb0c9f72000-02-17 15:17:18 +0000190#endif
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000191#ifdef __VMS
Neal Norwitz21d896c2003-07-01 20:15:21 +0000192PyAPI_DATA(PyObject *) PyExc_VMSError;
Martin v. Löwis79acb9e2002-12-06 12:48:53 +0000193#endif
Guido van Rossum3e55cb61990-10-21 22:09:30 +0000194
Thomas Wouters89d996e2007-09-08 17:39:28 +0000195PyAPI_DATA(PyObject *) PyExc_RecursionErrorInst;
Barry Warsaw392d8271997-08-29 21:56:07 +0000196
Guido van Rossum3fc30372000-12-15 21:57:34 +0000197/* Predefined warning categories */
Mark Hammond91a681d2002-08-12 07:21:58 +0000198PyAPI_DATA(PyObject *) PyExc_Warning;
199PyAPI_DATA(PyObject *) PyExc_UserWarning;
200PyAPI_DATA(PyObject *) PyExc_DeprecationWarning;
201PyAPI_DATA(PyObject *) PyExc_PendingDeprecationWarning;
202PyAPI_DATA(PyObject *) PyExc_SyntaxWarning;
Mark Hammond91a681d2002-08-12 07:21:58 +0000203PyAPI_DATA(PyObject *) PyExc_RuntimeWarning;
Barry Warsaw9f007392002-08-14 15:51:29 +0000204PyAPI_DATA(PyObject *) PyExc_FutureWarning;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000205PyAPI_DATA(PyObject *) PyExc_ImportWarning;
Thomas Wouters00ee7ba2006-08-21 19:07:27 +0000206PyAPI_DATA(PyObject *) PyExc_UnicodeWarning;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000207PyAPI_DATA(PyObject *) PyExc_BytesWarning;
Georg Brandl08be72d2010-10-24 15:11:22 +0000208PyAPI_DATA(PyObject *) PyExc_ResourceWarning;
Guido van Rossum3fc30372000-12-15 21:57:34 +0000209
Barry Warsaw392d8271997-08-29 21:56:07 +0000210
Guido van Rossum5c600e11990-10-14 20:00:25 +0000211/* Convenience functions */
212
Mark Hammond91a681d2002-08-12 07:21:58 +0000213PyAPI_FUNC(int) PyErr_BadArgument(void);
214PyAPI_FUNC(PyObject *) PyErr_NoMemory(void);
215PyAPI_FUNC(PyObject *) PyErr_SetFromErrno(PyObject *);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000216PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilenameObject(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000217 PyObject *, PyObject *);
Benjamin Peterson78565b22009-06-28 19:19:51 +0000218PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithFilename(
Victor Stinner257d38f2010-10-09 10:12:11 +0000219 PyObject *exc,
220 const char *filename /* decoded from the filesystem encoding */
221 );
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000222#if defined(MS_WINDOWS) && !defined(Py_LIMITED_API)
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000223PyAPI_FUNC(PyObject *) PyErr_SetFromErrnoWithUnicodeFilename(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000224 PyObject *, const Py_UNICODE *);
Hirokazu Yamamoto8223c242009-05-17 04:21:53 +0000225#endif /* MS_WINDOWS */
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000226
Victor Stinner1205f272010-09-11 00:54:47 +0000227PyAPI_FUNC(PyObject *) PyErr_Format(
228 PyObject *exception,
229 const char *format, /* ASCII-encoded string */
230 ...
231 );
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000232
Guido van Rossumdb0c9f72000-02-17 15:17:18 +0000233#ifdef MS_WINDOWS
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000234PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithFilename(
Victor Stinner555a24f2010-12-27 01:49:26 +0000235 int ierr,
Victor Stinnerb9cb21e2010-12-28 00:59:03 +0000236 const char *filename /* decoded from the filesystem encoding */
Victor Stinner555a24f2010-12-27 01:49:26 +0000237 );
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000238#ifndef Py_LIMITED_API
239/* XXX redeclare to use WSTRING */
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000240PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErrWithUnicodeFilename(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000241 int, const Py_UNICODE *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000242#endif
Mark Hammond91a681d2002-08-12 07:21:58 +0000243PyAPI_FUNC(PyObject *) PyErr_SetFromWindowsErr(int);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000244PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilenameObject(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000245 PyObject *,int, PyObject *);
Mark Hammond91a681d2002-08-12 07:21:58 +0000246PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithFilename(
Victor Stinner555a24f2010-12-27 01:49:26 +0000247 PyObject *exc,
248 int ierr,
Victor Stinnerb9cb21e2010-12-28 00:59:03 +0000249 const char *filename /* decoded from the filesystem encoding */
Victor Stinner555a24f2010-12-27 01:49:26 +0000250 );
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000251#ifndef Py_LIMITED_API
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000252PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErrWithUnicodeFilename(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000253 PyObject *,int, const Py_UNICODE *);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000254#endif
Mark Hammond91a681d2002-08-12 07:21:58 +0000255PyAPI_FUNC(PyObject *) PyErr_SetExcFromWindowsErr(PyObject *, int);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000256#endif /* MS_WINDOWS */
Guido van Rossum3e55cb61990-10-21 22:09:30 +0000257
Fred Drake6d63adf2000-08-24 22:38:39 +0000258/* Export the old function so that the existing API remains available: */
Mark Hammond91a681d2002-08-12 07:21:58 +0000259PyAPI_FUNC(void) PyErr_BadInternalCall(void);
Neal Norwitzb382b842007-08-24 20:00:37 +0000260PyAPI_FUNC(void) _PyErr_BadInternalCall(const char *filename, int lineno);
Fred Drake6d63adf2000-08-24 22:38:39 +0000261/* Mask the old API with a call to the new API for code compiled under
262 Python 2.0: */
263#define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__)
Guido van Rossum25831651993-05-19 14:50:45 +0000264
Guido van Rossum2d2c3441997-09-16 21:50:37 +0000265/* Function to create a new exception */
Georg Brandl1e28a272009-12-28 08:41:01 +0000266PyAPI_FUNC(PyObject *) PyErr_NewException(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000267 const char *name, PyObject *base, PyObject *dict);
Georg Brandl1e28a272009-12-28 08:41:01 +0000268PyAPI_FUNC(PyObject *) PyErr_NewExceptionWithDoc(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000269 const char *name, const char *doc, PyObject *base, PyObject *dict);
Mark Hammond91a681d2002-08-12 07:21:58 +0000270PyAPI_FUNC(void) PyErr_WriteUnraisable(PyObject *);
Guido van Rossum2d2c3441997-09-16 21:50:37 +0000271
Barry Warsawf3f41a91997-01-03 00:15:03 +0000272/* In sigcheck.c or signalmodule.c */
Mark Hammond91a681d2002-08-12 07:21:58 +0000273PyAPI_FUNC(int) PyErr_CheckSignals(void);
274PyAPI_FUNC(void) PyErr_SetInterrupt(void);
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000275
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000276/* In signalmodule.c */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000277#ifndef Py_LIMITED_API
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000278int PySignal_SetWakeupFd(int fd);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000279#endif
Christian Heimes5fb7c2a2007-12-24 08:52:31 +0000280
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000281/* Support for adding program text to SyntaxErrors */
Victor Stinner555a24f2010-12-27 01:49:26 +0000282PyAPI_FUNC(void) PyErr_SyntaxLocation(
283 const char *filename, /* decoded from the filesystem encoding */
284 int lineno);
285PyAPI_FUNC(void) PyErr_SyntaxLocationEx(
286 const char *filename, /* decoded from the filesystem encoding */
287 int lineno,
288 int col_offset);
289PyAPI_FUNC(PyObject *) PyErr_ProgramText(
290 const char *filename, /* decoded from the filesystem encoding */
291 int lineno);
Tim Petersa437d452001-11-28 16:51:49 +0000292
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000293/* The following functions are used to create and modify unicode
294 exceptions from C */
Walter Dörwaldbf73db82002-11-21 20:08:33 +0000295
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000296/* create a UnicodeDecodeError object */
297PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_Create(
Victor Stinner555a24f2010-12-27 01:49:26 +0000298 const char *encoding, /* UTF-8 encoded string */
299 const char *object,
300 Py_ssize_t length,
301 Py_ssize_t start,
302 Py_ssize_t end,
303 const char *reason /* UTF-8 encoded string */
304 );
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000305
306/* create a UnicodeEncodeError object */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000307#ifndef Py_LIMITED_API
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000308PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_Create(
Victor Stinner555a24f2010-12-27 01:49:26 +0000309 const char *encoding, /* UTF-8 encoded string */
310 const Py_UNICODE *object,
311 Py_ssize_t length,
312 Py_ssize_t start,
313 Py_ssize_t end,
314 const char *reason /* UTF-8 encoded string */
315 );
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000316#endif
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000317
318/* create a UnicodeTranslateError object */
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000319#ifndef Py_LIMITED_API
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000320PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_Create(
Victor Stinner555a24f2010-12-27 01:49:26 +0000321 const Py_UNICODE *object,
322 Py_ssize_t length,
323 Py_ssize_t start,
324 Py_ssize_t end,
325 const char *reason /* UTF-8 encoded string */
326 );
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200327PyAPI_FUNC(PyObject *) _PyUnicodeTranslateError_Create(
328 PyObject *object,
329 Py_ssize_t start,
330 Py_ssize_t end,
331 const char *reason /* UTF-8 encoded string */
332 );
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000333#endif
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000334
335/* get the encoding attribute */
336PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetEncoding(PyObject *);
337PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetEncoding(PyObject *);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000338
339/* get the object attribute */
340PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetObject(PyObject *);
341PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetObject(PyObject *);
342PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetObject(PyObject *);
343
344/* get the value of the start attribute (the int * may not be NULL)
345 return 0 on success, -1 on failure */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000346PyAPI_FUNC(int) PyUnicodeEncodeError_GetStart(PyObject *, Py_ssize_t *);
347PyAPI_FUNC(int) PyUnicodeDecodeError_GetStart(PyObject *, Py_ssize_t *);
348PyAPI_FUNC(int) PyUnicodeTranslateError_GetStart(PyObject *, Py_ssize_t *);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000349
350/* assign a new value to the start attribute
351 return 0 on success, -1 on failure */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000352PyAPI_FUNC(int) PyUnicodeEncodeError_SetStart(PyObject *, Py_ssize_t);
353PyAPI_FUNC(int) PyUnicodeDecodeError_SetStart(PyObject *, Py_ssize_t);
354PyAPI_FUNC(int) PyUnicodeTranslateError_SetStart(PyObject *, Py_ssize_t);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000355
356/* get the value of the end attribute (the int *may not be NULL)
357 return 0 on success, -1 on failure */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000358PyAPI_FUNC(int) PyUnicodeEncodeError_GetEnd(PyObject *, Py_ssize_t *);
359PyAPI_FUNC(int) PyUnicodeDecodeError_GetEnd(PyObject *, Py_ssize_t *);
360PyAPI_FUNC(int) PyUnicodeTranslateError_GetEnd(PyObject *, Py_ssize_t *);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000361
362/* assign a new value to the end attribute
363 return 0 on success, -1 on failure */
Martin v. Löwis18e16552006-02-15 17:27:45 +0000364PyAPI_FUNC(int) PyUnicodeEncodeError_SetEnd(PyObject *, Py_ssize_t);
365PyAPI_FUNC(int) PyUnicodeDecodeError_SetEnd(PyObject *, Py_ssize_t);
366PyAPI_FUNC(int) PyUnicodeTranslateError_SetEnd(PyObject *, Py_ssize_t);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000367
368/* get the value of the reason attribute */
369PyAPI_FUNC(PyObject *) PyUnicodeEncodeError_GetReason(PyObject *);
370PyAPI_FUNC(PyObject *) PyUnicodeDecodeError_GetReason(PyObject *);
371PyAPI_FUNC(PyObject *) PyUnicodeTranslateError_GetReason(PyObject *);
372
373/* assign a new value to the reason attribute
374 return 0 on success, -1 on failure */
375PyAPI_FUNC(int) PyUnicodeEncodeError_SetReason(
Victor Stinner555a24f2010-12-27 01:49:26 +0000376 PyObject *exc,
377 const char *reason /* UTF-8 encoded string */
378 );
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000379PyAPI_FUNC(int) PyUnicodeDecodeError_SetReason(
Victor Stinner555a24f2010-12-27 01:49:26 +0000380 PyObject *exc,
381 const char *reason /* UTF-8 encoded string */
382 );
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000383PyAPI_FUNC(int) PyUnicodeTranslateError_SetReason(
Victor Stinner555a24f2010-12-27 01:49:26 +0000384 PyObject *exc,
385 const char *reason /* UTF-8 encoded string */
386 );
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000387
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000388/* create a StopIteration exception with the given value */
389PyAPI_FUNC(PyObject *) PyStopIteration_Create(PyObject *);
Walter Dörwald3aeb6322002-09-02 13:14:32 +0000390
Marc-André Lemburge5006eb2001-07-31 13:24:44 +0000391/* These APIs aren't really part of the error implementation, but
392 often needed to format error messages; the native C lib APIs are
393 not available on all platforms, which is why we provide emulations
Tim Petersa437d452001-11-28 16:51:49 +0000394 for those platforms in Python/mysnprintf.c,
395 WARNING: The return value of snprintf varies across platforms; do
396 not rely on any particular behavior; eventually the C99 defn may
397 be reliable.
398*/
Marc-André Lemburge5006eb2001-07-31 13:24:44 +0000399#if defined(MS_WIN32) && !defined(HAVE_SNPRINTF)
400# define HAVE_SNPRINTF
401# define snprintf _snprintf
402# define vsnprintf _vsnprintf
403#endif
Marc-André Lemburg03d1b182001-07-31 18:05:33 +0000404
Marc-André Lemburgcecd9e02001-07-31 14:23:52 +0000405#include <stdarg.h>
Mark Hammond91a681d2002-08-12 07:21:58 +0000406PyAPI_FUNC(int) PyOS_snprintf(char *str, size_t size, const char *format, ...)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000407 Py_GCC_ATTRIBUTE((format(printf, 3, 4)));
Mark Hammond91a681d2002-08-12 07:21:58 +0000408PyAPI_FUNC(int) PyOS_vsnprintf(char *str, size_t size, const char *format, va_list va)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000409 Py_GCC_ATTRIBUTE((format(printf, 3, 0)));
Guido van Rossumb6775db1994-08-01 11:34:53 +0000410
Guido van Rossuma3309961993-07-28 09:05:47 +0000411#ifdef __cplusplus
412}
413#endif
414#endif /* !Py_ERRORS_H */