blob: e03f46828d1144619cde4c686a0a89a516e53552 [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 Rossum5799b521995-01-04 19:06:22 +00008Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
9The Netherlands.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000010
11 All Rights Reserved
12
Guido van Rossumd266eb41996-10-25 14:44:06 +000013Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
Guido van Rossumf70e43a1991-02-19 12:39:46 +000015provided that the above copyright notice appear in all copies and that
Guido van Rossumd266eb41996-10-25 14:44:06 +000016both that copyright notice and this permission notice appear in
Guido van Rossumf70e43a1991-02-19 12:39:46 +000017supporting documentation, and that the names of Stichting Mathematisch
Guido van Rossumd266eb41996-10-25 14:44:06 +000018Centrum or CWI or Corporation for National Research Initiatives or
19CNRI not be used in advertising or publicity pertaining to
20distribution of the software without specific, written prior
21permission.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000022
Guido van Rossumd266eb41996-10-25 14:44:06 +000023While CWI is the initial source for this software, a modified version
24is made available by the Corporation for National Research Initiatives
25(CNRI) at the Internet address ftp://ftp.python.org.
26
27STICHTING MATHEMATISCH CENTRUM AND CNRI DISCLAIM ALL WARRANTIES WITH
28REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
29MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH
30CENTRUM OR CNRI BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
31DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
32PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
33TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
34PERFORMANCE OF THIS SOFTWARE.
Guido van Rossumf70e43a1991-02-19 12:39:46 +000035
36******************************************************************/
37
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000038/* Class object interface */
39
Guido van Rossumb3f72581993-05-21 19:56:10 +000040/* Revealing some structures (not for general use) */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000041
Guido van Rossum81daa321993-05-20 14:24:46 +000042typedef struct {
Guido van Rossumcaa63801995-01-12 11:45:45 +000043 PyObject_HEAD
44 PyObject *cl_bases; /* A tuple of class objects */
45 PyObject *cl_dict; /* A dictionary */
46 PyObject *cl_name; /* A string */
Guido van Rossum03a90961994-09-06 09:48:43 +000047 /* The following three are functions or NULL */
Guido van Rossumcaa63801995-01-12 11:45:45 +000048 PyObject *cl_getattr;
49 PyObject *cl_setattr;
50 PyObject *cl_delattr;
51} PyClassObject;
Guido van Rossum81daa321993-05-20 14:24:46 +000052
Guido van Rossumb3f72581993-05-21 19:56:10 +000053typedef struct {
Guido van Rossumcaa63801995-01-12 11:45:45 +000054 PyObject_HEAD
55 PyClassObject *in_class; /* The class object */
56 PyObject *in_dict; /* A dictionary */
57} PyInstanceObject;
Guido van Rossumb3f72581993-05-21 19:56:10 +000058
Guido van Rossumd4ba73c1998-07-10 15:46:33 +000059typedef struct {
60 PyObject_HEAD
61 PyObject *im_func; /* The callable object implementing the method */
62 PyObject *im_self; /* The instance it is bound to, or NULL */
63 PyObject *im_class; /* The class that defined the method */
64} PyMethodObject;
65
Guido van Rossum051ab121995-02-27 10:17:52 +000066extern DL_IMPORT(PyTypeObject) PyClass_Type, PyInstance_Type, PyMethod_Type;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000067
Guido van Rossumcaa63801995-01-12 11:45:45 +000068#define PyClass_Check(op) ((op)->ob_type == &PyClass_Type)
69#define PyInstance_Check(op) ((op)->ob_type == &PyInstance_Type)
70#define PyMethod_Check(op) ((op)->ob_type == &PyMethod_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000071
Guido van Rossumcaa63801995-01-12 11:45:45 +000072extern PyObject *PyClass_New Py_PROTO((PyObject *, PyObject *, PyObject *));
Guido van Rossumbebdc371995-07-26 17:58:29 +000073extern PyObject *PyInstance_New Py_PROTO((PyObject *, PyObject *, PyObject *));
Guido van Rossumcaa63801995-01-12 11:45:45 +000074extern PyObject *PyMethod_New Py_PROTO((PyObject *, PyObject *, PyObject *));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000075
Guido van Rossumcaa63801995-01-12 11:45:45 +000076extern PyObject *PyMethod_Function Py_PROTO((PyObject *));
77extern PyObject *PyMethod_Self Py_PROTO((PyObject *));
78extern PyObject *PyMethod_Class Py_PROTO((PyObject *));
Guido van Rossum04691fc1992-08-12 15:35:34 +000079
Guido van Rossumd4ba73c1998-07-10 15:46:33 +000080/* Macros for direct access to these values. Type checks are *not*
81 done, so use with care. */
82#define PyMethod_GET_FUNCTION(meth) \
83 (((PyMethodObject *)meth) -> im_func)
84#define PyMethod_GET_SELF(meth) \
85 (((PyMethodObject *)meth) -> im_self)
86#define PyMethod_GET_CLASS(meth) \
87 (((PyMethodObject *)meth) -> im_class)
88
Guido van Rossumcaa63801995-01-12 11:45:45 +000089extern int PyClass_IsSubclass Py_PROTO((PyObject *, PyObject *));
Guido van Rossuma3309961993-07-28 09:05:47 +000090
Guido van Rossum855d0b31995-01-20 16:52:42 +000091extern PyObject *PyInstance_DoBinOp
Guido van Rossumcaa63801995-01-12 11:45:45 +000092 Py_PROTO((PyObject *, PyObject *,
93 char *, char *,
94 PyObject * (*) Py_PROTO((PyObject *, PyObject *)) ));
Guido van Rossumc5d92e11994-09-28 15:44:39 +000095
Guido van Rossuma3309961993-07-28 09:05:47 +000096#ifdef __cplusplus
97}
98#endif
99#endif /* !Py_CLASSOBJECT_H */