blob: d4dddef0b5902b6890e8a59219d90a77af564e12 [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 *, ...);
Martin v. Löwisaac13162006-10-19 10:58:46 +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 **, ...);
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 *);
Christian Heimes74b8e762008-01-22 15:25:18 +000043#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
44#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
Martin v. Löwis18e16552006-02-15 17:27:45 +000045
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000046#define PYTHON_API_VERSION 1013
47#define PYTHON_API_STRING "1013"
Guido van Rossum970a0a21995-01-09 17:47:20 +000048/* The API version is maintained (independently from the Python version)
49 so we can detect mismatches between the interpreter and dynamically
Thomas Wouters7e474022000-07-16 12:04:32 +000050 loaded modules. These are diagnosed by an error message but
Guido van Rossumae8a99e1996-07-30 16:41:02 +000051 the module is still loaded (because the mismatch can only be tested
52 after loading the module). The error message is intended to
53 explain the core dump a few seconds later.
Guido van Rossum970a0a21995-01-09 17:47:20 +000054
Guido van Rossum2ea0b061996-08-22 22:55:47 +000055 The symbol PYTHON_API_STRING defines the same value as a string
56 literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
57
Guido van Rossum970a0a21995-01-09 17:47:20 +000058 Please add a line or two to the top of this log for each API
59 version change:
60
Neal Norwitze42e4052006-02-28 20:03:28 +000061 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths
Thomas Wouters34aa7ba2006-02-28 19:02:24 +000062
Guido van Rossum45ec02a2002-08-19 21:43:18 +000063 19-Aug-2002 GvR 1012 Changes to string object struct for
64 interning changes, saving 3 bytes.
65
Tim Peters6d6c1a32001-08-02 04:15:00 +000066 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side
67
Fred Drake73a3c8f2001-01-25 22:13:34 +000068 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and
69 PyFrame_New(); Python 2.1a2
70
Guido van Rossum21a50bd2000-03-29 01:46:45 +000071 14-Mar-2000 GvR 1009 Unicode API added
72
Guido van Rossumf1176c41999-01-03 12:40:24 +000073 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!)
74
75 3-Dec-1998 GvR 1008 Python 1.5.2b1
Guido van Rossum7531d501998-12-03 18:18:12 +000076
77 18-Jan-1997 GvR 1007 string interning and other speedups
Guido van Rossumee5cf9b1997-01-18 07:54:03 +000078
Guido van Rossume449af71996-10-11 16:25:41 +000079 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-(
80
Guido van Rossumae8a99e1996-07-30 16:41:02 +000081 30-Jul-1996 GvR Slice and ellipses syntax added
82
83 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-)
84
Guido van Rossume0dbd591996-01-12 00:49:39 +000085 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( )
86
Guido van Rossumcaa63801995-01-12 11:45:45 +000087 10-Jan-1995 GvR Renamed globals to new naming scheme
88
Guido van Rossum970a0a21995-01-09 17:47:20 +000089 9-Jan-1995 GvR Initial version (incompatible with older API)
90*/
91
Guido van Rossum2ea0b061996-08-22 22:55:47 +000092#ifdef MS_WINDOWS
Guido van Rossumb4cfdfa1997-09-29 23:29:08 +000093/* Special defines for Windows versions used to live here. Things
94 have changed, and the "Version" is now in a global string variable.
95 Reason for this is that this for easier branding of a "custom DLL"
96 without actually needing a recompile. */
Guido van Rossum2ea0b061996-08-22 22:55:47 +000097#endif /* MS_WINDOWS */
98
Martin v. Löwis18e16552006-02-15 17:27:45 +000099#if SIZEOF_SIZE_T != SIZEOF_INT
100/* On a 64-bit system, rename the Py_InitModule4 so that 2.4
101 modules cannot get loaded into a 2.5 interpreter */
102#define Py_InitModule4 Py_InitModule4_64
103#endif
104
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000105#ifdef Py_TRACE_REFS
Martin v. Löwis18e16552006-02-15 17:27:45 +0000106 /* When we are tracing reference counts, rename Py_InitModule4 so
107 modules compiled with incompatible settings will generate a
108 link-time error. */
109 #if SIZEOF_SIZE_T != SIZEOF_INT
110 #undef Py_InitModule4
111 #define Py_InitModule4 Py_InitModule4TraceRefs_64
112 #else
113 #define Py_InitModule4 Py_InitModule4TraceRefs
114 #endif
Guido van Rossum2ea0b061996-08-22 22:55:47 +0000115#endif
116
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000117PyAPI_FUNC(PyObject *) Py_InitModule4(const char *name, PyMethodDef *methods,
118 const char *doc, PyObject *self,
119 int apiver);
Fred Draked5c84ed2000-07-08 17:25:55 +0000120
Guido van Rossumcaa63801995-01-12 11:45:45 +0000121#define Py_InitModule(name, methods) \
122 Py_InitModule4(name, methods, (char *)NULL, (PyObject *)NULL, \
123 PYTHON_API_VERSION)
Guido van Rossuma3309961993-07-28 09:05:47 +0000124
Guido van Rossuma70d1601998-06-27 18:21:59 +0000125#define Py_InitModule3(name, methods, doc) \
126 Py_InitModule4(name, methods, doc, (PyObject *)NULL, \
127 PYTHON_API_VERSION)
128
Mark Hammond91a681d2002-08-12 07:21:58 +0000129PyAPI_DATA(char *) _Py_PackageContext;
Guido van Rossumee6fd1c1997-11-19 18:51:35 +0000130
Guido van Rossuma3309961993-07-28 09:05:47 +0000131#ifdef __cplusplus
132}
133#endif
134#endif /* !Py_MODSUPPORT_H */