blob: 5c21f98f0601753c594f42e1fa5a6e3bba914a36 [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
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000050#ifndef Py_LIMITED_API
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000051PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kw);
Larry Hastingsb7ccb202014-01-18 23:50:21 -080052PyAPI_FUNC(int) _PyArg_NoPositional(const char *funcname, PyObject *args);
Guido van Rossumb6775db1994-08-01 11:34:53 +000053
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000054PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000055PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000056 const char *, char **, va_list);
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020057#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000058PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
Serhiy Storchaka937b7252016-12-27 17:59:04 +020059#ifndef Py_LIMITED_API
Victor Stinnere9abde42016-12-09 00:29:49 +010060PyAPI_FUNC(PyObject **) _Py_VaBuildStack(
61 PyObject **small_stack,
62 Py_ssize_t small_stack_len,
63 const char *format,
64 va_list va,
65 Py_ssize_t *p_nargs);
Serhiy Storchaka937b7252016-12-27 17:59:04 +020066#endif
Guido van Rossume5372401993-03-16 12:15:04 +000067
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030068#ifndef Py_LIMITED_API
69typedef struct _PyArg_Parser {
70 const char *format;
71 const char * const *keywords;
72 const char *fname;
73 const char *custom_msg;
74 int pos; /* number of positional-only arguments */
75 int min; /* minimal number of arguments */
76 int max; /* maximal number of positional arguments */
77 PyObject *kwtuple; /* tuple of keyword parameter names */
78 struct _PyArg_Parser *next;
79} _PyArg_Parser;
80#ifdef PY_SSIZE_T_CLEAN
81#define _PyArg_ParseTupleAndKeywordsFast _PyArg_ParseTupleAndKeywordsFast_SizeT
Victor Stinner6518a932017-01-17 01:29:49 +010082#define _PyArg_ParseStack _PyArg_ParseStack_SizeT
Victor Stinner3e1fad62017-01-17 01:29:01 +010083#define _PyArg_ParseStackAndKeywords _PyArg_ParseStackAndKeywords_SizeT
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030084#define _PyArg_VaParseTupleAndKeywordsFast _PyArg_VaParseTupleAndKeywordsFast_SizeT
85#endif
86PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
87 struct _PyArg_Parser *, ...);
Victor Stinner6518a932017-01-17 01:29:49 +010088PyAPI_FUNC(int) _PyArg_ParseStack(
89 PyObject **args,
90 Py_ssize_t nargs,
91 const char *format,
92 ...);
93PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords(
94 PyObject **args,
95 Py_ssize_t nargs,
96 PyObject *kwnames,
97 struct _PyArg_Parser *,
98 ...);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030099PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
100 struct _PyArg_Parser *, va_list);
101void _PyArg_Fini(void);
Victor Stinner6518a932017-01-17 01:29:49 +0100102#endif /* Py_LIMITED_API */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +0300103
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000104PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *);
105PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
106PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
Christian Heimes1af737c2008-01-23 08:24:23 +0000107#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
108#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
Yury Selivanovca829102015-06-02 19:06:47 -0400109
110#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
111/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000112PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *);
113PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *);
114PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def);
Yury Selivanovca829102015-06-02 19:06:47 -0400115#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +0000116
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000117#define Py_CLEANUP_SUPPORTED 0x20000
118
Thomas Wouters34aa7ba2006-02-28 19:02:24 +0000119#define PYTHON_API_VERSION 1013
120#define PYTHON_API_STRING "1013"
Guido van Rossum970a0a21995-01-09 17:47:20 +0000121/* The API version is maintained (independently from the Python version)
122 so we can detect mismatches between the interpreter and dynamically
Thomas Wouters7e474022000-07-16 12:04:32 +0000123 loaded modules. These are diagnosed by an error message but
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000124 the module is still loaded (because the mismatch can only be tested
125 after loading the module). The error message is intended to
126 explain the core dump a few seconds later.
Guido van Rossum970a0a21995-01-09 17:47:20 +0000127
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000128 The symbol PYTHON_API_STRING defines the same value as a string
129 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
130
Guido van Rossum970a0a21995-01-09 17:47:20 +0000131 Please add a line or two to the top of this log for each API
132 version change:
133
Nick Coghland5cacbb2015-05-23 22:24:10 +1000134 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths
Thomas Wouters34aa7ba2006-02-28 19:02:24 +0000135
Nick Coghland5cacbb2015-05-23 22:24:10 +1000136 19-Aug-2002 GvR 1012 Changes to string object struct for
137 interning changes, saving 3 bytes.
Guido van Rossum45ec02a2002-08-19 21:43:18 +0000138
Nick Coghland5cacbb2015-05-23 22:24:10 +1000139 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side
Tim Peters6d6c1a32001-08-02 04:15:00 +0000140
Fred Drake73a3c8f2001-01-25 22:13:34 +0000141 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and
142 PyFrame_New(); Python 2.1a2
143
Guido van Rossum21a50bd2000-03-29 01:46:45 +0000144 14-Mar-2000 GvR 1009 Unicode API added
145
Nick Coghland5cacbb2015-05-23 22:24:10 +1000146 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
Guido van Rossumf1176c41999-01-03 12:40:24 +0000147
Nick Coghland5cacbb2015-05-23 22:24:10 +1000148 3-Dec-1998 GvR 1008 Python 1.5.2b1
Guido van Rossum7531d501998-12-03 18:18:12 +0000149
Nick Coghland5cacbb2015-05-23 22:24:10 +1000150 18-Jan-1997 GvR 1007 string interning and other speedups
Guido van Rossumee5cf9b1997-01-18 07:54:03 +0000151
Nick Coghland5cacbb2015-05-23 22:24:10 +1000152 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
Guido van Rossume449af71996-10-11 16:25:41 +0000153
Nick Coghland5cacbb2015-05-23 22:24:10 +1000154 30-Jul-1996 GvR Slice and ellipses syntax added
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000155
Nick Coghland5cacbb2015-05-23 22:24:10 +1000156 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000157
Nick Coghland5cacbb2015-05-23 22:24:10 +1000158 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
Guido van Rossume0dbd591996-01-12 00:49:39 +0000159
Nick Coghland5cacbb2015-05-23 22:24:10 +1000160 10-Jan-1995 GvR Renamed globals to new naming scheme
Guido van Rossumcaa63801995-01-12 11:45:45 +0000161
Nick Coghland5cacbb2015-05-23 22:24:10 +1000162 9-Jan-1995 GvR Initial version (incompatible with older API)
Guido van Rossum970a0a21995-01-09 17:47:20 +0000163*/
164
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000165/* The PYTHON_ABI_VERSION is introduced in PEP 384. For the lifetime of
166 Python 3, it will stay at the value of 3; changes to the limited API
167 must be performed in a strictly backwards-compatible manner. */
168#define PYTHON_ABI_VERSION 3
169#define PYTHON_ABI_STRING "3"
170
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000171#ifdef Py_TRACE_REFS
Nick Coghland5cacbb2015-05-23 22:24:10 +1000172 /* When we are tracing reference counts, rename module creation functions so
Martin v. Löwis18e16552006-02-15 17:27:45 +0000173 modules compiled with incompatible settings will generate a
174 link-time error. */
Amaury Forgeot d'Arc11729992009-06-01 21:16:17 +0000175 #define PyModule_Create2 PyModule_Create2TraceRefs
Nick Coghland5cacbb2015-05-23 22:24:10 +1000176 #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000177#endif
178
Martin v. Löwis1a214512008-06-11 05:26:20 +0000179PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
180 int apiver);
Fred Draked5c84ed2000-07-08 17:25:55 +0000181
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000182#ifdef Py_LIMITED_API
183#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000184 PyModule_Create2(module, PYTHON_ABI_VERSION)
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000185#else
Martin v. Löwis1a214512008-06-11 05:26:20 +0000186#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000187 PyModule_Create2(module, PYTHON_API_VERSION)
188#endif
189
Yury Selivanovca829102015-06-02 19:06:47 -0400190#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
191/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000192PyAPI_FUNC(PyObject *) PyModule_FromDefAndSpec2(PyModuleDef *def,
193 PyObject *spec,
194 int module_api_version);
195
196#ifdef Py_LIMITED_API
197#define PyModule_FromDefAndSpec(module, spec) \
198 PyModule_FromDefAndSpec2(module, spec, PYTHON_ABI_VERSION)
199#else
200#define PyModule_FromDefAndSpec(module, spec) \
201 PyModule_FromDefAndSpec2(module, spec, PYTHON_API_VERSION)
Yury Selivanovca829102015-06-02 19:06:47 -0400202#endif /* Py_LIMITED_API */
203#endif /* New in 3.5 */
Guido van Rossuma70d1601998-06-27 18:21:59 +0000204
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000205#ifndef Py_LIMITED_API
Serhiy Storchakab57d9ea2016-11-21 10:25:54 +0200206PyAPI_DATA(const char *) _Py_PackageContext;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000207#endif
Guido van Rossumee6fd1c1997-11-19 18:51:35 +0000208
Guido van Rossuma3309961993-07-28 09:05:47 +0000209#ifdef __cplusplus
210}
211#endif
212#endif /* !Py_MODSUPPORT_H */