modsupport.h 7.6 KB
Newer Older
1

2 3 4 5 6 7
#ifndef Py_MODSUPPORT_H
#define Py_MODSUPPORT_H
#ifdef __cplusplus
extern "C" {
#endif

Guido van Rossum's avatar
Guido van Rossum committed
8 9
/* Module support interface */

10
#include <stdarg.h>
11

Martin v. Löwis's avatar
Martin v. Löwis committed
12 13 14
/* If PY_SSIZE_T_CLEAN is defined, each functions treats #-specifier
   to mean Py_ssize_t */
#ifdef PY_SSIZE_T_CLEAN
15 16 17
#define PyArg_Parse                     _PyArg_Parse_SizeT
#define PyArg_ParseTuple                _PyArg_ParseTuple_SizeT
#define PyArg_ParseTupleAndKeywords     _PyArg_ParseTupleAndKeywords_SizeT
18
#ifndef Py_LIMITED_API
19 20
#define PyArg_VaParse                   _PyArg_VaParse_SizeT
#define PyArg_VaParseTupleAndKeywords   _PyArg_VaParseTupleAndKeywords_SizeT
21
#endif /* !Py_LIMITED_API */
22 23
#define Py_BuildValue                   _Py_BuildValue_SizeT
#define Py_VaBuildValue                 _Py_VaBuildValue_SizeT
24
#define _Py_VaBuildStack                _Py_VaBuildStack_SizeT
25
#else
26
#ifndef Py_LIMITED_API
27
PyAPI_FUNC(PyObject *) _Py_VaBuildValue_SizeT(const char *, va_list);
28 29 30 31 32 33
PyAPI_FUNC(PyObject **) _Py_VaBuildStack_SizeT(
    PyObject **small_stack,
    Py_ssize_t small_stack_len,
    const char *format,
    va_list va,
    Py_ssize_t *p_nargs);
34
#endif /* !Py_LIMITED_API */
Martin v. Löwis's avatar
Martin v. Löwis committed
35 36
#endif

37 38
/* Due to a glitch in 3.2, the _SizeT versions weren't exported from the DLL. */
#if !defined(PY_SSIZE_T_CLEAN) || !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
39
PyAPI_FUNC(int) PyArg_Parse(PyObject *, const char *, ...);
40
PyAPI_FUNC(int) PyArg_ParseTuple(PyObject *, const char *, ...);
41
PyAPI_FUNC(int) PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
42
                                                  const char *, char **, ...);
43
PyAPI_FUNC(int) PyArg_ValidateKeywordArguments(PyObject *);
44
PyAPI_FUNC(int) PyArg_UnpackTuple(PyObject *, const char *, Py_ssize_t, Py_ssize_t, ...);
45
PyAPI_FUNC(PyObject *) Py_BuildValue(const char *, ...);
46
PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
47
#endif
48
#ifndef Py_LIMITED_API
49
PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kw);
50
PyAPI_FUNC(int) _PyArg_NoPositional(const char *funcname, PyObject *args);
51

52
PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list);
53
PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
54
                                                  const char *, char **, va_list);
55
#endif
56
PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
57 58 59 60 61 62
PyAPI_FUNC(PyObject **) _Py_VaBuildStack(
    PyObject **small_stack,
    Py_ssize_t small_stack_len,
    const char *format,
    va_list va,
    Py_ssize_t *p_nargs);
63

64 65 66 67 68 69 70 71 72 73 74 75 76 77
#ifndef Py_LIMITED_API
typedef struct _PyArg_Parser {
    const char *format;
    const char * const *keywords;
    const char *fname;
    const char *custom_msg;
    int pos;            /* number of positional-only arguments */
    int min;            /* minimal number of arguments */
    int max;            /* maximal number of positional arguments */
    PyObject *kwtuple;  /* tuple of keyword parameter names */
    struct _PyArg_Parser *next;
} _PyArg_Parser;
#ifdef PY_SSIZE_T_CLEAN
#define _PyArg_ParseTupleAndKeywordsFast  _PyArg_ParseTupleAndKeywordsFast_SizeT
78
#define _PyArg_ParseStack  _PyArg_ParseStack_SizeT
79 80 81 82
#define _PyArg_VaParseTupleAndKeywordsFast  _PyArg_VaParseTupleAndKeywordsFast_SizeT
#endif
PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
                                                 struct _PyArg_Parser *, ...);
83 84
PyAPI_FUNC(int) _PyArg_ParseStack(PyObject **args, Py_ssize_t nargs, PyObject *kwnames,
                                  struct _PyArg_Parser *, ...);
85 86 87 88 89
PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
                                                   struct _PyArg_Parser *, va_list);
