Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / cpython3 / 03d1b1814b367baf8a52389b5a7d7805dba1f68a / . / Include / pyerrors.h
blob: 1ee4fe2fab0572cdadead1bf94e89c0ead5cdd4e [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +0000[diff] [blame]1#ifndef Py_ERRORS_H
2#define Py_ERRORS_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumf70e43a1991-02-19 12:39:46 +0000[diff] [blame]7
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000[diff] [blame]8/* Error handling definitions */
9
Fred Draked5c84ed2000-07-08 17:25:55 +0000[diff] [blame]10DL_IMPORT(void) PyErr_SetNone(PyObject *);
11DL_IMPORT(void) PyErr_SetObject(PyObject *, PyObject *);
12DL_IMPORT(void) PyErr_SetString(PyObject *, const char *);
13DL_IMPORT(PyObject *) PyErr_Occurred(void);
14DL_IMPORT(void) PyErr_Clear(void);
15DL_IMPORT(void) PyErr_Fetch(PyObject **, PyObject **, PyObject **);
16DL_IMPORT(void) PyErr_Restore(PyObject *, PyObject *, PyObject *);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000[diff] [blame]17
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000[diff] [blame]18/* Error testing and normalization */
Fred Draked5c84ed2000-07-08 17:25:55 +0000[diff] [blame]19DL_IMPORT(int) PyErr_GivenExceptionMatches(PyObject *, PyObject *);
20DL_IMPORT(int) PyErr_ExceptionMatches(PyObject *);
21DL_IMPORT(void) PyErr_NormalizeException(PyObject**, PyObject**, PyObject**);
Barry Warsawc0dc92a1997-08-22 21:22:58 +0000[diff] [blame]22
23
Guido van Rossum3f5da241990-12-20 15:06:42 +0000[diff] [blame]24/* Predefined exceptions */
Guido van Rossum5c600e11990-10-14 20:00:25 +0000[diff] [blame]25
Guido van Rossum04748321997-09-16 18:43:15 +0000[diff] [blame]26extern DL_IMPORT(PyObject *) PyExc_Exception;
Guido van Rossum59d1d2b2001-04-20 19:13:02 +0000[diff] [blame]27extern DL_IMPORT(PyObject *) PyExc_StopIteration;
Barry Warsaw392d8271997-08-29 21:56:07 +0000[diff] [blame]28extern DL_IMPORT(PyObject *) PyExc_StandardError;
Barry Warsaw65349a31997-09-16 21:50:36 +0000[diff] [blame]29extern DL_IMPORT(PyObject *) PyExc_ArithmeticError;
Barry Warsaw392d8271997-08-29 21:56:07 +0000[diff] [blame]30extern DL_IMPORT(PyObject *) PyExc_LookupError;
31
Guido van Rossum6fa44661997-04-02 05:22:53 +0000[diff] [blame]32extern DL_IMPORT(PyObject *) PyExc_AssertionError;
Guido van Rossum051ab121995-02-27 10:17:52 +0000[diff] [blame]33extern DL_IMPORT(PyObject *) PyExc_AttributeError;
Guido van Rossum051ab121995-02-27 10:17:52 +0000[diff] [blame]34extern DL_IMPORT(PyObject *) PyExc_EOFError;
Guido van Rossum7d4266e1997-02-14 22:53:12 +0000[diff] [blame]35extern DL_IMPORT(PyObject *) PyExc_FloatingPointError;
Barry Warsaw62a21a21998-07-23 15:57:34 +0000[diff] [blame]36extern DL_IMPORT(PyObject *) PyExc_EnvironmentError;
Guido van Rossum051ab121995-02-27 10:17:52 +0000[diff] [blame]37extern DL_IMPORT(PyObject *) PyExc_IOError;
Barry Warsaw62a21a21998-07-23 15:57:34 +0000[diff] [blame]38extern DL_IMPORT(PyObject *) PyExc_OSError;
Guido van Rossum051ab121995-02-27 10:17:52 +0000[diff] [blame]39extern DL_IMPORT(PyObject *) PyExc_ImportError;
40extern DL_IMPORT(PyObject *) PyExc_IndexError;
41extern DL_IMPORT(PyObject *) PyExc_KeyError;
42extern DL_IMPORT(PyObject *) PyExc_KeyboardInterrupt;
43extern DL_IMPORT(PyObject *) PyExc_MemoryError;
44extern DL_IMPORT(PyObject *) PyExc_NameError;
45extern DL_IMPORT(PyObject *) PyExc_OverflowError;
46extern DL_IMPORT(PyObject *) PyExc_RuntimeError;
Barry Warsawd052ff01998-12-01 18:34:01 +0000[diff] [blame]47extern DL_IMPORT(PyObject *) PyExc_NotImplementedError;
Guido van Rossum051ab121995-02-27 10:17:52 +0000[diff] [blame]48extern DL_IMPORT(PyObject *) PyExc_SyntaxError;
Fred Draked5c84ed2000-07-08 17:25:55 +0000[diff] [blame]49extern DL_IMPORT(PyObject *) PyExc_IndentationError;
50extern DL_IMPORT(PyObject *) PyExc_TabError;
Guido van Rossum051ab121995-02-27 10:17:52 +0000[diff] [blame]51extern DL_IMPORT(PyObject *) PyExc_SystemError;
52extern DL_IMPORT(PyObject *) PyExc_SystemExit;
53extern DL_IMPORT(PyObject *) PyExc_TypeError;
Guido van Rossum87460821999-06-22 14:47:32 +0000[diff] [blame]54extern DL_IMPORT(PyObject *) PyExc_UnboundLocalError;
Guido van Rossum99cc9712000-03-10 22:33:32 +0000[diff] [blame]55extern DL_IMPORT(PyObject *) PyExc_UnicodeError;
Guido van Rossum051ab121995-02-27 10:17:52 +0000[diff] [blame]56extern DL_IMPORT(PyObject *) PyExc_ValueError;
57extern DL_IMPORT(PyObject *) PyExc_ZeroDivisionError;
Guido van Rossumdb0c9f72000-02-17 15:17:18 +0000[diff] [blame]58#ifdef MS_WINDOWS
59extern DL_IMPORT(PyObject *) PyExc_WindowsError;
60#endif
Guido van Rossum3e55cb61990-10-21 22:09:30 +0000[diff] [blame]61
Barry Warsaw392d8271997-08-29 21:56:07 +0000[diff] [blame]62extern DL_IMPORT(PyObject *) PyExc_MemoryErrorInst;
63
Guido van Rossum3fc30372000-12-15 21:57:34 +0000[diff] [blame]64/* Predefined warning categories */
65extern DL_IMPORT(PyObject *) PyExc_Warning;
66extern DL_IMPORT(PyObject *) PyExc_UserWarning;
67extern DL_IMPORT(PyObject *) PyExc_DeprecationWarning;
68extern DL_IMPORT(PyObject *) PyExc_SyntaxWarning;
69extern DL_IMPORT(PyObject *) PyExc_RuntimeWarning;
70
Barry Warsaw392d8271997-08-29 21:56:07 +0000[diff] [blame]71
Guido van Rossum5c600e11990-10-14 20:00:25 +0000[diff] [blame]72/* Convenience functions */
73
Fred Draked5c84ed2000-07-08 17:25:55 +0000[diff] [blame]74extern DL_IMPORT(int) PyErr_BadArgument(void);
75extern DL_IMPORT(PyObject *) PyErr_NoMemory(void);
76extern DL_IMPORT(PyObject *) PyErr_SetFromErrno(PyObject *);
77extern DL_IMPORT(PyObject *) PyErr_SetFromErrnoWithFilename(PyObject *, char *);
78extern DL_IMPORT(PyObject *) PyErr_Format(PyObject *, const char *, ...);
Guido van Rossumdb0c9f72000-02-17 15:17:18 +0000[diff] [blame]79#ifdef MS_WINDOWS
80extern DL_IMPORT(PyObject *) PyErr_SetFromWindowsErrWithFilename(int, const char *);
81extern DL_IMPORT(PyObject *) PyErr_SetFromWindowsErr(int);
82#endif
Guido van Rossum3e55cb61990-10-21 22:09:30 +0000[diff] [blame]83
Fred Drake6d63adf2000-08-24 22:38:39 +0000[diff] [blame]84/* Export the old function so that the existing API remains available: */
Fred Draked5c84ed2000-07-08 17:25:55 +0000[diff] [blame]85extern DL_IMPORT(void) PyErr_BadInternalCall(void);
Fred Drake6d63adf2000-08-24 22:38:39 +0000[diff] [blame]86extern DL_IMPORT(void) _PyErr_BadInternalCall(char *filename, int lineno);
87/* Mask the old API with a call to the new API for code compiled under
88 Python 2.0: */
89#define PyErr_BadInternalCall() _PyErr_BadInternalCall(__FILE__, __LINE__)
Guido van Rossum25831651993-05-19 14:50:45 +0000[diff] [blame]90
Guido van Rossum2d2c3441997-09-16 21:50:37 +0000[diff] [blame]91/* Function to create a new exception */
Fred Draked5c84ed2000-07-08 17:25:55 +0000[diff] [blame]92DL_IMPORT(PyObject *) PyErr_NewException(char *name, PyObject *base,
93 PyObject *dict);
Jeremy Hyltonb709df32000-09-01 02:47:25 +0000[diff] [blame]94extern DL_IMPORT(void) PyErr_WriteUnraisable(PyObject *);
Guido van Rossum2d2c3441997-09-16 21:50:37 +0000[diff] [blame]95
Guido van Rossum3fc30372000-12-15 21:57:34 +0000[diff] [blame]96/* Issue a warning or exception */
97extern DL_IMPORT(int) PyErr_Warn(PyObject *, char *);
Guido van Rossum1bcb7e92001-02-28 21:44:20 +0000[diff] [blame]98extern DL_IMPORT(int) PyErr_WarnExplicit(PyObject *, char *,
99 char *, int, char *, PyObject *);
Guido van Rossum3fc30372000-12-15 21:57:34 +0000[diff] [blame]100
Barry Warsawf3f41a91997-01-03 00:15:03 +0000[diff] [blame]101/* In sigcheck.c or signalmodule.c */
Fred Draked5c84ed2000-07-08 17:25:55 +0000[diff] [blame]102extern DL_IMPORT(int) PyErr_CheckSignals(void);
103extern DL_IMPORT(void) PyErr_SetInterrupt(void);
Jeremy Hyltonad3d3f22001-02-28 17:47:12 +0000[diff] [blame]104
105/* Support for adding program text to SyntaxErrors */
106extern DL_IMPORT(void) PyErr_SyntaxLocation(char *, int);
107extern DL_IMPORT(PyObject *) PyErr_ProgramText(char *, int);
Barry Warsawf3f41a91997-01-03 00:15:03 +0000[diff] [blame]108
Marc-André Lemburge5006eb2001-07-31 13:24:44 +0000[diff] [blame]109/* These APIs aren't really part of the error implementation, but
110 often needed to format error messages; the native C lib APIs are
111 not available on all platforms, which is why we provide emulations
112 for those platforms in Python/mysnprintf.c */
113#if defined(MS_WIN32) && !defined(HAVE_SNPRINTF)
114# define HAVE_SNPRINTF
115# define snprintf _snprintf
116# define vsnprintf _vsnprintf
117#endif
Marc-André Lemburg03d1b182001-07-31 18:05:33 +0000[diff] [blame^]118
119/* Always enable the fallback solution during the 2.2.0 alpha cycle
120 for enhanced testing */
121#if PY_VERSION_HEX < 0x020200B0
122# undef HAVE_SNPRINTF
123#endif
124
Marc-André Lemburge5006eb2001-07-31 13:24:44 +0000[diff] [blame]125#ifndef HAVE_SNPRINTF
Marc-André Lemburgcecd9e02001-07-31 14:23:52 +0000[diff] [blame]126#include <stdarg.h>
Marc-André Lemburge5006eb2001-07-31 13:24:44 +0000[diff] [blame]127extern DL_IMPORT(int) PyOS_snprintf(char *str, size_t size, const char *format, ...);
128extern DL_IMPORT(int) PyOS_vsnprintf(char *str, size_t size, const char *format, va_list va);
129#else
130# define PyOS_vsnprintf vsnprintf
131# define PyOS_snprintf snprintf
132#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000[diff] [blame]133
Guido van Rossuma3309961993-07-28 09:05:47 +0000[diff] [blame]134#ifdef __cplusplus
135}
136#endif
137#endif /* !Py_ERRORS_H */