Include/classobject.h

   1
   2 /* Class object interface */
   3
   4 /* Revealing some structures (not for general use) */
   5
   6 #ifndef Py_CLASSOBJECT_H
   7 #define Py_CLASSOBJECT_H
   8 #ifdef __cplusplus
   9 extern "C" {
  10 #endif
  11
  12 typedef struct {
  13     PyObject_HEAD
  14     PyObject    *cl_bases;      /* A tuple of class objects */
  15     PyObject    *cl_dict;       /* A dictionary */
  16     PyObject    *cl_name;       /* A string */
  17     /* The following three are functions or NULL */
  18     PyObject    *cl_getattr;
  19     PyObject    *cl_setattr;
  20     PyObject    *cl_delattr;
  21 } PyClassObject;
  22
  23 typedef struct {
  24     PyObject_HEAD
  25     PyClassObject *in_class;    /* The class object */
  26     PyObject      *in_dict;     /* A dictionary */
  27     PyObject      *in_weakreflist; /* List of weak references */
  28 } PyInstanceObject;
  29
  30 typedef struct {
  31     PyObject_HEAD
  32     PyObject *im_func;   /* The callable object implementing the method */
  33     PyObject *im_self;   /* The instance it is bound to, or NULL */
  34     PyObject *im_class;  /* The class that asked for the method */
  35     PyObject *im_weakreflist; /* List of weak references */
  36 } PyMethodObject;
  37
  38 PyAPI_DATA(PyTypeObject) PyClass_Type, PyInstance_Type, PyMethod_Type;
  39
  40 #define PyClass_Check(op) ((op)->ob_type == &PyClass_Type)
  41 #define PyInstance_Check(op) ((op)->ob_type == &PyInstance_Type)
  42 #define PyMethod_Check(op) ((op)->ob_type == &PyMethod_Type)
  43
  44 PyAPI_FUNC(PyObject *) PyClass_New(PyObject *, PyObject *, PyObject *);
  45 PyAPI_FUNC(PyObject *) PyInstance_New(PyObject *, PyObject *,
  46                                             PyObject *);
  47 PyAPI_FUNC(PyObject *) PyInstance_NewRaw(PyObject *, PyObject *);
  48 PyAPI_FUNC(PyObject *) PyMethod_New(PyObject *, PyObject *, PyObject *);
  49
  50 PyAPI_FUNC(PyObject *) PyMethod_Function(PyObject *);
  51 PyAPI_FUNC(PyObject *) PyMethod_Self(PyObject *);
  52 PyAPI_FUNC(PyObject *) PyMethod_Class(PyObject *);
  53
  54 /* Look up attribute with name (a string) on instance object pinst, using
  55  * only the instance and base class dicts.  If a descriptor is found in
  56  * a class dict, the descriptor is returned without calling it.
  57  * Returns NULL if nothing found, else a borrowed reference to the
  58  * value associated with name in the dict in which name was found.
  59  * The point of this routine is that it never calls arbitrary Python
  60  * code, so is always "safe":  all it does is dict lookups.  The function
  61  * can't fail, never sets an exception, and NULL is not an error (it just
  62  * means "not found").
  63  */
  64 PyAPI_FUNC(PyObject *) _PyInstance_Lookup(PyObject *pinst, PyObject *name);
  65
  66 /* Macros for direct access to these values. Type checks are *not*
  67    done, so use with care. */
  68 #define PyMethod_GET_FUNCTION(meth) \
  69         (((PyMethodObject *)meth) -> im_func)
  70 #define PyMethod_GET_SELF(meth) \
  71         (((PyMethodObject *)meth) -> im_self)
  72 #define PyMethod_GET_CLASS(meth) \
  73         (((PyMethodObject *)meth) -> im_class)
  74
  75 PyAPI_FUNC(int) PyClass_IsSubclass(PyObject *, PyObject *);
  76
  77 PyAPI_FUNC(int) PyMethod_ClearFreeList(void);
  78
  79 #ifdef __cplusplus
  80 }
  81 #endif
  82 #endif /* !Py_CLASSOBJECT_H */