/Include/funcobject.h

 1
 2/* Function object interface */
 3
 4#ifndef Py_FUNCOBJECT_H
 5#define Py_FUNCOBJECT_H
 6#ifdef __cplusplus
 7extern "C" {
 8#endif
 9
10/* Function objects and code objects should not be confused with each other:
11 *
12 * Function objects are created by the execution of the 'def' statement.
13 * They reference a code object in their func_code attribute, which is a
14 * purely syntactic object, i.e. nothing more than a compiled version of some
15 * source code lines.  There is one code object per source code "fragment",
16 * but each code object can be referenced by zero or many function objects
17 * depending only on how many times the 'def' statement in the source was
18 * executed so far.
19 */
20
21/* If you change this, update Util/PyTypeBuilder.h accordingly. */
22typedef struct PyFunctionObject {
23    PyObject_HEAD
24    PyObject *func_code;	/* A code object */
25    PyObject *func_globals;	/* A dictionary (other mappings won't do) */
26    PyObject *func_defaults;	/* NULL or a tuple */
27    PyObject *func_closure;	/* NULL or a tuple of cell objects */
28    PyObject *func_doc;		/* The __doc__ attribute, can be anything */
29    PyObject *func_name;	/* The __name__ attribute, a string object */
30    PyObject *func_dict;	/* The __dict__ attribute, a dict or NULL */
31    PyObject *func_weakreflist;	/* List of weak references */
32    PyObject *func_module;	/* The __module__ attribute, can be anything */
33
34    /* Invariant:
35     *     func_closure contains the bindings for func_code->co_freevars, so
36     *     PyTuple_Size(func_closure) == PyCode_GetNumFree(func_code)
37     *     (func_closure may be NULL if PyCode_GetNumFree(func_code) == 0).
38     */
39} PyFunctionObject;
40
41PyAPI_DATA(PyTypeObject) PyFunction_Type;
42
43#define PyFunction_Check(op) (Py_TYPE(op) == &PyFunction_Type)
44
45PyAPI_FUNC(PyObject *) PyFunction_New(PyObject *, PyObject *);
46PyAPI_FUNC(PyObject *) PyFunction_GetCode(PyObject *);
47PyAPI_FUNC(PyObject *) PyFunction_GetGlobals(PyObject *);
48PyAPI_FUNC(PyObject *) PyFunction_GetModule(PyObject *);
49PyAPI_FUNC(PyObject *) PyFunction_GetDefaults(PyObject *);
50PyAPI_FUNC(int) PyFunction_SetDefaults(PyObject *, PyObject *);
51PyAPI_FUNC(PyObject *) PyFunction_GetClosure(PyObject *);
52PyAPI_FUNC(int) PyFunction_SetClosure(PyObject *, PyObject *);
53
54/* Macros for direct access to these values. Type checks are *not*
55   done, so use with care. */
56#define PyFunction_GET_CODE(func) \
57        (((PyFunctionObject *)func) -> func_code)
58#define PyFunction_GET_GLOBALS(func) \
59	(((PyFunctionObject *)func) -> func_globals)
60#define PyFunction_GET_MODULE(func) \
61	(((PyFunctionObject *)func) -> func_module)
62#define PyFunction_GET_DEFAULTS(func) \
63	(((PyFunctionObject *)func) -> func_defaults)
64#define PyFunction_GET_CLOSURE(func) \
65	(((PyFunctionObject *)func) -> func_closure)
66
67/* The classmethod and staticmethod types lives here, too */
68PyAPI_DATA(PyTypeObject) PyClassMethod_Type;
69PyAPI_DATA(PyTypeObject) PyStaticMethod_Type;
70
71PyAPI_FUNC(PyObject *) PyClassMethod_New(PyObject *);
72PyAPI_FUNC(PyObject *) PyStaticMethod_New(PyObject *);
73
74#ifdef __cplusplus
75}
76#endif
77#endif /* !Py_FUNCOBJECT_H */