void _PyArg_Fini(void);
#endif

90 91 92
PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *);
PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
93 94
#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
95 96 97

#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
/* New in 3.5 */
98 99 100
PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *);
PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *);
PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def);
101
#endif
Martin v. Löwis's avatar
Martin v. Löwis committed
102

103 104
#define Py_CLEANUP_SUPPORTED 0x20000

105 106
#define PYTHON_API_VERSION 1013
#define PYTHON_API_STRING "1013"
Guido van Rossum's avatar
Guido van Rossum committed
107 108
/* The API version is maintained (independently from the Python version)
   so we can detect mismatches between the interpreter and dynamically
109
   loaded modules.  These are diagnosed by an error message but
110 111 112
   the module is still loaded (because the mismatch can only be tested
   after loading the module).  The error message is intended to
   explain the core dump a few seconds later.
Guido van Rossum's avatar
Guido van Rossum committed
113

114 115 116
   The symbol PYTHON_API_STRING defines the same value as a string
   literal.  *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***

Guido van Rossum's avatar
Guido van Rossum committed
117 118 119
   Please add a line or two to the top of this log for each API
   version change:

120
   22-Feb-2006  MvL     1013    PEP 353 - long indices for sequence lengths
121

122 123
   19-Aug-2002  GvR     1012    Changes to string object struct for
                                interning changes, saving 3 bytes.
124

125
   17-Jul-2001  GvR     1011    Descr-branch, just to be on the safe side
126

127 128 129
   25-Jan-2001  FLD     1010    Parameters added to PyCode_New() and
                                PyFrame_New(); Python 2.1a2

130 131
   14-Mar-2000  GvR     1009    Unicode API added

132
   3-Jan-1999   GvR     1007    Decided to change back!  (Don't reuse 1008!)
133

134
   3-Dec-1998   GvR     1008    Python 1.5.2b1
135

136
   18-Jan-1997  GvR     1007    string interning and other speedups
137

138
   11-Oct-1996  GvR     renamed Py_Ellipses to Py_Ellipsis :-(
139

140
   30-Jul-1996  GvR     Slice and ellipses syntax added
141

142
   23-Jul-1996  GvR     For 1.4 -- better safe than sorry this time :-)
143

144
   7-Nov-1995   GvR     Keyword arguments (should've been done at 1.3 :-( )
Guido van Rossum's avatar
Guido van Rossum committed
145

146
   10-Jan-1995  GvR     Renamed globals to new naming scheme
147

148
   9-Jan-1995   GvR     Initial version (incompatible with older API)
Guido van Rossum's avatar
Guido van Rossum committed
149 150
*/

151 152 153 154 155 156
/* The PYTHON_ABI_VERSION is introduced in PEP 384. For the lifetime of
   Python 3, it will stay at the value of 3; changes to the limited API
   must be performed in a strictly backwards-compatible manner. */
#define PYTHON_ABI_VERSION 3
#define PYTHON_ABI_STRING "3"

157
#ifdef Py_TRACE_REFS
158
 /* When we are tracing reference counts, rename module creation functions so
Martin v. Löwis's avatar
Martin v. Löwis committed
159 160
    modules compiled with incompatible settings will generate a
    link-time error. */
161
 #define PyModule_Create2 PyModule_Create2TraceRefs
162
 #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
163 164
#endif

165 166
PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
                                     int apiver);
167

168 169
#ifdef Py_LIMITED_API
#define PyModule_Create(module) \
170
        PyModule_Create2(module, PYTHON_ABI_VERSION)
171
#else
172
#define PyModule_Create(module) \
173 174 175
        PyModule_Create2(module, PYTHON_API_VERSION)
#endif

176 177
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
/* New in 3.5 */
178 179 180 181 182 183 184 185 186 187
PyAPI_FUNC(PyObject *) PyModule_FromDefAndSpec2(PyModuleDef *def,
                                                PyObject *spec,
                                                int module_api_version);

#ifdef Py_LIMITED_API
#define PyModule_FromDefAndSpec(module, spec) \
    PyModule_FromDefAndSpec2(module, spec, PYTHON_ABI_VERSION)
#else
#define PyModule_FromDefAndSpec(module, spec) \
    PyModule_FromDefAndSpec2(module, spec, PYTHON_API_VERSION)
188 189
#endif /* Py_LIMITED_API */
#endif /* New in 3.5 */
190

191
#ifndef Py_LIMITED_API
192
PyAPI_DATA(const char *) _Py_PackageContext;
193
#endif
194

195 196 197 198
#ifdef __cplusplus
}
#endif
#endif /* !Py_MODSUPPORT_H */