blob: 09e62cf13b01e2aed8d38d43134c48bcf93277af [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 Rossum3f5da241990-12-20 15:06:42 +00008/* Interface to map C struct members to Python object attributes */
9
Guido van Rossum5ebc0ca1994-10-20 22:03:08 +000010#ifdef HAVE_STDDEF_H
11#include <stddef.h> /* For offsetof */
12#endif
13
Guido van Rossum3f5da241990-12-20 15:06:42 +000014/* The offsetof() macro calculates the offset of a structure member
15 in its structure. Unfortunately this cannot be written down
16 portably, hence it is provided by a Standard C header file.
17 For pre-Standard C compilers, here is a version that usually works
18 (but watch out!): */
19
20#ifndef offsetof
21#define offsetof(type, member) ( (int) & ((type*)0) -> member )
22#endif
23
24/* An array of memberlist structures defines the name, type and offset
25 of selected members of a C structure. These can be read by
Guido van Rossumcaa63801995-01-12 11:45:45 +000026 PyMember_Get() and set by PyMember_Set() (except if their READONLY flag
Guido van Rossum3f5da241990-12-20 15:06:42 +000027 is set). The array must be terminated with an entry whose name
28 pointer is NULL. */
29
30struct memberlist {
31 char *name;
32 int type;
33 int offset;
34 int readonly;
35};
36
37/* Types */
38#define T_SHORT 0
39#define T_INT 1
40#define T_LONG 2
41#define T_FLOAT 3
42#define T_DOUBLE 4
43#define T_STRING 5
44#define T_OBJECT 6
Guido van Rossum00023951992-06-03 17:07:40 +000045/* XXX the ordering here is weird for binary compatibility */
46#define T_CHAR 7 /* 1-character string */
47#define T_BYTE 8 /* 8-bit signed int */
48/* unsigned variants: */
49#define T_UBYTE 9
50#define T_USHORT 10
51#define T_UINT 11
52#define T_ULONG 12
Guido van Rossum3f5da241990-12-20 15:06:42 +000053
Jack Jansen599f0d11994-12-14 13:04:05 +000054/* Added by Jack: strings contained in the structure */
55#define T_STRING_INPLACE 13
56#ifdef macintosh
57#define T_PSTRING 14 /* macintosh pascal-style counted string */
58#define T_PSTRING_INPLACE 15
59#endif /* macintosh */
60
Guido van Rossum3f5da241990-12-20 15:06:42 +000061/* Readonly flag */
62#define READONLY 1
63#define RO READONLY /* Shorthand */
64
Fred Drake5eb6d4e2000-07-08 23:37:28 +000065DL_IMPORT(PyObject *) PyMember_Get(char *, struct memberlist *, char *);
66DL_IMPORT(int) PyMember_Set(char *, struct memberlist *, char *, PyObject *);
Guido van Rossuma3309961993-07-28 09:05:47 +000067
68#ifdef __cplusplus
69}
70#endif
71#endif /* !Py_STRUCTMEMBER_H */