methodobject.h 2.34 KB
Newer Older
1

Guido van Rossum's avatar
Guido van Rossum committed
2 3
/* Method object interface */

4 5 6 7 8 9
#ifndef Py_METHODOBJECT_H
#define Py_METHODOBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

10
PyAPI_DATA(PyTypeObject) PyCFunction_Type;
Guido van Rossum's avatar
Guido van Rossum committed
11

12
#define PyCFunction_Check(op) ((op)->ob_type == &PyCFunction_Type)
Guido van Rossum's avatar
Guido van Rossum committed
13

14 15 16
typedef PyObject *(*PyCFunction)(PyObject *, PyObject *);
typedef PyObject *(*PyCFunctionWithKeywords)(PyObject *, PyObject *,
					     PyObject *);
17
typedef PyObject *(*PyNoArgsFunction)(PyObject *);
Guido van Rossum's avatar
Guido van Rossum committed
18

19 20 21
PyAPI_FUNC(PyCFunction) PyCFunction_GetFunction(PyObject *);
PyAPI_FUNC(PyObject *) PyCFunction_GetSelf(PyObject *);
PyAPI_FUNC(int) PyCFunction_GetFlags(PyObject *);
Guido van Rossum's avatar
Guido van Rossum committed
22

23 24 25 26 27 28 29 30
/* Macros for direct access to these values. Type checks are *not*
   done, so use with care. */
#define PyCFunction_GET_FUNCTION(func) \
        (((PyCFunctionObject *)func) -> m_ml -> ml_meth)
#define PyCFunction_GET_SELF(func) \
	(((PyCFunctionObject *)func) -> m_self)
#define PyCFunction_GET_FLAGS(func) \
	(((PyCFunctionObject *)func) -> m_ml -> ml_flags)
31
PyAPI_FUNC(PyObject *) PyCFunction_Call(PyObject *, PyObject *, PyObject *);
32

33
struct PyMethodDef {
34 35 36 37
    char	*ml_name;
    PyCFunction  ml_meth;
    int		 ml_flags;
    char	*ml_doc;
Guido van Rossum's avatar
Guido van Rossum committed
38
};
39
typedef struct PyMethodDef PyMethodDef;
Guido van Rossum's avatar
Guido van Rossum committed
40

41
PyAPI_FUNC(PyObject *) Py_FindMethod(PyMethodDef[], PyObject *, char *);
42

43 44 45
#define PyCFunction_New(ML, SELF) PyCFunction_NewEx((ML), (SELF), NULL)
PyAPI_FUNC(PyObject *) PyCFunction_NewEx(PyMethodDef *, PyObject *, 
					 PyObject *);
46

Guido van Rossum's avatar
Guido van Rossum committed
47
/* Flag passed to newmethodobject */
48
#define METH_OLDARGS  0x0000
Guido van Rossum's avatar
Guido van Rossum committed
49
#define METH_VARARGS  0x0001
50
#define METH_KEYWORDS 0x0002
51
/* METH_NOARGS and METH_O must not be combined with the flags above. */
52 53
#define METH_NOARGS   0x0004
#define METH_O        0x0008
Guido van Rossum's avatar
Guido van Rossum committed
54

55 56 57 58 59 60
/* METH_CLASS and METH_STATIC are a little different; these control
   the construction of methods for a class.  These cannot be used for
   functions in modules. */
#define METH_CLASS    0x0010
#define METH_STATIC   0x0020

61
typedef struct PyMethodChain {
62 63
    PyMethodDef *methods;		/* Methods of this type */
    struct PyMethodChain *link;	/* NULL or base type */
64 65
} PyMethodChain;

66
PyAPI_FUNC(PyObject *) Py_FindMethodInChain(PyMethodChain *, PyObject *,
67
                                                  char *);
68

69
typedef struct {
70 71 72
    PyObject_HEAD
    PyMethodDef *m_ml;
    PyObject    *m_self;
73
    PyObject    *m_module;
74 75
} PyCFunctionObject;

76 77 78 79
#ifdef __cplusplus
}
#endif
#endif /* !Py_METHODOBJECT_H */