Include/methodobject.h

   1 #ifndef Py_METHODOBJECT_H
   2 #define Py_METHODOBJECT_H
   3 #ifdef __cplusplus
   4 extern "C" {
   5 #endif
   6
   7 /***********************************************************
   8 Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
   9 The Netherlands.
  10
  11                         All Rights Reserved
  12
  13 Permission to use, copy, modify, and distribute this software and its
  14 documentation for any purpose and without fee is hereby granted,
  15 provided that the above copyright notice appear in all copies and that
  16 both that copyright notice and this permission notice appear in
  17 supporting documentation, and that the names of Stichting Mathematisch
  18 Centrum or CWI or Corporation for National Research Initiatives or
  19 CNRI not be used in advertising or publicity pertaining to
  20 distribution of the software without specific, written prior
  21 permission.
  22
  23 While CWI is the initial source for this software, a modified version
  24 is made available by the Corporation for National Research Initiatives
  25 (CNRI) at the Internet address ftp://ftp.python.org.
  26
  27 STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
  28 REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
  29 MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
  30 CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
  31 DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
  32 PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  33 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  34 PERFORMANCE OF THIS SOFTWARE.
  35
  36 ******************************************************************/
  37
  38 /* Method object interface */
  39
  40 extern DL_IMPORT(PyTypeObject) PyCFunction_Type;
  41
  42 #define PyCFunction_Check(op) ((op)->ob_type == &PyCFunction_Type)
  43
  44 typedef PyObject *(*PyCFunction) Py_FPROTO((PyObject *, PyObject *));
  45 typedef PyObject *(*PyCFunctionWithKeywords)
  46         Py_FPROTO((PyObject *, PyObject *, PyObject *));
  47
  48 extern DL_IMPORT(PyCFunction) PyCFunction_GetFunction Py_PROTO((PyObject *));
  49 extern DL_IMPORT(PyObject *) PyCFunction_GetSelf Py_PROTO((PyObject *));
  50 extern DL_IMPORT(int) PyCFunction_GetFlags Py_PROTO((PyObject *));
  51
  52 /* Macros for direct access to these values. Type checks are *not*
  53    done, so use with care. */
  54 #define PyCFunction_GET_FUNCTION(func) \
  55         (((PyCFunctionObject *)func) -> m_ml -> ml_meth)
  56 #define PyCFunction_GET_SELF(func) \
  57         (((PyCFunctionObject *)func) -> m_self)
  58 #define PyCFunction_GET_FLAGS(func) \
  59         (((PyCFunctionObject *)func) -> m_ml -> ml_flags)
  60
  61 struct PyMethodDef {
  62         char            *ml_name;
  63         PyCFunction     ml_meth;
  64         int             ml_flags;
  65         char            *ml_doc;
  66 };
  67 typedef struct PyMethodDef PyMethodDef;
  68
  69 extern DL_IMPORT(PyObject *) Py_FindMethod
  70         Py_PROTO((PyMethodDef[], PyObject *, char *));
  71
  72 extern DL_IMPORT(PyObject *) PyCFunction_New
  73         Py_PROTO((PyMethodDef *, PyObject *));
  74
  75 /* Flag passed to newmethodobject */
  76 #define METH_VARARGS  0x0001
  77 #define METH_KEYWORDS 0x0002
  78
  79 typedef struct PyMethodChain {
  80         PyMethodDef *methods;           /* Methods of this type */
  81         struct PyMethodChain *link;     /* NULL or base type */
  82 } PyMethodChain;
  83
  84 extern DL_IMPORT(PyObject *) Py_FindMethodInChain
  85         Py_PROTO((PyMethodChain *, PyObject *, char *));
  86
  87 typedef struct {
  88         PyObject_HEAD
  89         PyMethodDef *m_ml;
  90         PyObject    *m_self;
  91 } PyCFunctionObject;
  92
  93 #ifdef __cplusplus
  94 }
  95 #endif
  96 #endif /* !Py_METHODOBJECT_H */