blob: ae4af9d5ffd2424fc374fc2cca72b2378a782374 [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 */
Steve Dower6baa0f92015-05-23 08:59:25 -0700300 st = PyThread_acquire_lock_timed(self->lock, (PY_TIMEOUT_T)1e6, 0);
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200301 }
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
Serhiy Storchaka5c4064e2015-12-19 20:05:25 +0200426 res = _PyObject_SIZE(Py_TYPE(self));
Antoine Pitrou10f0c502012-07-29 19:02:46 +0200427 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 }
Serhiy Storchaka4a1e70f2015-12-27 12:36:18 +02001199 Py_SETREF(res, _PyBytes_Join(_PyIO_empty_bytes, chunks));
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001200
1201end:
1202 LEAVE_BUFFERED(self)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001203end_unlocked:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001204 Py_XDECREF(chunks);
1205 return res;
1206}
1207
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001208/*[clinic input]
1209_io._Buffered.readline
1210 size: io_ssize_t = -1
1211 /
1212[clinic start generated code]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001213
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001214static PyObject *
1215_io__Buffered_readline_impl(buffered *self, Py_ssize_t size)
1216/*[clinic end generated code: output=24dd2aa6e33be83c input=ff1e0df821cb4e5c]*/
1217{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001218 CHECK_INITIALIZED(self)
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001219 return _buffered_readline(self, size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001220}
1221
1222
1223static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001224buffered_tell(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001225{
1226 Py_off_t pos;
1227
1228 CHECK_INITIALIZED(self)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001229 pos = _buffered_raw_tell(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001230 if (pos == -1)
1231 return NULL;
1232 pos -= RAW_OFFSET(self);
1233 /* TODO: sanity check (pos >= 0) */
1234 return PyLong_FromOff_t(pos);
1235}
1236
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001237/*[clinic input]
1238_io._Buffered.seek
1239 target as targetobj: object
1240 whence: int = 0
1241 /
1242[clinic start generated code]*/
1243
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001244static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001245_io__Buffered_seek_impl(buffered *self, PyObject *targetobj, int whence)
1246/*[clinic end generated code: output=7ae0e8dc46efdefb input=a9c4920bfcba6163]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001247{
1248 Py_off_t target, n;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001249 PyObject *res = NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001250
1251 CHECK_INITIALIZED(self)
Jesus Cea94363612012-06-22 18:32:07 +02001252
1253 /* Do some error checking instead of trusting OS 'seek()'
1254 ** error detection, just in case.
1255 */
1256 if ((whence < 0 || whence >2)
1257#ifdef SEEK_HOLE
1258 && (whence != SEEK_HOLE)
1259#endif
1260#ifdef SEEK_DATA
1261 && (whence != SEEK_DATA)
1262#endif
1263 ) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001264 PyErr_Format(PyExc_ValueError,
Jesus Cea94363612012-06-22 18:32:07 +02001265 "whence value %d unsupported", whence);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001266 return NULL;
1267 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001268
1269 CHECK_CLOSED(self, "seek of closed file")
1270
Antoine Pitrou1e44fec2011-10-04 12:26:20 +02001271 if (_PyIOBase_check_seekable(self->raw, Py_True) == NULL)
1272 return NULL;
1273
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001274 target = PyNumber_AsOff_t(targetobj, PyExc_ValueError);
1275 if (target == -1 && PyErr_Occurred())
1276 return NULL;
1277
Jesus Cea94363612012-06-22 18:32:07 +02001278 /* SEEK_SET and SEEK_CUR are special because we could seek inside the
1279 buffer. Other whence values must be managed without this optimization.
1280 Some Operating Systems can provide additional values, like
1281 SEEK_HOLE/SEEK_DATA. */
1282 if (((whence == 0) || (whence == 1)) && self->readable) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001283 Py_off_t current, avail;
1284 /* Check if seeking leaves us inside the current buffer,
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001285 so as to return quickly if possible. Also, we needn't take the
1286 lock in this fast path.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001287 Don't know how to do that when whence == 2, though. */
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001288 /* NOTE: RAW_TELL() can release the GIL but the object is in a stable
1289 state at this point. */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001290 current = RAW_TELL(self);
1291 avail = READAHEAD(self);
1292 if (avail > 0) {
1293 Py_off_t offset;
1294 if (whence == 0)
1295 offset = target - (current - RAW_OFFSET(self));
1296 else
1297 offset = target;
1298 if (offset >= -self->pos && offset <= avail) {
1299 self->pos += offset;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001300 return PyLong_FromOff_t(current - avail + offset);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001301 }
1302 }
1303 }
1304
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001305 if (!ENTER_BUFFERED(self))
1306 return NULL;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001307
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001308 /* Fallback: invoke raw seek() method and clear buffer */
1309 if (self->writable) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001310 res = _bufferedwriter_flush_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001311 if (res == NULL)
1312 goto end;
1313 Py_CLEAR(res);
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001314 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001315 }
1316
1317 /* TODO: align on block boundary and read buffer if needed? */
1318 if (whence == 1)
1319 target -= RAW_OFFSET(self);
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001320 n = _buffered_raw_seek(self, target, whence);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001321 if (n == -1)
1322 goto end;
1323 self->raw_pos = -1;
1324 res = PyLong_FromOff_t(n);
1325 if (res != NULL && self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001326 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001327
1328end:
1329 LEAVE_BUFFERED(self)
1330 return res;
1331}
1332
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001333/*[clinic input]
1334_io._Buffered.truncate
1335 pos: object = None
1336 /
1337[clinic start generated code]*/
1338
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001339static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001340_io__Buffered_truncate_impl(buffered *self, PyObject *pos)
1341/*[clinic end generated code: output=667ca03c60c270de input=8a1be34d57cca2d3]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001342{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001343 PyObject *res = NULL;
1344
1345 CHECK_INITIALIZED(self)
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001346 if (!ENTER_BUFFERED(self))
1347 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001348
1349 if (self->writable) {
Antoine Pitroue05565e2011-08-20 14:39:23 +02001350 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001351 if (res == NULL)
1352 goto end;
1353 Py_CLEAR(res);
1354 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001355 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_truncate, pos, NULL);
1356 if (res == NULL)
1357 goto end;
1358 /* Reset cached position */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001359 if (_buffered_raw_tell(self) == -1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001360 PyErr_Clear();
1361
1362end:
1363 LEAVE_BUFFERED(self)
1364 return res;
1365}
1366
1367static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001368buffered_iternext(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001369{
1370 PyObject *line;
1371 PyTypeObject *tp;
1372
1373 CHECK_INITIALIZED(self);
1374
1375 tp = Py_TYPE(self);
1376 if (tp == &PyBufferedReader_Type ||
1377 tp == &PyBufferedRandom_Type) {
1378 /* Skip method call overhead for speed */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001379 line = _buffered_readline(self, -1);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001380 }
1381 else {
1382 line = PyObject_CallMethodObjArgs((PyObject *)self,
1383 _PyIO_str_readline, NULL);
1384 if (line && !PyBytes_Check(line)) {
1385 PyErr_Format(PyExc_IOError,
1386 "readline() should have returned a bytes object, "
1387 "not '%.200s'", Py_TYPE(line)->tp_name);
1388 Py_DECREF(line);
1389 return NULL;
1390 }
1391 }
1392
1393 if (line == NULL)
1394 return NULL;
1395
1396 if (PyBytes_GET_SIZE(line) == 0) {
1397 /* Reached EOF or would have blocked */
1398 Py_DECREF(line);
1399 return NULL;
1400 }
1401
1402 return line;
1403}
1404
Antoine Pitrou716c4442009-05-23 19:04:03 +00001405static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001406buffered_repr(buffered *self)
Antoine Pitrou716c4442009-05-23 19:04:03 +00001407{
1408 PyObject *nameobj, *res;
1409
Martin v. Löwis767046a2011-10-14 15:35:36 +02001410 nameobj = _PyObject_GetAttrId((PyObject *) self, &PyId_name);
Antoine Pitrou716c4442009-05-23 19:04:03 +00001411 if (nameobj == NULL) {
Benjamin Peterson10e76b62014-12-21 20:51:50 -06001412 if (PyErr_ExceptionMatches(PyExc_Exception))
Antoine Pitrou716c4442009-05-23 19:04:03 +00001413 PyErr_Clear();
1414 else
1415 return NULL;
1416 res = PyUnicode_FromFormat("<%s>", Py_TYPE(self)->tp_name);
1417 }
1418 else {
1419 res = PyUnicode_FromFormat("<%s name=%R>",
1420 Py_TYPE(self)->tp_name, nameobj);
1421 Py_DECREF(nameobj);
1422 }
1423 return res;
1424}
1425
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001426/*
1427 * class BufferedReader
1428 */
1429
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001430static void _bufferedreader_reset_buf(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001431{
1432 self->read_end = -1;
1433}
1434
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001435/*[clinic input]
1436_io.BufferedReader.__init__
1437 raw: object
1438 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001439
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001440Create a new buffered reader using the given readable raw IO object.
1441[clinic start generated code]*/
1442
1443static int
1444_io_BufferedReader___init___impl(buffered *self, PyObject *raw,
1445 Py_ssize_t buffer_size)
1446/*[clinic end generated code: output=cddcfefa0ed294c4 input=fb887e06f11b4e48]*/
1447{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001448 self->ok = 0;
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001449 self->detached = 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001450
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001451 if (_PyIOBase_check_readable(raw, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001452 return -1;
1453
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001454 Py_INCREF(raw);
Serhiy Storchaka4a1e70f2015-12-27 12:36:18 +02001455 Py_SETREF(self->raw, raw);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001456 self->buffer_size = buffer_size;
1457 self->readable = 1;
1458 self->writable = 0;
1459
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001460 if (_buffered_init(self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001461 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001462 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001463
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001464 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedReader_Type &&
1465 Py_TYPE(raw) == &PyFileIO_Type);
1466
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001467 self->ok = 1;
1468 return 0;
1469}
1470
1471static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001472_bufferedreader_raw_read(buffered *self, char *start, Py_ssize_t len)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001473{
1474 Py_buffer buf;
1475 PyObject *memobj, *res;
1476 Py_ssize_t n;
1477 /* NOTE: the buffer needn't be released as its object is NULL. */
1478 if (PyBuffer_FillInfo(&buf, NULL, start, len, 0, PyBUF_CONTIG) == -1)
1479 return -1;
1480 memobj = PyMemoryView_FromBuffer(&buf);
1481 if (memobj == NULL)
1482 return -1;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001483 /* NOTE: PyErr_SetFromErrno() calls PyErr_CheckSignals() when EINTR
1484 occurs so we needn't do it ourselves.
1485 We then retry reading, ignoring the signal if no handler has
1486 raised (see issue #10956).
1487 */
1488 do {
1489 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_readinto, memobj, NULL);
Gregory P. Smith51359922012-06-23 23:55:39 -07001490 } while (res == NULL && _PyIO_trap_eintr());
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001491 Py_DECREF(memobj);
1492 if (res == NULL)
1493 return -1;
1494 if (res == Py_None) {
1495 /* Non-blocking stream would have blocked. Special return code! */
1496 Py_DECREF(res);
1497 return -2;
1498 }
1499 n = PyNumber_AsSsize_t(res, PyExc_ValueError);
1500 Py_DECREF(res);
1501 if (n < 0 || n > len) {
1502 PyErr_Format(PyExc_IOError,
1503 "raw readinto() returned invalid length %zd "
1504 "(should have been between 0 and %zd)", n, len);
1505 return -1;
1506 }
1507 if (n > 0 && self->abs_pos != -1)
1508 self->abs_pos += n;
1509 return n;
1510}
1511
1512static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001513_bufferedreader_fill_buffer(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001514{
1515 Py_ssize_t start, len, n;
1516 if (VALID_READ_BUFFER(self))
1517 start = Py_SAFE_DOWNCAST(self->read_end, Py_off_t, Py_ssize_t);
1518 else
1519 start = 0;
1520 len = self->buffer_size - start;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001521 n = _bufferedreader_raw_read(self, self->buffer + start, len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001522 if (n <= 0)
1523 return n;
1524 self->read_end = start + n;
1525 self->raw_pos = start + n;
1526 return n;
1527}
1528
1529static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001530_bufferedreader_read_all(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001531{
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001532 Py_ssize_t current_size;
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001533 PyObject *res = NULL, *data = NULL, *tmp = NULL, *chunks = NULL;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001534
1535 /* First copy what we have in the current buffer. */
1536 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1537 if (current_size) {
1538 data = PyBytes_FromStringAndSize(
1539 self->buffer + self->pos, current_size);
Victor Stinnerb57f1082011-05-26 00:19:38 +02001540 if (data == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001541 return NULL;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001542 self->pos += current_size;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001543 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001544 /* We're going past the buffer's bounds, flush it */
1545 if (self->writable) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001546 tmp = buffered_flush_and_rewind_unlocked(self);
1547 if (tmp == NULL)
1548 goto cleanup;
1549 Py_CLEAR(tmp);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001550 }
Antoine Pitroue05565e2011-08-20 14:39:23 +02001551 _bufferedreader_reset_buf(self);
Victor Stinnerb57f1082011-05-26 00:19:38 +02001552
1553 if (PyObject_HasAttr(self->raw, _PyIO_str_readall)) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001554 tmp = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_readall, NULL);
1555 if (tmp == NULL)
1556 goto cleanup;
1557 if (tmp != Py_None && !PyBytes_Check(tmp)) {
Victor Stinnerb57f1082011-05-26 00:19:38 +02001558 PyErr_SetString(PyExc_TypeError, "readall() should return bytes");
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001559 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001560 }
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001561 if (tmp == Py_None) {
1562 if (current_size == 0) {
1563 res = Py_None;
1564 goto cleanup;
1565 } else {
1566 res = data;
1567 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001568 }
1569 }
1570 else if (current_size) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001571 PyBytes_Concat(&data, tmp);
1572 res = data;
1573 goto cleanup;
1574 }
1575 else {
1576 res = tmp;
1577 goto cleanup;
1578 }
Victor Stinnerb57f1082011-05-26 00:19:38 +02001579 }
1580
1581 chunks = PyList_New(0);
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001582 if (chunks == NULL)
1583 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001584
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001585 while (1) {
1586 if (data) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001587 if (PyList_Append(chunks, data) < 0)
1588 goto cleanup;
1589 Py_CLEAR(data);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001590 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001591
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001592 /* Read until EOF or until read() would block. */
1593 data = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_read, NULL);
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001594 if (data == NULL)
1595 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001596 if (data != Py_None && !PyBytes_Check(data)) {
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001597 PyErr_SetString(PyExc_TypeError, "read() should return bytes");
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001598 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001599 }
1600 if (data == Py_None || PyBytes_GET_SIZE(data) == 0) {
1601 if (current_size == 0) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001602 res = data;
1603 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001604 }
1605 else {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001606 tmp = _PyBytes_Join(_PyIO_empty_bytes, chunks);
1607 res = tmp;
1608 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001609 }
1610 }
1611 current_size += PyBytes_GET_SIZE(data);
1612 if (self->abs_pos != -1)
1613 self->abs_pos += PyBytes_GET_SIZE(data);
1614 }
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001615cleanup:
1616 /* res is either NULL or a borrowed ref */
1617 Py_XINCREF(res);
1618 Py_XDECREF(data);
1619 Py_XDECREF(tmp);
1620 Py_XDECREF(chunks);
1621 return res;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001622}
1623
1624/* Read n bytes from the buffer if it can, otherwise return None.
1625 This function is simple enough that it can run unlocked. */
1626static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001627_bufferedreader_read_fast(buffered *self, Py_ssize_t n)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001628{
1629 Py_ssize_t current_size;
1630
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001631 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1632 if (n <= current_size) {
1633 /* Fast path: the data to read is fully buffered. */
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001634 PyObject *res = PyBytes_FromStringAndSize(self->buffer + self->pos, n);
1635 if (res != NULL)
1636 self->pos += n;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001637 return res;
1638 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001639 Py_RETURN_NONE;
1640}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001641
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001642/* Generic read function: read from the stream until enough bytes are read,
1643 * or until an EOF occurs or until read() would block.
1644 */
1645static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001646_bufferedreader_read_generic(buffered *self, Py_ssize_t n)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001647{
1648 PyObject *res = NULL;
1649 Py_ssize_t current_size, remaining, written;
1650 char *out;
1651
1652 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1653 if (n <= current_size)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001654 return _bufferedreader_read_fast(self, n);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001655
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001656 res = PyBytes_FromStringAndSize(NULL, n);
1657 if (res == NULL)
1658 goto error;
1659 out = PyBytes_AS_STRING(res);
1660 remaining = n;
1661 written = 0;
1662 if (current_size > 0) {
1663 memcpy(out, self->buffer + self->pos, current_size);
1664 remaining -= current_size;
1665 written += current_size;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001666 self->pos += current_size;
1667 }
1668 /* Flush the write buffer if necessary */
1669 if (self->writable) {
1670 PyObject *r = buffered_flush_and_rewind_unlocked(self);
1671 if (r == NULL)
1672 goto error;
1673 Py_DECREF(r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001674 }
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001675 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001676 while (remaining > 0) {
1677 /* We want to read a whole block at the end into buffer.
1678 If we had readv() we could do this in one pass. */
1679 Py_ssize_t r = MINUS_LAST_BLOCK(self, remaining);
1680 if (r == 0)
1681 break;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001682 r = _bufferedreader_raw_read(self, out + written, r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001683 if (r == -1)
1684 goto error;
1685 if (r == 0 || r == -2) {
1686 /* EOF occurred or read() would block. */
1687 if (r == 0 || written > 0) {
1688 if (_PyBytes_Resize(&res, written))
1689 goto error;
1690 return res;
1691 }
1692 Py_DECREF(res);
1693 Py_INCREF(Py_None);
1694 return Py_None;
1695 }
1696 remaining -= r;
1697 written += r;
1698 }
1699 assert(remaining <= self->buffer_size);
1700 self->pos = 0;
1701 self->raw_pos = 0;
1702 self->read_end = 0;
Antoine Pitrou32cfede2010-08-11 13:31:33 +00001703 /* NOTE: when the read is satisfied, we avoid issuing any additional
1704 reads, which could block indefinitely (e.g. on a socket).
1705 See issue #9550. */
1706 while (remaining > 0 && self->read_end < self->buffer_size) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001707 Py_ssize_t r = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001708 if (r == -1)
1709 goto error;
1710 if (r == 0 || r == -2) {
1711 /* EOF occurred or read() would block. */
1712 if (r == 0 || written > 0) {
1713 if (_PyBytes_Resize(&res, written))
1714 goto error;
1715 return res;
1716 }
1717 Py_DECREF(res);
1718 Py_INCREF(Py_None);
1719 return Py_None;
1720 }
1721 if (remaining > r) {
1722 memcpy(out + written, self->buffer + self->pos, r);
1723 written += r;
1724 self->pos += r;
1725 remaining -= r;
1726 }
1727 else if (remaining > 0) {
1728 memcpy(out + written, self->buffer + self->pos, remaining);
1729 written += remaining;
1730 self->pos += remaining;
1731 remaining = 0;
1732 }
1733 if (remaining == 0)
1734 break;
1735 }
1736
1737 return res;
1738
1739error:
1740 Py_XDECREF(res);
1741 return NULL;
1742}
1743
1744static PyObject *
Victor Stinnerbc93a112011-06-01 00:01:24 +02001745_bufferedreader_peek_unlocked(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001746{
1747 Py_ssize_t have, r;
1748
1749 have = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1750 /* Constraints:
1751 1. we don't want to advance the file position.
1752 2. we don't want to lose block alignment, so we can't shift the buffer
1753 to make some place.
1754 Therefore, we either return `have` bytes (if > 0), or a full buffer.
1755 */
1756 if (have > 0) {
1757 return PyBytes_FromStringAndSize(self->buffer + self->pos, have);
1758 }
1759
1760 /* Fill the buffer from the raw stream, and copy it to the result. */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001761 _bufferedreader_reset_buf(self);
1762 r = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001763 if (r == -1)
1764 return NULL;
1765 if (r == -2)
1766 r = 0;
1767 self->pos = 0;
1768 return PyBytes_FromStringAndSize(self->buffer, r);
1769}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001770
1771
Benjamin Peterson59406a92009-03-26 17:10:29 +00001772
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001773/*
1774 * class BufferedWriter
1775 */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001776static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001777_bufferedwriter_reset_buf(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001778{
1779 self->write_pos = 0;
1780 self->write_end = -1;
1781}
1782
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001783/*[clinic input]
1784_io.BufferedWriter.__init__
1785 raw: object
1786 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001787
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001788A buffer for a writeable sequential RawIO object.
1789
1790The constructor creates a BufferedWriter for the given writeable raw
1791stream. If the buffer_size is not given, it defaults to
1792DEFAULT_BUFFER_SIZE.
1793[clinic start generated code]*/
1794
1795static int
1796_io_BufferedWriter___init___impl(buffered *self, PyObject *raw,
1797 Py_ssize_t buffer_size)
1798/*[clinic end generated code: output=c8942a020c0dee64 input=914be9b95e16007b]*/
1799{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001800 self->ok = 0;
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001801 self->detached = 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001802
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001803 if (_PyIOBase_check_writable(raw, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001804 return -1;
1805
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001806 Py_INCREF(raw);
Serhiy Storchaka4a1e70f2015-12-27 12:36:18 +02001807 Py_SETREF(self->raw, raw);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001808 self->readable = 0;
1809 self->writable = 1;
1810
1811 self->buffer_size = buffer_size;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001812 if (_buffered_init(self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001813 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001814 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001815 self->pos = 0;
1816
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001817 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedWriter_Type &&
1818 Py_TYPE(raw) == &PyFileIO_Type);
1819
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001820 self->ok = 1;
1821 return 0;
1822}
1823
1824static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001825_bufferedwriter_raw_write(buffered *self, char *start, Py_ssize_t len)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001826{
1827 Py_buffer buf;
1828 PyObject *memobj, *res;
1829 Py_ssize_t n;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001830 int errnum;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001831 /* NOTE: the buffer needn't be released as its object is NULL. */
1832 if (PyBuffer_FillInfo(&buf, NULL, start, len, 1, PyBUF_CONTIG_RO) == -1)
1833 return -1;
1834 memobj = PyMemoryView_FromBuffer(&buf);
1835 if (memobj == NULL)
1836 return -1;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001837 /* NOTE: PyErr_SetFromErrno() calls PyErr_CheckSignals() when EINTR
1838 occurs so we needn't do it ourselves.
1839 We then retry writing, ignoring the signal if no handler has
1840 raised (see issue #10956).
1841 */
1842 do {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001843 errno = 0;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001844 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_write, memobj, NULL);
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001845 errnum = errno;
Gregory P. Smith51359922012-06-23 23:55:39 -07001846 } while (res == NULL && _PyIO_trap_eintr());
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001847 Py_DECREF(memobj);
1848 if (res == NULL)
1849 return -1;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001850 if (res == Py_None) {
1851 /* Non-blocking stream would have blocked. Special return code!
1852 Being paranoid we reset errno in case it is changed by code
1853 triggered by a decref. errno is used by _set_BlockingIOError(). */
1854 Py_DECREF(res);
1855 errno = errnum;
1856 return -2;
1857 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001858 n = PyNumber_AsSsize_t(res, PyExc_ValueError);
1859 Py_DECREF(res);
1860 if (n < 0 || n > len) {
1861 PyErr_Format(PyExc_IOError,
1862 "raw write() returned invalid length %zd "
1863 "(should have been between 0 and %zd)", n, len);
1864 return -1;
1865 }
1866 if (n > 0 && self->abs_pos != -1)
1867 self->abs_pos += n;
1868 return n;
1869}
1870
1871/* `restore_pos` is 1 if we need to restore the raw stream position at
1872 the end, 0 otherwise. */
1873static PyObject *
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001874_bufferedwriter_flush_unlocked(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001875{
1876 Py_ssize_t written = 0;
1877 Py_off_t n, rewind;
1878
1879 if (!VALID_WRITE_BUFFER(self) || self->write_pos == self->write_end)
1880 goto end;
1881 /* First, rewind */
1882 rewind = RAW_OFFSET(self) + (self->pos - self->write_pos);
1883 if (rewind != 0) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001884 n = _buffered_raw_seek(self, -rewind, 1);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001885 if (n < 0) {
1886 goto error;
1887 }
1888 self->raw_pos -= rewind;
1889 }
1890 while (self->write_pos < self->write_end) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001891 n = _bufferedwriter_raw_write(self,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001892 self->buffer + self->write_pos,
1893 Py_SAFE_DOWNCAST(self->write_end - self->write_pos,
1894 Py_off_t, Py_ssize_t));
1895 if (n == -1) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001896 goto error;
1897 }
1898 else if (n == -2) {
1899 _set_BlockingIOError("write could not complete without blocking",
1900 0);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001901 goto error;
1902 }
1903 self->write_pos += n;
1904 self->raw_pos = self->write_pos;
1905 written += Py_SAFE_DOWNCAST(n, Py_off_t, Py_ssize_t);
Antoine Pitroub46b9d52010-08-21 19:09:32 +00001906 /* Partial writes can return successfully when interrupted by a
1907 signal (see write(2)). We must run signal handlers before
1908 blocking another time, possibly indefinitely. */
1909 if (PyErr_CheckSignals() < 0)
1910 goto error;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001911 }
1912
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001913 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001914
1915end:
1916 Py_RETURN_NONE;
1917
1918error:
1919 return NULL;
1920}
1921
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001922/*[clinic input]
1923_io.BufferedWriter.write
1924 buffer: Py_buffer
1925 /
1926[clinic start generated code]*/
1927
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001928static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001929_io_BufferedWriter_write_impl(buffered *self, Py_buffer *buffer)
1930/*[clinic end generated code: output=7f8d1365759bfc6b input=dd87dd85fc7f8850]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001931{
1932 PyObject *res = NULL;
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00001933 Py_ssize_t written, avail, remaining;
1934 Py_off_t offset;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001935
1936 CHECK_INITIALIZED(self)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001937 if (IS_CLOSED(self)) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001938 PyErr_SetString(PyExc_ValueError, "write to closed file");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001939 return NULL;
1940 }
1941
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001942 if (!ENTER_BUFFERED(self))
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001943 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001944
1945 /* Fast path: the data to write can be fully buffered. */
1946 if (!VALID_READ_BUFFER(self) && !VALID_WRITE_BUFFER(self)) {
1947 self->pos = 0;
1948 self->raw_pos = 0;
1949 }
1950 avail = Py_SAFE_DOWNCAST(self->buffer_size - self->pos, Py_off_t, Py_ssize_t);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001951 if (buffer->len <= avail) {
1952 memcpy(self->buffer + self->pos, buffer->buf, buffer->len);
Antoine Pitrou7c404892011-05-13 00:13:33 +02001953 if (!VALID_WRITE_BUFFER(self) || self->write_pos > self->pos) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001954 self->write_pos = self->pos;
1955 }
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001956 ADJUST_POSITION(self, self->pos + buffer->len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001957 if (self->pos > self->write_end)
1958 self->write_end = self->pos;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001959 written = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001960 goto end;
1961 }
1962
1963 /* First write the current buffer */
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001964 res = _bufferedwriter_flush_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001965 if (res == NULL) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001966 Py_ssize_t *w = _buffered_check_blocking_error();
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001967 if (w == NULL)
1968 goto error;
1969 if (self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001970 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001971 /* Make some place by shifting the buffer. */
1972 assert(VALID_WRITE_BUFFER(self));
1973 memmove(self->buffer, self->buffer + self->write_pos,
1974 Py_SAFE_DOWNCAST(self->write_end - self->write_pos,
1975 Py_off_t, Py_ssize_t));
1976 self->write_end -= self->write_pos;
1977 self->raw_pos -= self->write_pos;
1978 self->pos -= self->write_pos;
1979 self->write_pos = 0;
1980 avail = Py_SAFE_DOWNCAST(self->buffer_size - self->write_end,
1981 Py_off_t, Py_ssize_t);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001982 if (buffer->len <= avail) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001983 /* Everything can be buffered */
1984 PyErr_Clear();
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001985 memcpy(self->buffer + self->write_end, buffer->buf, buffer->len);
1986 self->write_end += buffer->len;
1987 self->pos += buffer->len;
1988 written = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001989 goto end;
1990 }
1991 /* Buffer as much as possible. */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001992 memcpy(self->buffer + self->write_end, buffer->buf, avail);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001993 self->write_end += avail;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001994 self->pos += avail;
1995 /* XXX Modifying the existing exception e using the pointer w
1996 will change e.characters_written but not e.args[2].
1997 Therefore we just replace with a new error. */
1998 _set_BlockingIOError("write could not complete without blocking",
1999 avail);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002000 goto error;
2001 }
2002 Py_CLEAR(res);
2003
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002004 /* Adjust the raw stream position if it is away from the logical stream
2005 position. This happens if the read buffer has been filled but not
2006 modified (and therefore _bufferedwriter_flush_unlocked() didn't rewind
2007 the raw stream by itself).
2008 Fixes issue #6629.
2009 */
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002010 offset = RAW_OFFSET(self);
2011 if (offset != 0) {
2012 if (_buffered_raw_seek(self, -offset, 1) < 0)
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002013 goto error;
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002014 self->raw_pos -= offset;
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002015 }
2016
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002017 /* Then write buf itself. At this point the buffer has been emptied. */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002018 remaining = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002019 written = 0;
2020 while (remaining > self->buffer_size) {
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002021 Py_ssize_t n = _bufferedwriter_raw_write(
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002022 self, (char *) buffer->buf + written, buffer->len - written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002023 if (n == -1) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002024 goto error;
2025 } else if (n == -2) {
2026 /* Write failed because raw file is non-blocking */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002027 if (remaining > self->buffer_size) {
2028 /* Can't buffer everything, still buffer as much as possible */
2029 memcpy(self->buffer,
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002030 (char *) buffer->buf + written, self->buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002031 self->raw_pos = 0;
2032 ADJUST_POSITION(self, self->buffer_size);
2033 self->write_end = self->buffer_size;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002034 written += self->buffer_size;
2035 _set_BlockingIOError("write could not complete without "
2036 "blocking", written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002037 goto error;
2038 }
2039 PyErr_Clear();
2040 break;
2041 }
2042 written += n;
2043 remaining -= n;
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002044 /* Partial writes can return successfully when interrupted by a
2045 signal (see write(2)). We must run signal handlers before
2046 blocking another time, possibly indefinitely. */
2047 if (PyErr_CheckSignals() < 0)
2048 goto error;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002049 }
2050 if (self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002051 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002052 if (remaining > 0) {
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002053 memcpy(self->buffer, (char *) buffer->buf + written, remaining);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002054 written += remaining;
2055 }
2056 self->write_pos = 0;
2057 /* TODO: sanity check (remaining >= 0) */
2058 self->write_end = remaining;
2059 ADJUST_POSITION(self, remaining);
2060 self->raw_pos = 0;
2061
2062end:
2063 res = PyLong_FromSsize_t(written);
2064
2065error:
2066 LEAVE_BUFFERED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002067 return res;
2068}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002069
2070
2071
2072/*
2073 * BufferedRWPair
2074 */
2075
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002076/* XXX The usefulness of this (compared to having two separate IO objects) is
2077 * questionable.
2078 */
2079
2080typedef struct {
2081 PyObject_HEAD
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002082 buffered *reader;
2083 buffered *writer;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002084 PyObject *dict;
2085 PyObject *weakreflist;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002086} rwpair;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002087
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002088/*[clinic input]
2089_io.BufferedRWPair.__init__
2090 reader: object
2091 writer: object
2092 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
2093 /
2094
2095A buffered reader and writer object together.
2096
2097A buffered reader object and buffered writer object put together to
2098form a sequential IO object that can read and write. This is typically
2099used with a socket or two-way pipe.
2100
2101reader and writer are RawIOBase objects that are readable and
2102writeable respectively. If the buffer_size is omitted it defaults to
2103DEFAULT_BUFFER_SIZE.
2104[clinic start generated code]*/
2105
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002106static int
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002107_io_BufferedRWPair___init___impl(rwpair *self, PyObject *reader,
2108 PyObject *writer, Py_ssize_t buffer_size)
2109/*[clinic end generated code: output=327e73d1aee8f984 input=620d42d71f33a031]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002110{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002111 if (_PyIOBase_check_readable(reader, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002112 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002113 if (_PyIOBase_check_writable(writer, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002114 return -1;
2115
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002116 self->reader = (buffered *) PyObject_CallFunction(
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002117 (PyObject *) &PyBufferedReader_Type, "On", reader, buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002118 if (self->reader == NULL)
2119 return -1;
2120
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002121 self->writer = (buffered *) PyObject_CallFunction(
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002122 (PyObject *) &PyBufferedWriter_Type, "On", writer, buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002123 if (self->writer == NULL) {
2124 Py_CLEAR(self->reader);
2125 return -1;
2126 }
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002127
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002128 return 0;
2129}
2130
2131static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002132bufferedrwpair_traverse(rwpair *self, visitproc visit, void *arg)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002133{
2134 Py_VISIT(self->dict);
2135 return 0;
2136}
2137
2138static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002139bufferedrwpair_clear(rwpair *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002140{
2141 Py_CLEAR(self->reader);
2142 Py_CLEAR(self->writer);
2143 Py_CLEAR(self->dict);
2144 return 0;
2145}
2146
2147static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002148bufferedrwpair_dealloc(rwpair *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002149{
2150 _PyObject_GC_UNTRACK(self);
Benjamin Petersonbbd0a322014-09-29 22:46:57 -04002151 if (self->weakreflist != NULL)
2152 PyObject_ClearWeakRefs((PyObject *)self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002153 Py_CLEAR(self->reader);
2154 Py_CLEAR(self->writer);
2155 Py_CLEAR(self->dict);
2156 Py_TYPE(self)->tp_free((PyObject *) self);
2157}
2158
2159static PyObject *
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002160_forward_call(buffered *self, _Py_Identifier *name, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002161{
Serhiy Storchaka61e24932014-02-12 10:52:35 +02002162 PyObject *func, *ret;
2163 if (self == NULL) {
2164 PyErr_SetString(PyExc_ValueError,
2165 "I/O operation on uninitialized object");
2166 return NULL;
2167 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002168
Serhiy Storchaka61e24932014-02-12 10:52:35 +02002169 func = _PyObject_GetAttrId((PyObject *)self, name);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002170 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002171 PyErr_SetString(PyExc_AttributeError, name->string);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002172 return NULL;
2173 }
2174
2175 ret = PyObject_CallObject(func, args);
2176 Py_DECREF(func);
2177 return ret;
2178}
2179
2180static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002181bufferedrwpair_read(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002182{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002183 return _forward_call(self->reader, &PyId_read, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002184}
2185
2186static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002187bufferedrwpair_peek(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002188{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002189 return _forward_call(self->reader, &PyId_peek, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002190}
2191
2192static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002193bufferedrwpair_read1(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002194{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002195 return _forward_call(self->reader, &PyId_read1, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002196}
2197
2198static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002199bufferedrwpair_readinto(rwpair *self, PyObject *args)
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002200{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002201 return _forward_call(self->reader, &PyId_readinto, args);
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002202}
2203
2204static PyObject *
Benjamin Petersona96fea02014-06-22 14:17:44 -07002205bufferedrwpair_readinto1(rwpair *self, PyObject *args)
2206{
2207 return _forward_call(self->reader, &PyId_readinto1, args);
2208}
2209
2210static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002211bufferedrwpair_write(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002212{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002213 return _forward_call(self->writer, &PyId_write, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002214}
2215
2216static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002217bufferedrwpair_flush(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002218{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002219 return _forward_call(self->writer, &PyId_flush, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002220}
2221
2222static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002223bufferedrwpair_readable(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002224{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002225 return _forward_call(self->reader, &PyId_readable, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002226}
2227
2228static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002229bufferedrwpair_writable(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002230{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002231 return _forward_call(self->writer, &PyId_writable, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002232}
2233
2234static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002235bufferedrwpair_close(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002236{
Serhiy Storchaka7665be62015-03-24 23:21:57 +02002237 PyObject *exc = NULL, *val, *tb;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002238 PyObject *ret = _forward_call(self->writer, &PyId_close, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002239 if (ret == NULL)
Serhiy Storchaka7665be62015-03-24 23:21:57 +02002240 PyErr_Fetch(&exc, &val, &tb);
2241 else
2242 Py_DECREF(ret);
2243 ret = _forward_call(self->reader, &PyId_close, args);
2244 if (exc != NULL) {
2245 _PyErr_ChainExceptions(exc, val, tb);
2246 Py_CLEAR(ret);
2247 }
2248 return ret;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002249}
2250
2251static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002252bufferedrwpair_isatty(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002253{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002254 PyObject *ret = _forward_call(self->writer, &PyId_isatty, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002255
2256 if (ret != Py_False) {
2257 /* either True or exception */
2258 return ret;
2259 }
2260 Py_DECREF(ret);
2261
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002262 return _forward_call(self->reader, &PyId_isatty, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002263}
2264
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002265static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002266bufferedrwpair_closed_get(rwpair *self, void *context)
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002267{
Charles-François Natali42c28cd2011-10-05 19:53:43 +02002268 if (self->writer == NULL) {
2269 PyErr_SetString(PyExc_RuntimeError,
2270 "the BufferedRWPair object is being garbage-collected");
2271 return NULL;
2272 }
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002273 return PyObject_GetAttr((PyObject *) self->writer, _PyIO_str_closed);
2274}
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002275
2276
2277
2278/*
2279 * BufferedRandom
2280 */
2281
2282/*[clinic input]
2283_io.BufferedRandom.__init__
2284 raw: object
2285 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
2286
2287A buffered interface to random access streams.
2288
2289The constructor creates a reader and writer for a seekable stream,
2290raw, given in the first argument. If the buffer_size is omitted it
2291defaults to DEFAULT_BUFFER_SIZE.
2292[clinic start generated code]*/
2293
2294static int
2295_io_BufferedRandom___init___impl(buffered *self, PyObject *raw,
2296 Py_ssize_t buffer_size)
2297/*[clinic end generated code: output=d3d64eb0f64e64a3 input=a4e818fb86d0e50c]*/
2298{
2299 self->ok = 0;
2300 self->detached = 0;
2301
2302 if (_PyIOBase_check_seekable(raw, Py_True) == NULL)
2303 return -1;
2304 if (_PyIOBase_check_readable(raw, Py_True) == NULL)
2305 return -1;
2306 if (_PyIOBase_check_writable(raw, Py_True) == NULL)
2307 return -1;
2308
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002309 Py_INCREF(raw);
Serhiy Storchaka4a1e70f2015-12-27 12:36:18 +02002310 Py_SETREF(self->raw, raw);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002311 self->buffer_size = buffer_size;
2312 self->readable = 1;
2313 self->writable = 1;
2314
2315 if (_buffered_init(self) < 0)
2316 return -1;
2317 _bufferedreader_reset_buf(self);
2318 _bufferedwriter_reset_buf(self);
2319 self->pos = 0;
2320
2321 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedRandom_Type &&
2322 Py_TYPE(raw) == &PyFileIO_Type);
2323
2324 self->ok = 1;
2325 return 0;
2326}
2327
2328#include "clinic/bufferedio.c.h"
2329
2330
2331static PyMethodDef bufferediobase_methods[] = {
2332 _IO__BUFFEREDIOBASE_DETACH_METHODDEF
2333 {"read", bufferediobase_read, METH_VARARGS, bufferediobase_read_doc},
2334 {"read1", bufferediobase_read1, METH_VARARGS, bufferediobase_read1_doc},
2335 _IO__BUFFEREDIOBASE_READINTO_METHODDEF
2336 _IO__BUFFEREDIOBASE_READINTO1_METHODDEF
2337 {"write", bufferediobase_write, METH_VARARGS, bufferediobase_write_doc},
2338 {NULL, NULL}
2339};
2340
2341PyTypeObject PyBufferedIOBase_Type = {
2342 PyVarObject_HEAD_INIT(NULL, 0)
2343 "_io._BufferedIOBase", /*tp_name*/
2344 0, /*tp_basicsize*/
2345 0, /*tp_itemsize*/
2346 0, /*tp_dealloc*/
2347 0, /*tp_print*/
2348 0, /*tp_getattr*/
2349 0, /*tp_setattr*/
2350 0, /*tp_compare */
2351 0, /*tp_repr*/
2352 0, /*tp_as_number*/
2353 0, /*tp_as_sequence*/
2354 0, /*tp_as_mapping*/
2355 0, /*tp_hash */
2356 0, /*tp_call*/
2357 0, /*tp_str*/
2358 0, /*tp_getattro*/
2359 0, /*tp_setattro*/
2360 0, /*tp_as_buffer*/
2361 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2362 | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2363 bufferediobase_doc, /* tp_doc */
2364 0, /* tp_traverse */
2365 0, /* tp_clear */
2366 0, /* tp_richcompare */
2367 0, /* tp_weaklistoffset */
2368 0, /* tp_iter */
2369 0, /* tp_iternext */
2370 bufferediobase_methods, /* tp_methods */
2371 0, /* tp_members */
2372 0, /* tp_getset */
2373 &PyIOBase_Type, /* tp_base */
2374 0, /* tp_dict */
2375 0, /* tp_descr_get */
2376 0, /* tp_descr_set */
2377 0, /* tp_dictoffset */
2378 0, /* tp_init */
2379 0, /* tp_alloc */
2380 0, /* tp_new */
2381 0, /* tp_free */
2382 0, /* tp_is_gc */
2383 0, /* tp_bases */
2384 0, /* tp_mro */
2385 0, /* tp_cache */
2386 0, /* tp_subclasses */
2387 0, /* tp_weaklist */
2388 0, /* tp_del */
2389 0, /* tp_version_tag */
2390 0, /* tp_finalize */
2391};
2392
2393
2394static PyMethodDef bufferedreader_methods[] = {
2395 /* BufferedIOMixin methods */
2396 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2397 {"flush", (PyCFunction)buffered_simple_flush, METH_NOARGS},
2398 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2399 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2400 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
2401 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2402 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2403 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
2404 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
2405 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2406
2407 _IO__BUFFERED_READ_METHODDEF
2408 _IO__BUFFERED_PEEK_METHODDEF
2409 _IO__BUFFERED_READ1_METHODDEF
2410 _IO__BUFFERED_READINTO_METHODDEF
2411 _IO__BUFFERED_READINTO1_METHODDEF
2412 _IO__BUFFERED_READLINE_METHODDEF
2413 _IO__BUFFERED_SEEK_METHODDEF
2414 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
2415 _IO__BUFFERED_TRUNCATE_METHODDEF
2416 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
2417 {NULL, NULL}
2418};
2419
2420static PyMemberDef bufferedreader_members[] = {
2421 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
2422 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
2423 {NULL}
2424};
2425
2426static PyGetSetDef bufferedreader_getset[] = {
2427 {"closed", (getter)buffered_closed_get, NULL, NULL},
2428 {"name", (getter)buffered_name_get, NULL, NULL},
2429 {"mode", (getter)buffered_mode_get, NULL, NULL},
2430 {NULL}
2431};
2432
2433
2434PyTypeObject PyBufferedReader_Type = {
2435 PyVarObject_HEAD_INIT(NULL, 0)
2436 "_io.BufferedReader", /*tp_name*/
2437 sizeof(buffered), /*tp_basicsize*/
2438 0, /*tp_itemsize*/
2439 (destructor)buffered_dealloc, /*tp_dealloc*/
2440 0, /*tp_print*/
2441 0, /*tp_getattr*/
2442 0, /*tp_setattr*/
2443 0, /*tp_compare */
2444 (reprfunc)buffered_repr, /*tp_repr*/
2445 0, /*tp_as_number*/
2446 0, /*tp_as_sequence*/
2447 0, /*tp_as_mapping*/
2448 0, /*tp_hash */
2449 0, /*tp_call*/
2450 0, /*tp_str*/
2451 0, /*tp_getattro*/
2452 0, /*tp_setattro*/
2453 0, /*tp_as_buffer*/
2454 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2455 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2456 _io_BufferedReader___init____doc__, /* tp_doc */
2457 (traverseproc)buffered_traverse, /* tp_traverse */
2458 (inquiry)buffered_clear, /* tp_clear */
2459 0, /* tp_richcompare */
2460 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
2461 0, /* tp_iter */
2462 (iternextfunc)buffered_iternext, /* tp_iternext */
2463 bufferedreader_methods, /* tp_methods */
2464 bufferedreader_members, /* tp_members */
2465 bufferedreader_getset, /* tp_getset */
2466 0, /* tp_base */
2467 0, /* tp_dict */
2468 0, /* tp_descr_get */
2469 0, /* tp_descr_set */
2470 offsetof(buffered, dict), /* tp_dictoffset */
2471 _io_BufferedReader___init__, /* tp_init */
2472 0, /* tp_alloc */
2473 PyType_GenericNew, /* tp_new */
2474 0, /* tp_free */
2475 0, /* tp_is_gc */
2476 0, /* tp_bases */
2477 0, /* tp_mro */
2478 0, /* tp_cache */
2479 0, /* tp_subclasses */
2480 0, /* tp_weaklist */
2481 0, /* tp_del */
2482 0, /* tp_version_tag */
2483 0, /* tp_finalize */
2484};
2485
2486
2487static PyMethodDef bufferedwriter_methods[] = {
2488 /* BufferedIOMixin methods */
2489 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2490 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2491 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2492 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
2493 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2494 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2495 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
2496 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
2497 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2498
2499 _IO_BUFFEREDWRITER_WRITE_METHODDEF
2500 _IO__BUFFERED_TRUNCATE_METHODDEF
2501 {"flush", (PyCFunction)buffered_flush, METH_NOARGS},
2502 _IO__BUFFERED_SEEK_METHODDEF
2503 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
2504 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
2505 {NULL, NULL}
2506};
2507
2508static PyMemberDef bufferedwriter_members[] = {
2509 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
2510 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
2511 {NULL}
2512};
2513
2514static PyGetSetDef bufferedwriter_getset[] = {
2515 {"closed", (getter)buffered_closed_get, NULL, NULL},
2516 {"name", (getter)buffered_name_get, NULL, NULL},
2517 {"mode", (getter)buffered_mode_get, NULL, NULL},
2518 {NULL}
2519};
2520
2521
2522PyTypeObject PyBufferedWriter_Type = {
2523 PyVarObject_HEAD_INIT(NULL, 0)
2524 "_io.BufferedWriter", /*tp_name*/
2525 sizeof(buffered), /*tp_basicsize*/
2526 0, /*tp_itemsize*/
2527 (destructor)buffered_dealloc, /*tp_dealloc*/
2528 0, /*tp_print*/
2529 0, /*tp_getattr*/
2530 0, /*tp_setattr*/
2531 0, /*tp_compare */
2532 (reprfunc)buffered_repr, /*tp_repr*/
2533 0, /*tp_as_number*/
2534 0, /*tp_as_sequence*/
2535 0, /*tp_as_mapping*/
2536 0, /*tp_hash */
2537 0, /*tp_call*/
2538 0, /*tp_str*/
2539 0, /*tp_getattro*/
2540 0, /*tp_setattro*/
2541 0, /*tp_as_buffer*/
2542 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2543 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2544 _io_BufferedWriter___init____doc__, /* tp_doc */
2545 (traverseproc)buffered_traverse, /* tp_traverse */
2546 (inquiry)buffered_clear, /* tp_clear */
2547 0, /* tp_richcompare */
2548 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
2549 0, /* tp_iter */
2550 0, /* tp_iternext */
2551 bufferedwriter_methods, /* tp_methods */
2552 bufferedwriter_members, /* tp_members */
2553 bufferedwriter_getset, /* tp_getset */
2554 0, /* tp_base */
2555 0, /* tp_dict */
2556 0, /* tp_descr_get */
2557 0, /* tp_descr_set */
2558 offsetof(buffered, dict), /* tp_dictoffset */
2559 _io_BufferedWriter___init__, /* tp_init */
2560 0, /* tp_alloc */
2561 PyType_GenericNew, /* tp_new */
2562 0, /* tp_free */
2563 0, /* tp_is_gc */
2564 0, /* tp_bases */
2565 0, /* tp_mro */
2566 0, /* tp_cache */
2567 0, /* tp_subclasses */
2568 0, /* tp_weaklist */
2569 0, /* tp_del */
2570 0, /* tp_version_tag */
2571 0, /* tp_finalize */
2572};
2573
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002574
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002575static PyMethodDef bufferedrwpair_methods[] = {
2576 {"read", (PyCFunction)bufferedrwpair_read, METH_VARARGS},
2577 {"peek", (PyCFunction)bufferedrwpair_peek, METH_VARARGS},
2578 {"read1", (PyCFunction)bufferedrwpair_read1, METH_VARARGS},
2579 {"readinto", (PyCFunction)bufferedrwpair_readinto, METH_VARARGS},
Benjamin Petersona96fea02014-06-22 14:17:44 -07002580 {"readinto1", (PyCFunction)bufferedrwpair_readinto1, METH_VARARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002581
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002582 {"write", (PyCFunction)bufferedrwpair_write, METH_VARARGS},
2583 {"flush", (PyCFunction)bufferedrwpair_flush, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002584
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002585 {"readable", (PyCFunction)bufferedrwpair_readable, METH_NOARGS},
2586 {"writable", (PyCFunction)bufferedrwpair_writable, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002587
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002588 {"close", (PyCFunction)bufferedrwpair_close, METH_NOARGS},
2589 {"isatty", (PyCFunction)bufferedrwpair_isatty, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002590
Antoine Pitrou243757e2010-11-05 21:15:39 +00002591 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2592
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002593 {NULL, NULL}
2594};
2595
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002596static PyGetSetDef bufferedrwpair_getset[] = {
2597 {"closed", (getter)bufferedrwpair_closed_get, NULL, NULL},
Benjamin Peterson1fea3212009-04-19 03:15:20 +00002598 {NULL}
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002599};
2600
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002601PyTypeObject PyBufferedRWPair_Type = {
2602 PyVarObject_HEAD_INIT(NULL, 0)
2603 "_io.BufferedRWPair", /*tp_name*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002604 sizeof(rwpair), /*tp_basicsize*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002605 0, /*tp_itemsize*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002606 (destructor)bufferedrwpair_dealloc, /*tp_dealloc*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002607 0, /*tp_print*/
2608 0, /*tp_getattr*/
2609 0, /*tp_setattr*/
2610 0, /*tp_compare */
2611 0, /*tp_repr*/
2612 0, /*tp_as_number*/
2613 0, /*tp_as_sequence*/
2614 0, /*tp_as_mapping*/
2615 0, /*tp_hash */
2616 0, /*tp_call*/
2617 0, /*tp_str*/
2618 0, /*tp_getattro*/
2619 0, /*tp_setattro*/
2620 0, /*tp_as_buffer*/
2621 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
Antoine Pitrou796564c2013-07-30 19:59:21 +02002622 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /* tp_flags */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002623 _io_BufferedRWPair___init____doc__, /* tp_doc */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002624 (traverseproc)bufferedrwpair_traverse, /* tp_traverse */
2625 (inquiry)bufferedrwpair_clear, /* tp_clear */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002626 0, /* tp_richcompare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002627 offsetof(rwpair, weakreflist), /*tp_weaklistoffset*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002628 0, /* tp_iter */
2629 0, /* tp_iternext */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002630 bufferedrwpair_methods, /* tp_methods */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002631 0, /* tp_members */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002632 bufferedrwpair_getset, /* tp_getset */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002633 0, /* tp_base */
2634 0, /* tp_dict */
2635 0, /* tp_descr_get */
2636 0, /* tp_descr_set */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002637 offsetof(rwpair, dict), /* tp_dictoffset */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002638 _io_BufferedRWPair___init__, /* tp_init */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002639 0, /* tp_alloc */
2640 PyType_GenericNew, /* tp_new */
Antoine Pitrou796564c2013-07-30 19:59:21 +02002641 0, /* tp_free */
2642 0, /* tp_is_gc */
2643 0, /* tp_bases */
2644 0, /* tp_mro */
2645 0, /* tp_cache */
2646 0, /* tp_subclasses */
2647 0, /* tp_weaklist */
2648 0, /* tp_del */
2649 0, /* tp_version_tag */
2650 0, /* tp_finalize */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002651};
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002652
2653
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002654static PyMethodDef bufferedrandom_methods[] = {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002655 /* BufferedIOMixin methods */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002656 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2657 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2658 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2659 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
2660 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2661 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2662 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
Antoine Pitroue033e062010-10-29 10:38:18 +00002663 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
Antoine Pitrou243757e2010-11-05 21:15:39 +00002664 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002665
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002666 {"flush", (PyCFunction)buffered_flush, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002667
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002668 _IO__BUFFERED_SEEK_METHODDEF
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002669 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002670 _IO__BUFFERED_TRUNCATE_METHODDEF
2671 _IO__BUFFERED_READ_METHODDEF
2672 _IO__BUFFERED_READ1_METHODDEF
2673 _IO__BUFFERED_READINTO_METHODDEF
2674 _IO__BUFFERED_READINTO1_METHODDEF
2675 _IO__BUFFERED_READLINE_METHODDEF
2676 _IO__BUFFERED_PEEK_METHODDEF
2677 _IO_BUFFEREDWRITER_WRITE_METHODDEF
Antoine Pitrou10f0c502012-07-29 19:02:46 +02002678 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002679 {NULL, NULL}
2680};
2681
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002682static PyMemberDef bufferedrandom_members[] = {
Antoine Pitrou7f8f4182010-12-21 21:20:59 +00002683 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
Antoine Pitrou796564c2013-07-30 19:59:21 +02002684 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002685 {NULL}
2686};
2687
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002688static PyGetSetDef bufferedrandom_getset[] = {
2689 {"closed", (getter)buffered_closed_get, NULL, NULL},
2690 {"name", (getter)buffered_name_get, NULL, NULL},
2691 {"mode", (getter)buffered_mode_get, NULL, NULL},
Benjamin Peterson1fea3212009-04-19 03:15:20 +00002692 {NULL}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002693};
2694
2695
2696PyTypeObject PyBufferedRandom_Type = {
2697 PyVarObject_HEAD_INIT(NULL, 0)
2698 "_io.BufferedRandom", /*tp_name*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002699 sizeof(buffered), /*tp_basicsize*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002700 0, /*tp_itemsize*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002701 (destructor)buffered_dealloc, /*tp_dealloc*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002702 0, /*tp_print*/
2703 0, /*tp_getattr*/
2704 0, /*tp_setattr*/
2705 0, /*tp_compare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002706 (reprfunc)buffered_repr, /*tp_repr*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002707 0, /*tp_as_number*/
2708 0, /*tp_as_sequence*/
2709 0, /*tp_as_mapping*/
2710 0, /*tp_hash */
2711 0, /*tp_call*/
2712 0, /*tp_str*/
2713 0, /*tp_getattro*/
2714 0, /*tp_setattro*/
2715 0, /*tp_as_buffer*/
2716 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
Antoine Pitrou796564c2013-07-30 19:59:21 +02002717 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002718 _io_BufferedRandom___init____doc__, /* tp_doc */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002719 (traverseproc)buffered_traverse, /* tp_traverse */
2720 (inquiry)buffered_clear, /* tp_clear */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002721 0, /* tp_richcompare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002722 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002723 0, /* tp_iter */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002724 (iternextfunc)buffered_iternext, /* tp_iternext */
2725 bufferedrandom_methods, /* tp_methods */
2726 bufferedrandom_members, /* tp_members */
2727 bufferedrandom_getset, /* tp_getset */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002728 0, /* tp_base */
2729 0, /*tp_dict*/
2730 0, /* tp_descr_get */
2731 0, /* tp_descr_set */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002732 offsetof(buffered, dict), /*tp_dictoffset*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002733 _io_BufferedRandom___init__, /* tp_init */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002734 0, /* tp_alloc */
2735 PyType_GenericNew, /* tp_new */
Antoine Pitrou796564c2013-07-30 19:59:21 +02002736 0, /* tp_free */
2737 0, /* tp_is_gc */
2738 0, /* tp_bases */
2739 0, /* tp_mro */
2740 0, /* tp_cache */
2741 0, /* tp_subclasses */
2742 0, /* tp_weaklist */
2743 0, /* tp_del */
2744 0, /* tp_version_tag */
2745 0, /* tp_finalize */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002746};