blob: 23d5d3a0939ab7e9b4f2be861672add94ca98215 [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
Martin v. Löwis5cb69362006-04-14 09:08:42 +000020#define Py_BuildValue _Py_BuildValue_SizeT
21#define Py_VaBuildValue _Py_VaBuildValue_SizeT
Anthony Baxter46854bc2006-04-04 12:27:20 +000022#else
Anthony Baxter46854bc2006-04-04 12:27:20 +000023PyAPI_FUNC(PyObject *) _Py_VaBuildValue_SizeT(const char *, va_list);
24#endif
Martin v. Löwis18e16552006-02-15 17:27:45 +000025
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000026PyAPI_FUNC(int) PyArg_Parse(PyObject *, const char *, ...);
27PyAPI_FUNC(int) PyArg_ParseTuple(PyObject *, const char *, ...);
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 **, ...);
Martin v. Löwis76246742006-03-01 04:06:10 +000030PyAPI_FUNC(int) PyArg_UnpackTuple(PyObject *, const char *, Py_ssize_t, Py_ssize_t, ...);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000031PyAPI_FUNC(PyObject *) Py_BuildValue(const char *, ...);
Skip Montanaro3fca4632006-04-18 00:29:29 +000032PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000033PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kw);
Guido van Rossumb6775db1994-08-01 11:34:53 +000034
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000035PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000036PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Martin v. Löwis15e62742006-02-27 16:46:16 +000037 const char *, char **, va_list);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000038PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
Guido van Rossume5372401993-03-16 12:15:04 +000039
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000040PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *);
41PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
42PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
Fred Drake9e285152000-09-23 03:24:27 +000043
Martin v. Löwis18e16552006-02-15 17:27:45 +000044
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000045#define PYTHON_API_VERSION 1013
46#define PYTHON_API_STRING "1013"
Guido van Rossum970a0a21995-01-09 17:47:20 +000047/* The API version is maintained (independently from the Python version)
48 so we can detect mismatches between the interpreter and dynamically
Thomas Wouters7e474022000-07-16 12:04:32 +000049 loaded modules. These are diagnosed by an error message but
Guido van Rossumae8a99e1996-07-30 16:41:02 +000050 the module is still loaded (because the mismatch can only be tested
51 after loading the module). The error message is intended to
52 explain the core dump a few seconds later.
Guido van Rossum970a0a21995-01-09 17:47:20 +000053
Guido van Rossum2ea0b061996-08-22 22:55:47 +000054 The symbol PYTHON_API_STRING defines the same value as a string
55 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
56
Guido van Rossum970a0a21995-01-09 17:47:20 +000057 Please add a line or two to the top of this log for each API
58 version change:
59
Neal Norwitze42e4052006-02-28 20:03:28 +000060 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000061
Guido van Rossum45ec02a2002-08-19 21:43:18 +000062 19-Aug-2002 GvR 1012 Changes to string object struct for
63 interning changes, saving 3 bytes.
64
Tim Peters6d6c1a32001-08-02 04:15:00 +000065 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side
66
Fred Drake73a3c8f2001-01-25 22:13:34 +000067 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and
68 PyFrame_New(); Python 2.1a2
69
Guido van Rossum21a50bd2000-03-29 01:46:45 +000070 14-Mar-2000 GvR 1009 Unicode API added
71
Guido van Rossumf1176c41999-01-03 12:40:24 +000072 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
73
74 3-Dec-1998 GvR 1008 Python 1.5.2b1
Guido van Rossum7531d501998-12-03 18:18:12 +000075
76 18-Jan-1997 GvR 1007 string interning and other speedups
Guido van Rossumee5cf9b1997-01-18 07:54:03 +000077
Guido van Rossume449af71996-10-11 16:25:41 +000078 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
79
Guido van Rossumae8a99e1996-07-30 16:41:02 +000080 30-Jul-1996 GvR Slice and ellipses syntax added
81
82 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
83
Guido van Rossume0dbd591996-01-12 00:49:39 +000084 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
85
Guido van Rossumcaa63801995-01-12 11:45:45 +000086 10-Jan-1995 GvR Renamed globals to new naming scheme
87
Guido van Rossum970a0a21995-01-09 17:47:20 +000088 9-Jan-1995 GvR Initial version (incompatible with older API)
89*/
90
Guido van Rossum2ea0b061996-08-22 22:55:47 +000091#ifdef MS_WINDOWS
Guido van Rossumb4cfdfa1997-09-29 23:29:08 +000092/* Special defines for Windows versions used to live here. Things
93 have changed, and the "Version" is now in a global string variable.
94 Reason for this is that this for easier branding of a "custom DLL"
95 without actually needing a recompile. */
Guido van Rossum2ea0b061996-08-22 22:55:47 +000096#endif /* MS_WINDOWS */
97
Martin v. Löwis18e16552006-02-15 17:27:45 +000098#if SIZEOF_SIZE_T != SIZEOF_INT
99/* On a 64-bit system, rename the Py_InitModule4 so that 2.4
100 modules cannot get loaded into a 2.5 interpreter */
101#define Py_InitModule4 Py_InitModule4_64
102#endif
103
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000104#ifdef Py_TRACE_REFS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000105 /* When we are tracing reference counts, rename Py_InitModule4 so
106 modules compiled with incompatible settings will generate a
107 link-time error. */
108 #if SIZEOF_SIZE_T != SIZEOF_INT
109 #undef Py_InitModule4
110 #define Py_InitModule4 Py_InitModule4TraceRefs_64
111 #else
112 #define Py_InitModule4 Py_InitModule4TraceRefs
113 #endif
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000114#endif
115
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000116PyAPI_FUNC(PyObject *) Py_InitModule4(const char *name, PyMethodDef *methods,
117 const char *doc, PyObject *self,
118 int apiver);
Fred Draked5c84ed2000-07-08 17:25:55 +0000119
Guido van Rossumcaa63801995-01-12 11:45:45 +0000120#define Py_InitModule(name, methods) \
121 Py_InitModule4(name, methods, (char *)NULL, (PyObject *)NULL, \
122 PYTHON_API_VERSION)
Guido van Rossuma3309961993-07-28 09:05:47 +0000123
Guido van Rossuma70d1601998-06-27 18:21:59 +0000124#define Py_InitModule3(name, methods, doc) \
125 Py_InitModule4(name, methods, doc, (PyObject *)NULL, \
126 PYTHON_API_VERSION)
127
Mark Hammond91a681d2002-08-12 07:21:58 +0000128PyAPI_DATA(char *) _Py_PackageContext;
Guido van Rossumee6fd1c1997-11-19 18:51:35 +0000129
Guido van Rossuma3309961993-07-28 09:05:47 +0000130#ifdef __cplusplus
131}
132#endif
133#endif /* !Py_MODSUPPORT_H */