blob: cb27c7c5e69cd94a8d9ff4554d1ac51ffb272b50 [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_OBJIMPL_H
2#define Py_OBJIMPL_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
13Permission to use, copy, modify, and distribute this software and its
14documentation for any purpose and without fee is hereby granted,
15provided that the above copyright notice appear in all copies and that
16both that copyright notice and this permission notice appear in
17supporting documentation, and that the names of Stichting Mathematisch
18Centrum or CWI not be used in advertising or publicity pertaining to
19distribution of the software without specific, written prior permission.
20
21STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
22THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
23FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
24FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
25WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
26ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
27OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
28
29******************************************************************/
30
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000031/*
32123456789-123456789-123456789-123456789-123456789-123456789-123456789-12
33
34Additional macros for modules that implement new object types.
35You must first include "object.h".
36
Guido van Rossumcaa63801995-01-12 11:45:45 +000037PyObject_NEW(type, typeobj) allocates memory for a new object of the given
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000038type; here 'type' must be the C structure type used to represent the
39object and 'typeobj' the address of the corresponding type object.
40Reference count and type pointer are filled in; the rest of the bytes of
41the object are *undefined*! The resulting expression type is 'type *'.
42The size of the object is actually determined by the tp_basicsize field
43of the type object.
44
Guido van Rossumcaa63801995-01-12 11:45:45 +000045PyObject_NEW_VAR(type, typeobj, n) is similar but allocates a variable-size
46object with n extra items. The size is computed as tp_basicsize plus
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000047n * tp_itemsize. This fills in the ob_size field as well.
48*/
49
Guido van Rossumcaa63801995-01-12 11:45:45 +000050extern PyObject *_PyObject_New Py_PROTO((PyTypeObject *));
51extern varobject *_PyObject_NewVar Py_PROTO((PyTypeObject *, unsigned int));
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000052
Guido van Rossumcaa63801995-01-12 11:45:45 +000053#define PyObject_NEW(type, typeobj) ((type *) _PyObject_New(typeobj))
54#define PyObject_NEW_VAR(type, typeobj, n) ((type *) _PyObject_NewVar(typeobj, n))
Guido van Rossuma3309961993-07-28 09:05:47 +000055
56#ifdef __cplusplus
57}
58#endif
59#endif /* !Py_OBJIMPL_H */