1 | /* Set object interface */ |
2 | |
3 | #ifndef Py_SETOBJECT_H |
4 | #define Py_SETOBJECT_H |
5 | #ifdef __cplusplus |
6 | extern "C" { |
7 | #endif |
8 | |
9 | #ifndef Py_LIMITED_API |
10 | |
11 | /* There are three kinds of entries in the table: |
12 | |
13 | 1. Unused: key == NULL |
14 | 2. Active: key != NULL and key != dummy |
15 | 3. Dummy: key == dummy |
16 | |
17 | The hash field of Unused slots have no meaning. |
18 | The hash field of Dummny slots are set to -1 |
19 | meaning that dummy entries can be detected by |
20 | either entry->key==dummy or by entry->hash==-1. |
21 | */ |
22 | |
23 | #define PySet_MINSIZE 8 |
24 | |
25 | typedef struct { |
26 | PyObject *key; |
27 | Py_hash_t hash; /* Cached hash code of the key */ |
28 | } setentry; |
29 | |
30 | /* The SetObject data structure is shared by set and frozenset objects. |
31 | |
32 | Invariant for sets: |
33 | - hash is -1 |
34 | |
35 | Invariants for frozensets: |
36 | - data is immutable. |
37 | - hash is the hash of the frozenset or -1 if not computed yet. |
38 | |
39 | */ |
40 | |
41 | typedef struct { |
42 | PyObject_HEAD |
43 | |
44 | Py_ssize_t fill; /* Number active and dummy entries*/ |
45 | Py_ssize_t used; /* Number active entries */ |
46 | |
47 | /* The table contains mask + 1 slots, and that's a power of 2. |
48 | * We store the mask instead of the size because the mask is more |
49 | * frequently needed. |
50 | */ |
51 | Py_ssize_t mask; |
52 | |
53 | /* The table points to a fixed-size smalltable for small tables |
54 | * or to additional malloc'ed memory for bigger tables. |
55 | * The table pointer is never NULL which saves us from repeated |
56 | * runtime null-tests. |
57 | */ |
58 | setentry *table; |
59 | Py_hash_t hash; /* Only used by frozenset objects */ |
60 | Py_ssize_t finger; /* Search finger for pop() */ |
61 | |
62 | setentry smalltable[PySet_MINSIZE]; |
63 | PyObject *weakreflist; /* List of weak references */ |
64 | } PySetObject; |
65 | |
66 | #define PySet_GET_SIZE(so) (((PySetObject *)(so))->used) |
67 | |
68 | PyAPI_DATA(PyObject *) _PySet_Dummy; |
69 | |
70 | PyAPI_FUNC(int) _PySet_NextEntry(PyObject *set, Py_ssize_t *pos, PyObject **key, Py_hash_t *hash); |
71 | PyAPI_FUNC(int) _PySet_Update(PyObject *set, PyObject *iterable); |
72 | PyAPI_FUNC(int) PySet_ClearFreeList(void); |
73 | |
74 | #endif /* Section excluded by Py_LIMITED_API */ |
75 | |
76 | PyAPI_DATA(PyTypeObject) PySet_Type; |
77 | PyAPI_DATA(PyTypeObject) PyFrozenSet_Type; |
78 | PyAPI_DATA(PyTypeObject) PySetIter_Type; |
79 | |
80 | PyAPI_FUNC(PyObject *) PySet_New(PyObject *); |
81 | PyAPI_FUNC(PyObject *) PyFrozenSet_New(PyObject *); |
82 | |
83 | PyAPI_FUNC(int) PySet_Add(PyObject *set, PyObject *key); |
84 | PyAPI_FUNC(int) PySet_Clear(PyObject *set); |
85 | PyAPI_FUNC(int) PySet_Contains(PyObject *anyset, PyObject *key); |
86 | PyAPI_FUNC(int) PySet_Discard(PyObject *set, PyObject *key); |
87 | PyAPI_FUNC(PyObject *) PySet_Pop(PyObject *set); |
88 | PyAPI_FUNC(Py_ssize_t) PySet_Size(PyObject *anyset); |
89 | |
90 | #define PyFrozenSet_CheckExact(ob) (Py_TYPE(ob) == &PyFrozenSet_Type) |
91 | #define PyAnySet_CheckExact(ob) \ |
92 | (Py_TYPE(ob) == &PySet_Type || Py_TYPE(ob) == &PyFrozenSet_Type) |
93 | #define PyAnySet_Check(ob) \ |
94 | (Py_TYPE(ob) == &PySet_Type || Py_TYPE(ob) == &PyFrozenSet_Type || \ |
95 | PyType_IsSubtype(Py_TYPE(ob), &PySet_Type) || \ |
96 | PyType_IsSubtype(Py_TYPE(ob), &PyFrozenSet_Type)) |
97 | #define PySet_Check(ob) \ |
98 | (Py_TYPE(ob) == &PySet_Type || \ |
99 | PyType_IsSubtype(Py_TYPE(ob), &PySet_Type)) |
100 | #define PyFrozenSet_Check(ob) \ |
101 | (Py_TYPE(ob) == &PyFrozenSet_Type || \ |
102 | PyType_IsSubtype(Py_TYPE(ob), &PyFrozenSet_Type)) |
103 | |
104 | #ifdef __cplusplus |
105 | } |
106 | #endif |
107 | #endif /* !Py_SETOBJECT_H */ |
108 | |