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 | |
Raymond Hettinger | c208308 | 2015-02-28 23:29:16 -0800 | [diff] [blame] | 4 | #ifdef STDC_HEADERS |
| 5 | #include <stddef.h> |
| 6 | #else |
| 7 | #include <sys/types.h> /* For size_t */ |
| 8 | #endif |
| 9 | |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 10 | /*[clinic input] |
Miss Islington (bot) | 21ce245 | 2019-06-05 16:20:58 -0700 | [diff] [blame] | 11 | module _collections |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 12 | class _tuplegetter "_tuplegetterobject *" "&tuplegetter_type" |
| 13 | [clinic start generated code]*/ |
Miss Islington (bot) | 21ce245 | 2019-06-05 16:20:58 -0700 | [diff] [blame] | 14 | /*[clinic end generated code: output=da39a3ee5e6b4b0d input=a8ece4ccad7e30ac]*/ |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 15 | |
| 16 | static PyTypeObject tuplegetter_type; |
| 17 | #include "clinic/_collectionsmodule.c.h" |
| 18 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 19 | /* collections module implementation of a deque() datatype |
| 20 | Written and maintained by Raymond D. Hettinger <python@rcn.com> |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 21 | */ |
| 22 | |
Raymond Hettinger | 77e8bf1 | 2004-10-01 15:25:53 +0000 | [diff] [blame] | 23 | /* 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] | 24 | * reduce the number of calls to the memory allocator, give faster |
Raymond Hettinger | 30c9074 | 2015-03-02 22:31:35 -0800 | [diff] [blame] | 25 | * indexing and rotation, and reduce the link to data overhead ratio. |
Raymond Hettinger | daf57f2 | 2015-02-26 23:21:29 -0800 | [diff] [blame] | 26 | * Making the block length a power of two speeds-up the modulo |
Raymond Hettinger | 30c9074 | 2015-03-02 22:31:35 -0800 | [diff] [blame] | 27 | * and division calculations in deque_item() and deque_ass_item(). |
Raymond Hettinger | 77e8bf1 | 2004-10-01 15:25:53 +0000 | [diff] [blame] | 28 | */ |
| 29 | |
Raymond Hettinger | daf57f2 | 2015-02-26 23:21:29 -0800 | [diff] [blame] | 30 | #define BLOCKLEN 64 |
Raymond Hettinger | 61f05fb | 2004-10-01 06:24:12 +0000 | [diff] [blame] | 31 | #define CENTER ((BLOCKLEN - 1) / 2) |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 32 | |
Raymond Hettinger | 551350a | 2015-03-24 00:19:53 -0700 | [diff] [blame] | 33 | /* Data for deque objects is stored in a doubly-linked list of fixed |
| 34 | * length blocks. This assures that appends or pops never move any |
| 35 | * other data elements besides the one being appended or popped. |
| 36 | * |
| 37 | * Another advantage is that it completely avoids use of realloc(), |
| 38 | * resulting in more predictable performance. |
| 39 | * |
| 40 | * Textbook implementations of doubly-linked lists store one datum |
| 41 | * per link, but that gives them a 200% memory overhead (a prev and |
| 42 | * next link for each datum) and it costs one malloc() call per data |
| 43 | * element. By using fixed-length blocks, the link to data ratio is |
| 44 | * significantly improved and there are proportionally fewer calls |
| 45 | * to malloc() and free(). The data blocks of consecutive pointers |
| 46 | * also improve cache locality. |
| 47 | * |
Raymond Hettinger | 61f05fb | 2004-10-01 06:24:12 +0000 | [diff] [blame] | 48 | * 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] | 49 | * are never equal to NULL. The list is not circular. |
| 50 | * |
| 51 | * A deque d's first element is at d.leftblock[leftindex] |
| 52 | * and its last element is at d.rightblock[rightindex]. |
Raymond Hettinger | 61f05fb | 2004-10-01 06:24:12 +0000 | [diff] [blame] | 53 | * |
Raymond Hettinger | 551350a | 2015-03-24 00:19:53 -0700 | [diff] [blame] | 54 | * Unlike Python slice indices, these indices are inclusive on both |
| 55 | * ends. This makes the algorithms for left and right operations |
| 56 | * more symmetrical and it simplifies the design. |
Raymond Hettinger | 61f05fb | 2004-10-01 06:24:12 +0000 | [diff] [blame] | 57 | * |
Raymond Hettinger | 551350a | 2015-03-24 00:19:53 -0700 | [diff] [blame] | 58 | * The indices, d.leftindex and d.rightindex are always in the range: |
| 59 | * 0 <= index < BLOCKLEN |
| 60 | * |
| 61 | * And their exact relationship is: |
| 62 | * (d.leftindex + d.len - 1) % BLOCKLEN == d.rightindex |
Raymond Hettinger | 61f05fb | 2004-10-01 06:24:12 +0000 | [diff] [blame] | 63 | * |
Raymond Hettinger | 8dbbae2 | 2015-03-24 21:01:50 -0700 | [diff] [blame] | 64 | * Whenever d.leftblock == d.rightblock, then: |
Raymond Hettinger | 551350a | 2015-03-24 00:19:53 -0700 | [diff] [blame] | 65 | * d.leftindex + d.len - 1 == d.rightindex |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 66 | * |
Raymond Hettinger | 551350a | 2015-03-24 00:19:53 -0700 | [diff] [blame] | 67 | * However, when d.leftblock != d.rightblock, the d.leftindex and |
| 68 | * d.rightindex become indices into distinct blocks and either may |
| 69 | * be larger than the other. |
| 70 | * |
| 71 | * Empty deques have: |
| 72 | * d.len == 0 |
| 73 | * d.leftblock == d.rightblock |
| 74 | * d.leftindex == CENTER + 1 |
| 75 | * d.rightindex == CENTER |
| 76 | * |
| 77 | * Checking for d.len == 0 is the intended way to see whether d is empty. |
Tim Peters | d8768d3 | 2004-10-01 01:32:53 +0000 | [diff] [blame] | 78 | */ |
| 79 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 80 | typedef struct BLOCK { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 81 | struct BLOCK *leftlink; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 82 | PyObject *data[BLOCKLEN]; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 83 | struct BLOCK *rightlink; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 84 | } block; |
| 85 | |
Raymond Hettinger | 30c9074 | 2015-03-02 22:31:35 -0800 | [diff] [blame] | 86 | typedef struct { |
| 87 | PyObject_VAR_HEAD |
| 88 | block *leftblock; |
| 89 | block *rightblock; |
Raymond Hettinger | 551350a | 2015-03-24 00:19:53 -0700 | [diff] [blame] | 90 | Py_ssize_t leftindex; /* 0 <= leftindex < BLOCKLEN */ |
| 91 | Py_ssize_t rightindex; /* 0 <= rightindex < BLOCKLEN */ |
Raymond Hettinger | f9d9c79 | 2015-03-02 22:47:46 -0800 | [diff] [blame] | 92 | size_t state; /* incremented whenever the indices move */ |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 93 | Py_ssize_t maxlen; /* maxlen is -1 for unbounded deques */ |
Raymond Hettinger | 0f6f947 | 2015-03-21 01:42:10 -0700 | [diff] [blame] | 94 | PyObject *weakreflist; |
Raymond Hettinger | 30c9074 | 2015-03-02 22:31:35 -0800 | [diff] [blame] | 95 | } dequeobject; |
| 96 | |
| 97 | static PyTypeObject deque_type; |
| 98 | |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 99 | /* For debug builds, add error checking to track the endpoints |
| 100 | * in the chain of links. The goal is to make sure that link |
| 101 | * assignments only take place at endpoints so that links already |
| 102 | * in use do not get overwritten. |
| 103 | * |
| 104 | * CHECK_END should happen before each assignment to a block's link field. |
| 105 | * MARK_END should happen whenever a link field becomes a new endpoint. |
| 106 | * This happens when new blocks are added or whenever an existing |
| 107 | * block is freed leaving another existing block as the new endpoint. |
| 108 | */ |
| 109 | |
Raymond Hettinger | 3223dd5 | 2013-07-26 23:14:22 -0700 | [diff] [blame] | 110 | #ifndef NDEBUG |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 111 | #define MARK_END(link) link = NULL; |
| 112 | #define CHECK_END(link) assert(link == NULL); |
| 113 | #define CHECK_NOT_END(link) assert(link != NULL); |
| 114 | #else |
| 115 | #define MARK_END(link) |
| 116 | #define CHECK_END(link) |
| 117 | #define CHECK_NOT_END(link) |
| 118 | #endif |
| 119 | |
| 120 | /* A simple freelisting scheme is used to minimize calls to the memory |
Raymond Hettinger | 551350a | 2015-03-24 00:19:53 -0700 | [diff] [blame] | 121 | allocator. It accommodates common use cases where new blocks are being |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 122 | added at about the same rate as old blocks are being freed. |
| 123 | */ |
| 124 | |
Raymond Hettinger | f2b02ce | 2015-09-26 17:47:02 -0700 | [diff] [blame] | 125 | #define MAXFREEBLOCKS 16 |
Benjamin Peterson | d631371 | 2008-07-31 16:23:04 +0000 | [diff] [blame] | 126 | static Py_ssize_t numfreeblocks = 0; |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 127 | static block *freeblocks[MAXFREEBLOCKS]; |
| 128 | |
Tim Peters | 6f85356 | 2004-10-01 01:04:50 +0000 | [diff] [blame] | 129 | static block * |
Raymond Hettinger | db41fd4 | 2015-10-22 22:48:16 -0700 | [diff] [blame] | 130 | newblock(void) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 131 | block *b; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 132 | if (numfreeblocks) { |
Raymond Hettinger | 59cf23a | 2013-02-07 00:57:19 -0500 | [diff] [blame] | 133 | numfreeblocks--; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 134 | return freeblocks[numfreeblocks]; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 135 | } |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 136 | b = PyMem_Malloc(sizeof(block)); |
| 137 | if (b != NULL) { |
| 138 | return b; |
| 139 | } |
| 140 | PyErr_NoMemory(); |
| 141 | return NULL; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 142 | } |
| 143 | |
Martin v. Löwis | 59683e8 | 2008-06-13 07:50:45 +0000 | [diff] [blame] | 144 | static void |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 145 | freeblock(block *b) |
| 146 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 147 | if (numfreeblocks < MAXFREEBLOCKS) { |
| 148 | freeblocks[numfreeblocks] = b; |
| 149 | numfreeblocks++; |
| 150 | } else { |
| 151 | PyMem_Free(b); |
| 152 | } |
Guido van Rossum | 58da931 | 2007-11-10 23:39:45 +0000 | [diff] [blame] | 153 | } |
| 154 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 155 | static PyObject * |
| 156 | deque_new(PyTypeObject *type, PyObject *args, PyObject *kwds) |
| 157 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 158 | dequeobject *deque; |
| 159 | block *b; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 160 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 161 | /* create dequeobject structure */ |
| 162 | deque = (dequeobject *)type->tp_alloc(type, 0); |
| 163 | if (deque == NULL) |
| 164 | return NULL; |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 165 | |
Raymond Hettinger | db41fd4 | 2015-10-22 22:48:16 -0700 | [diff] [blame] | 166 | b = newblock(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 167 | if (b == NULL) { |
| 168 | Py_DECREF(deque); |
| 169 | return NULL; |
| 170 | } |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 171 | MARK_END(b->leftlink); |
| 172 | MARK_END(b->rightlink); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 173 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 174 | assert(BLOCKLEN >= 2); |
Raymond Hettinger | 87e6912 | 2015-03-02 23:32:02 -0800 | [diff] [blame] | 175 | Py_SIZE(deque) = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 176 | deque->leftblock = b; |
| 177 | deque->rightblock = b; |
| 178 | deque->leftindex = CENTER + 1; |
| 179 | deque->rightindex = CENTER; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 180 | deque->state = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 181 | deque->maxlen = -1; |
Raymond Hettinger | 87e6912 | 2015-03-02 23:32:02 -0800 | [diff] [blame] | 182 | deque->weakreflist = NULL; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 183 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 184 | return (PyObject *)deque; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 185 | } |
| 186 | |
| 187 | static PyObject * |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 188 | deque_pop(dequeobject *deque, PyObject *unused) |
| 189 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 190 | PyObject *item; |
| 191 | block *prevblock; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 192 | |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 193 | if (Py_SIZE(deque) == 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 194 | PyErr_SetString(PyExc_IndexError, "pop from an empty deque"); |
| 195 | return NULL; |
| 196 | } |
| 197 | item = deque->rightblock->data[deque->rightindex]; |
| 198 | deque->rightindex--; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 199 | Py_SIZE(deque)--; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 200 | deque->state++; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 201 | |
Raymond Hettinger | d3d2b2c | 2015-09-21 23:41:56 -0700 | [diff] [blame] | 202 | if (deque->rightindex < 0) { |
Raymond Hettinger | 8dbbae2 | 2015-03-24 21:01:50 -0700 | [diff] [blame] | 203 | if (Py_SIZE(deque)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 204 | prevblock = deque->rightblock->leftlink; |
| 205 | assert(deque->leftblock != deque->rightblock); |
| 206 | freeblock(deque->rightblock); |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 207 | CHECK_NOT_END(prevblock); |
| 208 | MARK_END(prevblock->rightlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 209 | deque->rightblock = prevblock; |
| 210 | deque->rightindex = BLOCKLEN - 1; |
Raymond Hettinger | 8dbbae2 | 2015-03-24 21:01:50 -0700 | [diff] [blame] | 211 | } else { |
| 212 | assert(deque->leftblock == deque->rightblock); |
| 213 | assert(deque->leftindex == deque->rightindex+1); |
| 214 | /* re-center instead of freeing a block */ |
| 215 | deque->leftindex = CENTER + 1; |
| 216 | deque->rightindex = CENTER; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 217 | } |
| 218 | } |
| 219 | return item; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 220 | } |
| 221 | |
| 222 | PyDoc_STRVAR(pop_doc, "Remove and return the rightmost element."); |
| 223 | |
| 224 | static PyObject * |
| 225 | deque_popleft(dequeobject *deque, PyObject *unused) |
| 226 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 227 | PyObject *item; |
| 228 | block *prevblock; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 229 | |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 230 | if (Py_SIZE(deque) == 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 231 | PyErr_SetString(PyExc_IndexError, "pop from an empty deque"); |
| 232 | return NULL; |
| 233 | } |
| 234 | assert(deque->leftblock != NULL); |
| 235 | item = deque->leftblock->data[deque->leftindex]; |
| 236 | deque->leftindex++; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 237 | Py_SIZE(deque)--; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 238 | deque->state++; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 239 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 240 | if (deque->leftindex == BLOCKLEN) { |
Raymond Hettinger | 8dbbae2 | 2015-03-24 21:01:50 -0700 | [diff] [blame] | 241 | if (Py_SIZE(deque)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 242 | assert(deque->leftblock != deque->rightblock); |
| 243 | prevblock = deque->leftblock->rightlink; |
| 244 | freeblock(deque->leftblock); |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 245 | CHECK_NOT_END(prevblock); |
| 246 | MARK_END(prevblock->leftlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 247 | deque->leftblock = prevblock; |
| 248 | deque->leftindex = 0; |
Raymond Hettinger | 8dbbae2 | 2015-03-24 21:01:50 -0700 | [diff] [blame] | 249 | } else { |
| 250 | assert(deque->leftblock == deque->rightblock); |
| 251 | assert(deque->leftindex == deque->rightindex+1); |
| 252 | /* re-center instead of freeing a block */ |
| 253 | deque->leftindex = CENTER + 1; |
| 254 | deque->rightindex = CENTER; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 255 | } |
| 256 | } |
| 257 | return item; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 258 | } |
| 259 | |
| 260 | PyDoc_STRVAR(popleft_doc, "Remove and return the leftmost element."); |
| 261 | |
Raymond Hettinger | f30f5b9 | 2015-03-02 22:23:37 -0800 | [diff] [blame] | 262 | /* The deque's size limit is d.maxlen. The limit can be zero or positive. |
| 263 | * If there is no limit, then d.maxlen == -1. |
| 264 | * |
Raymond Hettinger | a4b13d0 | 2015-10-15 08:05:31 -0700 | [diff] [blame] | 265 | * After an item is added to a deque, we check to see if the size has |
| 266 | * grown past the limit. If it has, we get the size back down to the limit |
| 267 | * by popping an item off of the opposite end. The methods that can |
| 268 | * trigger this are append(), appendleft(), extend(), and extendleft(). |
Raymond Hettinger | d96db09 | 2015-10-11 22:34:48 -0700 | [diff] [blame] | 269 | * |
| 270 | * The macro to check whether a deque needs to be trimmed uses a single |
| 271 | * unsigned test that returns true whenever 0 <= maxlen < Py_SIZE(deque). |
Raymond Hettinger | f30f5b9 | 2015-03-02 22:23:37 -0800 | [diff] [blame] | 272 | */ |
| 273 | |
Raymond Hettinger | d96db09 | 2015-10-11 22:34:48 -0700 | [diff] [blame] | 274 | #define NEEDS_TRIM(deque, maxlen) ((size_t)(maxlen) < (size_t)(Py_SIZE(deque))) |
Raymond Hettinger | f30f5b9 | 2015-03-02 22:23:37 -0800 | [diff] [blame] | 275 | |
Raymond Hettinger | 66953f0 | 2018-07-10 04:17:40 -0700 | [diff] [blame] | 276 | static inline int |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 277 | deque_append_internal(dequeobject *deque, PyObject *item, Py_ssize_t maxlen) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 278 | { |
Raymond Hettinger | 8dbbae2 | 2015-03-24 21:01:50 -0700 | [diff] [blame] | 279 | if (deque->rightindex == BLOCKLEN - 1) { |
Raymond Hettinger | db41fd4 | 2015-10-22 22:48:16 -0700 | [diff] [blame] | 280 | block *b = newblock(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 281 | if (b == NULL) |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 282 | return -1; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 283 | b->leftlink = deque->rightblock; |
| 284 | CHECK_END(deque->rightblock->rightlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 285 | deque->rightblock->rightlink = b; |
| 286 | deque->rightblock = b; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 287 | MARK_END(b->rightlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 288 | deque->rightindex = -1; |
| 289 | } |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 290 | Py_SIZE(deque)++; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 291 | deque->rightindex++; |
| 292 | deque->rightblock->data[deque->rightindex] = item; |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 293 | if (NEEDS_TRIM(deque, maxlen)) { |
Raymond Hettinger | 1286d14 | 2015-10-14 23:16:57 -0700 | [diff] [blame] | 294 | PyObject *olditem = deque_popleft(deque, NULL); |
| 295 | Py_DECREF(olditem); |
Raymond Hettinger | 0f43bb1 | 2015-10-20 00:03:33 -0700 | [diff] [blame] | 296 | } else { |
| 297 | deque->state++; |
Raymond Hettinger | d96db09 | 2015-10-11 22:34:48 -0700 | [diff] [blame] | 298 | } |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 299 | return 0; |
| 300 | } |
| 301 | |
| 302 | static PyObject * |
| 303 | deque_append(dequeobject *deque, PyObject *item) |
| 304 | { |
| 305 | Py_INCREF(item); |
| 306 | if (deque_append_internal(deque, item, deque->maxlen) < 0) |
| 307 | return NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 308 | Py_RETURN_NONE; |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 309 | } |
| 310 | |
| 311 | PyDoc_STRVAR(append_doc, "Add an element to the right side of the deque."); |
| 312 | |
Raymond Hettinger | 66953f0 | 2018-07-10 04:17:40 -0700 | [diff] [blame] | 313 | static inline int |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 314 | deque_appendleft_internal(dequeobject *deque, PyObject *item, Py_ssize_t maxlen) |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 315 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 316 | if (deque->leftindex == 0) { |
Raymond Hettinger | db41fd4 | 2015-10-22 22:48:16 -0700 | [diff] [blame] | 317 | block *b = newblock(); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 318 | if (b == NULL) |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 319 | return -1; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 320 | b->rightlink = deque->leftblock; |
| 321 | CHECK_END(deque->leftblock->leftlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 322 | deque->leftblock->leftlink = b; |
| 323 | deque->leftblock = b; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 324 | MARK_END(b->leftlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 325 | deque->leftindex = BLOCKLEN; |
| 326 | } |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 327 | Py_SIZE(deque)++; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 328 | deque->leftindex--; |
| 329 | deque->leftblock->data[deque->leftindex] = item; |
Raymond Hettinger | d96db09 | 2015-10-11 22:34:48 -0700 | [diff] [blame] | 330 | if (NEEDS_TRIM(deque, deque->maxlen)) { |
Raymond Hettinger | 1286d14 | 2015-10-14 23:16:57 -0700 | [diff] [blame] | 331 | PyObject *olditem = deque_pop(deque, NULL); |
| 332 | Py_DECREF(olditem); |
Raymond Hettinger | 0f43bb1 | 2015-10-20 00:03:33 -0700 | [diff] [blame] | 333 | } else { |
| 334 | deque->state++; |
Raymond Hettinger | d96db09 | 2015-10-11 22:34:48 -0700 | [diff] [blame] | 335 | } |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 336 | return 0; |
| 337 | } |
| 338 | |
| 339 | static PyObject * |
| 340 | deque_appendleft(dequeobject *deque, PyObject *item) |
| 341 | { |
| 342 | Py_INCREF(item); |
| 343 | if (deque_appendleft_internal(deque, item, deque->maxlen) < 0) |
| 344 | return NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 345 | Py_RETURN_NONE; |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 346 | } |
| 347 | |
| 348 | PyDoc_STRVAR(appendleft_doc, "Add an element to the left side of the deque."); |
| 349 | |
Raymond Hettinger | fd265f4 | 2015-10-02 23:17:33 -0700 | [diff] [blame] | 350 | static PyObject* |
| 351 | finalize_iterator(PyObject *it) |
| 352 | { |
| 353 | if (PyErr_Occurred()) { |
| 354 | if (PyErr_ExceptionMatches(PyExc_StopIteration)) |
| 355 | PyErr_Clear(); |
| 356 | else { |
| 357 | Py_DECREF(it); |
| 358 | return NULL; |
| 359 | } |
| 360 | } |
| 361 | Py_DECREF(it); |
| 362 | Py_RETURN_NONE; |
| 363 | } |
Raymond Hettinger | 060c7f6 | 2009-03-10 09:36:07 +0000 | [diff] [blame] | 364 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 365 | /* Run an iterator to exhaustion. Shortcut for |
Raymond Hettinger | 060c7f6 | 2009-03-10 09:36:07 +0000 | [diff] [blame] | 366 | the extend/extendleft methods when maxlen == 0. */ |
| 367 | static PyObject* |
| 368 | consume_iterator(PyObject *it) |
| 369 | { |
Raymond Hettinger | fd265f4 | 2015-10-02 23:17:33 -0700 | [diff] [blame] | 370 | PyObject *(*iternext)(PyObject *); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 371 | PyObject *item; |
Raymond Hettinger | 060c7f6 | 2009-03-10 09:36:07 +0000 | [diff] [blame] | 372 | |
Raymond Hettinger | fd265f4 | 2015-10-02 23:17:33 -0700 | [diff] [blame] | 373 | iternext = *Py_TYPE(it)->tp_iternext; |
| 374 | while ((item = iternext(it)) != NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 375 | Py_DECREF(item); |
| 376 | } |
Raymond Hettinger | fd265f4 | 2015-10-02 23:17:33 -0700 | [diff] [blame] | 377 | return finalize_iterator(it); |
Raymond Hettinger | 060c7f6 | 2009-03-10 09:36:07 +0000 | [diff] [blame] | 378 | } |
| 379 | |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 380 | static PyObject * |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 381 | deque_extend(dequeobject *deque, PyObject *iterable) |
| 382 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 383 | PyObject *it, *item; |
Raymond Hettinger | 7a84552 | 2015-09-26 01:30:51 -0700 | [diff] [blame] | 384 | PyObject *(*iternext)(PyObject *); |
Raymond Hettinger | 6b1e113 | 2015-10-11 09:43:50 -0700 | [diff] [blame] | 385 | Py_ssize_t maxlen = deque->maxlen; |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 386 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 387 | /* Handle case where id(deque) == id(iterable) */ |
| 388 | if ((PyObject *)deque == iterable) { |
| 389 | PyObject *result; |
| 390 | PyObject *s = PySequence_List(iterable); |
| 391 | if (s == NULL) |
| 392 | return NULL; |
| 393 | result = deque_extend(deque, s); |
| 394 | Py_DECREF(s); |
| 395 | return result; |
| 396 | } |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 397 | |
Raymond Hettinger | d79d5b1 | 2016-03-04 09:55:07 -0800 | [diff] [blame] | 398 | it = PyObject_GetIter(iterable); |
| 399 | if (it == NULL) |
| 400 | return NULL; |
| 401 | |
| 402 | if (maxlen == 0) |
| 403 | return consume_iterator(it); |
| 404 | |
Raymond Hettinger | d9c116c | 2013-07-09 00:13:21 -0700 | [diff] [blame] | 405 | /* Space saving heuristic. Start filling from the left */ |
| 406 | if (Py_SIZE(deque) == 0) { |
| 407 | assert(deque->leftblock == deque->rightblock); |
| 408 | assert(deque->leftindex == deque->rightindex+1); |
| 409 | deque->leftindex = 1; |
| 410 | deque->rightindex = 0; |
| 411 | } |
| 412 | |
Raymond Hettinger | 7a84552 | 2015-09-26 01:30:51 -0700 | [diff] [blame] | 413 | iternext = *Py_TYPE(it)->tp_iternext; |
| 414 | while ((item = iternext(it)) != NULL) { |
Raymond Hettinger | 66953f0 | 2018-07-10 04:17:40 -0700 | [diff] [blame] | 415 | if (deque_append_internal(deque, item, maxlen) == -1) { |
| 416 | Py_DECREF(item); |
| 417 | Py_DECREF(it); |
| 418 | return NULL; |
Raymond Hettinger | 6b1e113 | 2015-10-11 09:43:50 -0700 | [diff] [blame] | 419 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 420 | } |
Raymond Hettinger | fd265f4 | 2015-10-02 23:17:33 -0700 | [diff] [blame] | 421 | return finalize_iterator(it); |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 422 | } |
| 423 | |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 424 | PyDoc_STRVAR(extend_doc, |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 425 | "Extend the right side of the deque with elements from the iterable"); |
| 426 | |
| 427 | static PyObject * |
| 428 | deque_extendleft(dequeobject *deque, PyObject *iterable) |
| 429 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 430 | PyObject *it, *item; |
Raymond Hettinger | 7a84552 | 2015-09-26 01:30:51 -0700 | [diff] [blame] | 431 | PyObject *(*iternext)(PyObject *); |
Raymond Hettinger | 6b1e113 | 2015-10-11 09:43:50 -0700 | [diff] [blame] | 432 | Py_ssize_t maxlen = deque->maxlen; |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 433 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 434 | /* Handle case where id(deque) == id(iterable) */ |
| 435 | if ((PyObject *)deque == iterable) { |
| 436 | PyObject *result; |
| 437 | PyObject *s = PySequence_List(iterable); |
| 438 | if (s == NULL) |
| 439 | return NULL; |
| 440 | result = deque_extendleft(deque, s); |
| 441 | Py_DECREF(s); |
| 442 | return result; |
| 443 | } |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 444 | |
Raymond Hettinger | d79d5b1 | 2016-03-04 09:55:07 -0800 | [diff] [blame] | 445 | it = PyObject_GetIter(iterable); |
| 446 | if (it == NULL) |
| 447 | return NULL; |
| 448 | |
| 449 | if (maxlen == 0) |
| 450 | return consume_iterator(it); |
| 451 | |
Raymond Hettinger | d9c116c | 2013-07-09 00:13:21 -0700 | [diff] [blame] | 452 | /* Space saving heuristic. Start filling from the right */ |
| 453 | if (Py_SIZE(deque) == 0) { |
| 454 | assert(deque->leftblock == deque->rightblock); |
| 455 | assert(deque->leftindex == deque->rightindex+1); |
| 456 | deque->leftindex = BLOCKLEN - 1; |
| 457 | deque->rightindex = BLOCKLEN - 2; |
| 458 | } |
| 459 | |
Raymond Hettinger | 7a84552 | 2015-09-26 01:30:51 -0700 | [diff] [blame] | 460 | iternext = *Py_TYPE(it)->tp_iternext; |
| 461 | while ((item = iternext(it)) != NULL) { |
Raymond Hettinger | 66953f0 | 2018-07-10 04:17:40 -0700 | [diff] [blame] | 462 | if (deque_appendleft_internal(deque, item, maxlen) == -1) { |
| 463 | Py_DECREF(item); |
| 464 | Py_DECREF(it); |
| 465 | return NULL; |
Raymond Hettinger | 6b1e113 | 2015-10-11 09:43:50 -0700 | [diff] [blame] | 466 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 467 | } |
Raymond Hettinger | fd265f4 | 2015-10-02 23:17:33 -0700 | [diff] [blame] | 468 | return finalize_iterator(it); |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 469 | } |
| 470 | |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 471 | PyDoc_STRVAR(extendleft_doc, |
Raymond Hettinger | 3ba85c2 | 2004-02-06 19:04:56 +0000 | [diff] [blame] | 472 | "Extend the left side of the deque with elements from the iterable"); |
| 473 | |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 474 | static PyObject * |
| 475 | deque_inplace_concat(dequeobject *deque, PyObject *other) |
| 476 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 477 | PyObject *result; |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 478 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 479 | result = deque_extend(deque, other); |
| 480 | if (result == NULL) |
| 481 | return result; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 482 | Py_INCREF(deque); |
Raymond Hettinger | 2b2b753 | 2015-09-05 17:05:52 -0700 | [diff] [blame] | 483 | Py_DECREF(result); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 484 | return (PyObject *)deque; |
Raymond Hettinger | 3f9afd8 | 2009-12-10 03:03:02 +0000 | [diff] [blame] | 485 | } |
| 486 | |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 487 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 488 | deque_copy(PyObject *deque, PyObject *Py_UNUSED(ignored)) |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 489 | { |
Oren Milman | 24bd50b | 2018-09-11 21:46:55 +0300 | [diff] [blame] | 490 | PyObject *result; |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 491 | dequeobject *old_deque = (dequeobject *)deque; |
| 492 | if (Py_TYPE(deque) == &deque_type) { |
| 493 | dequeobject *new_deque; |
| 494 | PyObject *rv; |
| 495 | |
| 496 | new_deque = (dequeobject *)deque_new(&deque_type, (PyObject *)NULL, (PyObject *)NULL); |
| 497 | if (new_deque == NULL) |
| 498 | return NULL; |
| 499 | new_deque->maxlen = old_deque->maxlen; |
| 500 | /* Fast path for the deque_repeat() common case where len(deque) == 1 */ |
Raymond Hettinger | 0443ac2 | 2015-10-05 22:52:37 -0400 | [diff] [blame] | 501 | if (Py_SIZE(deque) == 1) { |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 502 | PyObject *item = old_deque->leftblock->data[old_deque->leftindex]; |
| 503 | rv = deque_append(new_deque, item); |
| 504 | } else { |
| 505 | rv = deque_extend(new_deque, deque); |
| 506 | } |
| 507 | if (rv != NULL) { |
| 508 | Py_DECREF(rv); |
| 509 | return (PyObject *)new_deque; |
| 510 | } |
| 511 | Py_DECREF(new_deque); |
| 512 | return NULL; |
| 513 | } |
| 514 | if (old_deque->maxlen < 0) |
Oren Milman | 24bd50b | 2018-09-11 21:46:55 +0300 | [diff] [blame] | 515 | result = PyObject_CallFunctionObjArgs((PyObject *)(Py_TYPE(deque)), |
| 516 | deque, NULL); |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 517 | else |
Oren Milman | 24bd50b | 2018-09-11 21:46:55 +0300 | [diff] [blame] | 518 | result = PyObject_CallFunction((PyObject *)(Py_TYPE(deque)), "Oi", |
| 519 | deque, old_deque->maxlen, NULL); |
| 520 | if (result != NULL && !PyObject_TypeCheck(result, &deque_type)) { |
| 521 | PyErr_Format(PyExc_TypeError, |
| 522 | "%.200s() must return a deque, not %.200s", |
| 523 | Py_TYPE(deque)->tp_name, Py_TYPE(result)->tp_name); |
| 524 | Py_DECREF(result); |
| 525 | return NULL; |
| 526 | } |
| 527 | return result; |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 528 | } |
| 529 | |
| 530 | PyDoc_STRVAR(copy_doc, "Return a shallow copy of a deque."); |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 531 | |
| 532 | static PyObject * |
| 533 | deque_concat(dequeobject *deque, PyObject *other) |
| 534 | { |
Benjamin Peterson | 1a62921 | 2015-04-04 10:52:36 -0400 | [diff] [blame] | 535 | PyObject *new_deque, *result; |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 536 | int rv; |
| 537 | |
| 538 | rv = PyObject_IsInstance(other, (PyObject *)&deque_type); |
| 539 | if (rv <= 0) { |
| 540 | if (rv == 0) { |
| 541 | PyErr_Format(PyExc_TypeError, |
| 542 | "can only concatenate deque (not \"%.200s\") to deque", |
| 543 | other->ob_type->tp_name); |
| 544 | } |
| 545 | return NULL; |
| 546 | } |
| 547 | |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 548 | new_deque = deque_copy((PyObject *)deque, NULL); |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 549 | if (new_deque == NULL) |
| 550 | return NULL; |
Benjamin Peterson | 1a62921 | 2015-04-04 10:52:36 -0400 | [diff] [blame] | 551 | result = deque_extend((dequeobject *)new_deque, other); |
| 552 | if (result == NULL) { |
| 553 | Py_DECREF(new_deque); |
| 554 | return NULL; |
| 555 | } |
| 556 | Py_DECREF(result); |
| 557 | return new_deque; |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 558 | } |
| 559 | |
Serhiy Storchaka | a5c4228 | 2018-05-31 07:34:34 +0300 | [diff] [blame] | 560 | static int |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 561 | deque_clear(dequeobject *deque) |
| 562 | { |
| 563 | block *b; |
| 564 | block *prevblock; |
| 565 | block *leftblock; |
| 566 | Py_ssize_t leftindex; |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 567 | Py_ssize_t n, m; |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 568 | PyObject *item; |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 569 | PyObject **itemptr, **limit; |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 570 | |
Raymond Hettinger | 3803114 | 2015-09-29 22:45:05 -0700 | [diff] [blame] | 571 | if (Py_SIZE(deque) == 0) |
Serhiy Storchaka | a5c4228 | 2018-05-31 07:34:34 +0300 | [diff] [blame] | 572 | return 0; |
Raymond Hettinger | 3803114 | 2015-09-29 22:45:05 -0700 | [diff] [blame] | 573 | |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 574 | /* During the process of clearing a deque, decrefs can cause the |
| 575 | deque to mutate. To avoid fatal confusion, we have to make the |
| 576 | deque empty before clearing the blocks and never refer to |
| 577 | anything via deque->ref while clearing. (This is the same |
| 578 | technique used for clearing lists, sets, and dicts.) |
| 579 | |
| 580 | Making the deque empty requires allocating a new empty block. In |
| 581 | the unlikely event that memory is full, we fall back to an |
| 582 | alternate method that doesn't require a new block. Repeating |
| 583 | pops in a while-loop is slower, possibly re-entrant (and a clever |
| 584 | adversary could cause it to never terminate). |
| 585 | */ |
| 586 | |
Raymond Hettinger | db41fd4 | 2015-10-22 22:48:16 -0700 | [diff] [blame] | 587 | b = newblock(); |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 588 | if (b == NULL) { |
| 589 | PyErr_Clear(); |
| 590 | goto alternate_method; |
| 591 | } |
| 592 | |
| 593 | /* Remember the old size, leftblock, and leftindex */ |
Raymond Hettinger | 6f86a33 | 2016-03-02 00:30:58 -0800 | [diff] [blame] | 594 | n = Py_SIZE(deque); |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 595 | leftblock = deque->leftblock; |
| 596 | leftindex = deque->leftindex; |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 597 | |
| 598 | /* Set the deque to be empty using the newly allocated block */ |
| 599 | MARK_END(b->leftlink); |
| 600 | MARK_END(b->rightlink); |
| 601 | Py_SIZE(deque) = 0; |
| 602 | deque->leftblock = b; |
| 603 | deque->rightblock = b; |
| 604 | deque->leftindex = CENTER + 1; |
| 605 | deque->rightindex = CENTER; |
| 606 | deque->state++; |
| 607 | |
| 608 | /* Now the old size, leftblock, and leftindex are disconnected from |
| 609 | the empty deque and we can use them to decref the pointers. |
| 610 | */ |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 611 | m = (BLOCKLEN - leftindex > n) ? n : BLOCKLEN - leftindex; |
Raymond Hettinger | 589106b | 2016-03-02 00:06:21 -0800 | [diff] [blame] | 612 | itemptr = &leftblock->data[leftindex]; |
Raymond Hettinger | 6f86a33 | 2016-03-02 00:30:58 -0800 | [diff] [blame] | 613 | limit = itemptr + m; |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 614 | n -= m; |
| 615 | while (1) { |
| 616 | if (itemptr == limit) { |
| 617 | if (n == 0) |
| 618 | break; |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 619 | CHECK_NOT_END(leftblock->rightlink); |
| 620 | prevblock = leftblock; |
| 621 | leftblock = leftblock->rightlink; |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 622 | m = (n > BLOCKLEN) ? BLOCKLEN : n; |
Raymond Hettinger | 589106b | 2016-03-02 00:06:21 -0800 | [diff] [blame] | 623 | itemptr = leftblock->data; |
Raymond Hettinger | 6f86a33 | 2016-03-02 00:30:58 -0800 | [diff] [blame] | 624 | limit = itemptr + m; |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 625 | n -= m; |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 626 | freeblock(prevblock); |
| 627 | } |
Raymond Hettinger | d84ec22 | 2016-01-24 09:12:06 -0800 | [diff] [blame] | 628 | item = *(itemptr++); |
| 629 | Py_DECREF(item); |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 630 | } |
| 631 | CHECK_END(leftblock->rightlink); |
| 632 | freeblock(leftblock); |
Serhiy Storchaka | a5c4228 | 2018-05-31 07:34:34 +0300 | [diff] [blame] | 633 | return 0; |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 634 | |
| 635 | alternate_method: |
| 636 | while (Py_SIZE(deque)) { |
| 637 | item = deque_pop(deque, NULL); |
| 638 | assert (item != NULL); |
| 639 | Py_DECREF(item); |
| 640 | } |
Serhiy Storchaka | a5c4228 | 2018-05-31 07:34:34 +0300 | [diff] [blame] | 641 | return 0; |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 642 | } |
| 643 | |
| 644 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 645 | deque_clearmethod(dequeobject *deque, PyObject *Py_UNUSED(ignored)) |
Raymond Hettinger | 8299e9b | 2015-09-26 21:31:23 -0700 | [diff] [blame] | 646 | { |
| 647 | deque_clear(deque); |
| 648 | Py_RETURN_NONE; |
| 649 | } |
| 650 | |
| 651 | PyDoc_STRVAR(clear_doc, "Remove all elements from the deque."); |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 652 | |
| 653 | static PyObject * |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 654 | deque_inplace_repeat(dequeobject *deque, Py_ssize_t n) |
| 655 | { |
Raymond Hettinger | c22eee6 | 2015-09-26 02:14:50 -0700 | [diff] [blame] | 656 | Py_ssize_t i, m, size; |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 657 | PyObject *seq; |
| 658 | PyObject *rv; |
| 659 | |
| 660 | size = Py_SIZE(deque); |
| 661 | if (size == 0 || n == 1) { |
| 662 | Py_INCREF(deque); |
| 663 | return (PyObject *)deque; |
| 664 | } |
| 665 | |
| 666 | if (n <= 0) { |
| 667 | deque_clear(deque); |
| 668 | Py_INCREF(deque); |
| 669 | return (PyObject *)deque; |
| 670 | } |
| 671 | |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 672 | if (size == 1) { |
| 673 | /* common case, repeating a single element */ |
| 674 | PyObject *item = deque->leftblock->data[deque->leftindex]; |
| 675 | |
Raymond Hettinger | a7f63009 | 2015-10-10 23:56:02 -0400 | [diff] [blame] | 676 | if (deque->maxlen >= 0 && n > deque->maxlen) |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 677 | n = deque->maxlen; |
| 678 | |
Raymond Hettinger | 67c78b5 | 2015-09-12 11:00:20 -0400 | [diff] [blame] | 679 | deque->state++; |
Raymond Hettinger | ad26225 | 2015-09-14 01:03:04 -0400 | [diff] [blame] | 680 | for (i = 0 ; i < n-1 ; ) { |
Raymond Hettinger | 67c78b5 | 2015-09-12 11:00:20 -0400 | [diff] [blame] | 681 | if (deque->rightindex == BLOCKLEN - 1) { |
Raymond Hettinger | db41fd4 | 2015-10-22 22:48:16 -0700 | [diff] [blame] | 682 | block *b = newblock(); |
Raymond Hettinger | 67c78b5 | 2015-09-12 11:00:20 -0400 | [diff] [blame] | 683 | if (b == NULL) { |
| 684 | Py_SIZE(deque) += i; |
| 685 | return NULL; |
| 686 | } |
| 687 | b->leftlink = deque->rightblock; |
| 688 | CHECK_END(deque->rightblock->rightlink); |
| 689 | deque->rightblock->rightlink = b; |
| 690 | deque->rightblock = b; |
| 691 | MARK_END(b->rightlink); |
| 692 | deque->rightindex = -1; |
| 693 | } |
Raymond Hettinger | c22eee6 | 2015-09-26 02:14:50 -0700 | [diff] [blame] | 694 | m = n - 1 - i; |
| 695 | if (m > BLOCKLEN - 1 - deque->rightindex) |
| 696 | m = BLOCKLEN - 1 - deque->rightindex; |
| 697 | i += m; |
| 698 | while (m--) { |
Raymond Hettinger | ad26225 | 2015-09-14 01:03:04 -0400 | [diff] [blame] | 699 | deque->rightindex++; |
| 700 | Py_INCREF(item); |
| 701 | deque->rightblock->data[deque->rightindex] = item; |
| 702 | } |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 703 | } |
Raymond Hettinger | 67c78b5 | 2015-09-12 11:00:20 -0400 | [diff] [blame] | 704 | Py_SIZE(deque) += i; |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 705 | Py_INCREF(deque); |
| 706 | return (PyObject *)deque; |
| 707 | } |
| 708 | |
Raymond Hettinger | 20151f5 | 2015-10-16 22:47:29 -0700 | [diff] [blame] | 709 | if ((size_t)size > PY_SSIZE_T_MAX / (size_t)n) { |
Raymond Hettinger | f5d72f3 | 2015-09-09 22:39:44 -0400 | [diff] [blame] | 710 | return PyErr_NoMemory(); |
| 711 | } |
| 712 | |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 713 | seq = PySequence_List((PyObject *)deque); |
| 714 | if (seq == NULL) |
| 715 | return seq; |
| 716 | |
Louie Lu | 357bad7 | 2017-02-24 11:59:49 +0800 | [diff] [blame] | 717 | /* Reduce the number of repetitions when maxlen would be exceeded */ |
| 718 | if (deque->maxlen >= 0 && n * size > deque->maxlen) |
| 719 | n = (deque->maxlen + size - 1) / size; |
| 720 | |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 721 | for (i = 0 ; i < n-1 ; i++) { |
| 722 | rv = deque_extend(deque, seq); |
| 723 | if (rv == NULL) { |
| 724 | Py_DECREF(seq); |
| 725 | return NULL; |
| 726 | } |
| 727 | Py_DECREF(rv); |
| 728 | } |
| 729 | Py_INCREF(deque); |
| 730 | Py_DECREF(seq); |
| 731 | return (PyObject *)deque; |
| 732 | } |
| 733 | |
Raymond Hettinger | f5d72f3 | 2015-09-09 22:39:44 -0400 | [diff] [blame] | 734 | static PyObject * |
| 735 | deque_repeat(dequeobject *deque, Py_ssize_t n) |
| 736 | { |
| 737 | dequeobject *new_deque; |
Raymond Hettinger | 95e2cc5 | 2015-09-13 02:41:18 -0400 | [diff] [blame] | 738 | PyObject *rv; |
Raymond Hettinger | f5d72f3 | 2015-09-09 22:39:44 -0400 | [diff] [blame] | 739 | |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 740 | new_deque = (dequeobject *)deque_copy((PyObject *) deque, NULL); |
Raymond Hettinger | f5d72f3 | 2015-09-09 22:39:44 -0400 | [diff] [blame] | 741 | if (new_deque == NULL) |
| 742 | return NULL; |
Raymond Hettinger | 95e2cc5 | 2015-09-13 02:41:18 -0400 | [diff] [blame] | 743 | rv = deque_inplace_repeat(new_deque, n); |
| 744 | Py_DECREF(new_deque); |
| 745 | return rv; |
Raymond Hettinger | f5d72f3 | 2015-09-09 22:39:44 -0400 | [diff] [blame] | 746 | } |
| 747 | |
Raymond Hettinger | 5402315 | 2014-04-23 00:58:48 -0700 | [diff] [blame] | 748 | /* The rotate() method is part of the public API and is used internally |
| 749 | as a primitive for other methods. |
| 750 | |
| 751 | Rotation by 1 or -1 is a common case, so any optimizations for high |
| 752 | volume rotations should take care not to penalize the common case. |
| 753 | |
| 754 | Conceptually, a rotate by one is equivalent to a pop on one side and an |
| 755 | append on the other. However, a pop/append pair is unnecessarily slow |
Martin Panter | d2ad571 | 2015-11-02 04:20:33 +0000 | [diff] [blame] | 756 | because it requires an incref/decref pair for an object located randomly |
Raymond Hettinger | 5402315 | 2014-04-23 00:58:48 -0700 | [diff] [blame] | 757 | in memory. It is better to just move the object pointer from one block |
| 758 | to the next without changing the reference count. |
| 759 | |
| 760 | When moving batches of pointers, it is tempting to use memcpy() but that |
| 761 | proved to be slower than a simple loop for a variety of reasons. |
| 762 | Memcpy() cannot know in advance that we're copying pointers instead of |
| 763 | bytes, that the source and destination are pointer aligned and |
| 764 | non-overlapping, that moving just one pointer is a common case, that we |
| 765 | never need to move more than BLOCKLEN pointers, and that at least one |
| 766 | pointer is always moved. |
| 767 | |
| 768 | For high volume rotations, newblock() and freeblock() are never called |
| 769 | more than once. Previously emptied blocks are immediately reused as a |
| 770 | destination block. If a block is left-over at the end, it is freed. |
| 771 | */ |
| 772 | |
Raymond Hettinger | dcb9d94 | 2004-10-09 16:02:18 +0000 | [diff] [blame] | 773 | static int |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 774 | _deque_rotate(dequeobject *deque, Py_ssize_t n) |
Raymond Hettinger | 5c5eb86 | 2004-02-07 21:13:00 +0000 | [diff] [blame] | 775 | { |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 776 | block *b = NULL; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 777 | block *leftblock = deque->leftblock; |
| 778 | block *rightblock = deque->rightblock; |
| 779 | Py_ssize_t leftindex = deque->leftindex; |
| 780 | Py_ssize_t rightindex = deque->rightindex; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 781 | Py_ssize_t len=Py_SIZE(deque), halflen=len>>1; |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 782 | int rv = -1; |
Raymond Hettinger | 5c5eb86 | 2004-02-07 21:13:00 +0000 | [diff] [blame] | 783 | |
Raymond Hettinger | 464d89b | 2013-01-11 22:29:50 -0800 | [diff] [blame] | 784 | if (len <= 1) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 785 | return 0; |
| 786 | if (n > halflen || n < -halflen) { |
| 787 | n %= len; |
| 788 | if (n > halflen) |
| 789 | n -= len; |
| 790 | else if (n < -halflen) |
| 791 | n += len; |
| 792 | } |
Raymond Hettinger | 1f0044c | 2013-02-05 01:30:46 -0500 | [diff] [blame] | 793 | assert(len > 1); |
Raymond Hettinger | a4409c1 | 2013-02-04 00:08:12 -0500 | [diff] [blame] | 794 | assert(-halflen <= n && n <= halflen); |
Raymond Hettinger | 231ee4d | 2013-02-02 11:24:43 -0800 | [diff] [blame] | 795 | |
Raymond Hettinger | 464d89b | 2013-01-11 22:29:50 -0800 | [diff] [blame] | 796 | deque->state++; |
Raymond Hettinger | 1f0044c | 2013-02-05 01:30:46 -0500 | [diff] [blame] | 797 | while (n > 0) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 798 | if (leftindex == 0) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 799 | if (b == NULL) { |
Raymond Hettinger | db41fd4 | 2015-10-22 22:48:16 -0700 | [diff] [blame] | 800 | b = newblock(); |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 801 | if (b == NULL) |
| 802 | goto done; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 803 | } |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 804 | b->rightlink = leftblock; |
| 805 | CHECK_END(leftblock->leftlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 806 | leftblock->leftlink = b; |
| 807 | leftblock = b; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 808 | MARK_END(b->leftlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 809 | leftindex = BLOCKLEN; |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 810 | b = NULL; |
Raymond Hettinger | 464d89b | 2013-01-11 22:29:50 -0800 | [diff] [blame] | 811 | } |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 812 | assert(leftindex > 0); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 813 | { |
| 814 | PyObject **src, **dest; |
| 815 | Py_ssize_t m = n; |
Raymond Hettinger | 21777ac | 2013-02-02 09:56:08 -0800 | [diff] [blame] | 816 | |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 817 | if (m > rightindex + 1) |
| 818 | m = rightindex + 1; |
| 819 | if (m > leftindex) |
| 820 | m = leftindex; |
| 821 | assert (m > 0 && m <= len); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 822 | rightindex -= m; |
| 823 | leftindex -= m; |
Raymond Hettinger | 0e259f1 | 2015-02-01 22:53:41 -0800 | [diff] [blame] | 824 | src = &rightblock->data[rightindex + 1]; |
| 825 | dest = &leftblock->data[leftindex]; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 826 | n -= m; |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 827 | do { |
Raymond Hettinger | 0e259f1 | 2015-02-01 22:53:41 -0800 | [diff] [blame] | 828 | *(dest++) = *(src++); |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 829 | } while (--m); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 830 | } |
Raymond Hettinger | d3d2b2c | 2015-09-21 23:41:56 -0700 | [diff] [blame] | 831 | if (rightindex < 0) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 832 | assert(leftblock != rightblock); |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 833 | assert(b == NULL); |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 834 | b = rightblock; |
Raymond Hettinger | b97cc49 | 2013-07-21 01:51:07 -0700 | [diff] [blame] | 835 | CHECK_NOT_END(rightblock->leftlink); |
| 836 | rightblock = rightblock->leftlink; |
| 837 | MARK_END(rightblock->rightlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 838 | rightindex = BLOCKLEN - 1; |
Raymond Hettinger | 464d89b | 2013-01-11 22:29:50 -0800 | [diff] [blame] | 839 | } |
Raymond Hettinger | 21777ac | 2013-02-02 09:56:08 -0800 | [diff] [blame] | 840 | } |
Raymond Hettinger | 1f0044c | 2013-02-05 01:30:46 -0500 | [diff] [blame] | 841 | while (n < 0) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 842 | if (rightindex == BLOCKLEN - 1) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 843 | if (b == NULL) { |
Raymond Hettinger | db41fd4 | 2015-10-22 22:48:16 -0700 | [diff] [blame] | 844 | b = newblock(); |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 845 | if (b == NULL) |
| 846 | goto done; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 847 | } |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 848 | b->leftlink = rightblock; |
| 849 | CHECK_END(rightblock->rightlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 850 | rightblock->rightlink = b; |
| 851 | rightblock = b; |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 852 | MARK_END(b->rightlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 853 | rightindex = -1; |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 854 | b = NULL; |
Raymond Hettinger | 464d89b | 2013-01-11 22:29:50 -0800 | [diff] [blame] | 855 | } |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 856 | assert (rightindex < BLOCKLEN - 1); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 857 | { |
| 858 | PyObject **src, **dest; |
| 859 | Py_ssize_t m = -n; |
Raymond Hettinger | 21777ac | 2013-02-02 09:56:08 -0800 | [diff] [blame] | 860 | |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 861 | if (m > BLOCKLEN - leftindex) |
| 862 | m = BLOCKLEN - leftindex; |
| 863 | if (m > BLOCKLEN - 1 - rightindex) |
| 864 | m = BLOCKLEN - 1 - rightindex; |
| 865 | assert (m > 0 && m <= len); |
| 866 | src = &leftblock->data[leftindex]; |
| 867 | dest = &rightblock->data[rightindex + 1]; |
| 868 | leftindex += m; |
| 869 | rightindex += m; |
| 870 | n += m; |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 871 | do { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 872 | *(dest++) = *(src++); |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 873 | } while (--m); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 874 | } |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 875 | if (leftindex == BLOCKLEN) { |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 876 | assert(leftblock != rightblock); |
Raymond Hettinger | 840533b | 2013-07-13 17:03:58 -0700 | [diff] [blame] | 877 | assert(b == NULL); |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 878 | b = leftblock; |
Raymond Hettinger | b97cc49 | 2013-07-21 01:51:07 -0700 | [diff] [blame] | 879 | CHECK_NOT_END(leftblock->rightlink); |
| 880 | leftblock = leftblock->rightlink; |
| 881 | MARK_END(leftblock->leftlink); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 882 | leftindex = 0; |
Raymond Hettinger | 21777ac | 2013-02-02 09:56:08 -0800 | [diff] [blame] | 883 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 884 | } |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 885 | rv = 0; |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 886 | done: |
Raymond Hettinger | 3959af9 | 2013-07-13 02:34:08 -0700 | [diff] [blame] | 887 | if (b != NULL) |
| 888 | freeblock(b); |
Raymond Hettinger | 20b0f87 | 2013-06-23 15:44:33 -0700 | [diff] [blame] | 889 | deque->leftblock = leftblock; |
| 890 | deque->rightblock = rightblock; |
| 891 | deque->leftindex = leftindex; |
| 892 | deque->rightindex = rightindex; |
| 893 | |
| 894 | return rv; |
Raymond Hettinger | dcb9d94 | 2004-10-09 16:02:18 +0000 | [diff] [blame] | 895 | } |
| 896 | |
| 897 | static PyObject * |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 898 | deque_rotate(dequeobject *deque, PyObject *const *args, Py_ssize_t nargs) |
Raymond Hettinger | dcb9d94 | 2004-10-09 16:02:18 +0000 | [diff] [blame] | 899 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 900 | Py_ssize_t n=1; |
Raymond Hettinger | dcb9d94 | 2004-10-09 16:02:18 +0000 | [diff] [blame] | 901 | |
Victor Stinner | dd407d5 | 2017-02-06 16:06:49 +0100 | [diff] [blame] | 902 | if (!_PyArg_ParseStack(args, nargs, "|n:rotate", &n)) { |
| 903 | return NULL; |
| 904 | } |
| 905 | |
Raymond Hettinger | 6921c13 | 2015-03-21 02:03:40 -0700 | [diff] [blame] | 906 | if (!_deque_rotate(deque, n)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 907 | Py_RETURN_NONE; |
| 908 | return NULL; |
Raymond Hettinger | 5c5eb86 | 2004-02-07 21:13:00 +0000 | [diff] [blame] | 909 | } |
| 910 | |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 911 | PyDoc_STRVAR(rotate_doc, |
Raymond Hettinger | ee33b27 | 2004-02-08 04:05:26 +0000 | [diff] [blame] | 912 | "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] | 913 | |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 914 | static PyObject * |
| 915 | deque_reverse(dequeobject *deque, PyObject *unused) |
| 916 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 917 | block *leftblock = deque->leftblock; |
| 918 | block *rightblock = deque->rightblock; |
| 919 | Py_ssize_t leftindex = deque->leftindex; |
| 920 | Py_ssize_t rightindex = deque->rightindex; |
Raymond Hettinger | cfe5b6c | 2015-07-20 00:25:50 -0400 | [diff] [blame] | 921 | Py_ssize_t n = Py_SIZE(deque) >> 1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 922 | PyObject *tmp; |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 923 | |
Raymond Hettinger | e1b0287 | 2017-09-04 16:07:06 -0700 | [diff] [blame] | 924 | while (--n >= 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 925 | /* Validate that pointers haven't met in the middle */ |
| 926 | assert(leftblock != rightblock || leftindex < rightindex); |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 927 | CHECK_NOT_END(leftblock); |
| 928 | CHECK_NOT_END(rightblock); |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 929 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 930 | /* Swap */ |
| 931 | tmp = leftblock->data[leftindex]; |
| 932 | leftblock->data[leftindex] = rightblock->data[rightindex]; |
| 933 | rightblock->data[rightindex] = tmp; |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 934 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 935 | /* Advance left block/index pair */ |
| 936 | leftindex++; |
| 937 | if (leftindex == BLOCKLEN) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 938 | leftblock = leftblock->rightlink; |
| 939 | leftindex = 0; |
| 940 | } |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 941 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 942 | /* Step backwards with the right block/index pair */ |
| 943 | rightindex--; |
Raymond Hettinger | d3d2b2c | 2015-09-21 23:41:56 -0700 | [diff] [blame] | 944 | if (rightindex < 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 945 | rightblock = rightblock->leftlink; |
| 946 | rightindex = BLOCKLEN - 1; |
| 947 | } |
| 948 | } |
| 949 | Py_RETURN_NONE; |
Raymond Hettinger | e5fdedb | 2009-12-10 00:47:21 +0000 | [diff] [blame] | 950 | } |
| 951 | |
| 952 | PyDoc_STRVAR(reverse_doc, |
| 953 | "D.reverse() -- reverse *IN PLACE*"); |
| 954 | |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 955 | static PyObject * |
| 956 | deque_count(dequeobject *deque, PyObject *v) |
| 957 | { |
Raymond Hettinger | f3a67b7 | 2013-07-06 17:49:06 -1000 | [diff] [blame] | 958 | block *b = deque->leftblock; |
| 959 | Py_ssize_t index = deque->leftindex; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 960 | Py_ssize_t n = Py_SIZE(deque); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 961 | Py_ssize_t count = 0; |
Raymond Hettinger | f9d9c79 | 2015-03-02 22:47:46 -0800 | [diff] [blame] | 962 | size_t start_state = deque->state; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 963 | PyObject *item; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 964 | int cmp; |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 965 | |
Raymond Hettinger | e1b0287 | 2017-09-04 16:07:06 -0700 | [diff] [blame] | 966 | while (--n >= 0) { |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 967 | CHECK_NOT_END(b); |
Raymond Hettinger | f3a67b7 | 2013-07-06 17:49:06 -1000 | [diff] [blame] | 968 | item = b->data[index]; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 969 | cmp = PyObject_RichCompareBool(item, v, Py_EQ); |
Raymond Hettinger | 2b0d646 | 2015-09-23 19:15:44 -0700 | [diff] [blame] | 970 | if (cmp < 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 971 | return NULL; |
Raymond Hettinger | 2b0d646 | 2015-09-23 19:15:44 -0700 | [diff] [blame] | 972 | count += cmp; |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 973 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 974 | if (start_state != deque->state) { |
| 975 | PyErr_SetString(PyExc_RuntimeError, |
| 976 | "deque mutated during iteration"); |
| 977 | return NULL; |
| 978 | } |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 979 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 980 | /* Advance left block/index pair */ |
Raymond Hettinger | f3a67b7 | 2013-07-06 17:49:06 -1000 | [diff] [blame] | 981 | index++; |
| 982 | if (index == BLOCKLEN) { |
| 983 | b = b->rightlink; |
| 984 | index = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 985 | } |
| 986 | } |
| 987 | return PyLong_FromSsize_t(count); |
Raymond Hettinger | 44459de | 2010-04-03 23:20:46 +0000 | [diff] [blame] | 988 | } |
| 989 | |
| 990 | PyDoc_STRVAR(count_doc, |
| 991 | "D.count(value) -> integer -- return number of occurrences of value"); |
| 992 | |
Raymond Hettinger | 39dadf7 | 2015-03-20 16:38:56 -0700 | [diff] [blame] | 993 | static int |
| 994 | deque_contains(dequeobject *deque, PyObject *v) |
| 995 | { |
| 996 | block *b = deque->leftblock; |
| 997 | Py_ssize_t index = deque->leftindex; |
| 998 | Py_ssize_t n = Py_SIZE(deque); |
Raymond Hettinger | 39dadf7 | 2015-03-20 16:38:56 -0700 | [diff] [blame] | 999 | size_t start_state = deque->state; |
| 1000 | PyObject *item; |
| 1001 | int cmp; |
| 1002 | |
Raymond Hettinger | e1b0287 | 2017-09-04 16:07:06 -0700 | [diff] [blame] | 1003 | while (--n >= 0) { |
Raymond Hettinger | 39dadf7 | 2015-03-20 16:38:56 -0700 | [diff] [blame] | 1004 | CHECK_NOT_END(b); |
| 1005 | item = b->data[index]; |
| 1006 | cmp = PyObject_RichCompareBool(item, v, Py_EQ); |
| 1007 | if (cmp) { |
| 1008 | return cmp; |
| 1009 | } |
| 1010 | if (start_state != deque->state) { |
| 1011 | PyErr_SetString(PyExc_RuntimeError, |
| 1012 | "deque mutated during iteration"); |
| 1013 | return -1; |
| 1014 | } |
| 1015 | index++; |
| 1016 | if (index == BLOCKLEN) { |
| 1017 | b = b->rightlink; |
| 1018 | index = 0; |
| 1019 | } |
| 1020 | } |
| 1021 | return 0; |
| 1022 | } |
| 1023 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1024 | static Py_ssize_t |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1025 | deque_len(dequeobject *deque) |
| 1026 | { |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1027 | return Py_SIZE(deque); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1028 | } |
| 1029 | |
Raymond Hettinger | 4aec61e | 2005-03-18 21:20:23 +0000 | [diff] [blame] | 1030 | static PyObject * |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 1031 | deque_index(dequeobject *deque, PyObject *const *args, Py_ssize_t nargs) |
Raymond Hettinger | 32ea165 | 2015-03-21 01:37:37 -0700 | [diff] [blame] | 1032 | { |
Raymond Hettinger | 67b97b8 | 2015-11-01 23:57:37 -0500 | [diff] [blame] | 1033 | Py_ssize_t i, n, start=0, stop=Py_SIZE(deque); |
Raymond Hettinger | 32ea165 | 2015-03-21 01:37:37 -0700 | [diff] [blame] | 1034 | PyObject *v, *item; |
| 1035 | block *b = deque->leftblock; |
| 1036 | Py_ssize_t index = deque->leftindex; |
| 1037 | size_t start_state = deque->state; |
Raymond Hettinger | 67b97b8 | 2015-11-01 23:57:37 -0500 | [diff] [blame] | 1038 | int cmp; |
Raymond Hettinger | 32ea165 | 2015-03-21 01:37:37 -0700 | [diff] [blame] | 1039 | |
Victor Stinner | dd407d5 | 2017-02-06 16:06:49 +0100 | [diff] [blame] | 1040 | if (!_PyArg_ParseStack(args, nargs, "O|O&O&:index", &v, |
Serhiy Storchaka | d4edfc9 | 2017-03-30 18:29:23 +0300 | [diff] [blame] | 1041 | _PyEval_SliceIndexNotNone, &start, |
| 1042 | _PyEval_SliceIndexNotNone, &stop)) { |
Victor Stinner | dd407d5 | 2017-02-06 16:06:49 +0100 | [diff] [blame] | 1043 | return NULL; |
| 1044 | } |
| 1045 | |
Raymond Hettinger | 32ea165 | 2015-03-21 01:37:37 -0700 | [diff] [blame] | 1046 | if (start < 0) { |
| 1047 | start += Py_SIZE(deque); |
| 1048 | if (start < 0) |
| 1049 | start = 0; |
| 1050 | } |
| 1051 | if (stop < 0) { |
| 1052 | stop += Py_SIZE(deque); |
| 1053 | if (stop < 0) |
| 1054 | stop = 0; |
| 1055 | } |
Raymond Hettinger | 87674ec | 2015-08-26 08:08:38 -0700 | [diff] [blame] | 1056 | if (stop > Py_SIZE(deque)) |
| 1057 | stop = Py_SIZE(deque); |
Raymond Hettinger | 67b97b8 | 2015-11-01 23:57:37 -0500 | [diff] [blame] | 1058 | if (start > stop) |
| 1059 | start = stop; |
| 1060 | assert(0 <= start && start <= stop && stop <= Py_SIZE(deque)); |
Raymond Hettinger | 32ea165 | 2015-03-21 01:37:37 -0700 | [diff] [blame] | 1061 | |
Raymond Hettinger | b46ad54 | 2018-09-21 01:46:41 -0700 | [diff] [blame] | 1062 | for (i=0 ; i < start - BLOCKLEN ; i += BLOCKLEN) { |
| 1063 | b = b->rightlink; |
| 1064 | } |
| 1065 | for ( ; i < start ; i++) { |
Raymond Hettinger | 67b97b8 | 2015-11-01 23:57:37 -0500 | [diff] [blame] | 1066 | index++; |
| 1067 | if (index == BLOCKLEN) { |
| 1068 | b = b->rightlink; |
| 1069 | index = 0; |
| 1070 | } |
| 1071 | } |
| 1072 | |
Raymond Hettinger | e1b0287 | 2017-09-04 16:07:06 -0700 | [diff] [blame] | 1073 | n = stop - i; |
| 1074 | while (--n >= 0) { |
Raymond Hettinger | 67b97b8 | 2015-11-01 23:57:37 -0500 | [diff] [blame] | 1075 | CHECK_NOT_END(b); |
| 1076 | item = b->data[index]; |
| 1077 | cmp = PyObject_RichCompareBool(item, v, Py_EQ); |
| 1078 | if (cmp > 0) |
Raymond Hettinger | e1b0287 | 2017-09-04 16:07:06 -0700 | [diff] [blame] | 1079 | return PyLong_FromSsize_t(stop - n - 1); |
Raymond Hettinger | df8f5b5 | 2015-11-02 07:27:40 -0500 | [diff] [blame] | 1080 | if (cmp < 0) |
Raymond Hettinger | 67b97b8 | 2015-11-01 23:57:37 -0500 | [diff] [blame] | 1081 | return NULL; |
| 1082 | if (start_state != deque->state) { |
| 1083 | PyErr_SetString(PyExc_RuntimeError, |
| 1084 | "deque mutated during iteration"); |
| 1085 | return NULL; |
Raymond Hettinger | 32ea165 | 2015-03-21 01:37:37 -0700 | [diff] [blame] | 1086 | } |
| 1087 | index++; |
| 1088 | if (index == BLOCKLEN) { |
| 1089 | b = b->rightlink; |
| 1090 | index = 0; |
| 1091 | } |
| 1092 | } |
| 1093 | PyErr_Format(PyExc_ValueError, "%R is not in deque", v); |
| 1094 | return NULL; |
| 1095 | } |
| 1096 | |
| 1097 | PyDoc_STRVAR(index_doc, |
| 1098 | "D.index(value, [start, [stop]]) -> integer -- return first index of value.\n" |
| 1099 | "Raises ValueError if the value is not present."); |
| 1100 | |
Raymond Hettinger | 551350a | 2015-03-24 00:19:53 -0700 | [diff] [blame] | 1101 | /* insert(), remove(), and delitem() are implemented in terms of |
| 1102 | rotate() for simplicity and reasonable performance near the end |
| 1103 | points. If for some reason these methods become popular, it is not |
| 1104 | hard to re-implement this using direct data movement (similar to |
| 1105 | the code used in list slice assignments) and achieve a performance |
Raymond Hettinger | fef9c1b | 2015-03-24 21:12:57 -0700 | [diff] [blame] | 1106 | boost (by moving each pointer only once instead of twice). |
Raymond Hettinger | 551350a | 2015-03-24 00:19:53 -0700 | [diff] [blame] | 1107 | */ |
| 1108 | |
Raymond Hettinger | 32ea165 | 2015-03-21 01:37:37 -0700 | [diff] [blame] | 1109 | static PyObject * |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 1110 | deque_insert(dequeobject *deque, PyObject *const *args, Py_ssize_t nargs) |
Raymond Hettinger | 32ea165 | 2015-03-21 01:37:37 -0700 | [diff] [blame] | 1111 | { |
| 1112 | Py_ssize_t index; |
| 1113 | Py_ssize_t n = Py_SIZE(deque); |
| 1114 | PyObject *value; |
| 1115 | PyObject *rv; |
| 1116 | |
Victor Stinner | dd407d5 | 2017-02-06 16:06:49 +0100 | [diff] [blame] | 1117 | if (!_PyArg_ParseStack(args, nargs, "nO:insert", &index, &value)) { |
| 1118 | return NULL; |
| 1119 | } |
| 1120 | |
Raymond Hettinger | 3743432 | 2016-01-26 21:44:16 -0800 | [diff] [blame] | 1121 | if (deque->maxlen == Py_SIZE(deque)) { |
Raymond Hettinger | a638971 | 2016-02-01 21:21:19 -0800 | [diff] [blame] | 1122 | PyErr_SetString(PyExc_IndexError, "deque already at its maximum size"); |
| 1123 | return NULL; |
Raymond Hettinger | 3743432 | 2016-01-26 21:44:16 -0800 | [diff] [blame] | 1124 | } |
Raymond Hettinger | 32ea165 | 2015-03-21 01:37:37 -0700 | [diff] [blame] | 1125 | if (index >= n) |
| 1126 | return deque_append(deque, value); |
| 1127 | if (index <= -n || index == 0) |
| 1128 | return deque_appendleft(deque, value); |
| 1129 | if (_deque_rotate(deque, -index)) |
| 1130 | return NULL; |
| 1131 | if (index < 0) |
| 1132 | rv = deque_append(deque, value); |
| 1133 | else |
| 1134 | rv = deque_appendleft(deque, value); |
| 1135 | if (rv == NULL) |
| 1136 | return NULL; |
| 1137 | Py_DECREF(rv); |
| 1138 | if (_deque_rotate(deque, index)) |
| 1139 | return NULL; |
| 1140 | Py_RETURN_NONE; |
| 1141 | } |
| 1142 | |
| 1143 | PyDoc_STRVAR(insert_doc, |
| 1144 | "D.insert(index, object) -- insert object before index"); |
| 1145 | |
| 1146 | static PyObject * |
Raymond Hettinger | 4aec61e | 2005-03-18 21:20:23 +0000 | [diff] [blame] | 1147 | deque_remove(dequeobject *deque, PyObject *value) |
| 1148 | { |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1149 | Py_ssize_t i, n=Py_SIZE(deque); |
Raymond Hettinger | 4aec61e | 2005-03-18 21:20:23 +0000 | [diff] [blame] | 1150 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1151 | for (i=0 ; i<n ; i++) { |
| 1152 | PyObject *item = deque->leftblock->data[deque->leftindex]; |
| 1153 | int cmp = PyObject_RichCompareBool(item, value, Py_EQ); |
Raymond Hettinger | d73202c | 2005-03-19 00:00:51 +0000 | [diff] [blame] | 1154 | |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1155 | if (Py_SIZE(deque) != n) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1156 | PyErr_SetString(PyExc_IndexError, |
| 1157 | "deque mutated during remove()."); |
| 1158 | return NULL; |
| 1159 | } |
| 1160 | if (cmp > 0) { |
| 1161 | PyObject *tgt = deque_popleft(deque, NULL); |
| 1162 | assert (tgt != NULL); |
Raymond Hettinger | 6921c13 | 2015-03-21 02:03:40 -0700 | [diff] [blame] | 1163 | if (_deque_rotate(deque, i)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1164 | return NULL; |
Raymond Hettinger | ac13ad6 | 2015-03-21 01:53:16 -0700 | [diff] [blame] | 1165 | Py_DECREF(tgt); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1166 | Py_RETURN_NONE; |
| 1167 | } |
| 1168 | else if (cmp < 0) { |
| 1169 | _deque_rotate(deque, i); |
| 1170 | return NULL; |
| 1171 | } |
| 1172 | _deque_rotate(deque, -1); |
| 1173 | } |
| 1174 | PyErr_SetString(PyExc_ValueError, "deque.remove(x): x not in deque"); |
| 1175 | return NULL; |
Raymond Hettinger | 4aec61e | 2005-03-18 21:20:23 +0000 | [diff] [blame] | 1176 | } |
| 1177 | |
| 1178 | PyDoc_STRVAR(remove_doc, |
| 1179 | "D.remove(value) -- remove first occurrence of value."); |
| 1180 | |
Raymond Hettinger | 3c186ba | 2015-03-02 21:45:02 -0800 | [diff] [blame] | 1181 | static int |
| 1182 | valid_index(Py_ssize_t i, Py_ssize_t limit) |
| 1183 | { |
Raymond Hettinger | 12f896c | 2015-07-31 12:03:20 -0700 | [diff] [blame] | 1184 | /* The cast to size_t lets us use just a single comparison |
Raymond Hettinger | 3c186ba | 2015-03-02 21:45:02 -0800 | [diff] [blame] | 1185 | to check whether i is in the range: 0 <= i < limit */ |
| 1186 | return (size_t) i < (size_t) limit; |
| 1187 | } |
| 1188 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1189 | static PyObject * |
Benjamin Peterson | d631371 | 2008-07-31 16:23:04 +0000 | [diff] [blame] | 1190 | deque_item(dequeobject *deque, Py_ssize_t i) |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 1191 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1192 | block *b; |
| 1193 | PyObject *item; |
| 1194 | Py_ssize_t n, index=i; |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 1195 | |
Raymond Hettinger | 3c186ba | 2015-03-02 21:45:02 -0800 | [diff] [blame] | 1196 | if (!valid_index(i, Py_SIZE(deque))) { |
| 1197 | PyErr_SetString(PyExc_IndexError, "deque index out of range"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1198 | return NULL; |
| 1199 | } |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 1200 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1201 | if (i == 0) { |
| 1202 | i = deque->leftindex; |
| 1203 | b = deque->leftblock; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1204 | } else if (i == Py_SIZE(deque) - 1) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1205 | i = deque->rightindex; |
| 1206 | b = deque->rightblock; |
| 1207 | } else { |
| 1208 | i += deque->leftindex; |
Raymond Hettinger | c208308 | 2015-02-28 23:29:16 -0800 | [diff] [blame] | 1209 | n = (Py_ssize_t)((size_t) i / BLOCKLEN); |
| 1210 | i = (Py_ssize_t)((size_t) i % BLOCKLEN); |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1211 | if (index < (Py_SIZE(deque) >> 1)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1212 | b = deque->leftblock; |
Raymond Hettinger | e1b0287 | 2017-09-04 16:07:06 -0700 | [diff] [blame] | 1213 | while (--n >= 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1214 | b = b->rightlink; |
| 1215 | } else { |
Raymond Hettinger | 63d1ff2 | 2015-02-28 07:41:30 -0800 | [diff] [blame] | 1216 | n = (Py_ssize_t)( |
Raymond Hettinger | c208308 | 2015-02-28 23:29:16 -0800 | [diff] [blame] | 1217 | ((size_t)(deque->leftindex + Py_SIZE(deque) - 1)) |
Raymond Hettinger | 63d1ff2 | 2015-02-28 07:41:30 -0800 | [diff] [blame] | 1218 | / BLOCKLEN - n); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1219 | b = deque->rightblock; |
Raymond Hettinger | e1b0287 | 2017-09-04 16:07:06 -0700 | [diff] [blame] | 1220 | while (--n >= 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1221 | b = b->leftlink; |
| 1222 | } |
| 1223 | } |
| 1224 | item = b->data[i]; |
| 1225 | Py_INCREF(item); |
| 1226 | return item; |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 1227 | } |
| 1228 | |
| 1229 | static int |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1230 | deque_del_item(dequeobject *deque, Py_ssize_t i) |
Raymond Hettinger | 0e371f2 | 2004-05-12 20:55:56 +0000 | [diff] [blame] | 1231 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1232 | PyObject *item; |
Raymond Hettinger | ac13ad6 | 2015-03-21 01:53:16 -0700 | [diff] [blame] | 1233 | int rv; |
Raymond Hettinger | 0e371f2 | 2004-05-12 20:55:56 +0000 | [diff] [blame] | 1234 | |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1235 | assert (i >= 0 && i < Py_SIZE(deque)); |
Raymond Hettinger | 6921c13 | 2015-03-21 02:03:40 -0700 | [diff] [blame] | 1236 | if (_deque_rotate(deque, -i)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1237 | return -1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1238 | item = deque_popleft(deque, NULL); |
Raymond Hettinger | ac13ad6 | 2015-03-21 01:53:16 -0700 | [diff] [blame] | 1239 | rv = _deque_rotate(deque, i); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1240 | assert (item != NULL); |
| 1241 | Py_DECREF(item); |
Raymond Hettinger | ac13ad6 | 2015-03-21 01:53:16 -0700 | [diff] [blame] | 1242 | return rv; |
Raymond Hettinger | 0e371f2 | 2004-05-12 20:55:56 +0000 | [diff] [blame] | 1243 | } |
| 1244 | |
| 1245 | static int |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1246 | deque_ass_item(dequeobject *deque, Py_ssize_t i, PyObject *v) |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 1247 | { |
Raymond Hettinger | 3841866 | 2016-02-08 20:34:49 -0800 | [diff] [blame] | 1248 | PyObject *old_value; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1249 | block *b; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1250 | 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] | 1251 | |
Raymond Hettinger | 3c186ba | 2015-03-02 21:45:02 -0800 | [diff] [blame] | 1252 | if (!valid_index(i, len)) { |
| 1253 | PyErr_SetString(PyExc_IndexError, "deque index out of range"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1254 | return -1; |
| 1255 | } |
| 1256 | if (v == NULL) |
| 1257 | return deque_del_item(deque, i); |
Raymond Hettinger | 0e371f2 | 2004-05-12 20:55:56 +0000 | [diff] [blame] | 1258 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1259 | i += deque->leftindex; |
Raymond Hettinger | c208308 | 2015-02-28 23:29:16 -0800 | [diff] [blame] | 1260 | n = (Py_ssize_t)((size_t) i / BLOCKLEN); |
| 1261 | i = (Py_ssize_t)((size_t) i % BLOCKLEN); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1262 | if (index <= halflen) { |
| 1263 | b = deque->leftblock; |
Raymond Hettinger | e1b0287 | 2017-09-04 16:07:06 -0700 | [diff] [blame] | 1264 | while (--n >= 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1265 | b = b->rightlink; |
| 1266 | } else { |
Raymond Hettinger | a473b9d | 2015-02-28 17:49:47 -0800 | [diff] [blame] | 1267 | n = (Py_ssize_t)( |
Raymond Hettinger | c208308 | 2015-02-28 23:29:16 -0800 | [diff] [blame] | 1268 | ((size_t)(deque->leftindex + Py_SIZE(deque) - 1)) |
Raymond Hettinger | a473b9d | 2015-02-28 17:49:47 -0800 | [diff] [blame] | 1269 | / BLOCKLEN - n); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1270 | b = deque->rightblock; |
Raymond Hettinger | e1b0287 | 2017-09-04 16:07:06 -0700 | [diff] [blame] | 1271 | while (--n >= 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1272 | b = b->leftlink; |
| 1273 | } |
| 1274 | Py_INCREF(v); |
Raymond Hettinger | 3841866 | 2016-02-08 20:34:49 -0800 | [diff] [blame] | 1275 | old_value = b->data[i]; |
| 1276 | b->data[i] = v; |
| 1277 | Py_DECREF(old_value); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1278 | return 0; |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 1279 | } |
| 1280 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1281 | static void |
| 1282 | deque_dealloc(dequeobject *deque) |
| 1283 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1284 | PyObject_GC_UnTrack(deque); |
| 1285 | if (deque->weakreflist != NULL) |
| 1286 | PyObject_ClearWeakRefs((PyObject *) deque); |
| 1287 | if (deque->leftblock != NULL) { |
| 1288 | deque_clear(deque); |
| 1289 | assert(deque->leftblock != NULL); |
| 1290 | freeblock(deque->leftblock); |
| 1291 | } |
| 1292 | deque->leftblock = NULL; |
| 1293 | deque->rightblock = NULL; |
| 1294 | Py_TYPE(deque)->tp_free(deque); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1295 | } |
| 1296 | |
| 1297 | static int |
Raymond Hettinger | 0a4977c | 2004-03-01 23:16:22 +0000 | [diff] [blame] | 1298 | deque_traverse(dequeobject *deque, visitproc visit, void *arg) |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1299 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1300 | block *b; |
| 1301 | PyObject *item; |
| 1302 | Py_ssize_t index; |
| 1303 | Py_ssize_t indexlo = deque->leftindex; |
Raymond Hettinger | 1286d14 | 2015-10-14 23:16:57 -0700 | [diff] [blame] | 1304 | Py_ssize_t indexhigh; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1305 | |
Raymond Hettinger | 5bfa867 | 2013-07-06 11:58:09 -1000 | [diff] [blame] | 1306 | for (b = deque->leftblock; b != deque->rightblock; b = b->rightlink) { |
| 1307 | for (index = indexlo; index < BLOCKLEN ; index++) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1308 | item = b->data[index]; |
| 1309 | Py_VISIT(item); |
| 1310 | } |
| 1311 | indexlo = 0; |
| 1312 | } |
Raymond Hettinger | 1286d14 | 2015-10-14 23:16:57 -0700 | [diff] [blame] | 1313 | indexhigh = deque->rightindex; |
| 1314 | for (index = indexlo; index <= indexhigh; index++) { |
Raymond Hettinger | 5bfa867 | 2013-07-06 11:58:09 -1000 | [diff] [blame] | 1315 | item = b->data[index]; |
| 1316 | Py_VISIT(item); |
| 1317 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1318 | return 0; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1319 | } |
| 1320 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1321 | static PyObject * |
Serhiy Storchaka | 8152402 | 2018-11-27 13:05:02 +0200 | [diff] [blame] | 1322 | deque_reduce(dequeobject *deque, PyObject *Py_UNUSED(ignored)) |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1323 | { |
Serhiy Storchaka | a0d416f | 2016-03-06 08:55:21 +0200 | [diff] [blame] | 1324 | PyObject *dict, *it; |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 1325 | _Py_IDENTIFIER(__dict__); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1326 | |
Serhiy Storchaka | f320be7 | 2018-01-25 10:49:40 +0200 | [diff] [blame] | 1327 | if (_PyObject_LookupAttrId((PyObject *)deque, &PyId___dict__, &dict) < 0) { |
| 1328 | return NULL; |
| 1329 | } |
Serhiy Storchaka | a0d416f | 2016-03-06 08:55:21 +0200 | [diff] [blame] | 1330 | if (dict == NULL) { |
Serhiy Storchaka | a0d416f | 2016-03-06 08:55:21 +0200 | [diff] [blame] | 1331 | dict = Py_None; |
| 1332 | Py_INCREF(dict); |
| 1333 | } |
| 1334 | |
| 1335 | it = PyObject_GetIter((PyObject *)deque); |
| 1336 | if (it == NULL) { |
| 1337 | Py_DECREF(dict); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1338 | return NULL; |
| 1339 | } |
Serhiy Storchaka | a0d416f | 2016-03-06 08:55:21 +0200 | [diff] [blame] | 1340 | |
| 1341 | if (deque->maxlen < 0) { |
| 1342 | return Py_BuildValue("O()NN", Py_TYPE(deque), dict, it); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1343 | } |
Serhiy Storchaka | a0d416f | 2016-03-06 08:55:21 +0200 | [diff] [blame] | 1344 | else { |
| 1345 | return Py_BuildValue("O(()n)NN", Py_TYPE(deque), deque->maxlen, dict, it); |
| 1346 | } |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1347 | } |
| 1348 | |
| 1349 | PyDoc_STRVAR(reduce_doc, "Return state information for pickling."); |
| 1350 | |
| 1351 | static PyObject * |
| 1352 | deque_repr(PyObject *deque) |
| 1353 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1354 | PyObject *aslist, *result; |
| 1355 | int i; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1356 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1357 | i = Py_ReprEnter(deque); |
| 1358 | if (i != 0) { |
| 1359 | if (i < 0) |
| 1360 | return NULL; |
| 1361 | return PyUnicode_FromString("[...]"); |
| 1362 | } |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1363 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1364 | aslist = PySequence_List(deque); |
| 1365 | if (aslist == NULL) { |
| 1366 | Py_ReprLeave(deque); |
| 1367 | return NULL; |
| 1368 | } |
Raymond Hettinger | a7f63009 | 2015-10-10 23:56:02 -0400 | [diff] [blame] | 1369 | if (((dequeobject *)deque)->maxlen >= 0) |
Serhiy Storchaka | b3a7796 | 2017-09-21 14:24:13 +0300 | [diff] [blame] | 1370 | result = PyUnicode_FromFormat("%s(%R, maxlen=%zd)", |
| 1371 | _PyType_Name(Py_TYPE(deque)), aslist, |
| 1372 | ((dequeobject *)deque)->maxlen); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1373 | else |
Serhiy Storchaka | b3a7796 | 2017-09-21 14:24:13 +0300 | [diff] [blame] | 1374 | result = PyUnicode_FromFormat("%s(%R)", |
| 1375 | _PyType_Name(Py_TYPE(deque)), aslist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1376 | Py_ReprLeave(deque); |
Raymond Hettinger | 2b2b753 | 2015-09-05 17:05:52 -0700 | [diff] [blame] | 1377 | Py_DECREF(aslist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1378 | return result; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1379 | } |
| 1380 | |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 1381 | static PyObject * |
| 1382 | deque_richcompare(PyObject *v, PyObject *w, int op) |
| 1383 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1384 | PyObject *it1=NULL, *it2=NULL, *x, *y; |
| 1385 | Py_ssize_t vs, ws; |
| 1386 | int b, cmp=-1; |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 1387 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1388 | if (!PyObject_TypeCheck(v, &deque_type) || |
| 1389 | !PyObject_TypeCheck(w, &deque_type)) { |
Brian Curtin | dfc80e3 | 2011-08-10 20:28:54 -0500 | [diff] [blame] | 1390 | Py_RETURN_NOTIMPLEMENTED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1391 | } |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 1392 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1393 | /* Shortcuts */ |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1394 | vs = Py_SIZE((dequeobject *)v); |
| 1395 | ws = Py_SIZE((dequeobject *)w); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1396 | if (op == Py_EQ) { |
| 1397 | if (v == w) |
| 1398 | Py_RETURN_TRUE; |
| 1399 | if (vs != ws) |
| 1400 | Py_RETURN_FALSE; |
| 1401 | } |
| 1402 | if (op == Py_NE) { |
| 1403 | if (v == w) |
| 1404 | Py_RETURN_FALSE; |
| 1405 | if (vs != ws) |
| 1406 | Py_RETURN_TRUE; |
| 1407 | } |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 1408 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1409 | /* Search for the first index where items are different */ |
| 1410 | it1 = PyObject_GetIter(v); |
| 1411 | if (it1 == NULL) |
| 1412 | goto done; |
| 1413 | it2 = PyObject_GetIter(w); |
| 1414 | if (it2 == NULL) |
| 1415 | goto done; |
| 1416 | for (;;) { |
| 1417 | x = PyIter_Next(it1); |
| 1418 | if (x == NULL && PyErr_Occurred()) |
| 1419 | goto done; |
| 1420 | y = PyIter_Next(it2); |
| 1421 | if (x == NULL || y == NULL) |
| 1422 | break; |
| 1423 | b = PyObject_RichCompareBool(x, y, Py_EQ); |
| 1424 | if (b == 0) { |
| 1425 | cmp = PyObject_RichCompareBool(x, y, op); |
| 1426 | Py_DECREF(x); |
| 1427 | Py_DECREF(y); |
| 1428 | goto done; |
| 1429 | } |
| 1430 | Py_DECREF(x); |
| 1431 | Py_DECREF(y); |
Raymond Hettinger | d3d2b2c | 2015-09-21 23:41:56 -0700 | [diff] [blame] | 1432 | if (b < 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1433 | goto done; |
| 1434 | } |
| 1435 | /* We reached the end of one deque or both */ |
| 1436 | Py_XDECREF(x); |
| 1437 | Py_XDECREF(y); |
| 1438 | if (PyErr_Occurred()) |
| 1439 | goto done; |
| 1440 | switch (op) { |
| 1441 | case Py_LT: cmp = y != NULL; break; /* if w was longer */ |
| 1442 | case Py_LE: cmp = x == NULL; break; /* if v was not longer */ |
| 1443 | case Py_EQ: cmp = x == y; break; /* if we reached the end of both */ |
| 1444 | case Py_NE: cmp = x != y; break; /* if one deque continues */ |
| 1445 | case Py_GT: cmp = x != NULL; break; /* if v was longer */ |
| 1446 | case Py_GE: cmp = y == NULL; break; /* if w was not longer */ |
| 1447 | } |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 1448 | |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 1449 | done: |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1450 | Py_XDECREF(it1); |
| 1451 | Py_XDECREF(it2); |
| 1452 | if (cmp == 1) |
| 1453 | Py_RETURN_TRUE; |
| 1454 | if (cmp == 0) |
| 1455 | Py_RETURN_FALSE; |
| 1456 | return NULL; |
Raymond Hettinger | 738ec90 | 2004-02-29 02:15:56 +0000 | [diff] [blame] | 1457 | } |
| 1458 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1459 | static int |
Guido van Rossum | 8ce8a78 | 2007-11-01 19:42:39 +0000 | [diff] [blame] | 1460 | deque_init(dequeobject *deque, PyObject *args, PyObject *kwdargs) |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1461 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1462 | PyObject *iterable = NULL; |
| 1463 | PyObject *maxlenobj = NULL; |
| 1464 | Py_ssize_t maxlen = -1; |
| 1465 | char *kwlist[] = {"iterable", "maxlen", 0}; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1466 | |
Raymond Hettinger | 05f1b93 | 2019-01-31 22:13:43 -0800 | [diff] [blame] | 1467 | if (kwdargs == NULL && PyTuple_GET_SIZE(args) <= 2) { |
| 1468 | if (PyTuple_GET_SIZE(args) > 0) { |
| 1469 | iterable = PyTuple_GET_ITEM(args, 0); |
| 1470 | } |
| 1471 | if (PyTuple_GET_SIZE(args) > 1) { |
| 1472 | maxlenobj = PyTuple_GET_ITEM(args, 1); |
| 1473 | } |
Raymond Hettinger | 0d30940 | 2015-09-30 23:15:02 -0700 | [diff] [blame] | 1474 | } else { |
| 1475 | if (!PyArg_ParseTupleAndKeywords(args, kwdargs, "|OO:deque", kwlist, |
| 1476 | &iterable, &maxlenobj)) |
| 1477 | return -1; |
| 1478 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1479 | if (maxlenobj != NULL && maxlenobj != Py_None) { |
| 1480 | maxlen = PyLong_AsSsize_t(maxlenobj); |
| 1481 | if (maxlen == -1 && PyErr_Occurred()) |
| 1482 | return -1; |
| 1483 | if (maxlen < 0) { |
| 1484 | PyErr_SetString(PyExc_ValueError, "maxlen must be non-negative"); |
| 1485 | return -1; |
| 1486 | } |
| 1487 | } |
| 1488 | deque->maxlen = maxlen; |
Raymond Hettinger | 0d30940 | 2015-09-30 23:15:02 -0700 | [diff] [blame] | 1489 | if (Py_SIZE(deque) > 0) |
| 1490 | deque_clear(deque); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1491 | if (iterable != NULL) { |
| 1492 | PyObject *rv = deque_extend(deque, iterable); |
| 1493 | if (rv == NULL) |
| 1494 | return -1; |
| 1495 | Py_DECREF(rv); |
| 1496 | } |
| 1497 | return 0; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1498 | } |
| 1499 | |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 1500 | static PyObject * |
Jesus Cea | 16e2fca | 2012-08-03 14:49:42 +0200 | [diff] [blame] | 1501 | deque_sizeof(dequeobject *deque, void *unused) |
| 1502 | { |
| 1503 | Py_ssize_t res; |
| 1504 | Py_ssize_t blocks; |
| 1505 | |
Serhiy Storchaka | 5c4064e | 2015-12-19 20:05:25 +0200 | [diff] [blame] | 1506 | res = _PyObject_SIZE(Py_TYPE(deque)); |
Raymond Hettinger | bc00341 | 2015-10-14 23:33:23 -0700 | [diff] [blame] | 1507 | blocks = (size_t)(deque->leftindex + Py_SIZE(deque) + BLOCKLEN - 1) / BLOCKLEN; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1508 | assert(deque->leftindex + Py_SIZE(deque) - 1 == |
Jesus Cea | 16e2fca | 2012-08-03 14:49:42 +0200 | [diff] [blame] | 1509 | (blocks - 1) * BLOCKLEN + deque->rightindex); |
| 1510 | res += blocks * sizeof(block); |
| 1511 | return PyLong_FromSsize_t(res); |
| 1512 | } |
| 1513 | |
| 1514 | PyDoc_STRVAR(sizeof_doc, |
| 1515 | "D.__sizeof__() -- size of D in memory, in bytes"); |
| 1516 | |
Raymond Hettinger | 0f1451c | 2015-03-23 23:23:55 -0700 | [diff] [blame] | 1517 | static int |
| 1518 | deque_bool(dequeobject *deque) |
| 1519 | { |
| 1520 | return Py_SIZE(deque) != 0; |
| 1521 | } |
| 1522 | |
Jesus Cea | 16e2fca | 2012-08-03 14:49:42 +0200 | [diff] [blame] | 1523 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 1524 | deque_get_maxlen(dequeobject *deque, void *Py_UNUSED(ignored)) |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 1525 | { |
Raymond Hettinger | d3d2b2c | 2015-09-21 23:41:56 -0700 | [diff] [blame] | 1526 | if (deque->maxlen < 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1527 | Py_RETURN_NONE; |
| 1528 | return PyLong_FromSsize_t(deque->maxlen); |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 1529 | } |
| 1530 | |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 1531 | |
| 1532 | /* deque object ********************************************************/ |
| 1533 | |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 1534 | static PyGetSetDef deque_getset[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1535 | {"maxlen", (getter)deque_get_maxlen, (setter)NULL, |
| 1536 | "maximum size of a deque or None if unbounded"}, |
| 1537 | {0} |
Raymond Hettinger | 5bb0f0e | 2009-03-10 12:56:32 +0000 | [diff] [blame] | 1538 | }; |
| 1539 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1540 | static PySequenceMethods deque_as_sequence = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1541 | (lenfunc)deque_len, /* sq_length */ |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 1542 | (binaryfunc)deque_concat, /* sq_concat */ |
| 1543 | (ssizeargfunc)deque_repeat, /* sq_repeat */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1544 | (ssizeargfunc)deque_item, /* sq_item */ |
| 1545 | 0, /* sq_slice */ |
Raymond Hettinger | 87e6912 | 2015-03-02 23:32:02 -0800 | [diff] [blame] | 1546 | (ssizeobjargproc)deque_ass_item, /* sq_ass_item */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1547 | 0, /* sq_ass_slice */ |
Raymond Hettinger | 39dadf7 | 2015-03-20 16:38:56 -0700 | [diff] [blame] | 1548 | (objobjproc)deque_contains, /* sq_contains */ |
Raymond Hettinger | 87e6912 | 2015-03-02 23:32:02 -0800 | [diff] [blame] | 1549 | (binaryfunc)deque_inplace_concat, /* sq_inplace_concat */ |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 1550 | (ssizeargfunc)deque_inplace_repeat, /* sq_inplace_repeat */ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1551 | }; |
| 1552 | |
Raymond Hettinger | 0f1451c | 2015-03-23 23:23:55 -0700 | [diff] [blame] | 1553 | static PyNumberMethods deque_as_number = { |
| 1554 | 0, /* nb_add */ |
| 1555 | 0, /* nb_subtract */ |
| 1556 | 0, /* nb_multiply */ |
| 1557 | 0, /* nb_remainder */ |
| 1558 | 0, /* nb_divmod */ |
| 1559 | 0, /* nb_power */ |
| 1560 | 0, /* nb_negative */ |
| 1561 | 0, /* nb_positive */ |
| 1562 | 0, /* nb_absolute */ |
| 1563 | (inquiry)deque_bool, /* nb_bool */ |
| 1564 | 0, /* nb_invert */ |
Raymond Hettinger | 0f1451c | 2015-03-23 23:23:55 -0700 | [diff] [blame] | 1565 | }; |
| 1566 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1567 | static PyObject *deque_iter(dequeobject *deque); |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1568 | static PyObject *deque_reviter(dequeobject *deque, PyObject *Py_UNUSED(ignored)); |
Tim Peters | 1065f75 | 2004-10-01 01:03:29 +0000 | [diff] [blame] | 1569 | PyDoc_STRVAR(reversed_doc, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1570 | "D.__reversed__() -- return a reverse iterator over the deque"); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1571 | |
| 1572 | static PyMethodDef deque_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1573 | {"append", (PyCFunction)deque_append, |
| 1574 | METH_O, append_doc}, |
| 1575 | {"appendleft", (PyCFunction)deque_appendleft, |
| 1576 | METH_O, appendleft_doc}, |
| 1577 | {"clear", (PyCFunction)deque_clearmethod, |
| 1578 | METH_NOARGS, clear_doc}, |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1579 | {"__copy__", deque_copy, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1580 | METH_NOARGS, copy_doc}, |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1581 | {"copy", deque_copy, |
Raymond Hettinger | 32ea165 | 2015-03-21 01:37:37 -0700 | [diff] [blame] | 1582 | METH_NOARGS, copy_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1583 | {"count", (PyCFunction)deque_count, |
Raymond Hettinger | 0f6f947 | 2015-03-21 01:42:10 -0700 | [diff] [blame] | 1584 | METH_O, count_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1585 | {"extend", (PyCFunction)deque_extend, |
| 1586 | METH_O, extend_doc}, |
| 1587 | {"extendleft", (PyCFunction)deque_extendleft, |
| 1588 | METH_O, extendleft_doc}, |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 1589 | {"index", (PyCFunction)(void(*)(void))deque_index, |
Victor Stinner | dd407d5 | 2017-02-06 16:06:49 +0100 | [diff] [blame] | 1590 | METH_FASTCALL, index_doc}, |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 1591 | {"insert", (PyCFunction)(void(*)(void))deque_insert, |
Victor Stinner | dd407d5 | 2017-02-06 16:06:49 +0100 | [diff] [blame] | 1592 | METH_FASTCALL, insert_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1593 | {"pop", (PyCFunction)deque_pop, |
| 1594 | METH_NOARGS, pop_doc}, |
| 1595 | {"popleft", (PyCFunction)deque_popleft, |
| 1596 | METH_NOARGS, popleft_doc}, |
Raymond Hettinger | 0f6f947 | 2015-03-21 01:42:10 -0700 | [diff] [blame] | 1597 | {"__reduce__", (PyCFunction)deque_reduce, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1598 | METH_NOARGS, reduce_doc}, |
| 1599 | {"remove", (PyCFunction)deque_remove, |
| 1600 | METH_O, remove_doc}, |
| 1601 | {"__reversed__", (PyCFunction)deque_reviter, |
| 1602 | METH_NOARGS, reversed_doc}, |
| 1603 | {"reverse", (PyCFunction)deque_reverse, |
| 1604 | METH_NOARGS, reverse_doc}, |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 1605 | {"rotate", (PyCFunction)(void(*)(void))deque_rotate, |
Victor Stinner | dd407d5 | 2017-02-06 16:06:49 +0100 | [diff] [blame] | 1606 | METH_FASTCALL, rotate_doc}, |
Jesus Cea | 16e2fca | 2012-08-03 14:49:42 +0200 | [diff] [blame] | 1607 | {"__sizeof__", (PyCFunction)deque_sizeof, |
| 1608 | METH_NOARGS, sizeof_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1609 | {NULL, NULL} /* sentinel */ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1610 | }; |
| 1611 | |
| 1612 | PyDoc_STRVAR(deque_doc, |
Andrew Svetlov | 6a5c7c3 | 2012-10-31 11:50:40 +0200 | [diff] [blame] | 1613 | "deque([iterable[, maxlen]]) --> deque object\n\ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1614 | \n\ |
Raymond Hettinger | 41290a6 | 2015-03-31 08:12:23 -0700 | [diff] [blame] | 1615 | A list-like sequence optimized for data accesses near its endpoints."); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1616 | |
Neal Norwitz | 87f1013 | 2004-02-29 15:40:53 +0000 | [diff] [blame] | 1617 | static PyTypeObject deque_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1618 | PyVarObject_HEAD_INIT(NULL, 0) |
| 1619 | "collections.deque", /* tp_name */ |
| 1620 | sizeof(dequeobject), /* tp_basicsize */ |
| 1621 | 0, /* tp_itemsize */ |
| 1622 | /* methods */ |
| 1623 | (destructor)deque_dealloc, /* tp_dealloc */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 1624 | 0, /* tp_vectorcall_offset */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1625 | 0, /* tp_getattr */ |
| 1626 | 0, /* tp_setattr */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 1627 | 0, /* tp_as_async */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1628 | deque_repr, /* tp_repr */ |
Raymond Hettinger | 0f1451c | 2015-03-23 23:23:55 -0700 | [diff] [blame] | 1629 | &deque_as_number, /* tp_as_number */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1630 | &deque_as_sequence, /* tp_as_sequence */ |
| 1631 | 0, /* tp_as_mapping */ |
Georg Brandl | f038b32 | 2010-10-18 07:35:09 +0000 | [diff] [blame] | 1632 | PyObject_HashNotImplemented, /* tp_hash */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1633 | 0, /* tp_call */ |
| 1634 | 0, /* tp_str */ |
| 1635 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 1636 | 0, /* tp_setattro */ |
| 1637 | 0, /* tp_as_buffer */ |
| 1638 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, |
Georg Brandl | f038b32 | 2010-10-18 07:35:09 +0000 | [diff] [blame] | 1639 | /* tp_flags */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1640 | deque_doc, /* tp_doc */ |
| 1641 | (traverseproc)deque_traverse, /* tp_traverse */ |
| 1642 | (inquiry)deque_clear, /* tp_clear */ |
| 1643 | (richcmpfunc)deque_richcompare, /* tp_richcompare */ |
Georg Brandl | f038b32 | 2010-10-18 07:35:09 +0000 | [diff] [blame] | 1644 | offsetof(dequeobject, weakreflist), /* tp_weaklistoffset*/ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1645 | (getiterfunc)deque_iter, /* tp_iter */ |
| 1646 | 0, /* tp_iternext */ |
| 1647 | deque_methods, /* tp_methods */ |
| 1648 | 0, /* tp_members */ |
Georg Brandl | f038b32 | 2010-10-18 07:35:09 +0000 | [diff] [blame] | 1649 | deque_getset, /* tp_getset */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1650 | 0, /* tp_base */ |
| 1651 | 0, /* tp_dict */ |
| 1652 | 0, /* tp_descr_get */ |
| 1653 | 0, /* tp_descr_set */ |
| 1654 | 0, /* tp_dictoffset */ |
| 1655 | (initproc)deque_init, /* tp_init */ |
| 1656 | PyType_GenericAlloc, /* tp_alloc */ |
| 1657 | deque_new, /* tp_new */ |
| 1658 | PyObject_GC_Del, /* tp_free */ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1659 | }; |
| 1660 | |
| 1661 | /*********************** Deque Iterator **************************/ |
| 1662 | |
| 1663 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1664 | PyObject_HEAD |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1665 | block *b; |
Raymond Hettinger | 87e6912 | 2015-03-02 23:32:02 -0800 | [diff] [blame] | 1666 | Py_ssize_t index; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1667 | dequeobject *deque; |
Raymond Hettinger | f9d9c79 | 2015-03-02 22:47:46 -0800 | [diff] [blame] | 1668 | size_t state; /* state when the iterator is created */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1669 | Py_ssize_t counter; /* number of items remaining for iteration */ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1670 | } dequeiterobject; |
| 1671 | |
Martin v. Löwis | 59683e8 | 2008-06-13 07:50:45 +0000 | [diff] [blame] | 1672 | static PyTypeObject dequeiter_type; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1673 | |
| 1674 | static PyObject * |
| 1675 | deque_iter(dequeobject *deque) |
| 1676 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1677 | dequeiterobject *it; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1678 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1679 | it = PyObject_GC_New(dequeiterobject, &dequeiter_type); |
| 1680 | if (it == NULL) |
| 1681 | return NULL; |
| 1682 | it->b = deque->leftblock; |
| 1683 | it->index = deque->leftindex; |
| 1684 | Py_INCREF(deque); |
| 1685 | it->deque = deque; |
| 1686 | it->state = deque->state; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1687 | it->counter = Py_SIZE(deque); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1688 | PyObject_GC_Track(it); |
| 1689 | return (PyObject *)it; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1690 | } |
| 1691 | |
Antoine Pitrou | 7ddda78 | 2009-01-01 15:35:33 +0000 | [diff] [blame] | 1692 | static int |
| 1693 | dequeiter_traverse(dequeiterobject *dio, visitproc visit, void *arg) |
| 1694 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1695 | Py_VISIT(dio->deque); |
| 1696 | return 0; |
Antoine Pitrou | 7ddda78 | 2009-01-01 15:35:33 +0000 | [diff] [blame] | 1697 | } |
| 1698 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1699 | static void |
| 1700 | dequeiter_dealloc(dequeiterobject *dio) |
| 1701 | { |
INADA Naoki | a6296d3 | 2017-08-24 14:55:17 +0900 | [diff] [blame] | 1702 | /* bpo-31095: UnTrack is needed before calling any callbacks */ |
| 1703 | PyObject_GC_UnTrack(dio); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1704 | Py_XDECREF(dio->deque); |
| 1705 | PyObject_GC_Del(dio); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1706 | } |
| 1707 | |
| 1708 | static PyObject * |
| 1709 | dequeiter_next(dequeiterobject *it) |
| 1710 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1711 | PyObject *item; |
Raymond Hettinger | d1b3d88 | 2004-10-02 00:43:13 +0000 | [diff] [blame] | 1712 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1713 | if (it->deque->state != it->state) { |
| 1714 | it->counter = 0; |
| 1715 | PyErr_SetString(PyExc_RuntimeError, |
| 1716 | "deque mutated during iteration"); |
| 1717 | return NULL; |
| 1718 | } |
| 1719 | if (it->counter == 0) |
| 1720 | return NULL; |
| 1721 | assert (!(it->b == it->deque->rightblock && |
| 1722 | it->index > it->deque->rightindex)); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1723 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1724 | item = it->b->data[it->index]; |
| 1725 | it->index++; |
| 1726 | it->counter--; |
| 1727 | if (it->index == BLOCKLEN && it->counter > 0) { |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 1728 | CHECK_NOT_END(it->b->rightlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1729 | it->b = it->b->rightlink; |
| 1730 | it->index = 0; |
| 1731 | } |
| 1732 | Py_INCREF(item); |
| 1733 | return item; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1734 | } |
| 1735 | |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 1736 | static PyObject * |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1737 | dequeiter_new(PyTypeObject *type, PyObject *args, PyObject *kwds) |
| 1738 | { |
| 1739 | Py_ssize_t i, index=0; |
| 1740 | PyObject *deque; |
| 1741 | dequeiterobject *it; |
| 1742 | if (!PyArg_ParseTuple(args, "O!|n", &deque_type, &deque, &index)) |
| 1743 | return NULL; |
| 1744 | assert(type == &dequeiter_type); |
| 1745 | |
| 1746 | it = (dequeiterobject*)deque_iter((dequeobject *)deque); |
| 1747 | if (!it) |
| 1748 | return NULL; |
| 1749 | /* consume items from the queue */ |
| 1750 | for(i=0; i<index; i++) { |
| 1751 | PyObject *item = dequeiter_next(it); |
| 1752 | if (item) { |
| 1753 | Py_DECREF(item); |
| 1754 | } else { |
| 1755 | if (it->counter) { |
| 1756 | Py_DECREF(it); |
| 1757 | return NULL; |
| 1758 | } else |
| 1759 | break; |
| 1760 | } |
| 1761 | } |
| 1762 | return (PyObject*)it; |
| 1763 | } |
| 1764 | |
| 1765 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1766 | dequeiter_len(dequeiterobject *it, PyObject *Py_UNUSED(ignored)) |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1767 | { |
Antoine Pitrou | 554f334 | 2010-08-17 18:30:06 +0000 | [diff] [blame] | 1768 | return PyLong_FromSsize_t(it->counter); |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1769 | } |
| 1770 | |
Armin Rigo | f5b3e36 | 2006-02-11 21:32:43 +0000 | [diff] [blame] | 1771 | 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] | 1772 | |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1773 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1774 | dequeiter_reduce(dequeiterobject *it, PyObject *Py_UNUSED(ignored)) |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1775 | { |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1776 | 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] | 1777 | } |
| 1778 | |
Raymond Hettinger | 6b27cda | 2005-09-24 21:23:05 +0000 | [diff] [blame] | 1779 | static PyMethodDef dequeiter_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1780 | {"__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] | 1781 | {"__reduce__", (PyCFunction)dequeiter_reduce, METH_NOARGS, reduce_doc}, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1782 | {NULL, NULL} /* sentinel */ |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1783 | }; |
| 1784 | |
Martin v. Löwis | 59683e8 | 2008-06-13 07:50:45 +0000 | [diff] [blame] | 1785 | static PyTypeObject dequeiter_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1786 | PyVarObject_HEAD_INIT(NULL, 0) |
Raymond Hettinger | 87e6912 | 2015-03-02 23:32:02 -0800 | [diff] [blame] | 1787 | "_collections._deque_iterator", /* tp_name */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1788 | sizeof(dequeiterobject), /* tp_basicsize */ |
| 1789 | 0, /* tp_itemsize */ |
| 1790 | /* methods */ |
| 1791 | (destructor)dequeiter_dealloc, /* tp_dealloc */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 1792 | 0, /* tp_vectorcall_offset */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1793 | 0, /* tp_getattr */ |
| 1794 | 0, /* tp_setattr */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 1795 | 0, /* tp_as_async */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1796 | 0, /* tp_repr */ |
| 1797 | 0, /* tp_as_number */ |
| 1798 | 0, /* tp_as_sequence */ |
| 1799 | 0, /* tp_as_mapping */ |
| 1800 | 0, /* tp_hash */ |
| 1801 | 0, /* tp_call */ |
| 1802 | 0, /* tp_str */ |
| 1803 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 1804 | 0, /* tp_setattro */ |
| 1805 | 0, /* tp_as_buffer */ |
Raymond Hettinger | 87e6912 | 2015-03-02 23:32:02 -0800 | [diff] [blame] | 1806 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1807 | 0, /* tp_doc */ |
| 1808 | (traverseproc)dequeiter_traverse, /* tp_traverse */ |
| 1809 | 0, /* tp_clear */ |
| 1810 | 0, /* tp_richcompare */ |
| 1811 | 0, /* tp_weaklistoffset */ |
| 1812 | PyObject_SelfIter, /* tp_iter */ |
| 1813 | (iternextfunc)dequeiter_next, /* tp_iternext */ |
| 1814 | dequeiter_methods, /* tp_methods */ |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1815 | 0, /* tp_members */ |
| 1816 | 0, /* tp_getset */ |
| 1817 | 0, /* tp_base */ |
| 1818 | 0, /* tp_dict */ |
| 1819 | 0, /* tp_descr_get */ |
| 1820 | 0, /* tp_descr_set */ |
| 1821 | 0, /* tp_dictoffset */ |
| 1822 | 0, /* tp_init */ |
| 1823 | 0, /* tp_alloc */ |
| 1824 | dequeiter_new, /* tp_new */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1825 | 0, |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 1826 | }; |
| 1827 | |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1828 | /*********************** Deque Reverse Iterator **************************/ |
| 1829 | |
Martin v. Löwis | 59683e8 | 2008-06-13 07:50:45 +0000 | [diff] [blame] | 1830 | static PyTypeObject dequereviter_type; |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1831 | |
| 1832 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1833 | deque_reviter(dequeobject *deque, PyObject *Py_UNUSED(ignored)) |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1834 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1835 | dequeiterobject *it; |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1836 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1837 | it = PyObject_GC_New(dequeiterobject, &dequereviter_type); |
| 1838 | if (it == NULL) |
| 1839 | return NULL; |
| 1840 | it->b = deque->rightblock; |
| 1841 | it->index = deque->rightindex; |
| 1842 | Py_INCREF(deque); |
| 1843 | it->deque = deque; |
| 1844 | it->state = deque->state; |
Raymond Hettinger | df715ba | 2013-07-06 13:01:13 -1000 | [diff] [blame] | 1845 | it->counter = Py_SIZE(deque); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1846 | PyObject_GC_Track(it); |
| 1847 | return (PyObject *)it; |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1848 | } |
| 1849 | |
| 1850 | static PyObject * |
| 1851 | dequereviter_next(dequeiterobject *it) |
| 1852 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1853 | PyObject *item; |
| 1854 | if (it->counter == 0) |
| 1855 | return NULL; |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1856 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1857 | if (it->deque->state != it->state) { |
| 1858 | it->counter = 0; |
| 1859 | PyErr_SetString(PyExc_RuntimeError, |
| 1860 | "deque mutated during iteration"); |
| 1861 | return NULL; |
| 1862 | } |
| 1863 | assert (!(it->b == it->deque->leftblock && |
| 1864 | it->index < it->deque->leftindex)); |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1865 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1866 | item = it->b->data[it->index]; |
| 1867 | it->index--; |
| 1868 | it->counter--; |
Raymond Hettinger | d3d2b2c | 2015-09-21 23:41:56 -0700 | [diff] [blame] | 1869 | if (it->index < 0 && it->counter > 0) { |
Raymond Hettinger | 82df925 | 2013-07-07 01:43:42 -1000 | [diff] [blame] | 1870 | CHECK_NOT_END(it->b->leftlink); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1871 | it->b = it->b->leftlink; |
| 1872 | it->index = BLOCKLEN - 1; |
| 1873 | } |
| 1874 | Py_INCREF(item); |
| 1875 | return item; |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1876 | } |
| 1877 | |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1878 | static PyObject * |
| 1879 | dequereviter_new(PyTypeObject *type, PyObject *args, PyObject *kwds) |
| 1880 | { |
| 1881 | Py_ssize_t i, index=0; |
| 1882 | PyObject *deque; |
| 1883 | dequeiterobject *it; |
| 1884 | if (!PyArg_ParseTuple(args, "O!|n", &deque_type, &deque, &index)) |
| 1885 | return NULL; |
| 1886 | assert(type == &dequereviter_type); |
| 1887 | |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1888 | it = (dequeiterobject*)deque_reviter((dequeobject *)deque, NULL); |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1889 | if (!it) |
| 1890 | return NULL; |
| 1891 | /* consume items from the queue */ |
| 1892 | for(i=0; i<index; i++) { |
| 1893 | PyObject *item = dequereviter_next(it); |
| 1894 | if (item) { |
| 1895 | Py_DECREF(item); |
| 1896 | } else { |
| 1897 | if (it->counter) { |
| 1898 | Py_DECREF(it); |
| 1899 | return NULL; |
| 1900 | } else |
| 1901 | break; |
| 1902 | } |
| 1903 | } |
| 1904 | return (PyObject*)it; |
| 1905 | } |
| 1906 | |
Martin v. Löwis | 59683e8 | 2008-06-13 07:50:45 +0000 | [diff] [blame] | 1907 | static PyTypeObject dequereviter_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1908 | PyVarObject_HEAD_INIT(NULL, 0) |
Raymond Hettinger | 87e6912 | 2015-03-02 23:32:02 -0800 | [diff] [blame] | 1909 | "_collections._deque_reverse_iterator", /* tp_name */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1910 | sizeof(dequeiterobject), /* tp_basicsize */ |
| 1911 | 0, /* tp_itemsize */ |
| 1912 | /* methods */ |
| 1913 | (destructor)dequeiter_dealloc, /* tp_dealloc */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 1914 | 0, /* tp_vectorcall_offset */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1915 | 0, /* tp_getattr */ |
| 1916 | 0, /* tp_setattr */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 1917 | 0, /* tp_as_async */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1918 | 0, /* tp_repr */ |
| 1919 | 0, /* tp_as_number */ |
| 1920 | 0, /* tp_as_sequence */ |
| 1921 | 0, /* tp_as_mapping */ |
| 1922 | 0, /* tp_hash */ |
| 1923 | 0, /* tp_call */ |
| 1924 | 0, /* tp_str */ |
| 1925 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 1926 | 0, /* tp_setattro */ |
| 1927 | 0, /* tp_as_buffer */ |
Raymond Hettinger | 87e6912 | 2015-03-02 23:32:02 -0800 | [diff] [blame] | 1928 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1929 | 0, /* tp_doc */ |
| 1930 | (traverseproc)dequeiter_traverse, /* tp_traverse */ |
| 1931 | 0, /* tp_clear */ |
| 1932 | 0, /* tp_richcompare */ |
| 1933 | 0, /* tp_weaklistoffset */ |
| 1934 | PyObject_SelfIter, /* tp_iter */ |
| 1935 | (iternextfunc)dequereviter_next, /* tp_iternext */ |
| 1936 | dequeiter_methods, /* tp_methods */ |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 1937 | 0, /* tp_members */ |
| 1938 | 0, /* tp_getset */ |
| 1939 | 0, /* tp_base */ |
| 1940 | 0, /* tp_dict */ |
| 1941 | 0, /* tp_descr_get */ |
| 1942 | 0, /* tp_descr_set */ |
| 1943 | 0, /* tp_dictoffset */ |
| 1944 | 0, /* tp_init */ |
| 1945 | 0, /* tp_alloc */ |
| 1946 | dequereviter_new, /* tp_new */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1947 | 0, |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 1948 | }; |
| 1949 | |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1950 | /* defaultdict type *********************************************************/ |
| 1951 | |
| 1952 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1953 | PyDictObject dict; |
| 1954 | PyObject *default_factory; |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1955 | } defdictobject; |
| 1956 | |
| 1957 | static PyTypeObject defdict_type; /* Forward */ |
| 1958 | |
| 1959 | PyDoc_STRVAR(defdict_missing_doc, |
| 1960 | "__missing__(key) # Called by __getitem__ for missing key; pseudo-code:\n\ |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1961 | if self.default_factory is None: raise KeyError((key,))\n\ |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1962 | self[key] = value = self.default_factory()\n\ |
| 1963 | return value\n\ |
| 1964 | "); |
| 1965 | |
| 1966 | static PyObject * |
| 1967 | defdict_missing(defdictobject *dd, PyObject *key) |
| 1968 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1969 | PyObject *factory = dd->default_factory; |
| 1970 | PyObject *value; |
| 1971 | if (factory == NULL || factory == Py_None) { |
| 1972 | /* XXX Call dict.__missing__(key) */ |
| 1973 | PyObject *tup; |
| 1974 | tup = PyTuple_Pack(1, key); |
| 1975 | if (!tup) return NULL; |
| 1976 | PyErr_SetObject(PyExc_KeyError, tup); |
| 1977 | Py_DECREF(tup); |
| 1978 | return NULL; |
| 1979 | } |
| 1980 | value = PyEval_CallObject(factory, NULL); |
| 1981 | if (value == NULL) |
| 1982 | return value; |
| 1983 | if (PyObject_SetItem((PyObject *)dd, key, value) < 0) { |
| 1984 | Py_DECREF(value); |
| 1985 | return NULL; |
| 1986 | } |
| 1987 | return value; |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1988 | } |
| 1989 | |
| 1990 | PyDoc_STRVAR(defdict_copy_doc, "D.copy() -> a shallow copy of D."); |
| 1991 | |
| 1992 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 1993 | defdict_copy(defdictobject *dd, PyObject *Py_UNUSED(ignored)) |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 1994 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1995 | /* This calls the object's class. That only works for subclasses |
| 1996 | whose class constructor has the same signature. Subclasses that |
| 1997 | define a different constructor signature must override copy(). |
| 1998 | */ |
Raymond Hettinger | 54628fa | 2009-08-04 19:16:39 +0000 | [diff] [blame] | 1999 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2000 | if (dd->default_factory == NULL) |
| 2001 | return PyObject_CallFunctionObjArgs((PyObject*)Py_TYPE(dd), Py_None, dd, NULL); |
| 2002 | return PyObject_CallFunctionObjArgs((PyObject*)Py_TYPE(dd), |
| 2003 | dd->default_factory, dd, NULL); |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2004 | } |
| 2005 | |
| 2006 | static PyObject * |
Siddhesh Poyarekar | 55edd0c | 2018-04-30 00:29:33 +0530 | [diff] [blame] | 2007 | defdict_reduce(defdictobject *dd, PyObject *Py_UNUSED(ignored)) |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2008 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2009 | /* __reduce__ must return a 5-tuple as follows: |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2010 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2011 | - factory function |
| 2012 | - tuple of args for the factory function |
| 2013 | - additional state (here None) |
| 2014 | - sequence iterator (here None) |
| 2015 | - dictionary iterator (yielding successive (key, value) pairs |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2016 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2017 | This API is used by pickle.py and copy.py. |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2018 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2019 | For this to be useful with pickle.py, the default_factory |
| 2020 | must be picklable; e.g., None, a built-in, or a global |
| 2021 | function in a module or package. |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2022 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2023 | Both shallow and deep copying are supported, but for deep |
| 2024 | copying, the default_factory must be deep-copyable; e.g. None, |
| 2025 | or a built-in (functions are not copyable at this time). |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2026 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2027 | This only works for subclasses as long as their constructor |
| 2028 | signature is compatible; the first argument must be the |
| 2029 | optional default_factory, defaulting to None. |
| 2030 | */ |
| 2031 | PyObject *args; |
| 2032 | PyObject *items; |
| 2033 | PyObject *iter; |
| 2034 | PyObject *result; |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 2035 | _Py_IDENTIFIER(items); |
Martin v. Löwis | afe55bb | 2011-10-09 10:38:36 +0200 | [diff] [blame] | 2036 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2037 | if (dd->default_factory == NULL || dd->default_factory == Py_None) |
| 2038 | args = PyTuple_New(0); |
| 2039 | else |
| 2040 | args = PyTuple_Pack(1, dd->default_factory); |
| 2041 | if (args == NULL) |
| 2042 | return NULL; |
Victor Stinner | ad8c83a | 2016-09-05 17:53:15 -0700 | [diff] [blame] | 2043 | items = _PyObject_CallMethodId((PyObject *)dd, &PyId_items, NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2044 | if (items == NULL) { |
| 2045 | Py_DECREF(args); |
| 2046 | return NULL; |
| 2047 | } |
| 2048 | iter = PyObject_GetIter(items); |
| 2049 | if (iter == NULL) { |
| 2050 | Py_DECREF(items); |
| 2051 | Py_DECREF(args); |
| 2052 | return NULL; |
| 2053 | } |
| 2054 | result = PyTuple_Pack(5, Py_TYPE(dd), args, |
| 2055 | Py_None, Py_None, iter); |
| 2056 | Py_DECREF(iter); |
| 2057 | Py_DECREF(items); |
| 2058 | Py_DECREF(args); |
| 2059 | return result; |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2060 | } |
| 2061 | |
| 2062 | static PyMethodDef defdict_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2063 | {"__missing__", (PyCFunction)defdict_missing, METH_O, |
| 2064 | defdict_missing_doc}, |
| 2065 | {"copy", (PyCFunction)defdict_copy, METH_NOARGS, |
| 2066 | defdict_copy_doc}, |
| 2067 | {"__copy__", (PyCFunction)defdict_copy, METH_NOARGS, |
| 2068 | defdict_copy_doc}, |
| 2069 | {"__reduce__", (PyCFunction)defdict_reduce, METH_NOARGS, |
| 2070 | reduce_doc}, |
| 2071 | {NULL} |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2072 | }; |
| 2073 | |
| 2074 | static PyMemberDef defdict_members[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2075 | {"default_factory", T_OBJECT, |
| 2076 | offsetof(defdictobject, default_factory), 0, |
| 2077 | PyDoc_STR("Factory for default value called by __missing__().")}, |
| 2078 | {NULL} |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2079 | }; |
| 2080 | |
| 2081 | static void |
| 2082 | defdict_dealloc(defdictobject *dd) |
| 2083 | { |
INADA Naoki | a6296d3 | 2017-08-24 14:55:17 +0900 | [diff] [blame] | 2084 | /* bpo-31095: UnTrack is needed before calling any callbacks */ |
| 2085 | PyObject_GC_UnTrack(dd); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2086 | Py_CLEAR(dd->default_factory); |
| 2087 | PyDict_Type.tp_dealloc((PyObject *)dd); |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2088 | } |
| 2089 | |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2090 | static PyObject * |
| 2091 | defdict_repr(defdictobject *dd) |
| 2092 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2093 | PyObject *baserepr; |
| 2094 | PyObject *defrepr; |
| 2095 | PyObject *result; |
| 2096 | baserepr = PyDict_Type.tp_repr((PyObject *)dd); |
| 2097 | if (baserepr == NULL) |
| 2098 | return NULL; |
| 2099 | if (dd->default_factory == NULL) |
| 2100 | defrepr = PyUnicode_FromString("None"); |
| 2101 | else |
| 2102 | { |
| 2103 | int status = Py_ReprEnter(dd->default_factory); |
| 2104 | if (status != 0) { |
Antoine Pitrou | f5f1fe0 | 2012-02-15 02:42:46 +0100 | [diff] [blame] | 2105 | if (status < 0) { |
| 2106 | Py_DECREF(baserepr); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2107 | return NULL; |
Antoine Pitrou | f5f1fe0 | 2012-02-15 02:42:46 +0100 | [diff] [blame] | 2108 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2109 | defrepr = PyUnicode_FromString("..."); |
| 2110 | } |
| 2111 | else |
| 2112 | defrepr = PyObject_Repr(dd->default_factory); |
| 2113 | Py_ReprLeave(dd->default_factory); |
| 2114 | } |
| 2115 | if (defrepr == NULL) { |
| 2116 | Py_DECREF(baserepr); |
| 2117 | return NULL; |
| 2118 | } |
Serhiy Storchaka | b3a7796 | 2017-09-21 14:24:13 +0300 | [diff] [blame] | 2119 | result = PyUnicode_FromFormat("%s(%U, %U)", |
| 2120 | _PyType_Name(Py_TYPE(dd)), |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2121 | defrepr, baserepr); |
| 2122 | Py_DECREF(defrepr); |
| 2123 | Py_DECREF(baserepr); |
| 2124 | return result; |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2125 | } |
| 2126 | |
| 2127 | static int |
| 2128 | defdict_traverse(PyObject *self, visitproc visit, void *arg) |
| 2129 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2130 | Py_VISIT(((defdictobject *)self)->default_factory); |
| 2131 | return PyDict_Type.tp_traverse(self, visit, arg); |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2132 | } |
| 2133 | |
| 2134 | static int |
| 2135 | defdict_tp_clear(defdictobject *dd) |
| 2136 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2137 | Py_CLEAR(dd->default_factory); |
| 2138 | return PyDict_Type.tp_clear((PyObject *)dd); |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2139 | } |
| 2140 | |
| 2141 | static int |
| 2142 | defdict_init(PyObject *self, PyObject *args, PyObject *kwds) |
| 2143 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2144 | defdictobject *dd = (defdictobject *)self; |
| 2145 | PyObject *olddefault = dd->default_factory; |
| 2146 | PyObject *newdefault = NULL; |
| 2147 | PyObject *newargs; |
| 2148 | int result; |
| 2149 | if (args == NULL || !PyTuple_Check(args)) |
| 2150 | newargs = PyTuple_New(0); |
| 2151 | else { |
| 2152 | Py_ssize_t n = PyTuple_GET_SIZE(args); |
| 2153 | if (n > 0) { |
| 2154 | newdefault = PyTuple_GET_ITEM(args, 0); |
| 2155 | if (!PyCallable_Check(newdefault) && newdefault != Py_None) { |
| 2156 | PyErr_SetString(PyExc_TypeError, |
Raymond Hettinger | 239aba7 | 2015-07-20 03:09:22 -0400 | [diff] [blame] | 2157 | "first argument must be callable or None"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2158 | return -1; |
| 2159 | } |
| 2160 | } |
| 2161 | newargs = PySequence_GetSlice(args, 1, n); |
| 2162 | } |
| 2163 | if (newargs == NULL) |
| 2164 | return -1; |
| 2165 | Py_XINCREF(newdefault); |
| 2166 | dd->default_factory = newdefault; |
| 2167 | result = PyDict_Type.tp_init(self, newargs, kwds); |
| 2168 | Py_DECREF(newargs); |
| 2169 | Py_XDECREF(olddefault); |
| 2170 | return result; |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2171 | } |
| 2172 | |
| 2173 | PyDoc_STRVAR(defdict_doc, |
Benjamin Peterson | 9cb33b7 | 2014-01-13 23:56:05 -0500 | [diff] [blame] | 2174 | "defaultdict(default_factory[, ...]) --> dict with default factory\n\ |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2175 | \n\ |
| 2176 | The default factory is called without arguments to produce\n\ |
| 2177 | a new value when a key is not present, in __getitem__ only.\n\ |
| 2178 | A defaultdict compares equal to a dict with the same items.\n\ |
Benjamin Peterson | 9cb33b7 | 2014-01-13 23:56:05 -0500 | [diff] [blame] | 2179 | All remaining arguments are treated the same as if they were\n\ |
| 2180 | passed to the dict constructor, including keyword arguments.\n\ |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2181 | "); |
| 2182 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 2183 | /* See comment in xxsubtype.c */ |
| 2184 | #define DEFERRED_ADDRESS(ADDR) 0 |
| 2185 | |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2186 | static PyTypeObject defdict_type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2187 | PyVarObject_HEAD_INIT(DEFERRED_ADDRESS(&PyType_Type), 0) |
| 2188 | "collections.defaultdict", /* tp_name */ |
| 2189 | sizeof(defdictobject), /* tp_basicsize */ |
| 2190 | 0, /* tp_itemsize */ |
| 2191 | /* methods */ |
| 2192 | (destructor)defdict_dealloc, /* tp_dealloc */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 2193 | 0, /* tp_vectorcall_offset */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2194 | 0, /* tp_getattr */ |
| 2195 | 0, /* tp_setattr */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 2196 | 0, /* tp_as_async */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2197 | (reprfunc)defdict_repr, /* tp_repr */ |
| 2198 | 0, /* tp_as_number */ |
| 2199 | 0, /* tp_as_sequence */ |
| 2200 | 0, /* tp_as_mapping */ |
| 2201 | 0, /* tp_hash */ |
| 2202 | 0, /* tp_call */ |
| 2203 | 0, /* tp_str */ |
| 2204 | PyObject_GenericGetAttr, /* tp_getattro */ |
| 2205 | 0, /* tp_setattro */ |
| 2206 | 0, /* tp_as_buffer */ |
| 2207 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC, |
| 2208 | /* tp_flags */ |
| 2209 | defdict_doc, /* tp_doc */ |
| 2210 | defdict_traverse, /* tp_traverse */ |
| 2211 | (inquiry)defdict_tp_clear, /* tp_clear */ |
| 2212 | 0, /* tp_richcompare */ |
| 2213 | 0, /* tp_weaklistoffset*/ |
| 2214 | 0, /* tp_iter */ |
| 2215 | 0, /* tp_iternext */ |
| 2216 | defdict_methods, /* tp_methods */ |
| 2217 | defdict_members, /* tp_members */ |
| 2218 | 0, /* tp_getset */ |
| 2219 | DEFERRED_ADDRESS(&PyDict_Type), /* tp_base */ |
| 2220 | 0, /* tp_dict */ |
| 2221 | 0, /* tp_descr_get */ |
| 2222 | 0, /* tp_descr_set */ |
| 2223 | 0, /* tp_dictoffset */ |
| 2224 | defdict_init, /* tp_init */ |
| 2225 | PyType_GenericAlloc, /* tp_alloc */ |
| 2226 | 0, /* tp_new */ |
| 2227 | PyObject_GC_Del, /* tp_free */ |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2228 | }; |
| 2229 | |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2230 | /* helper function for Counter *********************************************/ |
| 2231 | |
Miss Islington (bot) | 21ce245 | 2019-06-05 16:20:58 -0700 | [diff] [blame] | 2232 | /*[clinic input] |
| 2233 | _collections._count_elements |
| 2234 | |
| 2235 | mapping: object |
| 2236 | iterable: object |
| 2237 | / |
| 2238 | |
| 2239 | Count elements in the iterable, updating the mapping |
| 2240 | [clinic start generated code]*/ |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2241 | |
| 2242 | static PyObject * |
Miss Islington (bot) | 21ce245 | 2019-06-05 16:20:58 -0700 | [diff] [blame] | 2243 | _collections__count_elements_impl(PyObject *module, PyObject *mapping, |
| 2244 | PyObject *iterable) |
| 2245 | /*[clinic end generated code: output=7e0c1789636b3d8f input=e79fad04534a0b45]*/ |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2246 | { |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 2247 | _Py_IDENTIFIER(get); |
Raymond Hettinger | 2ff2190 | 2013-10-01 00:55:43 -0700 | [diff] [blame] | 2248 | _Py_IDENTIFIER(__setitem__); |
Miss Islington (bot) | 21ce245 | 2019-06-05 16:20:58 -0700 | [diff] [blame] | 2249 | PyObject *it, *oldval; |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2250 | PyObject *newval = NULL; |
| 2251 | PyObject *key = NULL; |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 2252 | PyObject *bound_get = NULL; |
| 2253 | PyObject *mapping_get; |
| 2254 | PyObject *dict_get; |
Raymond Hettinger | 2ff2190 | 2013-10-01 00:55:43 -0700 | [diff] [blame] | 2255 | PyObject *mapping_setitem; |
Raymond Hettinger | 2ff2190 | 2013-10-01 00:55:43 -0700 | [diff] [blame] | 2256 | PyObject *dict_setitem; |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2257 | |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2258 | it = PyObject_GetIter(iterable); |
| 2259 | if (it == NULL) |
| 2260 | return NULL; |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2261 | |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 2262 | /* Only take the fast path when get() and __setitem__() |
| 2263 | * have not been overridden. |
| 2264 | */ |
| 2265 | mapping_get = _PyType_LookupId(Py_TYPE(mapping), &PyId_get); |
| 2266 | dict_get = _PyType_LookupId(&PyDict_Type, &PyId_get); |
Raymond Hettinger | 2ff2190 | 2013-10-01 00:55:43 -0700 | [diff] [blame] | 2267 | mapping_setitem = _PyType_LookupId(Py_TYPE(mapping), &PyId___setitem__); |
| 2268 | dict_setitem = _PyType_LookupId(&PyDict_Type, &PyId___setitem__); |
| 2269 | |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 2270 | if (mapping_get != NULL && mapping_get == dict_get && |
Oren Milman | 31aca4b | 2017-09-27 06:18:21 +0300 | [diff] [blame] | 2271 | mapping_setitem != NULL && mapping_setitem == dict_setitem && |
| 2272 | PyDict_Check(mapping)) |
| 2273 | { |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2274 | while (1) { |
Raymond Hettinger | 507d997 | 2014-05-18 21:32:40 +0100 | [diff] [blame] | 2275 | /* Fast path advantages: |
| 2276 | 1. Eliminate double hashing |
| 2277 | (by re-using the same hash for both the get and set) |
| 2278 | 2. Avoid argument overhead of PyObject_CallFunctionObjArgs |
| 2279 | (argument tuple creation and parsing) |
| 2280 | 3. Avoid indirection through a bound method object |
| 2281 | (creates another argument tuple) |
| 2282 | 4. Avoid initial increment from zero |
| 2283 | (reuse an existing one-object instead) |
| 2284 | */ |
Raymond Hettinger | 4b0b1ac | 2014-05-03 16:41:19 -0700 | [diff] [blame] | 2285 | Py_hash_t hash; |
| 2286 | |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2287 | key = PyIter_Next(it); |
Victor Stinner | a154b5c | 2011-04-20 23:23:52 +0200 | [diff] [blame] | 2288 | if (key == NULL) |
| 2289 | break; |
Raymond Hettinger | 4b0b1ac | 2014-05-03 16:41:19 -0700 | [diff] [blame] | 2290 | |
| 2291 | if (!PyUnicode_CheckExact(key) || |
| 2292 | (hash = ((PyASCIIObject *) key)->hash) == -1) |
| 2293 | { |
| 2294 | hash = PyObject_Hash(key); |
Raymond Hettinger | da2850f | 2015-02-27 12:42:54 -0800 | [diff] [blame] | 2295 | if (hash == -1) |
Raymond Hettinger | 4b0b1ac | 2014-05-03 16:41:19 -0700 | [diff] [blame] | 2296 | goto done; |
| 2297 | } |
| 2298 | |
| 2299 | oldval = _PyDict_GetItem_KnownHash(mapping, key, hash); |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2300 | if (oldval == NULL) { |
Serhiy Storchaka | f0b311b | 2016-11-06 13:18:24 +0200 | [diff] [blame] | 2301 | if (PyErr_Occurred()) |
| 2302 | goto done; |
Serhiy Storchaka | ba85d69 | 2017-03-30 09:09:41 +0300 | [diff] [blame] | 2303 | if (_PyDict_SetItem_KnownHash(mapping, key, _PyLong_One, hash) < 0) |
Raymond Hettinger | 507d997 | 2014-05-18 21:32:40 +0100 | [diff] [blame] | 2304 | goto done; |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2305 | } else { |
Serhiy Storchaka | ba85d69 | 2017-03-30 09:09:41 +0300 | [diff] [blame] | 2306 | newval = PyNumber_Add(oldval, _PyLong_One); |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2307 | if (newval == NULL) |
Raymond Hettinger | 507d997 | 2014-05-18 21:32:40 +0100 | [diff] [blame] | 2308 | goto done; |
Raymond Hettinger | 28c995d | 2015-08-14 02:07:41 -0700 | [diff] [blame] | 2309 | if (_PyDict_SetItem_KnownHash(mapping, key, newval, hash) < 0) |
Raymond Hettinger | 507d997 | 2014-05-18 21:32:40 +0100 | [diff] [blame] | 2310 | goto done; |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2311 | Py_CLEAR(newval); |
| 2312 | } |
| 2313 | Py_DECREF(key); |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2314 | } |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2315 | } else { |
Victor Stinner | e7f516c | 2013-11-06 23:52:55 +0100 | [diff] [blame] | 2316 | bound_get = _PyObject_GetAttrId(mapping, &PyId_get); |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 2317 | if (bound_get == NULL) |
Raymond Hettinger | 224c87d | 2013-10-01 21:36:09 -0700 | [diff] [blame] | 2318 | goto done; |
| 2319 | |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2320 | while (1) { |
| 2321 | key = PyIter_Next(it); |
Victor Stinner | a154b5c | 2011-04-20 23:23:52 +0200 | [diff] [blame] | 2322 | if (key == NULL) |
| 2323 | break; |
Serhiy Storchaka | ba85d69 | 2017-03-30 09:09:41 +0300 | [diff] [blame] | 2324 | oldval = PyObject_CallFunctionObjArgs(bound_get, key, _PyLong_Zero, NULL); |
Raymond Hettinger | 224c87d | 2013-10-01 21:36:09 -0700 | [diff] [blame] | 2325 | if (oldval == NULL) |
| 2326 | break; |
Serhiy Storchaka | ba85d69 | 2017-03-30 09:09:41 +0300 | [diff] [blame] | 2327 | newval = PyNumber_Add(oldval, _PyLong_One); |
Raymond Hettinger | 224c87d | 2013-10-01 21:36:09 -0700 | [diff] [blame] | 2328 | Py_DECREF(oldval); |
| 2329 | if (newval == NULL) |
| 2330 | break; |
Raymond Hettinger | 28c995d | 2015-08-14 02:07:41 -0700 | [diff] [blame] | 2331 | if (PyObject_SetItem(mapping, key, newval) < 0) |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2332 | break; |
| 2333 | Py_CLEAR(newval); |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2334 | Py_DECREF(key); |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2335 | } |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2336 | } |
Raymond Hettinger | 426e052 | 2011-01-03 02:12:02 +0000 | [diff] [blame] | 2337 | |
Raymond Hettinger | 224c87d | 2013-10-01 21:36:09 -0700 | [diff] [blame] | 2338 | done: |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2339 | Py_DECREF(it); |
| 2340 | Py_XDECREF(key); |
| 2341 | Py_XDECREF(newval); |
Raymond Hettinger | cb1d96f | 2013-10-04 16:51:02 -0700 | [diff] [blame] | 2342 | Py_XDECREF(bound_get); |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2343 | if (PyErr_Occurred()) |
| 2344 | return NULL; |
| 2345 | Py_RETURN_NONE; |
| 2346 | } |
| 2347 | |
Serhiy Storchaka | 052b2df | 2018-12-31 14:15:16 +0200 | [diff] [blame] | 2348 | /* Helper function for namedtuple() ************************************/ |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2349 | |
| 2350 | typedef struct { |
| 2351 | PyObject_HEAD |
| 2352 | Py_ssize_t index; |
| 2353 | PyObject* doc; |
| 2354 | } _tuplegetterobject; |
| 2355 | |
| 2356 | /*[clinic input] |
| 2357 | @classmethod |
| 2358 | _tuplegetter.__new__ as tuplegetter_new |
| 2359 | |
| 2360 | index: Py_ssize_t |
| 2361 | doc: object |
| 2362 | / |
| 2363 | [clinic start generated code]*/ |
| 2364 | |
| 2365 | static PyObject * |
| 2366 | tuplegetter_new_impl(PyTypeObject *type, Py_ssize_t index, PyObject *doc) |
| 2367 | /*[clinic end generated code: output=014be444ad80263f input=87c576a5bdbc0bbb]*/ |
| 2368 | { |
| 2369 | _tuplegetterobject* self; |
| 2370 | self = (_tuplegetterobject *)type->tp_alloc(type, 0); |
| 2371 | if (self == NULL) { |
| 2372 | return NULL; |
| 2373 | } |
| 2374 | self->index = index; |
| 2375 | Py_INCREF(doc); |
| 2376 | self->doc = doc; |
| 2377 | return (PyObject *)self; |
| 2378 | } |
| 2379 | |
| 2380 | static PyObject * |
Serhiy Storchaka | 052b2df | 2018-12-31 14:15:16 +0200 | [diff] [blame] | 2381 | tuplegetter_descr_get(PyObject *self, PyObject *obj, PyObject *type) |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2382 | { |
Serhiy Storchaka | 052b2df | 2018-12-31 14:15:16 +0200 | [diff] [blame] | 2383 | Py_ssize_t index = ((_tuplegetterobject*)self)->index; |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2384 | PyObject *result; |
Serhiy Storchaka | 052b2df | 2018-12-31 14:15:16 +0200 | [diff] [blame] | 2385 | |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2386 | if (obj == NULL) { |
| 2387 | Py_INCREF(self); |
| 2388 | return self; |
| 2389 | } |
| 2390 | if (!PyTuple_Check(obj)) { |
| 2391 | if (obj == Py_None) { |
| 2392 | Py_INCREF(self); |
| 2393 | return self; |
| 2394 | } |
| 2395 | PyErr_Format(PyExc_TypeError, |
Serhiy Storchaka | d53fe5f | 2019-03-13 22:59:55 +0200 | [diff] [blame] | 2396 | "descriptor for index '%zd' for tuple subclasses " |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2397 | "doesn't apply to '%s' object", |
Serhiy Storchaka | 052b2df | 2018-12-31 14:15:16 +0200 | [diff] [blame] | 2398 | index, |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2399 | obj->ob_type->tp_name); |
| 2400 | return NULL; |
| 2401 | } |
| 2402 | |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2403 | if (!valid_index(index, PyTuple_GET_SIZE(obj))) { |
| 2404 | PyErr_SetString(PyExc_IndexError, "tuple index out of range"); |
| 2405 | return NULL; |
| 2406 | } |
| 2407 | |
| 2408 | result = PyTuple_GET_ITEM(obj, index); |
| 2409 | Py_INCREF(result); |
| 2410 | return result; |
| 2411 | } |
| 2412 | |
| 2413 | static int |
Serhiy Storchaka | 052b2df | 2018-12-31 14:15:16 +0200 | [diff] [blame] | 2414 | tuplegetter_descr_set(PyObject *self, PyObject *obj, PyObject *value) |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2415 | { |
| 2416 | if (value == NULL) { |
| 2417 | PyErr_SetString(PyExc_AttributeError, "can't delete attribute"); |
| 2418 | } else { |
| 2419 | PyErr_SetString(PyExc_AttributeError, "can't set attribute"); |
| 2420 | } |
| 2421 | return -1; |
| 2422 | } |
| 2423 | |
| 2424 | static int |
| 2425 | tuplegetter_traverse(PyObject *self, visitproc visit, void *arg) |
| 2426 | { |
| 2427 | _tuplegetterobject *tuplegetter = (_tuplegetterobject *)self; |
| 2428 | Py_VISIT(tuplegetter->doc); |
| 2429 | return 0; |
| 2430 | } |
| 2431 | |
| 2432 | static int |
| 2433 | tuplegetter_clear(PyObject *self) |
| 2434 | { |
| 2435 | _tuplegetterobject *tuplegetter = (_tuplegetterobject *)self; |
| 2436 | Py_CLEAR(tuplegetter->doc); |
| 2437 | return 0; |
| 2438 | } |
| 2439 | |
| 2440 | static void |
| 2441 | tuplegetter_dealloc(_tuplegetterobject *self) |
| 2442 | { |
| 2443 | PyObject_GC_UnTrack(self); |
| 2444 | tuplegetter_clear((PyObject*)self); |
| 2445 | Py_TYPE(self)->tp_free((PyObject*)self); |
| 2446 | } |
| 2447 | |
Joe Jevnik | f36f892 | 2019-02-21 16:00:40 -0500 | [diff] [blame] | 2448 | static PyObject* |
Serhiy Storchaka | adfffc7 | 2019-03-05 18:41:09 +0200 | [diff] [blame] | 2449 | tuplegetter_reduce(_tuplegetterobject *self, PyObject *Py_UNUSED(ignored)) |
Joe Jevnik | f36f892 | 2019-02-21 16:00:40 -0500 | [diff] [blame] | 2450 | { |
| 2451 | return Py_BuildValue("(O(nO))", (PyObject*) Py_TYPE(self), self->index, self->doc); |
| 2452 | } |
| 2453 | |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2454 | |
| 2455 | static PyMemberDef tuplegetter_members[] = { |
| 2456 | {"__doc__", T_OBJECT, offsetof(_tuplegetterobject, doc), 0}, |
| 2457 | {0} |
| 2458 | }; |
| 2459 | |
Joe Jevnik | f36f892 | 2019-02-21 16:00:40 -0500 | [diff] [blame] | 2460 | static PyMethodDef tuplegetter_methods[] = { |
Serhiy Storchaka | adfffc7 | 2019-03-05 18:41:09 +0200 | [diff] [blame] | 2461 | {"__reduce__", (PyCFunction)tuplegetter_reduce, METH_NOARGS, NULL}, |
Joe Jevnik | f36f892 | 2019-02-21 16:00:40 -0500 | [diff] [blame] | 2462 | {NULL}, |
| 2463 | }; |
| 2464 | |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2465 | static PyTypeObject tuplegetter_type = { |
| 2466 | PyVarObject_HEAD_INIT(NULL, 0) |
| 2467 | "_collections._tuplegetter", /* tp_name */ |
| 2468 | sizeof(_tuplegetterobject), /* tp_basicsize */ |
| 2469 | 0, /* tp_itemsize */ |
| 2470 | /* methods */ |
| 2471 | (destructor)tuplegetter_dealloc, /* tp_dealloc */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 2472 | 0, /* tp_vectorcall_offset */ |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2473 | 0, /* tp_getattr */ |
| 2474 | 0, /* tp_setattr */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 2475 | 0, /* tp_as_async */ |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2476 | 0, /* tp_repr */ |
| 2477 | 0, /* tp_as_number */ |
| 2478 | 0, /* tp_as_sequence */ |
| 2479 | 0, /* tp_as_mapping */ |
| 2480 | 0, /* tp_hash */ |
| 2481 | 0, /* tp_call */ |
| 2482 | 0, /* tp_str */ |
| 2483 | 0, /* tp_getattro */ |
| 2484 | 0, /* tp_setattro */ |
| 2485 | 0, /* tp_as_buffer */ |
| 2486 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ |
| 2487 | 0, /* tp_doc */ |
| 2488 | (traverseproc)tuplegetter_traverse, /* tp_traverse */ |
| 2489 | (inquiry)tuplegetter_clear, /* tp_clear */ |
| 2490 | 0, /* tp_richcompare */ |
| 2491 | 0, /* tp_weaklistoffset */ |
| 2492 | 0, /* tp_iter */ |
| 2493 | 0, /* tp_iternext */ |
Joe Jevnik | f36f892 | 2019-02-21 16:00:40 -0500 | [diff] [blame] | 2494 | tuplegetter_methods, /* tp_methods */ |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2495 | tuplegetter_members, /* tp_members */ |
| 2496 | 0, /* tp_getset */ |
| 2497 | 0, /* tp_base */ |
| 2498 | 0, /* tp_dict */ |
Serhiy Storchaka | 052b2df | 2018-12-31 14:15:16 +0200 | [diff] [blame] | 2499 | tuplegetter_descr_get, /* tp_descr_get */ |
| 2500 | tuplegetter_descr_set, /* tp_descr_set */ |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2501 | 0, /* tp_dictoffset */ |
| 2502 | 0, /* tp_init */ |
| 2503 | 0, /* tp_alloc */ |
| 2504 | tuplegetter_new, /* tp_new */ |
| 2505 | 0, |
| 2506 | }; |
| 2507 | |
| 2508 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 2509 | /* module level code ********************************************************/ |
| 2510 | |
| 2511 | PyDoc_STRVAR(module_doc, |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2512 | "High performance data structures.\n\ |
| 2513 | - deque: ordered collection accessible from endpoints only\n\ |
| 2514 | - defaultdict: dict subclass with a default value factory\n\ |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 2515 | "); |
| 2516 | |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2517 | static struct PyMethodDef module_functions[] = { |
Miss Islington (bot) | 21ce245 | 2019-06-05 16:20:58 -0700 | [diff] [blame] | 2518 | _COLLECTIONS__COUNT_ELEMENTS_METHODDEF |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2519 | {NULL, NULL} /* sentinel */ |
| 2520 | }; |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 2521 | |
| 2522 | static struct PyModuleDef _collectionsmodule = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2523 | PyModuleDef_HEAD_INIT, |
| 2524 | "_collections", |
| 2525 | module_doc, |
| 2526 | -1, |
Raymond Hettinger | 96f3410 | 2010-12-15 16:30:37 +0000 | [diff] [blame] | 2527 | module_functions, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2528 | NULL, |
| 2529 | NULL, |
| 2530 | NULL, |
| 2531 | NULL |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 2532 | }; |
| 2533 | |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 2534 | PyMODINIT_FUNC |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 2535 | PyInit__collections(void) |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 2536 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2537 | PyObject *m; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 2538 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2539 | m = PyModule_Create(&_collectionsmodule); |
| 2540 | if (m == NULL) |
| 2541 | return NULL; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 2542 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2543 | if (PyType_Ready(&deque_type) < 0) |
| 2544 | return NULL; |
| 2545 | Py_INCREF(&deque_type); |
| 2546 | PyModule_AddObject(m, "deque", (PyObject *)&deque_type); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 2547 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2548 | defdict_type.tp_base = &PyDict_Type; |
| 2549 | if (PyType_Ready(&defdict_type) < 0) |
| 2550 | return NULL; |
| 2551 | Py_INCREF(&defdict_type); |
| 2552 | PyModule_AddObject(m, "defaultdict", (PyObject *)&defdict_type); |
Guido van Rossum | 1968ad3 | 2006-02-25 22:38:04 +0000 | [diff] [blame] | 2553 | |
Eric Snow | 47db717 | 2015-05-29 22:21:39 -0600 | [diff] [blame] | 2554 | Py_INCREF(&PyODict_Type); |
| 2555 | PyModule_AddObject(m, "OrderedDict", (PyObject *)&PyODict_Type); |
| 2556 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2557 | if (PyType_Ready(&dequeiter_type) < 0) |
| 2558 | return NULL; |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 2559 | Py_INCREF(&dequeiter_type); |
| 2560 | PyModule_AddObject(m, "_deque_iterator", (PyObject *)&dequeiter_type); |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 2561 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2562 | if (PyType_Ready(&dequereviter_type) < 0) |
| 2563 | return NULL; |
Kristján Valur Jónsson | 31668b8 | 2012-04-03 10:49:41 +0000 | [diff] [blame] | 2564 | Py_INCREF(&dequereviter_type); |
| 2565 | PyModule_AddObject(m, "_deque_reverse_iterator", (PyObject *)&dequereviter_type); |
Raymond Hettinger | 1e5809f | 2004-03-18 11:04:57 +0000 | [diff] [blame] | 2566 | |
Pablo Galindo | 3f5fc70 | 2018-12-30 09:24:03 +0000 | [diff] [blame] | 2567 | if (PyType_Ready(&tuplegetter_type) < 0) |
| 2568 | return NULL; |
| 2569 | Py_INCREF(&tuplegetter_type); |
| 2570 | PyModule_AddObject(m, "_tuplegetter", (PyObject *)&tuplegetter_type); |
| 2571 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2572 | return m; |
Raymond Hettinger | 756b3f3 | 2004-01-29 06:37:52 +0000 | [diff] [blame] | 2573 | } |