Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 1 | #include "Python.h" |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 2 | #include "structmember.h" /* for offsetof() */ |
| 3 | #include "_iomodule.h" |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 4 | |
| 5 | typedef struct { |
| 6 | PyObject_HEAD |
| 7 | char *buf; |
| 8 | Py_ssize_t pos; |
| 9 | Py_ssize_t string_size; |
| 10 | size_t buf_size; |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 11 | PyObject *dict; |
| 12 | PyObject *weakreflist; |
Antoine Pitrou | 972ee13 | 2010-09-06 18:48:21 +0000 | [diff] [blame] | 13 | Py_ssize_t exports; |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 14 | } bytesio; |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 15 | |
Antoine Pitrou | 972ee13 | 2010-09-06 18:48:21 +0000 | [diff] [blame] | 16 | typedef struct { |
| 17 | PyObject_HEAD |
| 18 | bytesio *source; |
| 19 | } bytesiobuf; |
| 20 | |
| 21 | |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 22 | #define CHECK_CLOSED(self) \ |
| 23 | if ((self)->buf == NULL) { \ |
| 24 | PyErr_SetString(PyExc_ValueError, \ |
| 25 | "I/O operation on closed file."); \ |
| 26 | return NULL; \ |
| 27 | } |
| 28 | |
Antoine Pitrou | 972ee13 | 2010-09-06 18:48:21 +0000 | [diff] [blame] | 29 | #define CHECK_EXPORTS(self) \ |
| 30 | if ((self)->exports > 0) { \ |
| 31 | PyErr_SetString(PyExc_BufferError, \ |
| 32 | "Existing exports of data: object cannot be re-sized"); \ |
| 33 | return NULL; \ |
| 34 | } |
| 35 | |
| 36 | |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 37 | /* Internal routine to get a line from the buffer of a BytesIO |
| 38 | object. Returns the length between the current position to the |
| 39 | next newline character. */ |
| 40 | static Py_ssize_t |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 41 | get_line(bytesio *self, char **output) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 42 | { |
| 43 | char *n; |
| 44 | const char *str_end; |
| 45 | Py_ssize_t len; |
| 46 | |
| 47 | assert(self->buf != NULL); |
| 48 | |
| 49 | /* Move to the end of the line, up to the end of the string, s. */ |
| 50 | str_end = self->buf + self->string_size; |
| 51 | for (n = self->buf + self->pos; |
| 52 | n < str_end && *n != '\n'; |
| 53 | n++); |
| 54 | |
| 55 | /* Skip the newline character */ |
| 56 | if (n < str_end) |
| 57 | n++; |
| 58 | |
| 59 | /* Get the length from the current position to the end of the line. */ |
| 60 | len = n - (self->buf + self->pos); |
| 61 | *output = self->buf + self->pos; |
| 62 | |
| 63 | assert(len >= 0); |
| 64 | assert(self->pos < PY_SSIZE_T_MAX - len); |
| 65 | self->pos += len; |
| 66 | |
| 67 | return len; |
| 68 | } |
| 69 | |
| 70 | /* Internal routine for changing the size of the buffer of BytesIO objects. |
| 71 | The caller should ensure that the 'size' argument is non-negative. Returns |
| 72 | 0 on success, -1 otherwise. */ |
| 73 | static int |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 74 | resize_buffer(bytesio *self, size_t size) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 75 | { |
| 76 | /* Here, unsigned types are used to avoid dealing with signed integer |
| 77 | overflow, which is undefined in C. */ |
| 78 | size_t alloc = self->buf_size; |
| 79 | char *new_buf = NULL; |
| 80 | |
| 81 | assert(self->buf != NULL); |
| 82 | |
| 83 | /* For simplicity, stay in the range of the signed type. Anyway, Python |
| 84 | doesn't allow strings to be longer than this. */ |
| 85 | if (size > PY_SSIZE_T_MAX) |
| 86 | goto overflow; |
| 87 | |
| 88 | if (size < alloc / 2) { |
| 89 | /* Major downsize; resize down to exact size. */ |
| 90 | alloc = size + 1; |
| 91 | } |
| 92 | else if (size < alloc) { |
| 93 | /* Within allocated size; quick exit */ |
| 94 | return 0; |
| 95 | } |
| 96 | else if (size <= alloc * 1.125) { |
| 97 | /* Moderate upsize; overallocate similar to list_resize() */ |
| 98 | alloc = size + (size >> 3) + (size < 9 ? 3 : 6); |
| 99 | } |
| 100 | else { |
| 101 | /* Major upsize; resize up to exact size */ |
| 102 | alloc = size + 1; |
| 103 | } |
| 104 | |
| 105 | if (alloc > ((size_t)-1) / sizeof(char)) |
| 106 | goto overflow; |
| 107 | new_buf = (char *)PyMem_Realloc(self->buf, alloc * sizeof(char)); |
| 108 | if (new_buf == NULL) { |
| 109 | PyErr_NoMemory(); |
| 110 | return -1; |
| 111 | } |
| 112 | self->buf_size = alloc; |
| 113 | self->buf = new_buf; |
| 114 | |
| 115 | return 0; |
| 116 | |
| 117 | overflow: |
| 118 | PyErr_SetString(PyExc_OverflowError, |
| 119 | "new buffer size too large"); |
| 120 | return -1; |
| 121 | } |
| 122 | |
| 123 | /* Internal routine for writing a string of bytes to the buffer of a BytesIO |
| 124 | object. Returns the number of bytes wrote, or -1 on error. */ |
| 125 | static Py_ssize_t |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 126 | write_bytes(bytesio *self, const char *bytes, Py_ssize_t len) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 127 | { |
| 128 | assert(self->buf != NULL); |
| 129 | assert(self->pos >= 0); |
| 130 | assert(len >= 0); |
| 131 | |
Alexandre Vassalotti | 1bfe9dc8 | 2008-05-07 01:44:31 +0000 | [diff] [blame] | 132 | if ((size_t)self->pos + len > self->buf_size) { |
| 133 | if (resize_buffer(self, (size_t)self->pos + len) < 0) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 134 | return -1; |
| 135 | } |
| 136 | |
| 137 | if (self->pos > self->string_size) { |
| 138 | /* In case of overseek, pad with null bytes the buffer region between |
| 139 | the end of stream and the current position. |
| 140 | |
| 141 | 0 lo string_size hi |
| 142 | | |<---used--->|<----------available----------->| |
| 143 | | | <--to pad-->|<---to write---> | |
| 144 | 0 buf position |
| 145 | */ |
| 146 | memset(self->buf + self->string_size, '\0', |
| 147 | (self->pos - self->string_size) * sizeof(char)); |
| 148 | } |
| 149 | |
| 150 | /* Copy the data to the internal buffer, overwriting some of the existing |
| 151 | data if self->pos < self->string_size. */ |
| 152 | memcpy(self->buf + self->pos, bytes, len); |
| 153 | self->pos += len; |
| 154 | |
| 155 | /* Set the new length of the internal string if it has changed. */ |
| 156 | if (self->string_size < self->pos) { |
| 157 | self->string_size = self->pos; |
| 158 | } |
| 159 | |
| 160 | return len; |
| 161 | } |
| 162 | |
| 163 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 164 | bytesio_get_closed(bytesio *self) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 165 | { |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 166 | if (self->buf == NULL) { |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 167 | Py_RETURN_TRUE; |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 168 | } |
| 169 | else { |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 170 | Py_RETURN_FALSE; |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 171 | } |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 172 | } |
| 173 | |
| 174 | /* Generic getter for the writable, readable and seekable properties */ |
| 175 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 176 | return_true(bytesio *self) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 177 | { |
| 178 | Py_RETURN_TRUE; |
| 179 | } |
| 180 | |
| 181 | PyDoc_STRVAR(flush_doc, |
| 182 | "flush() -> None. Does nothing."); |
| 183 | |
| 184 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 185 | bytesio_flush(bytesio *self) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 186 | { |
Antoine Pitrou | 6be8876 | 2010-05-03 16:48:20 +0000 | [diff] [blame] | 187 | CHECK_CLOSED(self); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 188 | Py_RETURN_NONE; |
| 189 | } |
| 190 | |
Antoine Pitrou | 972ee13 | 2010-09-06 18:48:21 +0000 | [diff] [blame] | 191 | PyDoc_STRVAR(getbuffer_doc, |
| 192 | "getbuffer() -> bytes.\n" |
| 193 | "\n" |
| 194 | "Get a read-write view over the contents of the BytesIO object."); |
| 195 | |
| 196 | static PyObject * |
| 197 | bytesio_getbuffer(bytesio *self) |
| 198 | { |
| 199 | PyTypeObject *type = &_PyBytesIOBuffer_Type; |
| 200 | bytesiobuf *buf; |
| 201 | PyObject *view; |
| 202 | |
| 203 | CHECK_CLOSED(self); |
| 204 | |
| 205 | buf = (bytesiobuf *) type->tp_alloc(type, 0); |
| 206 | if (buf == NULL) |
| 207 | return NULL; |
| 208 | Py_INCREF(self); |
| 209 | buf->source = self; |
| 210 | view = PyMemoryView_FromObject((PyObject *) buf); |
| 211 | Py_DECREF(buf); |
| 212 | return view; |
| 213 | } |
| 214 | |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 215 | PyDoc_STRVAR(getval_doc, |
Alexandre Vassalotti | 10dfc1e | 2008-05-08 01:34:41 +0000 | [diff] [blame] | 216 | "getvalue() -> bytes.\n" |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 217 | "\n" |
| 218 | "Retrieve the entire contents of the BytesIO object."); |
| 219 | |
| 220 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 221 | bytesio_getvalue(bytesio *self) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 222 | { |
| 223 | CHECK_CLOSED(self); |
Christian Heimes | 72b710a | 2008-05-26 13:28:38 +0000 | [diff] [blame] | 224 | return PyBytes_FromStringAndSize(self->buf, self->string_size); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 225 | } |
| 226 | |
| 227 | PyDoc_STRVAR(isatty_doc, |
| 228 | "isatty() -> False.\n" |
| 229 | "\n" |
| 230 | "Always returns False since BytesIO objects are not connected\n" |
| 231 | "to a tty-like device."); |
| 232 | |
| 233 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 234 | bytesio_isatty(bytesio *self) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 235 | { |
| 236 | CHECK_CLOSED(self); |
| 237 | Py_RETURN_FALSE; |
| 238 | } |
| 239 | |
| 240 | PyDoc_STRVAR(tell_doc, |
| 241 | "tell() -> current file position, an integer\n"); |
| 242 | |
| 243 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 244 | bytesio_tell(bytesio *self) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 245 | { |
| 246 | CHECK_CLOSED(self); |
| 247 | return PyLong_FromSsize_t(self->pos); |
| 248 | } |
| 249 | |
| 250 | PyDoc_STRVAR(read_doc, |
| 251 | "read([size]) -> read at most size bytes, returned as a string.\n" |
| 252 | "\n" |
| 253 | "If the size argument is negative, read until EOF is reached.\n" |
| 254 | "Return an empty string at EOF."); |
| 255 | |
| 256 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 257 | bytesio_read(bytesio *self, PyObject *args) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 258 | { |
| 259 | Py_ssize_t size, n; |
| 260 | char *output; |
| 261 | PyObject *arg = Py_None; |
| 262 | |
| 263 | CHECK_CLOSED(self); |
| 264 | |
| 265 | if (!PyArg_ParseTuple(args, "|O:read", &arg)) |
| 266 | return NULL; |
| 267 | |
| 268 | if (PyLong_Check(arg)) { |
| 269 | size = PyLong_AsSsize_t(arg); |
Benjamin Peterson | a8a9304 | 2008-09-30 02:18:09 +0000 | [diff] [blame] | 270 | if (size == -1 && PyErr_Occurred()) |
| 271 | return NULL; |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 272 | } |
| 273 | else if (arg == Py_None) { |
| 274 | /* Read until EOF is reached, by default. */ |
| 275 | size = -1; |
| 276 | } |
| 277 | else { |
| 278 | PyErr_Format(PyExc_TypeError, "integer argument expected, got '%s'", |
| 279 | Py_TYPE(arg)->tp_name); |
| 280 | return NULL; |
| 281 | } |
| 282 | |
| 283 | /* adjust invalid sizes */ |
| 284 | n = self->string_size - self->pos; |
| 285 | if (size < 0 || size > n) { |
| 286 | size = n; |
| 287 | if (size < 0) |
| 288 | size = 0; |
| 289 | } |
| 290 | |
| 291 | assert(self->buf != NULL); |
| 292 | output = self->buf + self->pos; |
| 293 | self->pos += size; |
| 294 | |
Christian Heimes | 72b710a | 2008-05-26 13:28:38 +0000 | [diff] [blame] | 295 | return PyBytes_FromStringAndSize(output, size); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 296 | } |
| 297 | |
| 298 | |
| 299 | PyDoc_STRVAR(read1_doc, |
| 300 | "read1(size) -> read at most size bytes, returned as a string.\n" |
| 301 | "\n" |
| 302 | "If the size argument is negative or omitted, read until EOF is reached.\n" |
| 303 | "Return an empty string at EOF."); |
| 304 | |
| 305 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 306 | bytesio_read1(bytesio *self, PyObject *n) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 307 | { |
| 308 | PyObject *arg, *res; |
| 309 | |
| 310 | arg = PyTuple_Pack(1, n); |
| 311 | if (arg == NULL) |
| 312 | return NULL; |
| 313 | res = bytesio_read(self, arg); |
| 314 | Py_DECREF(arg); |
| 315 | return res; |
| 316 | } |
| 317 | |
| 318 | PyDoc_STRVAR(readline_doc, |
| 319 | "readline([size]) -> next line from the file, as a string.\n" |
| 320 | "\n" |
| 321 | "Retain newline. A non-negative size argument limits the maximum\n" |
| 322 | "number of bytes to return (an incomplete line may be returned then).\n" |
| 323 | "Return an empty string at EOF.\n"); |
| 324 | |
| 325 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 326 | bytesio_readline(bytesio *self, PyObject *args) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 327 | { |
| 328 | Py_ssize_t size, n; |
| 329 | char *output; |
| 330 | PyObject *arg = Py_None; |
| 331 | |
| 332 | CHECK_CLOSED(self); |
| 333 | |
| 334 | if (!PyArg_ParseTuple(args, "|O:readline", &arg)) |
| 335 | return NULL; |
| 336 | |
| 337 | if (PyLong_Check(arg)) { |
| 338 | size = PyLong_AsSsize_t(arg); |
Benjamin Peterson | a8a9304 | 2008-09-30 02:18:09 +0000 | [diff] [blame] | 339 | if (size == -1 && PyErr_Occurred()) |
| 340 | return NULL; |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 341 | } |
| 342 | else if (arg == Py_None) { |
| 343 | /* No size limit, by default. */ |
| 344 | size = -1; |
| 345 | } |
| 346 | else { |
| 347 | PyErr_Format(PyExc_TypeError, "integer argument expected, got '%s'", |
| 348 | Py_TYPE(arg)->tp_name); |
| 349 | return NULL; |
| 350 | } |
| 351 | |
| 352 | n = get_line(self, &output); |
| 353 | |
| 354 | if (size >= 0 && size < n) { |
| 355 | size = n - size; |
| 356 | n -= size; |
| 357 | self->pos -= size; |
| 358 | } |
| 359 | |
Christian Heimes | 72b710a | 2008-05-26 13:28:38 +0000 | [diff] [blame] | 360 | return PyBytes_FromStringAndSize(output, n); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 361 | } |
| 362 | |
| 363 | PyDoc_STRVAR(readlines_doc, |
| 364 | "readlines([size]) -> list of strings, each a line from the file.\n" |
| 365 | "\n" |
| 366 | "Call readline() repeatedly and return a list of the lines so read.\n" |
| 367 | "The optional size argument, if given, is an approximate bound on the\n" |
| 368 | "total number of bytes in the lines returned.\n"); |
| 369 | |
| 370 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 371 | bytesio_readlines(bytesio *self, PyObject *args) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 372 | { |
| 373 | Py_ssize_t maxsize, size, n; |
| 374 | PyObject *result, *line; |
| 375 | char *output; |
| 376 | PyObject *arg = Py_None; |
| 377 | |
| 378 | CHECK_CLOSED(self); |
| 379 | |
| 380 | if (!PyArg_ParseTuple(args, "|O:readlines", &arg)) |
| 381 | return NULL; |
| 382 | |
| 383 | if (PyLong_Check(arg)) { |
| 384 | maxsize = PyLong_AsSsize_t(arg); |
Benjamin Peterson | a8a9304 | 2008-09-30 02:18:09 +0000 | [diff] [blame] | 385 | if (maxsize == -1 && PyErr_Occurred()) |
| 386 | return NULL; |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 387 | } |
| 388 | else if (arg == Py_None) { |
| 389 | /* No size limit, by default. */ |
| 390 | maxsize = -1; |
| 391 | } |
| 392 | else { |
| 393 | PyErr_Format(PyExc_TypeError, "integer argument expected, got '%s'", |
| 394 | Py_TYPE(arg)->tp_name); |
| 395 | return NULL; |
| 396 | } |
| 397 | |
| 398 | size = 0; |
| 399 | result = PyList_New(0); |
| 400 | if (!result) |
| 401 | return NULL; |
| 402 | |
| 403 | while ((n = get_line(self, &output)) != 0) { |
Christian Heimes | 72b710a | 2008-05-26 13:28:38 +0000 | [diff] [blame] | 404 | line = PyBytes_FromStringAndSize(output, n); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 405 | if (!line) |
| 406 | goto on_error; |
| 407 | if (PyList_Append(result, line) == -1) { |
| 408 | Py_DECREF(line); |
| 409 | goto on_error; |
| 410 | } |
| 411 | Py_DECREF(line); |
| 412 | size += n; |
| 413 | if (maxsize > 0 && size >= maxsize) |
| 414 | break; |
| 415 | } |
| 416 | return result; |
| 417 | |
| 418 | on_error: |
| 419 | Py_DECREF(result); |
| 420 | return NULL; |
| 421 | } |
| 422 | |
| 423 | PyDoc_STRVAR(readinto_doc, |
Alexandre Vassalotti | 10dfc1e | 2008-05-08 01:34:41 +0000 | [diff] [blame] | 424 | "readinto(bytearray) -> int. Read up to len(b) bytes into b.\n" |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 425 | "\n" |
| 426 | "Returns number of bytes read (0 for EOF), or None if the object\n" |
| 427 | "is set not to block as has no data to read."); |
| 428 | |
| 429 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 430 | bytesio_readinto(bytesio *self, PyObject *buffer) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 431 | { |
| 432 | void *raw_buffer; |
Benjamin Peterson | fa73555 | 2010-11-20 17:24:04 +0000 | [diff] [blame^] | 433 | Py_ssize_t len, n; |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 434 | |
| 435 | CHECK_CLOSED(self); |
| 436 | |
| 437 | if (PyObject_AsWriteBuffer(buffer, &raw_buffer, &len) == -1) |
| 438 | return NULL; |
| 439 | |
Benjamin Peterson | fa73555 | 2010-11-20 17:24:04 +0000 | [diff] [blame^] | 440 | /* adjust invalid sizes */ |
| 441 | n = self->string_size - self->pos; |
| 442 | if (len > n) { |
| 443 | len = n; |
| 444 | if (len < 0) |
| 445 | len = 0; |
| 446 | } |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 447 | |
| 448 | memcpy(raw_buffer, self->buf + self->pos, len); |
| 449 | assert(self->pos + len < PY_SSIZE_T_MAX); |
| 450 | assert(len >= 0); |
| 451 | self->pos += len; |
| 452 | |
| 453 | return PyLong_FromSsize_t(len); |
| 454 | } |
| 455 | |
| 456 | PyDoc_STRVAR(truncate_doc, |
| 457 | "truncate([size]) -> int. Truncate the file to at most size bytes.\n" |
| 458 | "\n" |
| 459 | "Size defaults to the current file position, as returned by tell().\n" |
Antoine Pitrou | 905a2ff | 2010-01-31 22:47:27 +0000 | [diff] [blame] | 460 | "The current file position is unchanged. Returns the new size.\n"); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 461 | |
| 462 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 463 | bytesio_truncate(bytesio *self, PyObject *args) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 464 | { |
| 465 | Py_ssize_t size; |
| 466 | PyObject *arg = Py_None; |
| 467 | |
| 468 | CHECK_CLOSED(self); |
Antoine Pitrou | 972ee13 | 2010-09-06 18:48:21 +0000 | [diff] [blame] | 469 | CHECK_EXPORTS(self); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 470 | |
| 471 | if (!PyArg_ParseTuple(args, "|O:truncate", &arg)) |
| 472 | return NULL; |
| 473 | |
| 474 | if (PyLong_Check(arg)) { |
| 475 | size = PyLong_AsSsize_t(arg); |
Benjamin Peterson | a8a9304 | 2008-09-30 02:18:09 +0000 | [diff] [blame] | 476 | if (size == -1 && PyErr_Occurred()) |
| 477 | return NULL; |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 478 | } |
| 479 | else if (arg == Py_None) { |
| 480 | /* Truncate to current position if no argument is passed. */ |
| 481 | size = self->pos; |
| 482 | } |
| 483 | else { |
| 484 | PyErr_Format(PyExc_TypeError, "integer argument expected, got '%s'", |
| 485 | Py_TYPE(arg)->tp_name); |
| 486 | return NULL; |
| 487 | } |
| 488 | |
| 489 | if (size < 0) { |
| 490 | PyErr_Format(PyExc_ValueError, |
| 491 | "negative size value %zd", size); |
| 492 | return NULL; |
| 493 | } |
| 494 | |
| 495 | if (size < self->string_size) { |
| 496 | self->string_size = size; |
| 497 | if (resize_buffer(self, size) < 0) |
| 498 | return NULL; |
| 499 | } |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 500 | |
| 501 | return PyLong_FromSsize_t(size); |
| 502 | } |
| 503 | |
| 504 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 505 | bytesio_iternext(bytesio *self) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 506 | { |
| 507 | char *next; |
| 508 | Py_ssize_t n; |
| 509 | |
| 510 | CHECK_CLOSED(self); |
| 511 | |
| 512 | n = get_line(self, &next); |
| 513 | |
| 514 | if (!next || n == 0) |
| 515 | return NULL; |
| 516 | |
Christian Heimes | 72b710a | 2008-05-26 13:28:38 +0000 | [diff] [blame] | 517 | return PyBytes_FromStringAndSize(next, n); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 518 | } |
| 519 | |
| 520 | PyDoc_STRVAR(seek_doc, |
| 521 | "seek(pos, whence=0) -> int. Change stream position.\n" |
| 522 | "\n" |
| 523 | "Seek to byte offset pos relative to position indicated by whence:\n" |
| 524 | " 0 Start of stream (the default). pos should be >= 0;\n" |
| 525 | " 1 Current position - pos may be negative;\n" |
| 526 | " 2 End of stream - pos usually negative.\n" |
| 527 | "Returns the new absolute position."); |
| 528 | |
| 529 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 530 | bytesio_seek(bytesio *self, PyObject *args) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 531 | { |
| 532 | Py_ssize_t pos; |
| 533 | int mode = 0; |
| 534 | |
| 535 | CHECK_CLOSED(self); |
| 536 | |
| 537 | if (!PyArg_ParseTuple(args, "n|i:seek", &pos, &mode)) |
| 538 | return NULL; |
| 539 | |
| 540 | if (pos < 0 && mode == 0) { |
| 541 | PyErr_Format(PyExc_ValueError, |
| 542 | "negative seek value %zd", pos); |
| 543 | return NULL; |
| 544 | } |
| 545 | |
| 546 | /* mode 0: offset relative to beginning of the string. |
| 547 | mode 1: offset relative to current position. |
| 548 | mode 2: offset relative the end of the string. */ |
| 549 | if (mode == 1) { |
| 550 | if (pos > PY_SSIZE_T_MAX - self->pos) { |
| 551 | PyErr_SetString(PyExc_OverflowError, |
| 552 | "new position too large"); |
| 553 | return NULL; |
| 554 | } |
| 555 | pos += self->pos; |
| 556 | } |
| 557 | else if (mode == 2) { |
| 558 | if (pos > PY_SSIZE_T_MAX - self->string_size) { |
| 559 | PyErr_SetString(PyExc_OverflowError, |
| 560 | "new position too large"); |
| 561 | return NULL; |
| 562 | } |
| 563 | pos += self->string_size; |
| 564 | } |
| 565 | else if (mode != 0) { |
| 566 | PyErr_Format(PyExc_ValueError, |
| 567 | "invalid whence (%i, should be 0, 1 or 2)", mode); |
| 568 | return NULL; |
| 569 | } |
| 570 | |
| 571 | if (pos < 0) |
| 572 | pos = 0; |
| 573 | self->pos = pos; |
| 574 | |
| 575 | return PyLong_FromSsize_t(self->pos); |
| 576 | } |
| 577 | |
| 578 | PyDoc_STRVAR(write_doc, |
Alexandre Vassalotti | 10dfc1e | 2008-05-08 01:34:41 +0000 | [diff] [blame] | 579 | "write(bytes) -> int. Write bytes to file.\n" |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 580 | "\n" |
| 581 | "Return the number of bytes written."); |
| 582 | |
| 583 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 584 | bytesio_write(bytesio *self, PyObject *obj) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 585 | { |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 586 | Py_ssize_t n = 0; |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 587 | Py_buffer buf; |
| 588 | PyObject *result = NULL; |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 589 | |
| 590 | CHECK_CLOSED(self); |
Antoine Pitrou | 972ee13 | 2010-09-06 18:48:21 +0000 | [diff] [blame] | 591 | CHECK_EXPORTS(self); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 592 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 593 | if (PyObject_GetBuffer(obj, &buf, PyBUF_CONTIG_RO) < 0) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 594 | return NULL; |
| 595 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 596 | if (buf.len != 0) |
| 597 | n = write_bytes(self, buf.buf, buf.len); |
| 598 | if (n >= 0) |
| 599 | result = PyLong_FromSsize_t(n); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 600 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 601 | PyBuffer_Release(&buf); |
| 602 | return result; |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 603 | } |
| 604 | |
| 605 | PyDoc_STRVAR(writelines_doc, |
Alexandre Vassalotti | 7d06089 | 2008-05-07 01:47:37 +0000 | [diff] [blame] | 606 | "writelines(sequence_of_strings) -> None. Write strings to the file.\n" |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 607 | "\n" |
Alexandre Vassalotti | 7d06089 | 2008-05-07 01:47:37 +0000 | [diff] [blame] | 608 | "Note that newlines are not added. The sequence can be any iterable\n" |
| 609 | "object producing strings. This is equivalent to calling write() for\n" |
| 610 | "each string."); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 611 | |
| 612 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 613 | bytesio_writelines(bytesio *self, PyObject *v) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 614 | { |
| 615 | PyObject *it, *item; |
| 616 | PyObject *ret; |
| 617 | |
| 618 | CHECK_CLOSED(self); |
| 619 | |
| 620 | it = PyObject_GetIter(v); |
| 621 | if (it == NULL) |
| 622 | return NULL; |
| 623 | |
| 624 | while ((item = PyIter_Next(it)) != NULL) { |
| 625 | ret = bytesio_write(self, item); |
| 626 | Py_DECREF(item); |
| 627 | if (ret == NULL) { |
| 628 | Py_DECREF(it); |
| 629 | return NULL; |
| 630 | } |
| 631 | Py_DECREF(ret); |
| 632 | } |
| 633 | Py_DECREF(it); |
| 634 | |
| 635 | /* See if PyIter_Next failed */ |
| 636 | if (PyErr_Occurred()) |
| 637 | return NULL; |
| 638 | |
| 639 | Py_RETURN_NONE; |
| 640 | } |
| 641 | |
| 642 | PyDoc_STRVAR(close_doc, |
| 643 | "close() -> None. Disable all I/O operations."); |
| 644 | |
| 645 | static PyObject * |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 646 | bytesio_close(bytesio *self) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 647 | { |
| 648 | if (self->buf != NULL) { |
| 649 | PyMem_Free(self->buf); |
| 650 | self->buf = NULL; |
| 651 | } |
| 652 | Py_RETURN_NONE; |
| 653 | } |
| 654 | |
Alexandre Vassalotti | cf76e1a | 2009-07-22 03:24:36 +0000 | [diff] [blame] | 655 | /* Pickling support. |
| 656 | |
| 657 | Note that only pickle protocol 2 and onward are supported since we use |
| 658 | extended __reduce__ API of PEP 307 to make BytesIO instances picklable. |
| 659 | |
| 660 | Providing support for protocol < 2 would require the __reduce_ex__ method |
| 661 | which is notably long-winded when defined properly. |
| 662 | |
| 663 | For BytesIO, the implementation would similar to one coded for |
| 664 | object.__reduce_ex__, but slightly less general. To be more specific, we |
| 665 | could call bytesio_getstate directly and avoid checking for the presence of |
| 666 | a fallback __reduce__ method. However, we would still need a __newobj__ |
| 667 | function to use the efficient instance representation of PEP 307. |
| 668 | */ |
| 669 | |
| 670 | static PyObject * |
| 671 | bytesio_getstate(bytesio *self) |
| 672 | { |
| 673 | PyObject *initvalue = bytesio_getvalue(self); |
| 674 | PyObject *dict; |
| 675 | PyObject *state; |
| 676 | |
| 677 | if (initvalue == NULL) |
| 678 | return NULL; |
| 679 | if (self->dict == NULL) { |
| 680 | Py_INCREF(Py_None); |
| 681 | dict = Py_None; |
| 682 | } |
| 683 | else { |
| 684 | dict = PyDict_Copy(self->dict); |
| 685 | if (dict == NULL) |
| 686 | return NULL; |
| 687 | } |
| 688 | |
| 689 | state = Py_BuildValue("(OnN)", initvalue, self->pos, dict); |
| 690 | Py_DECREF(initvalue); |
| 691 | return state; |
| 692 | } |
| 693 | |
| 694 | static PyObject * |
| 695 | bytesio_setstate(bytesio *self, PyObject *state) |
| 696 | { |
| 697 | PyObject *result; |
| 698 | PyObject *position_obj; |
| 699 | PyObject *dict; |
| 700 | Py_ssize_t pos; |
| 701 | |
| 702 | assert(state != NULL); |
| 703 | |
| 704 | /* We allow the state tuple to be longer than 3, because we may need |
| 705 | someday to extend the object's state without breaking |
| 706 | backward-compatibility. */ |
| 707 | if (!PyTuple_Check(state) || Py_SIZE(state) < 3) { |
| 708 | PyErr_Format(PyExc_TypeError, |
| 709 | "%.200s.__setstate__ argument should be 3-tuple, got %.200s", |
| 710 | Py_TYPE(self)->tp_name, Py_TYPE(state)->tp_name); |
| 711 | return NULL; |
| 712 | } |
Antoine Pitrou | 972ee13 | 2010-09-06 18:48:21 +0000 | [diff] [blame] | 713 | CHECK_EXPORTS(self); |
Alexandre Vassalotti | cf76e1a | 2009-07-22 03:24:36 +0000 | [diff] [blame] | 714 | /* Reset the object to its default state. This is only needed to handle |
| 715 | the case of repeated calls to __setstate__. */ |
| 716 | self->string_size = 0; |
| 717 | self->pos = 0; |
| 718 | |
| 719 | /* Set the value of the internal buffer. If state[0] does not support the |
| 720 | buffer protocol, bytesio_write will raise the appropriate TypeError. */ |
| 721 | result = bytesio_write(self, PyTuple_GET_ITEM(state, 0)); |
| 722 | if (result == NULL) |
| 723 | return NULL; |
| 724 | Py_DECREF(result); |
| 725 | |
| 726 | /* Set carefully the position value. Alternatively, we could use the seek |
| 727 | method instead of modifying self->pos directly to better protect the |
| 728 | object internal state against errneous (or malicious) inputs. */ |
| 729 | position_obj = PyTuple_GET_ITEM(state, 1); |
| 730 | if (!PyLong_Check(position_obj)) { |
| 731 | PyErr_Format(PyExc_TypeError, |
| 732 | "second item of state must be an integer, not %.200s", |
| 733 | Py_TYPE(position_obj)->tp_name); |
| 734 | return NULL; |
| 735 | } |
| 736 | pos = PyLong_AsSsize_t(position_obj); |
| 737 | if (pos == -1 && PyErr_Occurred()) |
| 738 | return NULL; |
| 739 | if (pos < 0) { |
| 740 | PyErr_SetString(PyExc_ValueError, |
| 741 | "position value cannot be negative"); |
| 742 | return NULL; |
| 743 | } |
| 744 | self->pos = pos; |
| 745 | |
| 746 | /* Set the dictionary of the instance variables. */ |
| 747 | dict = PyTuple_GET_ITEM(state, 2); |
| 748 | if (dict != Py_None) { |
| 749 | if (!PyDict_Check(dict)) { |
| 750 | PyErr_Format(PyExc_TypeError, |
| 751 | "third item of state should be a dict, got a %.200s", |
| 752 | Py_TYPE(dict)->tp_name); |
| 753 | return NULL; |
| 754 | } |
| 755 | if (self->dict) { |
| 756 | /* Alternatively, we could replace the internal dictionary |
| 757 | completely. However, it seems more practical to just update it. */ |
| 758 | if (PyDict_Update(self->dict, dict) < 0) |
| 759 | return NULL; |
| 760 | } |
| 761 | else { |
| 762 | Py_INCREF(dict); |
| 763 | self->dict = dict; |
| 764 | } |
| 765 | } |
| 766 | |
| 767 | Py_RETURN_NONE; |
| 768 | } |
| 769 | |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 770 | static void |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 771 | bytesio_dealloc(bytesio *self) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 772 | { |
Alexandre Vassalotti | fc47704 | 2009-07-22 02:24:49 +0000 | [diff] [blame] | 773 | _PyObject_GC_UNTRACK(self); |
Antoine Pitrou | 972ee13 | 2010-09-06 18:48:21 +0000 | [diff] [blame] | 774 | if (self->exports > 0) { |
| 775 | PyErr_SetString(PyExc_SystemError, |
| 776 | "deallocated BytesIO object has exported buffers"); |
| 777 | PyErr_Print(); |
| 778 | } |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 779 | if (self->buf != NULL) { |
| 780 | PyMem_Free(self->buf); |
| 781 | self->buf = NULL; |
| 782 | } |
Alexandre Vassalotti | fc47704 | 2009-07-22 02:24:49 +0000 | [diff] [blame] | 783 | Py_CLEAR(self->dict); |
| 784 | if (self->weakreflist != NULL) |
| 785 | PyObject_ClearWeakRefs((PyObject *) self); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 786 | Py_TYPE(self)->tp_free(self); |
| 787 | } |
| 788 | |
| 789 | static PyObject * |
| 790 | bytesio_new(PyTypeObject *type, PyObject *args, PyObject *kwds) |
| 791 | { |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 792 | bytesio *self; |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 793 | |
| 794 | assert(type != NULL && type->tp_alloc != NULL); |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 795 | self = (bytesio *)type->tp_alloc(type, 0); |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 796 | if (self == NULL) |
| 797 | return NULL; |
| 798 | |
Alexandre Vassalotti | cf76e1a | 2009-07-22 03:24:36 +0000 | [diff] [blame] | 799 | /* tp_alloc initializes all the fields to zero. So we don't have to |
| 800 | initialize them here. */ |
| 801 | |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 802 | self->buf = (char *)PyMem_Malloc(0); |
| 803 | if (self->buf == NULL) { |
| 804 | Py_DECREF(self); |
| 805 | return PyErr_NoMemory(); |
| 806 | } |
| 807 | |
| 808 | return (PyObject *)self; |
| 809 | } |
| 810 | |
| 811 | static int |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 812 | bytesio_init(bytesio *self, PyObject *args, PyObject *kwds) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 813 | { |
Alexandre Vassalotti | ba5c743 | 2009-08-04 23:19:13 +0000 | [diff] [blame] | 814 | char *kwlist[] = {"initial_bytes", NULL}; |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 815 | PyObject *initvalue = NULL; |
| 816 | |
Alexandre Vassalotti | ba5c743 | 2009-08-04 23:19:13 +0000 | [diff] [blame] | 817 | if (!PyArg_ParseTupleAndKeywords(args, kwds, "|O:BytesIO", kwlist, |
| 818 | &initvalue)) |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 819 | return -1; |
| 820 | |
| 821 | /* In case, __init__ is called multiple times. */ |
| 822 | self->string_size = 0; |
| 823 | self->pos = 0; |
| 824 | |
| 825 | if (initvalue && initvalue != Py_None) { |
| 826 | PyObject *res; |
| 827 | res = bytesio_write(self, initvalue); |
| 828 | if (res == NULL) |
| 829 | return -1; |
| 830 | Py_DECREF(res); |
| 831 | self->pos = 0; |
| 832 | } |
| 833 | |
| 834 | return 0; |
| 835 | } |
| 836 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 837 | static int |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 838 | bytesio_traverse(bytesio *self, visitproc visit, void *arg) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 839 | { |
| 840 | Py_VISIT(self->dict); |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 841 | return 0; |
| 842 | } |
| 843 | |
| 844 | static int |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 845 | bytesio_clear(bytesio *self) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 846 | { |
| 847 | Py_CLEAR(self->dict); |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 848 | return 0; |
| 849 | } |
| 850 | |
| 851 | |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 852 | static PyGetSetDef bytesio_getsetlist[] = { |
| 853 | {"closed", (getter)bytesio_get_closed, NULL, |
| 854 | "True if the file is closed."}, |
Benjamin Peterson | 1fea321 | 2009-04-19 03:15:20 +0000 | [diff] [blame] | 855 | {NULL}, /* sentinel */ |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 856 | }; |
| 857 | |
| 858 | static struct PyMethodDef bytesio_methods[] = { |
| 859 | {"readable", (PyCFunction)return_true, METH_NOARGS, NULL}, |
| 860 | {"seekable", (PyCFunction)return_true, METH_NOARGS, NULL}, |
| 861 | {"writable", (PyCFunction)return_true, METH_NOARGS, NULL}, |
| 862 | {"close", (PyCFunction)bytesio_close, METH_NOARGS, close_doc}, |
| 863 | {"flush", (PyCFunction)bytesio_flush, METH_NOARGS, flush_doc}, |
| 864 | {"isatty", (PyCFunction)bytesio_isatty, METH_NOARGS, isatty_doc}, |
| 865 | {"tell", (PyCFunction)bytesio_tell, METH_NOARGS, tell_doc}, |
| 866 | {"write", (PyCFunction)bytesio_write, METH_O, write_doc}, |
| 867 | {"writelines", (PyCFunction)bytesio_writelines, METH_O, writelines_doc}, |
| 868 | {"read1", (PyCFunction)bytesio_read1, METH_O, read1_doc}, |
| 869 | {"readinto", (PyCFunction)bytesio_readinto, METH_O, readinto_doc}, |
| 870 | {"readline", (PyCFunction)bytesio_readline, METH_VARARGS, readline_doc}, |
| 871 | {"readlines", (PyCFunction)bytesio_readlines, METH_VARARGS, readlines_doc}, |
| 872 | {"read", (PyCFunction)bytesio_read, METH_VARARGS, read_doc}, |
Antoine Pitrou | 972ee13 | 2010-09-06 18:48:21 +0000 | [diff] [blame] | 873 | {"getbuffer", (PyCFunction)bytesio_getbuffer, METH_NOARGS, getbuffer_doc}, |
Antoine Pitrou | d5c3f6c | 2010-09-02 19:48:07 +0000 | [diff] [blame] | 874 | {"getvalue", (PyCFunction)bytesio_getvalue, METH_NOARGS, getval_doc}, |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 875 | {"seek", (PyCFunction)bytesio_seek, METH_VARARGS, seek_doc}, |
| 876 | {"truncate", (PyCFunction)bytesio_truncate, METH_VARARGS, truncate_doc}, |
Alexandre Vassalotti | cf76e1a | 2009-07-22 03:24:36 +0000 | [diff] [blame] | 877 | {"__getstate__", (PyCFunction)bytesio_getstate, METH_NOARGS, NULL}, |
| 878 | {"__setstate__", (PyCFunction)bytesio_setstate, METH_O, NULL}, |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 879 | {NULL, NULL} /* sentinel */ |
| 880 | }; |
| 881 | |
| 882 | PyDoc_STRVAR(bytesio_doc, |
| 883 | "BytesIO([buffer]) -> object\n" |
| 884 | "\n" |
| 885 | "Create a buffered I/O implementation using an in-memory bytes\n" |
| 886 | "buffer, ready for reading and writing."); |
| 887 | |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 888 | PyTypeObject PyBytesIO_Type = { |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 889 | PyVarObject_HEAD_INIT(NULL, 0) |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 890 | "_io.BytesIO", /*tp_name*/ |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 891 | sizeof(bytesio), /*tp_basicsize*/ |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 892 | 0, /*tp_itemsize*/ |
| 893 | (destructor)bytesio_dealloc, /*tp_dealloc*/ |
| 894 | 0, /*tp_print*/ |
| 895 | 0, /*tp_getattr*/ |
| 896 | 0, /*tp_setattr*/ |
Mark Dickinson | e94c679 | 2009-02-02 20:36:42 +0000 | [diff] [blame] | 897 | 0, /*tp_reserved*/ |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 898 | 0, /*tp_repr*/ |
| 899 | 0, /*tp_as_number*/ |
| 900 | 0, /*tp_as_sequence*/ |
| 901 | 0, /*tp_as_mapping*/ |
| 902 | 0, /*tp_hash*/ |
| 903 | 0, /*tp_call*/ |
| 904 | 0, /*tp_str*/ |
| 905 | 0, /*tp_getattro*/ |
| 906 | 0, /*tp_setattro*/ |
| 907 | 0, /*tp_as_buffer*/ |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 908 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | |
| 909 | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 910 | bytesio_doc, /*tp_doc*/ |
Benjamin Peterson | 4fa88fa | 2009-03-04 00:14:51 +0000 | [diff] [blame] | 911 | (traverseproc)bytesio_traverse, /*tp_traverse*/ |
| 912 | (inquiry)bytesio_clear, /*tp_clear*/ |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 913 | 0, /*tp_richcompare*/ |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 914 | offsetof(bytesio, weakreflist), /*tp_weaklistoffset*/ |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 915 | PyObject_SelfIter, /*tp_iter*/ |
| 916 | (iternextfunc)bytesio_iternext, /*tp_iternext*/ |
| 917 | bytesio_methods, /*tp_methods*/ |
| 918 | 0, /*tp_members*/ |
| 919 | bytesio_getsetlist, /*tp_getset*/ |
| 920 | 0, /*tp_base*/ |
| 921 | 0, /*tp_dict*/ |
| 922 | 0, /*tp_descr_get*/ |
| 923 | 0, /*tp_descr_set*/ |
Benjamin Peterson | 680bf1a | 2009-06-12 02:07:12 +0000 | [diff] [blame] | 924 | offsetof(bytesio, dict), /*tp_dictoffset*/ |
Alexandre Vassalotti | 77250f4 | 2008-05-06 19:48:38 +0000 | [diff] [blame] | 925 | (initproc)bytesio_init, /*tp_init*/ |
| 926 | 0, /*tp_alloc*/ |
| 927 | bytesio_new, /*tp_new*/ |
| 928 | }; |
Antoine Pitrou | 972ee13 | 2010-09-06 18:48:21 +0000 | [diff] [blame] | 929 | |
| 930 | |
| 931 | /* |
| 932 | * Implementation of the small intermediate object used by getbuffer(). |
| 933 | * getbuffer() returns a memoryview over this object, which should make it |
| 934 | * invisible from Python code. |
| 935 | */ |
| 936 | |
| 937 | static int |
| 938 | bytesiobuf_getbuffer(bytesiobuf *obj, Py_buffer *view, int flags) |
| 939 | { |
| 940 | int ret; |
| 941 | void *ptr; |
| 942 | bytesio *b = (bytesio *) obj->source; |
| 943 | if (view == NULL) { |
| 944 | b->exports++; |
| 945 | return 0; |
| 946 | } |
| 947 | ptr = (void *) obj; |
| 948 | ret = PyBuffer_FillInfo(view, (PyObject*)obj, b->buf, b->string_size, |
| 949 | 0, flags); |
| 950 | if (ret >= 0) { |
| 951 | b->exports++; |
| 952 | } |
| 953 | return ret; |
| 954 | } |
| 955 | |
| 956 | static void |
| 957 | bytesiobuf_releasebuffer(bytesiobuf *obj, Py_buffer *view) |
| 958 | { |
| 959 | bytesio *b = (bytesio *) obj->source; |
| 960 | b->exports--; |
| 961 | } |
| 962 | |
| 963 | static int |
| 964 | bytesiobuf_traverse(bytesiobuf *self, visitproc visit, void *arg) |
| 965 | { |
| 966 | Py_VISIT(self->source); |
| 967 | return 0; |
| 968 | } |
| 969 | |
| 970 | static void |
| 971 | bytesiobuf_dealloc(bytesiobuf *self) |
| 972 | { |
| 973 | Py_CLEAR(self->source); |
| 974 | Py_TYPE(self)->tp_free(self); |
| 975 | } |
| 976 | |
| 977 | static PyBufferProcs bytesiobuf_as_buffer = { |
| 978 | (getbufferproc) bytesiobuf_getbuffer, |
| 979 | (releasebufferproc) bytesiobuf_releasebuffer, |
| 980 | }; |
| 981 | |
| 982 | PyTypeObject _PyBytesIOBuffer_Type = { |
| 983 | PyVarObject_HEAD_INIT(NULL, 0) |
| 984 | "_io._BytesIOBuffer", /*tp_name*/ |
| 985 | sizeof(bytesiobuf), /*tp_basicsize*/ |
| 986 | 0, /*tp_itemsize*/ |
| 987 | (destructor)bytesiobuf_dealloc, /*tp_dealloc*/ |
| 988 | 0, /*tp_print*/ |
| 989 | 0, /*tp_getattr*/ |
| 990 | 0, /*tp_setattr*/ |
| 991 | 0, /*tp_reserved*/ |
| 992 | 0, /*tp_repr*/ |
| 993 | 0, /*tp_as_number*/ |
| 994 | 0, /*tp_as_sequence*/ |
| 995 | 0, /*tp_as_mapping*/ |
| 996 | 0, /*tp_hash*/ |
| 997 | 0, /*tp_call*/ |
| 998 | 0, /*tp_str*/ |
| 999 | 0, /*tp_getattro*/ |
| 1000 | 0, /*tp_setattro*/ |
| 1001 | &bytesiobuf_as_buffer, /*tp_as_buffer*/ |
| 1002 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ |
| 1003 | 0, /*tp_doc*/ |
| 1004 | (traverseproc)bytesiobuf_traverse, /*tp_traverse*/ |
| 1005 | 0, /*tp_clear*/ |
| 1006 | 0, /*tp_richcompare*/ |
| 1007 | 0, /*tp_weaklistoffset*/ |
| 1008 | 0, /*tp_iter*/ |
| 1009 | 0, /*tp_iternext*/ |
| 1010 | 0, /*tp_methods*/ |
| 1011 | 0, /*tp_members*/ |
| 1012 | 0, /*tp_getset*/ |
| 1013 | 0, /*tp_base*/ |
| 1014 | 0, /*tp_dict*/ |
| 1015 | 0, /*tp_descr_get*/ |
| 1016 | 0, /*tp_descr_set*/ |
| 1017 | 0, /*tp_dictoffset*/ |
| 1018 | 0, /*tp_init*/ |
| 1019 | 0, /*tp_alloc*/ |
| 1020 | 0, /*tp_new*/ |
| 1021 | }; |