1 /* Function object interface */
2
3 #ifndef Py_LIMITED_API
4 #ifndef Py_FUNCOBJECT_H
5 #define Py_FUNCOBJECT_H
6 #ifdef __cplusplus
7 extern "C" {
8 #endif
9
10
11 #define _Py_COMMON_FIELDS(PREFIX) \
12 PyObject *PREFIX ## globals; \
13 PyObject *PREFIX ## builtins; \
14 PyObject *PREFIX ## name; \
15 PyObject *PREFIX ## qualname; \
16 PyObject *PREFIX ## code; /* A code object, the __code__ attribute */ \
17 PyObject *PREFIX ## defaults; /* NULL or a tuple */ \
18 PyObject *PREFIX ## kwdefaults; /* NULL or a dict */ \
19 PyObject *PREFIX ## closure; /* NULL or a tuple of cell objects */
20
21 typedef struct {
22 _Py_COMMON_FIELDS(fc_)
23 } PyFrameConstructor;
24
25 /* Function objects and code objects should not be confused with each other:
26 *
27 * Function objects are created by the execution of the 'def' statement.
28 * They reference a code object in their __code__ attribute, which is a
29 * purely syntactic object, i.e. nothing more than a compiled version of some
30 * source code lines. There is one code object per source code "fragment",
31 * but each code object can be referenced by zero or many function objects
32 * depending only on how many times the 'def' statement in the source was
33 * executed so far.
34 */
35
36 typedef struct {
37 PyObject_HEAD
38 _Py_COMMON_FIELDS(func_)
39 PyObject *func_doc; /* The __doc__ attribute, can be anything */
40 PyObject *func_dict; /* The __dict__ attribute, a dict or NULL */
41 PyObject *func_weakreflist; /* List of weak references */
42 PyObject *func_module; /* The __module__ attribute, can be anything */
43 PyObject *func_annotations; /* Annotations, a dict or NULL */
44 PyObject *func_typeparams; /* Tuple of active type variables or NULL */
45 vectorcallfunc vectorcall;
46 /* Version number for use by specializer.
47 * Can set to non-zero when we want to specialize.
48 * Will be set to zero if any of these change:
49 * defaults
50 * kwdefaults (only if the object changes, not the contents of the dict)
51 * code
52 * annotations
53 * vectorcall function pointer */
54 uint32_t func_version;
55
56 /* Invariant:
57 * func_closure contains the bindings for func_code->co_freevars, so
58 * PyTuple_Size(func_closure) == PyCode_GetNumFree(func_code)
59 * (func_closure may be NULL if PyCode_GetNumFree(func_code) == 0).
60 */
61 } PyFunctionObject;
62
63 #undef _Py_COMMON_FIELDS
64
65 PyAPI_DATA(PyTypeObject) PyFunction_Type;
66
67 #define PyFunction_Check(op) Py_IS_TYPE((op), &PyFunction_Type)
68
69 PyAPI_FUNC(PyObject *) PyFunction_New(PyObject *, PyObject *);
70 PyAPI_FUNC(PyObject *) PyFunction_NewWithQualName(PyObject *, PyObject *, PyObject *);
71 PyAPI_FUNC(PyObject *) PyFunction_GetCode(PyObject *);
72 PyAPI_FUNC(PyObject *) PyFunction_GetGlobals(PyObject *);
73 PyAPI_FUNC(PyObject *) PyFunction_GetModule(PyObject *);
74 PyAPI_FUNC(PyObject *) PyFunction_GetDefaults(PyObject *);
75 PyAPI_FUNC(int) PyFunction_SetDefaults(PyObject *, PyObject *);
76 PyAPI_FUNC(void) PyFunction_SetVectorcall(PyFunctionObject *, vectorcallfunc);
77 PyAPI_FUNC(PyObject *) PyFunction_GetKwDefaults(PyObject *);
78 PyAPI_FUNC(int) PyFunction_SetKwDefaults(PyObject *, PyObject *);
79 PyAPI_FUNC(PyObject *) PyFunction_GetClosure(PyObject *);
80 PyAPI_FUNC(int) PyFunction_SetClosure(PyObject *, PyObject *);
81 PyAPI_FUNC(PyObject *) PyFunction_GetAnnotations(PyObject *);
82 PyAPI_FUNC(int) PyFunction_SetAnnotations(PyObject *, PyObject *);
83
84 #define _PyFunction_CAST(func) \
85 (assert(PyFunction_Check(func)), _Py_CAST(PyFunctionObject*, func))
86
87 /* Static inline functions for direct access to these values.
88 Type checks are *not* done, so use with care. */
PyFunction_GET_CODE(PyObject * func)89 static inline PyObject* PyFunction_GET_CODE(PyObject *func) {
90 return _PyFunction_CAST(func)->func_code;
91 }
92 #define PyFunction_GET_CODE(func) PyFunction_GET_CODE(_PyObject_CAST(func))
93
PyFunction_GET_GLOBALS(PyObject * func)94 static inline PyObject* PyFunction_GET_GLOBALS(PyObject *func) {
95 return _PyFunction_CAST(func)->func_globals;
96 }
97 #define PyFunction_GET_GLOBALS(func) PyFunction_GET_GLOBALS(_PyObject_CAST(func))
98
PyFunction_GET_MODULE(PyObject * func)99 static inline PyObject* PyFunction_GET_MODULE(PyObject *func) {
100 return _PyFunction_CAST(func)->func_module;
101 }
102 #define PyFunction_GET_MODULE(func) PyFunction_GET_MODULE(_PyObject_CAST(func))
103
PyFunction_GET_DEFAULTS(PyObject * func)104 static inline PyObject* PyFunction_GET_DEFAULTS(PyObject *func) {
105 return _PyFunction_CAST(func)->func_defaults;
106 }
107 #define PyFunction_GET_DEFAULTS(func) PyFunction_GET_DEFAULTS(_PyObject_CAST(func))
108
PyFunction_GET_KW_DEFAULTS(PyObject * func)109 static inline PyObject* PyFunction_GET_KW_DEFAULTS(PyObject *func) {
110 return _PyFunction_CAST(func)->func_kwdefaults;
111 }
112 #define PyFunction_GET_KW_DEFAULTS(func) PyFunction_GET_KW_DEFAULTS(_PyObject_CAST(func))
113
PyFunction_GET_CLOSURE(PyObject * func)114 static inline PyObject* PyFunction_GET_CLOSURE(PyObject *func) {
115 return _PyFunction_CAST(func)->func_closure;
116 }
117 #define PyFunction_GET_CLOSURE(func) PyFunction_GET_CLOSURE(_PyObject_CAST(func))
118
PyFunction_GET_ANNOTATIONS(PyObject * func)119 static inline PyObject* PyFunction_GET_ANNOTATIONS(PyObject *func) {
120 return _PyFunction_CAST(func)->func_annotations;
121 }
122 #define PyFunction_GET_ANNOTATIONS(func) PyFunction_GET_ANNOTATIONS(_PyObject_CAST(func))
123
124 /* The classmethod and staticmethod types lives here, too */
125 PyAPI_DATA(PyTypeObject) PyClassMethod_Type;
126 PyAPI_DATA(PyTypeObject) PyStaticMethod_Type;
127
128 PyAPI_FUNC(PyObject *) PyClassMethod_New(PyObject *);
129 PyAPI_FUNC(PyObject *) PyStaticMethod_New(PyObject *);
130
131 #define PY_FOREACH_FUNC_EVENT(V) \
132 V(CREATE) \
133 V(DESTROY) \
134 V(MODIFY_CODE) \
135 V(MODIFY_DEFAULTS) \
136 V(MODIFY_KWDEFAULTS)
137
138 typedef enum {
139 #define PY_DEF_EVENT(EVENT) PyFunction_EVENT_##EVENT,
140 PY_FOREACH_FUNC_EVENT(PY_DEF_EVENT)
141 #undef PY_DEF_EVENT
142 } PyFunction_WatchEvent;
143
144 /*
145 * A callback that is invoked for different events in a function's lifecycle.
146 *
147 * The callback is invoked with a borrowed reference to func, after it is
148 * created and before it is modified or destroyed. The callback should not
149 * modify func.
150 *
151 * When a function's code object, defaults, or kwdefaults are modified the
152 * callback will be invoked with the respective event and new_value will
153 * contain a borrowed reference to the new value that is about to be stored in
154 * the function. Otherwise the third argument is NULL.
155 *
156 * If the callback returns with an exception set, it must return -1. Otherwise
157 * it should return 0.
158 */
159 typedef int (*PyFunction_WatchCallback)(
160 PyFunction_WatchEvent event,
161 PyFunctionObject *func,
162 PyObject *new_value);
163
164 /*
165 * Register a per-interpreter callback that will be invoked for function lifecycle
166 * events.
167 *
168 * Returns a handle that may be passed to PyFunction_ClearWatcher on success,
169 * or -1 and sets an error if no more handles are available.
170 */
171 PyAPI_FUNC(int) PyFunction_AddWatcher(PyFunction_WatchCallback callback);
172
173 /*
174 * Clear the watcher associated with the watcher_id handle.
175 *
176 * Returns 0 on success or -1 if no watcher exists for the supplied id.
177 */
178 PyAPI_FUNC(int) PyFunction_ClearWatcher(int watcher_id);
179
180 #ifdef __cplusplus
181 }
182 #endif
183 #endif /* !Py_FUNCOBJECT_H */
184 #endif /* Py_LIMITED_API */
185