blob: 7fcf6ec7896185464a15680780d99fc61610b002 [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_CLASSOBJECT_H
2#define Py_CLASSOBJECT_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumf70e43a1991-02-19 12:39:46 +00007/***********************************************************
Guido van Rossumfd71b9e2000-06-30 23:50:40 +00008Copyright (c) 2000, BeOpen.com.
9Copyright (c) 1995-2000, Corporation for National Research Initiatives.
10Copyright (c) 1990-1995, Stichting Mathematisch Centrum.
11All rights reserved.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000012
Guido van Rossumfd71b9e2000-06-30 23:50:40 +000013See the file "Misc/COPYRIGHT" for information on usage and
14redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000015******************************************************************/
16
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000017/* Class object interface */
18
Guido van Rossumb3f72581993-05-21 19:56:10 +000019/* Revealing some structures (not for general use) */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000020
Guido van Rossum81daa321993-05-20 14:24:46 +000021typedef struct {
Guido van Rossumcaa63801995-01-12 11:45:45 +000022 PyObject_HEAD
23 PyObject *cl_bases; /* A tuple of class objects */
24 PyObject *cl_dict; /* A dictionary */
25 PyObject *cl_name; /* A string */
Guido van Rossum03a90961994-09-06 09:48:43 +000026 /* The following three are functions or NULL */
Guido van Rossumcaa63801995-01-12 11:45:45 +000027 PyObject *cl_getattr;
28 PyObject *cl_setattr;
29 PyObject *cl_delattr;
30} PyClassObject;
Guido van Rossum81daa321993-05-20 14:24:46 +000031
Guido van Rossumb3f72581993-05-21 19:56:10 +000032typedef struct {
Guido van Rossumcaa63801995-01-12 11:45:45 +000033 PyObject_HEAD
34 PyClassObject *in_class; /* The class object */
35 PyObject *in_dict; /* A dictionary */
36} PyInstanceObject;
Guido van Rossumb3f72581993-05-21 19:56:10 +000037
Guido van Rossumd4ba73c1998-07-10 15:46:33 +000038typedef struct {
39 PyObject_HEAD
40 PyObject *im_func; /* The callable object implementing the method */
41 PyObject *im_self; /* The instance it is bound to, or NULL */
42 PyObject *im_class; /* The class that defined the method */
43} PyMethodObject;
44
Guido van Rossum051ab121995-02-27 10:17:52 +000045extern DL_IMPORT(PyTypeObject) PyClass_Type, PyInstance_Type, PyMethod_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000046
Guido van Rossumcaa63801995-01-12 11:45:45 +000047#define PyClass_Check(op) ((op)->ob_type == &PyClass_Type)
48#define PyInstance_Check(op) ((op)->ob_type == &PyInstance_Type)
49#define PyMethod_Check(op) ((op)->ob_type == &PyMethod_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000050
Guido van Rossum43466ec1998-12-04 18:48:25 +000051extern DL_IMPORT(PyObject *) PyClass_New Py_PROTO((PyObject *, PyObject *, PyObject *));
52extern DL_IMPORT(PyObject *) PyInstance_New Py_PROTO((PyObject *, PyObject *, PyObject *));
53extern DL_IMPORT(PyObject *) PyMethod_New Py_PROTO((PyObject *, PyObject *, PyObject *));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000054
Guido van Rossum43466ec1998-12-04 18:48:25 +000055extern DL_IMPORT(PyObject *) PyMethod_Function Py_PROTO((PyObject *));
56extern DL_IMPORT(PyObject *) PyMethod_Self Py_PROTO((PyObject *));
57extern DL_IMPORT(PyObject *) PyMethod_Class Py_PROTO((PyObject *));
Guido van Rossum04691fc1992-08-12 15:35:34 +000058
Guido van Rossumd4ba73c1998-07-10 15:46:33 +000059/* Macros for direct access to these values. Type checks are *not*
60 done, so use with care. */
61#define PyMethod_GET_FUNCTION(meth) \
62 (((PyMethodObject *)meth) -> im_func)
63#define PyMethod_GET_SELF(meth) \
64 (((PyMethodObject *)meth) -> im_self)
65#define PyMethod_GET_CLASS(meth) \
66 (((PyMethodObject *)meth) -> im_class)
67
Guido van Rossum43466ec1998-12-04 18:48:25 +000068extern DL_IMPORT(int) PyClass_IsSubclass Py_PROTO((PyObject *, PyObject *));
Guido van Rossuma3309961993-07-28 09:05:47 +000069
Guido van Rossum43466ec1998-12-04 18:48:25 +000070extern DL_IMPORT(PyObject *) PyInstance_DoBinOp
Guido van Rossumcaa63801995-01-12 11:45:45 +000071 Py_PROTO((PyObject *, PyObject *,
72 char *, char *,
73 PyObject * (*) Py_PROTO((PyObject *, PyObject *)) ));
Guido van Rossumc5d92e11994-09-28 15:44:39 +000074
Guido van Rossuma3309961993-07-28 09:05:47 +000075#ifdef __cplusplus
76}
77#endif
78#endif /* !Py_CLASSOBJECT_H */