blob: 16bd1d6cb1f21ccea44b77f13b669b48311cf498 [file] [log] [blame]
Guido van Rossuma3309961993-07-28 09:05:47 +00001#ifndef Py_DICTOBJECT_H
2#define Py_DICTOBJECT_H
3#ifdef __cplusplus
4extern "C" {
5#endif
6
Guido van Rossumf70e43a1991-02-19 12:39:46 +00007
Guido van Rossum2ec90311997-05-13 21:23:32 +00008/* Dictionary object type -- mapping from hashable object to object */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00009
Raymond Hettinger930427b2003-05-03 06:51:59 +000010/* The distribution includes a separate file, Objects/dictnotes.txt,
Thomas Wouters4d70c3d2006-06-08 14:42:34 +000011 describing explorations into dictionary design and optimization.
Raymond Hettinger930427b2003-05-03 06:51:59 +000012 It covers typical dictionary use patterns, the parameters for
13 tuning dictionaries, and several ideas for possible optimizations.
14*/
15
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000016#ifndef Py_LIMITED_API
Tim Peters6d6c1a32001-08-02 04:15:00 +000017
Benjamin Peterson7d95e402012-04-23 11:24:50 -040018typedef struct _dictkeysobject PyDictKeysObject;
19
20/* The ma_values pointer is NULL for a combined table
21 * or points to an array of PyObject* for a split table
22 */
Tim Peters6d6c1a32001-08-02 04:15:00 +000023typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000024 PyObject_HEAD
Benjamin Peterson7d95e402012-04-23 11:24:50 -040025 Py_ssize_t ma_used;
26 PyDictKeysObject *ma_keys;
27 PyObject **ma_values;
28} PyDictObject;
Tim Peters6d6c1a32001-08-02 04:15:00 +000029
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000030#endif /* Py_LIMITED_API */
Tim Peters6d6c1a32001-08-02 04:15:00 +000031
Mark Hammond91a681d2002-08-12 07:21:58 +000032PyAPI_DATA(PyTypeObject) PyDict_Type;
Christian Heimesa22e8bd2007-11-29 22:35:39 +000033PyAPI_DATA(PyTypeObject) PyDictIterKey_Type;
34PyAPI_DATA(PyTypeObject) PyDictIterValue_Type;
35PyAPI_DATA(PyTypeObject) PyDictIterItem_Type;
36PyAPI_DATA(PyTypeObject) PyDictKeys_Type;
37PyAPI_DATA(PyTypeObject) PyDictItems_Type;
38PyAPI_DATA(PyTypeObject) PyDictValues_Type;
Guido van Rossum2ec90311997-05-13 21:23:32 +000039
Thomas Wouters27d517b2007-02-25 20:39:11 +000040#define PyDict_Check(op) \
Christian Heimes90aa7642007-12-19 02:45:37 +000041 PyType_FastSubclass(Py_TYPE(op), Py_TPFLAGS_DICT_SUBCLASS)
42#define PyDict_CheckExact(op) (Py_TYPE(op) == &PyDict_Type)
43#define PyDictKeys_Check(op) (Py_TYPE(op) == &PyDictKeys_Type)
44#define PyDictItems_Check(op) (Py_TYPE(op) == &PyDictItems_Type)
45#define PyDictValues_Check(op) (Py_TYPE(op) == &PyDictValues_Type)
Christian Heimesa22e8bd2007-11-29 22:35:39 +000046/* This excludes Values, since they are not sets. */
47# define PyDictViewSet_Check(op) \
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000048 (PyDictKeys_Check(op) || PyDictItems_Check(op))
Christian Heimesa22e8bd2007-11-29 22:35:39 +000049
Guido van Rossum2ec90311997-05-13 21:23:32 +000050
Mark Hammond91a681d2002-08-12 07:21:58 +000051PyAPI_FUNC(PyObject *) PyDict_New(void);
52PyAPI_FUNC(PyObject *) PyDict_GetItem(PyObject *mp, PyObject *key);
Alexandre Vassalotticb314332008-06-01 03:53:03 +000053PyAPI_FUNC(PyObject *) PyDict_GetItemWithError(PyObject *mp, PyObject *key);
Brett Cannonfd074152012-04-14 14:10:13 -040054PyAPI_FUNC(PyObject *) _PyDict_GetItemIdWithError(PyObject *dp,
55 struct _Py_Identifier *key);
Benjamin Peterson00e98862013-03-07 22:16:29 -050056PyAPI_FUNC(PyObject *) PyDict_SetDefault(
57 PyObject *mp, PyObject *key, PyObject *defaultobj);
Mark Hammond91a681d2002-08-12 07:21:58 +000058PyAPI_FUNC(int) PyDict_SetItem(PyObject *mp, PyObject *key, PyObject *item);
59PyAPI_FUNC(int) PyDict_DelItem(PyObject *mp, PyObject *key);
60PyAPI_FUNC(void) PyDict_Clear(PyObject *mp);
61PyAPI_FUNC(int) PyDict_Next(
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000062 PyObject *mp, Py_ssize_t *pos, PyObject **key, PyObject **value);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000063#ifndef Py_LIMITED_API
Benjamin Peterson7d95e402012-04-23 11:24:50 -040064PyDictKeysObject *_PyDict_NewKeysForClass(void);
65PyAPI_FUNC(PyObject *) PyObject_GenericGetDict(PyObject *, void *);
Thomas Wouterscf297e42007-02-23 15:07:44 +000066PyAPI_FUNC(int) _PyDict_Next(
Benjamin Peterson8f67d082010-10-17 20:54:53 +000067 PyObject *mp, Py_ssize_t *pos, PyObject **key, PyObject **value, Py_hash_t *hash);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000068#endif
Mark Hammond91a681d2002-08-12 07:21:58 +000069PyAPI_FUNC(PyObject *) PyDict_Keys(PyObject *mp);
70PyAPI_FUNC(PyObject *) PyDict_Values(PyObject *mp);
71PyAPI_FUNC(PyObject *) PyDict_Items(PyObject *mp);
Martin v. Löwis18e16552006-02-15 17:27:45 +000072PyAPI_FUNC(Py_ssize_t) PyDict_Size(PyObject *mp);
Mark Hammond91a681d2002-08-12 07:21:58 +000073PyAPI_FUNC(PyObject *) PyDict_Copy(PyObject *mp);
Raymond Hettingerbc0f2ab2003-11-25 21:12:14 +000074PyAPI_FUNC(int) PyDict_Contains(PyObject *mp, PyObject *key);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000075#ifndef Py_LIMITED_API
Benjamin Peterson8f67d082010-10-17 20:54:53 +000076PyAPI_FUNC(int) _PyDict_Contains(PyObject *mp, PyObject *key, Py_hash_t hash);
Christian Heimes99170a52007-12-19 02:07:34 +000077PyAPI_FUNC(PyObject *) _PyDict_NewPresized(Py_ssize_t minused);
Antoine Pitrou3a652b12009-03-23 18:52:06 +000078PyAPI_FUNC(void) _PyDict_MaybeUntrack(PyObject *mp);
Benjamin Petersonfb886362010-04-24 18:21:17 +000079PyAPI_FUNC(int) _PyDict_HasOnlyStringKeys(PyObject *mp);
Martin v. Loewis4f2f3b62012-04-24 19:13:57 +020080Py_ssize_t _PyDict_KeysSize(PyDictKeysObject *keys);
Benjamin Peterson7d95e402012-04-23 11:24:50 -040081#define _PyDict_HasSplitTable(d) ((d)->ma_values != NULL)
Antoine Pitrou9a812cb2011-11-15 00:00:12 +010082
83PyAPI_FUNC(int) PyDict_ClearFreeList(void);
Martin v. Löwis4d0d4712010-12-03 20:14:31 +000084#endif
Jeremy Hyltona12c7a72000-03-30 22:27:31 +000085
Tim Petersf582b822001-12-11 18:51:08 +000086/* PyDict_Update(mp, other) is equivalent to PyDict_Merge(mp, other, 1). */
Mark Hammond91a681d2002-08-12 07:21:58 +000087PyAPI_FUNC(int) PyDict_Update(PyObject *mp, PyObject *other);
Tim Petersf582b822001-12-11 18:51:08 +000088
89/* PyDict_Merge updates/merges from a mapping object (an object that
90 supports PyMapping_Keys() and PyObject_GetItem()). If override is true,
91 the last occurrence of a key wins, else the first. The Python
92 dict.update(other) is equivalent to PyDict_Merge(dict, other, 1).
93*/
Mark Hammond91a681d2002-08-12 07:21:58 +000094PyAPI_FUNC(int) PyDict_Merge(PyObject *mp,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000095 PyObject *other,
96 int override);
Tim Petersf582b822001-12-11 18:51:08 +000097
98/* PyDict_MergeFromSeq2 updates/merges from an iterable object producing
99 iterable objects of length 2. If override is true, the last occurrence
100 of a key wins, else the first. The Python dict constructor dict(seq2)
101 is equivalent to dict={}; PyDict_MergeFromSeq(dict, seq2, 1).
102*/
Mark Hammond91a681d2002-08-12 07:21:58 +0000103PyAPI_FUNC(int) PyDict_MergeFromSeq2(PyObject *d,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000104 PyObject *seq2,
105 int override);
Guido van Rossum2ec90311997-05-13 21:23:32 +0000106
Martin v. Löwis32b4a1b2002-12-11 13:21:12 +0000107PyAPI_FUNC(PyObject *) PyDict_GetItemString(PyObject *dp, const char *key);
Victor Stinner3c1e4812012-03-26 22:10:51 +0200108PyAPI_FUNC(PyObject *) _PyDict_GetItemId(PyObject *dp, struct _Py_Identifier *key);
Martin v. Löwis32b4a1b2002-12-11 13:21:12 +0000109PyAPI_FUNC(int) PyDict_SetItemString(PyObject *dp, const char *key, PyObject *item);
Victor Stinner3c1e4812012-03-26 22:10:51 +0200110PyAPI_FUNC(int) _PyDict_SetItemId(PyObject *dp, struct _Py_Identifier *key, PyObject *item);
Martin v. Löwis32b4a1b2002-12-11 13:21:12 +0000111PyAPI_FUNC(int) PyDict_DelItemString(PyObject *dp, const char *key);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000112
Benjamin Peterson7d95e402012-04-23 11:24:50 -0400113#ifndef Py_LIMITED_API
114int _PyObjectDict_SetItem(PyTypeObject *tp, PyObject **dictptr, PyObject *name, PyObject *value);
115PyObject *_PyDict_LoadGlobal(PyDictObject *, PyDictObject *, PyObject *);
David Malcolm49526f42012-06-22 14:55:41 -0400116PyAPI_FUNC(void) _PyDict_DebugMallocStats(FILE *out);
Benjamin Peterson7d95e402012-04-23 11:24:50 -0400117#endif
118
Guido van Rossuma3309961993-07-28 09:05:47 +0000119#ifdef __cplusplus
120}
121#endif
122#endif /* !Py_DICTOBJECT_H */