blob: 86719c6e9293057237b90ba076d416cd94b6cf25 [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
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000022#else
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +030023#ifndef Py_LIMITED_API
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000024PyAPI_FUNC(PyObject *) _Py_VaBuildValue_SizeT(const char *, va_list);
Serhiy Storchaka9fab79b2016-09-11 11:03:14 +030025#endif /* !Py_LIMITED_API */
Martin v. Löwis18e16552006-02-15 17:27:45 +000026#endif
27
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020028/* Due to a glitch in 3.2, the _SizeT versions weren't exported from the DLL. */
29#if !defined(PY_SSIZE_T_CLEAN) || !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000030PyAPI_FUNC(int) PyArg_Parse(PyObject *, const char *, ...);
Benjamin Petersonf6b687f2013-05-12 23:08:28 -050031PyAPI_FUNC(int) PyArg_ParseTuple(PyObject *, const char *, ...);
Mark Hammond91a681d2002-08-12 07:21:58 +000032PyAPI_FUNC(int) PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000033 const char *, char **, ...);
Serhiy Storchaka07a1f652017-01-24 21:27:12 +020034PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list);
35PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
36 const char *, char **, va_list);
37#endif
Benjamin Petersonfb886362010-04-24 18:21:17 +000038PyAPI_FUNC(int) PyArg_ValidateKeywordArguments(PyObject *);
Martin v. Löwis76246742006-03-01 04:06:10 +000039PyAPI_FUNC(int) PyArg_UnpackTuple(PyObject *, const char *, Py_ssize_t, Py_ssize_t, ...);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000040PyAPI_FUNC(PyObject *) Py_BuildValue(const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000041PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchaka07a1f652017-01-24 21:27:12 +020042
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000043#ifndef Py_LIMITED_API
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000044PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kw);
Larry Hastingsb7ccb202014-01-18 23:50:21 -080045PyAPI_FUNC(int) _PyArg_NoPositional(const char *funcname, PyObject *args);
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020046#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000047PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
Guido van Rossume5372401993-03-16 12:15:04 +000048
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030049#ifndef Py_LIMITED_API
50typedef struct _PyArg_Parser {
51 const char *format;
52 const char * const *keywords;
53 const char *fname;
54 const char *custom_msg;
55 int pos; /* number of positional-only arguments */
56 int min; /* minimal number of arguments */
57 int max; /* maximal number of positional arguments */
58 PyObject *kwtuple; /* tuple of keyword parameter names */
59 struct _PyArg_Parser *next;
60} _PyArg_Parser;
61#ifdef PY_SSIZE_T_CLEAN
62#define _PyArg_ParseTupleAndKeywordsFast _PyArg_ParseTupleAndKeywordsFast_SizeT
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -070063#define _PyArg_ParseStack _PyArg_ParseStack_SizeT
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030064#define _PyArg_VaParseTupleAndKeywordsFast _PyArg_VaParseTupleAndKeywordsFast_SizeT
65#endif
66PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
67 struct _PyArg_Parser *, ...);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -070068PyAPI_FUNC(int) _PyArg_ParseStack(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
69 struct _PyArg_Parser *, ...);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030070PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
71 struct _PyArg_Parser *, va_list);
72void _PyArg_Fini(void);
73#endif
74
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000075PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *);
76PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
77PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
Christian Heimes1af737c2008-01-23 08:24:23 +000078#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
79#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
Yury Selivanovca829102015-06-02 19:06:47 -040080
81#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
82/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +100083PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *);
84PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *);
85PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def);
Yury Selivanovca829102015-06-02 19:06:47 -040086#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +000087
Martin v. Löwisc15bdef2009-05-29 14:47:46 +000088#define Py_CLEANUP_SUPPORTED 0x20000
89
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000090#define PYTHON_API_VERSION 1013
91#define PYTHON_API_STRING "1013"
Guido van Rossum970a0a21995-01-09 17:47:20 +000092/* The API version is maintained (independently from the Python version)
93 so we can detect mismatches between the interpreter and dynamically
Thomas Wouters7e474022000-07-16 12:04:32 +000094 loaded modules. These are diagnosed by an error message but
Guido van Rossumae8a99e1996-07-30 16:41:02 +000095 the module is still loaded (because the mismatch can only be tested
96 after loading the module). The error message is intended to
97 explain the core dump a few seconds later.
Guido van Rossum970a0a21995-01-09 17:47:20 +000098
Guido van Rossum2ea0b061996-08-22 22:55:47 +000099 The symbol PYTHON_API_STRING defines the same value as a string
100 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
101
Guido van Rossum970a0a21995-01-09 17:47:20 +0000102 Please add a line or two to the top of this log for each API
103 version change:
104
Nick Coghland5cacbb2015-05-23 22:24:10 +1000105 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths
Thomas Wouters34aa7ba2006-02-28 19:02:24 +0000106
Nick Coghland5cacbb2015-05-23 22:24:10 +1000107 19-Aug-2002 GvR 1012 Changes to string object struct for
108 interning changes, saving 3 bytes.
Guido van Rossum45ec02a2002-08-19 21:43:18 +0000109
Nick Coghland5cacbb2015-05-23 22:24:10 +1000110 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side
Tim Peters6d6c1a32001-08-02 04:15:00 +0000111
Fred Drake73a3c8f2001-01-25 22:13:34 +0000112 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and
113 PyFrame_New(); Python 2.1a2
114
Guido van Rossum21a50bd2000-03-29 01:46:45 +0000115 14-Mar-2000 GvR 1009 Unicode API added
116
Nick Coghland5cacbb2015-05-23 22:24:10 +1000117 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
Guido van Rossumf1176c41999-01-03 12:40:24 +0000118
Nick Coghland5cacbb2015-05-23 22:24:10 +1000119 3-Dec-1998 GvR 1008 Python 1.5.2b1
Guido van Rossum7531d501998-12-03 18:18:12 +0000120
Nick Coghland5cacbb2015-05-23 22:24:10 +1000121 18-Jan-1997 GvR 1007 string interning and other speedups
Guido van Rossumee5cf9b1997-01-18 07:54:03 +0000122
Nick Coghland5cacbb2015-05-23 22:24:10 +1000123 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
Guido van Rossume449af71996-10-11 16:25:41 +0000124
Nick Coghland5cacbb2015-05-23 22:24:10 +1000125 30-Jul-1996 GvR Slice and ellipses syntax added
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000126
Nick Coghland5cacbb2015-05-23 22:24:10 +1000127 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000128
Nick Coghland5cacbb2015-05-23 22:24:10 +1000129 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
Guido van Rossume0dbd591996-01-12 00:49:39 +0000130
Nick Coghland5cacbb2015-05-23 22:24:10 +1000131 10-Jan-1995 GvR Renamed globals to new naming scheme
Guido van Rossumcaa63801995-01-12 11:45:45 +0000132
Nick Coghland5cacbb2015-05-23 22:24:10 +1000133 9-Jan-1995 GvR Initial version (incompatible with older API)
Guido van Rossum970a0a21995-01-09 17:47:20 +0000134*/
135
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000136/* The PYTHON_ABI_VERSION is introduced in PEP 384. For the lifetime of
137 Python 3, it will stay at the value of 3; changes to the limited API
138 must be performed in a strictly backwards-compatible manner. */
139#define PYTHON_ABI_VERSION 3
140#define PYTHON_ABI_STRING "3"
141
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000142#ifdef Py_TRACE_REFS
Nick Coghland5cacbb2015-05-23 22:24:10 +1000143 /* When we are tracing reference counts, rename module creation functions so
Martin v. Löwis18e16552006-02-15 17:27:45 +0000144 modules compiled with incompatible settings will generate a
145 link-time error. */
Amaury Forgeot d'Arc11729992009-06-01 21:16:17 +0000146 #define PyModule_Create2 PyModule_Create2TraceRefs
Nick Coghland5cacbb2015-05-23 22:24:10 +1000147 #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000148#endif
149
Martin v. Löwis1a214512008-06-11 05:26:20 +0000150PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
151 int apiver);
Fred Draked5c84ed2000-07-08 17:25:55 +0000152
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000153#ifdef Py_LIMITED_API
154#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000155 PyModule_Create2(module, PYTHON_ABI_VERSION)
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000156#else
Martin v. Löwis1a214512008-06-11 05:26:20 +0000157#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000158 PyModule_Create2(module, PYTHON_API_VERSION)
159#endif
160
Yury Selivanovca829102015-06-02 19:06:47 -0400161#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
162/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000163PyAPI_FUNC(PyObject *) PyModule_FromDefAndSpec2(PyModuleDef *def,
164 PyObject *spec,
165 int module_api_version);
166
167#ifdef Py_LIMITED_API
168#define PyModule_FromDefAndSpec(module, spec) \
169 PyModule_FromDefAndSpec2(module, spec, PYTHON_ABI_VERSION)
170#else
171#define PyModule_FromDefAndSpec(module, spec) \
172 PyModule_FromDefAndSpec2(module, spec, PYTHON_API_VERSION)
Yury Selivanovca829102015-06-02 19:06:47 -0400173#endif /* Py_LIMITED_API */
174#endif /* New in 3.5 */
Guido van Rossuma70d1601998-06-27 18:21:59 +0000175
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000176#ifndef Py_LIMITED_API
Mark Hammond91a681d2002-08-12 07:21:58 +0000177PyAPI_DATA(char *) _Py_PackageContext;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000178#endif
Guido van Rossumee6fd1c1997-11-19 18:51:35 +0000179
Guido van Rossuma3309961993-07-28 09:05:47 +0000180#ifdef __cplusplus
181}
182#endif
183#endif /* !Py_MODSUPPORT_H */