blob: 57886df8905e3cd57d1c8412661e5510720bdd1f [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
15#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
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000020#define Py_BuildValue _Py_BuildValue_SizeT
21#define Py_VaBuildValue _Py_VaBuildValue_SizeT
22#else
23PyAPI_FUNC(PyObject *) _Py_VaBuildValue_SizeT(const char *, va_list);
Martin v. Löwis18e16552006-02-15 17:27:45 +000024#endif
25
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000026PyAPI_FUNC(int) PyArg_Parse(PyObject *, const char *, ...);
Thomas Wouters89f507f2006-12-13 04:49:30 +000027PyAPI_FUNC(int) PyArg_ParseTuple(PyObject *, const char *, ...) Py_FORMAT_PARSETUPLE(PyArg_ParseTuple, 2, 3);
Mark Hammond91a681d2002-08-12 07:21:58 +000028PyAPI_FUNC(int) PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000029 const char *, char **, ...);
Benjamin Petersonfb886362010-04-24 18:21:17 +000030PyAPI_FUNC(int) PyArg_ValidateKeywordArguments(PyObject *);
Martin v. Löwis76246742006-03-01 04:06:10 +000031PyAPI_FUNC(int) PyArg_UnpackTuple(PyObject *, const char *, Py_ssize_t, Py_ssize_t, ...);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000032PyAPI_FUNC(PyObject *) Py_BuildValue(const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000033PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000034PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kw);
Guido van Rossumb6775db1994-08-01 11:34:53 +000035
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000036PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000037PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000038 const char *, char **, va_list);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000039PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
Guido van Rossume5372401993-03-16 12:15:04 +000040
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000041PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *);
42PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
43PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
Christian Heimes1af737c2008-01-23 08:24:23 +000044#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
45#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
Martin v. Löwis18e16552006-02-15 17:27:45 +000046
Martin v. Löwisc15bdef2009-05-29 14:47:46 +000047#define Py_CLEANUP_SUPPORTED 0x20000
48
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000049#define PYTHON_API_VERSION 1013
50#define PYTHON_API_STRING "1013"
Guido van Rossum970a0a21995-01-09 17:47:20 +000051/* The API version is maintained (independently from the Python version)
52 so we can detect mismatches between the interpreter and dynamically
Thomas Wouters7e474022000-07-16 12:04:32 +000053 loaded modules. These are diagnosed by an error message but
Guido van Rossumae8a99e1996-07-30 16:41:02 +000054 the module is still loaded (because the mismatch can only be tested
55 after loading the module). The error message is intended to
56 explain the core dump a few seconds later.
Guido van Rossum970a0a21995-01-09 17:47:20 +000057
Guido van Rossum2ea0b061996-08-22 22:55:47 +000058 The symbol PYTHON_API_STRING defines the same value as a string
59 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
60
Guido van Rossum970a0a21995-01-09 17:47:20 +000061 Please add a line or two to the top of this log for each API
62 version change:
63
Neal Norwitze42e4052006-02-28 20:03:28 +000064 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000065
Guido van Rossum45ec02a2002-08-19 21:43:18 +000066 19-Aug-2002 GvR 1012 Changes to string object struct for
67 interning changes, saving 3 bytes.
68
Tim Peters6d6c1a32001-08-02 04:15:00 +000069 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side
70
Fred Drake73a3c8f2001-01-25 22:13:34 +000071 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and
72 PyFrame_New(); Python 2.1a2
73
Guido van Rossum21a50bd2000-03-29 01:46:45 +000074 14-Mar-2000 GvR 1009 Unicode API added
75
Guido van Rossumf1176c41999-01-03 12:40:24 +000076 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
77
78 3-Dec-1998 GvR 1008 Python 1.5.2b1
Guido van Rossum7531d501998-12-03 18:18:12 +000079
80 18-Jan-1997 GvR 1007 string interning and other speedups
Guido van Rossumee5cf9b1997-01-18 07:54:03 +000081
Guido van Rossume449af71996-10-11 16:25:41 +000082 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
83
Guido van Rossumae8a99e1996-07-30 16:41:02 +000084 30-Jul-1996 GvR Slice and ellipses syntax added
85
86 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
87
Guido van Rossume0dbd591996-01-12 00:49:39 +000088 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
89
Guido van Rossumcaa63801995-01-12 11:45:45 +000090 10-Jan-1995 GvR Renamed globals to new naming scheme
91
Guido van Rossum970a0a21995-01-09 17:47:20 +000092 9-Jan-1995 GvR Initial version (incompatible with older API)
93*/
94
Guido van Rossum2ea0b061996-08-22 22:55:47 +000095#ifdef Py_TRACE_REFS
Amaury Forgeot d'Arc11729992009-06-01 21:16:17 +000096 /* When we are tracing reference counts, rename PyModule_Create2 so
Martin v. Löwis18e16552006-02-15 17:27:45 +000097 modules compiled with incompatible settings will generate a
98 link-time error. */
Amaury Forgeot d'Arc11729992009-06-01 21:16:17 +000099 #define PyModule_Create2 PyModule_Create2TraceRefs
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000100#endif
101
Martin v. Löwis1a214512008-06-11 05:26:20 +0000102PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
103 int apiver);
Fred Draked5c84ed2000-07-08 17:25:55 +0000104
Martin v. Löwis1a214512008-06-11 05:26:20 +0000105#define PyModule_Create(module) \
106 PyModule_Create2(module, PYTHON_API_VERSION)
Guido van Rossuma70d1601998-06-27 18:21:59 +0000107
Mark Hammond91a681d2002-08-12 07:21:58 +0000108PyAPI_DATA(char *) _Py_PackageContext;
Guido van Rossumee6fd1c1997-11-19 18:51:35 +0000109
Guido van Rossuma3309961993-07-28 09:05:47 +0000110#ifdef __cplusplus
111}
112#endif
113#endif /* !Py_MODSUPPORT_H */