dictobject.h 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. #ifndef Py_DICTOBJECT_H
  2. #define Py_DICTOBJECT_H
  3. #ifdef __cplusplus
  4. extern "C" {
  5. #endif
  6. /* Dictionary object type -- mapping from hashable object to object */
  7. /* The distribution includes a separate file, Objects/dictnotes.txt,
  8. describing explorations into dictionary design and optimization.
  9. It covers typical dictionary use patterns, the parameters for
  10. tuning dictionaries, and several ideas for possible optimizations.
  11. */
  12. #ifndef Py_LIMITED_API
  13. typedef struct _dictkeysobject PyDictKeysObject;
  14. /* The ma_values pointer is NULL for a combined table
  15. * or points to an array of PyObject* for a split table
  16. */
  17. typedef struct {
  18. PyObject_HEAD
  19. Py_ssize_t ma_used;
  20. PyDictKeysObject *ma_keys;
  21. PyObject **ma_values;
  22. } PyDictObject;
  23. typedef struct {
  24. PyObject_HEAD
  25. PyDictObject *dv_dict;
  26. } _PyDictViewObject;
  27. #endif /* Py_LIMITED_API */
  28. PyAPI_DATA(PyTypeObject) PyDict_Type;
  29. PyAPI_DATA(PyTypeObject) PyDictIterKey_Type;
  30. PyAPI_DATA(PyTypeObject) PyDictIterValue_Type;
  31. PyAPI_DATA(PyTypeObject) PyDictIterItem_Type;
  32. PyAPI_DATA(PyTypeObject) PyDictKeys_Type;
  33. PyAPI_DATA(PyTypeObject) PyDictItems_Type;
  34. PyAPI_DATA(PyTypeObject) PyDictValues_Type;
  35. #define PyDict_Check(op) \
  36. PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_DICT_SUBCLASS)
  37. #define PyDict_CheckExact(op) (Py_TYPE(op) == &PyDict_Type)
  38. #define PyDictKeys_Check(op) PyObject_TypeCheck(op, &PyDictKeys_Type)
  39. #define PyDictItems_Check(op) PyObject_TypeCheck(op, &PyDictItems_Type)
  40. #define PyDictValues_Check(op) PyObject_TypeCheck(op, &PyDictValues_Type)
  41. /* This excludes Values, since they are not sets. */
  42. # define PyDictViewSet_Check(op) \
  43. (PyDictKeys_Check(op) || PyDictItems_Check(op))
  44. PyAPI_FUNC(PyObject *) PyDict_New(void);
  45. PyAPI_FUNC(PyObject *) PyDict_GetItem(PyObject *mp, PyObject *key);
  46. #ifndef Py_LIMITED_API
  47. PyAPI_FUNC(PyObject *) _PyDict_GetItem_KnownHash(PyObject *mp, PyObject *key,
  48. Py_hash_t hash);
  49. #endif
  50. PyAPI_FUNC(PyObject *) PyDict_GetItemWithError(PyObject *mp, PyObject *key);
  51. PyAPI_FUNC(PyObject *) _PyDict_GetItemIdWithError(PyObject *dp,
  52. struct _Py_Identifier *key);
  53. #ifndef Py_LIMITED_API
  54. PyAPI_FUNC(PyObject *) PyDict_SetDefault(
  55. PyObject *mp, PyObject *key, PyObject *defaultobj);
  56. #endif
  57. PyAPI_FUNC(int) PyDict_SetItem(PyObject *mp, PyObject *key, PyObject *item);
  58. #ifndef Py_LIMITED_API
  59. PyAPI_FUNC(int) _PyDict_SetItem_KnownHash(PyObject *mp, PyObject *key,
  60. PyObject *item, Py_hash_t hash);
  61. #endif
  62. PyAPI_FUNC(int) PyDict_DelItem(PyObject *mp, PyObject *key);
  63. #ifndef Py_LIMITED_API
  64. PyAPI_FUNC(int) _PyDict_DelItem_KnownHash(PyObject *mp, PyObject *key,
  65. Py_hash_t hash);
  66. #endif
  67. PyAPI_FUNC(void) PyDict_Clear(PyObject *mp);
  68. PyAPI_FUNC(int) PyDict_Next(
  69. PyObject *mp, Py_ssize_t *pos, PyObject **key, PyObject **value);
  70. #ifndef Py_LIMITED_API
  71. PyDictKeysObject *_PyDict_NewKeysForClass(void);
  72. PyAPI_FUNC(PyObject *) PyObject_GenericGetDict(PyObject *, void *);
  73. PyAPI_FUNC(int) _PyDict_Next(
  74. PyObject *mp, Py_ssize_t *pos, PyObject **key, PyObject **value, Py_hash_t *hash);
  75. PyObject *_PyDictView_New(PyObject *, PyTypeObject *);
  76. #endif
  77. PyAPI_FUNC(PyObject *) PyDict_Keys(PyObject *mp);
  78. PyAPI_FUNC(PyObject *) PyDict_Values(PyObject *mp);
  79. PyAPI_FUNC(PyObject *) PyDict_Items(PyObject *mp);
  80. PyAPI_FUNC(Py_ssize_t) PyDict_Size(PyObject *mp);
  81. PyAPI_FUNC(PyObject *) PyDict_Copy(PyObject *mp);
  82. PyAPI_FUNC(int) PyDict_Contains(PyObject *mp, PyObject *key);
  83. #ifndef Py_LIMITED_API
  84. PyAPI_FUNC(int) _PyDict_Contains(PyObject *mp, PyObject *key, Py_hash_t hash);
  85. PyAPI_FUNC(PyObject *) _PyDict_NewPresized(Py_ssize_t minused);
  86. PyAPI_FUNC(void) _PyDict_MaybeUntrack(PyObject *mp);
  87. PyAPI_FUNC(int) _PyDict_HasOnlyStringKeys(PyObject *mp);
  88. Py_ssize_t _PyDict_KeysSize(PyDictKeysObject *keys);
  89. Py_ssize_t _PyDict_SizeOf(PyDictObject *);
  90. PyObject *_PyDict_Pop(PyDictObject *, PyObject *, PyObject *);
  91. PyObject *_PyDict_FromKeys(PyObject *, PyObject *, PyObject *);
  92. #define _PyDict_HasSplitTable(d) ((d)->ma_values != NULL)
  93. PyAPI_FUNC(int) PyDict_ClearFreeList(void);
  94. #endif
  95. /* PyDict_Update(mp, other) is equivalent to PyDict_Merge(mp, other, 1). */
  96. PyAPI_FUNC(int) PyDict_Update(PyObject *mp, PyObject *other);
  97. /* PyDict_Merge updates/merges from a mapping object (an object that
  98. supports PyMapping_Keys() and PyObject_GetItem()). If override is true,
  99. the last occurrence of a key wins, else the first. The Python
  100. dict.update(other) is equivalent to PyDict_Merge(dict, other, 1).
  101. */
  102. PyAPI_FUNC(int) PyDict_Merge(PyObject *mp,
  103. PyObject *other,
  104. int override);
  105. #ifndef Py_LIMITED_API
  106. PyAPI_FUNC(PyObject *) _PyDictView_Intersect(PyObject* self, PyObject *other);
  107. #endif
  108. /* PyDict_MergeFromSeq2 updates/merges from an iterable object producing
  109. iterable objects of length 2. If override is true, the last occurrence
  110. of a key wins, else the first. The Python dict constructor dict(seq2)
  111. is equivalent to dict={}; PyDict_MergeFromSeq(dict, seq2, 1).
  112. */
  113. PyAPI_FUNC(int) PyDict_MergeFromSeq2(PyObject *d,
  114. PyObject *seq2,
  115. int override);
  116. PyAPI_FUNC(PyObject *) PyDict_GetItemString(PyObject *dp, const char *key);
  117. PyAPI_FUNC(PyObject *) _PyDict_GetItemId(PyObject *dp, struct _Py_Identifier *key);
  118. PyAPI_FUNC(int) PyDict_SetItemString(PyObject *dp, const char *key, PyObject *item);
  119. PyAPI_FUNC(int) _PyDict_SetItemId(PyObject *dp, struct _Py_Identifier *key, PyObject *item);
  120. PyAPI_FUNC(int) PyDict_DelItemString(PyObject *dp, const char *key);
  121. #ifndef Py_LIMITED_API
  122. PyAPI_FUNC(int) _PyDict_DelItemId(PyObject *mp, struct _Py_Identifier *key);
  123. PyAPI_FUNC(void) _PyDict_DebugMallocStats(FILE *out);
  124. int _PyObjectDict_SetItem(PyTypeObject *tp, PyObject **dictptr, PyObject *name, PyObject *value);
  125. PyObject *_PyDict_LoadGlobal(PyDictObject *, PyDictObject *, PyObject *);
  126. #endif
  127. #ifdef __cplusplus
  128. }
  129. #endif
  130. #endif /* !Py_DICTOBJECT_H */