Coverage Report

Created: 2022-07-08 09:39

/home/mdboom/Work/builds/cpython/Include/modsupport.h
Line
Count
Source (jump to first uncovered line)
1
2
#ifndef Py_MODSUPPORT_H
3
#define Py_MODSUPPORT_H
4
#ifdef __cplusplus
5
extern "C" {
6
#endif
7
8
/* Module support interface */
9
10
#include <stdarg.h>               // va_list
11
12
/* 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
20
#define Py_BuildValue                   _Py_BuildValue_SizeT
21
#define Py_VaBuildValue                 _Py_VaBuildValue_SizeT
22
#endif
23
24
/* Due to a glitch in 3.2, the _SizeT versions weren't exported from the DLL. */
25
#if !defined(PY_SSIZE_T_CLEAN) || !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03030000
26
PyAPI_FUNC(int) PyArg_Parse(PyObject *, const char *, ...);
27
PyAPI_FUNC(int) PyArg_ParseTuple(PyObject *, const char *, ...);
28
PyAPI_FUNC(int) PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
29
                                                  const char *, char **, ...);
30
PyAPI_FUNC(int) PyArg_VaParse(PyObject *, const char *, va_list);
31
PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
32
                                                  const char *, char **, va_list);
33
#endif
34
PyAPI_FUNC(int) PyArg_ValidateKeywordArguments(PyObject *);
35
PyAPI_FUNC(int) PyArg_UnpackTuple(PyObject *, const char *, Py_ssize_t, Py_ssize_t, ...);
36
PyAPI_FUNC(PyObject *) Py_BuildValue(const char *, ...);
37
PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
38
39
40
PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
41
42
// Add an attribute with name 'name' and value 'obj' to the module 'mod.
43
// On success, return 0 on success.
44
// On error, raise an exception and return -1.
45
PyAPI_FUNC(int) PyModule_AddObjectRef(PyObject *mod, const char *name, PyObject *value);
46
47
// Similar to PyModule_AddObjectRef() but steal a reference to 'obj'
48
// (Py_DECREF(obj)) on success (if it returns 0).
49
PyAPI_FUNC(int) PyModule_AddObject(PyObject *mod, const char *, PyObject *value);
50
51
PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
52
PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
53
54
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03090000
55
/* New in 3.9 */
56
PyAPI_FUNC(int) PyModule_AddType(PyObject *module, PyTypeObject *type);
57
#endif /* Py_LIMITED_API */
58
59
#define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant((m), #c, (c))
60
#define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant((m), #c, (c))
61
62
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
63
/* New in 3.5 */
64
PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *);
65
PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *);
66
PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def);
67
#endif
68
69
#define Py_CLEANUP_SUPPORTED 0x20000
70
71
#define PYTHON_API_VERSION 1013
72
#define PYTHON_API_STRING "1013"
73
/* The API version is maintained (independently from the Python version)
74
   so we can detect mismatches between the interpreter and dynamically
75
   loaded modules.  These are diagnosed by an error message but
76
   the module is still loaded (because the mismatch can only be tested
77
   after loading the module).  The error message is intended to
78
   explain the core dump a few seconds later.
79
80
   The symbol PYTHON_API_STRING defines the same value as a string
81
   literal.  *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
82
83
   Please add a line or two to the top of this log for each API
84
   version change:
85
86
   22-Feb-2006  MvL     1013    PEP 353 - long indices for sequence lengths
87
88
   19-Aug-2002  GvR     1012    Changes to string object struct for
89
                                interning changes, saving 3 bytes.
90
91
   17-Jul-2001  GvR     1011    Descr-branch, just to be on the safe side
92
93
   25-Jan-2001  FLD     1010    Parameters added to PyCode_New() and
94
                                PyFrame_New(); Python 2.1a2
95
96
   14-Mar-2000  GvR     1009    Unicode API added
97
98
   3-Jan-1999   GvR     1007    Decided to change back!  (Don't reuse 1008!)
99
100
   3-Dec-1998   GvR     1008    Python 1.5.2b1
101
102
   18-Jan-1997  GvR     1007    string interning and other speedups
103
104
   11-Oct-1996  GvR     renamed Py_Ellipses to Py_Ellipsis :-(
105
106
   30-Jul-1996  GvR     Slice and ellipses syntax added
107
108
   23-Jul-1996  GvR     For 1.4 -- better safe than sorry this time :-)
109
110
   7-Nov-1995   GvR     Keyword arguments (should've been done at 1.3 :-( )
111
112
   10-Jan-1995  GvR     Renamed globals to new naming scheme
113
114
   9-Jan-1995   GvR     Initial version (incompatible with older API)
115
*/
116
117
/* The PYTHON_ABI_VERSION is introduced in PEP 384. For the lifetime of
118
   Python 3, it will stay at the value of 3; changes to the limited API
119
   must be performed in a strictly backwards-compatible manner. */
120
#define PYTHON_ABI_VERSION 3
121
#define PYTHON_ABI_STRING "3"
122
123
#ifdef Py_TRACE_REFS
124
 /* When we are tracing reference counts, rename module creation functions so
125
    modules compiled with incompatible settings will generate a
126
    link-time error. */
127
 #define PyModule_Create2 PyModule_Create2TraceRefs
128
 #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
129
#endif
130
131
PyAPI_FUNC(PyObject *) PyModule_Create2(PyModuleDef*, int apiver);
132
133
#ifdef Py_LIMITED_API
134
#define PyModule_Create(module) \
135
        PyModule_Create2((module), PYTHON_ABI_VERSION)
136
#else
137
#define PyModule_Create(module) \
138
        PyModule_Create2((module), PYTHON_API_VERSION)
139
#endif
140
141
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
142
/* New in 3.5 */
143
PyAPI_FUNC(PyObject *) PyModule_FromDefAndSpec2(PyModuleDef *def,
144
                                                PyObject *spec,
145
                                                int module_api_version);
146
147
#ifdef Py_LIMITED_API
148
#define PyModule_FromDefAndSpec(module, spec) \
149
    PyModule_FromDefAndSpec2((module), (spec), PYTHON_ABI_VERSION)
150
#else
151
#define PyModule_FromDefAndSpec(module, spec) \
152
    PyModule_FromDefAndSpec2((module), (spec), PYTHON_API_VERSION)
153
#endif /* Py_LIMITED_API */
154
155
#endif /* New in 3.5 */
156
157
#ifndef Py_LIMITED_API
158
#  define Py_CPYTHON_MODSUPPORT_H
159
#  include "cpython/modsupport.h"
160
#  undef Py_CPYTHON_MODSUPPORT_H
161
#endif
162
163
#ifdef __cplusplus
164
}
165
#endif
166
#endif /* !Py_MODSUPPORT_H */