blob: b542732b16d6a7fcac1f913fb97e012cf06b8ba7 [file] [log] [blame]
Guido van Rossum32d34c82001-09-20 21:45:26 +00001/* Descriptors */
Martin v. Löwis522cf1f2002-03-30 08:57:12 +00002#ifndef Py_DESCROBJECT_H
3#define Py_DESCROBJECT_H
4#ifdef __cplusplus
5extern "C" {
6#endif
Tim Peters6d6c1a32001-08-02 04:15:00 +00007
8typedef PyObject *(*getter)(PyObject *, void *);
9typedef int (*setter)(PyObject *, PyObject *, void *);
10
Guido van Rossum32d34c82001-09-20 21:45:26 +000011typedef struct PyGetSetDef {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000012 char *name;
13 getter get;
14 setter set;
15 char *doc;
16 void *closure;
Guido van Rossum32d34c82001-09-20 21:45:26 +000017} PyGetSetDef;
Tim Peters6d6c1a32001-08-02 04:15:00 +000018
19typedef PyObject *(*wrapperfunc)(PyObject *self, PyObject *args,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000020 void *wrapped);
Tim Peters6d6c1a32001-08-02 04:15:00 +000021
Guido van Rossumc8e56452001-10-22 00:43:43 +000022typedef PyObject *(*wrapperfunc_kwds)(PyObject *self, PyObject *args,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000023 void *wrapped, PyObject *kwds);
Guido van Rossumc8e56452001-10-22 00:43:43 +000024
Tim Peters6d6c1a32001-08-02 04:15:00 +000025struct wrapperbase {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000026 char *name;
27 int offset;
28 void *function;
29 wrapperfunc wrapper;
30 char *doc;
31 int flags;
32 PyObject *name_strobj;
Tim Peters6d6c1a32001-08-02 04:15:00 +000033};
34
Guido van Rossumc8e56452001-10-22 00:43:43 +000035/* Flags for above struct */
36#define PyWrapperFlag_KEYWORDS 1 /* wrapper function takes keyword args */
37
Guido van Rossumf4593e02001-10-03 12:09:30 +000038/* Various kinds of descriptor objects */
39
40#define PyDescr_COMMON \
Antoine Pitrouc83ea132010-05-09 14:46:46 +000041 PyObject_HEAD \
42 PyTypeObject *d_type; \
43 PyObject *d_name
Guido van Rossumf4593e02001-10-03 12:09:30 +000044
45typedef struct {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000046 PyDescr_COMMON;
Guido van Rossumf4593e02001-10-03 12:09:30 +000047} PyDescrObject;
48
49typedef struct {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000050 PyDescr_COMMON;
51 PyMethodDef *d_method;
Guido van Rossumf4593e02001-10-03 12:09:30 +000052} PyMethodDescrObject;
53
54typedef struct {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000055 PyDescr_COMMON;
56 struct PyMemberDef *d_member;
Guido van Rossumf4593e02001-10-03 12:09:30 +000057} PyMemberDescrObject;
58
59typedef struct {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000060 PyDescr_COMMON;
61 PyGetSetDef *d_getset;
Guido van Rossumf4593e02001-10-03 12:09:30 +000062} PyGetSetDescrObject;
63
64typedef struct {
Antoine Pitrouc83ea132010-05-09 14:46:46 +000065 PyDescr_COMMON;
66 struct wrapperbase *d_base;
67 void *d_wrapped; /* This can be any function pointer */
Guido van Rossumf4593e02001-10-03 12:09:30 +000068} PyWrapperDescrObject;
69
Mark Hammond91a681d2002-08-12 07:21:58 +000070PyAPI_DATA(PyTypeObject) PyWrapperDescr_Type;
Benjamin Peterson01c6e6f2009-04-18 22:15:26 +000071PyAPI_DATA(PyTypeObject) PyDictProxy_Type;
72PyAPI_DATA(PyTypeObject) PyGetSetDescr_Type;
73PyAPI_DATA(PyTypeObject) PyMemberDescr_Type;
Guido van Rossumf4593e02001-10-03 12:09:30 +000074
Mark Hammond91a681d2002-08-12 07:21:58 +000075PyAPI_FUNC(PyObject *) PyDescr_NewMethod(PyTypeObject *, PyMethodDef *);
Tim Petersbca1cbc2002-12-09 22:56:13 +000076PyAPI_FUNC(PyObject *) PyDescr_NewClassMethod(PyTypeObject *, PyMethodDef *);
Mark Hammond91a681d2002-08-12 07:21:58 +000077PyAPI_FUNC(PyObject *) PyDescr_NewMember(PyTypeObject *,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000078 struct PyMemberDef *);
Mark Hammond91a681d2002-08-12 07:21:58 +000079PyAPI_FUNC(PyObject *) PyDescr_NewGetSet(PyTypeObject *,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000080 struct PyGetSetDef *);
Mark Hammond91a681d2002-08-12 07:21:58 +000081PyAPI_FUNC(PyObject *) PyDescr_NewWrapper(PyTypeObject *,
Antoine Pitrouc83ea132010-05-09 14:46:46 +000082 struct wrapperbase *, void *);
Christian Heimese93237d2007-12-19 02:37:44 +000083#define PyDescr_IsData(d) (Py_TYPE(d)->tp_descr_set != NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +000084
Mark Hammond91a681d2002-08-12 07:21:58 +000085PyAPI_FUNC(PyObject *) PyDictProxy_New(PyObject *);
86PyAPI_FUNC(PyObject *) PyWrapper_New(PyObject *, PyObject *);
Guido van Rossum29a62dd2001-08-23 21:40:38 +000087
88
Mark Hammond91a681d2002-08-12 07:21:58 +000089PyAPI_DATA(PyTypeObject) PyProperty_Type;
Martin v. Löwis522cf1f2002-03-30 08:57:12 +000090#ifdef __cplusplus
91}
92#endif
93#endif /* !Py_DESCROBJECT_H */
94