Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1 | #include "Python.h" |
Raymond Hettinger | 691d805 | 2004-05-30 07:26:47 +0000 | [diff] [blame] | 2 | #include "structmember.h" |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 3 | |
| 4 | /* collections module implementation of a deque() datatype |
| 5 | Written and maintained by Raymond D. Hettinger <python@rcn.com> |
Raymond Hettinger | 5402315 | 2014-04-23 00:58:48 -0700 | [diff] [blame] | 6 | Copyright (c) 2004-2014 Python Software Foundation. |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 7 | All rights reserved. |
| 8 | */ |
| 9 | |
Raymond Hettinger | 77e8bf1 | 2004-10-01 15:25:53 +0000 | [diff] [blame] | 10 | /* The block length may be set to any number over 1. Larger numbers |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 11 | * reduce the number of calls to the memory allocator, give faster |
| 12 | * indexing and rotation, and reduce the link::data overhead ratio. |
Raymond Hettinger | 7757820 | 2013-07-28 02:39:49 -0700 | [diff] [blame] | 13 | * |
| 14 | * Ideally, the block length will be set to two less than some |
| 15 | * multiple of the cache-line length (so that the full block |
| 16 | * including the leftlink and rightlink will fit neatly into |
| 17 | * cache lines). |
Raymond Hettinger | 77e8bf1 | 2004-10-01 15:25:53 +0000 | [diff] [blame] | 18 | */ |
| 19 | |
Raymond Hettinger | 7757820 | 2013-07-28 02:39:49 -0700 | [diff] [blame] | 20 | #define BLOCKLEN 62 |
Raymond Hettinger | 61f05fb | 2004-10-01 06:24:12 +0000 | [diff] [blame] | 21 | #define CENTER ((BLOCKLEN - 1) / 2) |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 22 | |
Tim Peters | d8768d3 | 2004-10-01 01:32:53 +0000 | [diff] [blame] | 23 | /* A `dequeobject` is composed of a doubly-linked list of `block` nodes. |
Raymond Hettinger | 61f05fb | 2004-10-01 06:24:12 +0000 | [diff] [blame] | 24 | * The list of blocks is never empty, so d.leftblock and d.rightblock |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 25 | * are never equal to NULL. The list is not circular. |
| 26 | * |
| 27 | * A deque d's first element is at d.leftblock[leftindex] |
| 28 | * and its last element is at d.rightblock[rightindex]. |
| 29 | * Unlike Python slice indices, these indices are inclusive |
| 30 | * on both ends. This makes the algorithms for left and |
| 31 | * right operations more symmetrical and simplifies the design. |
Raymond Hettinger | 61f05fb | 2004-10-01 06:24:12 +0000 | [diff] [blame] | 32 | * |
| 33 | * The indices, d.leftindex and d.rightindex are always in the range |
| 34 | * 0 <= index < BLOCKLEN. |
Raymond Hettinger | 4ca4c7c | 2004-10-01 15:14:39 +0000 | [diff] [blame] | 35 | * Their exact relationship is: |
| 36 | * (d.leftindex + d.len - 1) % BLOCKLEN == d.rightindex. |
Raymond Hettinger | 61f05fb | 2004-10-01 06:24:12 +0000 | [diff] [blame] | 37 | * |
| 38 | * Empty deques have d.len == 0; d.leftblock==d.rightblock; |
| 39 | * d.leftindex == CENTER+1; and d.rightindex == CENTER. |
| 40 | * Checking for d.len == 0 is the intended way to see whether d is empty. |
| 41 | * |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 42 | * Whenever d.leftblock == d.rightblock, |
Raymond Hettinger | 4ca4c7c | 2004-10-01 15:14:39 +0000 | [diff] [blame] | 43 | * d.leftindex + d.len - 1 == d.rightindex. |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 44 | * |
Raymond Hettinger | 4ca4c7c | 2004-10-01 15:14:39 +0000 | [diff] [blame] | 45 | * However, when d.leftblock != d.rightblock, d.leftindex and d.rightindex |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 46 | * become indices into distinct blocks and either may be larger than the |
Raymond Hettinger | 4ca4c7c | 2004-10-01 15:14:39 +0000 | [diff] [blame] | 47 | * other. |
Tim Peters | d8768d3 | 2004-10-01 01:32:53 +0000 | [diff] [blame] | 48 | */ |
| 49 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 50 | typedef struct BLOCK { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 51 | struct BLOCK *leftlink; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 52 | PyObject *data[BLOCKLEN]; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 53 | struct BLOCK *rightlink; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 54 | } block; |
| 55 | |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 56 | /* For debug builds, add error checking to track the endpoints |
| 57 | * in the chain of links. The goal is to make sure that link |
| 58 | * assignments only take place at endpoints so that links already |
| 59 | * in use do not get overwritten. |
| 60 | * |
| 61 | * CHECK_END should happen before each assignment to a block's link field. |
| 62 | * MARK_END should happen whenever a link field becomes a new endpoint. |
| 63 | * This happens when new blocks are added or whenever an existing |
| 64 | * block is freed leaving another existing block as the new endpoint. |
| 65 | */ |
| 66 | |
Raymond Hettinger | 3223dd5 | 2013-07-26 23:14:22 -0700 | [diff] [blame] | 67 | #ifndef NDEBUG |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 68 | #define MARK_END(link) link = NULL; |
| 69 | #define CHECK_END(link) assert(link == NULL); |
| 70 | #define CHECK_NOT_END(link) assert(link != NULL); |
| 71 | #else |
| 72 | #define MARK_END(link) |
| 73 | #define CHECK_END(link) |
| 74 | #define CHECK_NOT_END(link) |
| 75 | #endif |
| 76 | |
| 77 | /* A simple freelisting scheme is used to minimize calls to the memory |
| 78 | allocator. It accomodates common use cases where new blocks are being |
| 79 | added at about the same rate as old blocks are being freed. |
| 80 | */ |
| 81 | |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 82 | #define MAXFREEBLOCKS 10 |
Benjamin Peterson | d631371 | 2008-07-31 16:23:04 +0000 | [diff] [blame] | 83 | static Py_ssize_t numfreeblocks = 0; |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 84 | static block *freeblocks[MAXFREEBLOCKS]; |
| 85 | |
Tim Peters | 6f85356 | 2004-10-01 01:04:50 +0000 | [diff] [blame] | 86 | static block * |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 87 | newblock(Py_ssize_t len) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 88 | block *b; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 89 | /* To prevent len from overflowing PY_SSIZE_T_MAX, we refuse to |
| 90 | * allocate new blocks if the current len is nearing overflow. */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 91 | if (len >= PY_SSIZE_T_MAX - 2*BLOCKLEN) { |
| 92 | PyErr_SetString(PyExc_OverflowError, |
| 93 | "cannot add more blocks to the deque"); |
| 94 | return NULL; |
| 95 | } |
| 96 | if (numfreeblocks) { |
Raymond Hettinger | 59cf23a | 2013-02-07 00:57:19 -0500 | [diff] [blame] | 97 | numfreeblocks--; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 98 | return freeblocks[numfreeblocks]; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 99 | } |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 100 | b = PyMem_Malloc(sizeof(block)); |
| 101 | if (b != NULL) { |
| 102 | return b; |
| 103 | } |
| 104 | PyErr_NoMemory(); |
| 105 | return NULL; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 106 | } |
| 107 | |
Martin v. Löwis | 59683e8 | 2008-06-13 07:50:45 +0000 | [diff] [blame] | 108 | static void |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 109 | freeblock(block *b) |
| 110 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 111 | if (numfreeblocks < MAXFREEBLOCKS) { |
| 112 | freeblocks[numfreeblocks] = b; |
| 113 | numfreeblocks++; |
| 114 | } else { |
| 115 | PyMem_Free(b); |
| 116 | } |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 117 | } |
| 118 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 119 | typedef struct { |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 120 | PyObject_VAR_HEAD |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 121 | block *leftblock; |
| 122 | block *rightblock; |
| 123 | Py_ssize_t leftindex; /* in range(BLOCKLEN) */ |
| 124 | Py_ssize_t rightindex; /* in range(BLOCKLEN) */ |
Raymond Hettinger | 90dea4c | 2013-07-13 22:30:25 -0700 | [diff] [blame] | 125 | long state; /* incremented whenever the indices move */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 126 | Py_ssize_t maxlen; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 127 | PyObject *weakreflist; /* List of weak references */ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 128 | } dequeobject; |
| 129 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 130 | /* The deque's size limit is d.maxlen. The limit can be zero or positive. |
| 131 | * If there is no limit, then d.maxlen == -1. |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 132 | * |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 133 | * After an item is added to a deque, we check to see if the size has grown past |
| 134 | * the limit. If it has, we get the size back down to the limit by popping an |
| 135 | * item off of the opposite end. The methods that can trigger this are append(), |
| 136 | * appendleft(), extend(), and extendleft(). |
| 137 | */ |
| 138 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 139 | #define TRIM(d, popfunction) \ |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 140 | if (d->maxlen != -1 && Py_SIZE(d) > d->maxlen) { \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 141 | PyObject *rv = popfunction(d, NULL); \ |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 142 | assert(rv != NULL && Py_SIZE(d) <= d->maxlen); \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 143 | Py_DECREF(rv); \ |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 144 | } |
| 145 | |
Neal Norwitz | 87f1013 | 2004-02-29 15:40:53 +0000 | [diff] [blame] | 146 | static PyTypeObject deque_type; |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 147 | |
Raymond Hettinger | 5402315 | 2014-04-23 00:58:48 -0700 | [diff] [blame] | 148 | /* XXX Todo: |
| 149 | If aligned memory allocations become available, make the |
| 150 | deque object 64 byte aligned so that all of the fields |
| 151 | can be retrieved or updated in a single cache line. |
| 152 | */ |
| 153 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 154 | static PyObject * |
| 155 | deque_new(PyTypeObject *type, PyObject *args, PyObject *kwds) |
| 156 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 157 | dequeobject *deque; |
| 158 | block *b; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 159 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 160 | /* create dequeobject structure */ |
| 161 | deque = (dequeobject *)type->tp_alloc(type, 0); |
| 162 | if (deque == NULL) |
| 163 | return NULL; |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 164 | |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 165 | b = newblock(0); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 166 | if (b == NULL) { |
| 167 | Py_DECREF(deque); |
| 168 | return NULL; |
| 169 | } |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 170 | MARK_END(b->leftlink); |
| 171 | MARK_END(b->rightlink); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 172 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 173 | assert(BLOCKLEN >= 2); |
| 174 | deque->leftblock = b; |
| 175 | deque->rightblock = b; |
| 176 | deque->leftindex = CENTER + 1; |
| 177 | deque->rightindex = CENTER; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 178 | Py_SIZE(deque) = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 179 | deque->state = 0; |
| 180 | deque->weakreflist = NULL; |
| 181 | deque->maxlen = -1; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 182 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 183 | return (PyObject *)deque; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 184 | } |
| 185 | |
| 186 | static PyObject * |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 187 | deque_pop(dequeobject *deque, PyObject *unused) |
| 188 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 189 | PyObject *item; |
| 190 | block *prevblock; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 191 | |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 192 | if (Py_SIZE(deque) == 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 193 | PyErr_SetString(PyExc_IndexError, "pop from an empty deque"); |
| 194 | return NULL; |
| 195 | } |
| 196 | item = deque->rightblock->data[deque->rightindex]; |
| 197 | deque->rightindex--; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 198 | Py_SIZE(deque)--; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 199 | deque->state++; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 200 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 201 | if (deque->rightindex == -1) { |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 202 | if (Py_SIZE(deque) == 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 203 | assert(deque->leftblock == deque->rightblock); |
| 204 | assert(deque->leftindex == deque->rightindex+1); |
| 205 | /* re-center instead of freeing a block */ |
| 206 | deque->leftindex = CENTER + 1; |
| 207 | deque->rightindex = CENTER; |
| 208 | } else { |
| 209 | prevblock = deque->rightblock->leftlink; |
| 210 | assert(deque->leftblock != deque->rightblock); |
| 211 | freeblock(deque->rightblock); |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 212 | CHECK_NOT_END(prevblock); |
| 213 | MARK_END(prevblock->rightlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 214 | deque->rightblock = prevblock; |
| 215 | deque->rightindex = BLOCKLEN - 1; |
| 216 | } |
| 217 | } |
| 218 | return item; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 219 | } |
| 220 | |
| 221 | PyDoc_STRVAR(pop_doc, "Remove and return the rightmost element."); |
| 222 | |
| 223 | static PyObject * |
| 224 | deque_popleft(dequeobject *deque, PyObject *unused) |
| 225 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 226 | PyObject *item; |
| 227 | block *prevblock; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 228 | |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 229 | if (Py_SIZE(deque) == 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 230 | PyErr_SetString(PyExc_IndexError, "pop from an empty deque"); |
| 231 | return NULL; |
| 232 | } |
| 233 | assert(deque->leftblock != NULL); |
| 234 | item = deque->leftblock->data[deque->leftindex]; |
| 235 | deque->leftindex++; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 236 | Py_SIZE(deque)--; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 237 | deque->state++; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 238 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 239 | if (deque->leftindex == BLOCKLEN) { |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 240 | if (Py_SIZE(deque) == 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 241 | assert(deque->leftblock == deque->rightblock); |
| 242 | assert(deque->leftindex == deque->rightindex+1); |
| 243 | /* re-center instead of freeing a block */ |
| 244 | deque->leftindex = CENTER + 1; |
| 245 | deque->rightindex = CENTER; |
| 246 | } else { |
| 247 | assert(deque->leftblock != deque->rightblock); |
| 248 | prevblock = deque->leftblock->rightlink; |
| 249 | freeblock(deque->leftblock); |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 250 | CHECK_NOT_END(prevblock); |
| 251 | MARK_END(prevblock->leftlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 252 | deque->leftblock = prevblock; |
| 253 | deque->leftindex = 0; |
| 254 | } |
| 255 | } |
| 256 | return item; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 257 | } |
| 258 | |
| 259 | PyDoc_STRVAR(popleft_doc, "Remove and return the leftmost element."); |
| 260 | |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 261 | static PyObject * |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 262 | deque_append(dequeobject *deque, PyObject *item) |
| 263 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 264 | deque->state++; |
| 265 | if (deque->rightindex == BLOCKLEN-1) { |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 266 | block *b = newblock(Py_SIZE(deque)); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 267 | if (b == NULL) |
| 268 | return NULL; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 269 | b->leftlink = deque->rightblock; |
| 270 | CHECK_END(deque->rightblock->rightlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 271 | deque->rightblock->rightlink = b; |
| 272 | deque->rightblock = b; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 273 | MARK_END(b->rightlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 274 | deque->rightindex = -1; |
| 275 | } |
| 276 | Py_INCREF(item); |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 277 | Py_SIZE(deque)++; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 278 | deque->rightindex++; |
| 279 | deque->rightblock->data[deque->rightindex] = item; |
| 280 | TRIM(deque, deque_popleft); |
| 281 | Py_RETURN_NONE; |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 282 | } |
| 283 | |
| 284 | PyDoc_STRVAR(append_doc, "Add an element to the right side of the deque."); |
| 285 | |
| 286 | static PyObject * |
| 287 | deque_appendleft(dequeobject *deque, PyObject *item) |
| 288 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 289 | deque->state++; |
| 290 | if (deque->leftindex == 0) { |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 291 | block *b = newblock(Py_SIZE(deque)); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 292 | if (b == NULL) |
| 293 | return NULL; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 294 | b->rightlink = deque->leftblock; |
| 295 | CHECK_END(deque->leftblock->leftlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 296 | deque->leftblock->leftlink = b; |
| 297 | deque->leftblock = b; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 298 | MARK_END(b->leftlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 299 | deque->leftindex = BLOCKLEN; |
| 300 | } |
| 301 | Py_INCREF(item); |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 302 | Py_SIZE(deque)++; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 303 | deque->leftindex--; |
| 304 | deque->leftblock->data[deque->leftindex] = item; |
| 305 | TRIM(deque, deque_pop); |
| 306 | Py_RETURN_NONE; |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 307 | } |
| 308 | |
| 309 | PyDoc_STRVAR(appendleft_doc, "Add an element to the left side of the deque."); |
| 310 | |
Raymond Hettinger | 060c7f6 | 2009-03-10 09:36:07 +0000 | [diff] [blame] | 311 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 312 | /* Run an iterator to exhaustion. Shortcut for |
Raymond Hettinger | 060c7f6 | 2009-03-10 09:36:07 +0000 | [diff] [blame] | 313 | the extend/extendleft methods when maxlen == 0. */ |
| 314 | static PyObject* |
| 315 | consume_iterator(PyObject *it) |
| 316 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 317 | PyObject *item; |
Raymond Hettinger | 060c7f6 | 2009-03-10 09:36:07 +0000 | [diff] [blame] | 318 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 319 | while ((item = PyIter_Next(it)) != NULL) { |
| 320 | Py_DECREF(item); |
| 321 | } |
| 322 | Py_DECREF(it); |
| 323 | if (PyErr_Occurred()) |
| 324 | return NULL; |
| 325 | Py_RETURN_NONE; |
Raymond Hettinger | 060c7f6 | 2009-03-10 09:36:07 +0000 | [diff] [blame] | 326 | } |
| 327 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 328 | static PyObject * |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 329 | deque_extend(dequeobject *deque, PyObject *iterable) |
| 330 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 331 | PyObject *it, *item; |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 332 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 333 | /* Handle case where id(deque) == id(iterable) */ |
| 334 | if ((PyObject *)deque == iterable) { |
| 335 | PyObject *result; |
| 336 | PyObject *s = PySequence_List(iterable); |
| 337 | if (s == NULL) |
| 338 | return NULL; |
| 339 | result = deque_extend(deque, s); |
| 340 | Py_DECREF(s); |
| 341 | return result; |
| 342 | } |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 343 | |
Raymond Hettinger | d9c116c | 2013-07-09 00:13:21 -0700 | [diff] [blame] | 344 | /* Space saving heuristic. Start filling from the left */ |
| 345 | if (Py_SIZE(deque) == 0) { |
| 346 | assert(deque->leftblock == deque->rightblock); |
| 347 | assert(deque->leftindex == deque->rightindex+1); |
| 348 | deque->leftindex = 1; |
| 349 | deque->rightindex = 0; |
| 350 | } |
| 351 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 352 | it = PyObject_GetIter(iterable); |
| 353 | if (it == NULL) |
| 354 | return NULL; |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 355 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 356 | if (deque->maxlen == 0) |
| 357 | return consume_iterator(it); |
Raymond Hettinger | 060c7f6 | 2009-03-10 09:36:07 +0000 | [diff] [blame] | 358 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 359 | while ((item = PyIter_Next(it)) != NULL) { |
| 360 | deque->state++; |
| 361 | if (deque->rightindex == BLOCKLEN-1) { |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 362 | block *b = newblock(Py_SIZE(deque)); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 363 | if (b == NULL) { |
| 364 | Py_DECREF(item); |
| 365 | Py_DECREF(it); |
| 366 | return NULL; |
| 367 | } |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 368 | b->leftlink = deque->rightblock; |
| 369 | CHECK_END(deque->rightblock->rightlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 370 | deque->rightblock->rightlink = b; |
| 371 | deque->rightblock = b; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 372 | MARK_END(b->rightlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 373 | deque->rightindex = -1; |
| 374 | } |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 375 | Py_SIZE(deque)++; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 376 | deque->rightindex++; |
| 377 | deque->rightblock->data[deque->rightindex] = item; |
| 378 | TRIM(deque, deque_popleft); |
| 379 | } |
| 380 | Py_DECREF(it); |
| 381 | if (PyErr_Occurred()) |
| 382 | return NULL; |
| 383 | Py_RETURN_NONE; |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 384 | } |
| 385 | |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 386 | PyDoc_STRVAR(extend_doc, |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 387 | "Extend the right side of the deque with elements from the iterable"); |
| 388 | |
| 389 | static PyObject * |
| 390 | deque_extendleft(dequeobject *deque, PyObject *iterable) |
| 391 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 392 | PyObject *it, *item; |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 393 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 394 | /* Handle case where id(deque) == id(iterable) */ |
| 395 | if ((PyObject *)deque == iterable) { |
| 396 | PyObject *result; |
| 397 | PyObject *s = PySequence_List(iterable); |
| 398 | if (s == NULL) |
| 399 | return NULL; |
| 400 | result = deque_extendleft(deque, s); |
| 401 | Py_DECREF(s); |
| 402 | return result; |
| 403 | } |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 404 | |
Raymond Hettinger | d9c116c | 2013-07-09 00:13:21 -0700 | [diff] [blame] | 405 | /* Space saving heuristic. Start filling from the right */ |
| 406 | if (Py_SIZE(deque) == 0) { |
| 407 | assert(deque->leftblock == deque->rightblock); |
| 408 | assert(deque->leftindex == deque->rightindex+1); |
| 409 | deque->leftindex = BLOCKLEN - 1; |
| 410 | deque->rightindex = BLOCKLEN - 2; |
| 411 | } |
| 412 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 413 | it = PyObject_GetIter(iterable); |
| 414 | if (it == NULL) |
| 415 | return NULL; |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 416 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 417 | if (deque->maxlen == 0) |
| 418 | return consume_iterator(it); |
Raymond Hettinger | 060c7f6 | 2009-03-10 09:36:07 +0000 | [diff] [blame] | 419 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 420 | while ((item = PyIter_Next(it)) != NULL) { |
| 421 | deque->state++; |
| 422 | if (deque->leftindex == 0) { |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 423 | block *b = newblock(Py_SIZE(deque)); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 424 | if (b == NULL) { |
| 425 | Py_DECREF(item); |
| 426 | Py_DECREF(it); |
| 427 | return NULL; |
| 428 | } |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 429 | b->rightlink = deque->leftblock; |
| 430 | CHECK_END(deque->leftblock->leftlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 431 | deque->leftblock->leftlink = b; |
| 432 | deque->leftblock = b; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 433 | MARK_END(b->leftlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 434 | deque->leftindex = BLOCKLEN; |
| 435 | } |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 436 | Py_SIZE(deque)++; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 437 | deque->leftindex--; |
| 438 | deque->leftblock->data[deque->leftindex] = item; |
| 439 | TRIM(deque, deque_pop); |
| 440 | } |
| 441 | Py_DECREF(it); |
| 442 | if (PyErr_Occurred()) |
| 443 | return NULL; |
| 444 | Py_RETURN_NONE; |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 445 | } |
| 446 | |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 447 | PyDoc_STRVAR(extendleft_doc, |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 448 | "Extend the left side of the deque with elements from the iterable"); |
| 449 | |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 450 | static PyObject * |
| 451 | deque_inplace_concat(dequeobject *deque, PyObject *other) |
| 452 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 453 | PyObject *result; |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 454 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 455 | result = deque_extend(deque, other); |
| 456 | if (result == NULL) |
| 457 | return result; |
| 458 | Py_DECREF(result); |
| 459 | Py_INCREF(deque); |
| 460 | return (PyObject *)deque; |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 461 | } |
| 462 | |
Raymond Hettinger | 5402315 | 2014-04-23 00:58:48 -0700 | [diff] [blame] | 463 | /* The rotate() method is part of the public API and is used internally |
| 464 | as a primitive for other methods. |
| 465 | |
| 466 | Rotation by 1 or -1 is a common case, so any optimizations for high |
| 467 | volume rotations should take care not to penalize the common case. |
| 468 | |
| 469 | Conceptually, a rotate by one is equivalent to a pop on one side and an |
| 470 | append on the other. However, a pop/append pair is unnecessarily slow |
| 471 | because it requires a incref/decref pair for an object located randomly |
| 472 | in memory. It is better to just move the object pointer from one block |
| 473 | to the next without changing the reference count. |
| 474 | |
| 475 | When moving batches of pointers, it is tempting to use memcpy() but that |
| 476 | proved to be slower than a simple loop for a variety of reasons. |
| 477 | Memcpy() cannot know in advance that we're copying pointers instead of |
| 478 | bytes, that the source and destination are pointer aligned and |
| 479 | non-overlapping, that moving just one pointer is a common case, that we |
| 480 | never need to move more than BLOCKLEN pointers, and that at least one |
| 481 | pointer is always moved. |
| 482 | |
| 483 | For high volume rotations, newblock() and freeblock() are never called |
| 484 | more than once. Previously emptied blocks are immediately reused as a |
| 485 | destination block. If a block is left-over at the end, it is freed. |
| 486 | */ |
| 487 | |
Raymond Hettinger | dcb9d94 | 2004-10-09 16:02:18 +0000 | [diff] [blame] | 488 | static int |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 489 | _deque_rotate(dequeobject *deque, Py_ssize_t n) |
Raymond Hettinger | 5c5eb86 | 2004-02-07 21:13:00 +0000 | [diff] [blame] | 490 | { |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 491 | block *b = NULL; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 492 | block *leftblock = deque->leftblock; |
| 493 | block *rightblock = deque->rightblock; |
| 494 | Py_ssize_t leftindex = deque->leftindex; |
| 495 | Py_ssize_t rightindex = deque->rightindex; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 496 | Py_ssize_t len=Py_SIZE(deque), halflen=len>>1; |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 497 | int rv = -1; |
Raymond Hettinger | 5c5eb86 | 2004-02-07 21:13:00 +0000 | [diff] [blame] | 498 | |
Raymond Hettinger | 464d89b | 2013-01-11 22:29:50 -0800 | [diff] [blame] | 499 | if (len <= 1) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 500 | return 0; |
| 501 | if (n > halflen || n < -halflen) { |
| 502 | n %= len; |
| 503 | if (n > halflen) |
| 504 | n -= len; |
| 505 | else if (n < -halflen) |
| 506 | n += len; |
| 507 | } |
Raymond Hettinger | 1f0044c | 2013-02-05 01:30:46 -0500 | [diff] [blame] | 508 | assert(len > 1); |
Raymond Hettinger | a4409c1 | 2013-02-04 00:08:12 -0500 | [diff] [blame] | 509 | assert(-halflen <= n && n <= halflen); |
Raymond Hettinger | 231ee4d | 2013-02-02 11:24:43 -0800 | [diff] [blame] | 510 | |
Raymond Hettinger | 464d89b | 2013-01-11 22:29:50 -0800 | [diff] [blame] | 511 | deque->state++; |
Raymond Hettinger | 1f0044c | 2013-02-05 01:30:46 -0500 | [diff] [blame] | 512 | while (n > 0) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 513 | if (leftindex == 0) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 514 | if (b == NULL) { |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 515 | b = newblock(len); |
| 516 | if (b == NULL) |
| 517 | goto done; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 518 | } |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 519 | b->rightlink = leftblock; |
| 520 | CHECK_END(leftblock->leftlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 521 | leftblock->leftlink = b; |
| 522 | leftblock = b; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 523 | MARK_END(b->leftlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 524 | leftindex = BLOCKLEN; |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 525 | b = NULL; |
Raymond Hettinger | 464d89b | 2013-01-11 22:29:50 -0800 | [diff] [blame] | 526 | } |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 527 | assert(leftindex > 0); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 528 | { |
| 529 | PyObject **src, **dest; |
| 530 | Py_ssize_t m = n; |
Raymond Hettinger | 21777ac | 2013-02-02 09:56:08 -0800 | [diff] [blame] | 531 | |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 532 | if (m > rightindex + 1) |
| 533 | m = rightindex + 1; |
| 534 | if (m > leftindex) |
| 535 | m = leftindex; |
| 536 | assert (m > 0 && m <= len); |
| 537 | src = &rightblock->data[rightindex]; |
| 538 | dest = &leftblock->data[leftindex - 1]; |
| 539 | rightindex -= m; |
| 540 | leftindex -= m; |
| 541 | n -= m; |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 542 | do { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 543 | *(dest--) = *(src--); |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 544 | } while (--m); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 545 | } |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 546 | if (rightindex == -1) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 547 | assert(leftblock != rightblock); |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 548 | assert(b == NULL); |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 549 | b = rightblock; |
Raymond Hettinger | b97cc49 | 2013-07-21 01:51:07 -0700 | [diff] [blame] | 550 | CHECK_NOT_END(rightblock->leftlink); |
| 551 | rightblock = rightblock->leftlink; |
| 552 | MARK_END(rightblock->rightlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 553 | rightindex = BLOCKLEN - 1; |
Raymond Hettinger | 464d89b | 2013-01-11 22:29:50 -0800 | [diff] [blame] | 554 | } |
Raymond Hettinger | 21777ac | 2013-02-02 09:56:08 -0800 | [diff] [blame] | 555 | } |
Raymond Hettinger | 1f0044c | 2013-02-05 01:30:46 -0500 | [diff] [blame] | 556 | while (n < 0) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 557 | if (rightindex == BLOCKLEN - 1) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 558 | if (b == NULL) { |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 559 | b = newblock(len); |
| 560 | if (b == NULL) |
| 561 | goto done; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 562 | } |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 563 | b->leftlink = rightblock; |
| 564 | CHECK_END(rightblock->rightlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 565 | rightblock->rightlink = b; |
| 566 | rightblock = b; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 567 | MARK_END(b->rightlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 568 | rightindex = -1; |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 569 | b = NULL; |
Raymond Hettinger | 464d89b | 2013-01-11 22:29:50 -0800 | [diff] [blame] | 570 | } |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 571 | assert (rightindex < BLOCKLEN - 1); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 572 | { |
| 573 | PyObject **src, **dest; |
| 574 | Py_ssize_t m = -n; |
Raymond Hettinger | 21777ac | 2013-02-02 09:56:08 -0800 | [diff] [blame] | 575 | |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 576 | if (m > BLOCKLEN - leftindex) |
| 577 | m = BLOCKLEN - leftindex; |
| 578 | if (m > BLOCKLEN - 1 - rightindex) |
| 579 | m = BLOCKLEN - 1 - rightindex; |
| 580 | assert (m > 0 && m <= len); |
| 581 | src = &leftblock->data[leftindex]; |
| 582 | dest = &rightblock->data[rightindex + 1]; |
| 583 | leftindex += m; |
| 584 | rightindex += m; |
| 585 | n += m; |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 586 | do { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 587 | *(dest++) = *(src++); |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 588 | } while (--m); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 589 | } |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 590 | if (leftindex == BLOCKLEN) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 591 | assert(leftblock != rightblock); |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 592 | assert(b == NULL); |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 593 | b = leftblock; |
Raymond Hettinger | b97cc49 | 2013-07-21 01:51:07 -0700 | [diff] [blame] | 594 | CHECK_NOT_END(leftblock->rightlink); |
| 595 | leftblock = leftblock->rightlink; |
| 596 | MARK_END(leftblock->leftlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 597 | leftindex = 0; |
Raymond Hettinger | 21777ac | 2013-02-02 09:56:08 -0800 | [diff] [blame] | 598 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 599 | } |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 600 | rv = 0; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 601 | done: |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 602 | if (b != NULL) |
| 603 | freeblock(b); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 604 | deque->leftblock = leftblock; |
| 605 | deque->rightblock = rightblock; |
| 606 | deque->leftindex = leftindex; |
| 607 | deque->rightindex = rightindex; |
| 608 | |
| 609 | return rv; |
Raymond Hettinger | dcb9d94 | 2004-10-09 16:02:18 +0000 | [diff] [blame] | 610 | } |
| 611 | |
| 612 | static PyObject * |
| 613 | deque_rotate(dequeobject *deque, PyObject *args) |
| 614 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 615 | Py_ssize_t n=1; |
Raymond Hettinger | dcb9d94 | 2004-10-09 16:02:18 +0000 | [diff] [blame] | 616 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 617 | if (!PyArg_ParseTuple(args, "|n:rotate", &n)) |
| 618 | return NULL; |
| 619 | if (_deque_rotate(deque, n) == 0) |
| 620 | Py_RETURN_NONE; |
| 621 | return NULL; |
Raymond Hettinger | 5c5eb86 | 2004-02-07 21:13:00 +0000 | [diff] [blame] | 622 | } |
| 623 | |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 624 | PyDoc_STRVAR(rotate_doc, |
Raymond Hettinger | ee33b27 | 2004-02-08 04:05:26 +0000 | [diff] [blame] | 625 | "Rotate the deque n steps to the right (default n=1). If n is negative, rotates left."); |
Raymond Hettinger | 5c5eb86 | 2004-02-07 21:13:00 +0000 | [diff] [blame] | 626 | |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 627 | static PyObject * |
| 628 | deque_reverse(dequeobject *deque, PyObject *unused) |
| 629 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 630 | block *leftblock = deque->leftblock; |
| 631 | block *rightblock = deque->rightblock; |
| 632 | Py_ssize_t leftindex = deque->leftindex; |
| 633 | Py_ssize_t rightindex = deque->rightindex; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 634 | Py_ssize_t n = (Py_SIZE(deque))/2; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 635 | Py_ssize_t i; |
| 636 | PyObject *tmp; |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 637 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 638 | for (i=0 ; i<n ; i++) { |
| 639 | /* Validate that pointers haven't met in the middle */ |
| 640 | assert(leftblock != rightblock || leftindex < rightindex); |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 641 | CHECK_NOT_END(leftblock); |
| 642 | CHECK_NOT_END(rightblock); |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 643 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 644 | /* Swap */ |
| 645 | tmp = leftblock->data[leftindex]; |
| 646 | leftblock->data[leftindex] = rightblock->data[rightindex]; |
| 647 | rightblock->data[rightindex] = tmp; |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 648 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 649 | /* Advance left block/index pair */ |
| 650 | leftindex++; |
| 651 | if (leftindex == BLOCKLEN) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 652 | leftblock = leftblock->rightlink; |
| 653 | leftindex = 0; |
| 654 | } |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 655 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 656 | /* Step backwards with the right block/index pair */ |
| 657 | rightindex--; |
| 658 | if (rightindex == -1) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 659 | rightblock = rightblock->leftlink; |
| 660 | rightindex = BLOCKLEN - 1; |
| 661 | } |
| 662 | } |
| 663 | Py_RETURN_NONE; |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 664 | } |
| 665 | |
| 666 | PyDoc_STRVAR(reverse_doc, |
| 667 | "D.reverse() -- reverse *IN PLACE*"); |
| 668 | |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 669 | static PyObject * |
| 670 | deque_count(dequeobject *deque, PyObject *v) |
| 671 | { |
Raymond Hettinger | f3a67b7 | 2013-07-06 17:49:06 -1000 | [diff] [blame] | 672 | block *b = deque->leftblock; |
| 673 | Py_ssize_t index = deque->leftindex; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 674 | Py_ssize_t n = Py_SIZE(deque); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 675 | Py_ssize_t i; |
| 676 | Py_ssize_t count = 0; |
| 677 | PyObject *item; |
| 678 | long start_state = deque->state; |
| 679 | int cmp; |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 680 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 681 | for (i=0 ; i<n ; i++) { |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 682 | CHECK_NOT_END(b); |
Raymond Hettinger | f3a67b7 | 2013-07-06 17:49:06 -1000 | [diff] [blame] | 683 | item = b->data[index]; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 684 | cmp = PyObject_RichCompareBool(item, v, Py_EQ); |
| 685 | if (cmp > 0) |
| 686 | count++; |
| 687 | else if (cmp < 0) |
| 688 | return NULL; |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 689 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 690 | if (start_state != deque->state) { |
| 691 | PyErr_SetString(PyExc_RuntimeError, |
| 692 | "deque mutated during iteration"); |
| 693 | return NULL; |
| 694 | } |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 695 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 696 | /* Advance left block/index pair */ |
Raymond Hettinger | f3a67b7 | 2013-07-06 17:49:06 -1000 | [diff] [blame] | 697 | index++; |
| 698 | if (index == BLOCKLEN) { |
| 699 | b = b->rightlink; |
| 700 | index = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 701 | } |
| 702 | } |
| 703 | return PyLong_FromSsize_t(count); |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 704 | } |
| 705 | |
| 706 | PyDoc_STRVAR(count_doc, |
| 707 | "D.count(value) -> integer -- return number of occurrences of value"); |
| 708 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 709 | static Py_ssize_t |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 710 | deque_len(dequeobject *deque) |
| 711 | { |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 712 | return Py_SIZE(deque); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 713 | } |
| 714 | |
Raymond Hettinger | 4aec61e | 2005-03-18 21:20:23 +0000 | [diff] [blame] | 715 | static PyObject * |
| 716 | deque_remove(dequeobject *deque, PyObject *value) |
| 717 | { |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 718 | Py_ssize_t i, n=Py_SIZE(deque); |
Raymond Hettinger | 4aec61e | 2005-03-18 21:20:23 +0000 | [diff] [blame] | 719 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 720 | for (i=0 ; i<n ; i++) { |
| 721 | PyObject *item = deque->leftblock->data[deque->leftindex]; |
| 722 | int cmp = PyObject_RichCompareBool(item, value, Py_EQ); |
Raymond Hettinger | d73202c | 2005-03-19 00:00:51 +0000 | [diff] [blame] | 723 | |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 724 | if (Py_SIZE(deque) != n) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 725 | PyErr_SetString(PyExc_IndexError, |
| 726 | "deque mutated during remove()."); |
| 727 | return NULL; |
| 728 | } |
| 729 | if (cmp > 0) { |
| 730 | PyObject *tgt = deque_popleft(deque, NULL); |
| 731 | assert (tgt != NULL); |
| 732 | Py_DECREF(tgt); |
| 733 | if (_deque_rotate(deque, i) == -1) |
| 734 | return NULL; |
| 735 | Py_RETURN_NONE; |
| 736 | } |
| 737 | else if (cmp < 0) { |
| 738 | _deque_rotate(deque, i); |
| 739 | return NULL; |
| 740 | } |
| 741 | _deque_rotate(deque, -1); |
| 742 | } |
| 743 | PyErr_SetString(PyExc_ValueError, "deque.remove(x): x not in deque"); |
| 744 | return NULL; |
Raymond Hettinger | 4aec61e | 2005-03-18 21:20:23 +0000 | [diff] [blame] | 745 | } |
| 746 | |
| 747 | PyDoc_STRVAR(remove_doc, |
| 748 | "D.remove(value) -- remove first occurrence of value."); |
| 749 | |
Benjamin Peterson | 0e5c48a | 2013-01-12 21:22:18 -0500 | [diff] [blame] | 750 | static void |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 751 | deque_clear(dequeobject *deque) |
| 752 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 753 | PyObject *item; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 754 | |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 755 | while (Py_SIZE(deque)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 756 | item = deque_pop(deque, NULL); |
| 757 | assert (item != NULL); |
| 758 | Py_DECREF(item); |
| 759 | } |
| 760 | assert(deque->leftblock == deque->rightblock && |
| 761 | deque->leftindex - 1 == deque->rightindex && |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 762 | Py_SIZE(deque) == 0); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 763 | } |
| 764 | |
| 765 | static PyObject * |
Benjamin Peterson | d631371 | 2008-07-31 16:23:04 +0000 | [diff] [blame] | 766 | deque_item(dequeobject *deque, Py_ssize_t i) |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 767 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 768 | block *b; |
| 769 | PyObject *item; |
| 770 | Py_ssize_t n, index=i; |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 771 | |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 772 | if (i < 0 || i >= Py_SIZE(deque)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 773 | PyErr_SetString(PyExc_IndexError, |
| 774 | "deque index out of range"); |
| 775 | return NULL; |
| 776 | } |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 777 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 778 | if (i == 0) { |
| 779 | i = deque->leftindex; |
| 780 | b = deque->leftblock; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 781 | } else if (i == Py_SIZE(deque) - 1) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 782 | i = deque->rightindex; |
| 783 | b = deque->rightblock; |
| 784 | } else { |
| 785 | i += deque->leftindex; |
| 786 | n = i / BLOCKLEN; |
| 787 | i %= BLOCKLEN; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 788 | if (index < (Py_SIZE(deque) >> 1)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 789 | b = deque->leftblock; |
| 790 | while (n--) |
| 791 | b = b->rightlink; |
| 792 | } else { |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 793 | n = (deque->leftindex + Py_SIZE(deque) - 1) / BLOCKLEN - n; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 794 | b = deque->rightblock; |
| 795 | while (n--) |
| 796 | b = b->leftlink; |
| 797 | } |
| 798 | } |
| 799 | item = b->data[i]; |
| 800 | Py_INCREF(item); |
| 801 | return item; |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 802 | } |
| 803 | |
Raymond Hettinger | 616f4f6 | 2004-06-26 04:42:06 +0000 | [diff] [blame] | 804 | /* delitem() implemented in terms of rotate for simplicity and reasonable |
| 805 | performance near the end points. If for some reason this method becomes |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 806 | popular, it is not hard to re-implement this using direct data movement |
Raymond Hettinger | 616f4f6 | 2004-06-26 04:42:06 +0000 | [diff] [blame] | 807 | (similar to code in list slice assignment) and achieve a two or threefold |
| 808 | performance boost. |
| 809 | */ |
| 810 | |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 811 | static int |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 812 | deque_del_item(dequeobject *deque, Py_ssize_t i) |
Raymond Hettinger | 0e371f2 | 2004-05-12 20:55:56 +0000 | [diff] [blame] | 813 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 814 | PyObject *item; |
Raymond Hettinger | 0e371f2 | 2004-05-12 20:55:56 +0000 | [diff] [blame] | 815 | |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 816 | assert (i >= 0 && i < Py_SIZE(deque)); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 817 | if (_deque_rotate(deque, -i) == -1) |
| 818 | return -1; |
Raymond Hettinger | 0e371f2 | 2004-05-12 20:55:56 +0000 | [diff] [blame] | 819 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 820 | item = deque_popleft(deque, NULL); |
| 821 | assert (item != NULL); |
| 822 | Py_DECREF(item); |
Raymond Hettinger | 0e371f2 | 2004-05-12 20:55:56 +0000 | [diff] [blame] | 823 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 824 | return _deque_rotate(deque, i); |
Raymond Hettinger | 0e371f2 | 2004-05-12 20:55:56 +0000 | [diff] [blame] | 825 | } |
| 826 | |
| 827 | static int |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 828 | deque_ass_item(dequeobject *deque, Py_ssize_t i, PyObject *v) |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 829 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 830 | PyObject *old_value; |
| 831 | block *b; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 832 | Py_ssize_t n, len=Py_SIZE(deque), halflen=(len+1)>>1, index=i; |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 833 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 834 | if (i < 0 || i >= len) { |
| 835 | PyErr_SetString(PyExc_IndexError, |
| 836 | "deque index out of range"); |
| 837 | return -1; |
| 838 | } |
| 839 | if (v == NULL) |
| 840 | return deque_del_item(deque, i); |
Raymond Hettinger | 0e371f2 | 2004-05-12 20:55:56 +0000 | [diff] [blame] | 841 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 842 | i += deque->leftindex; |
| 843 | n = i / BLOCKLEN; |
| 844 | i %= BLOCKLEN; |
| 845 | if (index <= halflen) { |
| 846 | b = deque->leftblock; |
| 847 | while (n--) |
| 848 | b = b->rightlink; |
| 849 | } else { |
| 850 | n = (deque->leftindex + len - 1) / BLOCKLEN - n; |
| 851 | b = deque->rightblock; |
| 852 | while (n--) |
| 853 | b = b->leftlink; |
| 854 | } |
| 855 | Py_INCREF(v); |
| 856 | old_value = b->data[i]; |
| 857 | b->data[i] = v; |
| 858 | Py_DECREF(old_value); |
| 859 | return 0; |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 860 | } |
| 861 | |
| 862 | static PyObject * |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 863 | deque_clearmethod(dequeobject *deque) |
| 864 | { |
Benjamin Peterson | 0e5c48a | 2013-01-12 21:22:18 -0500 | [diff] [blame] | 865 | deque_clear(deque); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 866 | Py_RETURN_NONE; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 867 | } |
| 868 | |
| 869 | PyDoc_STRVAR(clear_doc, "Remove all elements from the deque."); |
| 870 | |
| 871 | static void |
| 872 | deque_dealloc(dequeobject *deque) |
| 873 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 874 | PyObject_GC_UnTrack(deque); |
| 875 | if (deque->weakreflist != NULL) |
| 876 | PyObject_ClearWeakRefs((PyObject *) deque); |
| 877 | if (deque->leftblock != NULL) { |
| 878 | deque_clear(deque); |
| 879 | assert(deque->leftblock != NULL); |
| 880 | freeblock(deque->leftblock); |
| 881 | } |
| 882 | deque->leftblock = NULL; |
| 883 | deque->rightblock = NULL; |
| 884 | Py_TYPE(deque)->tp_free(deque); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 885 | } |
| 886 | |
| 887 | static int |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 888 | deque_traverse(dequeobject *deque, visitproc visit, void *arg) |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 889 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 890 | block *b; |
| 891 | PyObject *item; |
| 892 | Py_ssize_t index; |
| 893 | Py_ssize_t indexlo = deque->leftindex; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 894 | |
Raymond Hettinger | 5bfa867 | 2013-07-06 11:58:09 -1000 | [diff] [blame] | 895 | for (b = deque->leftblock; b != deque->rightblock; b = b->rightlink) { |
| 896 | for (index = indexlo; index < BLOCKLEN ; index++) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 897 | item = b->data[index]; |
| 898 | Py_VISIT(item); |
| 899 | } |
| 900 | indexlo = 0; |
| 901 | } |
Raymond Hettinger | 5bfa867 | 2013-07-06 11:58:09 -1000 | [diff] [blame] | 902 | for (index = indexlo; index <= deque->rightindex; index++) { |
| 903 | item = b->data[index]; |
| 904 | Py_VISIT(item); |
| 905 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 906 | return 0; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 907 | } |
| 908 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 909 | static PyObject * |
| 910 | deque_copy(PyObject *deque) |
| 911 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 912 | if (((dequeobject *)deque)->maxlen == -1) |
| 913 | return PyObject_CallFunction((PyObject *)(Py_TYPE(deque)), "O", deque, NULL); |
| 914 | else |
| 915 | return PyObject_CallFunction((PyObject *)(Py_TYPE(deque)), "Oi", |
| 916 | deque, ((dequeobject *)deque)->maxlen, NULL); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 917 | } |
| 918 | |
| 919 | PyDoc_STRVAR(copy_doc, "Return a shallow copy of a deque."); |
| 920 | |
| 921 | static PyObject * |
| 922 | deque_reduce(dequeobject *deque) |
| 923 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 924 | PyObject *dict, *result, *aslist; |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 925 | _Py_IDENTIFIER(__dict__); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 926 | |
Martin v. Löwis | 1ee1b6f | 2011-10-10 18:11:30 +0200 | [diff] [blame] | 927 | dict = _PyObject_GetAttrId((PyObject *)deque, &PyId___dict__); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 928 | if (dict == NULL) |
| 929 | PyErr_Clear(); |
| 930 | aslist = PySequence_List((PyObject *)deque); |
| 931 | if (aslist == NULL) { |
| 932 | Py_XDECREF(dict); |
| 933 | return NULL; |
| 934 | } |
| 935 | if (dict == NULL) { |
| 936 | if (deque->maxlen == -1) |
| 937 | result = Py_BuildValue("O(O)", Py_TYPE(deque), aslist); |
| 938 | else |
| 939 | result = Py_BuildValue("O(On)", Py_TYPE(deque), aslist, deque->maxlen); |
| 940 | } else { |
| 941 | if (deque->maxlen == -1) |
| 942 | result = Py_BuildValue("O(OO)O", Py_TYPE(deque), aslist, Py_None, dict); |
| 943 | else |
| 944 | result = Py_BuildValue("O(On)O", Py_TYPE(deque), aslist, deque->maxlen, dict); |
| 945 | } |
| 946 | Py_XDECREF(dict); |
| 947 | Py_DECREF(aslist); |
| 948 | return result; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 949 | } |
| 950 | |
| 951 | PyDoc_STRVAR(reduce_doc, "Return state information for pickling."); |
| 952 | |
| 953 | static PyObject * |
| 954 | deque_repr(PyObject *deque) |
| 955 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 956 | PyObject *aslist, *result; |
| 957 | int i; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 958 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 959 | i = Py_ReprEnter(deque); |
| 960 | if (i != 0) { |
| 961 | if (i < 0) |
| 962 | return NULL; |
| 963 | return PyUnicode_FromString("[...]"); |
| 964 | } |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 965 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 966 | aslist = PySequence_List(deque); |
| 967 | if (aslist == NULL) { |
| 968 | Py_ReprLeave(deque); |
| 969 | return NULL; |
| 970 | } |
| 971 | if (((dequeobject *)deque)->maxlen != -1) |
Benjamin Peterson | a786b02 | 2008-08-25 21:05:21 +0000 | [diff] [blame] | 972 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 973 | result = PyUnicode_FromFormat("deque(%R, maxlen=%zd)", |
| 974 | aslist, ((dequeobject *)deque)->maxlen); |
| 975 | else |
| 976 | result = PyUnicode_FromFormat("deque(%R)", aslist); |
| 977 | Py_DECREF(aslist); |
| 978 | Py_ReprLeave(deque); |
| 979 | return result; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 980 | } |
| 981 | |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 982 | static PyObject * |
| 983 | deque_richcompare(PyObject *v, PyObject *w, int op) |
| 984 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 985 | PyObject *it1=NULL, *it2=NULL, *x, *y; |
| 986 | Py_ssize_t vs, ws; |
| 987 | int b, cmp=-1; |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 988 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 989 | if (!PyObject_TypeCheck(v, &deque_type) || |
| 990 | !PyObject_TypeCheck(w, &deque_type)) { |
Brian Curtin | dfc80e3 | 2011-08-10 20:28:54 -0500 | [diff] [blame] | 991 | Py_RETURN_NOTIMPLEMENTED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 992 | } |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 993 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 994 | /* Shortcuts */ |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 995 | vs = Py_SIZE((dequeobject *)v); |
| 996 | ws = Py_SIZE((dequeobject *)w); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 997 | if (op == Py_EQ) { |
| 998 | if (v == w) |
| 999 | Py_RETURN_TRUE; |
| 1000 | if (vs != ws) |
| 1001 | Py_RETURN_FALSE; |
| 1002 | } |
| 1003 | if (op == Py_NE) { |
| 1004 | if (v == w) |
| 1005 | Py_RETURN_FALSE; |
| 1006 | if (vs != ws) |
| 1007 | Py_RETURN_TRUE; |
| 1008 | } |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 1009 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1010 | /* Search for the first index where items are different */ |
| 1011 | it1 = PyObject_GetIter(v); |
| 1012 | if (it1 == NULL) |
| 1013 | goto done; |
| 1014 | it2 = PyObject_GetIter(w); |
| 1015 | if (it2 == NULL) |
| 1016 | goto done; |
| 1017 | for (;;) { |
| 1018 | x = PyIter_Next(it1); |
| 1019 | if (x == NULL && PyErr_Occurred()) |
| 1020 | goto done; |
| 1021 | y = PyIter_Next(it2); |
| 1022 | if (x == NULL || y == NULL) |
| 1023 | break; |
| 1024 | b = PyObject_RichCompareBool(x, y, Py_EQ); |
| 1025 | if (b == 0) { |
| 1026 | cmp = PyObject_RichCompareBool(x, y, op); |
| 1027 | Py_DECREF(x); |
| 1028 | Py_DECREF(y); |
| 1029 | goto done; |
| 1030 | } |
| 1031 | Py_DECREF(x); |
| 1032 | Py_DECREF(y); |
| 1033 | if (b == -1) |
| 1034 | goto done; |
| 1035 | } |
| 1036 | /* We reached the end of one deque or both */ |
| 1037 | Py_XDECREF(x); |
| 1038 | Py_XDECREF(y); |
| 1039 | if (PyErr_Occurred()) |
| 1040 | goto done; |
| 1041 | switch (op) { |
| 1042 | case Py_LT: cmp = y != NULL; break; /* if w was longer */ |
| 1043 | case Py_LE: cmp = x == NULL; break; /* if v was not longer */ |
| 1044 | case Py_EQ: cmp = x == y; break; /* if we reached the end of both */ |
| 1045 | case Py_NE: cmp = x != y; break; /* if one deque continues */ |
| 1046 | case Py_GT: cmp = x != NULL; break; /* if v was longer */ |
| 1047 | case Py_GE: cmp = y == NULL; break; /* if w was not longer */ |
| 1048 | } |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 1049 | |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 1050 | done: |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1051 | Py_XDECREF(it1); |
| 1052 | Py_XDECREF(it2); |
| 1053 | if (cmp == 1) |
| 1054 | Py_RETURN_TRUE; |
| 1055 | if (cmp == 0) |
| 1056 | Py_RETURN_FALSE; |
| 1057 | return NULL; |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 1058 | } |
| 1059 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1060 | static int |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 1061 | deque_init(dequeobject *deque, PyObject *args, PyObject *kwdargs) |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1062 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1063 | PyObject *iterable = NULL; |
| 1064 | PyObject *maxlenobj = NULL; |
| 1065 | Py_ssize_t maxlen = -1; |
| 1066 | char *kwlist[] = {"iterable", "maxlen", 0}; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1067 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1068 | if (!PyArg_ParseTupleAndKeywords(args, kwdargs, "|OO:deque", kwlist, &iterable, &maxlenobj)) |
| 1069 | return -1; |
| 1070 | if (maxlenobj != NULL && maxlenobj != Py_None) { |
| 1071 | maxlen = PyLong_AsSsize_t(maxlenobj); |
| 1072 | if (maxlen == -1 && PyErr_Occurred()) |
| 1073 | return -1; |
| 1074 | if (maxlen < 0) { |
| 1075 | PyErr_SetString(PyExc_ValueError, "maxlen must be non-negative"); |
| 1076 | return -1; |
| 1077 | } |
| 1078 | } |
| 1079 | deque->maxlen = maxlen; |
| 1080 | deque_clear(deque); |
| 1081 | if (iterable != NULL) { |
| 1082 | PyObject *rv = deque_extend(deque, iterable); |
| 1083 | if (rv == NULL) |
| 1084 | return -1; |
| 1085 | Py_DECREF(rv); |
| 1086 | } |
| 1087 | return 0; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1088 | } |
| 1089 | |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 1090 | static PyObject * |
Jesus Cea | 16e2fca | 2012-08-03 14:49:42 +0200 | [diff] [blame] | 1091 | deque_sizeof(dequeobject *deque, void *unused) |
| 1092 | { |
| 1093 | Py_ssize_t res; |
| 1094 | Py_ssize_t blocks; |
| 1095 | |
| 1096 | res = sizeof(dequeobject); |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1097 | blocks = (deque->leftindex + Py_SIZE(deque) + BLOCKLEN - 1) / BLOCKLEN; |
| 1098 | assert(deque->leftindex + Py_SIZE(deque) - 1 == |
Jesus Cea | 16e2fca | 2012-08-03 14:49:42 +0200 | [diff] [blame] | 1099 | (blocks - 1) * BLOCKLEN + deque->rightindex); |
| 1100 | res += blocks * sizeof(block); |
| 1101 | return PyLong_FromSsize_t(res); |
| 1102 | } |
| 1103 | |
| 1104 | PyDoc_STRVAR(sizeof_doc, |
| 1105 | "D.__sizeof__() -- size of D in memory, in bytes"); |
| 1106 | |
| 1107 | static PyObject * |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 1108 | deque_get_maxlen(dequeobject *deque) |
| 1109 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1110 | if (deque->maxlen == -1) |
| 1111 | Py_RETURN_NONE; |
| 1112 | return PyLong_FromSsize_t(deque->maxlen); |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 1113 | } |
| 1114 | |
| 1115 | static PyGetSetDef deque_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1116 | {"maxlen", (getter)deque_get_maxlen, (setter)NULL, |
| 1117 | "maximum size of a deque or None if unbounded"}, |
| 1118 | {0} |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 1119 | }; |
| 1120 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1121 | static PySequenceMethods deque_as_sequence = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1122 | (lenfunc)deque_len, /* sq_length */ |
| 1123 | 0, /* sq_concat */ |
| 1124 | 0, /* sq_repeat */ |
| 1125 | (ssizeargfunc)deque_item, /* sq_item */ |
| 1126 | 0, /* sq_slice */ |
| 1127 | (ssizeobjargproc)deque_ass_item, /* sq_ass_item */ |
| 1128 | 0, /* sq_ass_slice */ |
| 1129 | 0, /* sq_contains */ |
| 1130 | (binaryfunc)deque_inplace_concat, /* sq_inplace_concat */ |
| 1131 | 0, /* sq_inplace_repeat */ |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 1132 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1133 | }; |
| 1134 | |
| 1135 | /* deque object ********************************************************/ |
| 1136 | |
| 1137 | static PyObject *deque_iter(dequeobject *deque); |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1138 | static PyObject *deque_reviter(dequeobject *deque); |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 1139 | PyDoc_STRVAR(reversed_doc, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1140 | "D.__reversed__() -- return a reverse iterator over the deque"); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1141 | |
| 1142 | static PyMethodDef deque_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1143 | {"append", (PyCFunction)deque_append, |
| 1144 | METH_O, append_doc}, |
| 1145 | {"appendleft", (PyCFunction)deque_appendleft, |
| 1146 | METH_O, appendleft_doc}, |
| 1147 | {"clear", (PyCFunction)deque_clearmethod, |
| 1148 | METH_NOARGS, clear_doc}, |
| 1149 | {"__copy__", (PyCFunction)deque_copy, |
| 1150 | METH_NOARGS, copy_doc}, |
| 1151 | {"count", (PyCFunction)deque_count, |
| 1152 | METH_O, count_doc}, |
| 1153 | {"extend", (PyCFunction)deque_extend, |
| 1154 | METH_O, extend_doc}, |
| 1155 | {"extendleft", (PyCFunction)deque_extendleft, |
| 1156 | METH_O, extendleft_doc}, |
| 1157 | {"pop", (PyCFunction)deque_pop, |
| 1158 | METH_NOARGS, pop_doc}, |
| 1159 | {"popleft", (PyCFunction)deque_popleft, |
| 1160 | METH_NOARGS, popleft_doc}, |
| 1161 | {"__reduce__", (PyCFunction)deque_reduce, |
| 1162 | METH_NOARGS, reduce_doc}, |
| 1163 | {"remove", (PyCFunction)deque_remove, |
| 1164 | METH_O, remove_doc}, |
| 1165 | {"__reversed__", (PyCFunction)deque_reviter, |
| 1166 | METH_NOARGS, reversed_doc}, |
| 1167 | {"reverse", (PyCFunction)deque_reverse, |
| 1168 | METH_NOARGS, reverse_doc}, |
| 1169 | {"rotate", (PyCFunction)deque_rotate, |
Jesus Cea | 16e2fca | 2012-08-03 14:49:42 +0200 | [diff] [blame] | 1170 | METH_VARARGS, rotate_doc}, |
| 1171 | {"__sizeof__", (PyCFunction)deque_sizeof, |
| 1172 | METH_NOARGS, sizeof_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1173 | {NULL, NULL} /* sentinel */ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1174 | }; |
| 1175 | |
| 1176 | PyDoc_STRVAR(deque_doc, |
Andrew Svetlov | 6a5c7c3 | 2012-10-31 11:50:40 +0200 | [diff] [blame] | 1177 | "deque([iterable[, maxlen]]) --> deque object\n\ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1178 | \n\ |
Raymond Hettinger | 4974705 | 2011-03-29 17:36:31 -0700 | [diff] [blame] | 1179 | Build an ordered collection with optimized access from its endpoints."); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1180 | |
Neal Norwitz | 87f1013 | 2004-02-29 15:40:53 +0000 | [diff] [blame] | 1181 | static PyTypeObject deque_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1182 | PyVarObject_HEAD_INIT(NULL, 0) |
| 1183 | "collections.deque", /* tp_name */ |
| 1184 | sizeof(dequeobject), /* tp_basicsize */ |
| 1185 | 0, /* tp_itemsize */ |
| 1186 | /* methods */ |
| 1187 | (destructor)deque_dealloc, /* tp_dealloc */ |
| 1188 | 0, /* tp_print */ |
| 1189 | 0, /* tp_getattr */ |
| 1190 | 0, /* tp_setattr */ |
| 1191 | 0, /* tp_reserved */ |
| 1192 | deque_repr, /* tp_repr */ |
| 1193 | 0, /* tp_as_number */ |
| 1194 | &deque_as_sequence, /* tp_as_sequence */ |
| 1195 | 0, /* tp_as_mapping */ |
Georg Brandl | f038b32 | 2010-10-18 07:35:09 +0000 | [diff] [blame] | 1196 | PyObject_HashNotImplemented, /* tp_hash */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1197 | 0, /* tp_call */ |
| 1198 | 0, /* tp_str */ |
| 1199 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 1200 | 0, /* tp_setattro */ |
| 1201 | 0, /* tp_as_buffer */ |
| 1202 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, |
Georg Brandl | f038b32 | 2010-10-18 07:35:09 +0000 | [diff] [blame] | 1203 | /* tp_flags */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1204 | deque_doc, /* tp_doc */ |
| 1205 | (traverseproc)deque_traverse, /* tp_traverse */ |
| 1206 | (inquiry)deque_clear, /* tp_clear */ |
| 1207 | (richcmpfunc)deque_richcompare, /* tp_richcompare */ |
Georg Brandl | f038b32 | 2010-10-18 07:35:09 +0000 | [diff] [blame] | 1208 | offsetof(dequeobject, weakreflist), /* tp_weaklistoffset*/ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1209 | (getiterfunc)deque_iter, /* tp_iter */ |
| 1210 | 0, /* tp_iternext */ |
| 1211 | deque_methods, /* tp_methods */ |
| 1212 | 0, /* tp_members */ |
Georg Brandl | f038b32 | 2010-10-18 07:35:09 +0000 | [diff] [blame] | 1213 | deque_getset, /* tp_getset */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1214 | 0, /* tp_base */ |
| 1215 | 0, /* tp_dict */ |
| 1216 | 0, /* tp_descr_get */ |
| 1217 | 0, /* tp_descr_set */ |
| 1218 | 0, /* tp_dictoffset */ |
| 1219 | (initproc)deque_init, /* tp_init */ |
| 1220 | PyType_GenericAlloc, /* tp_alloc */ |
| 1221 | deque_new, /* tp_new */ |
| 1222 | PyObject_GC_Del, /* tp_free */ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1223 | }; |
| 1224 | |
| 1225 | /*********************** Deque Iterator **************************/ |
| 1226 | |
| 1227 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1228 | PyObject_HEAD |
| 1229 | Py_ssize_t index; |
| 1230 | block *b; |
| 1231 | dequeobject *deque; |
| 1232 | long state; /* state when the iterator is created */ |
| 1233 | Py_ssize_t counter; /* number of items remaining for iteration */ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1234 | } dequeiterobject; |
| 1235 | |
Martin v. Löwis | 59683e8 | 2008-06-13 07:50:45 +0000 | [diff] [blame] | 1236 | static PyTypeObject dequeiter_type; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1237 | |
| 1238 | static PyObject * |
| 1239 | deque_iter(dequeobject *deque) |
| 1240 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1241 | dequeiterobject *it; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1242 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1243 | it = PyObject_GC_New(dequeiterobject, &dequeiter_type); |
| 1244 | if (it == NULL) |
| 1245 | return NULL; |
| 1246 | it->b = deque->leftblock; |
| 1247 | it->index = deque->leftindex; |
| 1248 | Py_INCREF(deque); |
| 1249 | it->deque = deque; |
| 1250 | it->state = deque->state; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1251 | it->counter = Py_SIZE(deque); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1252 | PyObject_GC_Track(it); |
| 1253 | return (PyObject *)it; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1254 | } |
| 1255 | |
Antoine Pitrou | 7ddda78 | 2009-01-01 15:35:33 +0000 | [diff] [blame] | 1256 | static int |
| 1257 | dequeiter_traverse(dequeiterobject *dio, visitproc visit, void *arg) |
| 1258 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1259 | Py_VISIT(dio->deque); |
| 1260 | return 0; |
Antoine Pitrou | 7ddda78 | 2009-01-01 15:35:33 +0000 | [diff] [blame] | 1261 | } |
| 1262 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1263 | static void |
| 1264 | dequeiter_dealloc(dequeiterobject *dio) |
| 1265 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1266 | Py_XDECREF(dio->deque); |
| 1267 | PyObject_GC_Del(dio); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1268 | } |
| 1269 | |
| 1270 | static PyObject * |
| 1271 | dequeiter_next(dequeiterobject *it) |
| 1272 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1273 | PyObject *item; |
Raymond Hettinger | d1b3d88 | 2004-10-02 00:43:13 +0000 | [diff] [blame] | 1274 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1275 | if (it->deque->state != it->state) { |
| 1276 | it->counter = 0; |
| 1277 | PyErr_SetString(PyExc_RuntimeError, |
| 1278 | "deque mutated during iteration"); |
| 1279 | return NULL; |
| 1280 | } |
| 1281 | if (it->counter == 0) |
| 1282 | return NULL; |
| 1283 | assert (!(it->b == it->deque->rightblock && |
| 1284 | it->index > it->deque->rightindex)); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1285 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1286 | item = it->b->data[it->index]; |
| 1287 | it->index++; |
| 1288 | it->counter--; |
| 1289 | if (it->index == BLOCKLEN && it->counter > 0) { |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 1290 | CHECK_NOT_END(it->b->rightlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1291 | it->b = it->b->rightlink; |
| 1292 | it->index = 0; |
| 1293 | } |
| 1294 | Py_INCREF(item); |
| 1295 | return item; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1296 | } |
| 1297 | |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 1298 | static PyObject * |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1299 | dequeiter_new(PyTypeObject *type, PyObject *args, PyObject *kwds) |
| 1300 | { |
| 1301 | Py_ssize_t i, index=0; |
| 1302 | PyObject *deque; |
| 1303 | dequeiterobject *it; |
| 1304 | if (!PyArg_ParseTuple(args, "O!|n", &deque_type, &deque, &index)) |
| 1305 | return NULL; |
| 1306 | assert(type == &dequeiter_type); |
| 1307 | |
| 1308 | it = (dequeiterobject*)deque_iter((dequeobject *)deque); |
| 1309 | if (!it) |
| 1310 | return NULL; |
| 1311 | /* consume items from the queue */ |
| 1312 | for(i=0; i<index; i++) { |
| 1313 | PyObject *item = dequeiter_next(it); |
| 1314 | if (item) { |
| 1315 | Py_DECREF(item); |
| 1316 | } else { |
| 1317 | if (it->counter) { |
| 1318 | Py_DECREF(it); |
| 1319 | return NULL; |
| 1320 | } else |
| 1321 | break; |
| 1322 | } |
| 1323 | } |
| 1324 | return (PyObject*)it; |
| 1325 | } |
| 1326 | |
| 1327 | static PyObject * |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1328 | dequeiter_len(dequeiterobject *it) |
| 1329 | { |
Antoine Pitrou | 554f334 | 2010-08-17 18:30:06 +0000 | [diff] [blame] | 1330 | return PyLong_FromSsize_t(it->counter); |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1331 | } |
| 1332 | |
Armin Rigo | f5b3e36 | 2006-02-11 21:32:43 +0000 | [diff] [blame] | 1333 | PyDoc_STRVAR(length_hint_doc, "Private method returning an estimate of len(list(it))."); |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 1334 | |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1335 | static PyObject * |
| 1336 | dequeiter_reduce(dequeiterobject *it) |
| 1337 | { |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1338 | return Py_BuildValue("O(On)", Py_TYPE(it), it->deque, Py_SIZE(it->deque) - it->counter); |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1339 | } |
| 1340 | |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 1341 | static PyMethodDef dequeiter_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1342 | {"__length_hint__", (PyCFunction)dequeiter_len, METH_NOARGS, length_hint_doc}, |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1343 | {"__reduce__", (PyCFunction)dequeiter_reduce, METH_NOARGS, reduce_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1344 | {NULL, NULL} /* sentinel */ |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1345 | }; |
| 1346 | |
Martin v. Löwis | 59683e8 | 2008-06-13 07:50:45 +0000 | [diff] [blame] | 1347 | static PyTypeObject dequeiter_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1348 | PyVarObject_HEAD_INIT(NULL, 0) |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1349 | "_collections._deque_iterator", /* tp_name */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1350 | sizeof(dequeiterobject), /* tp_basicsize */ |
| 1351 | 0, /* tp_itemsize */ |
| 1352 | /* methods */ |
| 1353 | (destructor)dequeiter_dealloc, /* tp_dealloc */ |
| 1354 | 0, /* tp_print */ |
| 1355 | 0, /* tp_getattr */ |
| 1356 | 0, /* tp_setattr */ |
| 1357 | 0, /* tp_reserved */ |
| 1358 | 0, /* tp_repr */ |
| 1359 | 0, /* tp_as_number */ |
| 1360 | 0, /* tp_as_sequence */ |
| 1361 | 0, /* tp_as_mapping */ |
| 1362 | 0, /* tp_hash */ |
| 1363 | 0, /* tp_call */ |
| 1364 | 0, /* tp_str */ |
| 1365 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 1366 | 0, /* tp_setattro */ |
| 1367 | 0, /* tp_as_buffer */ |
| 1368 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */ |
| 1369 | 0, /* tp_doc */ |
| 1370 | (traverseproc)dequeiter_traverse, /* tp_traverse */ |
| 1371 | 0, /* tp_clear */ |
| 1372 | 0, /* tp_richcompare */ |
| 1373 | 0, /* tp_weaklistoffset */ |
| 1374 | PyObject_SelfIter, /* tp_iter */ |
| 1375 | (iternextfunc)dequeiter_next, /* tp_iternext */ |
| 1376 | dequeiter_methods, /* tp_methods */ |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1377 | 0, /* tp_members */ |
| 1378 | 0, /* tp_getset */ |
| 1379 | 0, /* tp_base */ |
| 1380 | 0, /* tp_dict */ |
| 1381 | 0, /* tp_descr_get */ |
| 1382 | 0, /* tp_descr_set */ |
| 1383 | 0, /* tp_dictoffset */ |
| 1384 | 0, /* tp_init */ |
| 1385 | 0, /* tp_alloc */ |
| 1386 | dequeiter_new, /* tp_new */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1387 | 0, |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1388 | }; |
| 1389 | |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1390 | /*********************** Deque Reverse Iterator **************************/ |
| 1391 | |
Martin v. Löwis | 59683e8 | 2008-06-13 07:50:45 +0000 | [diff] [blame] | 1392 | static PyTypeObject dequereviter_type; |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1393 | |
| 1394 | static PyObject * |
| 1395 | deque_reviter(dequeobject *deque) |
| 1396 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1397 | dequeiterobject *it; |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1398 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1399 | it = PyObject_GC_New(dequeiterobject, &dequereviter_type); |
| 1400 | if (it == NULL) |
| 1401 | return NULL; |
| 1402 | it->b = deque->rightblock; |
| 1403 | it->index = deque->rightindex; |
| 1404 | Py_INCREF(deque); |
| 1405 | it->deque = deque; |
| 1406 | it->state = deque->state; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1407 | it->counter = Py_SIZE(deque); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1408 | PyObject_GC_Track(it); |
| 1409 | return (PyObject *)it; |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1410 | } |
| 1411 | |
| 1412 | static PyObject * |
| 1413 | dequereviter_next(dequeiterobject *it) |
| 1414 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1415 | PyObject *item; |
| 1416 | if (it->counter == 0) |
| 1417 | return NULL; |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1418 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1419 | if (it->deque->state != it->state) { |
| 1420 | it->counter = 0; |
| 1421 | PyErr_SetString(PyExc_RuntimeError, |
| 1422 | "deque mutated during iteration"); |
| 1423 | return NULL; |
| 1424 | } |
| 1425 | assert (!(it->b == it->deque->leftblock && |
| 1426 | it->index < it->deque->leftindex)); |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1427 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1428 | item = it->b->data[it->index]; |
| 1429 | it->index--; |
| 1430 | it->counter--; |
| 1431 | if (it->index == -1 && it->counter > 0) { |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 1432 | CHECK_NOT_END(it->b->leftlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1433 | it->b = it->b->leftlink; |
| 1434 | it->index = BLOCKLEN - 1; |
| 1435 | } |
| 1436 | Py_INCREF(item); |
| 1437 | return item; |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1438 | } |
| 1439 | |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1440 | static PyObject * |
| 1441 | dequereviter_new(PyTypeObject *type, PyObject *args, PyObject *kwds) |
| 1442 | { |
| 1443 | Py_ssize_t i, index=0; |
| 1444 | PyObject *deque; |
| 1445 | dequeiterobject *it; |
| 1446 | if (!PyArg_ParseTuple(args, "O!|n", &deque_type, &deque, &index)) |
| 1447 | return NULL; |
| 1448 | assert(type == &dequereviter_type); |
| 1449 | |
| 1450 | it = (dequeiterobject*)deque_reviter((dequeobject *)deque); |
| 1451 | if (!it) |
| 1452 | return NULL; |
| 1453 | /* consume items from the queue */ |
| 1454 | for(i=0; i<index; i++) { |
| 1455 | PyObject *item = dequereviter_next(it); |
| 1456 | if (item) { |
| 1457 | Py_DECREF(item); |
| 1458 | } else { |
| 1459 | if (it->counter) { |
| 1460 | Py_DECREF(it); |
| 1461 | return NULL; |
| 1462 | } else |
| 1463 | break; |
| 1464 | } |
| 1465 | } |
| 1466 | return (PyObject*)it; |
| 1467 | } |
| 1468 | |
Martin v. Löwis | 59683e8 | 2008-06-13 07:50:45 +0000 | [diff] [blame] | 1469 | static PyTypeObject dequereviter_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1470 | PyVarObject_HEAD_INIT(NULL, 0) |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1471 | "_collections._deque_reverse_iterator", /* tp_name */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1472 | sizeof(dequeiterobject), /* tp_basicsize */ |
| 1473 | 0, /* tp_itemsize */ |
| 1474 | /* methods */ |
| 1475 | (destructor)dequeiter_dealloc, /* tp_dealloc */ |
| 1476 | 0, /* tp_print */ |
| 1477 | 0, /* tp_getattr */ |
| 1478 | 0, /* tp_setattr */ |
| 1479 | 0, /* tp_reserved */ |
| 1480 | 0, /* tp_repr */ |
| 1481 | 0, /* tp_as_number */ |
| 1482 | 0, /* tp_as_sequence */ |
| 1483 | 0, /* tp_as_mapping */ |
| 1484 | 0, /* tp_hash */ |
| 1485 | 0, /* tp_call */ |
| 1486 | 0, /* tp_str */ |
| 1487 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 1488 | 0, /* tp_setattro */ |
| 1489 | 0, /* tp_as_buffer */ |
| 1490 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */ |
| 1491 | 0, /* tp_doc */ |
| 1492 | (traverseproc)dequeiter_traverse, /* tp_traverse */ |
| 1493 | 0, /* tp_clear */ |
| 1494 | 0, /* tp_richcompare */ |
| 1495 | 0, /* tp_weaklistoffset */ |
| 1496 | PyObject_SelfIter, /* tp_iter */ |
| 1497 | (iternextfunc)dequereviter_next, /* tp_iternext */ |
| 1498 | dequeiter_methods, /* tp_methods */ |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1499 | 0, /* tp_members */ |
| 1500 | 0, /* tp_getset */ |
| 1501 | 0, /* tp_base */ |
| 1502 | 0, /* tp_dict */ |
| 1503 | 0, /* tp_descr_get */ |
| 1504 | 0, /* tp_descr_set */ |
| 1505 | 0, /* tp_dictoffset */ |
| 1506 | 0, /* tp_init */ |
| 1507 | 0, /* tp_alloc */ |
| 1508 | dequereviter_new, /* tp_new */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1509 | 0, |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1510 | }; |
| 1511 | |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1512 | /* defaultdict type *********************************************************/ |
| 1513 | |
| 1514 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1515 | PyDictObject dict; |
| 1516 | PyObject *default_factory; |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1517 | } defdictobject; |
| 1518 | |
| 1519 | static PyTypeObject defdict_type; /* Forward */ |
| 1520 | |
| 1521 | PyDoc_STRVAR(defdict_missing_doc, |
| 1522 | "__missing__(key) # Called by __getitem__ for missing key; pseudo-code:\n\ |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1523 | if self.default_factory is None: raise KeyError((key,))\n\ |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1524 | self[key] = value = self.default_factory()\n\ |
| 1525 | return value\n\ |
| 1526 | "); |
| 1527 | |
| 1528 | static PyObject * |
| 1529 | defdict_missing(defdictobject *dd, PyObject *key) |
| 1530 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1531 | PyObject *factory = dd->default_factory; |
| 1532 | PyObject *value; |
| 1533 | if (factory == NULL || factory == Py_None) { |
| 1534 | /* XXX Call dict.__missing__(key) */ |
| 1535 | PyObject *tup; |
| 1536 | tup = PyTuple_Pack(1, key); |
| 1537 | if (!tup) return NULL; |
| 1538 | PyErr_SetObject(PyExc_KeyError, tup); |
| 1539 | Py_DECREF(tup); |
| 1540 | return NULL; |
| 1541 | } |
| 1542 | value = PyEval_CallObject(factory, NULL); |
| 1543 | if (value == NULL) |
| 1544 | return value; |
| 1545 | if (PyObject_SetItem((PyObject *)dd, key, value) < 0) { |
| 1546 | Py_DECREF(value); |
| 1547 | return NULL; |
| 1548 | } |
| 1549 | return value; |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1550 | } |
| 1551 | |
| 1552 | PyDoc_STRVAR(defdict_copy_doc, "D.copy() -> a shallow copy of D."); |
| 1553 | |
| 1554 | static PyObject * |
| 1555 | defdict_copy(defdictobject *dd) |
| 1556 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1557 | /* This calls the object's class. That only works for subclasses |
| 1558 | whose class constructor has the same signature. Subclasses that |
| 1559 | define a different constructor signature must override copy(). |
| 1560 | */ |
Raymond Hettinger | 54628fa | 2009-08-04 19:16:39 +0000 | [diff] [blame] | 1561 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1562 | if (dd->default_factory == NULL) |
| 1563 | return PyObject_CallFunctionObjArgs((PyObject*)Py_TYPE(dd), Py_None, dd, NULL); |
| 1564 | return PyObject_CallFunctionObjArgs((PyObject*)Py_TYPE(dd), |
| 1565 | dd->default_factory, dd, NULL); |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1566 | } |
| 1567 | |
| 1568 | static PyObject * |
| 1569 | defdict_reduce(defdictobject *dd) |
| 1570 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1571 | /* __reduce__ must return a 5-tuple as follows: |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1572 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1573 | - factory function |
| 1574 | - tuple of args for the factory function |
| 1575 | - additional state (here None) |
| 1576 | - sequence iterator (here None) |
| 1577 | - dictionary iterator (yielding successive (key, value) pairs |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1578 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1579 | This API is used by pickle.py and copy.py. |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1580 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1581 | For this to be useful with pickle.py, the default_factory |
| 1582 | must be picklable; e.g., None, a built-in, or a global |
| 1583 | function in a module or package. |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1584 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1585 | Both shallow and deep copying are supported, but for deep |
| 1586 | copying, the default_factory must be deep-copyable; e.g. None, |
| 1587 | or a built-in (functions are not copyable at this time). |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1588 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1589 | This only works for subclasses as long as their constructor |
| 1590 | signature is compatible; the first argument must be the |
| 1591 | optional default_factory, defaulting to None. |
| 1592 | */ |
| 1593 | PyObject *args; |
| 1594 | PyObject *items; |
| 1595 | PyObject *iter; |
| 1596 | PyObject *result; |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 1597 | _Py_IDENTIFIER(items); |
Martin v. Löwis | afe55bb | 2011-10-09 10:38:36 +0200 | [diff] [blame] | 1598 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1599 | if (dd->default_factory == NULL || dd->default_factory == Py_None) |
| 1600 | args = PyTuple_New(0); |
| 1601 | else |
| 1602 | args = PyTuple_Pack(1, dd->default_factory); |
| 1603 | if (args == NULL) |
| 1604 | return NULL; |
Martin v. Löwis | afe55bb | 2011-10-09 10:38:36 +0200 | [diff] [blame] | 1605 | items = _PyObject_CallMethodId((PyObject *)dd, &PyId_items, "()"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1606 | if (items == NULL) { |
| 1607 | Py_DECREF(args); |
| 1608 | return NULL; |
| 1609 | } |
| 1610 | iter = PyObject_GetIter(items); |
| 1611 | if (iter == NULL) { |
| 1612 | Py_DECREF(items); |
| 1613 | Py_DECREF(args); |
| 1614 | return NULL; |
| 1615 | } |
| 1616 | result = PyTuple_Pack(5, Py_TYPE(dd), args, |
| 1617 | Py_None, Py_None, iter); |
| 1618 | Py_DECREF(iter); |
| 1619 | Py_DECREF(items); |
| 1620 | Py_DECREF(args); |
| 1621 | return result; |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1622 | } |
| 1623 | |
| 1624 | static PyMethodDef defdict_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1625 | {"__missing__", (PyCFunction)defdict_missing, METH_O, |
| 1626 | defdict_missing_doc}, |
| 1627 | {"copy", (PyCFunction)defdict_copy, METH_NOARGS, |
| 1628 | defdict_copy_doc}, |
| 1629 | {"__copy__", (PyCFunction)defdict_copy, METH_NOARGS, |
| 1630 | defdict_copy_doc}, |
| 1631 | {"__reduce__", (PyCFunction)defdict_reduce, METH_NOARGS, |
| 1632 | reduce_doc}, |
| 1633 | {NULL} |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1634 | }; |
| 1635 | |
| 1636 | static PyMemberDef defdict_members[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1637 | {"default_factory", T_OBJECT, |
| 1638 | offsetof(defdictobject, default_factory), 0, |
| 1639 | PyDoc_STR("Factory for default value called by __missing__().")}, |
| 1640 | {NULL} |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1641 | }; |
| 1642 | |
| 1643 | static void |
| 1644 | defdict_dealloc(defdictobject *dd) |
| 1645 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1646 | Py_CLEAR(dd->default_factory); |
| 1647 | PyDict_Type.tp_dealloc((PyObject *)dd); |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1648 | } |
| 1649 | |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1650 | static PyObject * |
| 1651 | defdict_repr(defdictobject *dd) |
| 1652 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1653 | PyObject *baserepr; |
| 1654 | PyObject *defrepr; |
| 1655 | PyObject *result; |
| 1656 | baserepr = PyDict_Type.tp_repr((PyObject *)dd); |
| 1657 | if (baserepr == NULL) |
| 1658 | return NULL; |
| 1659 | if (dd->default_factory == NULL) |
| 1660 | defrepr = PyUnicode_FromString("None"); |
| 1661 | else |
| 1662 | { |
| 1663 | int status = Py_ReprEnter(dd->default_factory); |
| 1664 | if (status != 0) { |
Antoine Pitrou | f5f1fe0 | 2012-02-15 02:42:46 +0100 | [diff] [blame] | 1665 | if (status < 0) { |
| 1666 | Py_DECREF(baserepr); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1667 | return NULL; |
Antoine Pitrou | f5f1fe0 | 2012-02-15 02:42:46 +0100 | [diff] [blame] | 1668 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1669 | defrepr = PyUnicode_FromString("..."); |
| 1670 | } |
| 1671 | else |
| 1672 | defrepr = PyObject_Repr(dd->default_factory); |
| 1673 | Py_ReprLeave(dd->default_factory); |
| 1674 | } |
| 1675 | if (defrepr == NULL) { |
| 1676 | Py_DECREF(baserepr); |
| 1677 | return NULL; |
| 1678 | } |
| 1679 | result = PyUnicode_FromFormat("defaultdict(%U, %U)", |
| 1680 | defrepr, baserepr); |
| 1681 | Py_DECREF(defrepr); |
| 1682 | Py_DECREF(baserepr); |
| 1683 | return result; |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1684 | } |
| 1685 | |
| 1686 | static int |
| 1687 | defdict_traverse(PyObject *self, visitproc visit, void *arg) |
| 1688 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1689 | Py_VISIT(((defdictobject *)self)->default_factory); |
| 1690 | return PyDict_Type.tp_traverse(self, visit, arg); |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1691 | } |
| 1692 | |
| 1693 | static int |
| 1694 | defdict_tp_clear(defdictobject *dd) |
| 1695 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1696 | Py_CLEAR(dd->default_factory); |
| 1697 | return PyDict_Type.tp_clear((PyObject *)dd); |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1698 | } |
| 1699 | |
| 1700 | static int |
| 1701 | defdict_init(PyObject *self, PyObject *args, PyObject *kwds) |
| 1702 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1703 | defdictobject *dd = (defdictobject *)self; |
| 1704 | PyObject *olddefault = dd->default_factory; |
| 1705 | PyObject *newdefault = NULL; |
| 1706 | PyObject *newargs; |
| 1707 | int result; |
| 1708 | if (args == NULL || !PyTuple_Check(args)) |
| 1709 | newargs = PyTuple_New(0); |
| 1710 | else { |
| 1711 | Py_ssize_t n = PyTuple_GET_SIZE(args); |
| 1712 | if (n > 0) { |
| 1713 | newdefault = PyTuple_GET_ITEM(args, 0); |
| 1714 | if (!PyCallable_Check(newdefault) && newdefault != Py_None) { |
| 1715 | PyErr_SetString(PyExc_TypeError, |
| 1716 | "first argument must be callable"); |
| 1717 | return -1; |
| 1718 | } |
| 1719 | } |
| 1720 | newargs = PySequence_GetSlice(args, 1, n); |
| 1721 | } |
| 1722 | if (newargs == NULL) |
| 1723 | return -1; |
| 1724 | Py_XINCREF(newdefault); |
| 1725 | dd->default_factory = newdefault; |
| 1726 | result = PyDict_Type.tp_init(self, newargs, kwds); |
| 1727 | Py_DECREF(newargs); |
| 1728 | Py_XDECREF(olddefault); |
| 1729 | return result; |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1730 | } |
| 1731 | |
| 1732 | PyDoc_STRVAR(defdict_doc, |
Benjamin Peterson | 9cb33b7 | 2014-01-13 23:56:05 -0500 | [diff] [blame] | 1733 | "defaultdict(default_factory[, ...]) --> dict with default factory\n\ |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1734 | \n\ |
| 1735 | The default factory is called without arguments to produce\n\ |
| 1736 | a new value when a key is not present, in __getitem__ only.\n\ |
| 1737 | A defaultdict compares equal to a dict with the same items.\n\ |
Benjamin Peterson | 9cb33b7 | 2014-01-13 23:56:05 -0500 | [diff] [blame] | 1738 | All remaining arguments are treated the same as if they were\n\ |
| 1739 | passed to the dict constructor, including keyword arguments.\n\ |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1740 | "); |
| 1741 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1742 | /* See comment in xxsubtype.c */ |
| 1743 | #define DEFERRED_ADDRESS(ADDR) 0 |
| 1744 | |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1745 | static PyTypeObject defdict_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1746 | PyVarObject_HEAD_INIT(DEFERRED_ADDRESS(&PyType_Type), 0) |
| 1747 | "collections.defaultdict", /* tp_name */ |
| 1748 | sizeof(defdictobject), /* tp_basicsize */ |
| 1749 | 0, /* tp_itemsize */ |
| 1750 | /* methods */ |
| 1751 | (destructor)defdict_dealloc, /* tp_dealloc */ |
| 1752 | 0, /* tp_print */ |
| 1753 | 0, /* tp_getattr */ |
| 1754 | 0, /* tp_setattr */ |
| 1755 | 0, /* tp_reserved */ |
| 1756 | (reprfunc)defdict_repr, /* tp_repr */ |
| 1757 | 0, /* tp_as_number */ |
| 1758 | 0, /* tp_as_sequence */ |
| 1759 | 0, /* tp_as_mapping */ |
| 1760 | 0, /* tp_hash */ |
| 1761 | 0, /* tp_call */ |
| 1762 | 0, /* tp_str */ |
| 1763 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 1764 | 0, /* tp_setattro */ |
| 1765 | 0, /* tp_as_buffer */ |
| 1766 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, |
| 1767 | /* tp_flags */ |
| 1768 | defdict_doc, /* tp_doc */ |
| 1769 | defdict_traverse, /* tp_traverse */ |
| 1770 | (inquiry)defdict_tp_clear, /* tp_clear */ |
| 1771 | 0, /* tp_richcompare */ |
| 1772 | 0, /* tp_weaklistoffset*/ |
| 1773 | 0, /* tp_iter */ |
| 1774 | 0, /* tp_iternext */ |
| 1775 | defdict_methods, /* tp_methods */ |
| 1776 | defdict_members, /* tp_members */ |
| 1777 | 0, /* tp_getset */ |
| 1778 | DEFERRED_ADDRESS(&PyDict_Type), /* tp_base */ |
| 1779 | 0, /* tp_dict */ |
| 1780 | 0, /* tp_descr_get */ |
| 1781 | 0, /* tp_descr_set */ |
| 1782 | 0, /* tp_dictoffset */ |
| 1783 | defdict_init, /* tp_init */ |
| 1784 | PyType_GenericAlloc, /* tp_alloc */ |
| 1785 | 0, /* tp_new */ |
| 1786 | PyObject_GC_Del, /* tp_free */ |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1787 | }; |
| 1788 | |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1789 | /* helper function for Counter *********************************************/ |
| 1790 | |
| 1791 | PyDoc_STRVAR(_count_elements_doc, |
| 1792 | "_count_elements(mapping, iterable) -> None\n\ |
| 1793 | \n\ |
| 1794 | Count elements in the iterable, updating the mappping"); |
| 1795 | |
| 1796 | static PyObject * |
| 1797 | _count_elements(PyObject *self, PyObject *args) |
| 1798 | { |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 1799 | _Py_IDENTIFIER(get); |
Raymond Hettinger | 2ff2190 | 2013-10-01 00:55:43 -0700 | [diff] [blame] | 1800 | _Py_IDENTIFIER(__setitem__); |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1801 | PyObject *it, *iterable, *mapping, *oldval; |
| 1802 | PyObject *newval = NULL; |
| 1803 | PyObject *key = NULL; |
Raymond Hettinger | 224c87d | 2013-10-01 21:36:09 -0700 | [diff] [blame] | 1804 | PyObject *zero = NULL; |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1805 | PyObject *one = NULL; |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 1806 | PyObject *bound_get = NULL; |
| 1807 | PyObject *mapping_get; |
| 1808 | PyObject *dict_get; |
Raymond Hettinger | 2ff2190 | 2013-10-01 00:55:43 -0700 | [diff] [blame] | 1809 | PyObject *mapping_setitem; |
Raymond Hettinger | 2ff2190 | 2013-10-01 00:55:43 -0700 | [diff] [blame] | 1810 | PyObject *dict_setitem; |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1811 | |
| 1812 | if (!PyArg_UnpackTuple(args, "_count_elements", 2, 2, &mapping, &iterable)) |
| 1813 | return NULL; |
| 1814 | |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1815 | it = PyObject_GetIter(iterable); |
| 1816 | if (it == NULL) |
| 1817 | return NULL; |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1818 | |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1819 | one = PyLong_FromLong(1); |
Raymond Hettinger | 224c87d | 2013-10-01 21:36:09 -0700 | [diff] [blame] | 1820 | if (one == NULL) |
| 1821 | goto done; |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1822 | |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 1823 | /* Only take the fast path when get() and __setitem__() |
| 1824 | * have not been overridden. |
| 1825 | */ |
| 1826 | mapping_get = _PyType_LookupId(Py_TYPE(mapping), &PyId_get); |
| 1827 | dict_get = _PyType_LookupId(&PyDict_Type, &PyId_get); |
Raymond Hettinger | 2ff2190 | 2013-10-01 00:55:43 -0700 | [diff] [blame] | 1828 | mapping_setitem = _PyType_LookupId(Py_TYPE(mapping), &PyId___setitem__); |
| 1829 | dict_setitem = _PyType_LookupId(&PyDict_Type, &PyId___setitem__); |
| 1830 | |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 1831 | if (mapping_get != NULL && mapping_get == dict_get && |
| 1832 | mapping_setitem != NULL && mapping_setitem == dict_setitem) { |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1833 | while (1) { |
Raymond Hettinger | 507d997 | 2014-05-18 21:32:40 +0100 | [diff] [blame] | 1834 | /* Fast path advantages: |
| 1835 | 1. Eliminate double hashing |
| 1836 | (by re-using the same hash for both the get and set) |
| 1837 | 2. Avoid argument overhead of PyObject_CallFunctionObjArgs |
| 1838 | (argument tuple creation and parsing) |
| 1839 | 3. Avoid indirection through a bound method object |
| 1840 | (creates another argument tuple) |
| 1841 | 4. Avoid initial increment from zero |
| 1842 | (reuse an existing one-object instead) |
| 1843 | */ |
Raymond Hettinger | 4b0b1ac | 2014-05-03 16:41:19 -0700 | [diff] [blame] | 1844 | Py_hash_t hash; |
| 1845 | |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1846 | key = PyIter_Next(it); |
Victor Stinner | a154b5c | 2011-04-20 23:23:52 +0200 | [diff] [blame] | 1847 | if (key == NULL) |
| 1848 | break; |
Raymond Hettinger | 4b0b1ac | 2014-05-03 16:41:19 -0700 | [diff] [blame] | 1849 | |
| 1850 | if (!PyUnicode_CheckExact(key) || |
| 1851 | (hash = ((PyASCIIObject *) key)->hash) == -1) |
| 1852 | { |
| 1853 | hash = PyObject_Hash(key); |
| 1854 | if (hash == -1) |
| 1855 | goto done; |
| 1856 | } |
| 1857 | |
| 1858 | oldval = _PyDict_GetItem_KnownHash(mapping, key, hash); |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1859 | if (oldval == NULL) { |
Raymond Hettinger | 4b0b1ac | 2014-05-03 16:41:19 -0700 | [diff] [blame] | 1860 | if (_PyDict_SetItem_KnownHash(mapping, key, one, hash) == -1) |
Raymond Hettinger | 507d997 | 2014-05-18 21:32:40 +0100 | [diff] [blame] | 1861 | goto done; |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1862 | } else { |
| 1863 | newval = PyNumber_Add(oldval, one); |
| 1864 | if (newval == NULL) |
Raymond Hettinger | 507d997 | 2014-05-18 21:32:40 +0100 | [diff] [blame] | 1865 | goto done; |
Raymond Hettinger | 4b0b1ac | 2014-05-03 16:41:19 -0700 | [diff] [blame] | 1866 | if (_PyDict_SetItem_KnownHash(mapping, key, newval, hash) == -1) |
Raymond Hettinger | 507d997 | 2014-05-18 21:32:40 +0100 | [diff] [blame] | 1867 | goto done; |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1868 | Py_CLEAR(newval); |
| 1869 | } |
| 1870 | Py_DECREF(key); |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1871 | } |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1872 | } else { |
Victor Stinner | e7f516c | 2013-11-06 23:52:55 +0100 | [diff] [blame] | 1873 | bound_get = _PyObject_GetAttrId(mapping, &PyId_get); |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 1874 | if (bound_get == NULL) |
Raymond Hettinger | 224c87d | 2013-10-01 21:36:09 -0700 | [diff] [blame] | 1875 | goto done; |
| 1876 | |
| 1877 | zero = PyLong_FromLong(0); |
| 1878 | if (zero == NULL) |
| 1879 | goto done; |
| 1880 | |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1881 | while (1) { |
| 1882 | key = PyIter_Next(it); |
Victor Stinner | a154b5c | 2011-04-20 23:23:52 +0200 | [diff] [blame] | 1883 | if (key == NULL) |
| 1884 | break; |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 1885 | oldval = PyObject_CallFunctionObjArgs(bound_get, key, zero, NULL); |
Raymond Hettinger | 224c87d | 2013-10-01 21:36:09 -0700 | [diff] [blame] | 1886 | if (oldval == NULL) |
| 1887 | break; |
| 1888 | newval = PyNumber_Add(oldval, one); |
| 1889 | Py_DECREF(oldval); |
| 1890 | if (newval == NULL) |
| 1891 | break; |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1892 | if (PyObject_SetItem(mapping, key, newval) == -1) |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1893 | break; |
| 1894 | Py_CLEAR(newval); |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1895 | Py_DECREF(key); |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1896 | } |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1897 | } |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 1898 | |
Raymond Hettinger | 224c87d | 2013-10-01 21:36:09 -0700 | [diff] [blame] | 1899 | done: |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1900 | Py_DECREF(it); |
| 1901 | Py_XDECREF(key); |
| 1902 | Py_XDECREF(newval); |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 1903 | Py_XDECREF(bound_get); |
Raymond Hettinger | 224c87d | 2013-10-01 21:36:09 -0700 | [diff] [blame] | 1904 | Py_XDECREF(zero); |
| 1905 | Py_XDECREF(one); |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1906 | if (PyErr_Occurred()) |
| 1907 | return NULL; |
| 1908 | Py_RETURN_NONE; |
| 1909 | } |
| 1910 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1911 | /* module level code ********************************************************/ |
| 1912 | |
| 1913 | PyDoc_STRVAR(module_doc, |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1914 | "High performance data structures.\n\ |
| 1915 | - deque: ordered collection accessible from endpoints only\n\ |
| 1916 | - defaultdict: dict subclass with a default value factory\n\ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1917 | "); |
| 1918 | |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1919 | static struct PyMethodDef module_functions[] = { |
| 1920 | {"_count_elements", _count_elements, METH_VARARGS, _count_elements_doc}, |
| 1921 | {NULL, NULL} /* sentinel */ |
| 1922 | }; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1923 | |
| 1924 | static struct PyModuleDef _collectionsmodule = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1925 | PyModuleDef_HEAD_INIT, |
| 1926 | "_collections", |
| 1927 | module_doc, |
| 1928 | -1, |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 1929 | module_functions, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1930 | NULL, |
| 1931 | NULL, |
| 1932 | NULL, |
| 1933 | NULL |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1934 | }; |
| 1935 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1936 | PyMODINIT_FUNC |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1937 | PyInit__collections(void) |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1938 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1939 | PyObject *m; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1940 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1941 | m = PyModule_Create(&_collectionsmodule); |
| 1942 | if (m == NULL) |
| 1943 | return NULL; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1944 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1945 | if (PyType_Ready(&deque_type) < 0) |
| 1946 | return NULL; |
| 1947 | Py_INCREF(&deque_type); |
| 1948 | PyModule_AddObject(m, "deque", (PyObject *)&deque_type); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1949 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1950 | defdict_type.tp_base = &PyDict_Type; |
| 1951 | if (PyType_Ready(&defdict_type) < 0) |
| 1952 | return NULL; |
| 1953 | Py_INCREF(&defdict_type); |
| 1954 | PyModule_AddObject(m, "defaultdict", (PyObject *)&defdict_type); |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1955 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1956 | if (PyType_Ready(&dequeiter_type) < 0) |
| 1957 | return NULL; |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1958 | Py_INCREF(&dequeiter_type); |
| 1959 | PyModule_AddObject(m, "_deque_iterator", (PyObject *)&dequeiter_type); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1960 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1961 | if (PyType_Ready(&dequereviter_type) < 0) |
| 1962 | return NULL; |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1963 | Py_INCREF(&dequereviter_type); |
| 1964 | PyModule_AddObject(m, "_deque_reverse_iterator", (PyObject *)&dequereviter_type); |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1965 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1966 | return m; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1967 | } |