blob: 4c7457cd0b26a220c2c277b568c6295b05b79c25 [file] [log] [blame]
Victor Stinnerffedd9a2018-11-27 00:12:26 +01001#ifndef Py_CPYTHON_DICTOBJECT_H
2# error "this header file must not be included directly"
3#endif
4
5#ifdef __cplusplus
6extern "C" {
7#endif
8
9typedef struct _dictkeysobject PyDictKeysObject;
10
11/* The ma_values pointer is NULL for a combined table
12 * or points to an array of PyObject* for a split table
13 */
14typedef struct {
15 PyObject_HEAD
16
17 /* Number of items in the dictionary */
18 Py_ssize_t ma_used;
19
20 /* Dictionary version: globally unique, value change each time
21 the dictionary is modified */
22 uint64_t ma_version_tag;
23
24 PyDictKeysObject *ma_keys;
25
26 /* If ma_values is NULL, the table is "combined": keys and values
27 are stored in ma_keys.
28
29 If ma_values is not NULL, the table is splitted:
30 keys are stored in ma_keys and values are stored in ma_values */
31 PyObject **ma_values;
32} PyDictObject;
33
34PyAPI_FUNC(PyObject *) _PyDict_GetItem_KnownHash(PyObject *mp, PyObject *key,
35 Py_hash_t hash);
36PyAPI_FUNC(PyObject *) _PyDict_GetItemIdWithError(PyObject *dp,
37 struct _Py_Identifier *key);
38PyAPI_FUNC(PyObject *) PyDict_SetDefault(
39 PyObject *mp, PyObject *key, PyObject *defaultobj);
40PyAPI_FUNC(int) _PyDict_SetItem_KnownHash(PyObject *mp, PyObject *key,
41 PyObject *item, Py_hash_t hash);
42PyAPI_FUNC(int) _PyDict_DelItem_KnownHash(PyObject *mp, PyObject *key,
43 Py_hash_t hash);
44PyAPI_FUNC(int) _PyDict_DelItemIf(PyObject *mp, PyObject *key,
45 int (*predicate)(PyObject *value));
46PyDictKeysObject *_PyDict_NewKeysForClass(void);
47PyAPI_FUNC(PyObject *) PyObject_GenericGetDict(PyObject *, void *);
48PyAPI_FUNC(int) _PyDict_Next(
49 PyObject *mp, Py_ssize_t *pos, PyObject **key, PyObject **value, Py_hash_t *hash);
50
51/* Get the number of items of a dictionary. */
52#define PyDict_GET_SIZE(mp) (assert(PyDict_Check(mp)),((PyDictObject *)mp)->ma_used)
53PyAPI_FUNC(int) _PyDict_Contains(PyObject *mp, PyObject *key, Py_hash_t hash);
54PyAPI_FUNC(PyObject *) _PyDict_NewPresized(Py_ssize_t minused);
55PyAPI_FUNC(void) _PyDict_MaybeUntrack(PyObject *mp);
56PyAPI_FUNC(int) _PyDict_HasOnlyStringKeys(PyObject *mp);
57Py_ssize_t _PyDict_KeysSize(PyDictKeysObject *keys);
58PyAPI_FUNC(Py_ssize_t) _PyDict_SizeOf(PyDictObject *);
59PyAPI_FUNC(PyObject *) _PyDict_Pop(PyObject *, PyObject *, PyObject *);
60PyObject *_PyDict_Pop_KnownHash(PyObject *, PyObject *, Py_hash_t, PyObject *);
61PyObject *_PyDict_FromKeys(PyObject *, PyObject *, PyObject *);
62#define _PyDict_HasSplitTable(d) ((d)->ma_values != NULL)
63
64PyAPI_FUNC(int) PyDict_ClearFreeList(void);
65
66/* Like PyDict_Merge, but override can be 0, 1 or 2. If override is 0,
67 the first occurrence of a key wins, if override is 1, the last occurrence
68 of a key wins, if override is 2, a KeyError with conflicting key as
69 argument is raised.
70*/
71PyAPI_FUNC(int) _PyDict_MergeEx(PyObject *mp, PyObject *other, int override);
72PyAPI_FUNC(PyObject *) _PyDict_GetItemId(PyObject *dp, struct _Py_Identifier *key);
73PyAPI_FUNC(int) _PyDict_SetItemId(PyObject *dp, struct _Py_Identifier *key, PyObject *item);
74
75PyAPI_FUNC(int) _PyDict_DelItemId(PyObject *mp, struct _Py_Identifier *key);
76PyAPI_FUNC(void) _PyDict_DebugMallocStats(FILE *out);
77
78int _PyObjectDict_SetItem(PyTypeObject *tp, PyObject **dictptr, PyObject *name, PyObject *value);
79PyObject *_PyDict_LoadGlobal(PyDictObject *, PyDictObject *, PyObject *);
80
81/* _PyDictView */
82
83typedef struct {
84 PyObject_HEAD
85 PyDictObject *dv_dict;
86} _PyDictViewObject;
87
88PyAPI_FUNC(PyObject *) _PyDictView_New(PyObject *, PyTypeObject *);
89PyAPI_FUNC(PyObject *) _PyDictView_Intersect(PyObject* self, PyObject *other);
90
91#ifdef __cplusplus
92}
93#endif