blob: 0c008561a828e05b2c44c80325210f6a08555f90 [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_STRUCTMEMBER_H
2#define Py_STRUCTMEMBER_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 Rossum3f5da241990-12-20 15:06:42 +000031/* Interface to map C struct members to Python object attributes */
32
Guido van Rossum5ebc0ca1994-10-20 22:03:08 +000033#ifdef HAVE_STDDEF_H
34#include <stddef.h> /* For offsetof */
35#endif
36
Guido van Rossum3f5da241990-12-20 15:06:42 +000037/* The offsetof() macro calculates the offset of a structure member
38 in its structure. Unfortunately this cannot be written down
39 portably, hence it is provided by a Standard C header file.
40 For pre-Standard C compilers, here is a version that usually works
41 (but watch out!): */
42
43#ifndef offsetof
44#define offsetof(type, member) ( (int) & ((type*)0) -> member )
45#endif
46
47/* An array of memberlist structures defines the name, type and offset
48 of selected members of a C structure. These can be read by
Guido van Rossumcaa63801995-01-12 11:45:45 +000049 PyMember_Get() and set by PyMember_Set() (except if their READONLY flag
Guido van Rossum3f5da241990-12-20 15:06:42 +000050 is set). The array must be terminated with an entry whose name
51 pointer is NULL. */
52
53struct memberlist {
54 char *name;
55 int type;
56 int offset;
57 int readonly;
58};
59
60/* Types */
61#define T_SHORT 0
62#define T_INT 1
63#define T_LONG 2
64#define T_FLOAT 3
65#define T_DOUBLE 4
66#define T_STRING 5
67#define T_OBJECT 6
Guido van Rossum00023951992-06-03 17:07:40 +000068/* XXX the ordering here is weird for binary compatibility */
69#define T_CHAR 7 /* 1-character string */
70#define T_BYTE 8 /* 8-bit signed int */
71/* unsigned variants: */
72#define T_UBYTE 9
73#define T_USHORT 10
74#define T_UINT 11
75#define T_ULONG 12
Guido van Rossum3f5da241990-12-20 15:06:42 +000076
Jack Jansen599f0d11994-12-14 13:04:05 +000077/* Added by Jack: strings contained in the structure */
78#define T_STRING_INPLACE 13
79#ifdef macintosh
80#define T_PSTRING 14 /* macintosh pascal-style counted string */
81#define T_PSTRING_INPLACE 15
82#endif /* macintosh */
83
Guido van Rossum3f5da241990-12-20 15:06:42 +000084/* Readonly flag */
85#define READONLY 1
86#define RO READONLY /* Shorthand */
87
Guido van Rossumcaa63801995-01-12 11:45:45 +000088PyObject *PyMember_Get Py_PROTO((char *, struct memberlist *, char *));
89int PyMember_Set Py_PROTO((char *, struct memberlist *, char *, PyObject *));
Guido van Rossuma3309961993-07-28 09:05:47 +000090
91#ifdef __cplusplus
92}
93#endif
94#endif /* !Py_STRUCTMEMBER_H */