structmember.h 1.98 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 */

12
/* An array of PyMemberDef structures defines the name, type and offset
Guido van Rossum's avatar
Guido van Rossum committed
13
   of selected members of a C structure.  These can be read by
14 15
   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
16 17
   pointer is NULL. */

18
typedef struct PyMemberDef {
19
    const char *name;
20 21 22
    int type;
    Py_ssize_t offset;
    int flags;
23
    const char *doc;
24 25
} PyMemberDef;

Guido van Rossum's avatar
Guido van Rossum committed
26
/* Types */
27 28 29 30 31 32 33
#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
34
/* XXX the ordering here is weird for binary compatibility */
35 36
#define T_CHAR      7   /* 1-character string */
#define T_BYTE      8   /* 8-bit signed int */
37
/* unsigned variants: */
38 39 40 41
#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
42

43
/* Added by Jack: strings contained in the structure */
44
#define T_STRING_INPLACE    13
45

46
/* Added by Lillo: bools contained in the structure (assumed char) */
47
#define T_BOOL      14
48

49 50 51 52
#define T_OBJECT_EX 16  /* Like T_OBJECT, but raises AttributeError
                           when the value is NULL, instead of
                           converting to None. */
#define T_LONGLONG      17
53
#define T_ULONGLONG     18
54

55
#define T_PYSSIZET      19      /* Py_ssize_t */
56
#define T_NONE          20      /* Value is always None */
57

58

59
/* Flags */
60 61
#define READONLY            1
#define READ_RESTRICTED     2
62
#define PY_WRITE_RESTRICTED 4
63
#define RESTRICTED          (READ_RESTRICTED | PY_WRITE_RESTRICTED)
64

Guido van Rossum's avatar
Guido van Rossum committed
65

66
/* Current API, use this */
67
PyAPI_FUNC(PyObject *) PyMember_GetOne(const char *, struct PyMemberDef *);
68
PyAPI_FUNC(int) PyMember_SetOne(char *, struct PyMemberDef *, PyObject *);
69 70


71 72 73 74
#ifdef __cplusplus
}
#endif
#endif /* !Py_STRUCTMEMBER_H */