Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 1 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 2 | /* Function object interface */ |
| 3 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 4 | #ifndef Py_FUNCOBJECT_H |
| 5 | #define Py_FUNCOBJECT_H |
| 6 | #ifdef __cplusplus |
| 7 | extern "C" { |
| 8 | #endif |
| 9 | |
Armin Rigo | 89a3946 | 2004-10-28 16:32:00 +0000 | [diff] [blame] | 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. |
Neal Norwitz | 8ced961 | 2007-08-25 17:01:41 +0000 | [diff] [blame] | 13 | * They reference a code object in their __code__ attribute, which is a |
Armin Rigo | 89a3946 | 2004-10-28 16:32:00 +0000 | [diff] [blame] | 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 | |
Guido van Rossum | 2583165 | 1993-05-19 14:50:45 +0000 | [diff] [blame] | 21 | typedef struct { |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 22 | PyObject_HEAD |
Neal Norwitz | 8ced961 | 2007-08-25 17:01:41 +0000 | [diff] [blame] | 23 | PyObject *func_code; /* A code object, the __code__ attribute */ |
Armin Rigo | 89a3946 | 2004-10-28 16:32:00 +0000 | [diff] [blame] | 24 | PyObject *func_globals; /* A dictionary (other mappings won't do) */ |
| 25 | PyObject *func_defaults; /* NULL or a tuple */ |
Guido van Rossum | 4f72a78 | 2006-10-27 23:31:49 +0000 | [diff] [blame] | 26 | PyObject *func_kwdefaults; /* NULL or a dict */ |
Armin Rigo | 89a3946 | 2004-10-28 16:32:00 +0000 | [diff] [blame] | 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 */ |
Neal Norwitz | c150536 | 2006-12-28 06:47:50 +0000 | [diff] [blame] | 33 | PyObject *func_annotations; /* Annotations, a dict or NULL */ |
Armin Rigo | 89a3946 | 2004-10-28 16:32:00 +0000 | [diff] [blame] | 34 | |
| 35 | /* Invariant: |
| 36 | * func_closure contains the bindings for func_code->co_freevars, so |
| 37 | * PyTuple_Size(func_closure) == PyCode_GetNumFree(func_code) |
| 38 | * (func_closure may be NULL if PyCode_GetNumFree(func_code) == 0). |
| 39 | */ |
Guido van Rossum | caa6380 | 1995-01-12 11:45:45 +0000 | [diff] [blame] | 40 | } PyFunctionObject; |
Guido van Rossum | 2583165 | 1993-05-19 14:50:45 +0000 | [diff] [blame] | 41 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 42 | PyAPI_DATA(PyTypeObject) PyFunction_Type; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 43 | |
Martin v. Löwis | 9f2e346 | 2007-07-21 17:22:18 +0000 | [diff] [blame] | 44 | #define PyFunction_Check(op) (Py_Type(op) == &PyFunction_Type) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 45 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 46 | PyAPI_FUNC(PyObject *) PyFunction_New(PyObject *, PyObject *); |
| 47 | PyAPI_FUNC(PyObject *) PyFunction_GetCode(PyObject *); |
| 48 | PyAPI_FUNC(PyObject *) PyFunction_GetGlobals(PyObject *); |
Jeremy Hylton | 4f0dcc9 | 2003-01-31 18:33:18 +0000 | [diff] [blame] | 49 | PyAPI_FUNC(PyObject *) PyFunction_GetModule(PyObject *); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 50 | PyAPI_FUNC(PyObject *) PyFunction_GetDefaults(PyObject *); |
| 51 | PyAPI_FUNC(int) PyFunction_SetDefaults(PyObject *, PyObject *); |
Guido van Rossum | 4f72a78 | 2006-10-27 23:31:49 +0000 | [diff] [blame] | 52 | PyAPI_FUNC(PyObject *) PyFunction_GetKwDefaults(PyObject *); |
| 53 | PyAPI_FUNC(int) PyFunction_SetKwDefaults(PyObject *, PyObject *); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 54 | PyAPI_FUNC(PyObject *) PyFunction_GetClosure(PyObject *); |
| 55 | PyAPI_FUNC(int) PyFunction_SetClosure(PyObject *, PyObject *); |
Neal Norwitz | c150536 | 2006-12-28 06:47:50 +0000 | [diff] [blame] | 56 | PyAPI_FUNC(PyObject *) PyFunction_GetAnnotations(PyObject *); |
| 57 | PyAPI_FUNC(int) PyFunction_SetAnnotations(PyObject *, PyObject *); |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 58 | |
Guido van Rossum | ba0d061 | 1998-07-10 15:47:08 +0000 | [diff] [blame] | 59 | /* Macros for direct access to these values. Type checks are *not* |
| 60 | done, so use with care. */ |
| 61 | #define PyFunction_GET_CODE(func) \ |
| 62 | (((PyFunctionObject *)func) -> func_code) |
| 63 | #define PyFunction_GET_GLOBALS(func) \ |
| 64 | (((PyFunctionObject *)func) -> func_globals) |
Jeremy Hylton | 4f0dcc9 | 2003-01-31 18:33:18 +0000 | [diff] [blame] | 65 | #define PyFunction_GET_MODULE(func) \ |
| 66 | (((PyFunctionObject *)func) -> func_module) |
Guido van Rossum | ba0d061 | 1998-07-10 15:47:08 +0000 | [diff] [blame] | 67 | #define PyFunction_GET_DEFAULTS(func) \ |
| 68 | (((PyFunctionObject *)func) -> func_defaults) |
Guido van Rossum | 4f72a78 | 2006-10-27 23:31:49 +0000 | [diff] [blame] | 69 | #define PyFunction_GET_KW_DEFAULTS(func) \ |
| 70 | (((PyFunctionObject *)func) -> func_kwdefaults) |
Jeremy Hylton | 64949cb | 2001-01-25 20:06:59 +0000 | [diff] [blame] | 71 | #define PyFunction_GET_CLOSURE(func) \ |
| 72 | (((PyFunctionObject *)func) -> func_closure) |
Neal Norwitz | c150536 | 2006-12-28 06:47:50 +0000 | [diff] [blame] | 73 | #define PyFunction_GET_ANNOTATIONS(func) \ |
| 74 | (((PyFunctionObject *)func) -> func_annotations) |
Guido van Rossum | ba0d061 | 1998-07-10 15:47:08 +0000 | [diff] [blame] | 75 | |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 76 | /* The classmethod and staticmethod types lives here, too */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 77 | PyAPI_DATA(PyTypeObject) PyClassMethod_Type; |
| 78 | PyAPI_DATA(PyTypeObject) PyStaticMethod_Type; |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 79 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame] | 80 | PyAPI_FUNC(PyObject *) PyClassMethod_New(PyObject *); |
| 81 | PyAPI_FUNC(PyObject *) PyStaticMethod_New(PyObject *); |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 82 | |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 83 | #ifdef __cplusplus |
| 84 | } |
| 85 | #endif |
| 86 | #endif /* !Py_FUNCOBJECT_H */ |