blob: 4fafb8a963b03c4346e15f416d6ebb779d52f862 [file] [log] [blame]
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001/***********************************************************
Guido van Rossumfd71b9e2000-06-30 23:50:40 +00002Copyright (c) 2000, BeOpen.com.
3Copyright (c) 1995-2000, Corporation for National Research Initiatives.
4Copyright (c) 1990-1995, Stichting Mathematisch Centrum.
5All rights reserved.
Guido van Rossum4b1302b1993-03-27 18:11:32 +00006
Guido van Rossumfd71b9e2000-06-30 23:50:40 +00007See the file "Misc/COPYRIGHT" for information on usage and
8redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
Guido van Rossum4b1302b1993-03-27 18:11:32 +00009******************************************************************/
10
Guido van Rossum2bc13791999-03-24 19:06:42 +000011/* Dictionary object implementation using a hash table */
Guido van Rossum9bfef441993-03-29 10:43:31 +000012
Guido van Rossumc0b618a1997-05-02 03:12:38 +000013#include "Python.h"
Guido van Rossum4b1302b1993-03-27 18:11:32 +000014
15
16/*
Guido van Rossuma9e7a811997-05-13 21:02:11 +000017 * MINSIZE is the minimum size of a dictionary.
Guido van Rossum16e93a81997-01-28 00:00:11 +000018 */
19
20#define MINSIZE 4
21
22/*
23Table of irreducible polynomials to efficiently cycle through
24GF(2^n)-{0}, 2<=n<=30.
Guido van Rossum4b1302b1993-03-27 18:11:32 +000025*/
Guido van Rossum16e93a81997-01-28 00:00:11 +000026static long polys[] = {
Guido van Rossum9e5656c1997-01-29 04:45:16 +000027 4 + 3,
28 8 + 3,
29 16 + 3,
30 32 + 5,
31 64 + 3,
32 128 + 3,
33 256 + 29,
34 512 + 17,
35 1024 + 9,
36 2048 + 5,
37 4096 + 83,
38 8192 + 27,
39 16384 + 43,
40 32768 + 3,
41 65536 + 45,
42 131072 + 9,
43 262144 + 39,
44 524288 + 39,
45 1048576 + 9,
46 2097152 + 5,
47 4194304 + 3,
48 8388608 + 33,
49 16777216 + 27,
50 33554432 + 9,
51 67108864 + 71,
52 134217728 + 39,
53 268435456 + 9,
54 536870912 + 5,
55 1073741824 + 83,
56 0
Guido van Rossum4b1302b1993-03-27 18:11:32 +000057};
58
59/* Object used as dummy key to fill deleted entries */
Guido van Rossuma9e7a811997-05-13 21:02:11 +000060static PyObject *dummy; /* Initialized by first call to newdictobject() */
Guido van Rossum4b1302b1993-03-27 18:11:32 +000061
62/*
Guido van Rossum2bc13791999-03-24 19:06:42 +000063Invariant for entries: when in use, me_value is not NULL and me_key is
64not NULL and not dummy; when not in use, me_value is NULL and me_key
Guido van Rossum4b1302b1993-03-27 18:11:32 +000065is either NULL or dummy. A dummy key value cannot be replaced by
66NULL, since otherwise other keys may be lost.
67*/
68typedef struct {
69 long me_hash;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000070 PyObject *me_key;
71 PyObject *me_value;
Guido van Rossum36488841997-04-11 19:14:07 +000072#ifdef USE_CACHE_ALIGNED
73 long aligner;
74#endif
Guido van Rossuma9e7a811997-05-13 21:02:11 +000075} dictentry;
Guido van Rossum4b1302b1993-03-27 18:11:32 +000076
77/*
78To ensure the lookup algorithm terminates, the table size must be a
79prime number and there must be at least one NULL key in the table.
80The value ma_fill is the number of non-NULL keys; ma_used is the number
81of non-NULL, non-dummy keys.
82To avoid slowing down lookups on a near-full table, we resize the table
83when it is more than half filled.
84*/
85typedef struct {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000086 PyObject_HEAD
Guido van Rossum4b1302b1993-03-27 18:11:32 +000087 int ma_fill;
88 int ma_used;
89 int ma_size;
Guido van Rossum16e93a81997-01-28 00:00:11 +000090 int ma_poly;
Guido van Rossuma9e7a811997-05-13 21:02:11 +000091 dictentry *ma_table;
92} dictobject;
Guido van Rossum4b1302b1993-03-27 18:11:32 +000093
Guido van Rossumc0b618a1997-05-02 03:12:38 +000094PyObject *
Thomas Wouters78890102000-07-22 19:25:51 +000095PyDict_New(void)
Guido van Rossum4b1302b1993-03-27 18:11:32 +000096{
Guido van Rossuma9e7a811997-05-13 21:02:11 +000097 register dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +000098 if (dummy == NULL) { /* Auto-initialize dummy */
Guido van Rossumc0b618a1997-05-02 03:12:38 +000099 dummy = PyString_FromString("<dummy key>");
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000100 if (dummy == NULL)
101 return NULL;
102 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000103 mp = PyObject_NEW(dictobject, &PyDict_Type);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000104 if (mp == NULL)
105 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000106 mp->ma_size = 0;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000107 mp->ma_poly = 0;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000108 mp->ma_table = NULL;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000109 mp->ma_fill = 0;
110 mp->ma_used = 0;
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +0000111 PyObject_GC_Init(mp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000112 return (PyObject *)mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000113}
114
115/*
116The basic lookup function used by all operations.
Guido van Rossum16e93a81997-01-28 00:00:11 +0000117This is based on Algorithm D from Knuth Vol. 3, Sec. 6.4.
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000118Open addressing is preferred over chaining since the link overhead for
119chaining would be substantial (100% with typical malloc overhead).
Guido van Rossum16e93a81997-01-28 00:00:11 +0000120However, instead of going through the table at constant steps, we cycle
121through the values of GF(2^n)-{0}. This avoids modulo computations, being
122much cheaper on RISC machines, without leading to clustering.
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000123
Guido van Rossum2bc13791999-03-24 19:06:42 +0000124The initial probe index is computed as hash mod the table size.
Guido van Rossum16e93a81997-01-28 00:00:11 +0000125Subsequent probe indices use the values of x^i in GF(2^n) as an offset,
Guido van Rossum2bc13791999-03-24 19:06:42 +0000126where x is a root. The initial value is derived from hash, too.
127
128All arithmetic on hash should ignore overflow.
Guido van Rossum16e93a81997-01-28 00:00:11 +0000129
130(This version is due to Reimer Behrends, some ideas are also due to
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000131Jyrki Alakuijala and Vladimir Marangozov.)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000132*/
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000133static dictentry *
Tim Peters1f5871e2000-07-04 17:44:48 +0000134lookdict(dictobject *mp, PyObject *key, register long hash)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000135{
Guido van Rossum16e93a81997-01-28 00:00:11 +0000136 register int i;
137 register unsigned incr;
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000138 register dictentry *freeslot;
Guido van Rossum2095d241997-04-09 19:41:24 +0000139 register unsigned int mask = mp->ma_size-1;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000140 dictentry *ep0 = mp->ma_table;
141 register dictentry *ep;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000142 /* We must come up with (i, incr) such that 0 <= i < ma_size
143 and 0 < incr < ma_size and both are a function of hash */
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000144 i = (~hash) & mask;
145 /* We use ~hash instead of hash, as degenerate hash functions, such
Guido van Rossum16e93a81997-01-28 00:00:11 +0000146 as for ints <sigh>, can have lots of leading zeros. It's not
147 really a performance risk, but better safe than sorry. */
Guido van Rossumefb46091997-01-29 15:53:56 +0000148 ep = &ep0[i];
Guido van Rossumc1c7b1a1998-10-06 16:01:14 +0000149 if (ep->me_key == NULL || ep->me_key == key)
Guido van Rossum7d181591997-01-16 21:06:45 +0000150 return ep;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000151 if (ep->me_key == dummy)
Guido van Rossum7d181591997-01-16 21:06:45 +0000152 freeslot = ep;
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000153 else {
Guido van Rossumc1c7b1a1998-10-06 16:01:14 +0000154 if (ep->me_hash == hash &&
155 PyObject_Compare(ep->me_key, key) == 0)
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000156 {
157 return ep;
158 }
159 freeslot = NULL;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000160 }
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000161 /* XXX What if PyObject_Compare returned an exception? */
Guido van Rossum2bc13791999-03-24 19:06:42 +0000162 /* Derive incr from hash, just to make it more arbitrary. Note that
Guido van Rossum16e93a81997-01-28 00:00:11 +0000163 incr must not be 0, or we will get into an infinite loop.*/
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000164 incr = (hash ^ ((unsigned long)hash >> 3)) & mask;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000165 if (!incr)
166 incr = mask;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000167 for (;;) {
Guido van Rossumefb46091997-01-29 15:53:56 +0000168 ep = &ep0[(i+incr)&mask];
Guido van Rossum16e93a81997-01-28 00:00:11 +0000169 if (ep->me_key == NULL) {
170 if (freeslot != NULL)
171 return freeslot;
172 else
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000173 return ep;
174 }
Guido van Rossum16e93a81997-01-28 00:00:11 +0000175 if (ep->me_key == dummy) {
176 if (freeslot == NULL)
177 freeslot = ep;
178 }
179 else if (ep->me_key == key ||
180 (ep->me_hash == hash &&
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000181 PyObject_Compare(ep->me_key, key) == 0)) {
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000182 return ep;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000183 }
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000184 /* XXX What if PyObject_Compare returned an exception? */
Guido van Rossum16e93a81997-01-28 00:00:11 +0000185 /* Cycle through GF(2^n)-{0} */
186 incr = incr << 1;
187 if (incr > mask)
Thomas Wouters7e474022000-07-16 12:04:32 +0000188 incr ^= mp->ma_poly; /* This will implicitly clear
Guido van Rossumf05fc711998-11-16 22:46:30 +0000189 the highest bit */
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000190 }
191}
192
193/*
194Internal routine to insert a new item into the table.
195Used both by the internal resize routine and by the public insert routine.
196Eats a reference to key and one to value.
197*/
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000198static void
Tim Peters1f5871e2000-07-04 17:44:48 +0000199insertdict(register dictobject *mp, PyObject *key, long hash, PyObject *value)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000200{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000201 PyObject *old_value;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000202 register dictentry *ep;
203 ep = lookdict(mp, key, hash);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000204 if (ep->me_value != NULL) {
Guido van Rossumd7047b31995-01-02 19:07:15 +0000205 old_value = ep->me_value;
206 ep->me_value = value;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000207 Py_DECREF(old_value); /* which **CAN** re-enter */
208 Py_DECREF(key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000209 }
210 else {
211 if (ep->me_key == NULL)
212 mp->ma_fill++;
213 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000214 Py_DECREF(ep->me_key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000215 ep->me_key = key;
216 ep->me_hash = hash;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000217 ep->me_value = value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000218 mp->ma_used++;
219 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000220}
221
222/*
223Restructure the table by allocating a new table and reinserting all
224items again. When entries have been deleted, the new table may
225actually be smaller than the old one.
226*/
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000227static int
Tim Peters1f5871e2000-07-04 17:44:48 +0000228dictresize(dictobject *mp, int minused)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000229{
230 register int oldsize = mp->ma_size;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000231 register int newsize, newpoly;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000232 register dictentry *oldtable = mp->ma_table;
233 register dictentry *newtable;
234 register dictentry *ep;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000235 register int i;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000236 for (i = 0, newsize = MINSIZE; ; i++, newsize <<= 1) {
237 if (i > sizeof(polys)/sizeof(polys[0])) {
238 /* Ran out of polynomials */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000239 PyErr_NoMemory();
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000240 return -1;
241 }
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000242 if (newsize > minused) {
Guido van Rossum16e93a81997-01-28 00:00:11 +0000243 newpoly = polys[i];
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000244 break;
245 }
246 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000247 newtable = PyMem_NEW(dictentry, newsize);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000248 if (newtable == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000249 PyErr_NoMemory();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000250 return -1;
251 }
Guido van Rossum0fd00331998-07-16 15:06:13 +0000252 memset(newtable, '\0', sizeof(dictentry) * newsize);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000253 mp->ma_size = newsize;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000254 mp->ma_poly = newpoly;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000255 mp->ma_table = newtable;
256 mp->ma_fill = 0;
257 mp->ma_used = 0;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000258
259 /* Make two passes, so we can avoid decrefs
260 (and possible side effects) till the table is copied */
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000261 for (i = 0, ep = oldtable; i < oldsize; i++, ep++) {
262 if (ep->me_value != NULL)
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000263 insertdict(mp,ep->me_key,ep->me_hash,ep->me_value);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000264 }
Guido van Rossumd7047b31995-01-02 19:07:15 +0000265 for (i = 0, ep = oldtable; i < oldsize; i++, ep++) {
Guido van Rossum255443b1998-04-10 22:47:14 +0000266 if (ep->me_value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000267 Py_XDECREF(ep->me_key);
Guido van Rossum255443b1998-04-10 22:47:14 +0000268 }
Guido van Rossumd7047b31995-01-02 19:07:15 +0000269 }
270
Guido van Rossumb18618d2000-05-03 23:44:39 +0000271 if (oldtable != NULL)
272 PyMem_DEL(oldtable);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000273 return 0;
274}
275
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000276PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000277PyDict_GetItem(PyObject *op, PyObject *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000278{
279 long hash;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000280 if (!PyDict_Check(op)) {
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000281 return NULL;
282 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000283 if (((dictobject *)op)->ma_table == NULL)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000284 return NULL;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000285#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000286 if (!PyString_Check(key) ||
287 (hash = ((PyStringObject *) key)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000288#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000289 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000290 hash = PyObject_Hash(key);
Guido van Rossum474b19e1998-05-14 01:00:51 +0000291 if (hash == -1) {
292 PyErr_Clear();
Guido van Rossumca756f21997-01-23 19:39:29 +0000293 return NULL;
Guido van Rossum474b19e1998-05-14 01:00:51 +0000294 }
Guido van Rossumca756f21997-01-23 19:39:29 +0000295 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000296 return lookdict((dictobject *)op, key, hash) -> me_value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000297}
298
299int
Tim Peters1f5871e2000-07-04 17:44:48 +0000300PyDict_SetItem(register PyObject *op, PyObject *key, PyObject *value)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000301{
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000302 register dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000303 register long hash;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000304 if (!PyDict_Check(op)) {
305 PyErr_BadInternalCall();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000306 return -1;
307 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000308 mp = (dictobject *)op;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000309#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000310 if (PyString_Check(key)) {
Guido van Rossum2a61e741997-01-18 07:55:05 +0000311#ifdef INTERN_STRINGS
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000312 if (((PyStringObject *)key)->ob_sinterned != NULL) {
313 key = ((PyStringObject *)key)->ob_sinterned;
314 hash = ((PyStringObject *)key)->ob_shash;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000315 }
316 else
317#endif
318 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000319 hash = ((PyStringObject *)key)->ob_shash;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000320 if (hash == -1)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000321 hash = PyObject_Hash(key);
Guido van Rossum2a61e741997-01-18 07:55:05 +0000322 }
323 }
324 else
325#endif
326 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000327 hash = PyObject_Hash(key);
Guido van Rossum2a61e741997-01-18 07:55:05 +0000328 if (hash == -1)
329 return -1;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000330 }
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000331 /* if fill >= 2/3 size, double in size */
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000332 if (mp->ma_fill*3 >= mp->ma_size*2) {
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000333 if (dictresize(mp, mp->ma_used*2) != 0) {
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000334 if (mp->ma_fill+1 > mp->ma_size)
335 return -1;
336 }
337 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000338 Py_INCREF(value);
339 Py_INCREF(key);
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000340 insertdict(mp, key, hash, value);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000341 return 0;
342}
343
344int
Tim Peters1f5871e2000-07-04 17:44:48 +0000345PyDict_DelItem(PyObject *op, PyObject *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000346{
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000347 register dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000348 register long hash;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000349 register dictentry *ep;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000350 PyObject *old_value, *old_key;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000351
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000352 if (!PyDict_Check(op)) {
353 PyErr_BadInternalCall();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000354 return -1;
355 }
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000356#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000357 if (!PyString_Check(key) ||
358 (hash = ((PyStringObject *) key)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000359#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000360 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000361 hash = PyObject_Hash(key);
Guido van Rossumca756f21997-01-23 19:39:29 +0000362 if (hash == -1)
363 return -1;
364 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000365 mp = (dictobject *)op;
366 if (((dictobject *)op)->ma_table == NULL)
Guido van Rossumefc87131995-01-02 19:42:39 +0000367 goto empty;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000368 ep = lookdict(mp, key, hash);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000369 if (ep->me_value == NULL) {
Guido van Rossumefc87131995-01-02 19:42:39 +0000370 empty:
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000371 PyErr_SetObject(PyExc_KeyError, key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000372 return -1;
373 }
Guido van Rossumd7047b31995-01-02 19:07:15 +0000374 old_key = ep->me_key;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000375 Py_INCREF(dummy);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000376 ep->me_key = dummy;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000377 old_value = ep->me_value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000378 ep->me_value = NULL;
379 mp->ma_used--;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000380 Py_DECREF(old_value);
381 Py_DECREF(old_key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000382 return 0;
383}
384
Guido van Rossum25831651993-05-19 14:50:45 +0000385void
Tim Peters1f5871e2000-07-04 17:44:48 +0000386PyDict_Clear(PyObject *op)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000387{
Guido van Rossumd7047b31995-01-02 19:07:15 +0000388 int i, n;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000389 register dictentry *table;
390 dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000391 if (!PyDict_Check(op))
Guido van Rossum25831651993-05-19 14:50:45 +0000392 return;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000393 mp = (dictobject *)op;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000394 table = mp->ma_table;
395 if (table == NULL)
396 return;
397 n = mp->ma_size;
398 mp->ma_size = mp->ma_used = mp->ma_fill = 0;
399 mp->ma_table = NULL;
400 for (i = 0; i < n; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000401 Py_XDECREF(table[i].me_key);
402 Py_XDECREF(table[i].me_value);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000403 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000404 PyMem_DEL(table);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000405}
406
Guido van Rossum25831651993-05-19 14:50:45 +0000407int
Tim Peters1f5871e2000-07-04 17:44:48 +0000408PyDict_Next(PyObject *op, int *ppos, PyObject **pkey, PyObject **pvalue)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000409{
Guido van Rossum25831651993-05-19 14:50:45 +0000410 int i;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000411 register dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000412 if (!PyDict_Check(op))
Guido van Rossum25831651993-05-19 14:50:45 +0000413 return 0;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000414 mp = (dictobject *)op;
Guido van Rossum25831651993-05-19 14:50:45 +0000415 i = *ppos;
416 if (i < 0)
417 return 0;
418 while (i < mp->ma_size && mp->ma_table[i].me_value == NULL)
419 i++;
420 *ppos = i+1;
421 if (i >= mp->ma_size)
422 return 0;
423 if (pkey)
424 *pkey = mp->ma_table[i].me_key;
425 if (pvalue)
426 *pvalue = mp->ma_table[i].me_value;
427 return 1;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000428}
429
430/* Methods */
431
432static void
Tim Peters1f5871e2000-07-04 17:44:48 +0000433dict_dealloc(register dictobject *mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000434{
435 register int i;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000436 register dictentry *ep;
Guido van Rossumd724b232000-03-13 16:01:29 +0000437 Py_TRASHCAN_SAFE_BEGIN(mp)
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +0000438 PyObject_GC_Fini(mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000439 for (i = 0, ep = mp->ma_table; i < mp->ma_size; i++, ep++) {
Guido van Rossum255443b1998-04-10 22:47:14 +0000440 if (ep->me_key != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000441 Py_DECREF(ep->me_key);
Guido van Rossum255443b1998-04-10 22:47:14 +0000442 }
443 if (ep->me_value != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000444 Py_DECREF(ep->me_value);
Guido van Rossum255443b1998-04-10 22:47:14 +0000445 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000446 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000447 if (mp->ma_table != NULL)
448 PyMem_DEL(mp->ma_table);
Guido van Rossum4cc6ac72000-07-01 01:00:38 +0000449 mp = (dictobject *) PyObject_AS_GC(mp);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000450 PyObject_DEL(mp);
Guido van Rossumd724b232000-03-13 16:01:29 +0000451 Py_TRASHCAN_SAFE_END(mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000452}
453
454static int
Tim Peters1f5871e2000-07-04 17:44:48 +0000455dict_print(register dictobject *mp, register FILE *fp, register int flags)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000456{
457 register int i;
458 register int any;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000459 register dictentry *ep;
Guido van Rossum255443b1998-04-10 22:47:14 +0000460
461 i = Py_ReprEnter((PyObject*)mp);
462 if (i != 0) {
463 if (i < 0)
464 return i;
465 fprintf(fp, "{...}");
466 return 0;
467 }
468
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000469 fprintf(fp, "{");
470 any = 0;
471 for (i = 0, ep = mp->ma_table; i < mp->ma_size; i++, ep++) {
472 if (ep->me_value != NULL) {
473 if (any++ > 0)
474 fprintf(fp, ", ");
Guido van Rossum255443b1998-04-10 22:47:14 +0000475 if (PyObject_Print((PyObject *)ep->me_key, fp, 0)!=0) {
476 Py_ReprLeave((PyObject*)mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000477 return -1;
Guido van Rossum255443b1998-04-10 22:47:14 +0000478 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000479 fprintf(fp, ": ");
Guido van Rossum255443b1998-04-10 22:47:14 +0000480 if (PyObject_Print(ep->me_value, fp, 0) != 0) {
481 Py_ReprLeave((PyObject*)mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000482 return -1;
Guido van Rossum255443b1998-04-10 22:47:14 +0000483 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000484 }
485 }
486 fprintf(fp, "}");
Guido van Rossum255443b1998-04-10 22:47:14 +0000487 Py_ReprLeave((PyObject*)mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000488 return 0;
489}
490
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000491static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000492dict_repr(dictobject *mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000493{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000494 auto PyObject *v;
495 PyObject *sepa, *colon;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000496 register int i;
497 register int any;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000498 register dictentry *ep;
Guido van Rossum255443b1998-04-10 22:47:14 +0000499
500 i = Py_ReprEnter((PyObject*)mp);
501 if (i != 0) {
502 if (i > 0)
503 return PyString_FromString("{...}");
504 return NULL;
505 }
506
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000507 v = PyString_FromString("{");
508 sepa = PyString_FromString(", ");
509 colon = PyString_FromString(": ");
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000510 any = 0;
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000511 for (i = 0, ep = mp->ma_table; i < mp->ma_size && v; i++, ep++) {
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000512 if (ep->me_value != NULL) {
513 if (any++)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000514 PyString_Concat(&v, sepa);
515 PyString_ConcatAndDel(&v, PyObject_Repr(ep->me_key));
516 PyString_Concat(&v, colon);
517 PyString_ConcatAndDel(&v, PyObject_Repr(ep->me_value));
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000518 }
519 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000520 PyString_ConcatAndDel(&v, PyString_FromString("}"));
Guido van Rossum255443b1998-04-10 22:47:14 +0000521 Py_ReprLeave((PyObject*)mp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000522 Py_XDECREF(sepa);
523 Py_XDECREF(colon);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000524 return v;
525}
526
527static int
Tim Peters1f5871e2000-07-04 17:44:48 +0000528dict_length(dictobject *mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000529{
530 return mp->ma_used;
531}
532
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000533static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000534dict_subscript(dictobject *mp, register PyObject *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000535{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000536 PyObject *v;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000537 long hash;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000538 if (mp->ma_table == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000539 PyErr_SetObject(PyExc_KeyError, key);
Guido van Rossumd7047b31995-01-02 19:07:15 +0000540 return NULL;
541 }
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000542#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000543 if (!PyString_Check(key) ||
544 (hash = ((PyStringObject *) key)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000545#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000546 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000547 hash = PyObject_Hash(key);
Guido van Rossumca756f21997-01-23 19:39:29 +0000548 if (hash == -1)
549 return NULL;
550 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000551 v = lookdict(mp, key, hash) -> me_value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000552 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000553 PyErr_SetObject(PyExc_KeyError, key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000554 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000555 Py_INCREF(v);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000556 return v;
557}
558
559static int
Tim Peters1f5871e2000-07-04 17:44:48 +0000560dict_ass_sub(dictobject *mp, PyObject *v, PyObject *w)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000561{
562 if (w == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000563 return PyDict_DelItem((PyObject *)mp, v);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000564 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000565 return PyDict_SetItem((PyObject *)mp, v, w);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000566}
567
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000568static PyMappingMethods dict_as_mapping = {
569 (inquiry)dict_length, /*mp_length*/
570 (binaryfunc)dict_subscript, /*mp_subscript*/
571 (objobjargproc)dict_ass_sub, /*mp_ass_subscript*/
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000572};
573
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000574static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000575dict_keys(register dictobject *mp, PyObject *args)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000576{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000577 register PyObject *v;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000578 register int i, j;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000579 if (!PyArg_NoArgs(args))
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000580 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000581 v = PyList_New(mp->ma_used);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000582 if (v == NULL)
583 return NULL;
584 for (i = 0, j = 0; i < mp->ma_size; i++) {
585 if (mp->ma_table[i].me_value != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000586 PyObject *key = mp->ma_table[i].me_key;
587 Py_INCREF(key);
588 PyList_SetItem(v, j, key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000589 j++;
590 }
591 }
592 return v;
593}
594
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000595static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000596dict_values(register dictobject *mp, PyObject *args)
Guido van Rossum25831651993-05-19 14:50:45 +0000597{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000598 register PyObject *v;
Guido van Rossum25831651993-05-19 14:50:45 +0000599 register int i, j;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000600 if (!PyArg_NoArgs(args))
Guido van Rossum25831651993-05-19 14:50:45 +0000601 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000602 v = PyList_New(mp->ma_used);
Guido van Rossum25831651993-05-19 14:50:45 +0000603 if (v == NULL)
604 return NULL;
605 for (i = 0, j = 0; i < mp->ma_size; i++) {
606 if (mp->ma_table[i].me_value != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000607 PyObject *value = mp->ma_table[i].me_value;
608 Py_INCREF(value);
609 PyList_SetItem(v, j, value);
Guido van Rossum25831651993-05-19 14:50:45 +0000610 j++;
611 }
612 }
613 return v;
614}
615
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000616static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000617dict_items(register dictobject *mp, PyObject *args)
Guido van Rossum25831651993-05-19 14:50:45 +0000618{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000619 register PyObject *v;
Guido van Rossum25831651993-05-19 14:50:45 +0000620 register int i, j;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000621 if (!PyArg_NoArgs(args))
Guido van Rossum25831651993-05-19 14:50:45 +0000622 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000623 v = PyList_New(mp->ma_used);
Guido van Rossum25831651993-05-19 14:50:45 +0000624 if (v == NULL)
625 return NULL;
626 for (i = 0, j = 0; i < mp->ma_size; i++) {
627 if (mp->ma_table[i].me_value != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000628 PyObject *key = mp->ma_table[i].me_key;
629 PyObject *value = mp->ma_table[i].me_value;
630 PyObject *item = PyTuple_New(2);
Guido van Rossum25831651993-05-19 14:50:45 +0000631 if (item == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000632 Py_DECREF(v);
Guido van Rossum25831651993-05-19 14:50:45 +0000633 return NULL;
634 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000635 Py_INCREF(key);
636 PyTuple_SetItem(item, 0, key);
637 Py_INCREF(value);
638 PyTuple_SetItem(item, 1, value);
639 PyList_SetItem(v, j, item);
Guido van Rossum25831651993-05-19 14:50:45 +0000640 j++;
641 }
642 }
643 return v;
644}
645
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000646static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000647dict_update(register dictobject *mp, PyObject *args)
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000648{
649 register int i;
650 dictobject *other;
651 dictentry *entry;
652 if (!PyArg_Parse(args, "O!", &PyDict_Type, &other))
653 return NULL;
654 if (other == mp)
Guido van Rossuma8d51311997-06-02 17:13:37 +0000655 goto done; /* a.update(a); nothing to do */
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000656 /* Do one big resize at the start, rather than incrementally
657 resizing as we insert new items. Expect that there will be
658 no (or few) overlapping keys. */
659 if ((mp->ma_fill + other->ma_used)*3 >= mp->ma_size*2) {
660 if (dictresize(mp, (mp->ma_used + other->ma_used)*3/2) != 0)
661 return NULL;
662 }
663 for (i = 0; i < other->ma_size; i++) {
664 entry = &other->ma_table[i];
665 if (entry->me_value != NULL) {
666 Py_INCREF(entry->me_key);
667 Py_INCREF(entry->me_value);
668 insertdict(mp, entry->me_key, entry->me_hash,
669 entry->me_value);
670 }
671 }
672 done:
673 Py_INCREF(Py_None);
674 return Py_None;
675}
676
677static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000678dict_copy(register dictobject *mp, PyObject *args)
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000679{
Jeremy Hyltona12c7a72000-03-30 22:27:31 +0000680 if (!PyArg_Parse(args, ""))
681 return NULL;
682 return PyDict_Copy((PyObject*)mp);
683}
684
685PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000686PyDict_Copy(PyObject *o)
Jeremy Hyltona12c7a72000-03-30 22:27:31 +0000687{
688 register dictobject *mp;
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000689 register int i;
690 dictobject *copy;
691 dictentry *entry;
Jeremy Hyltona12c7a72000-03-30 22:27:31 +0000692
693 if (o == NULL || !PyDict_Check(o)) {
694 PyErr_BadInternalCall();
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000695 return NULL;
Jeremy Hyltona12c7a72000-03-30 22:27:31 +0000696 }
697 mp = (dictobject *)o;
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000698 copy = (dictobject *)PyDict_New();
699 if (copy == NULL)
700 return NULL;
701 if (mp->ma_used > 0) {
702 if (dictresize(copy, mp->ma_used*3/2) != 0)
703 return NULL;
704 for (i = 0; i < mp->ma_size; i++) {
705 entry = &mp->ma_table[i];
706 if (entry->me_value != NULL) {
707 Py_INCREF(entry->me_key);
708 Py_INCREF(entry->me_value);
709 insertdict(copy, entry->me_key, entry->me_hash,
710 entry->me_value);
711 }
712 }
713 }
714 return (PyObject *)copy;
715}
716
Guido van Rossum4199fac1993-11-05 10:18:44 +0000717int
Tim Peters1f5871e2000-07-04 17:44:48 +0000718PyDict_Size(PyObject *mp)
Guido van Rossum4199fac1993-11-05 10:18:44 +0000719{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000720 if (mp == NULL || !PyDict_Check(mp)) {
721 PyErr_BadInternalCall();
Guido van Rossumb376a4a1993-11-23 17:53:17 +0000722 return 0;
Guido van Rossum4199fac1993-11-05 10:18:44 +0000723 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000724 return ((dictobject *)mp)->ma_used;
Guido van Rossum4199fac1993-11-05 10:18:44 +0000725}
726
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000727PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000728PyDict_Keys(PyObject *mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000729{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000730 if (mp == NULL || !PyDict_Check(mp)) {
731 PyErr_BadInternalCall();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000732 return NULL;
733 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000734 return dict_keys((dictobject *)mp, (PyObject *)NULL);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000735}
736
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000737PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000738PyDict_Values(PyObject *mp)
Guido van Rossum25831651993-05-19 14:50:45 +0000739{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000740 if (mp == NULL || !PyDict_Check(mp)) {
741 PyErr_BadInternalCall();
Guido van Rossum25831651993-05-19 14:50:45 +0000742 return NULL;
743 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000744 return dict_values((dictobject *)mp, (PyObject *)NULL);
Guido van Rossum25831651993-05-19 14:50:45 +0000745}
746
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000747PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000748PyDict_Items(PyObject *mp)
Guido van Rossum25831651993-05-19 14:50:45 +0000749{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000750 if (mp == NULL || !PyDict_Check(mp)) {
751 PyErr_BadInternalCall();
Guido van Rossum25831651993-05-19 14:50:45 +0000752 return NULL;
753 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000754 return dict_items((dictobject *)mp, (PyObject *)NULL);
Guido van Rossum25831651993-05-19 14:50:45 +0000755}
756
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000757#define NEWCMP
758
759#ifdef NEWCMP
760
761/* Subroutine which returns the smallest key in a for which b's value
762 is different or absent. The value is returned too, through the
763 pval argument. No reference counts are incremented. */
764
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000765static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000766characterize(dictobject *a, dictobject *b, PyObject **pval)
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000767{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000768 PyObject *diff = NULL;
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000769 int i;
770
771 *pval = NULL;
772 for (i = 0; i < a->ma_size; i++) {
773 if (a->ma_table[i].me_value != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000774 PyObject *key = a->ma_table[i].me_key;
775 PyObject *aval, *bval;
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000776 /* XXX What if PyObject_Compare raises an exception? */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000777 if (diff != NULL && PyObject_Compare(key, diff) > 0)
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000778 continue;
779 aval = a->ma_table[i].me_value;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000780 bval = PyDict_GetItem((PyObject *)b, key);
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000781 /* XXX What if PyObject_Compare raises an exception? */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000782 if (bval == NULL || PyObject_Compare(aval, bval) != 0)
783 {
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000784 diff = key;
785 *pval = aval;
786 }
787 }
788 }
789 return diff;
790}
791
792static int
Tim Peters1f5871e2000-07-04 17:44:48 +0000793dict_compare(dictobject *a, dictobject *b)
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000794{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000795 PyObject *adiff, *bdiff, *aval, *bval;
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000796 int res;
797
798 /* Compare lengths first */
799 if (a->ma_used < b->ma_used)
800 return -1; /* a is shorter */
801 else if (a->ma_used > b->ma_used)
802 return 1; /* b is shorter */
803 /* Same length -- check all keys */
804 adiff = characterize(a, b, &aval);
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000805 if (PyErr_Occurred())
806 return -1;
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000807 if (adiff == NULL)
808 return 0; /* a is a subset with the same length */
809 bdiff = characterize(b, a, &bval);
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000810 if (PyErr_Occurred())
811 return -1;
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000812 /* bdiff == NULL would be impossible now */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000813 res = PyObject_Compare(adiff, bdiff);
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000814 if (res == 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000815 res = PyObject_Compare(aval, bval);
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000816 return res;
817}
818
819#else /* !NEWCMP */
820
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000821static int
Tim Peters1f5871e2000-07-04 17:44:48 +0000822dict_compare(dictobject *a, dictobject *b)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000823{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000824 PyObject *akeys, *bkeys;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000825 int i, n, res;
826 if (a == b)
827 return 0;
828 if (a->ma_used == 0) {
829 if (b->ma_used != 0)
830 return -1;
831 else
832 return 0;
833 }
834 else {
835 if (b->ma_used == 0)
836 return 1;
837 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000838 akeys = dict_keys(a, (PyObject *)NULL);
839 bkeys = dict_keys(b, (PyObject *)NULL);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000840 if (akeys == NULL || bkeys == NULL) {
841 /* Oops, out of memory -- what to do? */
842 /* For now, sort on address! */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000843 Py_XDECREF(akeys);
844 Py_XDECREF(bkeys);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000845 if (a < b)
846 return -1;
847 else
848 return 1;
849 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000850 PyList_Sort(akeys);
851 PyList_Sort(bkeys);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000852 n = a->ma_used < b->ma_used ? a->ma_used : b->ma_used; /* smallest */
853 res = 0;
854 for (i = 0; i < n; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000855 PyObject *akey, *bkey, *aval, *bval;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000856 long ahash, bhash;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000857 akey = PyList_GetItem(akeys, i);
858 bkey = PyList_GetItem(bkeys, i);
859 res = PyObject_Compare(akey, bkey);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000860 if (res != 0)
861 break;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000862#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000863 if (!PyString_Check(akey) ||
864 (ahash = ((PyStringObject *) akey)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000865#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000866 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000867 ahash = PyObject_Hash(akey);
Guido van Rossumca756f21997-01-23 19:39:29 +0000868 if (ahash == -1)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000869 PyErr_Clear(); /* Don't want errors here */
Guido van Rossumca756f21997-01-23 19:39:29 +0000870 }
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000871#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000872 if (!PyString_Check(bkey) ||
873 (bhash = ((PyStringObject *) bkey)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000874#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000875 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000876 bhash = PyObject_Hash(bkey);
Guido van Rossumca756f21997-01-23 19:39:29 +0000877 if (bhash == -1)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000878 PyErr_Clear(); /* Don't want errors here */
Guido van Rossumca756f21997-01-23 19:39:29 +0000879 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000880 aval = lookdict(a, akey, ahash) -> me_value;
881 bval = lookdict(b, bkey, bhash) -> me_value;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000882 res = PyObject_Compare(aval, bval);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000883 if (res != 0)
884 break;
885 }
886 if (res == 0) {
887 if (a->ma_used < b->ma_used)
888 res = -1;
889 else if (a->ma_used > b->ma_used)
890 res = 1;
891 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000892 Py_DECREF(akeys);
893 Py_DECREF(bkeys);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000894 return res;
895}
896
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000897#endif /* !NEWCMP */
898
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000899static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000900dict_has_key(register dictobject *mp, PyObject *args)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000901{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000902 PyObject *key;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000903 long hash;
904 register long ok;
Fred Drake52fccfd2000-02-23 15:47:16 +0000905 if (!PyArg_ParseTuple(args, "O:has_key", &key))
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000906 return NULL;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000907#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000908 if (!PyString_Check(key) ||
909 (hash = ((PyStringObject *) key)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000910#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000911 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000912 hash = PyObject_Hash(key);
Guido van Rossumca756f21997-01-23 19:39:29 +0000913 if (hash == -1)
914 return NULL;
915 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000916 ok = mp->ma_size != 0 && lookdict(mp, key, hash)->me_value != NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000917 return PyInt_FromLong(ok);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000918}
919
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000920static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000921dict_get(register dictobject *mp, PyObject *args)
Barry Warsawc38c5da1997-10-06 17:49:20 +0000922{
923 PyObject *key;
Barry Warsaw320ac331997-10-20 17:26:25 +0000924 PyObject *failobj = Py_None;
Barry Warsawc38c5da1997-10-06 17:49:20 +0000925 PyObject *val = NULL;
926 long hash;
927
Fred Drake52fccfd2000-02-23 15:47:16 +0000928 if (!PyArg_ParseTuple(args, "O|O:get", &key, &failobj))
Barry Warsawc38c5da1997-10-06 17:49:20 +0000929 return NULL;
Guido van Rossum6fcfa721997-10-20 20:10:00 +0000930 if (mp->ma_table == NULL)
931 goto finally;
Barry Warsawc38c5da1997-10-06 17:49:20 +0000932
Barry Warsawc38c5da1997-10-06 17:49:20 +0000933#ifdef CACHE_HASH
934 if (!PyString_Check(key) ||
935 (hash = ((PyStringObject *) key)->ob_shash) == -1)
936#endif
937 {
938 hash = PyObject_Hash(key);
939 if (hash == -1)
940 return NULL;
941 }
942 val = lookdict(mp, key, hash)->me_value;
Barry Warsaw320ac331997-10-20 17:26:25 +0000943
Guido van Rossum6fcfa721997-10-20 20:10:00 +0000944 finally:
Barry Warsawc38c5da1997-10-06 17:49:20 +0000945 if (val == NULL)
946 val = failobj;
947 Py_INCREF(val);
948 return val;
949}
950
951
952static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +0000953dict_clear(register dictobject *mp, PyObject *args)
Guido van Rossumfb8f1ca1997-03-21 21:55:12 +0000954{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000955 if (!PyArg_NoArgs(args))
Guido van Rossumfb8f1ca1997-03-21 21:55:12 +0000956 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000957 PyDict_Clear((PyObject *)mp);
958 Py_INCREF(Py_None);
959 return Py_None;
Guido van Rossumfb8f1ca1997-03-21 21:55:12 +0000960}
961
Jeremy Hylton8caad492000-06-23 14:18:11 +0000962static int
963dict_traverse(PyObject *op, visitproc visit, void *arg)
964{
965 int i = 0, err;
966 PyObject *pk;
967 PyObject *pv;
968
969 while (PyDict_Next(op, &i, &pk, &pv)) {
970 err = visit(pk, arg);
971 if (err)
972 return err;
973 err = visit(pv, arg);
974 if (err)
975 return err;
976 }
977 return 0;
978}
979
980static int
981dict_tp_clear(PyObject *op)
982{
983 PyDict_Clear(op);
984 return 0;
985}
986
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000987static PyMethodDef mapp_methods[] = {
Fred Drake52fccfd2000-02-23 15:47:16 +0000988 {"has_key", (PyCFunction)dict_has_key, METH_VARARGS},
Guido van Rossum5d8123f1997-07-13 03:58:01 +0000989 {"keys", (PyCFunction)dict_keys},
990 {"items", (PyCFunction)dict_items},
991 {"values", (PyCFunction)dict_values},
Guido van Rossuma8d51311997-06-02 17:13:37 +0000992 {"update", (PyCFunction)dict_update},
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000993 {"clear", (PyCFunction)dict_clear},
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000994 {"copy", (PyCFunction)dict_copy},
Fred Drake52fccfd2000-02-23 15:47:16 +0000995 {"get", (PyCFunction)dict_get, METH_VARARGS},
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000996 {NULL, NULL} /* sentinel */
997};
998
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000999static PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +00001000dict_getattr(dictobject *mp, char *name)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001001{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001002 return Py_FindMethod(mapp_methods, (PyObject *)mp, name);
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001003}
1004
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001005PyTypeObject PyDict_Type = {
1006 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001007 0,
Guido van Rossum9bfef441993-03-29 10:43:31 +00001008 "dictionary",
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +00001009 sizeof(dictobject) + PyGC_HEAD_SIZE,
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001010 0,
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001011 (destructor)dict_dealloc, /*tp_dealloc*/
1012 (printfunc)dict_print, /*tp_print*/
1013 (getattrfunc)dict_getattr, /*tp_getattr*/
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001014 0, /*tp_setattr*/
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001015 (cmpfunc)dict_compare, /*tp_compare*/
1016 (reprfunc)dict_repr, /*tp_repr*/
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001017 0, /*tp_as_number*/
1018 0, /*tp_as_sequence*/
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001019 &dict_as_mapping, /*tp_as_mapping*/
Jeremy Hylton8caad492000-06-23 14:18:11 +00001020 0, /* tp_hash */
1021 0, /* tp_call */
1022 0, /* tp_str */
1023 0, /* tp_getattro */
1024 0, /* tp_setattro */
1025 0, /* tp_as_buffer */
Jeremy Hyltond08b4c42000-06-23 19:37:02 +00001026 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_GC, /*tp_flags*/
Jeremy Hylton8caad492000-06-23 14:18:11 +00001027 0, /* tp_doc */
1028 (traverseproc)dict_traverse, /* tp_traverse */
1029 (inquiry)dict_tp_clear, /* tp_clear */
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001030};
1031
Guido van Rossum3cca2451997-05-16 14:23:33 +00001032/* For backward compatibility with old dictionary interface */
1033
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001034PyObject *
Tim Peters1f5871e2000-07-04 17:44:48 +00001035PyDict_GetItemString(PyObject *v, char *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001036{
Guido van Rossum3cca2451997-05-16 14:23:33 +00001037 PyObject *kv, *rv;
1038 kv = PyString_FromString(key);
1039 if (kv == NULL)
1040 return NULL;
Guido van Rossum3cca2451997-05-16 14:23:33 +00001041 rv = PyDict_GetItem(v, kv);
1042 Py_DECREF(kv);
1043 return rv;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001044}
1045
1046int
Tim Peters1f5871e2000-07-04 17:44:48 +00001047PyDict_SetItemString(PyObject *v, char *key, PyObject *item)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001048{
Guido van Rossum3cca2451997-05-16 14:23:33 +00001049 PyObject *kv;
1050 int err;
1051 kv = PyString_FromString(key);
1052 if (kv == NULL)
Guido van Rossum037b2201997-05-20 18:35:19 +00001053 return -1;
Guido van Rossum4f3bf1e1997-09-29 23:31:11 +00001054 PyString_InternInPlace(&kv); /* XXX Should we really? */
Guido van Rossum3cca2451997-05-16 14:23:33 +00001055 err = PyDict_SetItem(v, kv, item);
1056 Py_DECREF(kv);
1057 return err;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001058}
1059
1060int
Tim Peters1f5871e2000-07-04 17:44:48 +00001061PyDict_DelItemString(PyObject *v, char *key)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001062{
Guido van Rossum3cca2451997-05-16 14:23:33 +00001063 PyObject *kv;
1064 int err;
1065 kv = PyString_FromString(key);
1066 if (kv == NULL)
Guido van Rossum037b2201997-05-20 18:35:19 +00001067 return -1;
Guido van Rossum3cca2451997-05-16 14:23:33 +00001068 err = PyDict_DelItem(v, kv);
1069 Py_DECREF(kv);
1070 return err;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001071}