mirror of https://github.com/python/cpython
119 lines
4.6 KiB
C
119 lines
4.6 KiB
C
#ifndef Py_CPYTHON_DICTOBJECT_H
|
|
# error "this header file must not be included directly"
|
|
#endif
|
|
|
|
typedef struct _dictkeysobject PyDictKeysObject;
|
|
typedef struct _dictvalues PyDictValues;
|
|
|
|
/* The ma_values pointer is NULL for a combined table
|
|
* or points to an array of PyObject* for a split table
|
|
*/
|
|
typedef struct {
|
|
PyObject_HEAD
|
|
|
|
/* Number of items in the dictionary */
|
|
Py_ssize_t ma_used;
|
|
|
|
/* Dictionary version: globally unique, value change each time
|
|
the dictionary is modified */
|
|
#ifdef Py_BUILD_CORE
|
|
uint64_t ma_version_tag;
|
|
#else
|
|
Py_DEPRECATED(3.12) uint64_t ma_version_tag;
|
|
#endif
|
|
|
|
PyDictKeysObject *ma_keys;
|
|
|
|
/* If ma_values is NULL, the table is "combined": keys and values
|
|
are stored in ma_keys.
|
|
|
|
If ma_values is not NULL, the table is split:
|
|
keys are stored in ma_keys and values are stored in ma_values */
|
|
PyDictValues *ma_values;
|
|
} PyDictObject;
|
|
|
|
PyAPI_FUNC(PyObject *) _PyDict_GetItem_KnownHash(PyObject *mp, PyObject *key,
|
|
Py_hash_t hash);
|
|
PyAPI_FUNC(PyObject *) _PyDict_GetItemWithError(PyObject *dp, PyObject *key);
|
|
PyAPI_FUNC(PyObject *) _PyDict_GetItemIdWithError(PyObject *dp,
|
|
_Py_Identifier *key);
|
|
PyAPI_FUNC(PyObject *) _PyDict_GetItemStringWithError(PyObject *, const char *);
|
|
PyAPI_FUNC(PyObject *) PyDict_SetDefault(
|
|
PyObject *mp, PyObject *key, PyObject *defaultobj);
|
|
PyAPI_FUNC(int) _PyDict_SetItem_KnownHash(PyObject *mp, PyObject *key,
|
|
PyObject *item, Py_hash_t hash);
|
|
PyAPI_FUNC(int) _PyDict_DelItem_KnownHash(PyObject *mp, PyObject *key,
|
|
Py_hash_t hash);
|
|
PyAPI_FUNC(int) _PyDict_DelItemIf(PyObject *mp, PyObject *key,
|
|
int (*predicate)(PyObject *value));
|
|
PyAPI_FUNC(int) _PyDict_Next(
|
|
PyObject *mp, Py_ssize_t *pos, PyObject **key, PyObject **value, Py_hash_t *hash);
|
|
|
|
/* Get the number of items of a dictionary. */
|
|
static inline Py_ssize_t PyDict_GET_SIZE(PyObject *op) {
|
|
PyDictObject *mp;
|
|
assert(PyDict_Check(op));
|
|
mp = _Py_CAST(PyDictObject*, op);
|
|
return mp->ma_used;
|
|
}
|
|
#define PyDict_GET_SIZE(op) PyDict_GET_SIZE(_PyObject_CAST(op))
|
|
|
|
PyAPI_FUNC(int) _PyDict_Contains_KnownHash(PyObject *, PyObject *, Py_hash_t);
|
|
PyAPI_FUNC(int) _PyDict_ContainsId(PyObject *, _Py_Identifier *);
|
|
PyAPI_FUNC(PyObject *) _PyDict_NewPresized(Py_ssize_t minused);
|
|
PyAPI_FUNC(void) _PyDict_MaybeUntrack(PyObject *mp);
|
|
PyAPI_FUNC(int) _PyDict_HasOnlyStringKeys(PyObject *mp);
|
|
PyAPI_FUNC(Py_ssize_t) _PyDict_SizeOf(PyDictObject *);
|
|
PyAPI_FUNC(PyObject *) _PyDict_Pop(PyObject *, PyObject *, PyObject *);
|
|
#define _PyDict_HasSplitTable(d) ((d)->ma_values != NULL)
|
|
|
|
/* Like PyDict_Merge, but override can be 0, 1 or 2. If override is 0,
|
|
the first occurrence of a key wins, if override is 1, the last occurrence
|
|
of a key wins, if override is 2, a KeyError with conflicting key as
|
|
argument is raised.
|
|
*/
|
|
PyAPI_FUNC(int) _PyDict_MergeEx(PyObject *mp, PyObject *other, int override);
|
|
PyAPI_FUNC(int) _PyDict_SetItemId(PyObject *dp, _Py_Identifier *key, PyObject *item);
|
|
|
|
PyAPI_FUNC(int) _PyDict_DelItemId(PyObject *mp, _Py_Identifier *key);
|
|
PyAPI_FUNC(void) _PyDict_DebugMallocStats(FILE *out);
|
|
|
|
/* _PyDictView */
|
|
|
|
typedef struct {
|
|
PyObject_HEAD
|
|
PyDictObject *dv_dict;
|
|
} _PyDictViewObject;
|
|
|
|
PyAPI_FUNC(PyObject *) _PyDictView_New(PyObject *, PyTypeObject *);
|
|
PyAPI_FUNC(PyObject *) _PyDictView_Intersect(PyObject* self, PyObject *other);
|
|
|
|
/* Dictionary watchers */
|
|
|
|
#define PY_FOREACH_DICT_EVENT(V) \
|
|
V(ADDED) \
|
|
V(MODIFIED) \
|
|
V(DELETED) \
|
|
V(CLONED) \
|
|
V(CLEARED) \
|
|
V(DEALLOCATED)
|
|
|
|
typedef enum {
|
|
#define PY_DEF_EVENT(EVENT) PyDict_EVENT_##EVENT,
|
|
PY_FOREACH_DICT_EVENT(PY_DEF_EVENT)
|
|
#undef PY_DEF_EVENT
|
|
} PyDict_WatchEvent;
|
|
|
|
// Callback to be invoked when a watched dict is cleared, dealloced, or modified.
|
|
// In clear/dealloc case, key and new_value will be NULL. Otherwise, new_value will be the
|
|
// new value for key, NULL if key is being deleted.
|
|
typedef int(*PyDict_WatchCallback)(PyDict_WatchEvent event, PyObject* dict, PyObject* key, PyObject* new_value);
|
|
|
|
// Register/unregister a dict-watcher callback
|
|
PyAPI_FUNC(int) PyDict_AddWatcher(PyDict_WatchCallback callback);
|
|
PyAPI_FUNC(int) PyDict_ClearWatcher(int watcher_id);
|
|
|
|
// Mark given dictionary as "watched" (callback will be called if it is modified)
|
|
PyAPI_FUNC(int) PyDict_Watch(int watcher_id, PyObject* dict);
|
|
PyAPI_FUNC(int) PyDict_Unwatch(int watcher_id, PyObject* dict);
|