Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 1 | |
Fred Drake | d5c84ed | 2000-07-08 17:25:55 +0000 | [diff] [blame] | 2 | #ifndef Py_MODSUPPORT_H |
| 3 | #define Py_MODSUPPORT_H |
| 4 | #ifdef __cplusplus |
| 5 | extern "C" { |
| 6 | #endif |
| 7 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 8 | /* Module support interface */ |
| 9 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 10 | #include <stdarg.h> |
| 11 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 12 | /* If PY_SSIZE_T_CLEAN is defined, each functions treats #-specifier |
| 13 | to mean Py_ssize_t */ |
| 14 | #ifdef PY_SSIZE_T_CLEAN |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 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 |
| 20 | #define Py_BuildValue _Py_BuildValue_SizeT |
| 21 | #define Py_VaBuildValue _Py_VaBuildValue_SizeT |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 22 | #else |
| 23 | PyAPI_FUNC(PyObject *) _Py_VaBuildValue_SizeT(const char *, va_list); |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 24 | #endif |
| 25 | |
Martin v. Löwis | 75aeaa9 | 2012-06-24 00:00:30 +0200 | [diff] [blame] | 26 | /* 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 Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 28 | PyAPI_FUNC(int) PyArg_Parse(PyObject *, const char *, ...); |
Benjamin Peterson | f6b687f | 2013-05-12 23:08:28 -0500 | [diff] [blame] | 29 | PyAPI_FUNC(int) PyArg_ParseTuple(PyObject *, const char *, ...); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 30 | PyAPI_FUNC(int) PyArg_ParseTupleAndKeywords(PyObject *, PyObject *, |
Martin v. Löwis | 15e6274 | 2006-02-27 16:46:16 +0000 | [diff] [blame] | 31 | const char *, char **, ...); |
Benjamin Peterson | fb88636 | 2010-04-24 18:21:17 +0000 | [diff] [blame] | 32 | PyAPI_FUNC(int) PyArg_ValidateKeywordArguments(PyObject *); |
Martin v. Löwis | 7624674 | 2006-03-01 04:06:10 +0000 | [diff] [blame] | 33 | PyAPI_FUNC(int) PyArg_UnpackTuple(PyObject *, const char *, Py_ssize_t, Py_ssize_t, ...); |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 34 | PyAPI_FUNC(PyObject *) Py_BuildValue(const char *, ...); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 35 | PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...); |
Martin v. Löwis | 75aeaa9 | 2012-06-24 00:00:30 +0200 | [diff] [blame] | 36 | #endif |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 37 | #ifndef Py_LIMITED_API |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 38 | PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kw); |
Larry Hastings | b7ccb20 | 2014-01-18 23:50:21 -0800 | [diff] [blame] | 39 | PyAPI_FUNC(int) _PyArg_NoPositional(const char *funcname, PyObject *args); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 40 | |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 41 | PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list); |
Brett Cannon | 711e7d9 | 2004-07-10 22:20:32 +0000 | [diff] [blame] | 42 | PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *, |
Martin v. Löwis | 15e6274 | 2006-02-27 16:46:16 +0000 | [diff] [blame] | 43 | const char *, char **, va_list); |
Martin v. Löwis | 75aeaa9 | 2012-06-24 00:00:30 +0200 | [diff] [blame] | 44 | #endif |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 45 | PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list); |
Guido van Rossum | e537240 | 1993-03-16 12:15:04 +0000 | [diff] [blame] | 46 | |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 47 | PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *); |
| 48 | PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long); |
| 49 | PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *); |
Christian Heimes | 1af737c | 2008-01-23 08:24:23 +0000 | [diff] [blame] | 50 | #define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c) |
| 51 | #define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c) |
Yury Selivanov | ca82910 | 2015-06-02 19:06:47 -0400 | [diff] [blame] | 52 | |
| 53 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000 |
| 54 | /* New in 3.5 */ |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 55 | PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *); |
| 56 | PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *); |
| 57 | PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def); |
Yury Selivanov | ca82910 | 2015-06-02 19:06:47 -0400 | [diff] [blame] | 58 | #endif |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 59 | |
Martin v. Löwis | c15bdef | 2009-05-29 14:47:46 +0000 | [diff] [blame] | 60 | #define Py_CLEANUP_SUPPORTED 0x20000 |
| 61 | |
Thomas Wouters | 34aa7ba | 2006-02-28 19:02:24 +0000 | [diff] [blame] | 62 | #define PYTHON_API_VERSION 1013 |
| 63 | #define PYTHON_API_STRING "1013" |
Guido van Rossum | 970a0a2 | 1995-01-09 17:47:20 +0000 | [diff] [blame] | 64 | /* The API version is maintained (independently from the Python version) |
| 65 | so we can detect mismatches between the interpreter and dynamically |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 66 | loaded modules. These are diagnosed by an error message but |
Guido van Rossum | ae8a99e | 1996-07-30 16:41:02 +0000 | [diff] [blame] | 67 | 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 Rossum | 970a0a2 | 1995-01-09 17:47:20 +0000 | [diff] [blame] | 70 | |
Guido van Rossum | 2ea0b06 | 1996-08-22 22:55:47 +0000 | [diff] [blame] | 71 | The symbol PYTHON_API_STRING defines the same value as a string |
| 72 | literal. *** PLEASE MAKE SURE THE DEFINITIONS MATCH. *** |
| 73 | |
Guido van Rossum | 970a0a2 | 1995-01-09 17:47:20 +0000 | [diff] [blame] | 74 | Please add a line or two to the top of this log for each API |
| 75 | version change: |
| 76 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 77 | 22-Feb-2006 MvL 1013 PEP 353 - long indices for sequence lengths |
Thomas Wouters | 34aa7ba | 2006-02-28 19:02:24 +0000 | [diff] [blame] | 78 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 79 | 19-Aug-2002 GvR 1012 Changes to string object struct for |
| 80 | interning changes, saving 3 bytes. |
Guido van Rossum | 45ec02a | 2002-08-19 21:43:18 +0000 | [diff] [blame] | 81 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 82 | 17-Jul-2001 GvR 1011 Descr-branch, just to be on the safe side |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 83 | |
Fred Drake | 73a3c8f | 2001-01-25 22:13:34 +0000 | [diff] [blame] | 84 | 25-Jan-2001 FLD 1010 Parameters added to PyCode_New() and |
| 85 | PyFrame_New(); Python 2.1a2 |
| 86 | |
Guido van Rossum | 21a50bd | 2000-03-29 01:46:45 +0000 | [diff] [blame] | 87 | 14-Mar-2000 GvR 1009 Unicode API added |
| 88 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 89 | 3-Jan-1999 GvR 1007 Decided to change back! (Don't reuse 1008!) |
Guido van Rossum | f1176c4 | 1999-01-03 12:40:24 +0000 | [diff] [blame] | 90 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 91 | 3-Dec-1998 GvR 1008 Python 1.5.2b1 |
Guido van Rossum | 7531d50 | 1998-12-03 18:18:12 +0000 | [diff] [blame] | 92 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 93 | 18-Jan-1997 GvR 1007 string interning and other speedups |
Guido van Rossum | ee5cf9b | 1997-01-18 07:54:03 +0000 | [diff] [blame] | 94 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 95 | 11-Oct-1996 GvR renamed Py_Ellipses to Py_Ellipsis :-( |
Guido van Rossum | e449af7 | 1996-10-11 16:25:41 +0000 | [diff] [blame] | 96 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 97 | 30-Jul-1996 GvR Slice and ellipses syntax added |
Guido van Rossum | ae8a99e | 1996-07-30 16:41:02 +0000 | [diff] [blame] | 98 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 99 | 23-Jul-1996 GvR For 1.4 -- better safe than sorry this time :-) |
Guido van Rossum | ae8a99e | 1996-07-30 16:41:02 +0000 | [diff] [blame] | 100 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 101 | 7-Nov-1995 GvR Keyword arguments (should've been done at 1.3 :-( ) |
Guido van Rossum | e0dbd59 | 1996-01-12 00:49:39 +0000 | [diff] [blame] | 102 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 103 | 10-Jan-1995 GvR Renamed globals to new naming scheme |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 104 | |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 105 | 9-Jan-1995 GvR Initial version (incompatible with older API) |
Guido van Rossum | 970a0a2 | 1995-01-09 17:47:20 +0000 | [diff] [blame] | 106 | */ |
| 107 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 108 | /* 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 Rossum | 2ea0b06 | 1996-08-22 22:55:47 +0000 | [diff] [blame] | 114 | #ifdef Py_TRACE_REFS |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 115 | /* When we are tracing reference counts, rename module creation functions so |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 116 | modules compiled with incompatible settings will generate a |
| 117 | link-time error. */ |
Amaury Forgeot d'Arc | 1172999 | 2009-06-01 21:16:17 +0000 | [diff] [blame] | 118 | #define PyModule_Create2 PyModule_Create2TraceRefs |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 119 | #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs |
Guido van Rossum | 2ea0b06 | 1996-08-22 22:55:47 +0000 | [diff] [blame] | 120 | #endif |
| 121 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 122 | PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*, |
| 123 | int apiver); |
Fred Drake | d5c84ed | 2000-07-08 17:25:55 +0000 | [diff] [blame] | 124 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 125 | #ifdef Py_LIMITED_API |
| 126 | #define PyModule_Create(module) \ |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 127 | PyModule_Create2(module, PYTHON_ABI_VERSION) |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 128 | #else |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 129 | #define PyModule_Create(module) \ |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 130 | PyModule_Create2(module, PYTHON_API_VERSION) |
| 131 | #endif |
| 132 | |
Yury Selivanov | ca82910 | 2015-06-02 19:06:47 -0400 | [diff] [blame] | 133 | #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000 |
| 134 | /* New in 3.5 */ |
Nick Coghlan | d5cacbb | 2015-05-23 22:24:10 +1000 | [diff] [blame] | 135 | PyAPI_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 Selivanov | ca82910 | 2015-06-02 19:06:47 -0400 | [diff] [blame] | 145 | #endif /* Py_LIMITED_API */ |
| 146 | #endif /* New in 3.5 */ |
Guido van Rossum | a70d160 | 1998-06-27 18:21:59 +0000 | [diff] [blame] | 147 | |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 148 | #ifndef Py_LIMITED_API |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 149 | PyAPI_DATA(char *) _Py_PackageContext; |
Martin v. Löwis | 4d0d471 | 2010-12-03 20:14:31 +0000 | [diff] [blame] | 150 | #endif |
Guido van Rossum | ee6fd1c | 1997-11-19 18:51:35 +0000 | [diff] [blame] | 151 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 152 | #ifdef __cplusplus |
| 153 | } |
| 154 | #endif |
| 155 | #endif /* !Py_MODSUPPORT_H */ |