blob: e464a1cad00efdc19b6a874f37405466f50146b7 [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
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +030018#ifndef Py_LIMITED_API
Nick Coghland5cacbb2015-05-23 22:24:10 +100019#define PyArg_VaParse _PyArg_VaParse_SizeT
20#define PyArg_VaParseTupleAndKeywords _PyArg_VaParseTupleAndKeywords_SizeT
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +030021#endif /* !Py_LIMITED_API */
Nick Coghland5cacbb2015-05-23 22:24:10 +100022#define Py_BuildValue _Py_BuildValue_SizeT
23#define Py_VaBuildValue _Py_VaBuildValue_SizeT
Serhiy Storchaka937b7252016-12-27 17:59:04 +020024#ifndef Py_LIMITED_API
Victor Stinnere9abde42016-12-09 00:29:49 +010025#define _Py_VaBuildStack _Py_VaBuildStack_SizeT
Serhiy Storchaka937b7252016-12-27 17:59:04 +020026#endif
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000027#else
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +030028#ifndef Py_LIMITED_API
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000029PyAPI_FUNC(PyObject *) _Py_VaBuildValue_SizeT(const char *, va_list);
Victor Stinnere9abde42016-12-09 00:29:49 +010030PyAPI_FUNC(PyObject **) _Py_VaBuildStack_SizeT(
31 PyObject **small_stack,
32 Py_ssize_t small_stack_len,
33 const char *format,
34 va_list va,
35 Py_ssize_t *p_nargs);
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +030036#endif /* !Py_LIMITED_API */
Martin v. Löwis18e16552006-02-15 17:27:45 +000037#endif
38
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020039/* Due to a glitch in 3.2, the _SizeT versions weren't exported from the DLL. */
40#if !defined(PY_SSIZE_T_CLEAN) || !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000041PyAPI_FUNC(int) PyArg_Parse(PyObject *, const char *, ...);
Benjamin Petersonf6b687f2013-05-12 23:08:28 -050042PyAPI_FUNC(int) PyArg_ParseTuple(PyObject *, const char *, ...);
Mark Hammond91a681d2002-08-12 07:21:58 +000043PyAPI_FUNC(int) PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000044 const char *, char **, ...);
Benjamin Petersonfb886362010-04-24 18:21:17 +000045PyAPI_FUNC(int) PyArg_ValidateKeywordArguments(PyObject *);
Martin v. Löwis76246742006-03-01 04:06:10 +000046PyAPI_FUNC(int) PyArg_UnpackTuple(PyObject *, const char *, Py_ssize_t, Py_ssize_t, ...);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000047PyAPI_FUNC(PyObject *) Py_BuildValue(const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000048PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020049#endif
Victor Stinnerfe54dd82017-01-17 02:33:55 +010050
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000051#ifndef Py_LIMITED_API
Victor Stinnerfe54dd82017-01-17 02:33:55 +010052PyAPI_FUNC(int) _PyArg_UnpackStack(
53 PyObject **args,
54 Py_ssize_t nargs,
55 const char *name,
56 Py_ssize_t min,
57 Py_ssize_t max,
58 ...);
59
Victor Stinner29d39cc2017-01-17 01:40:01 +010060PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kwargs);
61PyAPI_FUNC(int) _PyArg_NoStackKeywords(const char *funcname, PyObject *kwnames);
Larry Hastingsb7ccb202014-01-18 23:50:21 -080062PyAPI_FUNC(int) _PyArg_NoPositional(const char *funcname, PyObject *args);
Guido van Rossumb6775db1994-08-01 11:34:53 +000063
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000064PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000065PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000066 const char *, char **, va_list);
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020067#endif
Victor Stinnerfe54dd82017-01-17 02:33:55 +010068
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000069PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
Serhiy Storchaka937b7252016-12-27 17:59:04 +020070#ifndef Py_LIMITED_API
Victor Stinnere9abde42016-12-09 00:29:49 +010071PyAPI_FUNC(PyObject **) _Py_VaBuildStack(
72 PyObject **small_stack,
73 Py_ssize_t small_stack_len,
74 const char *format,
75 va_list va,
76 Py_ssize_t *p_nargs);
Serhiy Storchaka937b7252016-12-27 17:59:04 +020077#endif
Guido van Rossume5372401993-03-16 12:15:04 +000078
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030079#ifndef Py_LIMITED_API
80typedef struct _PyArg_Parser {
81 const char *format;
82 const char * const *keywords;
83 const char *fname;
84 const char *custom_msg;
85 int pos; /* number of positional-only arguments */
86 int min; /* minimal number of arguments */
87 int max; /* maximal number of positional arguments */
88 PyObject *kwtuple; /* tuple of keyword parameter names */
89 struct _PyArg_Parser *next;
90} _PyArg_Parser;
91#ifdef PY_SSIZE_T_CLEAN
92#define _PyArg_ParseTupleAndKeywordsFast _PyArg_ParseTupleAndKeywordsFast_SizeT
Victor Stinner6518a932017-01-17 01:29:49 +010093#define _PyArg_ParseStack _PyArg_ParseStack_SizeT
Victor Stinner3e1fad62017-01-17 01:29:01 +010094#define _PyArg_ParseStackAndKeywords _PyArg_ParseStackAndKeywords_SizeT
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030095#define _PyArg_VaParseTupleAndKeywordsFast _PyArg_VaParseTupleAndKeywordsFast_SizeT
96#endif
97PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
98 struct _PyArg_Parser *, ...);
Victor Stinner6518a932017-01-17 01:29:49 +010099PyAPI_FUNC(int) _PyArg_ParseStack(
100 PyObject **args,
101 Py_ssize_t nargs,
102 const char *format,
103 ...);
104PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords(
105 PyObject **args,
106 Py_ssize_t nargs,
107 PyObject *kwnames,
108 struct _PyArg_Parser *,
109 ...);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +0300110PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
111 struct _PyArg_Parser *, va_list);
112void _PyArg_Fini(void);
Victor Stinner6518a932017-01-17 01:29:49 +0100113#endif /* Py_LIMITED_API */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +0300114
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000115PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *);
116PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
117PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
Christian Heimes1af737c2008-01-23 08:24:23 +0000118#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
119#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
Yury Selivanovca829102015-06-02 19:06:47 -0400120
121#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
122/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000123PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *);
124PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *);
125PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def);
Yury Selivanovca829102015-06-02 19:06:47 -0400126#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000127
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000128#define Py_CLEANUP_SUPPORTED 0x20000
129
Thomas Wouters34aa7ba2006-02-28 19:02:24 +0000130#define PYTHON_API_VERSION 1013
131#define PYTHON_API_STRING "1013"
Guido van Rossum970a0a21995-01-09 17:47:20 +0000132/* The API version is maintained (independently from the Python version)
133 so we can detect mismatches between the interpreter and dynamically
Thomas Wouters7e474022000-07-16 12:04:32 +0000134 loaded modules. These are diagnosed by an error message but
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000135 the module is still loaded (because the mismatch can only be tested
136 after loading the module). The error message is intended to
137 explain the core dump a few seconds later.
Guido van Rossum970a0a21995-01-09 17:47:20 +0000138
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000139 The symbol PYTHON_API_STRING defines the same value as a string
140 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
141
Guido van Rossum970a0a21995-01-09 17:47:20 +0000142 Please add a line or two to the top of this log for each API
143 version change:
144
Nick Coghland5cacbb2015-05-23 22:24:10 +1000145 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths
Thomas Wouters34aa7ba2006-02-28 19:02:24 +0000146
Nick Coghland5cacbb2015-05-23 22:24:10 +1000147 19-Aug-2002 GvR 1012 Changes to string object struct for
148 interning changes, saving 3 bytes.
Guido van Rossum45ec02a2002-08-19 21:43:18 +0000149
Nick Coghland5cacbb2015-05-23 22:24:10 +1000150 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side
Tim Peters6d6c1a32001-08-02 04:15:00 +0000151
Fred Drake73a3c8f2001-01-25 22:13:34 +0000152 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and
153 PyFrame_New(); Python 2.1a2
154
Guido van Rossum21a50bd2000-03-29 01:46:45 +0000155 14-Mar-2000 GvR 1009 Unicode API added
156
Nick Coghland5cacbb2015-05-23 22:24:10 +1000157 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
Guido van Rossumf1176c41999-01-03 12:40:24 +0000158
Nick Coghland5cacbb2015-05-23 22:24:10 +1000159 3-Dec-1998 GvR 1008 Python 1.5.2b1
Guido van Rossum7531d501998-12-03 18:18:12 +0000160
Nick Coghland5cacbb2015-05-23 22:24:10 +1000161 18-Jan-1997 GvR 1007 string interning and other speedups
Guido van Rossumee5cf9b1997-01-18 07:54:03 +0000162
Nick Coghland5cacbb2015-05-23 22:24:10 +1000163 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
Guido van Rossume449af71996-10-11 16:25:41 +0000164
Nick Coghland5cacbb2015-05-23 22:24:10 +1000165 30-Jul-1996 GvR Slice and ellipses syntax added
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000166
Nick Coghland5cacbb2015-05-23 22:24:10 +1000167 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000168
Nick Coghland5cacbb2015-05-23 22:24:10 +1000169 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
Guido van Rossume0dbd591996-01-12 00:49:39 +0000170
Nick Coghland5cacbb2015-05-23 22:24:10 +1000171 10-Jan-1995 GvR Renamed globals to new naming scheme
Guido van Rossumcaa63801995-01-12 11:45:45 +0000172
Nick Coghland5cacbb2015-05-23 22:24:10 +1000173 9-Jan-1995 GvR Initial version (incompatible with older API)
Guido van Rossum970a0a21995-01-09 17:47:20 +0000174*/
175
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000176/* The PYTHON_ABI_VERSION is introduced in PEP 384. For the lifetime of
177 Python 3, it will stay at the value of 3; changes to the limited API
178 must be performed in a strictly backwards-compatible manner. */
179#define PYTHON_ABI_VERSION 3
180#define PYTHON_ABI_STRING "3"
181
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000182#ifdef Py_TRACE_REFS
Nick Coghland5cacbb2015-05-23 22:24:10 +1000183 /* When we are tracing reference counts, rename module creation functions so
Martin v. Löwis18e16552006-02-15 17:27:45 +0000184 modules compiled with incompatible settings will generate a
185 link-time error. */
Amaury Forgeot d'Arc11729992009-06-01 21:16:17 +0000186 #define PyModule_Create2 PyModule_Create2TraceRefs
Nick Coghland5cacbb2015-05-23 22:24:10 +1000187 #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000188#endif
189
Martin v. Löwis1a214512008-06-11 05:26:20 +0000190PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
191 int apiver);
Fred Draked5c84ed2000-07-08 17:25:55 +0000192
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000193#ifdef Py_LIMITED_API
194#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000195 PyModule_Create2(module, PYTHON_ABI_VERSION)
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000196#else
Martin v. Löwis1a214512008-06-11 05:26:20 +0000197#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000198 PyModule_Create2(module, PYTHON_API_VERSION)
199#endif
200
Yury Selivanovca829102015-06-02 19:06:47 -0400201#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
202/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000203PyAPI_FUNC(PyObject *) PyModule_FromDefAndSpec2(PyModuleDef *def,
204 PyObject *spec,
205 int module_api_version);
206
207#ifdef Py_LIMITED_API
208#define PyModule_FromDefAndSpec(module, spec) \
209 PyModule_FromDefAndSpec2(module, spec, PYTHON_ABI_VERSION)
210#else
211#define PyModule_FromDefAndSpec(module, spec) \
212 PyModule_FromDefAndSpec2(module, spec, PYTHON_API_VERSION)
Yury Selivanovca829102015-06-02 19:06:47 -0400213#endif /* Py_LIMITED_API */
214#endif /* New in 3.5 */
Guido van Rossuma70d1601998-06-27 18:21:59 +0000215
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000216#ifndef Py_LIMITED_API
Serhiy Storchakab57d9ea2016-11-21 10:25:54 +0200217PyAPI_DATA(const char *) _Py_PackageContext;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000218#endif
Guido van Rossumee6fd1c1997-11-19 18:51:35 +0000219
Guido van Rossuma3309961993-07-28 09:05:47 +0000220#ifdef __cplusplus
221}
222#endif
223#endif /* !Py_MODSUPPORT_H */