blob: 7c42808c59e0be4320457b1977eca5fe435a1db7 [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 {
Tim Peters6d6c1a32001-08-02 04:15:00 +000012 char *name;
13 getter get;
14 setter set;
Guido van Rossum32d34c82001-09-20 21:45:26 +000015 char *doc;
Tim Peters6d6c1a32001-08-02 04:15:00 +000016 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,
20 void *wrapped);
21
Guido van Rossumc8e56452001-10-22 00:43:43 +000022typedef PyObject *(*wrapperfunc_kwds)(PyObject *self, PyObject *args,
23 void *wrapped, PyObject *kwds);
24
Tim Peters6d6c1a32001-08-02 04:15:00 +000025struct wrapperbase {
26 char *name;
Guido van Rossum6d204072001-10-21 00:44:31 +000027 int offset;
28 void *function;
Tim Peters6d6c1a32001-08-02 04:15:00 +000029 wrapperfunc wrapper;
30 char *doc;
Guido van Rossumc8e56452001-10-22 00:43:43 +000031 int flags;
Guido van Rossum6d204072001-10-21 00:44:31 +000032 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
Guido van Rossumf4593e02001-10-03 12:09:30 +000040typedef struct {
Alexandre Vassalotti2db046d2009-07-22 03:56:36 +000041 PyObject_HEAD
42 PyTypeObject *d_type;
43 PyObject *d_name;
Guido van Rossumf4593e02001-10-03 12:09:30 +000044} PyDescrObject;
45
Alexandre Vassalotti2db046d2009-07-22 03:56:36 +000046#define PyDescr_COMMON PyDescrObject d_common
47
48#define PyDescr_TYPE(x) (((PyDescrObject *)(x))->d_type)
49#define PyDescr_NAME(x) (((PyDescrObject *)(x))->d_name)
50
Guido van Rossumf4593e02001-10-03 12:09:30 +000051typedef struct {
52 PyDescr_COMMON;
53 PyMethodDef *d_method;
54} PyMethodDescrObject;
55
56typedef struct {
57 PyDescr_COMMON;
58 struct PyMemberDef *d_member;
59} PyMemberDescrObject;
60
61typedef struct {
62 PyDescr_COMMON;
63 PyGetSetDef *d_getset;
64} PyGetSetDescrObject;
65
66typedef struct {
67 PyDescr_COMMON;
68 struct wrapperbase *d_base;
69 void *d_wrapped; /* This can be any function pointer */
70} PyWrapperDescrObject;
71
Christian Heimesa22e8bd2007-11-29 22:35:39 +000072PyAPI_DATA(PyTypeObject) PyClassMethodDescr_Type;
73PyAPI_DATA(PyTypeObject) PyGetSetDescr_Type;
74PyAPI_DATA(PyTypeObject) PyMemberDescr_Type;
75PyAPI_DATA(PyTypeObject) PyMethodDescr_Type;
Mark Hammond91a681d2002-08-12 07:21:58 +000076PyAPI_DATA(PyTypeObject) PyWrapperDescr_Type;
Christian Heimesa22e8bd2007-11-29 22:35:39 +000077PyAPI_DATA(PyTypeObject) PyDictProxy_Type;
Guido van Rossumf4593e02001-10-03 12:09:30 +000078
Mark Hammond91a681d2002-08-12 07:21:58 +000079PyAPI_FUNC(PyObject *) PyDescr_NewMethod(PyTypeObject *, PyMethodDef *);
Tim Petersbca1cbc2002-12-09 22:56:13 +000080PyAPI_FUNC(PyObject *) PyDescr_NewClassMethod(PyTypeObject *, PyMethodDef *);
Mark Hammond91a681d2002-08-12 07:21:58 +000081PyAPI_FUNC(PyObject *) PyDescr_NewMember(PyTypeObject *,
Guido van Rossum6f799372001-09-20 20:46:19 +000082 struct PyMemberDef *);
Mark Hammond91a681d2002-08-12 07:21:58 +000083PyAPI_FUNC(PyObject *) PyDescr_NewGetSet(PyTypeObject *,
Guido van Rossum32d34c82001-09-20 21:45:26 +000084 struct PyGetSetDef *);
Mark Hammond91a681d2002-08-12 07:21:58 +000085PyAPI_FUNC(PyObject *) PyDescr_NewWrapper(PyTypeObject *,
Tim Peters6d6c1a32001-08-02 04:15:00 +000086 struct wrapperbase *, void *);
Christian Heimes90aa7642007-12-19 02:45:37 +000087#define PyDescr_IsData(d) (Py_TYPE(d)->tp_descr_set != NULL)
Tim Peters6d6c1a32001-08-02 04:15:00 +000088
Mark Hammond91a681d2002-08-12 07:21:58 +000089PyAPI_FUNC(PyObject *) PyDictProxy_New(PyObject *);
90PyAPI_FUNC(PyObject *) PyWrapper_New(PyObject *, PyObject *);
Guido van Rossum29a62dd2001-08-23 21:40:38 +000091
92
Mark Hammond91a681d2002-08-12 07:21:58 +000093PyAPI_DATA(PyTypeObject) PyProperty_Type;
Martin v. Löwis522cf1f2002-03-30 08:57:12 +000094#ifdef __cplusplus
95}
96#endif
97#endif /* !Py_DESCROBJECT_H */
98