/Windows/Python3.8/WPy64-3830/WPy64-3830/python-3.8.3.amd64/include/methodobject.h

  1
  2/* Method object interface */
  3
  4#ifndef Py_METHODOBJECT_H
  5#define Py_METHODOBJECT_H
  6#ifdef __cplusplus
  7extern "C" {
  8#endif
  9
 10/* This is about the type 'builtin_function_or_method',
 11   not Python methods in user-defined classes.  See classobject.h
 12   for the latter. */
 13
 14PyAPI_DATA(PyTypeObject) PyCFunction_Type;
 15
 16#define PyCFunction_Check(op) (Py_TYPE(op) == &PyCFunction_Type)
 17
 18typedef PyObject *(*PyCFunction)(PyObject *, PyObject *);
 19typedef PyObject *(*_PyCFunctionFast) (PyObject *, PyObject *const *, Py_ssize_t);
 20typedef PyObject *(*PyCFunctionWithKeywords)(PyObject *, PyObject *,
 21                                             PyObject *);
 22typedef PyObject *(*_PyCFunctionFastWithKeywords) (PyObject *,
 23                                                   PyObject *const *, Py_ssize_t,
 24                                                   PyObject *);
 25typedef PyObject *(*PyNoArgsFunction)(PyObject *);
 26
 27PyAPI_FUNC(PyCFunction) PyCFunction_GetFunction(PyObject *);
 28PyAPI_FUNC(PyObject *) PyCFunction_GetSelf(PyObject *);
 29PyAPI_FUNC(int) PyCFunction_GetFlags(PyObject *);
 30
 31/* Macros for direct access to these values. Type checks are *not*
 32   done, so use with care. */
 33#ifndef Py_LIMITED_API
 34#define PyCFunction_GET_FUNCTION(func) \
 35        (((PyCFunctionObject *)func) -> m_ml -> ml_meth)
 36#define PyCFunction_GET_SELF(func) \
 37        (((PyCFunctionObject *)func) -> m_ml -> ml_flags & METH_STATIC ? \
 38         NULL : ((PyCFunctionObject *)func) -> m_self)
 39#define PyCFunction_GET_FLAGS(func) \
 40        (((PyCFunctionObject *)func) -> m_ml -> ml_flags)
 41#endif
 42PyAPI_FUNC(PyObject *) PyCFunction_Call(PyObject *, PyObject *, PyObject *);
 43
 44#ifndef Py_LIMITED_API
 45PyAPI_FUNC(PyObject *) _PyCFunction_FastCallDict(PyObject *func,
 46    PyObject *const *args,
 47    Py_ssize_t nargs,
 48    PyObject *kwargs);
 49#endif
 50
 51struct PyMethodDef {
 52    const char  *ml_name;   /* The name of the built-in function/method */
 53    PyCFunction ml_meth;    /* The C function that implements it */
 54    int         ml_flags;   /* Combination of METH_xxx flags, which mostly
 55                               describe the args expected by the C func */
 56    const char  *ml_doc;    /* The __doc__ attribute, or NULL */
 57};
 58typedef struct PyMethodDef PyMethodDef;
 59
 60#define PyCFunction_New(ML, SELF) PyCFunction_NewEx((ML), (SELF), NULL)
 61PyAPI_FUNC(PyObject *) PyCFunction_NewEx(PyMethodDef *, PyObject *,
 62                                         PyObject *);
 63
 64/* Flag passed to newmethodobject */
 65/* #define METH_OLDARGS  0x0000   -- unsupported now */
 66#define METH_VARARGS  0x0001
 67#define METH_KEYWORDS 0x0002
 68/* METH_NOARGS and METH_O must not be combined with the flags above. */
 69#define METH_NOARGS   0x0004
 70#define METH_O        0x0008
 71
 72/* METH_CLASS and METH_STATIC are a little different; these control
 73   the construction of methods for a class.  These cannot be used for
 74   functions in modules. */
 75#define METH_CLASS    0x0010
 76#define METH_STATIC   0x0020
 77
 78/* METH_COEXIST allows a method to be entered even though a slot has
 79   already filled the entry.  When defined, the flag allows a separate
 80   method, "__contains__" for example, to coexist with a defined
 81   slot like sq_contains. */
 82
 83#define METH_COEXIST   0x0040
 84
 85#ifndef Py_LIMITED_API
 86#define METH_FASTCALL  0x0080
 87#endif
 88
 89/* This bit is preserved for Stackless Python */
 90#ifdef STACKLESS
 91#define METH_STACKLESS 0x0100
 92#else
 93#define METH_STACKLESS 0x0000
 94#endif
 95
 96#ifndef Py_LIMITED_API
 97typedef struct {
 98    PyObject_HEAD
 99    PyMethodDef *m_ml; /* Description of the C function to call */
100    PyObject    *m_self; /* Passed as 'self' arg to the C func, can be NULL */
101    PyObject    *m_module; /* The __module__ attribute, can be anything */
102    PyObject    *m_weakreflist; /* List of weak references */
103    vectorcallfunc vectorcall;
104} PyCFunctionObject;
105
106PyAPI_FUNC(PyObject *) _PyMethodDef_RawFastCallDict(
107    PyMethodDef *method,
108    PyObject *self,
109    PyObject *const *args,
110    Py_ssize_t nargs,
111    PyObject *kwargs);
112
113PyAPI_FUNC(PyObject *) _PyMethodDef_RawFastCallKeywords(
114    PyMethodDef *method,
115    PyObject *self,
116    PyObject *const *args,
117    Py_ssize_t nargs,
118    PyObject *kwnames);
119#endif
120
121PyAPI_FUNC(int) PyCFunction_ClearFreeList(void);
122
123#ifndef Py_LIMITED_API
124PyAPI_FUNC(void) _PyCFunction_DebugMallocStats(FILE *out);
125PyAPI_FUNC(void) _PyMethod_DebugMallocStats(FILE *out);
126#endif
127
128#ifdef __cplusplus
129}
130#endif
131#endif /* !Py_METHODOBJECT_H */