mirror of
https://github.com/python/cpython.git
synced 2024-11-24 17:47:13 +01:00
84 lines
2.8 KiB
C
84 lines
2.8 KiB
C
|
|
/* Method object interface */
|
|
|
|
#ifndef Py_METHODOBJECT_H
|
|
#define Py_METHODOBJECT_H
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* This is about the type 'builtin_function_or_method',
|
|
not Python methods in user-defined classes. See classobject.h
|
|
for the latter. */
|
|
|
|
PyAPI_DATA(PyTypeObject) PyCFunction_Type;
|
|
|
|
#define PyCFunction_Check(op) (Py_TYPE(op) == &PyCFunction_Type)
|
|
|
|
typedef PyObject *(*PyCFunction)(PyObject *, PyObject *);
|
|
typedef PyObject *(*PyCFunctionWithKeywords)(PyObject *, PyObject *,
|
|
PyObject *);
|
|
typedef PyObject *(*PyNoArgsFunction)(PyObject *);
|
|
|
|
PyAPI_FUNC(PyCFunction) PyCFunction_GetFunction(PyObject *);
|
|
PyAPI_FUNC(PyObject *) PyCFunction_GetSelf(PyObject *);
|
|
PyAPI_FUNC(int) PyCFunction_GetFlags(PyObject *);
|
|
|
|
/* 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)
|
|
PyAPI_FUNC(PyObject *) PyCFunction_Call(PyObject *, PyObject *, PyObject *);
|
|
|
|
struct PyMethodDef {
|
|
const char *ml_name; /* The name of the built-in function/method */
|
|
PyCFunction ml_meth; /* The C function that implements it */
|
|
int ml_flags; /* Combination of METH_xxx flags, which mostly
|
|
describe the args expected by the C func */
|
|
const char *ml_doc; /* The __doc__ attribute, or NULL */
|
|
};
|
|
typedef struct PyMethodDef PyMethodDef;
|
|
|
|
#define PyCFunction_New(ML, SELF) PyCFunction_NewEx((ML), (SELF), NULL)
|
|
PyAPI_FUNC(PyObject *) PyCFunction_NewEx(PyMethodDef *, PyObject *,
|
|
PyObject *);
|
|
|
|
/* Flag passed to newmethodobject */
|
|
/* #define METH_OLDARGS 0x0000 -- unsupported now */
|
|
#define METH_VARARGS 0x0001
|
|
#define METH_KEYWORDS 0x0002
|
|
/* METH_NOARGS and METH_O must not be combined with the flags above. */
|
|
#define METH_NOARGS 0x0004
|
|
#define METH_O 0x0008
|
|
|
|
/* 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
|
|
|
|
/* METH_COEXIST allows a method to be entered even though a slot has
|
|
already filled the entry. When defined, the flag allows a separate
|
|
method, "__contains__" for example, to coexist with a defined
|
|
slot like sq_contains. */
|
|
|
|
#define METH_COEXIST 0x0040
|
|
|
|
typedef struct {
|
|
PyObject_HEAD
|
|
PyMethodDef *m_ml; /* Description of the C function to call */
|
|
PyObject *m_self; /* Passed as 'self' arg to the C func, can be NULL */
|
|
PyObject *m_module; /* The __module__ attribute, can be anything */
|
|
} PyCFunctionObject;
|
|
|
|
PyAPI_FUNC(int) PyCFunction_ClearFreeList(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* !Py_METHODOBJECT_H */
|