• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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>
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 #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 PyAPI_FUNC(PyObject **) _Py_VaBuildStack_SizeT(
29     PyObject **small_stack,
30     Py_ssize_t small_stack_len,
31     const char *format,
32     va_list va,
33     Py_ssize_t *p_nargs);
34 #endif /* !Py_LIMITED_API */
35 #endif
36 
37 /* Due to a glitch in 3.2, the _SizeT versions weren't exported from the DLL. */
38 #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_VaParse(PyObject *, const char *, va_list);
44 PyAPI_FUNC(int) PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
45                                                   const char *, char **, va_list);
46 #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     Py_ssize_t nargs,
57     const char *name,
58     Py_ssize_t min,
59     Py_ssize_t max,
60     ...);
61 
62 PyAPI_FUNC(int) _PyArg_NoKeywords(const char *funcname, PyObject *kwargs);
63 PyAPI_FUNC(int) _PyArg_NoPositional(const char *funcname, PyObject *args);
64 #define _PyArg_NoKeywords(funcname, kwargs) \
65     ((kwargs) == NULL || _PyArg_NoKeywords((funcname), (kwargs)))
66 #define _PyArg_NoPositional(funcname, args) \
67     ((args) == NULL || _PyArg_NoPositional((funcname), (args)))
68 
69 #endif
70 
71 PyAPI_FUNC(PyObject *) Py_VaBuildValue(const char *, va_list);
72 #ifndef Py_LIMITED_API
73 PyAPI_FUNC(PyObject **) _Py_VaBuildStack(
74     PyObject **small_stack,
75     Py_ssize_t small_stack_len,
76     const char *format,
77     va_list va,
78     Py_ssize_t *p_nargs);
79 #endif
80 
81 #ifndef Py_LIMITED_API
82 typedef struct _PyArg_Parser {
83     const char *format;
84     const char * const *keywords;
85     const char *fname;
86     const char *custom_msg;
87     int pos;            /* number of positional-only arguments */
88     int min;            /* minimal number of arguments */
89     int max;            /* maximal number of positional arguments */
90     PyObject *kwtuple;  /* tuple of keyword parameter names */
91     struct _PyArg_Parser *next;
92 } _PyArg_Parser;
93 #ifdef PY_SSIZE_T_CLEAN
94 #define _PyArg_ParseTupleAndKeywordsFast  _PyArg_ParseTupleAndKeywordsFast_SizeT
95 #define _PyArg_ParseStack  _PyArg_ParseStack_SizeT
96 #define _PyArg_ParseStackAndKeywords  _PyArg_ParseStackAndKeywords_SizeT
97 #define _PyArg_VaParseTupleAndKeywordsFast  _PyArg_VaParseTupleAndKeywordsFast_SizeT
98 #endif
99 PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
100                                                  struct _PyArg_Parser *, ...);
101 PyAPI_FUNC(int) _PyArg_ParseStack(
102     PyObject *const *args,
103     Py_ssize_t nargs,
104     const char *format,
105     ...);
106 PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords(
107     PyObject *const *args,
108     Py_ssize_t nargs,
109     PyObject *kwnames,
110     struct _PyArg_Parser *,
111     ...);
112 PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
113                                                    struct _PyArg_Parser *, va_list);
114 void _PyArg_Fini(void);
115 #endif   /* Py_LIMITED_API */
116 
117 PyAPI_FUNC(int) PyModule_AddObject(PyObject *, const char *, PyObject *);
118 PyAPI_FUNC(int) PyModule_AddIntConstant(PyObject *, const char *, long);
119 PyAPI_FUNC(int) PyModule_AddStringConstant(PyObject *, const char *, const char *);
120 #define PyModule_AddIntMacro(m, c) PyModule_AddIntConstant(m, #c, c)
121 #define PyModule_AddStringMacro(m, c) PyModule_AddStringConstant(m, #c, c)
122 
123 #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
124 /* New in 3.5 */
125 PyAPI_FUNC(int) PyModule_SetDocString(PyObject *, const char *);
126 PyAPI_FUNC(int) PyModule_AddFunctions(PyObject *, PyMethodDef *);
127 PyAPI_FUNC(int) PyModule_ExecDef(PyObject *module, PyModuleDef *def);
128 #endif
129 
130 #define Py_CLEANUP_SUPPORTED 0x20000
131 
132 #define PYTHON_API_VERSION 1013
133 #define PYTHON_API_STRING "1013"
134 /* The API version is maintained (independently from the Python version)
135    so we can detect mismatches between the interpreter and dynamically
136    loaded modules.  These are diagnosed by an error message but
137    the module is still loaded (because the mismatch can only be tested
138    after loading the module).  The error message is intended to
139    explain the core dump a few seconds later.
140 
141    The symbol PYTHON_API_STRING defines the same value as a string
142    literal.  *** PLEASE MAKE SURE THE DEFINITIONS MATCH. ***
143 
144    Please add a line or two to the top of this log for each API
145    version change:
146 
147    22-Feb-2006  MvL     1013    PEP 353 - long indices for sequence lengths
148 
149    19-Aug-2002  GvR     1012    Changes to string object struct for
150                                 interning changes, saving 3 bytes.
151 
152    17-Jul-2001  GvR     1011    Descr-branch, just to be on the safe side
153 
154    25-Jan-2001  FLD     1010    Parameters added to PyCode_New() and
155                                 PyFrame_New(); Python 2.1a2
156 
157    14-Mar-2000  GvR     1009    Unicode API added
158 
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 :-( )
172 
173    10-Jan-1995  GvR     Renamed globals to new naming scheme
174 
175    9-Jan-1995   GvR     Initial version (incompatible with older API)
176 */
177 
178 /* The PYTHON_ABI_VERSION is introduced in PEP 384. For the lifetime of
179    Python 3, it will stay at the value of 3; changes to the limited API
180    must be performed in a strictly backwards-compatible manner. */
181 #define PYTHON_ABI_VERSION 3
182 #define PYTHON_ABI_STRING "3"
183 
184 #ifdef Py_TRACE_REFS
185  /* When we are tracing reference counts, rename module creation functions so
186     modules compiled with incompatible settings will generate a
187     link-time error. */
188  #define PyModule_Create2 PyModule_Create2TraceRefs
189  #define PyModule_FromDefAndSpec2 PyModule_FromDefAndSpec2TraceRefs
190 #endif
191 
192 PyAPI_FUNC(PyObject *) PyModule_Create2(struct PyModuleDef*,
193                                      int apiver);
194 #ifndef Py_LIMITED_API
195 PyAPI_FUNC(PyObject *) _PyModule_CreateInitialized(struct PyModuleDef*,
196                                                    int apiver);
197 #endif
198 
199 #ifdef Py_LIMITED_API
200 #define PyModule_Create(module) \
201         PyModule_Create2(module, PYTHON_ABI_VERSION)
202 #else
203 #define PyModule_Create(module) \
204         PyModule_Create2(module, PYTHON_API_VERSION)
205 #endif
206 
207 #if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03050000
208 /* New in 3.5 */
209 PyAPI_FUNC(PyObject *) PyModule_FromDefAndSpec2(PyModuleDef *def,
210                                                 PyObject *spec,
211                                                 int module_api_version);
212 
213 #ifdef Py_LIMITED_API
214 #define PyModule_FromDefAndSpec(module, spec) \
215     PyModule_FromDefAndSpec2(module, spec, PYTHON_ABI_VERSION)
216 #else
217 #define PyModule_FromDefAndSpec(module, spec) \
218     PyModule_FromDefAndSpec2(module, spec, PYTHON_API_VERSION)
219 #endif /* Py_LIMITED_API */
220 #endif /* New in 3.5 */
221 
222 #ifndef Py_LIMITED_API
223 PyAPI_DATA(const char *) _Py_PackageContext;
224 #endif
225 
226 #ifdef __cplusplus
227 }
228 #endif
229 #endif /* !Py_MODSUPPORT_H */
230