blob: acdb84ee74acd1c8d5a1b74a98269e6966c624bf [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#include <stddef.h> /* For offsetof */
Guido van Rossum5ebc0ca1994-10-20 22:03:08 +000011
Guido van Rossum3f5da241990-12-20 15:06:42 +000012/* The offsetof() macro calculates the offset of a structure member
13 in its structure. Unfortunately this cannot be written down
14 portably, hence it is provided by a Standard C header file.
15 For pre-Standard C compilers, here is a version that usually works
16 (but watch out!): */
17
18#ifndef offsetof
19#define offsetof(type, member) ( (int) & ((type*)0) -> member )
20#endif
21
Neal Norwitz8dfc4a92007-08-11 06:39:53 +000022/* An array of PyMemberDef structures defines the name, type and offset
Guido van Rossum3f5da241990-12-20 15:06:42 +000023 of selected members of a C structure. These can be read by
Neal Norwitz8dfc4a92007-08-11 06:39:53 +000024 PyMember_GetOne() and set by PyMember_SetOne() (except if their READONLY
25 flag is set). The array must be terminated with an entry whose name
Guido van Rossum3f5da241990-12-20 15:06:42 +000026 pointer is NULL. */
27
Guido van Rossum6f799372001-09-20 20:46:19 +000028typedef struct PyMemberDef {
29 /* Current version, use this */
30 char *name;
31 int type;
Martin v. Löwis44e379d2006-02-16 14:23:19 +000032 Py_ssize_t offset;
Guido van Rossum6f799372001-09-20 20:46:19 +000033 int flags;
34 char *doc;
35} PyMemberDef;
36
Guido van Rossum3f5da241990-12-20 15:06:42 +000037/* 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
Jack Jansen599f0d11994-12-14 13:04:05 +000056
Guido van Rossum6b705992001-12-04 16:23:42 +000057#define T_OBJECT_EX 16 /* Like T_OBJECT, but raises AttributeError
58 when the value is NULL, instead of
59 converting to None. */
Martin v. Löwis96d743e2005-03-03 23:00:26 +000060#ifdef HAVE_LONG_LONG
61#define T_LONGLONG 17
Guido van Rossum50e9fb92006-08-17 05:42:55 +000062#define T_ULONGLONG 18
Martin v. Löwis96d743e2005-03-03 23:00:26 +000063#endif /* HAVE_LONG_LONG */
Guido van Rossum6b705992001-12-04 16:23:42 +000064
Guido van Rossum806c2462007-08-06 23:33:07 +000065#define T_PYSSIZET 19 /* Py_ssize_t */
Guido van Rossum7eaf8222007-06-18 17:58:50 +000066#define T_NONE 20 /* Value is always None */
Guido van Rossum50e9fb92006-08-17 05:42:55 +000067
Guido van Rossum806c2462007-08-06 23:33:07 +000068
Guido van Rossumc299fc12001-09-17 19:28:08 +000069/* Flags */
Guido van Rossum3f5da241990-12-20 15:06:42 +000070#define READONLY 1
Guido van Rossumc299fc12001-09-17 19:28:08 +000071#define READ_RESTRICTED 2
Christian Heimesbce52be2007-11-17 19:08:41 +000072#define PY_WRITE_RESTRICTED 4
73#define RESTRICTED (READ_RESTRICTED | PY_WRITE_RESTRICTED)
Guido van Rossumc299fc12001-09-17 19:28:08 +000074
Guido van Rossum3f5da241990-12-20 15:06:42 +000075
Guido van Rossum6f799372001-09-20 20:46:19 +000076/* Current API, use this */
Tim Petersc3d12ac2005-12-24 06:03:06 +000077PyAPI_FUNC(PyObject *) PyMember_GetOne(const char *, struct PyMemberDef *);
Mark Hammond91a681d2002-08-12 07:21:58 +000078PyAPI_FUNC(int) PyMember_SetOne(char *, struct PyMemberDef *, PyObject *);
Guido van Rossum6f799372001-09-20 20:46:19 +000079
80
Guido van Rossuma3309961993-07-28 09:05:47 +000081#ifdef __cplusplus
82}
83#endif
84#endif /* !Py_STRUCTMEMBER_H */