blob: f009d586bf620256fba88b259c6a2aace11a9569 [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);
Dong-hee Na87ec86c2020-03-16 23:06:20 +090063PyAPI_FUNC(int) _PyArg_NoKwnames(const char *funcname, PyObject *kwnames);
Larry Hastingsb7ccb202014-01-18 23:50:21 -080064PyAPI_FUNC(int) _PyArg_NoPositional(const char *funcname, PyObject *args);
Serhiy Storchaka68a001d2017-02-06 10:41:46 +020065#define _PyArg_NoKeywords(funcname, kwargs) \
66 ((kwargs) == NULL || _PyArg_NoKeywords((funcname), (kwargs)))
Dong-hee Na87ec86c2020-03-16 23:06:20 +090067#define _PyArg_NoKwnames(funcname, kwnames) \
68 ((kwnames) == NULL || _PyArg_NoKwnames((funcname), (kwnames)))
Serhiy Storchaka68a001d2017-02-06 10:41:46 +020069#define _PyArg_NoPositional(funcname, args) \
70 ((args) == NULL || _PyArg_NoPositional((funcname), (args)))
71
Rémi Lapeyre4901fe22019-08-29 16:49:08 +020072PyAPI_FUNC(void) _PyArg_BadArgument(const char *, const char *, const char *, PyObject *);
Serhiy Storchaka4fa95912019-01-11 16:01:14 +020073PyAPI_FUNC(int) _PyArg_CheckPositional(const char *, Py_ssize_t,
74 Py_ssize_t, Py_ssize_t);
75#define _PyArg_CheckPositional(funcname, nargs, min, max) \
76 (((min) <= (nargs) && (nargs) <= (max)) \
77 || _PyArg_CheckPositional((funcname), (nargs), (min), (max)))
Serhiy Storchaka32d96a22018-12-25 13:23:47 +020078
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020079#endif
Victor Stinnerfe54dd82017-01-17 02:33:55 +010080
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000081PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
Serhiy Storchaka937b7252016-12-27 17:59:04 +020082#ifndef Py_LIMITED_API
Victor Stinnere9abde42016-12-09 00:29:49 +010083PyAPI_FUNC(PyObject **) _Py_VaBuildStack(
84 PyObject **small_stack,
85 Py_ssize_t small_stack_len,
86 const char *format,
87 va_list va,
88 Py_ssize_t *p_nargs);
Serhiy Storchaka937b7252016-12-27 17:59:04 +020089#endif
Guido van Rossume5372401993-03-16 12:15:04 +000090
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030091#ifndef Py_LIMITED_API
92typedef struct _PyArg_Parser {
93 const char *format;
94 const char * const *keywords;
95 const char *fname;
96 const char *custom_msg;
97 int pos; /* number of positional-only arguments */
98 int min; /* minimal number of arguments */
99 int max; /* maximal number of positional arguments */
100 PyObject *kwtuple; /* tuple of keyword parameter names */
101 struct _PyArg_Parser *next;
102} _PyArg_Parser;
103#ifdef PY_SSIZE_T_CLEAN
104#define _PyArg_ParseTupleAndKeywordsFast _PyArg_ParseTupleAndKeywordsFast_SizeT
Victor Stinner6518a932017-01-17 01:29:49 +0100105#define _PyArg_ParseStack _PyArg_ParseStack_SizeT
Victor Stinner3e1fad62017-01-17 01:29:01 +0100106#define _PyArg_ParseStackAndKeywords _PyArg_ParseStackAndKeywords_SizeT
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +0300107#define _PyArg_VaParseTupleAndKeywordsFast _PyArg_VaParseTupleAndKeywordsFast_SizeT
108#endif
109PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
110 struct _PyArg_Parser *, ...);
Victor Stinner6518a932017-01-17 01:29:49 +0100111PyAPI_FUNC(int) _PyArg_ParseStack(
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200112 PyObject *const *args,
Victor Stinner6518a932017-01-17 01:29:49 +0100113 Py_ssize_t nargs,
114 const char *format,
115 ...);
116PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords(
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200117 PyObject *const *args,
Victor Stinner6518a932017-01-17 01:29:49 +0100118 Py_ssize_t nargs,
119 PyObject *kwnames,
120 struct _PyArg_Parser *,
121 ...);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +0300122PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
123 struct _PyArg_Parser *, va_list);
Serhiy Storchaka31913912019-03-14 10:32:22 +0200124PyAPI_FUNC(PyObject * const *) _PyArg_UnpackKeywords(
125 PyObject *const *args, Py_ssize_t nargs,
126 PyObject *kwargs, PyObject *kwnames,
127 struct _PyArg_Parser *parser,
128 int minpos, int maxpos, int minkw,
129 PyObject **buf);
130#define _PyArg_UnpackKeywords(args, nargs, kwargs, kwnames, parser, minpos, maxpos, minkw, buf) \
131 (((minkw) == 0 && (kwargs) == NULL && (kwnames) == NULL && \
132 (minpos) <= (nargs) && (nargs) <= (maxpos) && args != NULL) ? (args) : \
133 _PyArg_UnpackKeywords((args), (nargs), (kwargs), (kwnames), (parser), \
134 (minpos), (maxpos), (minkw), (buf)))
135
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +0300136void _PyArg_Fini(void);
Victor Stinner6518a932017-01-17 01:29:49 +0100137#endif /* Py_LIMITED_API */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +0300138
Victor Stinner80218752020-11-04 13:59:15 +0100139// Add an attribute with name 'name' and value 'obj' to the module 'mod.
140// On success, return 0 on success.
141// On error, raise an exception and return -1.
142PyAPI_FUNC(int) PyModule_AddObjectRef(PyObject *mod, const char *name, PyObject *value);
143
144// Similar to PyModule_AddObjectRef() but steal a reference to 'obj'
145// (Py_DECREF(obj)) on success (if it returns 0).
146PyAPI_FUNC(int) PyModule_AddObject(PyObject *mod, const char *, PyObject *value);
147
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000148PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
149PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
Dong-hee Na05e4a292020-03-23 01:17:34 +0900150#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03090000
151/* New in 3.9 */
152PyAPI_FUNC(int) PyModule_AddType(PyObject *module, PyTypeObject *type);
153#endif /* Py_LIMITED_API */
Christian Heimes1af737c2008-01-23 08:24:23 +0000154#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
155#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
Yury Selivanovca829102015-06-02 19:06:47 -0400156
157#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
158/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000159PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *);
160PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *);
161PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def);
Yury Selivanovca829102015-06-02 19:06:47 -0400162#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000163
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000164#define Py_CLEANUP_SUPPORTED 0x20000
165
Thomas Wouters34aa7ba2006-02-28 19:02:24 +0000166#define PYTHON_API_VERSION 1013
167#define PYTHON_API_STRING "1013"
Guido van Rossum970a0a21995-01-09 17:47:20 +0000168/* The API version is maintained (independently from the Python version)
169 so we can detect mismatches between the interpreter and dynamically
Thomas Wouters7e474022000-07-16 12:04:32 +0000170 loaded modules. These are diagnosed by an error message but
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000171 the module is still loaded (because the mismatch can only be tested
172 after loading the module). The error message is intended to
173 explain the core dump a few seconds later.
Guido van Rossum970a0a21995-01-09 17:47:20 +0000174
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000175 The symbol PYTHON_API_STRING defines the same value as a string
176 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
177
Guido van Rossum970a0a21995-01-09 17:47:20 +0000178 Please add a line or two to the top of this log for each API
179 version change:
180
Nick Coghland5cacbb2015-05-23 22:24:10 +1000181 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths
Thomas Wouters34aa7ba2006-02-28 19:02:24 +0000182
Nick Coghland5cacbb2015-05-23 22:24:10 +1000183 19-Aug-2002 GvR 1012 Changes to string object struct for
184 interning changes, saving 3 bytes.
Guido van Rossum45ec02a2002-08-19 21:43:18 +0000185
Nick Coghland5cacbb2015-05-23 22:24:10 +1000186 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side
Tim Peters6d6c1a32001-08-02 04:15:00 +0000187
Fred Drake73a3c8f2001-01-25 22:13:34 +0000188 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and
189 PyFrame_New(); Python 2.1a2
190
Guido van Rossum21a50bd2000-03-29 01:46:45 +0000191 14-Mar-2000 GvR 1009 Unicode API added
192
Nick Coghland5cacbb2015-05-23 22:24:10 +1000193 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
Guido van Rossumf1176c41999-01-03 12:40:24 +0000194
Nick Coghland5cacbb2015-05-23 22:24:10 +1000195 3-Dec-1998 GvR 1008 Python 1.5.2b1
Guido van Rossum7531d501998-12-03 18:18:12 +0000196
Nick Coghland5cacbb2015-05-23 22:24:10 +1000197 18-Jan-1997 GvR 1007 string interning and other speedups
Guido van Rossumee5cf9b1997-01-18 07:54:03 +0000198
Nick Coghland5cacbb2015-05-23 22:24:10 +1000199 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
Guido van Rossume449af71996-10-11 16:25:41 +0000200
Nick Coghland5cacbb2015-05-23 22:24:10 +1000201 30-Jul-1996 GvR Slice and ellipses syntax added
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000202
Nick Coghland5cacbb2015-05-23 22:24:10 +1000203 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000204
Nick Coghland5cacbb2015-05-23 22:24:10 +1000205 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
Guido van Rossume0dbd591996-01-12 00:49:39 +0000206
Nick Coghland5cacbb2015-05-23 22:24:10 +1000207 10-Jan-1995 GvR Renamed globals to new naming scheme
Guido van Rossumcaa63801995-01-12 11:45:45 +0000208
Nick Coghland5cacbb2015-05-23 22:24:10 +1000209 9-Jan-1995 GvR Initial version (incompatible with older API)
Guido van Rossum970a0a21995-01-09 17:47:20 +0000210*/
211
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000212/* The PYTHON_ABI_VERSION is introduced in PEP 384. For the lifetime of
213 Python 3, it will stay at the value of 3; changes to the limited API
214 must be performed in a strictly backwards-compatible manner. */
215#define PYTHON_ABI_VERSION 3
216#define PYTHON_ABI_STRING "3"
217
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000218#ifdef Py_TRACE_REFS
Nick Coghland5cacbb2015-05-23 22:24:10 +1000219 /* When we are tracing reference counts, rename module creation functions so
Martin v. Löwis18e16552006-02-15 17:27:45 +0000220 modules compiled with incompatible settings will generate a
221 link-time error. */
Amaury Forgeot d'Arc11729992009-06-01 21:16:17 +0000222 #define PyModule_Create2 PyModule_Create2TraceRefs
Nick Coghland5cacbb2015-05-23 22:24:10 +1000223 #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000224#endif
225
Martin v. Löwis1a214512008-06-11 05:26:20 +0000226PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
227 int apiver);
Eric Snowd393c1b2017-09-14 12:18:12 -0600228#ifndef Py_LIMITED_API
229PyAPI_FUNC(PyObject *) _PyModule_CreateInitialized(struct PyModuleDef*,
230 int apiver);
231#endif
Fred Draked5c84ed2000-07-08 17:25:55 +0000232
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000233#ifdef Py_LIMITED_API
234#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000235 PyModule_Create2(module, PYTHON_ABI_VERSION)
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000236#else
Martin v. Löwis1a214512008-06-11 05:26:20 +0000237#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000238 PyModule_Create2(module, PYTHON_API_VERSION)
239#endif
240
Yury Selivanovca829102015-06-02 19:06:47 -0400241#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
242/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000243PyAPI_FUNC(PyObject *) PyModule_FromDefAndSpec2(PyModuleDef *def,
244 PyObject *spec,
245 int module_api_version);
246
247#ifdef Py_LIMITED_API
248#define PyModule_FromDefAndSpec(module, spec) \
249 PyModule_FromDefAndSpec2(module, spec, PYTHON_ABI_VERSION)
250#else
251#define PyModule_FromDefAndSpec(module, spec) \
252 PyModule_FromDefAndSpec2(module, spec, PYTHON_API_VERSION)
Yury Selivanovca829102015-06-02 19:06:47 -0400253#endif /* Py_LIMITED_API */
254#endif /* New in 3.5 */
Guido van Rossuma70d1601998-06-27 18:21:59 +0000255
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000256#ifndef Py_LIMITED_API
Serhiy Storchakab57d9ea2016-11-21 10:25:54 +0200257PyAPI_DATA(const char *) _Py_PackageContext;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000258#endif
Guido van Rossumee6fd1c1997-11-19 18:51:35 +0000259
Guido van Rossuma3309961993-07-28 09:05:47 +0000260#ifdef __cplusplus
261}
262#endif
263#endif /* !Py_MODSUPPORT_H */