blob: 829aaf8596833b4d5f669c7cd4c6639edcebd27a [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
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000047PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *);
48PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
49PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
Christian Heimes1af737c2008-01-23 08:24:23 +000050#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
51#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
Yury Selivanovca829102015-06-02 19:06:47 -040052
53#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
54/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +100055PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *);
56PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *);
57PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def);
Yury Selivanovca829102015-06-02 19:06:47 -040058#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +000059
Martin v. Löwisc15bdef2009-05-29 14:47:46 +000060#define Py_CLEANUP_SUPPORTED 0x20000
61
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000062#define PYTHON_API_VERSION 1013
63#define PYTHON_API_STRING "1013"
Guido van Rossum970a0a21995-01-09 17:47:20 +000064/* The API version is maintained (independently from the Python version)
65 so we can detect mismatches between the interpreter and dynamically
Thomas Wouters7e474022000-07-16 12:04:32 +000066 loaded modules. These are diagnosed by an error message but
Guido van Rossumae8a99e1996-07-30 16:41:02 +000067 the module is still loaded (because the mismatch can only be tested
68 after loading the module). The error message is intended to
69 explain the core dump a few seconds later.
Guido van Rossum970a0a21995-01-09 17:47:20 +000070
Guido van Rossum2ea0b061996-08-22 22:55:47 +000071 The symbol PYTHON_API_STRING defines the same value as a string
72 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
73
Guido van Rossum970a0a21995-01-09 17:47:20 +000074 Please add a line or two to the top of this log for each API
75 version change:
76
Nick Coghland5cacbb2015-05-23 22:24:10 +100077 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000078
Nick Coghland5cacbb2015-05-23 22:24:10 +100079 19-Aug-2002 GvR 1012 Changes to string object struct for
80 interning changes, saving 3 bytes.
Guido van Rossum45ec02a2002-08-19 21:43:18 +000081
Nick Coghland5cacbb2015-05-23 22:24:10 +100082 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side
Tim Peters6d6c1a32001-08-02 04:15:00 +000083
Fred Drake73a3c8f2001-01-25 22:13:34 +000084 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and
85 PyFrame_New(); Python 2.1a2
86
Guido van Rossum21a50bd2000-03-29 01:46:45 +000087 14-Mar-2000 GvR 1009 Unicode API added
88
Nick Coghland5cacbb2015-05-23 22:24:10 +100089 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
Guido van Rossumf1176c41999-01-03 12:40:24 +000090
Nick Coghland5cacbb2015-05-23 22:24:10 +100091 3-Dec-1998 GvR 1008 Python 1.5.2b1
Guido van Rossum7531d501998-12-03 18:18:12 +000092
Nick Coghland5cacbb2015-05-23 22:24:10 +100093 18-Jan-1997 GvR 1007 string interning and other speedups
Guido van Rossumee5cf9b1997-01-18 07:54:03 +000094
Nick Coghland5cacbb2015-05-23 22:24:10 +100095 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
Guido van Rossume449af71996-10-11 16:25:41 +000096
Nick Coghland5cacbb2015-05-23 22:24:10 +100097 30-Jul-1996 GvR Slice and ellipses syntax added
Guido van Rossumae8a99e1996-07-30 16:41:02 +000098
Nick Coghland5cacbb2015-05-23 22:24:10 +100099 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
Guido van Rossumae8a99e1996-07-30 16:41:02 +0000100
Nick Coghland5cacbb2015-05-23 22:24:10 +1000101 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
Guido van Rossume0dbd591996-01-12 00:49:39 +0000102
Nick Coghland5cacbb2015-05-23 22:24:10 +1000103 10-Jan-1995 GvR Renamed globals to new naming scheme
Guido van Rossumcaa63801995-01-12 11:45:45 +0000104
Nick Coghland5cacbb2015-05-23 22:24:10 +1000105 9-Jan-1995 GvR Initial version (incompatible with older API)
Guido van Rossum970a0a21995-01-09 17:47:20 +0000106*/
107
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000108/* The PYTHON_ABI_VERSION is introduced in PEP 384. For the lifetime of
109 Python 3, it will stay at the value of 3; changes to the limited API
110 must be performed in a strictly backwards-compatible manner. */
111#define PYTHON_ABI_VERSION 3
112#define PYTHON_ABI_STRING "3"
113
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000114#ifdef Py_TRACE_REFS
Nick Coghland5cacbb2015-05-23 22:24:10 +1000115 /* When we are tracing reference counts, rename module creation functions so
Martin v. Löwis18e16552006-02-15 17:27:45 +0000116 modules compiled with incompatible settings will generate a
117 link-time error. */
Amaury Forgeot d'Arc11729992009-06-01 21:16:17 +0000118 #define PyModule_Create2 PyModule_Create2TraceRefs
Nick Coghland5cacbb2015-05-23 22:24:10 +1000119 #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000120#endif
121
Martin v. Löwis1a214512008-06-11 05:26:20 +0000122PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
123 int apiver);
Fred Draked5c84ed2000-07-08 17:25:55 +0000124
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000125#ifdef Py_LIMITED_API
126#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000127 PyModule_Create2(module, PYTHON_ABI_VERSION)
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000128#else
Martin v. Löwis1a214512008-06-11 05:26:20 +0000129#define PyModule_Create(module) \
Nick Coghland5cacbb2015-05-23 22:24:10 +1000130 PyModule_Create2(module, PYTHON_API_VERSION)
131#endif
132
Yury Selivanovca829102015-06-02 19:06:47 -0400133#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
134/* New in 3.5 */
Nick Coghland5cacbb2015-05-23 22:24:10 +1000135PyAPI_FUNC(PyObject *) PyModule_FromDefAndSpec2(PyModuleDef *def,
136 PyObject *spec,
137 int module_api_version);
138
139#ifdef Py_LIMITED_API
140#define PyModule_FromDefAndSpec(module, spec) \
141 PyModule_FromDefAndSpec2(module, spec, PYTHON_ABI_VERSION)
142#else
143#define PyModule_FromDefAndSpec(module, spec) \
144 PyModule_FromDefAndSpec2(module, spec, PYTHON_API_VERSION)
Yury Selivanovca829102015-06-02 19:06:47 -0400145#endif /* Py_LIMITED_API */
146#endif /* New in 3.5 */
Guido van Rossuma70d1601998-06-27 18:21:59 +0000147
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000148#ifndef Py_LIMITED_API
Mark Hammond91a681d2002-08-12 07:21:58 +0000149PyAPI_DATA(char *) _Py_PackageContext;
Martin v. Löwis4d0d4712010-12-03 20:14:31 +0000150#endif
Guido van Rossumee6fd1c1997-11-19 18:51:35 +0000151
Guido van Rossuma3309961993-07-28 09:05:47 +0000152#ifdef __cplusplus
153}
154#endif
155#endif /* !Py_MODSUPPORT_H */