blob: 23ba3df866b12e026b073b64845a234e373b0ed6 [file] [log] [blame]
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001/*
2 An implementation of Buffered I/O as defined by PEP 3116 - "New I/O"
Antoine Pitrou3486a982011-05-12 01:57:53 +02003
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00004 Classes defined here: BufferedIOBase, BufferedReader, BufferedWriter,
5 BufferedRandom.
Antoine Pitrou3486a982011-05-12 01:57:53 +02006
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00007 Written by Amaury Forgeot d'Arc and Antoine Pitrou
8*/
9
10#define PY_SSIZE_T_CLEAN
11#include "Python.h"
12#include "structmember.h"
13#include "pythread.h"
14#include "_iomodule.h"
15
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030016/*[clinic input]
17module _io
18class _io._BufferedIOBase "PyObject *" "&PyBufferedIOBase_Type"
19class _io._Buffered "buffered *" "&PyBufferedIOBase_Type"
20class _io.BufferedReader "buffered *" "&PyBufferedReader_Type"
21class _io.BufferedWriter "buffered *" "&PyBufferedWriter_Type"
22class _io.BufferedRWPair "rwpair *" "&PyBufferedRWPair_Type"
23class _io.BufferedRandom "buffered *" "&PyBufferedRandom_Type"
24[clinic start generated code]*/
25/*[clinic end generated code: output=da39a3ee5e6b4b0d input=59460b9c5639984d]*/
26
27/*[python input]
28class io_ssize_t_converter(CConverter):
29 type = 'Py_ssize_t'
30 converter = '_PyIO_ConvertSsize_t'
31[python start generated code]*/
32/*[python end generated code: output=da39a3ee5e6b4b0d input=d0a811d3cbfd1b33]*/
33
Martin v. Löwisbd928fe2011-10-14 10:20:37 +020034_Py_IDENTIFIER(close);
35_Py_IDENTIFIER(_dealloc_warn);
36_Py_IDENTIFIER(flush);
37_Py_IDENTIFIER(isatty);
Martin v. Löwis767046a2011-10-14 15:35:36 +020038_Py_IDENTIFIER(mode);
39_Py_IDENTIFIER(name);
Martin v. Löwisbd928fe2011-10-14 10:20:37 +020040_Py_IDENTIFIER(peek);
41_Py_IDENTIFIER(read);
42_Py_IDENTIFIER(read1);
43_Py_IDENTIFIER(readable);
44_Py_IDENTIFIER(readinto);
Benjamin Petersona96fea02014-06-22 14:17:44 -070045_Py_IDENTIFIER(readinto1);
Martin v. Löwisbd928fe2011-10-14 10:20:37 +020046_Py_IDENTIFIER(writable);
47_Py_IDENTIFIER(write);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +020048
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000049/*
50 * BufferedIOBase class, inherits from IOBase.
51 */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +000052PyDoc_STRVAR(bufferediobase_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000053 "Base class for buffered IO objects.\n"
54 "\n"
55 "The main difference with RawIOBase is that the read() method\n"
56 "supports omitting the size argument, and does not have a default\n"
57 "implementation that defers to readinto().\n"
58 "\n"
59 "In addition, read(), readinto() and write() may raise\n"
60 "BlockingIOError if the underlying raw stream is in non-blocking\n"
61 "mode and not ready; unlike their raw counterparts, they will never\n"
62 "return None.\n"
63 "\n"
64 "A typical implementation should not inherit from a RawIOBase\n"
65 "implementation, but wrap one.\n"
66 );
67
68static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030069_bufferediobase_readinto_generic(PyObject *self, Py_buffer *buffer, char readinto1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000070{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000071 Py_ssize_t len;
72 PyObject *data;
73
Benjamin Petersona96fea02014-06-22 14:17:44 -070074 data = _PyObject_CallMethodId(self,
75 readinto1 ? &PyId_read1 : &PyId_read,
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030076 "n", buffer->len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000077 if (data == NULL)
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030078 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000079
80 if (!PyBytes_Check(data)) {
81 Py_DECREF(data);
82 PyErr_SetString(PyExc_TypeError, "read() should return bytes");
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030083 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000084 }
85
86 len = Py_SIZE(data);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030087 if (len > buffer->len) {
Serhiy Storchaka37a79a12013-05-28 16:24:45 +030088 PyErr_Format(PyExc_ValueError,
89 "read() returned too much data: "
90 "%zd bytes requested, %zd returned",
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030091 buffer->len, len);
Serhiy Storchaka37a79a12013-05-28 16:24:45 +030092 Py_DECREF(data);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030093 return NULL;
Serhiy Storchaka37a79a12013-05-28 16:24:45 +030094 }
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030095 memcpy(buffer->buf, PyBytes_AS_STRING(data), len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000096
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000097 Py_DECREF(data);
98
99 return PyLong_FromSsize_t(len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000100}
101
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300102/*[clinic input]
103_io._BufferedIOBase.readinto
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700104 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300105 /
106[clinic start generated code]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -0700107
108static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300109_io__BufferedIOBase_readinto_impl(PyObject *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700110/*[clinic end generated code: output=8c8cda6684af8038 input=00a6b9a38f29830a]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -0700111{
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300112 return _bufferediobase_readinto_generic(self, buffer, 0);
113}
114
115/*[clinic input]
116_io._BufferedIOBase.readinto1
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700117 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300118 /
119[clinic start generated code]*/
120
121static PyObject *
122_io__BufferedIOBase_readinto1_impl(PyObject *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700123/*[clinic end generated code: output=358623e4fd2b69d3 input=ebad75b4aadfb9be]*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300124{
125 return _bufferediobase_readinto_generic(self, buffer, 1);
Benjamin Petersona96fea02014-06-22 14:17:44 -0700126}
127
128static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000129bufferediobase_unsupported(const char *message)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000130{
Antoine Pitrou712cb732013-12-21 15:51:54 +0100131 _PyIO_State *state = IO_STATE();
132 if (state != NULL)
133 PyErr_SetString(state->unsupported_operation, message);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000134 return NULL;
135}
136
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300137/*[clinic input]
138_io._BufferedIOBase.detach
139
140Disconnect this buffer from its underlying raw stream and return it.
141
142After the raw stream has been detached, the buffer is in an unusable
143state.
144[clinic start generated code]*/
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000145
146static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300147_io__BufferedIOBase_detach_impl(PyObject *self)
148/*[clinic end generated code: output=754977c8d10ed88c input=822427fb58fe4169]*/
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000149{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000150 return bufferediobase_unsupported("detach");
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000151}
152
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000153PyDoc_STRVAR(bufferediobase_read_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000154 "Read and return up to n bytes.\n"
155 "\n"
156 "If the argument is omitted, None, or negative, reads and\n"
157 "returns all data until EOF.\n"
158 "\n"
159 "If the argument is positive, and the underlying raw stream is\n"
160 "not 'interactive', multiple raw reads may be issued to satisfy\n"
161 "the byte count (unless EOF is reached first). But for\n"
162 "interactive raw streams (as well as sockets and pipes), at most\n"
163 "one raw read will be issued, and a short result does not imply\n"
164 "that EOF is imminent.\n"
165 "\n"
166 "Returns an empty bytes object on EOF.\n"
167 "\n"
168 "Returns None if the underlying raw stream was open in non-blocking\n"
169 "mode and no data is available at the moment.\n");
170
171static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000172bufferediobase_read(PyObject *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000173{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000174 return bufferediobase_unsupported("read");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000175}
176
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000177PyDoc_STRVAR(bufferediobase_read1_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000178 "Read and return up to n bytes, with at most one read() call\n"
179 "to the underlying raw stream. A short result does not imply\n"
180 "that EOF is imminent.\n"
181 "\n"
182 "Returns an empty bytes object on EOF.\n");
183
184static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000185bufferediobase_read1(PyObject *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000186{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000187 return bufferediobase_unsupported("read1");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000188}
189
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000190PyDoc_STRVAR(bufferediobase_write_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000191 "Write the given buffer to the IO stream.\n"
192 "\n"
193 "Returns the number of bytes written, which is never less than\n"
194 "len(b).\n"
195 "\n"
196 "Raises BlockingIOError if the buffer is full and the\n"
197 "underlying raw stream cannot accept more data at the moment.\n");
198
199static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000200bufferediobase_write(PyObject *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000201{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000202 return bufferediobase_unsupported("write");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000203}
204
205
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000206typedef struct {
207 PyObject_HEAD
208
209 PyObject *raw;
210 int ok; /* Initialized? */
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000211 int detached;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000212 int readable;
213 int writable;
Antoine Pitrou796564c2013-07-30 19:59:21 +0200214 char finalizing;
Antoine Pitrou3486a982011-05-12 01:57:53 +0200215
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000216 /* True if this is a vanilla Buffered object (rather than a user derived
217 class) *and* the raw stream is a vanilla FileIO object. */
218 int fast_closed_checks;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000219
220 /* Absolute position inside the raw stream (-1 if unknown). */
221 Py_off_t abs_pos;
222
223 /* A static buffer of size `buffer_size` */
224 char *buffer;
225 /* Current logical position in the buffer. */
226 Py_off_t pos;
227 /* Position of the raw stream in the buffer. */
228 Py_off_t raw_pos;
229
230 /* Just after the last buffered byte in the buffer, or -1 if the buffer
231 isn't ready for reading. */
232 Py_off_t read_end;
233
234 /* Just after the last byte actually written */
235 Py_off_t write_pos;
236 /* Just after the last byte waiting to be written, or -1 if the buffer
237 isn't ready for writing. */
238 Py_off_t write_end;
239
Georg Brandldfd73442009-04-05 11:47:34 +0000240#ifdef WITH_THREAD
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000241 PyThread_type_lock lock;
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000242 volatile long owner;
Georg Brandldfd73442009-04-05 11:47:34 +0000243#endif
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000244
245 Py_ssize_t buffer_size;
246 Py_ssize_t buffer_mask;
247
248 PyObject *dict;
249 PyObject *weakreflist;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000250} buffered;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000251
252/*
253 Implementation notes:
Antoine Pitrou3486a982011-05-12 01:57:53 +0200254
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000255 * BufferedReader, BufferedWriter and BufferedRandom try to share most
256 methods (this is helped by the members `readable` and `writable`, which
257 are initialized in the respective constructors)
258 * They also share a single buffer for reading and writing. This enables
259 interleaved reads and writes without flushing. It also makes the logic
260 a bit trickier to get right.
261 * The absolute position of the raw stream is cached, if possible, in the
262 `abs_pos` member. It must be updated every time an operation is done
263 on the raw stream. If not sure, it can be reinitialized by calling
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000264 _buffered_raw_tell(), which queries the raw stream (_buffered_raw_seek()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000265 also does it). To read it, use RAW_TELL().
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000266 * Three helpers, _bufferedreader_raw_read, _bufferedwriter_raw_write and
267 _bufferedwriter_flush_unlocked do a lot of useful housekeeping.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000268
269 NOTE: we should try to maintain block alignment of reads and writes to the
270 raw stream (according to the buffer size), but for now it is only done
271 in read() and friends.
Antoine Pitrou3486a982011-05-12 01:57:53 +0200272
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000273*/
274
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000275/* These macros protect the buffered object against concurrent operations. */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000276
Georg Brandldfd73442009-04-05 11:47:34 +0000277#ifdef WITH_THREAD
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000278
279static int
280_enter_buffered_busy(buffered *self)
281{
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200282 int relax_locking;
283 PyLockStatus st;
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000284 if (self->owner == PyThread_get_thread_ident()) {
285 PyErr_Format(PyExc_RuntimeError,
286 "reentrant call inside %R", self);
287 return 0;
Antoine Pitrou5800b272009-11-01 12:05:48 +0000288 }
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200289 relax_locking = (_Py_Finalizing != NULL);
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000290 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200291 if (!relax_locking)
292 st = PyThread_acquire_lock(self->lock, 1);
293 else {
294 /* When finalizing, we don't want a deadlock to happen with daemon
295 * threads abruptly shut down while they owned the lock.
296 * Therefore, only wait for a grace period (1 s.).
297 * Note that non-daemon threads have already exited here, so this
298 * shouldn't affect carefully written threaded I/O code.
299 */
300 st = PyThread_acquire_lock_timed(self->lock, 1e6, 0);
301 }
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000302 Py_END_ALLOW_THREADS
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200303 if (relax_locking && st != PY_LOCK_ACQUIRED) {
304 PyObject *msgobj = PyUnicode_FromFormat(
305 "could not acquire lock for %A at interpreter "
306 "shutdown, possibly due to daemon threads",
307 (PyObject *) self);
308 char *msg = PyUnicode_AsUTF8(msgobj);
309 Py_FatalError(msg);
310 }
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000311 return 1;
312}
313
314#define ENTER_BUFFERED(self) \
315 ( (PyThread_acquire_lock(self->lock, 0) ? \
316 1 : _enter_buffered_busy(self)) \
317 && (self->owner = PyThread_get_thread_ident(), 1) )
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000318
319#define LEAVE_BUFFERED(self) \
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000320 do { \
321 self->owner = 0; \
322 PyThread_release_lock(self->lock); \
323 } while(0);
324
Georg Brandldfd73442009-04-05 11:47:34 +0000325#else
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000326#define ENTER_BUFFERED(self) 1
Georg Brandldfd73442009-04-05 11:47:34 +0000327#define LEAVE_BUFFERED(self)
328#endif
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000329
330#define CHECK_INITIALIZED(self) \
331 if (self->ok <= 0) { \
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000332 if (self->detached) { \
333 PyErr_SetString(PyExc_ValueError, \
334 "raw stream has been detached"); \
335 } else { \
336 PyErr_SetString(PyExc_ValueError, \
337 "I/O operation on uninitialized object"); \
338 } \
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000339 return NULL; \
340 }
341
342#define CHECK_INITIALIZED_INT(self) \
343 if (self->ok <= 0) { \
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000344 if (self->detached) { \
345 PyErr_SetString(PyExc_ValueError, \
346 "raw stream has been detached"); \
347 } else { \
348 PyErr_SetString(PyExc_ValueError, \
349 "I/O operation on uninitialized object"); \
350 } \
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000351 return -1; \
352 }
353
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000354#define IS_CLOSED(self) \
355 (self->fast_closed_checks \
356 ? _PyFileIO_closed(self->raw) \
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000357 : buffered_closed(self))
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000358
359#define CHECK_CLOSED(self, error_msg) \
360 if (IS_CLOSED(self)) { \
361 PyErr_SetString(PyExc_ValueError, error_msg); \
362 return NULL; \
363 }
364
365
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000366#define VALID_READ_BUFFER(self) \
367 (self->readable && self->read_end != -1)
368
369#define VALID_WRITE_BUFFER(self) \
370 (self->writable && self->write_end != -1)
371
372#define ADJUST_POSITION(self, _new_pos) \
373 do { \
374 self->pos = _new_pos; \
375 if (VALID_READ_BUFFER(self) && self->read_end < self->pos) \
376 self->read_end = self->pos; \
377 } while(0)
378
379#define READAHEAD(self) \
380 ((self->readable && VALID_READ_BUFFER(self)) \
381 ? (self->read_end - self->pos) : 0)
382
383#define RAW_OFFSET(self) \
384 (((VALID_READ_BUFFER(self) || VALID_WRITE_BUFFER(self)) \
385 && self->raw_pos >= 0) ? self->raw_pos - self->pos : 0)
386
387#define RAW_TELL(self) \
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000388 (self->abs_pos != -1 ? self->abs_pos : _buffered_raw_tell(self))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000389
390#define MINUS_LAST_BLOCK(self, size) \
391 (self->buffer_mask ? \
392 (size & ~self->buffer_mask) : \
393 (self->buffer_size * (size / self->buffer_size)))
394
395
396static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000397buffered_dealloc(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000398{
Antoine Pitrou796564c2013-07-30 19:59:21 +0200399 self->finalizing = 1;
400 if (_PyIOBase_finalize((PyObject *) self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000401 return;
402 _PyObject_GC_UNTRACK(self);
403 self->ok = 0;
404 if (self->weakreflist != NULL)
405 PyObject_ClearWeakRefs((PyObject *)self);
406 Py_CLEAR(self->raw);
407 if (self->buffer) {
408 PyMem_Free(self->buffer);
409 self->buffer = NULL;
410 }
Georg Brandldfd73442009-04-05 11:47:34 +0000411#ifdef WITH_THREAD
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000412 if (self->lock) {
413 PyThread_free_lock(self->lock);
414 self->lock = NULL;
415 }
Georg Brandldfd73442009-04-05 11:47:34 +0000416#endif
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000417 Py_CLEAR(self->dict);
418 Py_TYPE(self)->tp_free((PyObject *)self);
419}
420
Antoine Pitrou10f0c502012-07-29 19:02:46 +0200421static PyObject *
422buffered_sizeof(buffered *self, void *unused)
423{
424 Py_ssize_t res;
425
426 res = sizeof(buffered);
427 if (self->buffer)
428 res += self->buffer_size;
429 return PyLong_FromSsize_t(res);
430}
431
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000432static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000433buffered_traverse(buffered *self, visitproc visit, void *arg)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000434{
435 Py_VISIT(self->raw);
436 Py_VISIT(self->dict);
437 return 0;
438}
439
440static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000441buffered_clear(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000442{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000443 self->ok = 0;
444 Py_CLEAR(self->raw);
445 Py_CLEAR(self->dict);
446 return 0;
447}
448
Antoine Pitroue033e062010-10-29 10:38:18 +0000449/* Because this can call arbitrary code, it shouldn't be called when
450 the refcount is 0 (that is, not directly from tp_dealloc unless
451 the refcount has been temporarily re-incremented). */
Matthias Klosebee33162010-11-16 20:07:51 +0000452static PyObject *
Antoine Pitroue033e062010-10-29 10:38:18 +0000453buffered_dealloc_warn(buffered *self, PyObject *source)
454{
455 if (self->ok && self->raw) {
456 PyObject *r;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200457 r = _PyObject_CallMethodId(self->raw, &PyId__dealloc_warn, "O", source);
Antoine Pitroue033e062010-10-29 10:38:18 +0000458 if (r)
459 Py_DECREF(r);
460 else
461 PyErr_Clear();
462 }
463 Py_RETURN_NONE;
464}
465
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000466/*
467 * _BufferedIOMixin methods
468 * This is not a class, just a collection of methods that will be reused
469 * by BufferedReader and BufferedWriter
470 */
471
472/* Flush and close */
473
474static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000475buffered_simple_flush(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000476{
477 CHECK_INITIALIZED(self)
478 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_flush, NULL);
479}
480
481static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000482buffered_closed(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000483{
484 int closed;
485 PyObject *res;
486 CHECK_INITIALIZED_INT(self)
487 res = PyObject_GetAttr(self->raw, _PyIO_str_closed);
488 if (res == NULL)
489 return -1;
490 closed = PyObject_IsTrue(res);
491 Py_DECREF(res);
492 return closed;
493}
494
495static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000496buffered_closed_get(buffered *self, void *context)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000497{
498 CHECK_INITIALIZED(self)
499 return PyObject_GetAttr(self->raw, _PyIO_str_closed);
500}
501
502static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000503buffered_close(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000504{
Benjamin Peterson68623612012-12-20 11:53:11 -0600505 PyObject *res = NULL, *exc = NULL, *val, *tb;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000506 int r;
507
508 CHECK_INITIALIZED(self)
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000509 if (!ENTER_BUFFERED(self))
510 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000511
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000512 r = buffered_closed(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000513 if (r < 0)
514 goto end;
515 if (r > 0) {
516 res = Py_None;
517 Py_INCREF(res);
518 goto end;
519 }
Antoine Pitroue033e062010-10-29 10:38:18 +0000520
Antoine Pitrou796564c2013-07-30 19:59:21 +0200521 if (self->finalizing) {
Antoine Pitroue033e062010-10-29 10:38:18 +0000522 PyObject *r = buffered_dealloc_warn(self, (PyObject *) self);
523 if (r)
524 Py_DECREF(r);
525 else
526 PyErr_Clear();
527 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000528 /* flush() will most probably re-take the lock, so drop it first */
529 LEAVE_BUFFERED(self)
530 res = PyObject_CallMethodObjArgs((PyObject *)self, _PyIO_str_flush, NULL);
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000531 if (!ENTER_BUFFERED(self))
532 return NULL;
Benjamin Peterson68623612012-12-20 11:53:11 -0600533 if (res == NULL)
534 PyErr_Fetch(&exc, &val, &tb);
535 else
536 Py_DECREF(res);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000537
538 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_close, NULL);
539
Jesus Ceadc469452012-10-04 12:37:56 +0200540 if (self->buffer) {
541 PyMem_Free(self->buffer);
542 self->buffer = NULL;
543 }
544
Benjamin Peterson68623612012-12-20 11:53:11 -0600545 if (exc != NULL) {
Serhiy Storchakae2bd2a72014-10-08 22:31:52 +0300546 _PyErr_ChainExceptions(exc, val, tb);
547 Py_CLEAR(res);
Benjamin Peterson68623612012-12-20 11:53:11 -0600548 }
549
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000550end:
551 LEAVE_BUFFERED(self)
552 return res;
553}
554
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000555/* detach */
556
557static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000558buffered_detach(buffered *self, PyObject *args)
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000559{
560 PyObject *raw, *res;
561 CHECK_INITIALIZED(self)
562 res = PyObject_CallMethodObjArgs((PyObject *)self, _PyIO_str_flush, NULL);
563 if (res == NULL)
564 return NULL;
565 Py_DECREF(res);
566 raw = self->raw;
567 self->raw = NULL;
568 self->detached = 1;
569 self->ok = 0;
570 return raw;
571}
572
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000573/* Inquiries */
574
575static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000576buffered_seekable(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000577{
578 CHECK_INITIALIZED(self)
579 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_seekable, NULL);
580}
581
582static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000583buffered_readable(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000584{
585 CHECK_INITIALIZED(self)
586 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_readable, NULL);
587}
588
589static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000590buffered_writable(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000591{
592 CHECK_INITIALIZED(self)
593 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_writable, NULL);
594}
595
596static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000597buffered_name_get(buffered *self, void *context)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000598{
599 CHECK_INITIALIZED(self)
Martin v. Löwis767046a2011-10-14 15:35:36 +0200600 return _PyObject_GetAttrId(self->raw, &PyId_name);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000601}
602
603static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000604buffered_mode_get(buffered *self, void *context)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000605{
606 CHECK_INITIALIZED(self)
Martin v. Löwis767046a2011-10-14 15:35:36 +0200607 return _PyObject_GetAttrId(self->raw, &PyId_mode);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000608}
609
610/* Lower-level APIs */
611
612static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000613buffered_fileno(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000614{
615 CHECK_INITIALIZED(self)
616 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_fileno, NULL);
617}
618
619static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000620buffered_isatty(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000621{
622 CHECK_INITIALIZED(self)
623 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_isatty, NULL);
624}
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000625
Antoine Pitrou243757e2010-11-05 21:15:39 +0000626/* Serialization */
627
628static PyObject *
629buffered_getstate(buffered *self, PyObject *args)
630{
631 PyErr_Format(PyExc_TypeError,
632 "cannot serialize '%s' object", Py_TYPE(self)->tp_name);
633 return NULL;
634}
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000635
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000636/* Forward decls */
637static PyObject *
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100638_bufferedwriter_flush_unlocked(buffered *);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000639static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000640_bufferedreader_fill_buffer(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000641static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000642_bufferedreader_reset_buf(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000643static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000644_bufferedwriter_reset_buf(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000645static PyObject *
Victor Stinnerbc93a112011-06-01 00:01:24 +0200646_bufferedreader_peek_unlocked(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000647static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000648_bufferedreader_read_all(buffered *self);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000649static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000650_bufferedreader_read_fast(buffered *self, Py_ssize_t);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000651static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000652_bufferedreader_read_generic(buffered *self, Py_ssize_t);
Antoine Pitrou3486a982011-05-12 01:57:53 +0200653static Py_ssize_t
654_bufferedreader_raw_read(buffered *self, char *start, Py_ssize_t len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000655
656/*
657 * Helpers
658 */
659
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100660/* Sets the current error to BlockingIOError */
661static void
662_set_BlockingIOError(char *msg, Py_ssize_t written)
663{
664 PyObject *err;
Victor Stinnerace47d72013-07-18 01:41:08 +0200665 PyErr_Clear();
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100666 err = PyObject_CallFunction(PyExc_BlockingIOError, "isn",
667 errno, msg, written);
668 if (err)
669 PyErr_SetObject(PyExc_BlockingIOError, err);
670 Py_XDECREF(err);
671}
672
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000673/* Returns the address of the `written` member if a BlockingIOError was
674 raised, NULL otherwise. The error is always re-raised. */
675static Py_ssize_t *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000676_buffered_check_blocking_error(void)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000677{
678 PyObject *t, *v, *tb;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200679 PyOSErrorObject *err;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000680
681 PyErr_Fetch(&t, &v, &tb);
682 if (v == NULL || !PyErr_GivenExceptionMatches(v, PyExc_BlockingIOError)) {
683 PyErr_Restore(t, v, tb);
684 return NULL;
685 }
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200686 err = (PyOSErrorObject *) v;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000687 /* TODO: sanity check (err->written >= 0) */
688 PyErr_Restore(t, v, tb);
689 return &err->written;
690}
691
692static Py_off_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000693_buffered_raw_tell(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000694{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000695 Py_off_t n;
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000696 PyObject *res;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000697 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_tell, NULL);
698 if (res == NULL)
699 return -1;
700 n = PyNumber_AsOff_t(res, PyExc_ValueError);
701 Py_DECREF(res);
702 if (n < 0) {
703 if (!PyErr_Occurred())
704 PyErr_Format(PyExc_IOError,
Mark Dickinson1a0aaaa2009-11-24 20:54:11 +0000705 "Raw stream returned invalid position %" PY_PRIdOFF,
Antoine Pitrou3486a982011-05-12 01:57:53 +0200706 (PY_OFF_T_COMPAT)n);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000707 return -1;
708 }
709 self->abs_pos = n;
710 return n;
711}
712
713static Py_off_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000714_buffered_raw_seek(buffered *self, Py_off_t target, int whence)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000715{
716 PyObject *res, *posobj, *whenceobj;
717 Py_off_t n;
718
719 posobj = PyLong_FromOff_t(target);
720 if (posobj == NULL)
721 return -1;
722 whenceobj = PyLong_FromLong(whence);
723 if (whenceobj == NULL) {
724 Py_DECREF(posobj);
725 return -1;
726 }
727 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_seek,
728 posobj, whenceobj, NULL);
729 Py_DECREF(posobj);
730 Py_DECREF(whenceobj);
731 if (res == NULL)
732 return -1;
733 n = PyNumber_AsOff_t(res, PyExc_ValueError);
734 Py_DECREF(res);
735 if (n < 0) {
736 if (!PyErr_Occurred())
737 PyErr_Format(PyExc_IOError,
Mark Dickinson1a0aaaa2009-11-24 20:54:11 +0000738 "Raw stream returned invalid position %" PY_PRIdOFF,
Antoine Pitrou3486a982011-05-12 01:57:53 +0200739 (PY_OFF_T_COMPAT)n);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000740 return -1;
741 }
742 self->abs_pos = n;
743 return n;
744}
745
746static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000747_buffered_init(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000748{
749 Py_ssize_t n;
750 if (self->buffer_size <= 0) {
751 PyErr_SetString(PyExc_ValueError,
752 "buffer size must be strictly positive");
753 return -1;
754 }
755 if (self->buffer)
756 PyMem_Free(self->buffer);
757 self->buffer = PyMem_Malloc(self->buffer_size);
758 if (self->buffer == NULL) {
759 PyErr_NoMemory();
760 return -1;
761 }
Georg Brandldfd73442009-04-05 11:47:34 +0000762#ifdef WITH_THREAD
Antoine Pitrouc881f152010-08-01 16:53:42 +0000763 if (self->lock)
764 PyThread_free_lock(self->lock);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000765 self->lock = PyThread_allocate_lock();
766 if (self->lock == NULL) {
767 PyErr_SetString(PyExc_RuntimeError, "can't allocate read lock");
768 return -1;
769 }
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000770 self->owner = 0;
Georg Brandldfd73442009-04-05 11:47:34 +0000771#endif
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000772 /* Find out whether buffer_size is a power of 2 */
773 /* XXX is this optimization useful? */
774 for (n = self->buffer_size - 1; n & 1; n >>= 1)
775 ;
776 if (n == 0)
777 self->buffer_mask = self->buffer_size - 1;
778 else
779 self->buffer_mask = 0;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000780 if (_buffered_raw_tell(self) == -1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000781 PyErr_Clear();
782 return 0;
783}
784
Antoine Pitrou707ce822011-02-25 21:24:11 +0000785/* Return 1 if an EnvironmentError with errno == EINTR is set (and then
786 clears the error indicator), 0 otherwise.
787 Should only be called when PyErr_Occurred() is true.
788*/
Gregory P. Smith51359922012-06-23 23:55:39 -0700789int
790_PyIO_trap_eintr(void)
Antoine Pitrou707ce822011-02-25 21:24:11 +0000791{
792 static PyObject *eintr_int = NULL;
793 PyObject *typ, *val, *tb;
794 PyEnvironmentErrorObject *env_err;
795
796 if (eintr_int == NULL) {
797 eintr_int = PyLong_FromLong(EINTR);
798 assert(eintr_int != NULL);
799 }
800 if (!PyErr_ExceptionMatches(PyExc_EnvironmentError))
801 return 0;
802 PyErr_Fetch(&typ, &val, &tb);
803 PyErr_NormalizeException(&typ, &val, &tb);
804 env_err = (PyEnvironmentErrorObject *) val;
805 assert(env_err != NULL);
806 if (env_err->myerrno != NULL &&
807 PyObject_RichCompareBool(env_err->myerrno, eintr_int, Py_EQ) > 0) {
808 Py_DECREF(typ);
809 Py_DECREF(val);
810 Py_XDECREF(tb);
811 return 1;
812 }
813 /* This silences any error set by PyObject_RichCompareBool() */
814 PyErr_Restore(typ, val, tb);
815 return 0;
816}
817
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000818/*
819 * Shared methods and wrappers
820 */
821
822static PyObject *
Antoine Pitroue05565e2011-08-20 14:39:23 +0200823buffered_flush_and_rewind_unlocked(buffered *self)
824{
825 PyObject *res;
826
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100827 res = _bufferedwriter_flush_unlocked(self);
Antoine Pitroue05565e2011-08-20 14:39:23 +0200828 if (res == NULL)
829 return NULL;
830 Py_DECREF(res);
831
832 if (self->readable) {
833 /* Rewind the raw stream so that its position corresponds to
834 the current logical position. */
835 Py_off_t n;
836 n = _buffered_raw_seek(self, -RAW_OFFSET(self), 1);
837 _bufferedreader_reset_buf(self);
838 if (n == -1)
839 return NULL;
840 }
841 Py_RETURN_NONE;
842}
843
844static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000845buffered_flush(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000846{
847 PyObject *res;
848
849 CHECK_INITIALIZED(self)
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000850 CHECK_CLOSED(self, "flush of closed file")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000851
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000852 if (!ENTER_BUFFERED(self))
853 return NULL;
Antoine Pitroue05565e2011-08-20 14:39:23 +0200854 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000855 LEAVE_BUFFERED(self)
856
857 return res;
858}
859
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300860/*[clinic input]
861_io._Buffered.peek
862 size: Py_ssize_t = 0
863 /
864
865[clinic start generated code]*/
866
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000867static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300868_io__Buffered_peek_impl(buffered *self, Py_ssize_t size)
869/*[clinic end generated code: output=ba7a097ca230102b input=37ffb97d06ff4adb]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000870{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000871 PyObject *res = NULL;
872
873 CHECK_INITIALIZED(self)
Berker Peksagd10d6ae2015-05-12 17:01:05 +0300874 CHECK_CLOSED(self, "peek of closed file")
875
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000876 if (!ENTER_BUFFERED(self))
877 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000878
879 if (self->writable) {
Antoine Pitroue05565e2011-08-20 14:39:23 +0200880 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000881 if (res == NULL)
882 goto end;
883 Py_CLEAR(res);
884 }
Victor Stinnerbc93a112011-06-01 00:01:24 +0200885 res = _bufferedreader_peek_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000886
887end:
888 LEAVE_BUFFERED(self)
889 return res;
890}
891
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300892/*[clinic input]
893_io._Buffered.read
894 size as n: io_ssize_t = -1
895 /
896[clinic start generated code]*/
897
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000898static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300899_io__Buffered_read_impl(buffered *self, Py_ssize_t n)
900/*[clinic end generated code: output=f41c78bb15b9bbe9 input=c0939ec7f9e9354f]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000901{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000902 PyObject *res;
903
904 CHECK_INITIALIZED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000905 if (n < -1) {
906 PyErr_SetString(PyExc_ValueError,
907 "read length must be positive or -1");
908 return NULL;
909 }
910
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000911 CHECK_CLOSED(self, "read of closed file")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000912
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000913 if (n == -1) {
914 /* The number of bytes is unspecified, read until the end of stream */
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000915 if (!ENTER_BUFFERED(self))
916 return NULL;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000917 res = _bufferedreader_read_all(self);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000918 }
919 else {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000920 res = _bufferedreader_read_fast(self, n);
Antoine Pitroue05565e2011-08-20 14:39:23 +0200921 if (res != Py_None)
922 return res;
923 Py_DECREF(res);
924 if (!ENTER_BUFFERED(self))
925 return NULL;
926 res = _bufferedreader_read_generic(self, n);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000927 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000928
Antoine Pitroue05565e2011-08-20 14:39:23 +0200929 LEAVE_BUFFERED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000930 return res;
931}
932
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300933/*[clinic input]
934_io._Buffered.read1
935 size as n: Py_ssize_t
936 /
937[clinic start generated code]*/
938
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000939static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300940_io__Buffered_read1_impl(buffered *self, Py_ssize_t n)
941/*[clinic end generated code: output=bcc4fb4e54d103a3 input=8d2869c18b983184]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000942{
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300943 Py_ssize_t have, r;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000944 PyObject *res = NULL;
945
946 CHECK_INITIALIZED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000947 if (n < 0) {
948 PyErr_SetString(PyExc_ValueError,
949 "read length must be positive");
950 return NULL;
951 }
Berker Peksagd10d6ae2015-05-12 17:01:05 +0300952
953 CHECK_CLOSED(self, "read of closed file")
954
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000955 if (n == 0)
956 return PyBytes_FromStringAndSize(NULL, 0);
957
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000958 /* Return up to n bytes. If at least one byte is buffered, we
959 only return buffered bytes. Otherwise, we do one raw read. */
960
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000961 have = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
962 if (have > 0) {
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100963 n = Py_MIN(have, n);
964 res = _bufferedreader_read_fast(self, n);
965 assert(res != Py_None);
966 return res;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000967 }
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100968 res = PyBytes_FromStringAndSize(NULL, n);
969 if (res == NULL)
970 return NULL;
971 if (!ENTER_BUFFERED(self)) {
Antoine Pitroue05565e2011-08-20 14:39:23 +0200972 Py_DECREF(res);
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100973 return NULL;
Antoine Pitroue05565e2011-08-20 14:39:23 +0200974 }
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000975 _bufferedreader_reset_buf(self);
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100976 r = _bufferedreader_raw_read(self, PyBytes_AS_STRING(res), n);
977 LEAVE_BUFFERED(self)
978 if (r == -1) {
979 Py_DECREF(res);
980 return NULL;
981 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000982 if (r == -2)
983 r = 0;
984 if (n > r)
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100985 _PyBytes_Resize(&res, r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000986 return res;
987}
988
989static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300990_buffered_readinto_generic(buffered *self, Py_buffer *buffer, char readinto1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000991{
Antoine Pitrou3486a982011-05-12 01:57:53 +0200992 Py_ssize_t n, written = 0, remaining;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000993 PyObject *res = NULL;
994
995 CHECK_INITIALIZED(self)
Antoine Pitrou3486a982011-05-12 01:57:53 +0200996
Antoine Pitrou3486a982011-05-12 01:57:53 +0200997 n = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
998 if (n > 0) {
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300999 if (n >= buffer->len) {
1000 memcpy(buffer->buf, self->buffer + self->pos, buffer->len);
1001 self->pos += buffer->len;
1002 return PyLong_FromSsize_t(buffer->len);
Antoine Pitrou3486a982011-05-12 01:57:53 +02001003 }
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001004 memcpy(buffer->buf, self->buffer + self->pos, n);
Antoine Pitrou3486a982011-05-12 01:57:53 +02001005 self->pos += n;
1006 written = n;
1007 }
1008
1009 if (!ENTER_BUFFERED(self))
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001010 return NULL;
Antoine Pitrou3486a982011-05-12 01:57:53 +02001011
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001012 if (self->writable) {
Antoine Pitroue8bb1a02011-08-20 14:52:04 +02001013 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001014 if (res == NULL)
1015 goto end;
Antoine Pitrou3486a982011-05-12 01:57:53 +02001016 Py_CLEAR(res);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001017 }
Antoine Pitrou3486a982011-05-12 01:57:53 +02001018
1019 _bufferedreader_reset_buf(self);
1020 self->pos = 0;
1021
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001022 for (remaining = buffer->len - written;
Antoine Pitrou3486a982011-05-12 01:57:53 +02001023 remaining > 0;
1024 written += n, remaining -= n) {
1025 /* If remaining bytes is larger than internal buffer size, copy
1026 * directly into caller's buffer. */
1027 if (remaining > self->buffer_size) {
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001028 n = _bufferedreader_raw_read(self, (char *) buffer->buf + written,
Antoine Pitrou4e19e112011-05-12 02:07:00 +02001029 remaining);
Antoine Pitrou3486a982011-05-12 01:57:53 +02001030 }
Benjamin Petersona96fea02014-06-22 14:17:44 -07001031
1032 /* In readinto1 mode, we do not want to fill the internal
1033 buffer if we already have some data to return */
1034 else if (!(readinto1 && written)) {
Antoine Pitrou3486a982011-05-12 01:57:53 +02001035 n = _bufferedreader_fill_buffer(self);
1036 if (n > 0) {
1037 if (n > remaining)
1038 n = remaining;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001039 memcpy((char *) buffer->buf + written,
Antoine Pitrou4e19e112011-05-12 02:07:00 +02001040 self->buffer + self->pos, n);
Antoine Pitrou3486a982011-05-12 01:57:53 +02001041 self->pos += n;
1042 continue; /* short circuit */
1043 }
1044 }
Benjamin Petersona96fea02014-06-22 14:17:44 -07001045 else
1046 n = 0;
Serhiy Storchaka009b8112015-03-18 21:53:15 +02001047
Antoine Pitrou3486a982011-05-12 01:57:53 +02001048 if (n == 0 || (n == -2 && written > 0))
1049 break;
1050 if (n < 0) {
1051 if (n == -2) {
1052 Py_INCREF(Py_None);
1053 res = Py_None;
1054 }
1055 goto end;
1056 }
Serhiy Storchaka009b8112015-03-18 21:53:15 +02001057
Benjamin Petersona96fea02014-06-22 14:17:44 -07001058 /* At most one read in readinto1 mode */
1059 if (readinto1) {
1060 written += n;
1061 break;
1062 }
Antoine Pitrou3486a982011-05-12 01:57:53 +02001063 }
1064 res = PyLong_FromSsize_t(written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001065
1066end:
Antoine Pitrou3486a982011-05-12 01:57:53 +02001067 LEAVE_BUFFERED(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001068 return res;
1069}
1070
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001071/*[clinic input]
1072_io._Buffered.readinto
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001073 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001074 /
1075[clinic start generated code]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -07001076
1077static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001078_io__Buffered_readinto_impl(buffered *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001079/*[clinic end generated code: output=bcb376580b1d8170 input=ed6b98b7a20a3008]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -07001080{
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001081 return _buffered_readinto_generic(self, buffer, 0);
1082}
1083
1084/*[clinic input]
1085_io._Buffered.readinto1
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001086 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001087 /
1088[clinic start generated code]*/
1089
1090static PyObject *
1091_io__Buffered_readinto1_impl(buffered *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001092/*[clinic end generated code: output=6e5c6ac5868205d6 input=4455c5d55fdf1687]*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001093{
1094 return _buffered_readinto_generic(self, buffer, 1);
Benjamin Petersona96fea02014-06-22 14:17:44 -07001095}
1096
1097
1098static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001099_buffered_readline(buffered *self, Py_ssize_t limit)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001100{
1101 PyObject *res = NULL;
1102 PyObject *chunks = NULL;
1103 Py_ssize_t n, written = 0;
1104 const char *start, *s, *end;
1105
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001106 CHECK_CLOSED(self, "readline of closed file")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001107
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001108 /* First, try to find a line in the buffer. This can run unlocked because
1109 the calls to the C API are simple enough that they can't trigger
1110 any thread switch. */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001111 n = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1112 if (limit >= 0 && n > limit)
1113 n = limit;
1114 start = self->buffer + self->pos;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001115 s = memchr(start, '\n', n);
1116 if (s != NULL) {
1117 res = PyBytes_FromStringAndSize(start, s - start + 1);
1118 if (res != NULL)
1119 self->pos += s - start + 1;
1120 goto end_unlocked;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001121 }
1122 if (n == limit) {
1123 res = PyBytes_FromStringAndSize(start, n);
1124 if (res != NULL)
1125 self->pos += n;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001126 goto end_unlocked;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001127 }
1128
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001129 if (!ENTER_BUFFERED(self))
1130 goto end_unlocked;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001131
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001132 /* Now we try to get some more from the raw stream */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001133 chunks = PyList_New(0);
1134 if (chunks == NULL)
1135 goto end;
1136 if (n > 0) {
1137 res = PyBytes_FromStringAndSize(start, n);
1138 if (res == NULL)
1139 goto end;
1140 if (PyList_Append(chunks, res) < 0) {
1141 Py_CLEAR(res);
1142 goto end;
1143 }
1144 Py_CLEAR(res);
1145 written += n;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001146 self->pos += n;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001147 if (limit >= 0)
1148 limit -= n;
1149 }
Antoine Pitroue05565e2011-08-20 14:39:23 +02001150 if (self->writable) {
1151 PyObject *r = buffered_flush_and_rewind_unlocked(self);
1152 if (r == NULL)
1153 goto end;
1154 Py_DECREF(r);
1155 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001156
1157 for (;;) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001158 _bufferedreader_reset_buf(self);
1159 n = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001160 if (n == -1)
1161 goto end;
1162 if (n <= 0)
1163 break;
1164 if (limit >= 0 && n > limit)
1165 n = limit;
1166 start = self->buffer;
1167 end = start + n;
1168 s = start;
1169 while (s < end) {
1170 if (*s++ == '\n') {
1171 res = PyBytes_FromStringAndSize(start, s - start);
1172 if (res == NULL)
1173 goto end;
1174 self->pos = s - start;
1175 goto found;
1176 }
1177 }
1178 res = PyBytes_FromStringAndSize(start, n);
1179 if (res == NULL)
1180 goto end;
1181 if (n == limit) {
1182 self->pos = n;
1183 break;
1184 }
1185 if (PyList_Append(chunks, res) < 0) {
1186 Py_CLEAR(res);
1187 goto end;
1188 }
1189 Py_CLEAR(res);
1190 written += n;
1191 if (limit >= 0)
1192 limit -= n;
1193 }
1194found:
1195 if (res != NULL && PyList_Append(chunks, res) < 0) {
1196 Py_CLEAR(res);
1197 goto end;
1198 }
1199 Py_CLEAR(res);
1200 res = _PyBytes_Join(_PyIO_empty_bytes, chunks);
1201
1202end:
1203 LEAVE_BUFFERED(self)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001204end_unlocked:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001205 Py_XDECREF(chunks);
1206 return res;
1207}
1208
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001209/*[clinic input]
1210_io._Buffered.readline
1211 size: io_ssize_t = -1
1212 /
1213[clinic start generated code]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001214
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001215static PyObject *
1216_io__Buffered_readline_impl(buffered *self, Py_ssize_t size)
1217/*[clinic end generated code: output=24dd2aa6e33be83c input=ff1e0df821cb4e5c]*/
1218{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001219 CHECK_INITIALIZED(self)
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001220 return _buffered_readline(self, size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001221}
1222
1223
1224static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001225buffered_tell(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001226{
1227 Py_off_t pos;
1228
1229 CHECK_INITIALIZED(self)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001230 pos = _buffered_raw_tell(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001231 if (pos == -1)
1232 return NULL;
1233 pos -= RAW_OFFSET(self);
1234 /* TODO: sanity check (pos >= 0) */
1235 return PyLong_FromOff_t(pos);
1236}
1237
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001238/*[clinic input]
1239_io._Buffered.seek
1240 target as targetobj: object
1241 whence: int = 0
1242 /
1243[clinic start generated code]*/
1244
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001245static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001246_io__Buffered_seek_impl(buffered *self, PyObject *targetobj, int whence)
1247/*[clinic end generated code: output=7ae0e8dc46efdefb input=a9c4920bfcba6163]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001248{
1249 Py_off_t target, n;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001250 PyObject *res = NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001251
1252 CHECK_INITIALIZED(self)
Jesus Cea94363612012-06-22 18:32:07 +02001253
1254 /* Do some error checking instead of trusting OS 'seek()'
1255 ** error detection, just in case.
1256 */
1257 if ((whence < 0 || whence >2)
1258#ifdef SEEK_HOLE
1259 && (whence != SEEK_HOLE)
1260#endif
1261#ifdef SEEK_DATA
1262 && (whence != SEEK_DATA)
1263#endif
1264 ) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001265 PyErr_Format(PyExc_ValueError,
Jesus Cea94363612012-06-22 18:32:07 +02001266 "whence value %d unsupported", whence);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001267 return NULL;
1268 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001269
1270 CHECK_CLOSED(self, "seek of closed file")
1271
Antoine Pitrou1e44fec2011-10-04 12:26:20 +02001272 if (_PyIOBase_check_seekable(self->raw, Py_True) == NULL)
1273 return NULL;
1274
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001275 target = PyNumber_AsOff_t(targetobj, PyExc_ValueError);
1276 if (target == -1 && PyErr_Occurred())
1277 return NULL;
1278
Jesus Cea94363612012-06-22 18:32:07 +02001279 /* SEEK_SET and SEEK_CUR are special because we could seek inside the
1280 buffer. Other whence values must be managed without this optimization.
1281 Some Operating Systems can provide additional values, like
1282 SEEK_HOLE/SEEK_DATA. */
1283 if (((whence == 0) || (whence == 1)) && self->readable) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001284 Py_off_t current, avail;
1285 /* Check if seeking leaves us inside the current buffer,
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001286 so as to return quickly if possible. Also, we needn't take the
1287 lock in this fast path.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001288 Don't know how to do that when whence == 2, though. */
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001289 /* NOTE: RAW_TELL() can release the GIL but the object is in a stable
1290 state at this point. */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001291 current = RAW_TELL(self);
1292 avail = READAHEAD(self);
1293 if (avail > 0) {
1294 Py_off_t offset;
1295 if (whence == 0)
1296 offset = target - (current - RAW_OFFSET(self));
1297 else
1298 offset = target;
1299 if (offset >= -self->pos && offset <= avail) {
1300 self->pos += offset;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001301 return PyLong_FromOff_t(current - avail + offset);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001302 }
1303 }
1304 }
1305
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001306 if (!ENTER_BUFFERED(self))
1307 return NULL;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001308
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001309 /* Fallback: invoke raw seek() method and clear buffer */
1310 if (self->writable) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001311 res = _bufferedwriter_flush_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001312 if (res == NULL)
1313 goto end;
1314 Py_CLEAR(res);
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001315 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001316 }
1317
1318 /* TODO: align on block boundary and read buffer if needed? */
1319 if (whence == 1)
1320 target -= RAW_OFFSET(self);
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001321 n = _buffered_raw_seek(self, target, whence);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001322 if (n == -1)
1323 goto end;
1324 self->raw_pos = -1;
1325 res = PyLong_FromOff_t(n);
1326 if (res != NULL && self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001327 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001328
1329end:
1330 LEAVE_BUFFERED(self)
1331 return res;
1332}
1333
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001334/*[clinic input]
1335_io._Buffered.truncate
1336 pos: object = None
1337 /
1338[clinic start generated code]*/
1339
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001340static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001341_io__Buffered_truncate_impl(buffered *self, PyObject *pos)
1342/*[clinic end generated code: output=667ca03c60c270de input=8a1be34d57cca2d3]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001343{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001344 PyObject *res = NULL;
1345
1346 CHECK_INITIALIZED(self)
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001347 if (!ENTER_BUFFERED(self))
1348 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001349
1350 if (self->writable) {
Antoine Pitroue05565e2011-08-20 14:39:23 +02001351 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001352 if (res == NULL)
1353 goto end;
1354 Py_CLEAR(res);
1355 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001356 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_truncate, pos, NULL);
1357 if (res == NULL)
1358 goto end;
1359 /* Reset cached position */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001360 if (_buffered_raw_tell(self) == -1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001361 PyErr_Clear();
1362
1363end:
1364 LEAVE_BUFFERED(self)
1365 return res;
1366}
1367
1368static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001369buffered_iternext(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001370{
1371 PyObject *line;
1372 PyTypeObject *tp;
1373
1374 CHECK_INITIALIZED(self);
1375
1376 tp = Py_TYPE(self);
1377 if (tp == &PyBufferedReader_Type ||
1378 tp == &PyBufferedRandom_Type) {
1379 /* Skip method call overhead for speed */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001380 line = _buffered_readline(self, -1);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001381 }
1382 else {
1383 line = PyObject_CallMethodObjArgs((PyObject *)self,
1384 _PyIO_str_readline, NULL);
1385 if (line && !PyBytes_Check(line)) {
1386 PyErr_Format(PyExc_IOError,
1387 "readline() should have returned a bytes object, "
1388 "not '%.200s'", Py_TYPE(line)->tp_name);
1389 Py_DECREF(line);
1390 return NULL;
1391 }
1392 }
1393
1394 if (line == NULL)
1395 return NULL;
1396
1397 if (PyBytes_GET_SIZE(line) == 0) {
1398 /* Reached EOF or would have blocked */
1399 Py_DECREF(line);
1400 return NULL;
1401 }
1402
1403 return line;
1404}
1405
Antoine Pitrou716c4442009-05-23 19:04:03 +00001406static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001407buffered_repr(buffered *self)
Antoine Pitrou716c4442009-05-23 19:04:03 +00001408{
1409 PyObject *nameobj, *res;
1410
Martin v. Löwis767046a2011-10-14 15:35:36 +02001411 nameobj = _PyObject_GetAttrId((PyObject *) self, &PyId_name);
Antoine Pitrou716c4442009-05-23 19:04:03 +00001412 if (nameobj == NULL) {
Benjamin Peterson10e76b62014-12-21 20:51:50 -06001413 if (PyErr_ExceptionMatches(PyExc_Exception))
Antoine Pitrou716c4442009-05-23 19:04:03 +00001414 PyErr_Clear();
1415 else
1416 return NULL;
1417 res = PyUnicode_FromFormat("<%s>", Py_TYPE(self)->tp_name);
1418 }
1419 else {
1420 res = PyUnicode_FromFormat("<%s name=%R>",
1421 Py_TYPE(self)->tp_name, nameobj);
1422 Py_DECREF(nameobj);
1423 }
1424 return res;
1425}
1426
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001427/*
1428 * class BufferedReader
1429 */
1430
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001431static void _bufferedreader_reset_buf(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001432{
1433 self->read_end = -1;
1434}
1435
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001436/*[clinic input]
1437_io.BufferedReader.__init__
1438 raw: object
1439 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001440
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001441Create a new buffered reader using the given readable raw IO object.
1442[clinic start generated code]*/
1443
1444static int
1445_io_BufferedReader___init___impl(buffered *self, PyObject *raw,
1446 Py_ssize_t buffer_size)
1447/*[clinic end generated code: output=cddcfefa0ed294c4 input=fb887e06f11b4e48]*/
1448{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001449 self->ok = 0;
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001450 self->detached = 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001451
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001452 if (_PyIOBase_check_readable(raw, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001453 return -1;
1454
1455 Py_CLEAR(self->raw);
1456 Py_INCREF(raw);
1457 self->raw = raw;
1458 self->buffer_size = buffer_size;
1459 self->readable = 1;
1460 self->writable = 0;
1461
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001462 if (_buffered_init(self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001463 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001464 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001465
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001466 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedReader_Type &&
1467 Py_TYPE(raw) == &PyFileIO_Type);
1468
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001469 self->ok = 1;
1470 return 0;
1471}
1472
1473static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001474_bufferedreader_raw_read(buffered *self, char *start, Py_ssize_t len)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001475{
1476 Py_buffer buf;
1477 PyObject *memobj, *res;
1478 Py_ssize_t n;
1479 /* NOTE: the buffer needn't be released as its object is NULL. */
1480 if (PyBuffer_FillInfo(&buf, NULL, start, len, 0, PyBUF_CONTIG) == -1)
1481 return -1;
1482 memobj = PyMemoryView_FromBuffer(&buf);
1483 if (memobj == NULL)
1484 return -1;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001485 /* NOTE: PyErr_SetFromErrno() calls PyErr_CheckSignals() when EINTR
1486 occurs so we needn't do it ourselves.
1487 We then retry reading, ignoring the signal if no handler has
1488 raised (see issue #10956).
1489 */
1490 do {
1491 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_readinto, memobj, NULL);
Gregory P. Smith51359922012-06-23 23:55:39 -07001492 } while (res == NULL && _PyIO_trap_eintr());
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001493 Py_DECREF(memobj);
1494 if (res == NULL)
1495 return -1;
1496 if (res == Py_None) {
1497 /* Non-blocking stream would have blocked. Special return code! */
1498 Py_DECREF(res);
1499 return -2;
1500 }
1501 n = PyNumber_AsSsize_t(res, PyExc_ValueError);
1502 Py_DECREF(res);
1503 if (n < 0 || n > len) {
1504 PyErr_Format(PyExc_IOError,
1505 "raw readinto() returned invalid length %zd "
1506 "(should have been between 0 and %zd)", n, len);
1507 return -1;
1508 }
1509 if (n > 0 && self->abs_pos != -1)
1510 self->abs_pos += n;
1511 return n;
1512}
1513
1514static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001515_bufferedreader_fill_buffer(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001516{
1517 Py_ssize_t start, len, n;
1518 if (VALID_READ_BUFFER(self))
1519 start = Py_SAFE_DOWNCAST(self->read_end, Py_off_t, Py_ssize_t);
1520 else
1521 start = 0;
1522 len = self->buffer_size - start;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001523 n = _bufferedreader_raw_read(self, self->buffer + start, len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001524 if (n <= 0)
1525 return n;
1526 self->read_end = start + n;
1527 self->raw_pos = start + n;
1528 return n;
1529}
1530
1531static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001532_bufferedreader_read_all(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001533{
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001534 Py_ssize_t current_size;
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001535 PyObject *res = NULL, *data = NULL, *tmp = NULL, *chunks = NULL;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001536
1537 /* First copy what we have in the current buffer. */
1538 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1539 if (current_size) {
1540 data = PyBytes_FromStringAndSize(
1541 self->buffer + self->pos, current_size);
Victor Stinnerb57f1082011-05-26 00:19:38 +02001542 if (data == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001543 return NULL;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001544 self->pos += current_size;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001545 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001546 /* We're going past the buffer's bounds, flush it */
1547 if (self->writable) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001548 tmp = buffered_flush_and_rewind_unlocked(self);
1549 if (tmp == NULL)
1550 goto cleanup;
1551 Py_CLEAR(tmp);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001552 }
Antoine Pitroue05565e2011-08-20 14:39:23 +02001553 _bufferedreader_reset_buf(self);
Victor Stinnerb57f1082011-05-26 00:19:38 +02001554
1555 if (PyObject_HasAttr(self->raw, _PyIO_str_readall)) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001556 tmp = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_readall, NULL);
1557 if (tmp == NULL)
1558 goto cleanup;
1559 if (tmp != Py_None && !PyBytes_Check(tmp)) {
Victor Stinnerb57f1082011-05-26 00:19:38 +02001560 PyErr_SetString(PyExc_TypeError, "readall() should return bytes");
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001561 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001562 }
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001563 if (tmp == Py_None) {
1564 if (current_size == 0) {
1565 res = Py_None;
1566 goto cleanup;
1567 } else {
1568 res = data;
1569 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001570 }
1571 }
1572 else if (current_size) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001573 PyBytes_Concat(&data, tmp);
1574 res = data;
1575 goto cleanup;
1576 }
1577 else {
1578 res = tmp;
1579 goto cleanup;
1580 }
Victor Stinnerb57f1082011-05-26 00:19:38 +02001581 }
1582
1583 chunks = PyList_New(0);
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001584 if (chunks == NULL)
1585 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001586
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001587 while (1) {
1588 if (data) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001589 if (PyList_Append(chunks, data) < 0)
1590 goto cleanup;
1591 Py_CLEAR(data);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001592 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001593
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001594 /* Read until EOF or until read() would block. */
1595 data = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_read, NULL);
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001596 if (data == NULL)
1597 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001598 if (data != Py_None && !PyBytes_Check(data)) {
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001599 PyErr_SetString(PyExc_TypeError, "read() should return bytes");
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001600 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001601 }
1602 if (data == Py_None || PyBytes_GET_SIZE(data) == 0) {
1603 if (current_size == 0) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001604 res = data;
1605 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001606 }
1607 else {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001608 tmp = _PyBytes_Join(_PyIO_empty_bytes, chunks);
1609 res = tmp;
1610 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001611 }
1612 }
1613 current_size += PyBytes_GET_SIZE(data);
1614 if (self->abs_pos != -1)
1615 self->abs_pos += PyBytes_GET_SIZE(data);
1616 }
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001617cleanup:
1618 /* res is either NULL or a borrowed ref */
1619 Py_XINCREF(res);
1620 Py_XDECREF(data);
1621 Py_XDECREF(tmp);
1622 Py_XDECREF(chunks);
1623 return res;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001624}
1625
1626/* Read n bytes from the buffer if it can, otherwise return None.
1627 This function is simple enough that it can run unlocked. */
1628static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001629_bufferedreader_read_fast(buffered *self, Py_ssize_t n)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001630{
1631 Py_ssize_t current_size;
1632
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001633 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1634 if (n <= current_size) {
1635 /* Fast path: the data to read is fully buffered. */
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001636 PyObject *res = PyBytes_FromStringAndSize(self->buffer + self->pos, n);
1637 if (res != NULL)
1638 self->pos += n;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001639 return res;
1640 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001641 Py_RETURN_NONE;
1642}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001643
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001644/* Generic read function: read from the stream until enough bytes are read,
1645 * or until an EOF occurs or until read() would block.
1646 */
1647static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001648_bufferedreader_read_generic(buffered *self, Py_ssize_t n)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001649{
1650 PyObject *res = NULL;
1651 Py_ssize_t current_size, remaining, written;
1652 char *out;
1653
1654 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1655 if (n <= current_size)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001656 return _bufferedreader_read_fast(self, n);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001657
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001658 res = PyBytes_FromStringAndSize(NULL, n);
1659 if (res == NULL)
1660 goto error;
1661 out = PyBytes_AS_STRING(res);
1662 remaining = n;
1663 written = 0;
1664 if (current_size > 0) {
1665 memcpy(out, self->buffer + self->pos, current_size);
1666 remaining -= current_size;
1667 written += current_size;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001668 self->pos += current_size;
1669 }
1670 /* Flush the write buffer if necessary */
1671 if (self->writable) {
1672 PyObject *r = buffered_flush_and_rewind_unlocked(self);
1673 if (r == NULL)
1674 goto error;
1675 Py_DECREF(r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001676 }
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001677 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001678 while (remaining > 0) {
1679 /* We want to read a whole block at the end into buffer.
1680 If we had readv() we could do this in one pass. */
1681 Py_ssize_t r = MINUS_LAST_BLOCK(self, remaining);
1682 if (r == 0)
1683 break;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001684 r = _bufferedreader_raw_read(self, out + written, r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001685 if (r == -1)
1686 goto error;
1687 if (r == 0 || r == -2) {
1688 /* EOF occurred or read() would block. */
1689 if (r == 0 || written > 0) {
1690 if (_PyBytes_Resize(&res, written))
1691 goto error;
1692 return res;
1693 }
1694 Py_DECREF(res);
1695 Py_INCREF(Py_None);
1696 return Py_None;
1697 }
1698 remaining -= r;
1699 written += r;
1700 }
1701 assert(remaining <= self->buffer_size);
1702 self->pos = 0;
1703 self->raw_pos = 0;
1704 self->read_end = 0;
Antoine Pitrou32cfede2010-08-11 13:31:33 +00001705 /* NOTE: when the read is satisfied, we avoid issuing any additional
1706 reads, which could block indefinitely (e.g. on a socket).
1707 See issue #9550. */
1708 while (remaining > 0 && self->read_end < self->buffer_size) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001709 Py_ssize_t r = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001710 if (r == -1)
1711 goto error;
1712 if (r == 0 || r == -2) {
1713 /* EOF occurred or read() would block. */
1714 if (r == 0 || written > 0) {
1715 if (_PyBytes_Resize(&res, written))
1716 goto error;
1717 return res;
1718 }
1719 Py_DECREF(res);
1720 Py_INCREF(Py_None);
1721 return Py_None;
1722 }
1723 if (remaining > r) {
1724 memcpy(out + written, self->buffer + self->pos, r);
1725 written += r;
1726 self->pos += r;
1727 remaining -= r;
1728 }
1729 else if (remaining > 0) {
1730 memcpy(out + written, self->buffer + self->pos, remaining);
1731 written += remaining;
1732 self->pos += remaining;
1733 remaining = 0;
1734 }
1735 if (remaining == 0)
1736 break;
1737 }
1738
1739 return res;
1740
1741error:
1742 Py_XDECREF(res);
1743 return NULL;
1744}
1745
1746static PyObject *
Victor Stinnerbc93a112011-06-01 00:01:24 +02001747_bufferedreader_peek_unlocked(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001748{
1749 Py_ssize_t have, r;
1750
1751 have = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1752 /* Constraints:
1753 1. we don't want to advance the file position.
1754 2. we don't want to lose block alignment, so we can't shift the buffer
1755 to make some place.
1756 Therefore, we either return `have` bytes (if > 0), or a full buffer.
1757 */
1758 if (have > 0) {
1759 return PyBytes_FromStringAndSize(self->buffer + self->pos, have);
1760 }
1761
1762 /* Fill the buffer from the raw stream, and copy it to the result. */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001763 _bufferedreader_reset_buf(self);
1764 r = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001765 if (r == -1)
1766 return NULL;
1767 if (r == -2)
1768 r = 0;
1769 self->pos = 0;
1770 return PyBytes_FromStringAndSize(self->buffer, r);
1771}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001772
1773
Benjamin Peterson59406a92009-03-26 17:10:29 +00001774
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001775/*
1776 * class BufferedWriter
1777 */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001778static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001779_bufferedwriter_reset_buf(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001780{
1781 self->write_pos = 0;
1782 self->write_end = -1;
1783}
1784
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001785/*[clinic input]
1786_io.BufferedWriter.__init__
1787 raw: object
1788 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001789
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001790A buffer for a writeable sequential RawIO object.
1791
1792The constructor creates a BufferedWriter for the given writeable raw
1793stream. If the buffer_size is not given, it defaults to
1794DEFAULT_BUFFER_SIZE.
1795[clinic start generated code]*/
1796
1797static int
1798_io_BufferedWriter___init___impl(buffered *self, PyObject *raw,
1799 Py_ssize_t buffer_size)
1800/*[clinic end generated code: output=c8942a020c0dee64 input=914be9b95e16007b]*/
1801{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001802 self->ok = 0;
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001803 self->detached = 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001804
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001805 if (_PyIOBase_check_writable(raw, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001806 return -1;
1807
1808 Py_CLEAR(self->raw);
1809 Py_INCREF(raw);
1810 self->raw = raw;
1811 self->readable = 0;
1812 self->writable = 1;
1813
1814 self->buffer_size = buffer_size;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001815 if (_buffered_init(self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001816 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001817 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001818 self->pos = 0;
1819
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001820 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedWriter_Type &&
1821 Py_TYPE(raw) == &PyFileIO_Type);
1822
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001823 self->ok = 1;
1824 return 0;
1825}
1826
1827static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001828_bufferedwriter_raw_write(buffered *self, char *start, Py_ssize_t len)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001829{
1830 Py_buffer buf;
1831 PyObject *memobj, *res;
1832 Py_ssize_t n;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001833 int errnum;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001834 /* NOTE: the buffer needn't be released as its object is NULL. */
1835 if (PyBuffer_FillInfo(&buf, NULL, start, len, 1, PyBUF_CONTIG_RO) == -1)
1836 return -1;
1837 memobj = PyMemoryView_FromBuffer(&buf);
1838 if (memobj == NULL)
1839 return -1;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001840 /* NOTE: PyErr_SetFromErrno() calls PyErr_CheckSignals() when EINTR
1841 occurs so we needn't do it ourselves.
1842 We then retry writing, ignoring the signal if no handler has
1843 raised (see issue #10956).
1844 */
1845 do {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001846 errno = 0;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001847 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_write, memobj, NULL);
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001848 errnum = errno;
Gregory P. Smith51359922012-06-23 23:55:39 -07001849 } while (res == NULL && _PyIO_trap_eintr());
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001850 Py_DECREF(memobj);
1851 if (res == NULL)
1852 return -1;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001853 if (res == Py_None) {
1854 /* Non-blocking stream would have blocked. Special return code!
1855 Being paranoid we reset errno in case it is changed by code
1856 triggered by a decref. errno is used by _set_BlockingIOError(). */
1857 Py_DECREF(res);
1858 errno = errnum;
1859 return -2;
1860 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001861 n = PyNumber_AsSsize_t(res, PyExc_ValueError);
1862 Py_DECREF(res);
1863 if (n < 0 || n > len) {
1864 PyErr_Format(PyExc_IOError,
1865 "raw write() returned invalid length %zd "
1866 "(should have been between 0 and %zd)", n, len);
1867 return -1;
1868 }
1869 if (n > 0 && self->abs_pos != -1)
1870 self->abs_pos += n;
1871 return n;
1872}
1873
1874/* `restore_pos` is 1 if we need to restore the raw stream position at
1875 the end, 0 otherwise. */
1876static PyObject *
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001877_bufferedwriter_flush_unlocked(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001878{
1879 Py_ssize_t written = 0;
1880 Py_off_t n, rewind;
1881
1882 if (!VALID_WRITE_BUFFER(self) || self->write_pos == self->write_end)
1883 goto end;
1884 /* First, rewind */
1885 rewind = RAW_OFFSET(self) + (self->pos - self->write_pos);
1886 if (rewind != 0) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001887 n = _buffered_raw_seek(self, -rewind, 1);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001888 if (n < 0) {
1889 goto error;
1890 }
1891 self->raw_pos -= rewind;
1892 }
1893 while (self->write_pos < self->write_end) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001894 n = _bufferedwriter_raw_write(self,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001895 self->buffer + self->write_pos,
1896 Py_SAFE_DOWNCAST(self->write_end - self->write_pos,
1897 Py_off_t, Py_ssize_t));
1898 if (n == -1) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001899 goto error;
1900 }
1901 else if (n == -2) {
1902 _set_BlockingIOError("write could not complete without blocking",
1903 0);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001904 goto error;
1905 }
1906 self->write_pos += n;
1907 self->raw_pos = self->write_pos;
1908 written += Py_SAFE_DOWNCAST(n, Py_off_t, Py_ssize_t);
Antoine Pitroub46b9d52010-08-21 19:09:32 +00001909 /* Partial writes can return successfully when interrupted by a
1910 signal (see write(2)). We must run signal handlers before
1911 blocking another time, possibly indefinitely. */
1912 if (PyErr_CheckSignals() < 0)
1913 goto error;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001914 }
1915
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001916 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001917
1918end:
1919 Py_RETURN_NONE;
1920
1921error:
1922 return NULL;
1923}
1924
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001925/*[clinic input]
1926_io.BufferedWriter.write
1927 buffer: Py_buffer
1928 /
1929[clinic start generated code]*/
1930
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001931static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001932_io_BufferedWriter_write_impl(buffered *self, Py_buffer *buffer)
1933/*[clinic end generated code: output=7f8d1365759bfc6b input=dd87dd85fc7f8850]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001934{
1935 PyObject *res = NULL;
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00001936 Py_ssize_t written, avail, remaining;
1937 Py_off_t offset;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001938
1939 CHECK_INITIALIZED(self)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001940 if (IS_CLOSED(self)) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001941 PyErr_SetString(PyExc_ValueError, "write to closed file");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001942 return NULL;
1943 }
1944
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001945 if (!ENTER_BUFFERED(self))
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001946 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001947
1948 /* Fast path: the data to write can be fully buffered. */
1949 if (!VALID_READ_BUFFER(self) && !VALID_WRITE_BUFFER(self)) {
1950 self->pos = 0;
1951 self->raw_pos = 0;
1952 }
1953 avail = Py_SAFE_DOWNCAST(self->buffer_size - self->pos, Py_off_t, Py_ssize_t);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001954 if (buffer->len <= avail) {
1955 memcpy(self->buffer + self->pos, buffer->buf, buffer->len);
Antoine Pitrou7c404892011-05-13 00:13:33 +02001956 if (!VALID_WRITE_BUFFER(self) || self->write_pos > self->pos) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001957 self->write_pos = self->pos;
1958 }
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001959 ADJUST_POSITION(self, self->pos + buffer->len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001960 if (self->pos > self->write_end)
1961 self->write_end = self->pos;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001962 written = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001963 goto end;
1964 }
1965
1966 /* First write the current buffer */
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001967 res = _bufferedwriter_flush_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001968 if (res == NULL) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001969 Py_ssize_t *w = _buffered_check_blocking_error();
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001970 if (w == NULL)
1971 goto error;
1972 if (self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001973 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001974 /* Make some place by shifting the buffer. */
1975 assert(VALID_WRITE_BUFFER(self));
1976 memmove(self->buffer, self->buffer + self->write_pos,
1977 Py_SAFE_DOWNCAST(self->write_end - self->write_pos,
1978 Py_off_t, Py_ssize_t));
1979 self->write_end -= self->write_pos;
1980 self->raw_pos -= self->write_pos;
1981 self->pos -= self->write_pos;
1982 self->write_pos = 0;
1983 avail = Py_SAFE_DOWNCAST(self->buffer_size - self->write_end,
1984 Py_off_t, Py_ssize_t);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001985 if (buffer->len <= avail) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001986 /* Everything can be buffered */
1987 PyErr_Clear();
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001988 memcpy(self->buffer + self->write_end, buffer->buf, buffer->len);
1989 self->write_end += buffer->len;
1990 self->pos += buffer->len;
1991 written = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001992 goto end;
1993 }
1994 /* Buffer as much as possible. */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001995 memcpy(self->buffer + self->write_end, buffer->buf, avail);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001996 self->write_end += avail;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001997 self->pos += avail;
1998 /* XXX Modifying the existing exception e using the pointer w
1999 will change e.characters_written but not e.args[2].
2000 Therefore we just replace with a new error. */
2001 _set_BlockingIOError("write could not complete without blocking",
2002 avail);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002003 goto error;
2004 }
2005 Py_CLEAR(res);
2006
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002007 /* Adjust the raw stream position if it is away from the logical stream
2008 position. This happens if the read buffer has been filled but not
2009 modified (and therefore _bufferedwriter_flush_unlocked() didn't rewind
2010 the raw stream by itself).
2011 Fixes issue #6629.
2012 */
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002013 offset = RAW_OFFSET(self);
2014 if (offset != 0) {
2015 if (_buffered_raw_seek(self, -offset, 1) < 0)
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002016 goto error;
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002017 self->raw_pos -= offset;
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002018 }
2019
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002020 /* Then write buf itself. At this point the buffer has been emptied. */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002021 remaining = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002022 written = 0;
2023 while (remaining > self->buffer_size) {
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002024 Py_ssize_t n = _bufferedwriter_raw_write(
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002025 self, (char *) buffer->buf + written, buffer->len - written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002026 if (n == -1) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002027 goto error;
2028 } else if (n == -2) {
2029 /* Write failed because raw file is non-blocking */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002030 if (remaining > self->buffer_size) {
2031 /* Can't buffer everything, still buffer as much as possible */
2032 memcpy(self->buffer,
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002033 (char *) buffer->buf + written, self->buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002034 self->raw_pos = 0;
2035 ADJUST_POSITION(self, self->buffer_size);
2036 self->write_end = self->buffer_size;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002037 written += self->buffer_size;
2038 _set_BlockingIOError("write could not complete without "
2039 "blocking", written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002040 goto error;
2041 }
2042 PyErr_Clear();
2043 break;
2044 }
2045 written += n;
2046 remaining -= n;
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002047 /* Partial writes can return successfully when interrupted by a
2048 signal (see write(2)). We must run signal handlers before
2049 blocking another time, possibly indefinitely. */
2050 if (PyErr_CheckSignals() < 0)
2051 goto error;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002052 }
2053 if (self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002054 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002055 if (remaining > 0) {
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002056 memcpy(self->buffer, (char *) buffer->buf + written, remaining);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002057 written += remaining;
2058 }
2059 self->write_pos = 0;
2060 /* TODO: sanity check (remaining >= 0) */
2061 self->write_end = remaining;
2062 ADJUST_POSITION(self, remaining);
2063 self->raw_pos = 0;
2064
2065end:
2066 res = PyLong_FromSsize_t(written);
2067
2068error:
2069 LEAVE_BUFFERED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002070 return res;
2071}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002072
2073
2074
2075/*
2076 * BufferedRWPair
2077 */
2078
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002079/* XXX The usefulness of this (compared to having two separate IO objects) is
2080 * questionable.
2081 */
2082
2083typedef struct {
2084 PyObject_HEAD
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002085 buffered *reader;
2086 buffered *writer;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002087 PyObject *dict;
2088 PyObject *weakreflist;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002089} rwpair;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002090
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002091/*[clinic input]
2092_io.BufferedRWPair.__init__
2093 reader: object
2094 writer: object
2095 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
2096 /
2097
2098A buffered reader and writer object together.
2099
2100A buffered reader object and buffered writer object put together to
2101form a sequential IO object that can read and write. This is typically
2102used with a socket or two-way pipe.
2103
2104reader and writer are RawIOBase objects that are readable and
2105writeable respectively. If the buffer_size is omitted it defaults to
2106DEFAULT_BUFFER_SIZE.
2107[clinic start generated code]*/
2108
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002109static int
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002110_io_BufferedRWPair___init___impl(rwpair *self, PyObject *reader,
2111 PyObject *writer, Py_ssize_t buffer_size)
2112/*[clinic end generated code: output=327e73d1aee8f984 input=620d42d71f33a031]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002113{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002114 if (_PyIOBase_check_readable(reader, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002115 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002116 if (_PyIOBase_check_writable(writer, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002117 return -1;
2118
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002119 self->reader = (buffered *) PyObject_CallFunction(
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002120 (PyObject *) &PyBufferedReader_Type, "On", reader, buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002121 if (self->reader == NULL)
2122 return -1;
2123
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002124 self->writer = (buffered *) PyObject_CallFunction(
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002125 (PyObject *) &PyBufferedWriter_Type, "On", writer, buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002126 if (self->writer == NULL) {
2127 Py_CLEAR(self->reader);
2128 return -1;
2129 }
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002130
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002131 return 0;
2132}
2133
2134static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002135bufferedrwpair_traverse(rwpair *self, visitproc visit, void *arg)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002136{
2137 Py_VISIT(self->dict);
2138 return 0;
2139}
2140
2141static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002142bufferedrwpair_clear(rwpair *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002143{
2144 Py_CLEAR(self->reader);
2145 Py_CLEAR(self->writer);
2146 Py_CLEAR(self->dict);
2147 return 0;
2148}
2149
2150static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002151bufferedrwpair_dealloc(rwpair *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002152{
2153 _PyObject_GC_UNTRACK(self);
Benjamin Petersonbbd0a322014-09-29 22:46:57 -04002154 if (self->weakreflist != NULL)
2155 PyObject_ClearWeakRefs((PyObject *)self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002156 Py_CLEAR(self->reader);
2157 Py_CLEAR(self->writer);
2158 Py_CLEAR(self->dict);
2159 Py_TYPE(self)->tp_free((PyObject *) self);
2160}
2161
2162static PyObject *
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002163_forward_call(buffered *self, _Py_Identifier *name, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002164{
Serhiy Storchaka61e24932014-02-12 10:52:35 +02002165 PyObject *func, *ret;
2166 if (self == NULL) {
2167 PyErr_SetString(PyExc_ValueError,
2168 "I/O operation on uninitialized object");
2169 return NULL;
2170 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002171
Serhiy Storchaka61e24932014-02-12 10:52:35 +02002172 func = _PyObject_GetAttrId((PyObject *)self, name);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002173 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002174 PyErr_SetString(PyExc_AttributeError, name->string);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002175 return NULL;
2176 }
2177
2178 ret = PyObject_CallObject(func, args);
2179 Py_DECREF(func);
2180 return ret;
2181}
2182
2183static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002184bufferedrwpair_read(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002185{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002186 return _forward_call(self->reader, &PyId_read, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002187}
2188
2189static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002190bufferedrwpair_peek(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002191{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002192 return _forward_call(self->reader, &PyId_peek, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002193}
2194
2195static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002196bufferedrwpair_read1(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002197{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002198 return _forward_call(self->reader, &PyId_read1, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002199}
2200
2201static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002202bufferedrwpair_readinto(rwpair *self, PyObject *args)
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002203{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002204 return _forward_call(self->reader, &PyId_readinto, args);
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002205}
2206
2207static PyObject *
Benjamin Petersona96fea02014-06-22 14:17:44 -07002208bufferedrwpair_readinto1(rwpair *self, PyObject *args)
2209{
2210 return _forward_call(self->reader, &PyId_readinto1, args);
2211}
2212
2213static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002214bufferedrwpair_write(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002215{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002216 return _forward_call(self->writer, &PyId_write, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002217}
2218
2219static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002220bufferedrwpair_flush(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002221{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002222 return _forward_call(self->writer, &PyId_flush, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002223}
2224
2225static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002226bufferedrwpair_readable(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002227{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002228 return _forward_call(self->reader, &PyId_readable, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002229}
2230
2231static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002232bufferedrwpair_writable(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002233{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002234 return _forward_call(self->writer, &PyId_writable, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002235}
2236
2237static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002238bufferedrwpair_close(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002239{
Serhiy Storchaka7665be62015-03-24 23:21:57 +02002240 PyObject *exc = NULL, *val, *tb;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002241 PyObject *ret = _forward_call(self->writer, &PyId_close, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002242 if (ret == NULL)
Serhiy Storchaka7665be62015-03-24 23:21:57 +02002243 PyErr_Fetch(&exc, &val, &tb);
2244 else
2245 Py_DECREF(ret);
2246 ret = _forward_call(self->reader, &PyId_close, args);
2247 if (exc != NULL) {
2248 _PyErr_ChainExceptions(exc, val, tb);
2249 Py_CLEAR(ret);
2250 }
2251 return ret;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002252}
2253
2254static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002255bufferedrwpair_isatty(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002256{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002257 PyObject *ret = _forward_call(self->writer, &PyId_isatty, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002258
2259 if (ret != Py_False) {
2260 /* either True or exception */
2261 return ret;
2262 }
2263 Py_DECREF(ret);
2264
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002265 return _forward_call(self->reader, &PyId_isatty, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002266}
2267
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002268static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002269bufferedrwpair_closed_get(rwpair *self, void *context)
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002270{
Charles-François Natali42c28cd2011-10-05 19:53:43 +02002271 if (self->writer == NULL) {
2272 PyErr_SetString(PyExc_RuntimeError,
2273 "the BufferedRWPair object is being garbage-collected");
2274 return NULL;
2275 }
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002276 return PyObject_GetAttr((PyObject *) self->writer, _PyIO_str_closed);
2277}
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002278
2279
2280
2281/*
2282 * BufferedRandom
2283 */
2284
2285/*[clinic input]
2286_io.BufferedRandom.__init__
2287 raw: object
2288 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
2289
2290A buffered interface to random access streams.
2291
2292The constructor creates a reader and writer for a seekable stream,
2293raw, given in the first argument. If the buffer_size is omitted it
2294defaults to DEFAULT_BUFFER_SIZE.
2295[clinic start generated code]*/
2296
2297static int
2298_io_BufferedRandom___init___impl(buffered *self, PyObject *raw,
2299 Py_ssize_t buffer_size)
2300/*[clinic end generated code: output=d3d64eb0f64e64a3 input=a4e818fb86d0e50c]*/
2301{
2302 self->ok = 0;
2303 self->detached = 0;
2304
2305 if (_PyIOBase_check_seekable(raw, Py_True) == NULL)
2306 return -1;
2307 if (_PyIOBase_check_readable(raw, Py_True) == NULL)
2308 return -1;
2309 if (_PyIOBase_check_writable(raw, Py_True) == NULL)
2310 return -1;
2311
2312 Py_CLEAR(self->raw);
2313 Py_INCREF(raw);
2314 self->raw = raw;
2315 self->buffer_size = buffer_size;
2316 self->readable = 1;
2317 self->writable = 1;
2318
2319 if (_buffered_init(self) < 0)
2320 return -1;
2321 _bufferedreader_reset_buf(self);
2322 _bufferedwriter_reset_buf(self);
2323 self->pos = 0;
2324
2325 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedRandom_Type &&
2326 Py_TYPE(raw) == &PyFileIO_Type);
2327
2328 self->ok = 1;
2329 return 0;
2330}
2331
2332#include "clinic/bufferedio.c.h"
2333
2334
2335static PyMethodDef bufferediobase_methods[] = {
2336 _IO__BUFFEREDIOBASE_DETACH_METHODDEF
2337 {"read", bufferediobase_read, METH_VARARGS, bufferediobase_read_doc},
2338 {"read1", bufferediobase_read1, METH_VARARGS, bufferediobase_read1_doc},
2339 _IO__BUFFEREDIOBASE_READINTO_METHODDEF
2340 _IO__BUFFEREDIOBASE_READINTO1_METHODDEF
2341 {"write", bufferediobase_write, METH_VARARGS, bufferediobase_write_doc},
2342 {NULL, NULL}
2343};
2344
2345PyTypeObject PyBufferedIOBase_Type = {
2346 PyVarObject_HEAD_INIT(NULL, 0)
2347 "_io._BufferedIOBase", /*tp_name*/
2348 0, /*tp_basicsize*/
2349 0, /*tp_itemsize*/
2350 0, /*tp_dealloc*/
2351 0, /*tp_print*/
2352 0, /*tp_getattr*/
2353 0, /*tp_setattr*/
2354 0, /*tp_compare */
2355 0, /*tp_repr*/
2356 0, /*tp_as_number*/
2357 0, /*tp_as_sequence*/
2358 0, /*tp_as_mapping*/
2359 0, /*tp_hash */
2360 0, /*tp_call*/
2361 0, /*tp_str*/
2362 0, /*tp_getattro*/
2363 0, /*tp_setattro*/
2364 0, /*tp_as_buffer*/
2365 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2366 | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2367 bufferediobase_doc, /* tp_doc */
2368 0, /* tp_traverse */
2369 0, /* tp_clear */
2370 0, /* tp_richcompare */
2371 0, /* tp_weaklistoffset */
2372 0, /* tp_iter */
2373 0, /* tp_iternext */
2374 bufferediobase_methods, /* tp_methods */
2375 0, /* tp_members */
2376 0, /* tp_getset */
2377 &PyIOBase_Type, /* tp_base */
2378 0, /* tp_dict */
2379 0, /* tp_descr_get */
2380 0, /* tp_descr_set */
2381 0, /* tp_dictoffset */
2382 0, /* tp_init */
2383 0, /* tp_alloc */
2384 0, /* tp_new */
2385 0, /* tp_free */
2386 0, /* tp_is_gc */
2387 0, /* tp_bases */
2388 0, /* tp_mro */
2389 0, /* tp_cache */
2390 0, /* tp_subclasses */
2391 0, /* tp_weaklist */
2392 0, /* tp_del */
2393 0, /* tp_version_tag */
2394 0, /* tp_finalize */
2395};
2396
2397
2398static PyMethodDef bufferedreader_methods[] = {
2399 /* BufferedIOMixin methods */
2400 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2401 {"flush", (PyCFunction)buffered_simple_flush, METH_NOARGS},
2402 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2403 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2404 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
2405 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2406 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2407 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
2408 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
2409 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2410
2411 _IO__BUFFERED_READ_METHODDEF
2412 _IO__BUFFERED_PEEK_METHODDEF
2413 _IO__BUFFERED_READ1_METHODDEF
2414 _IO__BUFFERED_READINTO_METHODDEF
2415 _IO__BUFFERED_READINTO1_METHODDEF
2416 _IO__BUFFERED_READLINE_METHODDEF
2417 _IO__BUFFERED_SEEK_METHODDEF
2418 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
2419 _IO__BUFFERED_TRUNCATE_METHODDEF
2420 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
2421 {NULL, NULL}
2422};
2423
2424static PyMemberDef bufferedreader_members[] = {
2425 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
2426 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
2427 {NULL}
2428};
2429
2430static PyGetSetDef bufferedreader_getset[] = {
2431 {"closed", (getter)buffered_closed_get, NULL, NULL},
2432 {"name", (getter)buffered_name_get, NULL, NULL},
2433 {"mode", (getter)buffered_mode_get, NULL, NULL},
2434 {NULL}
2435};
2436
2437
2438PyTypeObject PyBufferedReader_Type = {
2439 PyVarObject_HEAD_INIT(NULL, 0)
2440 "_io.BufferedReader", /*tp_name*/
2441 sizeof(buffered), /*tp_basicsize*/
2442 0, /*tp_itemsize*/
2443 (destructor)buffered_dealloc, /*tp_dealloc*/
2444 0, /*tp_print*/
2445 0, /*tp_getattr*/
2446 0, /*tp_setattr*/
2447 0, /*tp_compare */
2448 (reprfunc)buffered_repr, /*tp_repr*/
2449 0, /*tp_as_number*/
2450 0, /*tp_as_sequence*/
2451 0, /*tp_as_mapping*/
2452 0, /*tp_hash */
2453 0, /*tp_call*/
2454 0, /*tp_str*/
2455 0, /*tp_getattro*/
2456 0, /*tp_setattro*/
2457 0, /*tp_as_buffer*/
2458 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2459 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2460 _io_BufferedReader___init____doc__, /* tp_doc */
2461 (traverseproc)buffered_traverse, /* tp_traverse */
2462 (inquiry)buffered_clear, /* tp_clear */
2463 0, /* tp_richcompare */
2464 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
2465 0, /* tp_iter */
2466 (iternextfunc)buffered_iternext, /* tp_iternext */
2467 bufferedreader_methods, /* tp_methods */
2468 bufferedreader_members, /* tp_members */
2469 bufferedreader_getset, /* tp_getset */
2470 0, /* tp_base */
2471 0, /* tp_dict */
2472 0, /* tp_descr_get */
2473 0, /* tp_descr_set */
2474 offsetof(buffered, dict), /* tp_dictoffset */
2475 _io_BufferedReader___init__, /* tp_init */
2476 0, /* tp_alloc */
2477 PyType_GenericNew, /* tp_new */
2478 0, /* tp_free */
2479 0, /* tp_is_gc */
2480 0, /* tp_bases */
2481 0, /* tp_mro */
2482 0, /* tp_cache */
2483 0, /* tp_subclasses */
2484 0, /* tp_weaklist */
2485 0, /* tp_del */
2486 0, /* tp_version_tag */
2487 0, /* tp_finalize */
2488};
2489
2490
2491static PyMethodDef bufferedwriter_methods[] = {
2492 /* BufferedIOMixin methods */
2493 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2494 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2495 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2496 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
2497 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2498 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2499 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
2500 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
2501 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2502
2503 _IO_BUFFEREDWRITER_WRITE_METHODDEF
2504 _IO__BUFFERED_TRUNCATE_METHODDEF
2505 {"flush", (PyCFunction)buffered_flush, METH_NOARGS},
2506 _IO__BUFFERED_SEEK_METHODDEF
2507 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
2508 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
2509 {NULL, NULL}
2510};
2511
2512static PyMemberDef bufferedwriter_members[] = {
2513 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
2514 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
2515 {NULL}
2516};
2517
2518static PyGetSetDef bufferedwriter_getset[] = {
2519 {"closed", (getter)buffered_closed_get, NULL, NULL},
2520 {"name", (getter)buffered_name_get, NULL, NULL},
2521 {"mode", (getter)buffered_mode_get, NULL, NULL},
2522 {NULL}
2523};
2524
2525
2526PyTypeObject PyBufferedWriter_Type = {
2527 PyVarObject_HEAD_INIT(NULL, 0)
2528 "_io.BufferedWriter", /*tp_name*/
2529 sizeof(buffered), /*tp_basicsize*/
2530 0, /*tp_itemsize*/
2531 (destructor)buffered_dealloc, /*tp_dealloc*/
2532 0, /*tp_print*/
2533 0, /*tp_getattr*/
2534 0, /*tp_setattr*/
2535 0, /*tp_compare */
2536 (reprfunc)buffered_repr, /*tp_repr*/
2537 0, /*tp_as_number*/
2538 0, /*tp_as_sequence*/
2539 0, /*tp_as_mapping*/
2540 0, /*tp_hash */
2541 0, /*tp_call*/
2542 0, /*tp_str*/
2543 0, /*tp_getattro*/
2544 0, /*tp_setattro*/
2545 0, /*tp_as_buffer*/
2546 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2547 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2548 _io_BufferedWriter___init____doc__, /* tp_doc */
2549 (traverseproc)buffered_traverse, /* tp_traverse */
2550 (inquiry)buffered_clear, /* tp_clear */
2551 0, /* tp_richcompare */
2552 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
2553 0, /* tp_iter */
2554 0, /* tp_iternext */
2555 bufferedwriter_methods, /* tp_methods */
2556 bufferedwriter_members, /* tp_members */
2557 bufferedwriter_getset, /* tp_getset */
2558 0, /* tp_base */
2559 0, /* tp_dict */
2560 0, /* tp_descr_get */
2561 0, /* tp_descr_set */
2562 offsetof(buffered, dict), /* tp_dictoffset */
2563 _io_BufferedWriter___init__, /* tp_init */
2564 0, /* tp_alloc */
2565 PyType_GenericNew, /* tp_new */
2566 0, /* tp_free */
2567 0, /* tp_is_gc */
2568 0, /* tp_bases */
2569 0, /* tp_mro */
2570 0, /* tp_cache */
2571 0, /* tp_subclasses */
2572 0, /* tp_weaklist */
2573 0, /* tp_del */
2574 0, /* tp_version_tag */
2575 0, /* tp_finalize */
2576};
2577
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002578
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002579static PyMethodDef bufferedrwpair_methods[] = {
2580 {"read", (PyCFunction)bufferedrwpair_read, METH_VARARGS},
2581 {"peek", (PyCFunction)bufferedrwpair_peek, METH_VARARGS},
2582 {"read1", (PyCFunction)bufferedrwpair_read1, METH_VARARGS},
2583 {"readinto", (PyCFunction)bufferedrwpair_readinto, METH_VARARGS},
Benjamin Petersona96fea02014-06-22 14:17:44 -07002584 {"readinto1", (PyCFunction)bufferedrwpair_readinto1, METH_VARARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002585
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002586 {"write", (PyCFunction)bufferedrwpair_write, METH_VARARGS},
2587 {"flush", (PyCFunction)bufferedrwpair_flush, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002588
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002589 {"readable", (PyCFunction)bufferedrwpair_readable, METH_NOARGS},
2590 {"writable", (PyCFunction)bufferedrwpair_writable, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002591
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002592 {"close", (PyCFunction)bufferedrwpair_close, METH_NOARGS},
2593 {"isatty", (PyCFunction)bufferedrwpair_isatty, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002594
Antoine Pitrou243757e2010-11-05 21:15:39 +00002595 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2596
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002597 {NULL, NULL}
2598};
2599
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002600static PyGetSetDef bufferedrwpair_getset[] = {
2601 {"closed", (getter)bufferedrwpair_closed_get, NULL, NULL},
Benjamin Peterson1fea3212009-04-19 03:15:20 +00002602 {NULL}
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002603};
2604
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002605PyTypeObject PyBufferedRWPair_Type = {
2606 PyVarObject_HEAD_INIT(NULL, 0)
2607 "_io.BufferedRWPair", /*tp_name*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002608 sizeof(rwpair), /*tp_basicsize*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002609 0, /*tp_itemsize*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002610 (destructor)bufferedrwpair_dealloc, /*tp_dealloc*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002611 0, /*tp_print*/
2612 0, /*tp_getattr*/
2613 0, /*tp_setattr*/
2614 0, /*tp_compare */
2615 0, /*tp_repr*/
2616 0, /*tp_as_number*/
2617 0, /*tp_as_sequence*/
2618 0, /*tp_as_mapping*/
2619 0, /*tp_hash */
2620 0, /*tp_call*/
2621 0, /*tp_str*/
2622 0, /*tp_getattro*/
2623 0, /*tp_setattro*/
2624 0, /*tp_as_buffer*/
2625 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
Antoine Pitrou796564c2013-07-30 19:59:21 +02002626 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /* tp_flags */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002627 _io_BufferedRWPair___init____doc__, /* tp_doc */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002628 (traverseproc)bufferedrwpair_traverse, /* tp_traverse */
2629 (inquiry)bufferedrwpair_clear, /* tp_clear */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002630 0, /* tp_richcompare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002631 offsetof(rwpair, weakreflist), /*tp_weaklistoffset*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002632 0, /* tp_iter */
2633 0, /* tp_iternext */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002634 bufferedrwpair_methods, /* tp_methods */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002635 0, /* tp_members */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002636 bufferedrwpair_getset, /* tp_getset */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002637 0, /* tp_base */
2638 0, /* tp_dict */
2639 0, /* tp_descr_get */
2640 0, /* tp_descr_set */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002641 offsetof(rwpair, dict), /* tp_dictoffset */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002642 _io_BufferedRWPair___init__, /* tp_init */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002643 0, /* tp_alloc */
2644 PyType_GenericNew, /* tp_new */
Antoine Pitrou796564c2013-07-30 19:59:21 +02002645 0, /* tp_free */
2646 0, /* tp_is_gc */
2647 0, /* tp_bases */
2648 0, /* tp_mro */
2649 0, /* tp_cache */
2650 0, /* tp_subclasses */
2651 0, /* tp_weaklist */
2652 0, /* tp_del */
2653 0, /* tp_version_tag */
2654 0, /* tp_finalize */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002655};
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002656
2657
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002658static PyMethodDef bufferedrandom_methods[] = {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002659 /* BufferedIOMixin methods */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002660 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2661 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2662 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2663 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
2664 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2665 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2666 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
Antoine Pitroue033e062010-10-29 10:38:18 +00002667 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
Antoine Pitrou243757e2010-11-05 21:15:39 +00002668 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002669
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002670 {"flush", (PyCFunction)buffered_flush, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002671
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002672 _IO__BUFFERED_SEEK_METHODDEF
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002673 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002674 _IO__BUFFERED_TRUNCATE_METHODDEF
2675 _IO__BUFFERED_READ_METHODDEF
2676 _IO__BUFFERED_READ1_METHODDEF
2677 _IO__BUFFERED_READINTO_METHODDEF
2678 _IO__BUFFERED_READINTO1_METHODDEF
2679 _IO__BUFFERED_READLINE_METHODDEF
2680 _IO__BUFFERED_PEEK_METHODDEF
2681 _IO_BUFFEREDWRITER_WRITE_METHODDEF
Antoine Pitrou10f0c502012-07-29 19:02:46 +02002682 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002683 {NULL, NULL}
2684};
2685
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002686static PyMemberDef bufferedrandom_members[] = {
Antoine Pitrou7f8f4182010-12-21 21:20:59 +00002687 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
Antoine Pitrou796564c2013-07-30 19:59:21 +02002688 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002689 {NULL}
2690};
2691
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002692static PyGetSetDef bufferedrandom_getset[] = {
2693 {"closed", (getter)buffered_closed_get, NULL, NULL},
2694 {"name", (getter)buffered_name_get, NULL, NULL},
2695 {"mode", (getter)buffered_mode_get, NULL, NULL},
Benjamin Peterson1fea3212009-04-19 03:15:20 +00002696 {NULL}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002697};
2698
2699
2700PyTypeObject PyBufferedRandom_Type = {
2701 PyVarObject_HEAD_INIT(NULL, 0)
2702 "_io.BufferedRandom", /*tp_name*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002703 sizeof(buffered), /*tp_basicsize*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002704 0, /*tp_itemsize*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002705 (destructor)buffered_dealloc, /*tp_dealloc*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002706 0, /*tp_print*/
2707 0, /*tp_getattr*/
2708 0, /*tp_setattr*/
2709 0, /*tp_compare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002710 (reprfunc)buffered_repr, /*tp_repr*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002711 0, /*tp_as_number*/
2712 0, /*tp_as_sequence*/
2713 0, /*tp_as_mapping*/
2714 0, /*tp_hash */
2715 0, /*tp_call*/
2716 0, /*tp_str*/
2717 0, /*tp_getattro*/
2718 0, /*tp_setattro*/
2719 0, /*tp_as_buffer*/
2720 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
Antoine Pitrou796564c2013-07-30 19:59:21 +02002721 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002722 _io_BufferedRandom___init____doc__, /* tp_doc */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002723 (traverseproc)buffered_traverse, /* tp_traverse */
2724 (inquiry)buffered_clear, /* tp_clear */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002725 0, /* tp_richcompare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002726 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002727 0, /* tp_iter */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002728 (iternextfunc)buffered_iternext, /* tp_iternext */
2729 bufferedrandom_methods, /* tp_methods */
2730 bufferedrandom_members, /* tp_members */
2731 bufferedrandom_getset, /* tp_getset */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002732 0, /* tp_base */
2733 0, /*tp_dict*/
2734 0, /* tp_descr_get */
2735 0, /* tp_descr_set */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002736 offsetof(buffered, dict), /*tp_dictoffset*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002737 _io_BufferedRandom___init__, /* tp_init */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002738 0, /* tp_alloc */
2739 PyType_GenericNew, /* tp_new */
Antoine Pitrou796564c2013-07-30 19:59:21 +02002740 0, /* tp_free */
2741 0, /* tp_is_gc */
2742 0, /* tp_bases */
2743 0, /* tp_mro */
2744 0, /* tp_cache */
2745 0, /* tp_subclasses */
2746 0, /* tp_weaklist */
2747 0, /* tp_del */
2748 0, /* tp_version_tag */
2749 0, /* tp_finalize */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002750};