structmember.h 2.29 KB
Newer Older
1 2 3 4 5 6
#ifndef Py_STRUCTMEMBER_H
#define Py_STRUCTMEMBER_H
#ifdef __cplusplus
extern "C" {
#endif

7

Guido van Rossum's avatar
Guido van Rossum committed
8 9
/* Interface to map C struct members to Python object attributes */

Guido van Rossum's avatar
Guido van Rossum committed
10 11
#include <stddef.h> /* For offsetof */

Guido van Rossum's avatar
Guido van Rossum committed
12 13 14 15 16 17 18 19 20 21
/* The offsetof() macro calculates the offset of a structure member
   in its structure.  Unfortunately this cannot be written down
   portably, hence it is provided by a Standard C header file.
   For pre-Standard C compilers, here is a version that usually works
   (but watch out!): */

#ifndef offsetof
#define offsetof(type, member) ( (int) & ((type*)0) -> member )
#endif

22
/* An array of PyMemberDef structures defines the name, type and offset
Guido van Rossum's avatar
Guido van Rossum committed
23
   of selected members of a C structure.  These can be read by
24 25
   PyMember_GetOne() and set by PyMember_SetOne() (except if their READONLY
   flag is set).  The array must be terminated with an entry whose name
Guido van Rossum's avatar
Guido van Rossum committed
26 27
   pointer is NULL. */

28 29 30 31
typedef struct PyMemberDef {
	/* Current version, use this */
	char *name;
	int type;
32
	Py_ssize_t offset;
33 34 35 36
	int flags;
	char *doc;
} PyMemberDef;

Guido van Rossum's avatar
Guido van Rossum committed
37 38 39 40 41 42 43 44
/* Types */
#define T_SHORT		0
#define T_INT		1
#define T_LONG		2
#define T_FLOAT		3
#define T_DOUBLE	4
#define T_STRING	5
#define T_OBJECT	6
45 46 47 48 49 50 51 52
/* XXX the ordering here is weird for binary compatibility */
#define T_CHAR		7	/* 1-character string */
#define T_BYTE		8	/* 8-bit signed int */
/* unsigned variants: */
#define T_UBYTE		9
#define T_USHORT	10
#define T_UINT		11
#define T_ULONG		12
Guido van Rossum's avatar
Guido van Rossum committed
53

54 55 56
/* Added by Jack: strings contained in the structure */
#define T_STRING_INPLACE	13

57 58 59
/* Added by Lillo: bools contained in the structure (assumed char) */
#define T_BOOL		14

60 61 62
#define T_OBJECT_EX	16	/* Like T_OBJECT, but raises AttributeError
				   when the value is NULL, instead of
				   converting to None. */
63 64
#ifdef HAVE_LONG_LONG
#define T_LONGLONG      17  
65
#define T_ULONGLONG     18
66
#endif /* HAVE_LONG_LONG */
67

68
#define T_PYSSIZET      19      /* Py_ssize_t */
69
#define T_NONE          20      /* Value is always None */
70

71

72
/* Flags */
Guido van Rossum's avatar
Guido van Rossum committed
73
#define READONLY	1
74
#define READ_RESTRICTED	2
75 76
#define PY_WRITE_RESTRICTED 4
#define RESTRICTED	(READ_RESTRICTED | PY_WRITE_RESTRICTED)
77

Guido van Rossum's avatar
Guido van Rossum committed
78

79
/* Current API, use this */
80
PyAPI_FUNC(PyObject *) PyMember_GetOne(const char *, struct PyMemberDef *);
81
PyAPI_FUNC(int) PyMember_SetOne(char *, struct PyMemberDef *, PyObject *);
82 83


84 85 86 87
#ifdef __cplusplus
}
#endif
#endif /* !Py_STRUCTMEMBER_H */