blob: 6b0acb854d8bda4c60181c18025335a0f9bf7c1e [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
23PyAPI_FUNC(PyObject *) _Py_VaBuildValue_SizeT(const char *, va_list);
Martin v. Löwis18e16552006-02-15 17:27:45 +000024#endif
25
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020026/* Due to a glitch in 3.2, the _SizeT versions weren't exported from the DLL. */
27#if !defined(PY_SSIZE_T_CLEAN) || !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000028PyAPI_FUNC(int) PyArg_Parse(PyObject *, const char *, ...);
Benjamin Petersonf6b687f2013-05-12 23:08:28 -050029PyAPI_FUNC(int) PyArg_ParseTuple(PyObject *, const char *, ...);
Mark Hammond91a681d2002-08-12 07:21:58 +000030PyAPI_FUNC(int) PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000031 const char *, char **, ...);
Benjamin Petersonfb886362010-04-24 18:21:17 +000032PyAPI_FUNC(int) PyArg_ValidateKeywordArguments(PyObject *);
Martin v. Löwis76246742006-03-01 04:06:10 +000033PyAPI_FUNC(int) PyArg_UnpackTuple(PyObject *, const char *, Py_ssize_t, Py_ssize_t, ...);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000034PyAPI_FUNC(PyObject *) Py_BuildValue(const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000035PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020036#endif
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000037#ifndef Py_LIMITED_API
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000038PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kw);
Larry Hastingsb7ccb202014-01-18 23:50:21 -080039PyAPI_FUNC(int) _PyArg_NoPositional(const char *funcname, PyObject *args);
Guido van Rossumb6775db1994-08-01 11:34:53 +000040
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000041PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000042PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000043 const char *, char **, va_list);
Martin v. Löwis75aeaa92012-06-24 00:00:30 +020044#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000045PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
Guido van Rossume5372401993-03-16 12:15:04 +000046
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030047#ifndef Py_LIMITED_API
48typedef struct _PyArg_Parser {
49 const char *format;
50 const char * const *keywords;
51 const char *fname;
52 const char *custom_msg;
53 int pos; /* number of positional-only arguments */
54 int min; /* minimal number of arguments */
55 int max; /* maximal number of positional arguments */
56 PyObject *kwtuple; /* tuple of keyword parameter names */
57 struct _PyArg_Parser *next;
58} _PyArg_Parser;
59#ifdef PY_SSIZE_T_CLEAN
60#define _PyArg_ParseTupleAndKeywordsFast _PyArg_ParseTupleAndKeywordsFast_SizeT
61#define _PyArg_VaParseTupleAndKeywordsFast _PyArg_VaParseTupleAndKeywordsFast_SizeT
62#endif
63PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
64 struct _PyArg_Parser *, ...);
65PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
66 struct _PyArg_Parser *, va_list);
67void _PyArg_Fini(void);
68#endif
69
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000070PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *);
71PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
72PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
Christian Heimes1af737c2008-01-23 08:24:23 +000073#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
74#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
Yury Selivanovca829102015-06-02 19:06:47 -040075
76#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
77/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +100078PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *);
79PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *);
80PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def);
Yury Selivanovca829102015-06-02 19:06:47 -040081#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +000082
Martin v. Löwisc15bdef2009-05-29 14:47:46 +000083#define Py_CLEANUP_SUPPORTED 0x20000
84
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000085#define PYTHON_API_VERSION 1013
86#define PYTHON_API_STRING "1013"
Guido van Rossum970a0a21995-01-09 17:47:20 +000087/* The API version is maintained (independently from the Python version)
88 so we can detect mismatches between the interpreter and dynamically
Thomas Wouters7e474022000-07-16 12:04:32 +000089 loaded modules. These are diagnosed by an error message but
Guido van Rossumae8a99e1996-07-30 16:41:02 +000090 the module is still loaded (because the mismatch can only be tested
91 after loading the module). The error message is intended to
92 explain the core dump a few seconds later.
Guido van Rossum970a0a21995-01-09 17:47:20 +000093
Guido van Rossum2ea0b061996-08-22 22:55:47 +000094 The symbol PYTHON_API_STRING defines the same value as a string
95 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
96
Guido van Rossum970a0a21995-01-09 17:47:20 +000097 Please add a line or two to the top of this log for each API
98 version change:
99
Nick Coghland5cacbb2015-05-23 22:24:10 +1000100 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths
Thomas Wouters34aa7ba2006-02-28 19:02:24 +0000101
Nick Coghland5cacbb2015-05-23 22:24:10 +1000102 19-Aug-2002 GvR 1012 Changes to string object struct for
103 interning changes, saving 3 bytes.
Guido van Rossum45ec02a2002-08-19 21:43:18 +0000104
Nick Coghland5cacbb2015-05-23 22:24:10 +1000105 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side
Tim Peters6d6c1a32001-08-02 04:15:00 +0000106
Fred Drake73a3c8f2001-01-25 22:13:34 +0000107 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and
108 PyFrame_New(); Python 2.1a2
109
Guido van Rossum21a50bd2000-03-29 01:46:45 +0000110 14-Mar-2000 GvR 1009 Unicode API added
111
Nick Coghland5cacbb2015-05-23 22:24:10 +1000112 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
Guido van Rossumf1176c41999-01-03 12:40:24 +0000113
Nick Coghland5cacbb2015-05-23 22:24:10 +1000114 3-Dec-1998 GvR 1008 Python 1.5.2b1
Guido van Rossum7531d501998-12-03 18:18:12 +0000115
Nick Coghland5cacbb2015-05-23 22:24:10 +1000116 18-Jan-1997 GvR 1007 string interning and other speedups
Guido van Rossumee5cf9b1997-01-18 07:54:03 +0000117
Nick Coghland5cacbb2015-05-23 22:24:10 +1000118 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
Guido van Rossume449af71996-10-11 16:25:41 +0000119
Nick Coghland5cacbb2015-05-23 22:24:10 +1000120 30-Jul-1996 GvR Slice and ellipses syntax added
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000121
Nick Coghland5cacbb2015-05-23 22:24:10 +1000122 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000123
Nick Coghland5cacbb2015-05-23 22:24:10 +1000124 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
Guido van Rossume0dbd591996-01-12 00:49:39 +0000125
Nick Coghland5cacbb2015-05-23 22:24:10 +1000126 10-Jan-1995 GvR Renamed globals to new naming scheme
Guido van Rossumcaa63801995-01-12 11:45:45 +0000127
Nick Coghland5cacbb2015-05-23 22:24:10 +1000128 9-Jan-1995 GvR Initial version (incompatible with older API)
Guido van Rossum970a0a21995-01-09 17:47:20 +0000129*/
130
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000131/* The PYTHON_ABI_VERSION is introduced in PEP 384. For the lifetime of
132 Python 3, it will stay at the value of 3; changes to the limited API
133 must be performed in a strictly backwards-compatible manner. */
134#define PYTHON_ABI_VERSION 3
135#define PYTHON_ABI_STRING "3"
136
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000137#ifdef Py_TRACE_REFS
Nick Coghland5cacbb2015-05-23 22:24:10 +1000138 /* When we are tracing reference counts, rename module creation functions so
Martin v. Löwis18e16552006-02-15 17:27:45 +0000139 modules compiled with incompatible settings will generate a
140 link-time error. */
Amaury Forgeot d'Arc11729992009-06-01 21:16:17 +0000141 #define PyModule_Create2 PyModule_Create2TraceRefs
Nick Coghland5cacbb2015-05-23 22:24:10 +1000142 #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000143#endif
144
Martin v. Löwis1a214512008-06-11 05:26:20 +0000145PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
146 int apiver);
Fred Draked5c84ed2000-07-08 17:25:55 +0000147
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000148#ifdef Py_LIMITED_API
149#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000150 PyModule_Create2(module, PYTHON_ABI_VERSION)
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000151#else
Martin v. Löwis1a214512008-06-11 05:26:20 +0000152#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000153 PyModule_Create2(module, PYTHON_API_VERSION)
154#endif
155
Yury Selivanovca829102015-06-02 19:06:47 -0400156#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
157/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000158PyAPI_FUNC(PyObject *) PyModule_FromDefAndSpec2(PyModuleDef *def,
159 PyObject *spec,
160 int module_api_version);
161
162#ifdef Py_LIMITED_API
163#define PyModule_FromDefAndSpec(module, spec) \
164 PyModule_FromDefAndSpec2(module, spec, PYTHON_ABI_VERSION)
165#else
166#define PyModule_FromDefAndSpec(module, spec) \
167 PyModule_FromDefAndSpec2(module, spec, PYTHON_API_VERSION)
Yury Selivanovca829102015-06-02 19:06:47 -0400168#endif /* Py_LIMITED_API */
169#endif /* New in 3.5 */
Guido van Rossuma70d1601998-06-27 18:21:59 +0000170
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000171#ifndef Py_LIMITED_API
Mark Hammond91a681d2002-08-12 07:21:58 +0000172PyAPI_DATA(char *) _Py_PackageContext;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000173#endif
Guido van Rossumee6fd1c1997-11-19 18:51:35 +0000174
Guido van Rossuma3309961993-07-28 09:05:47 +0000175#ifdef __cplusplus
176}
177#endif
178#endif /* !Py_MODSUPPORT_H */