setobject.h 3.3 KB

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