blob: 60945f0c2989154bd64419df258ea0313ec0a8c6 [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 *
95PyDict_New()
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 *lookdict Py_PROTO((dictobject *, PyObject *, long));
134static dictentry *
135lookdict(mp, key, hash)
136 dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000137 PyObject *key;
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000138 register long hash;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000139{
Guido van Rossum16e93a81997-01-28 00:00:11 +0000140 register int i;
141 register unsigned incr;
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000142 register dictentry *freeslot;
Guido van Rossum2095d241997-04-09 19:41:24 +0000143 register unsigned int mask = mp->ma_size-1;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000144 dictentry *ep0 = mp->ma_table;
145 register dictentry *ep;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000146 /* We must come up with (i, incr) such that 0 <= i < ma_size
147 and 0 < incr < ma_size and both are a function of hash */
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000148 i = (~hash) & mask;
149 /* We use ~hash instead of hash, as degenerate hash functions, such
Guido van Rossum16e93a81997-01-28 00:00:11 +0000150 as for ints <sigh>, can have lots of leading zeros. It's not
151 really a performance risk, but better safe than sorry. */
Guido van Rossumefb46091997-01-29 15:53:56 +0000152 ep = &ep0[i];
Guido van Rossumc1c7b1a1998-10-06 16:01:14 +0000153 if (ep->me_key == NULL || ep->me_key == key)
Guido van Rossum7d181591997-01-16 21:06:45 +0000154 return ep;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000155 if (ep->me_key == dummy)
Guido van Rossum7d181591997-01-16 21:06:45 +0000156 freeslot = ep;
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000157 else {
Guido van Rossumc1c7b1a1998-10-06 16:01:14 +0000158 if (ep->me_hash == hash &&
159 PyObject_Compare(ep->me_key, key) == 0)
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000160 {
161 return ep;
162 }
163 freeslot = NULL;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000164 }
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000165 /* XXX What if PyObject_Compare returned an exception? */
Guido van Rossum2bc13791999-03-24 19:06:42 +0000166 /* Derive incr from hash, just to make it more arbitrary. Note that
Guido van Rossum16e93a81997-01-28 00:00:11 +0000167 incr must not be 0, or we will get into an infinite loop.*/
Guido van Rossumfd7a0b81997-08-18 21:52:47 +0000168 incr = (hash ^ ((unsigned long)hash >> 3)) & mask;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000169 if (!incr)
170 incr = mask;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000171 for (;;) {
Guido van Rossumefb46091997-01-29 15:53:56 +0000172 ep = &ep0[(i+incr)&mask];
Guido van Rossum16e93a81997-01-28 00:00:11 +0000173 if (ep->me_key == NULL) {
174 if (freeslot != NULL)
175 return freeslot;
176 else
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000177 return ep;
178 }
Guido van Rossum16e93a81997-01-28 00:00:11 +0000179 if (ep->me_key == dummy) {
180 if (freeslot == NULL)
181 freeslot = ep;
182 }
183 else if (ep->me_key == key ||
184 (ep->me_hash == hash &&
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000185 PyObject_Compare(ep->me_key, key) == 0)) {
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000186 return ep;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000187 }
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000188 /* XXX What if PyObject_Compare returned an exception? */
Guido van Rossum16e93a81997-01-28 00:00:11 +0000189 /* Cycle through GF(2^n)-{0} */
190 incr = incr << 1;
191 if (incr > mask)
Guido van Rossumf05fc711998-11-16 22:46:30 +0000192 incr ^= mp->ma_poly; /* This will implicitely clear
193 the highest bit */
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000194 }
195}
196
197/*
198Internal routine to insert a new item into the table.
199Used both by the internal resize routine and by the public insert routine.
200Eats a reference to key and one to value.
201*/
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000202static void insertdict
203 Py_PROTO((dictobject *, PyObject *, long, PyObject *));
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000204static void
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000205insertdict(mp, key, hash, value)
206 register dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000207 PyObject *key;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000208 long hash;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000209 PyObject *value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000210{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000211 PyObject *old_value;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000212 register dictentry *ep;
213 ep = lookdict(mp, key, hash);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000214 if (ep->me_value != NULL) {
Guido van Rossumd7047b31995-01-02 19:07:15 +0000215 old_value = ep->me_value;
216 ep->me_value = value;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000217 Py_DECREF(old_value); /* which **CAN** re-enter */
218 Py_DECREF(key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000219 }
220 else {
221 if (ep->me_key == NULL)
222 mp->ma_fill++;
223 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000224 Py_DECREF(ep->me_key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000225 ep->me_key = key;
226 ep->me_hash = hash;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000227 ep->me_value = value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000228 mp->ma_used++;
229 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000230}
231
232/*
233Restructure the table by allocating a new table and reinserting all
234items again. When entries have been deleted, the new table may
235actually be smaller than the old one.
236*/
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000237static int dictresize Py_PROTO((dictobject *, int));
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000238static int
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000239dictresize(mp, minused)
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000240 dictobject *mp;
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000241 int minused;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000242{
243 register int oldsize = mp->ma_size;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000244 register int newsize, newpoly;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000245 register dictentry *oldtable = mp->ma_table;
246 register dictentry *newtable;
247 register dictentry *ep;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000248 register int i;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000249 for (i = 0, newsize = MINSIZE; ; i++, newsize <<= 1) {
250 if (i > sizeof(polys)/sizeof(polys[0])) {
251 /* Ran out of polynomials */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000252 PyErr_NoMemory();
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000253 return -1;
254 }
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000255 if (newsize > minused) {
Guido van Rossum16e93a81997-01-28 00:00:11 +0000256 newpoly = polys[i];
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000257 break;
258 }
259 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000260 newtable = PyMem_NEW(dictentry, newsize);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000261 if (newtable == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000262 PyErr_NoMemory();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000263 return -1;
264 }
Guido van Rossum0fd00331998-07-16 15:06:13 +0000265 memset(newtable, '\0', sizeof(dictentry) * newsize);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000266 mp->ma_size = newsize;
Guido van Rossum16e93a81997-01-28 00:00:11 +0000267 mp->ma_poly = newpoly;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000268 mp->ma_table = newtable;
269 mp->ma_fill = 0;
270 mp->ma_used = 0;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000271
272 /* Make two passes, so we can avoid decrefs
273 (and possible side effects) till the table is copied */
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000274 for (i = 0, ep = oldtable; i < oldsize; i++, ep++) {
275 if (ep->me_value != NULL)
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000276 insertdict(mp,ep->me_key,ep->me_hash,ep->me_value);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000277 }
Guido van Rossumd7047b31995-01-02 19:07:15 +0000278 for (i = 0, ep = oldtable; i < oldsize; i++, ep++) {
Guido van Rossum255443b1998-04-10 22:47:14 +0000279 if (ep->me_value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000280 Py_XDECREF(ep->me_key);
Guido van Rossum255443b1998-04-10 22:47:14 +0000281 }
Guido van Rossumd7047b31995-01-02 19:07:15 +0000282 }
283
Guido van Rossumb18618d2000-05-03 23:44:39 +0000284 if (oldtable != NULL)
285 PyMem_DEL(oldtable);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000286 return 0;
287}
288
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000289PyObject *
290PyDict_GetItem(op, key)
291 PyObject *op;
292 PyObject *key;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000293{
294 long hash;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000295 if (!PyDict_Check(op)) {
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000296 return NULL;
297 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000298 if (((dictobject *)op)->ma_table == NULL)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000299 return NULL;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000300#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000301 if (!PyString_Check(key) ||
302 (hash = ((PyStringObject *) key)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000303#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000304 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000305 hash = PyObject_Hash(key);
Guido van Rossum474b19e1998-05-14 01:00:51 +0000306 if (hash == -1) {
307 PyErr_Clear();
Guido van Rossumca756f21997-01-23 19:39:29 +0000308 return NULL;
Guido van Rossum474b19e1998-05-14 01:00:51 +0000309 }
Guido van Rossumca756f21997-01-23 19:39:29 +0000310 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000311 return lookdict((dictobject *)op, key, hash) -> me_value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000312}
313
314int
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000315PyDict_SetItem(op, key, value)
316 register PyObject *op;
317 PyObject *key;
318 PyObject *value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000319{
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000320 register dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000321 register long hash;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000322 if (!PyDict_Check(op)) {
323 PyErr_BadInternalCall();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000324 return -1;
325 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000326 mp = (dictobject *)op;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000327#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000328 if (PyString_Check(key)) {
Guido van Rossum2a61e741997-01-18 07:55:05 +0000329#ifdef INTERN_STRINGS
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000330 if (((PyStringObject *)key)->ob_sinterned != NULL) {
331 key = ((PyStringObject *)key)->ob_sinterned;
332 hash = ((PyStringObject *)key)->ob_shash;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000333 }
334 else
335#endif
336 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000337 hash = ((PyStringObject *)key)->ob_shash;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000338 if (hash == -1)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000339 hash = PyObject_Hash(key);
Guido van Rossum2a61e741997-01-18 07:55:05 +0000340 }
341 }
342 else
343#endif
344 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000345 hash = PyObject_Hash(key);
Guido van Rossum2a61e741997-01-18 07:55:05 +0000346 if (hash == -1)
347 return -1;
Guido van Rossum2a61e741997-01-18 07:55:05 +0000348 }
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000349 /* if fill >= 2/3 size, double in size */
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000350 if (mp->ma_fill*3 >= mp->ma_size*2) {
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000351 if (dictresize(mp, mp->ma_used*2) != 0) {
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000352 if (mp->ma_fill+1 > mp->ma_size)
353 return -1;
354 }
355 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000356 Py_INCREF(value);
357 Py_INCREF(key);
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000358 insertdict(mp, key, hash, value);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000359 return 0;
360}
361
362int
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000363PyDict_DelItem(op, key)
364 PyObject *op;
365 PyObject *key;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000366{
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000367 register dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000368 register long hash;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000369 register dictentry *ep;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000370 PyObject *old_value, *old_key;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000371
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000372 if (!PyDict_Check(op)) {
373 PyErr_BadInternalCall();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000374 return -1;
375 }
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000376#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000377 if (!PyString_Check(key) ||
378 (hash = ((PyStringObject *) key)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000379#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000380 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000381 hash = PyObject_Hash(key);
Guido van Rossumca756f21997-01-23 19:39:29 +0000382 if (hash == -1)
383 return -1;
384 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000385 mp = (dictobject *)op;
386 if (((dictobject *)op)->ma_table == NULL)
Guido van Rossumefc87131995-01-02 19:42:39 +0000387 goto empty;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000388 ep = lookdict(mp, key, hash);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000389 if (ep->me_value == NULL) {
Guido van Rossumefc87131995-01-02 19:42:39 +0000390 empty:
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000391 PyErr_SetObject(PyExc_KeyError, key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000392 return -1;
393 }
Guido van Rossumd7047b31995-01-02 19:07:15 +0000394 old_key = ep->me_key;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000395 Py_INCREF(dummy);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000396 ep->me_key = dummy;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000397 old_value = ep->me_value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000398 ep->me_value = NULL;
399 mp->ma_used--;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000400 Py_DECREF(old_value);
401 Py_DECREF(old_key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000402 return 0;
403}
404
Guido van Rossum25831651993-05-19 14:50:45 +0000405void
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000406PyDict_Clear(op)
407 PyObject *op;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000408{
Guido van Rossumd7047b31995-01-02 19:07:15 +0000409 int i, n;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000410 register dictentry *table;
411 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;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000414 mp = (dictobject *)op;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000415 table = mp->ma_table;
416 if (table == NULL)
417 return;
418 n = mp->ma_size;
419 mp->ma_size = mp->ma_used = mp->ma_fill = 0;
420 mp->ma_table = NULL;
421 for (i = 0; i < n; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000422 Py_XDECREF(table[i].me_key);
423 Py_XDECREF(table[i].me_value);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000424 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000425 PyMem_DEL(table);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000426}
427
Guido van Rossum25831651993-05-19 14:50:45 +0000428int
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000429PyDict_Next(op, ppos, pkey, pvalue)
430 PyObject *op;
Guido van Rossum25831651993-05-19 14:50:45 +0000431 int *ppos;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000432 PyObject **pkey;
433 PyObject **pvalue;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000434{
Guido van Rossum25831651993-05-19 14:50:45 +0000435 int i;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000436 register dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000437 if (!PyDict_Check(op))
Guido van Rossum25831651993-05-19 14:50:45 +0000438 return 0;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000439 mp = (dictobject *)op;
Guido van Rossum25831651993-05-19 14:50:45 +0000440 i = *ppos;
441 if (i < 0)
442 return 0;
443 while (i < mp->ma_size && mp->ma_table[i].me_value == NULL)
444 i++;
445 *ppos = i+1;
446 if (i >= mp->ma_size)
447 return 0;
448 if (pkey)
449 *pkey = mp->ma_table[i].me_key;
450 if (pvalue)
451 *pvalue = mp->ma_table[i].me_value;
452 return 1;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000453}
454
455/* Methods */
456
457static void
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000458dict_dealloc(mp)
459 register dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000460{
461 register int i;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000462 register dictentry *ep;
Guido van Rossumd724b232000-03-13 16:01:29 +0000463 Py_TRASHCAN_SAFE_BEGIN(mp)
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +0000464 PyObject_GC_Fini(mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000465 for (i = 0, ep = mp->ma_table; i < mp->ma_size; i++, ep++) {
Guido van Rossum255443b1998-04-10 22:47:14 +0000466 if (ep->me_key != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000467 Py_DECREF(ep->me_key);
Guido van Rossum255443b1998-04-10 22:47:14 +0000468 }
469 if (ep->me_value != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000470 Py_DECREF(ep->me_value);
Guido van Rossum255443b1998-04-10 22:47:14 +0000471 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000472 }
Guido van Rossumb18618d2000-05-03 23:44:39 +0000473 if (mp->ma_table != NULL)
474 PyMem_DEL(mp->ma_table);
Guido van Rossum4cc6ac72000-07-01 01:00:38 +0000475 mp = (dictobject *) PyObject_AS_GC(mp);
Guido van Rossumb18618d2000-05-03 23:44:39 +0000476 PyObject_DEL(mp);
Guido van Rossumd724b232000-03-13 16:01:29 +0000477 Py_TRASHCAN_SAFE_END(mp)
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000478}
479
480static int
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000481dict_print(mp, fp, flags)
482 register dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000483 register FILE *fp;
484 register int flags;
485{
486 register int i;
487 register int any;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000488 register dictentry *ep;
Guido van Rossum255443b1998-04-10 22:47:14 +0000489
490 i = Py_ReprEnter((PyObject*)mp);
491 if (i != 0) {
492 if (i < 0)
493 return i;
494 fprintf(fp, "{...}");
495 return 0;
496 }
497
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000498 fprintf(fp, "{");
499 any = 0;
500 for (i = 0, ep = mp->ma_table; i < mp->ma_size; i++, ep++) {
501 if (ep->me_value != NULL) {
502 if (any++ > 0)
503 fprintf(fp, ", ");
Guido van Rossum255443b1998-04-10 22:47:14 +0000504 if (PyObject_Print((PyObject *)ep->me_key, fp, 0)!=0) {
505 Py_ReprLeave((PyObject*)mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000506 return -1;
Guido van Rossum255443b1998-04-10 22:47:14 +0000507 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000508 fprintf(fp, ": ");
Guido van Rossum255443b1998-04-10 22:47:14 +0000509 if (PyObject_Print(ep->me_value, fp, 0) != 0) {
510 Py_ReprLeave((PyObject*)mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000511 return -1;
Guido van Rossum255443b1998-04-10 22:47:14 +0000512 }
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000513 }
514 }
515 fprintf(fp, "}");
Guido van Rossum255443b1998-04-10 22:47:14 +0000516 Py_ReprLeave((PyObject*)mp);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000517 return 0;
518}
519
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000520static PyObject *
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000521dict_repr(mp)
522 dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000523{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000524 auto PyObject *v;
525 PyObject *sepa, *colon;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000526 register int i;
527 register int any;
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000528 register dictentry *ep;
Guido van Rossum255443b1998-04-10 22:47:14 +0000529
530 i = Py_ReprEnter((PyObject*)mp);
531 if (i != 0) {
532 if (i > 0)
533 return PyString_FromString("{...}");
534 return NULL;
535 }
536
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000537 v = PyString_FromString("{");
538 sepa = PyString_FromString(", ");
539 colon = PyString_FromString(": ");
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000540 any = 0;
Guido van Rossum1d5735e1994-08-30 08:27:36 +0000541 for (i = 0, ep = mp->ma_table; i < mp->ma_size && v; i++, ep++) {
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000542 if (ep->me_value != NULL) {
543 if (any++)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000544 PyString_Concat(&v, sepa);
545 PyString_ConcatAndDel(&v, PyObject_Repr(ep->me_key));
546 PyString_Concat(&v, colon);
547 PyString_ConcatAndDel(&v, PyObject_Repr(ep->me_value));
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000548 }
549 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000550 PyString_ConcatAndDel(&v, PyString_FromString("}"));
Guido van Rossum255443b1998-04-10 22:47:14 +0000551 Py_ReprLeave((PyObject*)mp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000552 Py_XDECREF(sepa);
553 Py_XDECREF(colon);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000554 return v;
555}
556
557static int
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000558dict_length(mp)
559 dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000560{
561 return mp->ma_used;
562}
563
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000564static PyObject *
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000565dict_subscript(mp, key)
566 dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000567 register PyObject *key;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000568{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000569 PyObject *v;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000570 long hash;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000571 if (mp->ma_table == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000572 PyErr_SetObject(PyExc_KeyError, key);
Guido van Rossumd7047b31995-01-02 19:07:15 +0000573 return NULL;
574 }
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000575#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000576 if (!PyString_Check(key) ||
577 (hash = ((PyStringObject *) key)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000578#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000579 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000580 hash = PyObject_Hash(key);
Guido van Rossumca756f21997-01-23 19:39:29 +0000581 if (hash == -1)
582 return NULL;
583 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000584 v = lookdict(mp, key, hash) -> me_value;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000585 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000586 PyErr_SetObject(PyExc_KeyError, key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000587 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000588 Py_INCREF(v);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000589 return v;
590}
591
592static int
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000593dict_ass_sub(mp, v, w)
594 dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000595 PyObject *v, *w;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000596{
597 if (w == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000598 return PyDict_DelItem((PyObject *)mp, v);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000599 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000600 return PyDict_SetItem((PyObject *)mp, v, w);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000601}
602
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000603static PyMappingMethods dict_as_mapping = {
604 (inquiry)dict_length, /*mp_length*/
605 (binaryfunc)dict_subscript, /*mp_subscript*/
606 (objobjargproc)dict_ass_sub, /*mp_ass_subscript*/
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000607};
608
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000609static PyObject *
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000610dict_keys(mp, args)
611 register dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000612 PyObject *args;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000613{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000614 register PyObject *v;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000615 register int i, j;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000616 if (!PyArg_NoArgs(args))
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000617 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000618 v = PyList_New(mp->ma_used);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000619 if (v == NULL)
620 return NULL;
621 for (i = 0, j = 0; i < mp->ma_size; i++) {
622 if (mp->ma_table[i].me_value != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000623 PyObject *key = mp->ma_table[i].me_key;
624 Py_INCREF(key);
625 PyList_SetItem(v, j, key);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000626 j++;
627 }
628 }
629 return v;
630}
631
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000632static PyObject *
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000633dict_values(mp, args)
634 register dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000635 PyObject *args;
Guido van Rossum25831651993-05-19 14:50:45 +0000636{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000637 register PyObject *v;
Guido van Rossum25831651993-05-19 14:50:45 +0000638 register int i, j;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000639 if (!PyArg_NoArgs(args))
Guido van Rossum25831651993-05-19 14:50:45 +0000640 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000641 v = PyList_New(mp->ma_used);
Guido van Rossum25831651993-05-19 14:50:45 +0000642 if (v == NULL)
643 return NULL;
644 for (i = 0, j = 0; i < mp->ma_size; i++) {
645 if (mp->ma_table[i].me_value != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000646 PyObject *value = mp->ma_table[i].me_value;
647 Py_INCREF(value);
648 PyList_SetItem(v, j, value);
Guido van Rossum25831651993-05-19 14:50:45 +0000649 j++;
650 }
651 }
652 return v;
653}
654
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000655static PyObject *
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000656dict_items(mp, args)
657 register dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000658 PyObject *args;
Guido van Rossum25831651993-05-19 14:50:45 +0000659{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000660 register PyObject *v;
Guido van Rossum25831651993-05-19 14:50:45 +0000661 register int i, j;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000662 if (!PyArg_NoArgs(args))
Guido van Rossum25831651993-05-19 14:50:45 +0000663 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000664 v = PyList_New(mp->ma_used);
Guido van Rossum25831651993-05-19 14:50:45 +0000665 if (v == NULL)
666 return NULL;
667 for (i = 0, j = 0; i < mp->ma_size; i++) {
668 if (mp->ma_table[i].me_value != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000669 PyObject *key = mp->ma_table[i].me_key;
670 PyObject *value = mp->ma_table[i].me_value;
671 PyObject *item = PyTuple_New(2);
Guido van Rossum25831651993-05-19 14:50:45 +0000672 if (item == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000673 Py_DECREF(v);
Guido van Rossum25831651993-05-19 14:50:45 +0000674 return NULL;
675 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000676 Py_INCREF(key);
677 PyTuple_SetItem(item, 0, key);
678 Py_INCREF(value);
679 PyTuple_SetItem(item, 1, value);
680 PyList_SetItem(v, j, item);
Guido van Rossum25831651993-05-19 14:50:45 +0000681 j++;
682 }
683 }
684 return v;
685}
686
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000687static PyObject *
Guido van Rossuma8d51311997-06-02 17:13:37 +0000688dict_update(mp, args)
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000689 register dictobject *mp;
690 PyObject *args;
691{
692 register int i;
693 dictobject *other;
694 dictentry *entry;
695 if (!PyArg_Parse(args, "O!", &PyDict_Type, &other))
696 return NULL;
697 if (other == mp)
Guido van Rossuma8d51311997-06-02 17:13:37 +0000698 goto done; /* a.update(a); nothing to do */
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000699 /* Do one big resize at the start, rather than incrementally
700 resizing as we insert new items. Expect that there will be
701 no (or few) overlapping keys. */
702 if ((mp->ma_fill + other->ma_used)*3 >= mp->ma_size*2) {
703 if (dictresize(mp, (mp->ma_used + other->ma_used)*3/2) != 0)
704 return NULL;
705 }
706 for (i = 0; i < other->ma_size; i++) {
707 entry = &other->ma_table[i];
708 if (entry->me_value != NULL) {
709 Py_INCREF(entry->me_key);
710 Py_INCREF(entry->me_value);
711 insertdict(mp, entry->me_key, entry->me_hash,
712 entry->me_value);
713 }
714 }
715 done:
716 Py_INCREF(Py_None);
717 return Py_None;
718}
719
720static PyObject *
721dict_copy(mp, args)
722 register dictobject *mp;
723 PyObject *args;
724{
Jeremy Hyltona12c7a72000-03-30 22:27:31 +0000725 if (!PyArg_Parse(args, ""))
726 return NULL;
727 return PyDict_Copy((PyObject*)mp);
728}
729
730PyObject *
731PyDict_Copy(o)
732 PyObject *o;
733{
734 register dictobject *mp;
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000735 register int i;
736 dictobject *copy;
737 dictentry *entry;
Jeremy Hyltona12c7a72000-03-30 22:27:31 +0000738
739 if (o == NULL || !PyDict_Check(o)) {
740 PyErr_BadInternalCall();
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000741 return NULL;
Jeremy Hyltona12c7a72000-03-30 22:27:31 +0000742 }
743 mp = (dictobject *)o;
Guido van Rossume3f5b9c1997-05-28 19:15:28 +0000744 copy = (dictobject *)PyDict_New();
745 if (copy == NULL)
746 return NULL;
747 if (mp->ma_used > 0) {
748 if (dictresize(copy, mp->ma_used*3/2) != 0)
749 return NULL;
750 for (i = 0; i < mp->ma_size; i++) {
751 entry = &mp->ma_table[i];
752 if (entry->me_value != NULL) {
753 Py_INCREF(entry->me_key);
754 Py_INCREF(entry->me_value);
755 insertdict(copy, entry->me_key, entry->me_hash,
756 entry->me_value);
757 }
758 }
759 }
760 return (PyObject *)copy;
761}
762
Guido van Rossum4199fac1993-11-05 10:18:44 +0000763int
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000764PyDict_Size(mp)
765 PyObject *mp;
Guido van Rossum4199fac1993-11-05 10:18:44 +0000766{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000767 if (mp == NULL || !PyDict_Check(mp)) {
768 PyErr_BadInternalCall();
Guido van Rossumb376a4a1993-11-23 17:53:17 +0000769 return 0;
Guido van Rossum4199fac1993-11-05 10:18:44 +0000770 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000771 return ((dictobject *)mp)->ma_used;
Guido van Rossum4199fac1993-11-05 10:18:44 +0000772}
773
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000774PyObject *
775PyDict_Keys(mp)
776 PyObject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000777{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000778 if (mp == NULL || !PyDict_Check(mp)) {
779 PyErr_BadInternalCall();
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000780 return NULL;
781 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000782 return dict_keys((dictobject *)mp, (PyObject *)NULL);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000783}
784
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000785PyObject *
786PyDict_Values(mp)
787 PyObject *mp;
Guido van Rossum25831651993-05-19 14:50:45 +0000788{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000789 if (mp == NULL || !PyDict_Check(mp)) {
790 PyErr_BadInternalCall();
Guido van Rossum25831651993-05-19 14:50:45 +0000791 return NULL;
792 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000793 return dict_values((dictobject *)mp, (PyObject *)NULL);
Guido van Rossum25831651993-05-19 14:50:45 +0000794}
795
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000796PyObject *
797PyDict_Items(mp)
798 PyObject *mp;
Guido van Rossum25831651993-05-19 14:50:45 +0000799{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000800 if (mp == NULL || !PyDict_Check(mp)) {
801 PyErr_BadInternalCall();
Guido van Rossum25831651993-05-19 14:50:45 +0000802 return NULL;
803 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000804 return dict_items((dictobject *)mp, (PyObject *)NULL);
Guido van Rossum25831651993-05-19 14:50:45 +0000805}
806
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000807#define NEWCMP
808
809#ifdef NEWCMP
810
811/* Subroutine which returns the smallest key in a for which b's value
812 is different or absent. The value is returned too, through the
813 pval argument. No reference counts are incremented. */
814
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000815static PyObject *
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000816characterize(a, b, pval)
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000817 dictobject *a;
818 dictobject *b;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000819 PyObject **pval;
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000820{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000821 PyObject *diff = NULL;
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000822 int i;
823
824 *pval = NULL;
825 for (i = 0; i < a->ma_size; i++) {
826 if (a->ma_table[i].me_value != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000827 PyObject *key = a->ma_table[i].me_key;
828 PyObject *aval, *bval;
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000829 /* XXX What if PyObject_Compare raises an exception? */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000830 if (diff != NULL && PyObject_Compare(key, diff) > 0)
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000831 continue;
832 aval = a->ma_table[i].me_value;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000833 bval = PyDict_GetItem((PyObject *)b, key);
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000834 /* XXX What if PyObject_Compare raises an exception? */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000835 if (bval == NULL || PyObject_Compare(aval, bval) != 0)
836 {
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000837 diff = key;
838 *pval = aval;
839 }
840 }
841 }
842 return diff;
843}
844
845static int
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000846dict_compare(a, b)
847 dictobject *a, *b;
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000848{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000849 PyObject *adiff, *bdiff, *aval, *bval;
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000850 int res;
851
852 /* Compare lengths first */
853 if (a->ma_used < b->ma_used)
854 return -1; /* a is shorter */
855 else if (a->ma_used > b->ma_used)
856 return 1; /* b is shorter */
857 /* Same length -- check all keys */
858 adiff = characterize(a, b, &aval);
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000859 if (PyErr_Occurred())
860 return -1;
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000861 if (adiff == NULL)
862 return 0; /* a is a subset with the same length */
863 bdiff = characterize(b, a, &bval);
Guido van Rossum5b2121b1997-05-23 00:01:41 +0000864 if (PyErr_Occurred())
865 return -1;
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000866 /* bdiff == NULL would be impossible now */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000867 res = PyObject_Compare(adiff, bdiff);
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000868 if (res == 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000869 res = PyObject_Compare(aval, bval);
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000870 return res;
871}
872
873#else /* !NEWCMP */
874
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000875static int
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000876dict_compare(a, b)
877 dictobject *a, *b;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000878{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000879 PyObject *akeys, *bkeys;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000880 int i, n, res;
881 if (a == b)
882 return 0;
883 if (a->ma_used == 0) {
884 if (b->ma_used != 0)
885 return -1;
886 else
887 return 0;
888 }
889 else {
890 if (b->ma_used == 0)
891 return 1;
892 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000893 akeys = dict_keys(a, (PyObject *)NULL);
894 bkeys = dict_keys(b, (PyObject *)NULL);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000895 if (akeys == NULL || bkeys == NULL) {
896 /* Oops, out of memory -- what to do? */
897 /* For now, sort on address! */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000898 Py_XDECREF(akeys);
899 Py_XDECREF(bkeys);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000900 if (a < b)
901 return -1;
902 else
903 return 1;
904 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000905 PyList_Sort(akeys);
906 PyList_Sort(bkeys);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000907 n = a->ma_used < b->ma_used ? a->ma_used : b->ma_used; /* smallest */
908 res = 0;
909 for (i = 0; i < n; i++) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000910 PyObject *akey, *bkey, *aval, *bval;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000911 long ahash, bhash;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000912 akey = PyList_GetItem(akeys, i);
913 bkey = PyList_GetItem(bkeys, i);
914 res = PyObject_Compare(akey, bkey);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000915 if (res != 0)
916 break;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000917#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000918 if (!PyString_Check(akey) ||
919 (ahash = ((PyStringObject *) akey)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000920#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000921 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000922 ahash = PyObject_Hash(akey);
Guido van Rossumca756f21997-01-23 19:39:29 +0000923 if (ahash == -1)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000924 PyErr_Clear(); /* Don't want errors here */
Guido van Rossumca756f21997-01-23 19:39:29 +0000925 }
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000926#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000927 if (!PyString_Check(bkey) ||
928 (bhash = ((PyStringObject *) bkey)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000929#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000930 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000931 bhash = PyObject_Hash(bkey);
Guido van Rossumca756f21997-01-23 19:39:29 +0000932 if (bhash == -1)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000933 PyErr_Clear(); /* Don't want errors here */
Guido van Rossumca756f21997-01-23 19:39:29 +0000934 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000935 aval = lookdict(a, akey, ahash) -> me_value;
936 bval = lookdict(b, bkey, bhash) -> me_value;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000937 res = PyObject_Compare(aval, bval);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000938 if (res != 0)
939 break;
940 }
941 if (res == 0) {
942 if (a->ma_used < b->ma_used)
943 res = -1;
944 else if (a->ma_used > b->ma_used)
945 res = 1;
946 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000947 Py_DECREF(akeys);
948 Py_DECREF(bkeys);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000949 return res;
950}
951
Guido van Rossuma0a69b81996-12-05 21:55:55 +0000952#endif /* !NEWCMP */
953
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000954static PyObject *
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000955dict_has_key(mp, args)
956 register dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000957 PyObject *args;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000958{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000959 PyObject *key;
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000960 long hash;
961 register long ok;
Fred Drake52fccfd2000-02-23 15:47:16 +0000962 if (!PyArg_ParseTuple(args, "O:has_key", &key))
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000963 return NULL;
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000964#ifdef CACHE_HASH
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000965 if (!PyString_Check(key) ||
966 (hash = ((PyStringObject *) key)->ob_shash) == -1)
Sjoerd Mullender3bb8a051993-10-22 12:04:32 +0000967#endif
Guido van Rossumca756f21997-01-23 19:39:29 +0000968 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000969 hash = PyObject_Hash(key);
Guido van Rossumca756f21997-01-23 19:39:29 +0000970 if (hash == -1)
971 return NULL;
972 }
Guido van Rossuma9e7a811997-05-13 21:02:11 +0000973 ok = mp->ma_size != 0 && lookdict(mp, key, hash)->me_value != NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000974 return PyInt_FromLong(ok);
Guido van Rossum4b1302b1993-03-27 18:11:32 +0000975}
976
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000977static PyObject *
Barry Warsawc38c5da1997-10-06 17:49:20 +0000978dict_get(mp, args)
979 register dictobject *mp;
980 PyObject *args;
981{
982 PyObject *key;
Barry Warsaw320ac331997-10-20 17:26:25 +0000983 PyObject *failobj = Py_None;
Barry Warsawc38c5da1997-10-06 17:49:20 +0000984 PyObject *val = NULL;
985 long hash;
986
Fred Drake52fccfd2000-02-23 15:47:16 +0000987 if (!PyArg_ParseTuple(args, "O|O:get", &key, &failobj))
Barry Warsawc38c5da1997-10-06 17:49:20 +0000988 return NULL;
Guido van Rossum6fcfa721997-10-20 20:10:00 +0000989 if (mp->ma_table == NULL)
990 goto finally;
Barry Warsawc38c5da1997-10-06 17:49:20 +0000991
Barry Warsawc38c5da1997-10-06 17:49:20 +0000992#ifdef CACHE_HASH
993 if (!PyString_Check(key) ||
994 (hash = ((PyStringObject *) key)->ob_shash) == -1)
995#endif
996 {
997 hash = PyObject_Hash(key);
998 if (hash == -1)
999 return NULL;
1000 }
1001 val = lookdict(mp, key, hash)->me_value;
Barry Warsaw320ac331997-10-20 17:26:25 +00001002
Guido van Rossum6fcfa721997-10-20 20:10:00 +00001003 finally:
Barry Warsawc38c5da1997-10-06 17:49:20 +00001004 if (val == NULL)
1005 val = failobj;
1006 Py_INCREF(val);
1007 return val;
1008}
1009
1010
1011static PyObject *
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001012dict_clear(mp, args)
1013 register dictobject *mp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001014 PyObject *args;
Guido van Rossumfb8f1ca1997-03-21 21:55:12 +00001015{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001016 if (!PyArg_NoArgs(args))
Guido van Rossumfb8f1ca1997-03-21 21:55:12 +00001017 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001018 PyDict_Clear((PyObject *)mp);
1019 Py_INCREF(Py_None);
1020 return Py_None;
Guido van Rossumfb8f1ca1997-03-21 21:55:12 +00001021}
1022
Jeremy Hylton8caad492000-06-23 14:18:11 +00001023static int
1024dict_traverse(PyObject *op, visitproc visit, void *arg)
1025{
1026 int i = 0, err;
1027 PyObject *pk;
1028 PyObject *pv;
1029
1030 while (PyDict_Next(op, &i, &pk, &pv)) {
1031 err = visit(pk, arg);
1032 if (err)
1033 return err;
1034 err = visit(pv, arg);
1035 if (err)
1036 return err;
1037 }
1038 return 0;
1039}
1040
1041static int
1042dict_tp_clear(PyObject *op)
1043{
1044 PyDict_Clear(op);
1045 return 0;
1046}
1047
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001048static PyMethodDef mapp_methods[] = {
Fred Drake52fccfd2000-02-23 15:47:16 +00001049 {"has_key", (PyCFunction)dict_has_key, METH_VARARGS},
Guido van Rossum5d8123f1997-07-13 03:58:01 +00001050 {"keys", (PyCFunction)dict_keys},
1051 {"items", (PyCFunction)dict_items},
1052 {"values", (PyCFunction)dict_values},
Guido van Rossuma8d51311997-06-02 17:13:37 +00001053 {"update", (PyCFunction)dict_update},
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001054 {"clear", (PyCFunction)dict_clear},
Guido van Rossume3f5b9c1997-05-28 19:15:28 +00001055 {"copy", (PyCFunction)dict_copy},
Fred Drake52fccfd2000-02-23 15:47:16 +00001056 {"get", (PyCFunction)dict_get, METH_VARARGS},
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001057 {NULL, NULL} /* sentinel */
1058};
1059
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001060static PyObject *
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001061dict_getattr(mp, name)
1062 dictobject *mp;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001063 char *name;
1064{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001065 return Py_FindMethod(mapp_methods, (PyObject *)mp, name);
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001066}
1067
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001068PyTypeObject PyDict_Type = {
1069 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001070 0,
Guido van Rossum9bfef441993-03-29 10:43:31 +00001071 "dictionary",
Jeremy Hyltonc5007aa2000-06-30 05:02:53 +00001072 sizeof(dictobject) + PyGC_HEAD_SIZE,
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001073 0,
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001074 (destructor)dict_dealloc, /*tp_dealloc*/
1075 (printfunc)dict_print, /*tp_print*/
1076 (getattrfunc)dict_getattr, /*tp_getattr*/
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001077 0, /*tp_setattr*/
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001078 (cmpfunc)dict_compare, /*tp_compare*/
1079 (reprfunc)dict_repr, /*tp_repr*/
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001080 0, /*tp_as_number*/
1081 0, /*tp_as_sequence*/
Guido van Rossuma9e7a811997-05-13 21:02:11 +00001082 &dict_as_mapping, /*tp_as_mapping*/
Jeremy Hylton8caad492000-06-23 14:18:11 +00001083 0, /* tp_hash */
1084 0, /* tp_call */
1085 0, /* tp_str */
1086 0, /* tp_getattro */
1087 0, /* tp_setattro */
1088 0, /* tp_as_buffer */
Jeremy Hyltond08b4c42000-06-23 19:37:02 +00001089 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_GC, /*tp_flags*/
Jeremy Hylton8caad492000-06-23 14:18:11 +00001090 0, /* tp_doc */
1091 (traverseproc)dict_traverse, /* tp_traverse */
1092 (inquiry)dict_tp_clear, /* tp_clear */
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001093};
1094
Guido van Rossum3cca2451997-05-16 14:23:33 +00001095/* For backward compatibility with old dictionary interface */
1096
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001097PyObject *
1098PyDict_GetItemString(v, key)
1099 PyObject *v;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001100 char *key;
1101{
Guido van Rossum3cca2451997-05-16 14:23:33 +00001102 PyObject *kv, *rv;
1103 kv = PyString_FromString(key);
1104 if (kv == NULL)
1105 return NULL;
Guido van Rossum3cca2451997-05-16 14:23:33 +00001106 rv = PyDict_GetItem(v, kv);
1107 Py_DECREF(kv);
1108 return rv;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001109}
1110
1111int
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001112PyDict_SetItemString(v, key, item)
1113 PyObject *v;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001114 char *key;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001115 PyObject *item;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001116{
Guido van Rossum3cca2451997-05-16 14:23:33 +00001117 PyObject *kv;
1118 int err;
1119 kv = PyString_FromString(key);
1120 if (kv == NULL)
Guido van Rossum037b2201997-05-20 18:35:19 +00001121 return -1;
Guido van Rossum4f3bf1e1997-09-29 23:31:11 +00001122 PyString_InternInPlace(&kv); /* XXX Should we really? */
Guido van Rossum3cca2451997-05-16 14:23:33 +00001123 err = PyDict_SetItem(v, kv, item);
1124 Py_DECREF(kv);
1125 return err;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001126}
1127
1128int
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001129PyDict_DelItemString(v, key)
1130 PyObject *v;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001131 char *key;
1132{
Guido van Rossum3cca2451997-05-16 14:23:33 +00001133 PyObject *kv;
1134 int err;
1135 kv = PyString_FromString(key);
1136 if (kv == NULL)
Guido van Rossum037b2201997-05-20 18:35:19 +00001137 return -1;
Guido van Rossum3cca2451997-05-16 14:23:33 +00001138 err = PyDict_DelItem(v, kv);
1139 Py_DECREF(kv);
1140 return err;
Guido van Rossum4b1302b1993-03-27 18:11:32 +00001141}