blob: e47ebea76935b542b01141001b2120f7e5d5a0b8 [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* Method object interface */
3
Fred Drakeea9cb5a2000-07-09 00:20:36 +00004#ifndef Py_METHODOBJECT_H
5#define Py_METHODOBJECT_H
6#ifdef __cplusplus
7extern "C" {
8#endif
9
Guido van Rossum051ab121995-02-27 10:17:52 +000010extern DL_IMPORT(PyTypeObject) PyCFunction_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000011
Guido van Rossumcaa63801995-01-12 11:45:45 +000012#define PyCFunction_Check(op) ((op)->ob_type == &PyCFunction_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000013
Tim Petersdbd9ba62000-07-09 03:09:57 +000014typedef PyObject *(*PyCFunction)(PyObject *, PyObject *);
15typedef PyObject *(*PyCFunctionWithKeywords)(PyObject *, PyObject *,
16 PyObject *);
Jeremy Hylton910d7d42001-08-12 21:52:24 +000017typedef PyObject *(*PyNoArgsFunction)(PyObject *);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000018
Fred Drakeea9cb5a2000-07-09 00:20:36 +000019extern DL_IMPORT(PyCFunction) PyCFunction_GetFunction(PyObject *);
20extern DL_IMPORT(PyObject *) PyCFunction_GetSelf(PyObject *);
21extern DL_IMPORT(int) PyCFunction_GetFlags(PyObject *);
Guido van Rossum3f5da241990-12-20 15:06:42 +000022
Guido van Rossum92233511998-07-10 15:21:55 +000023/* Macros for direct access to these values. Type checks are *not*
24 done, so use with care. */
25#define PyCFunction_GET_FUNCTION(func) \
26 (((PyCFunctionObject *)func) -> m_ml -> ml_meth)
27#define PyCFunction_GET_SELF(func) \
28 (((PyCFunctionObject *)func) -> m_self)
29#define PyCFunction_GET_FLAGS(func) \
30 (((PyCFunctionObject *)func) -> m_ml -> ml_flags)
Jeremy Hylton910d7d42001-08-12 21:52:24 +000031extern DL_IMPORT(PyObject *) PyCFunction_Call(PyObject *, PyObject *, PyObject *);
Guido van Rossum92233511998-07-10 15:21:55 +000032
Guido van Rossumcaa63801995-01-12 11:45:45 +000033struct PyMethodDef {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000034 char *ml_name;
35 PyCFunction ml_meth;
36 int ml_flags;
37 char *ml_doc;
Guido van Rossum3f5da241990-12-20 15:06:42 +000038};
Guido van Rossumcaa63801995-01-12 11:45:45 +000039typedef struct PyMethodDef PyMethodDef;
Guido van Rossum3f5da241990-12-20 15:06:42 +000040
Fred Drakeea9cb5a2000-07-09 00:20:36 +000041extern DL_IMPORT(PyObject *) Py_FindMethod(PyMethodDef[], PyObject *, char *);
Guido van Rossum9dc8d0e1995-01-07 10:32:29 +000042
Fred Drakeea9cb5a2000-07-09 00:20:36 +000043extern DL_IMPORT(PyObject *) PyCFunction_New(PyMethodDef *, PyObject *);
Guido van Rossuma3309961993-07-28 09:05:47 +000044
Guido van Rossum5799b521995-01-04 19:06:22 +000045/* Flag passed to newmethodobject */
Andrew M. Kuchling767bf492000-08-03 02:28:54 +000046#define METH_OLDARGS 0x0000
Guido van Rossum5799b521995-01-04 19:06:22 +000047#define METH_VARARGS 0x0001
Guido van Rossumbebdc371995-07-26 17:58:29 +000048#define METH_KEYWORDS 0x0002
Jeremy Hylton910d7d42001-08-12 21:52:24 +000049/* METH_NOARGS and METH_O must not be combined with any other flag. */
50#define METH_NOARGS 0x0004
51#define METH_O 0x0008
Guido van Rossum5799b521995-01-04 19:06:22 +000052
Guido van Rossum69785031995-01-26 22:58:48 +000053typedef struct PyMethodChain {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000054 PyMethodDef *methods; /* Methods of this type */
55 struct PyMethodChain *link; /* NULL or base type */
Guido van Rossum69785031995-01-26 22:58:48 +000056} PyMethodChain;
57
Fred Drakeea9cb5a2000-07-09 00:20:36 +000058extern DL_IMPORT(PyObject *) Py_FindMethodInChain(PyMethodChain *, PyObject *,
59 char *);
Guido van Rossum69785031995-01-26 22:58:48 +000060
Guido van Rossum92233511998-07-10 15:21:55 +000061typedef struct {
Fred Drakeea9cb5a2000-07-09 00:20:36 +000062 PyObject_HEAD
63 PyMethodDef *m_ml;
64 PyObject *m_self;
Guido van Rossum92233511998-07-10 15:21:55 +000065} PyCFunctionObject;
66
Guido van Rossuma3309961993-07-28 09:05:47 +000067#ifdef __cplusplus
68}
69#endif
70#endif /* !Py_METHODOBJECT_H */