blob: ed24b2b311af656aa5511317e495bfaf25be424e [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Fred Draked5c84ed2000-07-08 17:25:55 +00002#ifndef Py_MODSUPPORT_H
3#define Py_MODSUPPORT_H
4#ifdef __cplusplus
5extern "C" {
6#endif
7
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00008/* Module support interface */
9
Guido van Rossumb6775db1994-08-01 11:34:53 +000010#include <stdarg.h>
11
Martin v. Löwis18e16552006-02-15 17:27:45 +000012/* If PY_SSIZE_T_CLEAN is defined, each functions treats #-specifier
13 to mean Py_ssize_t */
14#ifdef PY_SSIZE_T_CLEAN
Nick Coghland5cacbb2015-05-23 22:24:10 +100015#define PyArg_Parse _PyArg_Parse_SizeT
16#define PyArg_ParseTuple _PyArg_ParseTuple_SizeT
17#define PyArg_ParseTupleAndKeywords _PyArg_ParseTupleAndKeywords_SizeT
18#define PyArg_VaParse _PyArg_VaParse_SizeT
19#define PyArg_VaParseTupleAndKeywords _PyArg_VaParseTupleAndKeywords_SizeT
20#define Py_BuildValue _Py_BuildValue_SizeT
21#define Py_VaBuildValue _Py_VaBuildValue_SizeT
Serhiy Storchaka937b7252016-12-27 17:59:04 +020022#ifndef Py_LIMITED_API
Victor Stinnere9abde42016-12-09 00:29:49 +010023#define _Py_VaBuildStack _Py_VaBuildStack_SizeT
Serhiy Storchaka937b7252016-12-27 17:59:04 +020024#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000025#else
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +030026#ifndef Py_LIMITED_API
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000027PyAPI_FUNC(PyObject *) _Py_VaBuildValue_SizeT(const char *, va_list);
Victor Stinnere9abde42016-12-09 00:29:49 +010028PyAPI_FUNC(PyObject **) _Py_VaBuildStack_SizeT(
29 PyObject **small_stack,
30 Py_ssize_t small_stack_len,
31 const char *format,
32 va_list va,
33 Py_ssize_t *p_nargs);
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +030034#endif /* !Py_LIMITED_API */
Martin v. Löwis18e16552006-02-15 17:27:45 +000035#endif
36
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020037/* Due to a glitch in 3.2, the _SizeT versions weren't exported from the DLL. */
38#if !defined(PY_SSIZE_T_CLEAN) || !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000039PyAPI_FUNC(int) PyArg_Parse(PyObject *, const char *, ...);
Benjamin Petersonf6b687f2013-05-12 23:08:28 -050040PyAPI_FUNC(int) PyArg_ParseTuple(PyObject *, const char *, ...);
Mark Hammond91a681d2002-08-12 07:21:58 +000041PyAPI_FUNC(int) PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000042 const char *, char **, ...);
Serhiy Storchaka07a1f652017-01-24 21:27:12 +020043PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list);
44PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
45 const char *, char **, va_list);
46#endif
Benjamin Petersonfb886362010-04-24 18:21:17 +000047PyAPI_FUNC(int) PyArg_ValidateKeywordArguments(PyObject *);
Martin v. Löwis76246742006-03-01 04:06:10 +000048PyAPI_FUNC(int) PyArg_UnpackTuple(PyObject *, const char *, Py_ssize_t, Py_ssize_t, ...);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000049PyAPI_FUNC(PyObject *) Py_BuildValue(const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000050PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchaka07a1f652017-01-24 21:27:12 +020051
Victor Stinnerfe54dd82017-01-17 02:33:55 +010052
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000053#ifndef Py_LIMITED_API
Victor Stinnerfe54dd82017-01-17 02:33:55 +010054PyAPI_FUNC(int) _PyArg_UnpackStack(
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020055 PyObject *const *args,
Victor Stinnerfe54dd82017-01-17 02:33:55 +010056 Py_ssize_t nargs,
57 const char *name,
58 Py_ssize_t min,
59 Py_ssize_t max,
60 ...);
61
Victor Stinner29d39cc2017-01-17 01:40:01 +010062PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kwargs);
Larry Hastingsb7ccb202014-01-18 23:50:21 -080063PyAPI_FUNC(int) _PyArg_NoPositional(const char *funcname, PyObject *args);
Serhiy Storchaka68a001d2017-02-06 10:41:46 +020064#define _PyArg_NoKeywords(funcname, kwargs) \
65 ((kwargs) == NULL || _PyArg_NoKeywords((funcname), (kwargs)))
Serhiy Storchaka68a001d2017-02-06 10:41:46 +020066#define _PyArg_NoPositional(funcname, args) \
67 ((args) == NULL || _PyArg_NoPositional((funcname), (args)))
68
Serhiy Storchaka32d96a22018-12-25 13:23:47 +020069PyAPI_FUNC(void) _PyArg_BadArgument(const char *, const char *, PyObject *);
70
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020071#endif
Victor Stinnerfe54dd82017-01-17 02:33:55 +010072
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000073PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
Serhiy Storchaka937b7252016-12-27 17:59:04 +020074#ifndef Py_LIMITED_API
Victor Stinnere9abde42016-12-09 00:29:49 +010075PyAPI_FUNC(PyObject **) _Py_VaBuildStack(
76 PyObject **small_stack,
77 Py_ssize_t small_stack_len,
78 const char *format,
79 va_list va,
80 Py_ssize_t *p_nargs);
Serhiy Storchaka937b7252016-12-27 17:59:04 +020081#endif
Guido van Rossume5372401993-03-16 12:15:04 +000082
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030083#ifndef Py_LIMITED_API
84typedef struct _PyArg_Parser {
85 const char *format;
86 const char * const *keywords;
87 const char *fname;
88 const char *custom_msg;
89 int pos; /* number of positional-only arguments */
90 int min; /* minimal number of arguments */
91 int max; /* maximal number of positional arguments */
92 PyObject *kwtuple; /* tuple of keyword parameter names */
93 struct _PyArg_Parser *next;
94} _PyArg_Parser;
95#ifdef PY_SSIZE_T_CLEAN
96#define _PyArg_ParseTupleAndKeywordsFast _PyArg_ParseTupleAndKeywordsFast_SizeT
Victor Stinner6518a932017-01-17 01:29:49 +010097#define _PyArg_ParseStack _PyArg_ParseStack_SizeT
Victor Stinner3e1fad62017-01-17 01:29:01 +010098#define _PyArg_ParseStackAndKeywords _PyArg_ParseStackAndKeywords_SizeT
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030099#define _PyArg_VaParseTupleAndKeywordsFast _PyArg_VaParseTupleAndKeywordsFast_SizeT
100#endif
101PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
102 struct _PyArg_Parser *, ...);
Victor Stinner6518a932017-01-17 01:29:49 +0100103PyAPI_FUNC(int) _PyArg_ParseStack(
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200104 PyObject *const *args,
Victor Stinner6518a932017-01-17 01:29:49 +0100105 Py_ssize_t nargs,
106 const char *format,
107 ...);
108PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords(
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200109 PyObject *const *args,
Victor Stinner6518a932017-01-17 01:29:49 +0100110 Py_ssize_t nargs,
111 PyObject *kwnames,
112 struct _PyArg_Parser *,
113 ...);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +0300114PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
115 struct _PyArg_Parser *, va_list);
116void _PyArg_Fini(void);
Victor Stinner6518a932017-01-17 01:29:49 +0100117#endif /* Py_LIMITED_API */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +0300118
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000119PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *);
120PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
121PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
Christian Heimes1af737c2008-01-23 08:24:23 +0000122#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
123#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
Yury Selivanovca829102015-06-02 19:06:47 -0400124
125#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
126/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000127PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *);
128PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *);
129PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def);
Yury Selivanovca829102015-06-02 19:06:47 -0400130#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000131
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000132#define Py_CLEANUP_SUPPORTED 0x20000
133
Thomas Wouters34aa7ba2006-02-28 19:02:24 +0000134#define PYTHON_API_VERSION 1013
135#define PYTHON_API_STRING "1013"
Guido van Rossum970a0a21995-01-09 17:47:20 +0000136/* The API version is maintained (independently from the Python version)
137 so we can detect mismatches between the interpreter and dynamically
Thomas Wouters7e474022000-07-16 12:04:32 +0000138 loaded modules. These are diagnosed by an error message but
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000139 the module is still loaded (because the mismatch can only be tested
140 after loading the module). The error message is intended to
141 explain the core dump a few seconds later.
Guido van Rossum970a0a21995-01-09 17:47:20 +0000142
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000143 The symbol PYTHON_API_STRING defines the same value as a string
144 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
145
Guido van Rossum970a0a21995-01-09 17:47:20 +0000146 Please add a line or two to the top of this log for each API
147 version change:
148
Nick Coghland5cacbb2015-05-23 22:24:10 +1000149 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths
Thomas Wouters34aa7ba2006-02-28 19:02:24 +0000150
Nick Coghland5cacbb2015-05-23 22:24:10 +1000151 19-Aug-2002 GvR 1012 Changes to string object struct for
152 interning changes, saving 3 bytes.
Guido van Rossum45ec02a2002-08-19 21:43:18 +0000153
Nick Coghland5cacbb2015-05-23 22:24:10 +1000154 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side
Tim Peters6d6c1a32001-08-02 04:15:00 +0000155
Fred Drake73a3c8f2001-01-25 22:13:34 +0000156 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and
157 PyFrame_New(); Python 2.1a2
158
Guido van Rossum21a50bd2000-03-29 01:46:45 +0000159 14-Mar-2000 GvR 1009 Unicode API added
160
Nick Coghland5cacbb2015-05-23 22:24:10 +1000161 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
Guido van Rossumf1176c41999-01-03 12:40:24 +0000162
Nick Coghland5cacbb2015-05-23 22:24:10 +1000163 3-Dec-1998 GvR 1008 Python 1.5.2b1
Guido van Rossum7531d501998-12-03 18:18:12 +0000164
Nick Coghland5cacbb2015-05-23 22:24:10 +1000165 18-Jan-1997 GvR 1007 string interning and other speedups
Guido van Rossumee5cf9b1997-01-18 07:54:03 +0000166
Nick Coghland5cacbb2015-05-23 22:24:10 +1000167 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
Guido van Rossume449af71996-10-11 16:25:41 +0000168
Nick Coghland5cacbb2015-05-23 22:24:10 +1000169 30-Jul-1996 GvR Slice and ellipses syntax added
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000170
Nick Coghland5cacbb2015-05-23 22:24:10 +1000171 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000172
Nick Coghland5cacbb2015-05-23 22:24:10 +1000173 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
Guido van Rossume0dbd591996-01-12 00:49:39 +0000174
Nick Coghland5cacbb2015-05-23 22:24:10 +1000175 10-Jan-1995 GvR Renamed globals to new naming scheme
Guido van Rossumcaa63801995-01-12 11:45:45 +0000176
Nick Coghland5cacbb2015-05-23 22:24:10 +1000177 9-Jan-1995 GvR Initial version (incompatible with older API)
Guido van Rossum970a0a21995-01-09 17:47:20 +0000178*/
179
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000180/* The PYTHON_ABI_VERSION is introduced in PEP 384. For the lifetime of
181 Python 3, it will stay at the value of 3; changes to the limited API
182 must be performed in a strictly backwards-compatible manner. */
183#define PYTHON_ABI_VERSION 3
184#define PYTHON_ABI_STRING "3"
185
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000186#ifdef Py_TRACE_REFS
Nick Coghland5cacbb2015-05-23 22:24:10 +1000187 /* When we are tracing reference counts, rename module creation functions so
Martin v. Löwis18e16552006-02-15 17:27:45 +0000188 modules compiled with incompatible settings will generate a
189 link-time error. */
Amaury Forgeot d'Arc11729992009-06-01 21:16:17 +0000190 #define PyModule_Create2 PyModule_Create2TraceRefs
Nick Coghland5cacbb2015-05-23 22:24:10 +1000191 #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000192#endif
193
Martin v. Löwis1a214512008-06-11 05:26:20 +0000194PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
195 int apiver);
Eric Snowd393c1b2017-09-14 12:18:12 -0600196#ifndef Py_LIMITED_API
197PyAPI_FUNC(PyObject *) _PyModule_CreateInitialized(struct PyModuleDef*,
198 int apiver);
199#endif
Fred Draked5c84ed2000-07-08 17:25:55 +0000200
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000201#ifdef Py_LIMITED_API
202#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000203 PyModule_Create2(module, PYTHON_ABI_VERSION)
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000204#else
Martin v. Löwis1a214512008-06-11 05:26:20 +0000205#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000206 PyModule_Create2(module, PYTHON_API_VERSION)
207#endif
208
Yury Selivanovca829102015-06-02 19:06:47 -0400209#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
210/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000211PyAPI_FUNC(PyObject *) PyModule_FromDefAndSpec2(PyModuleDef *def,
212 PyObject *spec,
213 int module_api_version);
214
215#ifdef Py_LIMITED_API
216#define PyModule_FromDefAndSpec(module, spec) \
217 PyModule_FromDefAndSpec2(module, spec, PYTHON_ABI_VERSION)
218#else
219#define PyModule_FromDefAndSpec(module, spec) \
220 PyModule_FromDefAndSpec2(module, spec, PYTHON_API_VERSION)
Yury Selivanovca829102015-06-02 19:06:47 -0400221#endif /* Py_LIMITED_API */
222#endif /* New in 3.5 */
Guido van Rossuma70d1601998-06-27 18:21:59 +0000223
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000224#ifndef Py_LIMITED_API
Serhiy Storchakab57d9ea2016-11-21 10:25:54 +0200225PyAPI_DATA(const char *) _Py_PackageContext;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000226#endif
Guido van Rossumee6fd1c1997-11-19 18:51:35 +0000227
Guido van Rossuma3309961993-07-28 09:05:47 +0000228#ifdef __cplusplus
229}
230#endif
231#endif /* !Py_MODSUPPORT_H */