modsupport.h 8.36 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 18 19 20 21
#define PyArg_Parse                     _PyArg_Parse_SizeT
#define PyArg_ParseTuple                _PyArg_ParseTuple_SizeT
#define PyArg_ParseTupleAndKeywords     _PyArg_ParseTupleAndKeywords_SizeT
#define PyArg_VaParse                   _PyArg_VaParse_SizeT
#define PyArg_VaParseTupleAndKeywords   _PyArg_VaParseTupleAndKeywords_SizeT
#define Py_BuildValue                   _Py_BuildValue_SizeT
#define Py_VaBuildValue                 _Py_VaBuildValue_SizeT
22
#ifndef Py_LIMITED_API
23
#define _Py_VaBuildStack                _Py_VaBuildStack_SizeT
24
#endif
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 44 45 46
PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list);
PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
                                                  const char *, char **, va_list);
#endif
47
PyAPI_FUNC(int) PyArg_ValidateKeywordArguments(PyObject *);
48
PyAPI_FUNC(int) PyArg_UnpackTuple(PyObject *, const char *, Py_ssize_t, Py_ssize_t, ...);
49
PyAPI_FUNC(PyObject *) Py_BuildValue(const char *, ...);
50
PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
51

52

53
#ifndef Py_LIMITED_API
54
PyAPI_FUNC(int) _PyArg_UnpackStack(
55
    PyObject *const *args,
56 57 58 59 60 61
    Py_ssize_t nargs,
    const char *name,
    Py_ssize_t min,
    Py_ssize_t max,
    ...);

62
PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kwargs);
63
PyAPI_FUNC(int) _PyArg_NoPositional(const char *funcname, PyObject *args);
64 65 66 67 68
#define _PyArg_NoKeywords(funcname, kwargs) \
    ((kwargs) == NULL || _PyArg_NoKeywords((funcname), (kwargs)))
#define _PyArg_NoPositional(funcname, args) \
    ((args) == NULL || _PyArg_NoPositional((funcname), (args)))

69
#endif
70

71
PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
72
#ifndef Py_LIMITED_API
73 74 75 76 77 78
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);
79
#endif
80

81 82 83 84 85 86 87 88 89 90 91 92 93 94
#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
95
#define _PyArg_ParseStack  _PyArg_ParseStack_SizeT
96
#define _PyArg_ParseStackAndKeywords  _PyArg_ParseStackAndKeywords_SizeT
97 98 99 100
#define _PyArg_VaParseTupleAndKeywordsFast  _PyArg_VaParseTupleAndKeywordsFast_SizeT
#endif
PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
                                                 struct _PyArg_Parser *, ...);
101
PyAPI_FUNC(int) _PyArg_ParseStack(
102
    PyObject *const *args,
103 104 105 106
    Py_ssize_t nargs,
    const char *format,
    ...);
PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords(
107
    PyObject *const *args,
108 109 110 111
    Py_ssize_t nargs,
    PyObject *kwnames,
    struct _PyArg_Parser *,
    ...);
112 113 114
PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
                                                   struct _PyArg_Parser *, va_list);
void _PyArg_Fini(void);
115
#endif   /* Py_LIMITED_API */
116

117 118 119
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 *);
120 121
#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
122 123 124

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

130 131
#define Py_CLEANUP_SUPPORTED 0x20000

132 133
#define PYTHON_API_VERSION 1013
#define PYTHON_API_STRING "1013"
Guido van Rossum's avatar
Guido van Rossum committed
134 135
/* The API version is maintained (independently from the Python version)
   so we can detect mismatches between the interpreter and dynamically
136
   loaded modules.  These are diagnosed by an error message but
137 138 139
   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
140

141 142 143
   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
144 145 146
   Please add a line or two to the top of this log for each API
   version change:

147
   22-Feb-2006  MvL     1013    PEP 353 - long indices for sequence lengths
148

149 150
   19-Aug-2002  GvR     1012    Changes to string object struct for
                                interning changes, saving 3 bytes.
151

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

154 155 156
   25-Jan-2001  FLD     1010    Parameters added to PyCode_New() and
                                PyFrame_New(); Python 2.1a2

157 158
   14-Mar-2000  GvR     1009    Unicode API added

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

161
   3-Dec-1998   GvR     1008    Python 1.5.2b1
162

163
   18-Jan-1997  GvR     1007    string interning and other speedups
164

165
   11-Oct-1996  GvR     renamed Py_Ellipses to Py_Ellipsis :-(
166

167
   30-Jul-1996  GvR     Slice and ellipses syntax added
168

169
   23-Jul-1996  GvR     For 1.4 -- better safe than sorry this time :-)
170

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

173
   10-Jan-1995  GvR     Renamed globals to new naming scheme
174

175
   9-Jan-1995   GvR     Initial version (incompatible with older API)
Guido van Rossum's avatar
Guido van Rossum committed
176 177
*/

178 179 180 181 182 183
/* 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"

184
#ifdef Py_TRACE_REFS
185
 /* When we are tracing reference counts, rename module creation functions so
Martin v. Löwis's avatar
Martin v. Löwis committed
186 187
    modules compiled with incompatible settings will generate a
    link-time error. */
188
 #define PyModule_Create2 PyModule_Create2TraceRefs
189
 #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
190 191
#endif

192 193
PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
                                     int apiver);
194 195 196 197
#ifndef Py_LIMITED_API
PyAPI_FUNC(PyObject *) _PyModule_CreateInitialized(struct PyModuleDef*,
                                                   int apiver);
#endif
198

199 200
#ifdef Py_LIMITED_API
#define PyModule_Create(module) \
201
        PyModule_Create2(module, PYTHON_ABI_VERSION)
202
#else
203
#define PyModule_Create(module) \
204 205 206
        PyModule_Create2(module, PYTHON_API_VERSION)
#endif

207 208
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
/* New in 3.5 */
209 210 211 212 213 214 215 216 217 218
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)
219 220
#endif /* Py_LIMITED_API */
#endif /* New in 3.5 */
221

222
#ifndef Py_LIMITED_API
223
PyAPI_DATA(const char *) _Py_PackageContext;
224
#endif
225

226 227 228 229
#ifdef __cplusplus
}
#endif
#endif /* !Py_MODSUPPORT_H */