blob: 2c9064855a6d63e4eaf3e2bc3ca527b0562d124b [file] [log] [blame]
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001/*
2 An implementation of Buffered I/O as defined by PEP 3116 - "New I/O"
Antoine Pitrou3486a982011-05-12 01:57:53 +02003
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00004 Classes defined here: BufferedIOBase, BufferedReader, BufferedWriter,
5 BufferedRandom.
Antoine Pitrou3486a982011-05-12 01:57:53 +02006
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00007 Written by Amaury Forgeot d'Arc and Antoine Pitrou
8*/
9
10#define PY_SSIZE_T_CLEAN
11#include "Python.h"
12#include "structmember.h"
13#include "pythread.h"
14#include "_iomodule.h"
15
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030016/*[clinic input]
17module _io
18class _io._BufferedIOBase "PyObject *" "&PyBufferedIOBase_Type"
19class _io._Buffered "buffered *" "&PyBufferedIOBase_Type"
20class _io.BufferedReader "buffered *" "&PyBufferedReader_Type"
21class _io.BufferedWriter "buffered *" "&PyBufferedWriter_Type"
22class _io.BufferedRWPair "rwpair *" "&PyBufferedRWPair_Type"
23class _io.BufferedRandom "buffered *" "&PyBufferedRandom_Type"
24[clinic start generated code]*/
25/*[clinic end generated code: output=da39a3ee5e6b4b0d input=59460b9c5639984d]*/
26
27/*[python input]
28class io_ssize_t_converter(CConverter):
29 type = 'Py_ssize_t'
30 converter = '_PyIO_ConvertSsize_t'
31[python start generated code]*/
32/*[python end generated code: output=da39a3ee5e6b4b0d input=d0a811d3cbfd1b33]*/
33
Martin v. Löwisbd928fe2011-10-14 10:20:37 +020034_Py_IDENTIFIER(close);
35_Py_IDENTIFIER(_dealloc_warn);
36_Py_IDENTIFIER(flush);
37_Py_IDENTIFIER(isatty);
Martin v. Löwis767046a2011-10-14 15:35:36 +020038_Py_IDENTIFIER(mode);
39_Py_IDENTIFIER(name);
Martin v. Löwisbd928fe2011-10-14 10:20:37 +020040_Py_IDENTIFIER(peek);
41_Py_IDENTIFIER(read);
42_Py_IDENTIFIER(read1);
43_Py_IDENTIFIER(readable);
44_Py_IDENTIFIER(readinto);
Benjamin Petersona96fea02014-06-22 14:17:44 -070045_Py_IDENTIFIER(readinto1);
Martin v. Löwisbd928fe2011-10-14 10:20:37 +020046_Py_IDENTIFIER(writable);
47_Py_IDENTIFIER(write);
Martin v. Löwisafe55bb2011-10-09 10:38:36 +020048
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000049/*
50 * BufferedIOBase class, inherits from IOBase.
51 */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +000052PyDoc_STRVAR(bufferediobase_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000053 "Base class for buffered IO objects.\n"
54 "\n"
55 "The main difference with RawIOBase is that the read() method\n"
56 "supports omitting the size argument, and does not have a default\n"
57 "implementation that defers to readinto().\n"
58 "\n"
59 "In addition, read(), readinto() and write() may raise\n"
60 "BlockingIOError if the underlying raw stream is in non-blocking\n"
61 "mode and not ready; unlike their raw counterparts, they will never\n"
62 "return None.\n"
63 "\n"
64 "A typical implementation should not inherit from a RawIOBase\n"
65 "implementation, but wrap one.\n"
66 );
67
68static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030069_bufferediobase_readinto_generic(PyObject *self, Py_buffer *buffer, char readinto1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000070{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000071 Py_ssize_t len;
72 PyObject *data;
73
Benjamin Petersona96fea02014-06-22 14:17:44 -070074 data = _PyObject_CallMethodId(self,
75 readinto1 ? &PyId_read1 : &PyId_read,
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030076 "n", buffer->len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000077 if (data == NULL)
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030078 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000079
80 if (!PyBytes_Check(data)) {
81 Py_DECREF(data);
82 PyErr_SetString(PyExc_TypeError, "read() should return bytes");
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030083 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000084 }
85
86 len = Py_SIZE(data);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030087 if (len > buffer->len) {
Serhiy Storchaka37a79a12013-05-28 16:24:45 +030088 PyErr_Format(PyExc_ValueError,
89 "read() returned too much data: "
90 "%zd bytes requested, %zd returned",
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030091 buffer->len, len);
Serhiy Storchaka37a79a12013-05-28 16:24:45 +030092 Py_DECREF(data);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030093 return NULL;
Serhiy Storchaka37a79a12013-05-28 16:24:45 +030094 }
Serhiy Storchakaf24131f2015-04-16 11:19:43 +030095 memcpy(buffer->buf, PyBytes_AS_STRING(data), len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000096
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +000097 Py_DECREF(data);
98
99 return PyLong_FromSsize_t(len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000100}
101
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300102/*[clinic input]
103_io._BufferedIOBase.readinto
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700104 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300105 /
106[clinic start generated code]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -0700107
108static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300109_io__BufferedIOBase_readinto_impl(PyObject *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700110/*[clinic end generated code: output=8c8cda6684af8038 input=00a6b9a38f29830a]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -0700111{
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300112 return _bufferediobase_readinto_generic(self, buffer, 0);
113}
114
115/*[clinic input]
116_io._BufferedIOBase.readinto1
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700117 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300118 /
119[clinic start generated code]*/
120
121static PyObject *
122_io__BufferedIOBase_readinto1_impl(PyObject *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -0700123/*[clinic end generated code: output=358623e4fd2b69d3 input=ebad75b4aadfb9be]*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300124{
125 return _bufferediobase_readinto_generic(self, buffer, 1);
Benjamin Petersona96fea02014-06-22 14:17:44 -0700126}
127
128static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000129bufferediobase_unsupported(const char *message)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000130{
Antoine Pitrou712cb732013-12-21 15:51:54 +0100131 _PyIO_State *state = IO_STATE();
132 if (state != NULL)
133 PyErr_SetString(state->unsupported_operation, message);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000134 return NULL;
135}
136
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300137/*[clinic input]
138_io._BufferedIOBase.detach
139
140Disconnect this buffer from its underlying raw stream and return it.
141
142After the raw stream has been detached, the buffer is in an unusable
143state.
144[clinic start generated code]*/
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000145
146static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300147_io__BufferedIOBase_detach_impl(PyObject *self)
148/*[clinic end generated code: output=754977c8d10ed88c input=822427fb58fe4169]*/
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000149{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000150 return bufferediobase_unsupported("detach");
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000151}
152
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000153PyDoc_STRVAR(bufferediobase_read_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000154 "Read and return up to n bytes.\n"
155 "\n"
156 "If the argument is omitted, None, or negative, reads and\n"
157 "returns all data until EOF.\n"
158 "\n"
159 "If the argument is positive, and the underlying raw stream is\n"
160 "not 'interactive', multiple raw reads may be issued to satisfy\n"
161 "the byte count (unless EOF is reached first). But for\n"
162 "interactive raw streams (as well as sockets and pipes), at most\n"
163 "one raw read will be issued, and a short result does not imply\n"
164 "that EOF is imminent.\n"
165 "\n"
166 "Returns an empty bytes object on EOF.\n"
167 "\n"
168 "Returns None if the underlying raw stream was open in non-blocking\n"
169 "mode and no data is available at the moment.\n");
170
171static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000172bufferediobase_read(PyObject *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000173{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000174 return bufferediobase_unsupported("read");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000175}
176
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000177PyDoc_STRVAR(bufferediobase_read1_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000178 "Read and return up to n bytes, with at most one read() call\n"
179 "to the underlying raw stream. A short result does not imply\n"
180 "that EOF is imminent.\n"
181 "\n"
182 "Returns an empty bytes object on EOF.\n");
183
184static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000185bufferediobase_read1(PyObject *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000186{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000187 return bufferediobase_unsupported("read1");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000188}
189
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000190PyDoc_STRVAR(bufferediobase_write_doc,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000191 "Write the given buffer to the IO stream.\n"
192 "\n"
193 "Returns the number of bytes written, which is never less than\n"
194 "len(b).\n"
195 "\n"
196 "Raises BlockingIOError if the buffer is full and the\n"
197 "underlying raw stream cannot accept more data at the moment.\n");
198
199static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000200bufferediobase_write(PyObject *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000201{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000202 return bufferediobase_unsupported("write");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000203}
204
205
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000206typedef struct {
207 PyObject_HEAD
208
209 PyObject *raw;
210 int ok; /* Initialized? */
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000211 int detached;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000212 int readable;
213 int writable;
Antoine Pitrou796564c2013-07-30 19:59:21 +0200214 char finalizing;
Antoine Pitrou3486a982011-05-12 01:57:53 +0200215
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000216 /* True if this is a vanilla Buffered object (rather than a user derived
217 class) *and* the raw stream is a vanilla FileIO object. */
218 int fast_closed_checks;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000219
220 /* Absolute position inside the raw stream (-1 if unknown). */
221 Py_off_t abs_pos;
222
223 /* A static buffer of size `buffer_size` */
224 char *buffer;
225 /* Current logical position in the buffer. */
226 Py_off_t pos;
227 /* Position of the raw stream in the buffer. */
228 Py_off_t raw_pos;
229
230 /* Just after the last buffered byte in the buffer, or -1 if the buffer
231 isn't ready for reading. */
232 Py_off_t read_end;
233
234 /* Just after the last byte actually written */
235 Py_off_t write_pos;
236 /* Just after the last byte waiting to be written, or -1 if the buffer
237 isn't ready for writing. */
238 Py_off_t write_end;
239
Georg Brandldfd73442009-04-05 11:47:34 +0000240#ifdef WITH_THREAD
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000241 PyThread_type_lock lock;
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000242 volatile long owner;
Georg Brandldfd73442009-04-05 11:47:34 +0000243#endif
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000244
245 Py_ssize_t buffer_size;
246 Py_ssize_t buffer_mask;
247
248 PyObject *dict;
249 PyObject *weakreflist;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000250} buffered;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000251
252/*
253 Implementation notes:
Antoine Pitrou3486a982011-05-12 01:57:53 +0200254
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000255 * BufferedReader, BufferedWriter and BufferedRandom try to share most
256 methods (this is helped by the members `readable` and `writable`, which
257 are initialized in the respective constructors)
258 * They also share a single buffer for reading and writing. This enables
259 interleaved reads and writes without flushing. It also makes the logic
260 a bit trickier to get right.
261 * The absolute position of the raw stream is cached, if possible, in the
262 `abs_pos` member. It must be updated every time an operation is done
263 on the raw stream. If not sure, it can be reinitialized by calling
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000264 _buffered_raw_tell(), which queries the raw stream (_buffered_raw_seek()
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000265 also does it). To read it, use RAW_TELL().
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000266 * Three helpers, _bufferedreader_raw_read, _bufferedwriter_raw_write and
267 _bufferedwriter_flush_unlocked do a lot of useful housekeeping.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000268
269 NOTE: we should try to maintain block alignment of reads and writes to the
270 raw stream (according to the buffer size), but for now it is only done
271 in read() and friends.
Antoine Pitrou3486a982011-05-12 01:57:53 +0200272
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000273*/
274
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000275/* These macros protect the buffered object against concurrent operations. */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000276
Georg Brandldfd73442009-04-05 11:47:34 +0000277#ifdef WITH_THREAD
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000278
279static int
280_enter_buffered_busy(buffered *self)
281{
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200282 int relax_locking;
283 PyLockStatus st;
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000284 if (self->owner == PyThread_get_thread_ident()) {
285 PyErr_Format(PyExc_RuntimeError,
286 "reentrant call inside %R", self);
287 return 0;
Antoine Pitrou5800b272009-11-01 12:05:48 +0000288 }
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200289 relax_locking = (_Py_Finalizing != NULL);
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000290 Py_BEGIN_ALLOW_THREADS
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200291 if (!relax_locking)
292 st = PyThread_acquire_lock(self->lock, 1);
293 else {
294 /* When finalizing, we don't want a deadlock to happen with daemon
295 * threads abruptly shut down while they owned the lock.
296 * Therefore, only wait for a grace period (1 s.).
297 * Note that non-daemon threads have already exited here, so this
298 * shouldn't affect carefully written threaded I/O code.
299 */
300 st = PyThread_acquire_lock_timed(self->lock, 1e6, 0);
301 }
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000302 Py_END_ALLOW_THREADS
Antoine Pitrou25f85d42015-04-13 19:41:47 +0200303 if (relax_locking && st != PY_LOCK_ACQUIRED) {
304 PyObject *msgobj = PyUnicode_FromFormat(
305 "could not acquire lock for %A at interpreter "
306 "shutdown, possibly due to daemon threads",
307 (PyObject *) self);
308 char *msg = PyUnicode_AsUTF8(msgobj);
309 Py_FatalError(msg);
310 }
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000311 return 1;
312}
313
314#define ENTER_BUFFERED(self) \
315 ( (PyThread_acquire_lock(self->lock, 0) ? \
316 1 : _enter_buffered_busy(self)) \
317 && (self->owner = PyThread_get_thread_ident(), 1) )
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000318
319#define LEAVE_BUFFERED(self) \
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000320 do { \
321 self->owner = 0; \
322 PyThread_release_lock(self->lock); \
323 } while(0);
324
Georg Brandldfd73442009-04-05 11:47:34 +0000325#else
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000326#define ENTER_BUFFERED(self) 1
Georg Brandldfd73442009-04-05 11:47:34 +0000327#define LEAVE_BUFFERED(self)
328#endif
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000329
330#define CHECK_INITIALIZED(self) \
331 if (self->ok <= 0) { \
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000332 if (self->detached) { \
333 PyErr_SetString(PyExc_ValueError, \
334 "raw stream has been detached"); \
335 } else { \
336 PyErr_SetString(PyExc_ValueError, \
337 "I/O operation on uninitialized object"); \
338 } \
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000339 return NULL; \
340 }
341
342#define CHECK_INITIALIZED_INT(self) \
343 if (self->ok <= 0) { \
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000344 if (self->detached) { \
345 PyErr_SetString(PyExc_ValueError, \
346 "raw stream has been detached"); \
347 } else { \
348 PyErr_SetString(PyExc_ValueError, \
349 "I/O operation on uninitialized object"); \
350 } \
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000351 return -1; \
352 }
353
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000354#define IS_CLOSED(self) \
355 (self->fast_closed_checks \
356 ? _PyFileIO_closed(self->raw) \
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000357 : buffered_closed(self))
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000358
359#define CHECK_CLOSED(self, error_msg) \
360 if (IS_CLOSED(self)) { \
361 PyErr_SetString(PyExc_ValueError, error_msg); \
362 return NULL; \
363 }
364
365
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000366#define VALID_READ_BUFFER(self) \
367 (self->readable && self->read_end != -1)
368
369#define VALID_WRITE_BUFFER(self) \
370 (self->writable && self->write_end != -1)
371
372#define ADJUST_POSITION(self, _new_pos) \
373 do { \
374 self->pos = _new_pos; \
375 if (VALID_READ_BUFFER(self) && self->read_end < self->pos) \
376 self->read_end = self->pos; \
377 } while(0)
378
379#define READAHEAD(self) \
380 ((self->readable && VALID_READ_BUFFER(self)) \
381 ? (self->read_end - self->pos) : 0)
382
383#define RAW_OFFSET(self) \
384 (((VALID_READ_BUFFER(self) || VALID_WRITE_BUFFER(self)) \
385 && self->raw_pos >= 0) ? self->raw_pos - self->pos : 0)
386
387#define RAW_TELL(self) \
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000388 (self->abs_pos != -1 ? self->abs_pos : _buffered_raw_tell(self))
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000389
390#define MINUS_LAST_BLOCK(self, size) \
391 (self->buffer_mask ? \
392 (size & ~self->buffer_mask) : \
393 (self->buffer_size * (size / self->buffer_size)))
394
395
396static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000397buffered_dealloc(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000398{
Antoine Pitrou796564c2013-07-30 19:59:21 +0200399 self->finalizing = 1;
400 if (_PyIOBase_finalize((PyObject *) self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000401 return;
402 _PyObject_GC_UNTRACK(self);
403 self->ok = 0;
404 if (self->weakreflist != NULL)
405 PyObject_ClearWeakRefs((PyObject *)self);
406 Py_CLEAR(self->raw);
407 if (self->buffer) {
408 PyMem_Free(self->buffer);
409 self->buffer = NULL;
410 }
Georg Brandldfd73442009-04-05 11:47:34 +0000411#ifdef WITH_THREAD
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000412 if (self->lock) {
413 PyThread_free_lock(self->lock);
414 self->lock = NULL;
415 }
Georg Brandldfd73442009-04-05 11:47:34 +0000416#endif
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000417 Py_CLEAR(self->dict);
418 Py_TYPE(self)->tp_free((PyObject *)self);
419}
420
Antoine Pitrou10f0c502012-07-29 19:02:46 +0200421static PyObject *
422buffered_sizeof(buffered *self, void *unused)
423{
424 Py_ssize_t res;
425
426 res = sizeof(buffered);
427 if (self->buffer)
428 res += self->buffer_size;
429 return PyLong_FromSsize_t(res);
430}
431
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000432static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000433buffered_traverse(buffered *self, visitproc visit, void *arg)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000434{
435 Py_VISIT(self->raw);
436 Py_VISIT(self->dict);
437 return 0;
438}
439
440static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000441buffered_clear(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000442{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000443 self->ok = 0;
444 Py_CLEAR(self->raw);
445 Py_CLEAR(self->dict);
446 return 0;
447}
448
Antoine Pitroue033e062010-10-29 10:38:18 +0000449/* Because this can call arbitrary code, it shouldn't be called when
450 the refcount is 0 (that is, not directly from tp_dealloc unless
451 the refcount has been temporarily re-incremented). */
Matthias Klosebee33162010-11-16 20:07:51 +0000452static PyObject *
Antoine Pitroue033e062010-10-29 10:38:18 +0000453buffered_dealloc_warn(buffered *self, PyObject *source)
454{
455 if (self->ok && self->raw) {
456 PyObject *r;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +0200457 r = _PyObject_CallMethodId(self->raw, &PyId__dealloc_warn, "O", source);
Antoine Pitroue033e062010-10-29 10:38:18 +0000458 if (r)
459 Py_DECREF(r);
460 else
461 PyErr_Clear();
462 }
463 Py_RETURN_NONE;
464}
465
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000466/*
467 * _BufferedIOMixin methods
468 * This is not a class, just a collection of methods that will be reused
469 * by BufferedReader and BufferedWriter
470 */
471
472/* Flush and close */
473
474static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000475buffered_simple_flush(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000476{
477 CHECK_INITIALIZED(self)
478 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_flush, NULL);
479}
480
481static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000482buffered_closed(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000483{
484 int closed;
485 PyObject *res;
486 CHECK_INITIALIZED_INT(self)
487 res = PyObject_GetAttr(self->raw, _PyIO_str_closed);
488 if (res == NULL)
489 return -1;
490 closed = PyObject_IsTrue(res);
491 Py_DECREF(res);
492 return closed;
493}
494
495static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000496buffered_closed_get(buffered *self, void *context)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000497{
498 CHECK_INITIALIZED(self)
499 return PyObject_GetAttr(self->raw, _PyIO_str_closed);
500}
501
502static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000503buffered_close(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000504{
Benjamin Peterson68623612012-12-20 11:53:11 -0600505 PyObject *res = NULL, *exc = NULL, *val, *tb;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000506 int r;
507
508 CHECK_INITIALIZED(self)
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000509 if (!ENTER_BUFFERED(self))
510 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000511
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000512 r = buffered_closed(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000513 if (r < 0)
514 goto end;
515 if (r > 0) {
516 res = Py_None;
517 Py_INCREF(res);
518 goto end;
519 }
Antoine Pitroue033e062010-10-29 10:38:18 +0000520
Antoine Pitrou796564c2013-07-30 19:59:21 +0200521 if (self->finalizing) {
Antoine Pitroue033e062010-10-29 10:38:18 +0000522 PyObject *r = buffered_dealloc_warn(self, (PyObject *) self);
523 if (r)
524 Py_DECREF(r);
525 else
526 PyErr_Clear();
527 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000528 /* flush() will most probably re-take the lock, so drop it first */
529 LEAVE_BUFFERED(self)
530 res = PyObject_CallMethodObjArgs((PyObject *)self, _PyIO_str_flush, NULL);
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000531 if (!ENTER_BUFFERED(self))
532 return NULL;
Benjamin Peterson68623612012-12-20 11:53:11 -0600533 if (res == NULL)
534 PyErr_Fetch(&exc, &val, &tb);
535 else
536 Py_DECREF(res);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000537
538 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_close, NULL);
539
Jesus Ceadc469452012-10-04 12:37:56 +0200540 if (self->buffer) {
541 PyMem_Free(self->buffer);
542 self->buffer = NULL;
543 }
544
Benjamin Peterson68623612012-12-20 11:53:11 -0600545 if (exc != NULL) {
Serhiy Storchakae2bd2a72014-10-08 22:31:52 +0300546 _PyErr_ChainExceptions(exc, val, tb);
547 Py_CLEAR(res);
Benjamin Peterson68623612012-12-20 11:53:11 -0600548 }
549
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000550end:
551 LEAVE_BUFFERED(self)
552 return res;
553}
554
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000555/* detach */
556
557static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000558buffered_detach(buffered *self, PyObject *args)
Benjamin Petersond2e0c792009-05-01 20:40:59 +0000559{
560 PyObject *raw, *res;
561 CHECK_INITIALIZED(self)
562 res = PyObject_CallMethodObjArgs((PyObject *)self, _PyIO_str_flush, NULL);
563 if (res == NULL)
564 return NULL;
565 Py_DECREF(res);
566 raw = self->raw;
567 self->raw = NULL;
568 self->detached = 1;
569 self->ok = 0;
570 return raw;
571}
572
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000573/* Inquiries */
574
575static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000576buffered_seekable(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000577{
578 CHECK_INITIALIZED(self)
579 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_seekable, NULL);
580}
581
582static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000583buffered_readable(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000584{
585 CHECK_INITIALIZED(self)
586 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_readable, NULL);
587}
588
589static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000590buffered_writable(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000591{
592 CHECK_INITIALIZED(self)
593 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_writable, NULL);
594}
595
596static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000597buffered_name_get(buffered *self, void *context)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000598{
599 CHECK_INITIALIZED(self)
Martin v. Löwis767046a2011-10-14 15:35:36 +0200600 return _PyObject_GetAttrId(self->raw, &PyId_name);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000601}
602
603static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000604buffered_mode_get(buffered *self, void *context)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000605{
606 CHECK_INITIALIZED(self)
Martin v. Löwis767046a2011-10-14 15:35:36 +0200607 return _PyObject_GetAttrId(self->raw, &PyId_mode);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000608}
609
610/* Lower-level APIs */
611
612static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000613buffered_fileno(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000614{
615 CHECK_INITIALIZED(self)
616 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_fileno, NULL);
617}
618
619static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000620buffered_isatty(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000621{
622 CHECK_INITIALIZED(self)
623 return PyObject_CallMethodObjArgs(self->raw, _PyIO_str_isatty, NULL);
624}
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000625
Antoine Pitrou243757e2010-11-05 21:15:39 +0000626/* Serialization */
627
628static PyObject *
629buffered_getstate(buffered *self, PyObject *args)
630{
631 PyErr_Format(PyExc_TypeError,
632 "cannot serialize '%s' object", Py_TYPE(self)->tp_name);
633 return NULL;
634}
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000635
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000636/* Forward decls */
637static PyObject *
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100638_bufferedwriter_flush_unlocked(buffered *);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000639static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000640_bufferedreader_fill_buffer(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000641static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000642_bufferedreader_reset_buf(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000643static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000644_bufferedwriter_reset_buf(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000645static PyObject *
Victor Stinnerbc93a112011-06-01 00:01:24 +0200646_bufferedreader_peek_unlocked(buffered *self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000647static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000648_bufferedreader_read_all(buffered *self);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000649static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000650_bufferedreader_read_fast(buffered *self, Py_ssize_t);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000651static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000652_bufferedreader_read_generic(buffered *self, Py_ssize_t);
Antoine Pitrou3486a982011-05-12 01:57:53 +0200653static Py_ssize_t
654_bufferedreader_raw_read(buffered *self, char *start, Py_ssize_t len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000655
656/*
657 * Helpers
658 */
659
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100660/* Sets the current error to BlockingIOError */
661static void
662_set_BlockingIOError(char *msg, Py_ssize_t written)
663{
664 PyObject *err;
Victor Stinnerace47d72013-07-18 01:41:08 +0200665 PyErr_Clear();
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100666 err = PyObject_CallFunction(PyExc_BlockingIOError, "isn",
667 errno, msg, written);
668 if (err)
669 PyErr_SetObject(PyExc_BlockingIOError, err);
670 Py_XDECREF(err);
671}
672
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000673/* Returns the address of the `written` member if a BlockingIOError was
674 raised, NULL otherwise. The error is always re-raised. */
675static Py_ssize_t *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000676_buffered_check_blocking_error(void)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000677{
678 PyObject *t, *v, *tb;
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200679 PyOSErrorObject *err;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000680
681 PyErr_Fetch(&t, &v, &tb);
682 if (v == NULL || !PyErr_GivenExceptionMatches(v, PyExc_BlockingIOError)) {
683 PyErr_Restore(t, v, tb);
684 return NULL;
685 }
Antoine Pitrou6b4883d2011-10-12 02:54:14 +0200686 err = (PyOSErrorObject *) v;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000687 /* TODO: sanity check (err->written >= 0) */
688 PyErr_Restore(t, v, tb);
689 return &err->written;
690}
691
692static Py_off_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000693_buffered_raw_tell(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000694{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000695 Py_off_t n;
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000696 PyObject *res;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000697 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_tell, NULL);
698 if (res == NULL)
699 return -1;
700 n = PyNumber_AsOff_t(res, PyExc_ValueError);
701 Py_DECREF(res);
702 if (n < 0) {
703 if (!PyErr_Occurred())
704 PyErr_Format(PyExc_IOError,
Mark Dickinson1a0aaaa2009-11-24 20:54:11 +0000705 "Raw stream returned invalid position %" PY_PRIdOFF,
Antoine Pitrou3486a982011-05-12 01:57:53 +0200706 (PY_OFF_T_COMPAT)n);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000707 return -1;
708 }
709 self->abs_pos = n;
710 return n;
711}
712
713static Py_off_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000714_buffered_raw_seek(buffered *self, Py_off_t target, int whence)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000715{
716 PyObject *res, *posobj, *whenceobj;
717 Py_off_t n;
718
719 posobj = PyLong_FromOff_t(target);
720 if (posobj == NULL)
721 return -1;
722 whenceobj = PyLong_FromLong(whence);
723 if (whenceobj == NULL) {
724 Py_DECREF(posobj);
725 return -1;
726 }
727 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_seek,
728 posobj, whenceobj, NULL);
729 Py_DECREF(posobj);
730 Py_DECREF(whenceobj);
731 if (res == NULL)
732 return -1;
733 n = PyNumber_AsOff_t(res, PyExc_ValueError);
734 Py_DECREF(res);
735 if (n < 0) {
736 if (!PyErr_Occurred())
737 PyErr_Format(PyExc_IOError,
Mark Dickinson1a0aaaa2009-11-24 20:54:11 +0000738 "Raw stream returned invalid position %" PY_PRIdOFF,
Antoine Pitrou3486a982011-05-12 01:57:53 +0200739 (PY_OFF_T_COMPAT)n);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000740 return -1;
741 }
742 self->abs_pos = n;
743 return n;
744}
745
746static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000747_buffered_init(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000748{
749 Py_ssize_t n;
750 if (self->buffer_size <= 0) {
751 PyErr_SetString(PyExc_ValueError,
752 "buffer size must be strictly positive");
753 return -1;
754 }
755 if (self->buffer)
756 PyMem_Free(self->buffer);
757 self->buffer = PyMem_Malloc(self->buffer_size);
758 if (self->buffer == NULL) {
759 PyErr_NoMemory();
760 return -1;
761 }
Georg Brandldfd73442009-04-05 11:47:34 +0000762#ifdef WITH_THREAD
Antoine Pitrouc881f152010-08-01 16:53:42 +0000763 if (self->lock)
764 PyThread_free_lock(self->lock);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000765 self->lock = PyThread_allocate_lock();
766 if (self->lock == NULL) {
767 PyErr_SetString(PyExc_RuntimeError, "can't allocate read lock");
768 return -1;
769 }
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000770 self->owner = 0;
Georg Brandldfd73442009-04-05 11:47:34 +0000771#endif
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000772 /* Find out whether buffer_size is a power of 2 */
773 /* XXX is this optimization useful? */
774 for (n = self->buffer_size - 1; n & 1; n >>= 1)
775 ;
776 if (n == 0)
777 self->buffer_mask = self->buffer_size - 1;
778 else
779 self->buffer_mask = 0;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000780 if (_buffered_raw_tell(self) == -1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000781 PyErr_Clear();
782 return 0;
783}
784
Antoine Pitrou707ce822011-02-25 21:24:11 +0000785/* Return 1 if an EnvironmentError with errno == EINTR is set (and then
786 clears the error indicator), 0 otherwise.
787 Should only be called when PyErr_Occurred() is true.
788*/
Gregory P. Smith51359922012-06-23 23:55:39 -0700789int
790_PyIO_trap_eintr(void)
Antoine Pitrou707ce822011-02-25 21:24:11 +0000791{
792 static PyObject *eintr_int = NULL;
793 PyObject *typ, *val, *tb;
794 PyEnvironmentErrorObject *env_err;
795
796 if (eintr_int == NULL) {
797 eintr_int = PyLong_FromLong(EINTR);
798 assert(eintr_int != NULL);
799 }
800 if (!PyErr_ExceptionMatches(PyExc_EnvironmentError))
801 return 0;
802 PyErr_Fetch(&typ, &val, &tb);
803 PyErr_NormalizeException(&typ, &val, &tb);
804 env_err = (PyEnvironmentErrorObject *) val;
805 assert(env_err != NULL);
806 if (env_err->myerrno != NULL &&
807 PyObject_RichCompareBool(env_err->myerrno, eintr_int, Py_EQ) > 0) {
808 Py_DECREF(typ);
809 Py_DECREF(val);
810 Py_XDECREF(tb);
811 return 1;
812 }
813 /* This silences any error set by PyObject_RichCompareBool() */
814 PyErr_Restore(typ, val, tb);
815 return 0;
816}
817
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000818/*
819 * Shared methods and wrappers
820 */
821
822static PyObject *
Antoine Pitroue05565e2011-08-20 14:39:23 +0200823buffered_flush_and_rewind_unlocked(buffered *self)
824{
825 PyObject *res;
826
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +0100827 res = _bufferedwriter_flush_unlocked(self);
Antoine Pitroue05565e2011-08-20 14:39:23 +0200828 if (res == NULL)
829 return NULL;
830 Py_DECREF(res);
831
832 if (self->readable) {
833 /* Rewind the raw stream so that its position corresponds to
834 the current logical position. */
835 Py_off_t n;
836 n = _buffered_raw_seek(self, -RAW_OFFSET(self), 1);
837 _bufferedreader_reset_buf(self);
838 if (n == -1)
839 return NULL;
840 }
841 Py_RETURN_NONE;
842}
843
844static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000845buffered_flush(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000846{
847 PyObject *res;
848
849 CHECK_INITIALIZED(self)
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000850 CHECK_CLOSED(self, "flush of closed file")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000851
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000852 if (!ENTER_BUFFERED(self))
853 return NULL;
Antoine Pitroue05565e2011-08-20 14:39:23 +0200854 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000855 LEAVE_BUFFERED(self)
856
857 return res;
858}
859
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300860/*[clinic input]
861_io._Buffered.peek
862 size: Py_ssize_t = 0
863 /
864
865[clinic start generated code]*/
866
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000867static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300868_io__Buffered_peek_impl(buffered *self, Py_ssize_t size)
869/*[clinic end generated code: output=ba7a097ca230102b input=37ffb97d06ff4adb]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000870{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000871 PyObject *res = NULL;
872
873 CHECK_INITIALIZED(self)
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000874 if (!ENTER_BUFFERED(self))
875 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000876
877 if (self->writable) {
Antoine Pitroue05565e2011-08-20 14:39:23 +0200878 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000879 if (res == NULL)
880 goto end;
881 Py_CLEAR(res);
882 }
Victor Stinnerbc93a112011-06-01 00:01:24 +0200883 res = _bufferedreader_peek_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000884
885end:
886 LEAVE_BUFFERED(self)
887 return res;
888}
889
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300890/*[clinic input]
891_io._Buffered.read
892 size as n: io_ssize_t = -1
893 /
894[clinic start generated code]*/
895
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000896static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300897_io__Buffered_read_impl(buffered *self, Py_ssize_t n)
898/*[clinic end generated code: output=f41c78bb15b9bbe9 input=c0939ec7f9e9354f]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000899{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000900 PyObject *res;
901
902 CHECK_INITIALIZED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000903 if (n < -1) {
904 PyErr_SetString(PyExc_ValueError,
905 "read length must be positive or -1");
906 return NULL;
907 }
908
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000909 CHECK_CLOSED(self, "read of closed file")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000910
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000911 if (n == -1) {
912 /* The number of bytes is unspecified, read until the end of stream */
Antoine Pitrouf3b68b32010-12-03 18:41:39 +0000913 if (!ENTER_BUFFERED(self))
914 return NULL;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000915 res = _bufferedreader_read_all(self);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000916 }
917 else {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000918 res = _bufferedreader_read_fast(self, n);
Antoine Pitroue05565e2011-08-20 14:39:23 +0200919 if (res != Py_None)
920 return res;
921 Py_DECREF(res);
922 if (!ENTER_BUFFERED(self))
923 return NULL;
924 res = _bufferedreader_read_generic(self, n);
Antoine Pitrou711af3a2009-04-11 15:39:24 +0000925 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000926
Antoine Pitroue05565e2011-08-20 14:39:23 +0200927 LEAVE_BUFFERED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000928 return res;
929}
930
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300931/*[clinic input]
932_io._Buffered.read1
933 size as n: Py_ssize_t
934 /
935[clinic start generated code]*/
936
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000937static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300938_io__Buffered_read1_impl(buffered *self, Py_ssize_t n)
939/*[clinic end generated code: output=bcc4fb4e54d103a3 input=8d2869c18b983184]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000940{
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300941 Py_ssize_t have, r;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000942 PyObject *res = NULL;
943
944 CHECK_INITIALIZED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000945 if (n < 0) {
946 PyErr_SetString(PyExc_ValueError,
947 "read length must be positive");
948 return NULL;
949 }
950 if (n == 0)
951 return PyBytes_FromStringAndSize(NULL, 0);
952
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000953 /* Return up to n bytes. If at least one byte is buffered, we
954 only return buffered bytes. Otherwise, we do one raw read. */
955
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000956 have = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
957 if (have > 0) {
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100958 n = Py_MIN(have, n);
959 res = _bufferedreader_read_fast(self, n);
960 assert(res != Py_None);
961 return res;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000962 }
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100963 res = PyBytes_FromStringAndSize(NULL, n);
964 if (res == NULL)
965 return NULL;
966 if (!ENTER_BUFFERED(self)) {
Antoine Pitroue05565e2011-08-20 14:39:23 +0200967 Py_DECREF(res);
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100968 return NULL;
Antoine Pitroue05565e2011-08-20 14:39:23 +0200969 }
Benjamin Peterson680bf1a2009-06-12 02:07:12 +0000970 _bufferedreader_reset_buf(self);
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100971 r = _bufferedreader_raw_read(self, PyBytes_AS_STRING(res), n);
972 LEAVE_BUFFERED(self)
973 if (r == -1) {
974 Py_DECREF(res);
975 return NULL;
976 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000977 if (r == -2)
978 r = 0;
979 if (n > r)
Antoine Pitrou56a220a2011-11-16 00:56:10 +0100980 _PyBytes_Resize(&res, r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000981 return res;
982}
983
984static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300985_buffered_readinto_generic(buffered *self, Py_buffer *buffer, char readinto1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000986{
Antoine Pitrou3486a982011-05-12 01:57:53 +0200987 Py_ssize_t n, written = 0, remaining;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +0000988 PyObject *res = NULL;
989
990 CHECK_INITIALIZED(self)
Antoine Pitrou3486a982011-05-12 01:57:53 +0200991
Antoine Pitrou3486a982011-05-12 01:57:53 +0200992 n = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
993 if (n > 0) {
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300994 if (n >= buffer->len) {
995 memcpy(buffer->buf, self->buffer + self->pos, buffer->len);
996 self->pos += buffer->len;
997 return PyLong_FromSsize_t(buffer->len);
Antoine Pitrou3486a982011-05-12 01:57:53 +0200998 }
Serhiy Storchakaf24131f2015-04-16 11:19:43 +0300999 memcpy(buffer->buf, self->buffer + self->pos, n);
Antoine Pitrou3486a982011-05-12 01:57:53 +02001000 self->pos += n;
1001 written = n;
1002 }
1003
1004 if (!ENTER_BUFFERED(self))
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001005 return NULL;
Antoine Pitrou3486a982011-05-12 01:57:53 +02001006
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001007 if (self->writable) {
Antoine Pitroue8bb1a02011-08-20 14:52:04 +02001008 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001009 if (res == NULL)
1010 goto end;
Antoine Pitrou3486a982011-05-12 01:57:53 +02001011 Py_CLEAR(res);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001012 }
Antoine Pitrou3486a982011-05-12 01:57:53 +02001013
1014 _bufferedreader_reset_buf(self);
1015 self->pos = 0;
1016
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001017 for (remaining = buffer->len - written;
Antoine Pitrou3486a982011-05-12 01:57:53 +02001018 remaining > 0;
1019 written += n, remaining -= n) {
1020 /* If remaining bytes is larger than internal buffer size, copy
1021 * directly into caller's buffer. */
1022 if (remaining > self->buffer_size) {
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001023 n = _bufferedreader_raw_read(self, (char *) buffer->buf + written,
Antoine Pitrou4e19e112011-05-12 02:07:00 +02001024 remaining);
Antoine Pitrou3486a982011-05-12 01:57:53 +02001025 }
Benjamin Petersona96fea02014-06-22 14:17:44 -07001026
1027 /* In readinto1 mode, we do not want to fill the internal
1028 buffer if we already have some data to return */
1029 else if (!(readinto1 && written)) {
Antoine Pitrou3486a982011-05-12 01:57:53 +02001030 n = _bufferedreader_fill_buffer(self);
1031 if (n > 0) {
1032 if (n > remaining)
1033 n = remaining;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001034 memcpy((char *) buffer->buf + written,
Antoine Pitrou4e19e112011-05-12 02:07:00 +02001035 self->buffer + self->pos, n);
Antoine Pitrou3486a982011-05-12 01:57:53 +02001036 self->pos += n;
1037 continue; /* short circuit */
1038 }
1039 }
Benjamin Petersona96fea02014-06-22 14:17:44 -07001040 else
1041 n = 0;
Serhiy Storchaka009b8112015-03-18 21:53:15 +02001042
Antoine Pitrou3486a982011-05-12 01:57:53 +02001043 if (n == 0 || (n == -2 && written > 0))
1044 break;
1045 if (n < 0) {
1046 if (n == -2) {
1047 Py_INCREF(Py_None);
1048 res = Py_None;
1049 }
1050 goto end;
1051 }
Serhiy Storchaka009b8112015-03-18 21:53:15 +02001052
Benjamin Petersona96fea02014-06-22 14:17:44 -07001053 /* At most one read in readinto1 mode */
1054 if (readinto1) {
1055 written += n;
1056 break;
1057 }
Antoine Pitrou3486a982011-05-12 01:57:53 +02001058 }
1059 res = PyLong_FromSsize_t(written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001060
1061end:
Antoine Pitrou3486a982011-05-12 01:57:53 +02001062 LEAVE_BUFFERED(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001063 return res;
1064}
1065
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001066/*[clinic input]
1067_io._Buffered.readinto
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001068 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001069 /
1070[clinic start generated code]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -07001071
1072static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001073_io__Buffered_readinto_impl(buffered *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001074/*[clinic end generated code: output=bcb376580b1d8170 input=ed6b98b7a20a3008]*/
Benjamin Petersona96fea02014-06-22 14:17:44 -07001075{
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001076 return _buffered_readinto_generic(self, buffer, 0);
1077}
1078
1079/*[clinic input]
1080_io._Buffered.readinto1
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001081 buffer: Py_buffer(accept={rwbuffer})
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001082 /
1083[clinic start generated code]*/
1084
1085static PyObject *
1086_io__Buffered_readinto1_impl(buffered *self, Py_buffer *buffer)
Larry Hastingsdbfdc382015-05-04 06:59:46 -07001087/*[clinic end generated code: output=6e5c6ac5868205d6 input=4455c5d55fdf1687]*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001088{
1089 return _buffered_readinto_generic(self, buffer, 1);
Benjamin Petersona96fea02014-06-22 14:17:44 -07001090}
1091
1092
1093static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001094_buffered_readline(buffered *self, Py_ssize_t limit)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001095{
1096 PyObject *res = NULL;
1097 PyObject *chunks = NULL;
1098 Py_ssize_t n, written = 0;
1099 const char *start, *s, *end;
1100
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001101 CHECK_CLOSED(self, "readline of closed file")
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001102
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001103 /* First, try to find a line in the buffer. This can run unlocked because
1104 the calls to the C API are simple enough that they can't trigger
1105 any thread switch. */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001106 n = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1107 if (limit >= 0 && n > limit)
1108 n = limit;
1109 start = self->buffer + self->pos;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001110 s = memchr(start, '\n', n);
1111 if (s != NULL) {
1112 res = PyBytes_FromStringAndSize(start, s - start + 1);
1113 if (res != NULL)
1114 self->pos += s - start + 1;
1115 goto end_unlocked;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001116 }
1117 if (n == limit) {
1118 res = PyBytes_FromStringAndSize(start, n);
1119 if (res != NULL)
1120 self->pos += n;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001121 goto end_unlocked;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001122 }
1123
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001124 if (!ENTER_BUFFERED(self))
1125 goto end_unlocked;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001126
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001127 /* Now we try to get some more from the raw stream */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001128 chunks = PyList_New(0);
1129 if (chunks == NULL)
1130 goto end;
1131 if (n > 0) {
1132 res = PyBytes_FromStringAndSize(start, n);
1133 if (res == NULL)
1134 goto end;
1135 if (PyList_Append(chunks, res) < 0) {
1136 Py_CLEAR(res);
1137 goto end;
1138 }
1139 Py_CLEAR(res);
1140 written += n;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001141 self->pos += n;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001142 if (limit >= 0)
1143 limit -= n;
1144 }
Antoine Pitroue05565e2011-08-20 14:39:23 +02001145 if (self->writable) {
1146 PyObject *r = buffered_flush_and_rewind_unlocked(self);
1147 if (r == NULL)
1148 goto end;
1149 Py_DECREF(r);
1150 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001151
1152 for (;;) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001153 _bufferedreader_reset_buf(self);
1154 n = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001155 if (n == -1)
1156 goto end;
1157 if (n <= 0)
1158 break;
1159 if (limit >= 0 && n > limit)
1160 n = limit;
1161 start = self->buffer;
1162 end = start + n;
1163 s = start;
1164 while (s < end) {
1165 if (*s++ == '\n') {
1166 res = PyBytes_FromStringAndSize(start, s - start);
1167 if (res == NULL)
1168 goto end;
1169 self->pos = s - start;
1170 goto found;
1171 }
1172 }
1173 res = PyBytes_FromStringAndSize(start, n);
1174 if (res == NULL)
1175 goto end;
1176 if (n == limit) {
1177 self->pos = n;
1178 break;
1179 }
1180 if (PyList_Append(chunks, res) < 0) {
1181 Py_CLEAR(res);
1182 goto end;
1183 }
1184 Py_CLEAR(res);
1185 written += n;
1186 if (limit >= 0)
1187 limit -= n;
1188 }
1189found:
1190 if (res != NULL && PyList_Append(chunks, res) < 0) {
1191 Py_CLEAR(res);
1192 goto end;
1193 }
1194 Py_CLEAR(res);
1195 res = _PyBytes_Join(_PyIO_empty_bytes, chunks);
1196
1197end:
1198 LEAVE_BUFFERED(self)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001199end_unlocked:
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001200 Py_XDECREF(chunks);
1201 return res;
1202}
1203
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001204/*[clinic input]
1205_io._Buffered.readline
1206 size: io_ssize_t = -1
1207 /
1208[clinic start generated code]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001209
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001210static PyObject *
1211_io__Buffered_readline_impl(buffered *self, Py_ssize_t size)
1212/*[clinic end generated code: output=24dd2aa6e33be83c input=ff1e0df821cb4e5c]*/
1213{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001214 CHECK_INITIALIZED(self)
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001215 return _buffered_readline(self, size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001216}
1217
1218
1219static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001220buffered_tell(buffered *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001221{
1222 Py_off_t pos;
1223
1224 CHECK_INITIALIZED(self)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001225 pos = _buffered_raw_tell(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001226 if (pos == -1)
1227 return NULL;
1228 pos -= RAW_OFFSET(self);
1229 /* TODO: sanity check (pos >= 0) */
1230 return PyLong_FromOff_t(pos);
1231}
1232
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001233/*[clinic input]
1234_io._Buffered.seek
1235 target as targetobj: object
1236 whence: int = 0
1237 /
1238[clinic start generated code]*/
1239
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001240static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001241_io__Buffered_seek_impl(buffered *self, PyObject *targetobj, int whence)
1242/*[clinic end generated code: output=7ae0e8dc46efdefb input=a9c4920bfcba6163]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001243{
1244 Py_off_t target, n;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001245 PyObject *res = NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001246
1247 CHECK_INITIALIZED(self)
Jesus Cea94363612012-06-22 18:32:07 +02001248
1249 /* Do some error checking instead of trusting OS 'seek()'
1250 ** error detection, just in case.
1251 */
1252 if ((whence < 0 || whence >2)
1253#ifdef SEEK_HOLE
1254 && (whence != SEEK_HOLE)
1255#endif
1256#ifdef SEEK_DATA
1257 && (whence != SEEK_DATA)
1258#endif
1259 ) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001260 PyErr_Format(PyExc_ValueError,
Jesus Cea94363612012-06-22 18:32:07 +02001261 "whence value %d unsupported", whence);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001262 return NULL;
1263 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001264
1265 CHECK_CLOSED(self, "seek of closed file")
1266
Antoine Pitrou1e44fec2011-10-04 12:26:20 +02001267 if (_PyIOBase_check_seekable(self->raw, Py_True) == NULL)
1268 return NULL;
1269
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001270 target = PyNumber_AsOff_t(targetobj, PyExc_ValueError);
1271 if (target == -1 && PyErr_Occurred())
1272 return NULL;
1273
Jesus Cea94363612012-06-22 18:32:07 +02001274 /* SEEK_SET and SEEK_CUR are special because we could seek inside the
1275 buffer. Other whence values must be managed without this optimization.
1276 Some Operating Systems can provide additional values, like
1277 SEEK_HOLE/SEEK_DATA. */
1278 if (((whence == 0) || (whence == 1)) && self->readable) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001279 Py_off_t current, avail;
1280 /* Check if seeking leaves us inside the current buffer,
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001281 so as to return quickly if possible. Also, we needn't take the
1282 lock in this fast path.
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001283 Don't know how to do that when whence == 2, though. */
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001284 /* NOTE: RAW_TELL() can release the GIL but the object is in a stable
1285 state at this point. */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001286 current = RAW_TELL(self);
1287 avail = READAHEAD(self);
1288 if (avail > 0) {
1289 Py_off_t offset;
1290 if (whence == 0)
1291 offset = target - (current - RAW_OFFSET(self));
1292 else
1293 offset = target;
1294 if (offset >= -self->pos && offset <= avail) {
1295 self->pos += offset;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001296 return PyLong_FromOff_t(current - avail + offset);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001297 }
1298 }
1299 }
1300
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001301 if (!ENTER_BUFFERED(self))
1302 return NULL;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001303
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001304 /* Fallback: invoke raw seek() method and clear buffer */
1305 if (self->writable) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001306 res = _bufferedwriter_flush_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001307 if (res == NULL)
1308 goto end;
1309 Py_CLEAR(res);
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001310 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001311 }
1312
1313 /* TODO: align on block boundary and read buffer if needed? */
1314 if (whence == 1)
1315 target -= RAW_OFFSET(self);
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001316 n = _buffered_raw_seek(self, target, whence);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001317 if (n == -1)
1318 goto end;
1319 self->raw_pos = -1;
1320 res = PyLong_FromOff_t(n);
1321 if (res != NULL && self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001322 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001323
1324end:
1325 LEAVE_BUFFERED(self)
1326 return res;
1327}
1328
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001329/*[clinic input]
1330_io._Buffered.truncate
1331 pos: object = None
1332 /
1333[clinic start generated code]*/
1334
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001335static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001336_io__Buffered_truncate_impl(buffered *self, PyObject *pos)
1337/*[clinic end generated code: output=667ca03c60c270de input=8a1be34d57cca2d3]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001338{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001339 PyObject *res = NULL;
1340
1341 CHECK_INITIALIZED(self)
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001342 if (!ENTER_BUFFERED(self))
1343 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001344
1345 if (self->writable) {
Antoine Pitroue05565e2011-08-20 14:39:23 +02001346 res = buffered_flush_and_rewind_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001347 if (res == NULL)
1348 goto end;
1349 Py_CLEAR(res);
1350 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001351 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_truncate, pos, NULL);
1352 if (res == NULL)
1353 goto end;
1354 /* Reset cached position */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001355 if (_buffered_raw_tell(self) == -1)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001356 PyErr_Clear();
1357
1358end:
1359 LEAVE_BUFFERED(self)
1360 return res;
1361}
1362
1363static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001364buffered_iternext(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001365{
1366 PyObject *line;
1367 PyTypeObject *tp;
1368
1369 CHECK_INITIALIZED(self);
1370
1371 tp = Py_TYPE(self);
1372 if (tp == &PyBufferedReader_Type ||
1373 tp == &PyBufferedRandom_Type) {
1374 /* Skip method call overhead for speed */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001375 line = _buffered_readline(self, -1);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001376 }
1377 else {
1378 line = PyObject_CallMethodObjArgs((PyObject *)self,
1379 _PyIO_str_readline, NULL);
1380 if (line && !PyBytes_Check(line)) {
1381 PyErr_Format(PyExc_IOError,
1382 "readline() should have returned a bytes object, "
1383 "not '%.200s'", Py_TYPE(line)->tp_name);
1384 Py_DECREF(line);
1385 return NULL;
1386 }
1387 }
1388
1389 if (line == NULL)
1390 return NULL;
1391
1392 if (PyBytes_GET_SIZE(line) == 0) {
1393 /* Reached EOF or would have blocked */
1394 Py_DECREF(line);
1395 return NULL;
1396 }
1397
1398 return line;
1399}
1400
Antoine Pitrou716c4442009-05-23 19:04:03 +00001401static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001402buffered_repr(buffered *self)
Antoine Pitrou716c4442009-05-23 19:04:03 +00001403{
1404 PyObject *nameobj, *res;
1405
Martin v. Löwis767046a2011-10-14 15:35:36 +02001406 nameobj = _PyObject_GetAttrId((PyObject *) self, &PyId_name);
Antoine Pitrou716c4442009-05-23 19:04:03 +00001407 if (nameobj == NULL) {
Benjamin Peterson10e76b62014-12-21 20:51:50 -06001408 if (PyErr_ExceptionMatches(PyExc_Exception))
Antoine Pitrou716c4442009-05-23 19:04:03 +00001409 PyErr_Clear();
1410 else
1411 return NULL;
1412 res = PyUnicode_FromFormat("<%s>", Py_TYPE(self)->tp_name);
1413 }
1414 else {
1415 res = PyUnicode_FromFormat("<%s name=%R>",
1416 Py_TYPE(self)->tp_name, nameobj);
1417 Py_DECREF(nameobj);
1418 }
1419 return res;
1420}
1421
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001422/*
1423 * class BufferedReader
1424 */
1425
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001426static void _bufferedreader_reset_buf(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001427{
1428 self->read_end = -1;
1429}
1430
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001431/*[clinic input]
1432_io.BufferedReader.__init__
1433 raw: object
1434 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001435
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001436Create a new buffered reader using the given readable raw IO object.
1437[clinic start generated code]*/
1438
1439static int
1440_io_BufferedReader___init___impl(buffered *self, PyObject *raw,
1441 Py_ssize_t buffer_size)
1442/*[clinic end generated code: output=cddcfefa0ed294c4 input=fb887e06f11b4e48]*/
1443{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001444 self->ok = 0;
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001445 self->detached = 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001446
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001447 if (_PyIOBase_check_readable(raw, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001448 return -1;
1449
1450 Py_CLEAR(self->raw);
1451 Py_INCREF(raw);
1452 self->raw = raw;
1453 self->buffer_size = buffer_size;
1454 self->readable = 1;
1455 self->writable = 0;
1456
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001457 if (_buffered_init(self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001458 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001459 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001460
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001461 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedReader_Type &&
1462 Py_TYPE(raw) == &PyFileIO_Type);
1463
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001464 self->ok = 1;
1465 return 0;
1466}
1467
1468static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001469_bufferedreader_raw_read(buffered *self, char *start, Py_ssize_t len)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001470{
1471 Py_buffer buf;
1472 PyObject *memobj, *res;
1473 Py_ssize_t n;
1474 /* NOTE: the buffer needn't be released as its object is NULL. */
1475 if (PyBuffer_FillInfo(&buf, NULL, start, len, 0, PyBUF_CONTIG) == -1)
1476 return -1;
1477 memobj = PyMemoryView_FromBuffer(&buf);
1478 if (memobj == NULL)
1479 return -1;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001480 /* NOTE: PyErr_SetFromErrno() calls PyErr_CheckSignals() when EINTR
1481 occurs so we needn't do it ourselves.
1482 We then retry reading, ignoring the signal if no handler has
1483 raised (see issue #10956).
1484 */
1485 do {
1486 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_readinto, memobj, NULL);
Gregory P. Smith51359922012-06-23 23:55:39 -07001487 } while (res == NULL && _PyIO_trap_eintr());
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001488 Py_DECREF(memobj);
1489 if (res == NULL)
1490 return -1;
1491 if (res == Py_None) {
1492 /* Non-blocking stream would have blocked. Special return code! */
1493 Py_DECREF(res);
1494 return -2;
1495 }
1496 n = PyNumber_AsSsize_t(res, PyExc_ValueError);
1497 Py_DECREF(res);
1498 if (n < 0 || n > len) {
1499 PyErr_Format(PyExc_IOError,
1500 "raw readinto() returned invalid length %zd "
1501 "(should have been between 0 and %zd)", n, len);
1502 return -1;
1503 }
1504 if (n > 0 && self->abs_pos != -1)
1505 self->abs_pos += n;
1506 return n;
1507}
1508
1509static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001510_bufferedreader_fill_buffer(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001511{
1512 Py_ssize_t start, len, n;
1513 if (VALID_READ_BUFFER(self))
1514 start = Py_SAFE_DOWNCAST(self->read_end, Py_off_t, Py_ssize_t);
1515 else
1516 start = 0;
1517 len = self->buffer_size - start;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001518 n = _bufferedreader_raw_read(self, self->buffer + start, len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001519 if (n <= 0)
1520 return n;
1521 self->read_end = start + n;
1522 self->raw_pos = start + n;
1523 return n;
1524}
1525
1526static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001527_bufferedreader_read_all(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001528{
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001529 Py_ssize_t current_size;
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001530 PyObject *res = NULL, *data = NULL, *tmp = NULL, *chunks = NULL;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001531
1532 /* First copy what we have in the current buffer. */
1533 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1534 if (current_size) {
1535 data = PyBytes_FromStringAndSize(
1536 self->buffer + self->pos, current_size);
Victor Stinnerb57f1082011-05-26 00:19:38 +02001537 if (data == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001538 return NULL;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001539 self->pos += current_size;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001540 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001541 /* We're going past the buffer's bounds, flush it */
1542 if (self->writable) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001543 tmp = buffered_flush_and_rewind_unlocked(self);
1544 if (tmp == NULL)
1545 goto cleanup;
1546 Py_CLEAR(tmp);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001547 }
Antoine Pitroue05565e2011-08-20 14:39:23 +02001548 _bufferedreader_reset_buf(self);
Victor Stinnerb57f1082011-05-26 00:19:38 +02001549
1550 if (PyObject_HasAttr(self->raw, _PyIO_str_readall)) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001551 tmp = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_readall, NULL);
1552 if (tmp == NULL)
1553 goto cleanup;
1554 if (tmp != Py_None && !PyBytes_Check(tmp)) {
Victor Stinnerb57f1082011-05-26 00:19:38 +02001555 PyErr_SetString(PyExc_TypeError, "readall() should return bytes");
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001556 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001557 }
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001558 if (tmp == Py_None) {
1559 if (current_size == 0) {
1560 res = Py_None;
1561 goto cleanup;
1562 } else {
1563 res = data;
1564 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001565 }
1566 }
1567 else if (current_size) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001568 PyBytes_Concat(&data, tmp);
1569 res = data;
1570 goto cleanup;
1571 }
1572 else {
1573 res = tmp;
1574 goto cleanup;
1575 }
Victor Stinnerb57f1082011-05-26 00:19:38 +02001576 }
1577
1578 chunks = PyList_New(0);
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001579 if (chunks == NULL)
1580 goto cleanup;
Victor Stinnerb57f1082011-05-26 00:19:38 +02001581
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001582 while (1) {
1583 if (data) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001584 if (PyList_Append(chunks, data) < 0)
1585 goto cleanup;
1586 Py_CLEAR(data);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001587 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001588
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001589 /* Read until EOF or until read() would block. */
1590 data = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_read, NULL);
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001591 if (data == NULL)
1592 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001593 if (data != Py_None && !PyBytes_Check(data)) {
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001594 PyErr_SetString(PyExc_TypeError, "read() should return bytes");
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001595 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001596 }
1597 if (data == Py_None || PyBytes_GET_SIZE(data) == 0) {
1598 if (current_size == 0) {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001599 res = data;
1600 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001601 }
1602 else {
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001603 tmp = _PyBytes_Join(_PyIO_empty_bytes, chunks);
1604 res = tmp;
1605 goto cleanup;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001606 }
1607 }
1608 current_size += PyBytes_GET_SIZE(data);
1609 if (self->abs_pos != -1)
1610 self->abs_pos += PyBytes_GET_SIZE(data);
1611 }
Richard Oudkerk9ad51ec2013-07-15 16:05:22 +01001612cleanup:
1613 /* res is either NULL or a borrowed ref */
1614 Py_XINCREF(res);
1615 Py_XDECREF(data);
1616 Py_XDECREF(tmp);
1617 Py_XDECREF(chunks);
1618 return res;
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001619}
1620
1621/* Read n bytes from the buffer if it can, otherwise return None.
1622 This function is simple enough that it can run unlocked. */
1623static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001624_bufferedreader_read_fast(buffered *self, Py_ssize_t n)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001625{
1626 Py_ssize_t current_size;
1627
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001628 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1629 if (n <= current_size) {
1630 /* Fast path: the data to read is fully buffered. */
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001631 PyObject *res = PyBytes_FromStringAndSize(self->buffer + self->pos, n);
1632 if (res != NULL)
1633 self->pos += n;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001634 return res;
1635 }
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001636 Py_RETURN_NONE;
1637}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001638
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001639/* Generic read function: read from the stream until enough bytes are read,
1640 * or until an EOF occurs or until read() would block.
1641 */
1642static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001643_bufferedreader_read_generic(buffered *self, Py_ssize_t n)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001644{
1645 PyObject *res = NULL;
1646 Py_ssize_t current_size, remaining, written;
1647 char *out;
1648
1649 current_size = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1650 if (n <= current_size)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001651 return _bufferedreader_read_fast(self, n);
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001652
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001653 res = PyBytes_FromStringAndSize(NULL, n);
1654 if (res == NULL)
1655 goto error;
1656 out = PyBytes_AS_STRING(res);
1657 remaining = n;
1658 written = 0;
1659 if (current_size > 0) {
1660 memcpy(out, self->buffer + self->pos, current_size);
1661 remaining -= current_size;
1662 written += current_size;
Antoine Pitroue05565e2011-08-20 14:39:23 +02001663 self->pos += current_size;
1664 }
1665 /* Flush the write buffer if necessary */
1666 if (self->writable) {
1667 PyObject *r = buffered_flush_and_rewind_unlocked(self);
1668 if (r == NULL)
1669 goto error;
1670 Py_DECREF(r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001671 }
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001672 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001673 while (remaining > 0) {
1674 /* We want to read a whole block at the end into buffer.
1675 If we had readv() we could do this in one pass. */
1676 Py_ssize_t r = MINUS_LAST_BLOCK(self, remaining);
1677 if (r == 0)
1678 break;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001679 r = _bufferedreader_raw_read(self, out + written, r);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001680 if (r == -1)
1681 goto error;
1682 if (r == 0 || r == -2) {
1683 /* EOF occurred or read() would block. */
1684 if (r == 0 || written > 0) {
1685 if (_PyBytes_Resize(&res, written))
1686 goto error;
1687 return res;
1688 }
1689 Py_DECREF(res);
1690 Py_INCREF(Py_None);
1691 return Py_None;
1692 }
1693 remaining -= r;
1694 written += r;
1695 }
1696 assert(remaining <= self->buffer_size);
1697 self->pos = 0;
1698 self->raw_pos = 0;
1699 self->read_end = 0;
Antoine Pitrou32cfede2010-08-11 13:31:33 +00001700 /* NOTE: when the read is satisfied, we avoid issuing any additional
1701 reads, which could block indefinitely (e.g. on a socket).
1702 See issue #9550. */
1703 while (remaining > 0 && self->read_end < self->buffer_size) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001704 Py_ssize_t r = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001705 if (r == -1)
1706 goto error;
1707 if (r == 0 || r == -2) {
1708 /* EOF occurred or read() would block. */
1709 if (r == 0 || written > 0) {
1710 if (_PyBytes_Resize(&res, written))
1711 goto error;
1712 return res;
1713 }
1714 Py_DECREF(res);
1715 Py_INCREF(Py_None);
1716 return Py_None;
1717 }
1718 if (remaining > r) {
1719 memcpy(out + written, self->buffer + self->pos, r);
1720 written += r;
1721 self->pos += r;
1722 remaining -= r;
1723 }
1724 else if (remaining > 0) {
1725 memcpy(out + written, self->buffer + self->pos, remaining);
1726 written += remaining;
1727 self->pos += remaining;
1728 remaining = 0;
1729 }
1730 if (remaining == 0)
1731 break;
1732 }
1733
1734 return res;
1735
1736error:
1737 Py_XDECREF(res);
1738 return NULL;
1739}
1740
1741static PyObject *
Victor Stinnerbc93a112011-06-01 00:01:24 +02001742_bufferedreader_peek_unlocked(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001743{
1744 Py_ssize_t have, r;
1745
1746 have = Py_SAFE_DOWNCAST(READAHEAD(self), Py_off_t, Py_ssize_t);
1747 /* Constraints:
1748 1. we don't want to advance the file position.
1749 2. we don't want to lose block alignment, so we can't shift the buffer
1750 to make some place.
1751 Therefore, we either return `have` bytes (if > 0), or a full buffer.
1752 */
1753 if (have > 0) {
1754 return PyBytes_FromStringAndSize(self->buffer + self->pos, have);
1755 }
1756
1757 /* Fill the buffer from the raw stream, and copy it to the result. */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001758 _bufferedreader_reset_buf(self);
1759 r = _bufferedreader_fill_buffer(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001760 if (r == -1)
1761 return NULL;
1762 if (r == -2)
1763 r = 0;
1764 self->pos = 0;
1765 return PyBytes_FromStringAndSize(self->buffer, r);
1766}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001767
1768
Benjamin Peterson59406a92009-03-26 17:10:29 +00001769
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001770/*
1771 * class BufferedWriter
1772 */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001773static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001774_bufferedwriter_reset_buf(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001775{
1776 self->write_pos = 0;
1777 self->write_end = -1;
1778}
1779
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001780/*[clinic input]
1781_io.BufferedWriter.__init__
1782 raw: object
1783 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001784
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001785A buffer for a writeable sequential RawIO object.
1786
1787The constructor creates a BufferedWriter for the given writeable raw
1788stream. If the buffer_size is not given, it defaults to
1789DEFAULT_BUFFER_SIZE.
1790[clinic start generated code]*/
1791
1792static int
1793_io_BufferedWriter___init___impl(buffered *self, PyObject *raw,
1794 Py_ssize_t buffer_size)
1795/*[clinic end generated code: output=c8942a020c0dee64 input=914be9b95e16007b]*/
1796{
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001797 self->ok = 0;
Benjamin Petersond2e0c792009-05-01 20:40:59 +00001798 self->detached = 0;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001799
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001800 if (_PyIOBase_check_writable(raw, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001801 return -1;
1802
1803 Py_CLEAR(self->raw);
1804 Py_INCREF(raw);
1805 self->raw = raw;
1806 self->readable = 0;
1807 self->writable = 1;
1808
1809 self->buffer_size = buffer_size;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001810 if (_buffered_init(self) < 0)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001811 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001812 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001813 self->pos = 0;
1814
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001815 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedWriter_Type &&
1816 Py_TYPE(raw) == &PyFileIO_Type);
1817
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001818 self->ok = 1;
1819 return 0;
1820}
1821
1822static Py_ssize_t
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001823_bufferedwriter_raw_write(buffered *self, char *start, Py_ssize_t len)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001824{
1825 Py_buffer buf;
1826 PyObject *memobj, *res;
1827 Py_ssize_t n;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001828 int errnum;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001829 /* NOTE: the buffer needn't be released as its object is NULL. */
1830 if (PyBuffer_FillInfo(&buf, NULL, start, len, 1, PyBUF_CONTIG_RO) == -1)
1831 return -1;
1832 memobj = PyMemoryView_FromBuffer(&buf);
1833 if (memobj == NULL)
1834 return -1;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001835 /* NOTE: PyErr_SetFromErrno() calls PyErr_CheckSignals() when EINTR
1836 occurs so we needn't do it ourselves.
1837 We then retry writing, ignoring the signal if no handler has
1838 raised (see issue #10956).
1839 */
1840 do {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001841 errno = 0;
Antoine Pitrou707ce822011-02-25 21:24:11 +00001842 res = PyObject_CallMethodObjArgs(self->raw, _PyIO_str_write, memobj, NULL);
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001843 errnum = errno;
Gregory P. Smith51359922012-06-23 23:55:39 -07001844 } while (res == NULL && _PyIO_trap_eintr());
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001845 Py_DECREF(memobj);
1846 if (res == NULL)
1847 return -1;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001848 if (res == Py_None) {
1849 /* Non-blocking stream would have blocked. Special return code!
1850 Being paranoid we reset errno in case it is changed by code
1851 triggered by a decref. errno is used by _set_BlockingIOError(). */
1852 Py_DECREF(res);
1853 errno = errnum;
1854 return -2;
1855 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001856 n = PyNumber_AsSsize_t(res, PyExc_ValueError);
1857 Py_DECREF(res);
1858 if (n < 0 || n > len) {
1859 PyErr_Format(PyExc_IOError,
1860 "raw write() returned invalid length %zd "
1861 "(should have been between 0 and %zd)", n, len);
1862 return -1;
1863 }
1864 if (n > 0 && self->abs_pos != -1)
1865 self->abs_pos += n;
1866 return n;
1867}
1868
1869/* `restore_pos` is 1 if we need to restore the raw stream position at
1870 the end, 0 otherwise. */
1871static PyObject *
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001872_bufferedwriter_flush_unlocked(buffered *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001873{
1874 Py_ssize_t written = 0;
1875 Py_off_t n, rewind;
1876
1877 if (!VALID_WRITE_BUFFER(self) || self->write_pos == self->write_end)
1878 goto end;
1879 /* First, rewind */
1880 rewind = RAW_OFFSET(self) + (self->pos - self->write_pos);
1881 if (rewind != 0) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001882 n = _buffered_raw_seek(self, -rewind, 1);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001883 if (n < 0) {
1884 goto error;
1885 }
1886 self->raw_pos -= rewind;
1887 }
1888 while (self->write_pos < self->write_end) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001889 n = _bufferedwriter_raw_write(self,
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001890 self->buffer + self->write_pos,
1891 Py_SAFE_DOWNCAST(self->write_end - self->write_pos,
1892 Py_off_t, Py_ssize_t));
1893 if (n == -1) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001894 goto error;
1895 }
1896 else if (n == -2) {
1897 _set_BlockingIOError("write could not complete without blocking",
1898 0);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001899 goto error;
1900 }
1901 self->write_pos += n;
1902 self->raw_pos = self->write_pos;
1903 written += Py_SAFE_DOWNCAST(n, Py_off_t, Py_ssize_t);
Antoine Pitroub46b9d52010-08-21 19:09:32 +00001904 /* Partial writes can return successfully when interrupted by a
1905 signal (see write(2)). We must run signal handlers before
1906 blocking another time, possibly indefinitely. */
1907 if (PyErr_CheckSignals() < 0)
1908 goto error;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001909 }
1910
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001911 _bufferedwriter_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001912
1913end:
1914 Py_RETURN_NONE;
1915
1916error:
1917 return NULL;
1918}
1919
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001920/*[clinic input]
1921_io.BufferedWriter.write
1922 buffer: Py_buffer
1923 /
1924[clinic start generated code]*/
1925
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001926static PyObject *
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001927_io_BufferedWriter_write_impl(buffered *self, Py_buffer *buffer)
1928/*[clinic end generated code: output=7f8d1365759bfc6b input=dd87dd85fc7f8850]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001929{
1930 PyObject *res = NULL;
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00001931 Py_ssize_t written, avail, remaining;
1932 Py_off_t offset;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001933
1934 CHECK_INITIALIZED(self)
Antoine Pitrou711af3a2009-04-11 15:39:24 +00001935 if (IS_CLOSED(self)) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001936 PyErr_SetString(PyExc_ValueError, "write to closed file");
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001937 return NULL;
1938 }
1939
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001940 if (!ENTER_BUFFERED(self))
Antoine Pitrouf3b68b32010-12-03 18:41:39 +00001941 return NULL;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001942
1943 /* Fast path: the data to write can be fully buffered. */
1944 if (!VALID_READ_BUFFER(self) && !VALID_WRITE_BUFFER(self)) {
1945 self->pos = 0;
1946 self->raw_pos = 0;
1947 }
1948 avail = Py_SAFE_DOWNCAST(self->buffer_size - self->pos, Py_off_t, Py_ssize_t);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001949 if (buffer->len <= avail) {
1950 memcpy(self->buffer + self->pos, buffer->buf, buffer->len);
Antoine Pitrou7c404892011-05-13 00:13:33 +02001951 if (!VALID_WRITE_BUFFER(self) || self->write_pos > self->pos) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001952 self->write_pos = self->pos;
1953 }
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001954 ADJUST_POSITION(self, self->pos + buffer->len);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001955 if (self->pos > self->write_end)
1956 self->write_end = self->pos;
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001957 written = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001958 goto end;
1959 }
1960
1961 /* First write the current buffer */
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001962 res = _bufferedwriter_flush_unlocked(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001963 if (res == NULL) {
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001964 Py_ssize_t *w = _buffered_check_blocking_error();
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001965 if (w == NULL)
1966 goto error;
1967 if (self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00001968 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001969 /* Make some place by shifting the buffer. */
1970 assert(VALID_WRITE_BUFFER(self));
1971 memmove(self->buffer, self->buffer + self->write_pos,
1972 Py_SAFE_DOWNCAST(self->write_end - self->write_pos,
1973 Py_off_t, Py_ssize_t));
1974 self->write_end -= self->write_pos;
1975 self->raw_pos -= self->write_pos;
1976 self->pos -= self->write_pos;
1977 self->write_pos = 0;
1978 avail = Py_SAFE_DOWNCAST(self->buffer_size - self->write_end,
1979 Py_off_t, Py_ssize_t);
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001980 if (buffer->len <= avail) {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001981 /* Everything can be buffered */
1982 PyErr_Clear();
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001983 memcpy(self->buffer + self->write_end, buffer->buf, buffer->len);
1984 self->write_end += buffer->len;
1985 self->pos += buffer->len;
1986 written = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001987 goto end;
1988 }
1989 /* Buffer as much as possible. */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03001990 memcpy(self->buffer + self->write_end, buffer->buf, avail);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001991 self->write_end += avail;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01001992 self->pos += avail;
1993 /* XXX Modifying the existing exception e using the pointer w
1994 will change e.characters_written but not e.args[2].
1995 Therefore we just replace with a new error. */
1996 _set_BlockingIOError("write could not complete without blocking",
1997 avail);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00001998 goto error;
1999 }
2000 Py_CLEAR(res);
2001
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002002 /* Adjust the raw stream position if it is away from the logical stream
2003 position. This happens if the read buffer has been filled but not
2004 modified (and therefore _bufferedwriter_flush_unlocked() didn't rewind
2005 the raw stream by itself).
2006 Fixes issue #6629.
2007 */
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002008 offset = RAW_OFFSET(self);
2009 if (offset != 0) {
2010 if (_buffered_raw_seek(self, -offset, 1) < 0)
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002011 goto error;
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002012 self->raw_pos -= offset;
Antoine Pitroua0ceb732009-08-06 20:29:56 +00002013 }
2014
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002015 /* Then write buf itself. At this point the buffer has been emptied. */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002016 remaining = buffer->len;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002017 written = 0;
2018 while (remaining > self->buffer_size) {
Amaury Forgeot d'Arce1b60d42009-10-05 21:09:00 +00002019 Py_ssize_t n = _bufferedwriter_raw_write(
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002020 self, (char *) buffer->buf + written, buffer->len - written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002021 if (n == -1) {
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002022 goto error;
2023 } else if (n == -2) {
2024 /* Write failed because raw file is non-blocking */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002025 if (remaining > self->buffer_size) {
2026 /* Can't buffer everything, still buffer as much as possible */
2027 memcpy(self->buffer,
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002028 (char *) buffer->buf + written, self->buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002029 self->raw_pos = 0;
2030 ADJUST_POSITION(self, self->buffer_size);
2031 self->write_end = self->buffer_size;
Antoine Pitrou58fcf9f2011-11-21 20:16:44 +01002032 written += self->buffer_size;
2033 _set_BlockingIOError("write could not complete without "
2034 "blocking", written);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002035 goto error;
2036 }
2037 PyErr_Clear();
2038 break;
2039 }
2040 written += n;
2041 remaining -= n;
Antoine Pitroub46b9d52010-08-21 19:09:32 +00002042 /* Partial writes can return successfully when interrupted by a
2043 signal (see write(2)). We must run signal handlers before
2044 blocking another time, possibly indefinitely. */
2045 if (PyErr_CheckSignals() < 0)
2046 goto error;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002047 }
2048 if (self->readable)
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002049 _bufferedreader_reset_buf(self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002050 if (remaining > 0) {
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002051 memcpy(self->buffer, (char *) buffer->buf + written, remaining);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002052 written += remaining;
2053 }
2054 self->write_pos = 0;
2055 /* TODO: sanity check (remaining >= 0) */
2056 self->write_end = remaining;
2057 ADJUST_POSITION(self, remaining);
2058 self->raw_pos = 0;
2059
2060end:
2061 res = PyLong_FromSsize_t(written);
2062
2063error:
2064 LEAVE_BUFFERED(self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002065 return res;
2066}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002067
2068
2069
2070/*
2071 * BufferedRWPair
2072 */
2073
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002074/* XXX The usefulness of this (compared to having two separate IO objects) is
2075 * questionable.
2076 */
2077
2078typedef struct {
2079 PyObject_HEAD
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002080 buffered *reader;
2081 buffered *writer;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002082 PyObject *dict;
2083 PyObject *weakreflist;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002084} rwpair;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002085
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002086/*[clinic input]
2087_io.BufferedRWPair.__init__
2088 reader: object
2089 writer: object
2090 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
2091 /
2092
2093A buffered reader and writer object together.
2094
2095A buffered reader object and buffered writer object put together to
2096form a sequential IO object that can read and write. This is typically
2097used with a socket or two-way pipe.
2098
2099reader and writer are RawIOBase objects that are readable and
2100writeable respectively. If the buffer_size is omitted it defaults to
2101DEFAULT_BUFFER_SIZE.
2102[clinic start generated code]*/
2103
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002104static int
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002105_io_BufferedRWPair___init___impl(rwpair *self, PyObject *reader,
2106 PyObject *writer, Py_ssize_t buffer_size)
2107/*[clinic end generated code: output=327e73d1aee8f984 input=620d42d71f33a031]*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002108{
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002109 if (_PyIOBase_check_readable(reader, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002110 return -1;
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002111 if (_PyIOBase_check_writable(writer, Py_True) == NULL)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002112 return -1;
2113
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002114 self->reader = (buffered *) PyObject_CallFunction(
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002115 (PyObject *) &PyBufferedReader_Type, "On", reader, buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002116 if (self->reader == NULL)
2117 return -1;
2118
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002119 self->writer = (buffered *) PyObject_CallFunction(
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002120 (PyObject *) &PyBufferedWriter_Type, "On", writer, buffer_size);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002121 if (self->writer == NULL) {
2122 Py_CLEAR(self->reader);
2123 return -1;
2124 }
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002125
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002126 return 0;
2127}
2128
2129static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002130bufferedrwpair_traverse(rwpair *self, visitproc visit, void *arg)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002131{
2132 Py_VISIT(self->dict);
2133 return 0;
2134}
2135
2136static int
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002137bufferedrwpair_clear(rwpair *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002138{
2139 Py_CLEAR(self->reader);
2140 Py_CLEAR(self->writer);
2141 Py_CLEAR(self->dict);
2142 return 0;
2143}
2144
2145static void
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002146bufferedrwpair_dealloc(rwpair *self)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002147{
2148 _PyObject_GC_UNTRACK(self);
Benjamin Petersonbbd0a322014-09-29 22:46:57 -04002149 if (self->weakreflist != NULL)
2150 PyObject_ClearWeakRefs((PyObject *)self);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002151 Py_CLEAR(self->reader);
2152 Py_CLEAR(self->writer);
2153 Py_CLEAR(self->dict);
2154 Py_TYPE(self)->tp_free((PyObject *) self);
2155}
2156
2157static PyObject *
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002158_forward_call(buffered *self, _Py_Identifier *name, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002159{
Serhiy Storchaka61e24932014-02-12 10:52:35 +02002160 PyObject *func, *ret;
2161 if (self == NULL) {
2162 PyErr_SetString(PyExc_ValueError,
2163 "I/O operation on uninitialized object");
2164 return NULL;
2165 }
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002166
Serhiy Storchaka61e24932014-02-12 10:52:35 +02002167 func = _PyObject_GetAttrId((PyObject *)self, name);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002168 if (func == NULL) {
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002169 PyErr_SetString(PyExc_AttributeError, name->string);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002170 return NULL;
2171 }
2172
2173 ret = PyObject_CallObject(func, args);
2174 Py_DECREF(func);
2175 return ret;
2176}
2177
2178static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002179bufferedrwpair_read(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002180{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002181 return _forward_call(self->reader, &PyId_read, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002182}
2183
2184static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002185bufferedrwpair_peek(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002186{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002187 return _forward_call(self->reader, &PyId_peek, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002188}
2189
2190static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002191bufferedrwpair_read1(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002192{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002193 return _forward_call(self->reader, &PyId_read1, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002194}
2195
2196static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002197bufferedrwpair_readinto(rwpair *self, PyObject *args)
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002198{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002199 return _forward_call(self->reader, &PyId_readinto, args);
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002200}
2201
2202static PyObject *
Benjamin Petersona96fea02014-06-22 14:17:44 -07002203bufferedrwpair_readinto1(rwpair *self, PyObject *args)
2204{
2205 return _forward_call(self->reader, &PyId_readinto1, args);
2206}
2207
2208static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002209bufferedrwpair_write(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002210{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002211 return _forward_call(self->writer, &PyId_write, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002212}
2213
2214static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002215bufferedrwpair_flush(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002216{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002217 return _forward_call(self->writer, &PyId_flush, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002218}
2219
2220static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002221bufferedrwpair_readable(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002222{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002223 return _forward_call(self->reader, &PyId_readable, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002224}
2225
2226static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002227bufferedrwpair_writable(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002228{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002229 return _forward_call(self->writer, &PyId_writable, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002230}
2231
2232static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002233bufferedrwpair_close(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002234{
Serhiy Storchaka7665be62015-03-24 23:21:57 +02002235 PyObject *exc = NULL, *val, *tb;
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002236 PyObject *ret = _forward_call(self->writer, &PyId_close, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002237 if (ret == NULL)
Serhiy Storchaka7665be62015-03-24 23:21:57 +02002238 PyErr_Fetch(&exc, &val, &tb);
2239 else
2240 Py_DECREF(ret);
2241 ret = _forward_call(self->reader, &PyId_close, args);
2242 if (exc != NULL) {
2243 _PyErr_ChainExceptions(exc, val, tb);
2244 Py_CLEAR(ret);
2245 }
2246 return ret;
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002247}
2248
2249static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002250bufferedrwpair_isatty(rwpair *self, PyObject *args)
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002251{
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002252 PyObject *ret = _forward_call(self->writer, &PyId_isatty, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002253
2254 if (ret != Py_False) {
2255 /* either True or exception */
2256 return ret;
2257 }
2258 Py_DECREF(ret);
2259
Martin v. Löwisafe55bb2011-10-09 10:38:36 +02002260 return _forward_call(self->reader, &PyId_isatty, args);
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002261}
2262
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002263static PyObject *
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002264bufferedrwpair_closed_get(rwpair *self, void *context)
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002265{
Charles-François Natali42c28cd2011-10-05 19:53:43 +02002266 if (self->writer == NULL) {
2267 PyErr_SetString(PyExc_RuntimeError,
2268 "the BufferedRWPair object is being garbage-collected");
2269 return NULL;
2270 }
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002271 return PyObject_GetAttr((PyObject *) self->writer, _PyIO_str_closed);
2272}
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002273
2274
2275
2276/*
2277 * BufferedRandom
2278 */
2279
2280/*[clinic input]
2281_io.BufferedRandom.__init__
2282 raw: object
2283 buffer_size: Py_ssize_t(c_default="DEFAULT_BUFFER_SIZE") = DEFAULT_BUFFER_SIZE
2284
2285A buffered interface to random access streams.
2286
2287The constructor creates a reader and writer for a seekable stream,
2288raw, given in the first argument. If the buffer_size is omitted it
2289defaults to DEFAULT_BUFFER_SIZE.
2290[clinic start generated code]*/
2291
2292static int
2293_io_BufferedRandom___init___impl(buffered *self, PyObject *raw,
2294 Py_ssize_t buffer_size)
2295/*[clinic end generated code: output=d3d64eb0f64e64a3 input=a4e818fb86d0e50c]*/
2296{
2297 self->ok = 0;
2298 self->detached = 0;
2299
2300 if (_PyIOBase_check_seekable(raw, Py_True) == NULL)
2301 return -1;
2302 if (_PyIOBase_check_readable(raw, Py_True) == NULL)
2303 return -1;
2304 if (_PyIOBase_check_writable(raw, Py_True) == NULL)
2305 return -1;
2306
2307 Py_CLEAR(self->raw);
2308 Py_INCREF(raw);
2309 self->raw = raw;
2310 self->buffer_size = buffer_size;
2311 self->readable = 1;
2312 self->writable = 1;
2313
2314 if (_buffered_init(self) < 0)
2315 return -1;
2316 _bufferedreader_reset_buf(self);
2317 _bufferedwriter_reset_buf(self);
2318 self->pos = 0;
2319
2320 self->fast_closed_checks = (Py_TYPE(self) == &PyBufferedRandom_Type &&
2321 Py_TYPE(raw) == &PyFileIO_Type);
2322
2323 self->ok = 1;
2324 return 0;
2325}
2326
2327#include "clinic/bufferedio.c.h"
2328
2329
2330static PyMethodDef bufferediobase_methods[] = {
2331 _IO__BUFFEREDIOBASE_DETACH_METHODDEF
2332 {"read", bufferediobase_read, METH_VARARGS, bufferediobase_read_doc},
2333 {"read1", bufferediobase_read1, METH_VARARGS, bufferediobase_read1_doc},
2334 _IO__BUFFEREDIOBASE_READINTO_METHODDEF
2335 _IO__BUFFEREDIOBASE_READINTO1_METHODDEF
2336 {"write", bufferediobase_write, METH_VARARGS, bufferediobase_write_doc},
2337 {NULL, NULL}
2338};
2339
2340PyTypeObject PyBufferedIOBase_Type = {
2341 PyVarObject_HEAD_INIT(NULL, 0)
2342 "_io._BufferedIOBase", /*tp_name*/
2343 0, /*tp_basicsize*/
2344 0, /*tp_itemsize*/
2345 0, /*tp_dealloc*/
2346 0, /*tp_print*/
2347 0, /*tp_getattr*/
2348 0, /*tp_setattr*/
2349 0, /*tp_compare */
2350 0, /*tp_repr*/
2351 0, /*tp_as_number*/
2352 0, /*tp_as_sequence*/
2353 0, /*tp_as_mapping*/
2354 0, /*tp_hash */
2355 0, /*tp_call*/
2356 0, /*tp_str*/
2357 0, /*tp_getattro*/
2358 0, /*tp_setattro*/
2359 0, /*tp_as_buffer*/
2360 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2361 | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2362 bufferediobase_doc, /* tp_doc */
2363 0, /* tp_traverse */
2364 0, /* tp_clear */
2365 0, /* tp_richcompare */
2366 0, /* tp_weaklistoffset */
2367 0, /* tp_iter */
2368 0, /* tp_iternext */
2369 bufferediobase_methods, /* tp_methods */
2370 0, /* tp_members */
2371 0, /* tp_getset */
2372 &PyIOBase_Type, /* tp_base */
2373 0, /* tp_dict */
2374 0, /* tp_descr_get */
2375 0, /* tp_descr_set */
2376 0, /* tp_dictoffset */
2377 0, /* tp_init */
2378 0, /* tp_alloc */
2379 0, /* tp_new */
2380 0, /* tp_free */
2381 0, /* tp_is_gc */
2382 0, /* tp_bases */
2383 0, /* tp_mro */
2384 0, /* tp_cache */
2385 0, /* tp_subclasses */
2386 0, /* tp_weaklist */
2387 0, /* tp_del */
2388 0, /* tp_version_tag */
2389 0, /* tp_finalize */
2390};
2391
2392
2393static PyMethodDef bufferedreader_methods[] = {
2394 /* BufferedIOMixin methods */
2395 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2396 {"flush", (PyCFunction)buffered_simple_flush, METH_NOARGS},
2397 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2398 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2399 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
2400 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2401 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2402 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
2403 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
2404 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2405
2406 _IO__BUFFERED_READ_METHODDEF
2407 _IO__BUFFERED_PEEK_METHODDEF
2408 _IO__BUFFERED_READ1_METHODDEF
2409 _IO__BUFFERED_READINTO_METHODDEF
2410 _IO__BUFFERED_READINTO1_METHODDEF
2411 _IO__BUFFERED_READLINE_METHODDEF
2412 _IO__BUFFERED_SEEK_METHODDEF
2413 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
2414 _IO__BUFFERED_TRUNCATE_METHODDEF
2415 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
2416 {NULL, NULL}
2417};
2418
2419static PyMemberDef bufferedreader_members[] = {
2420 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
2421 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
2422 {NULL}
2423};
2424
2425static PyGetSetDef bufferedreader_getset[] = {
2426 {"closed", (getter)buffered_closed_get, NULL, NULL},
2427 {"name", (getter)buffered_name_get, NULL, NULL},
2428 {"mode", (getter)buffered_mode_get, NULL, NULL},
2429 {NULL}
2430};
2431
2432
2433PyTypeObject PyBufferedReader_Type = {
2434 PyVarObject_HEAD_INIT(NULL, 0)
2435 "_io.BufferedReader", /*tp_name*/
2436 sizeof(buffered), /*tp_basicsize*/
2437 0, /*tp_itemsize*/
2438 (destructor)buffered_dealloc, /*tp_dealloc*/
2439 0, /*tp_print*/
2440 0, /*tp_getattr*/
2441 0, /*tp_setattr*/
2442 0, /*tp_compare */
2443 (reprfunc)buffered_repr, /*tp_repr*/
2444 0, /*tp_as_number*/
2445 0, /*tp_as_sequence*/
2446 0, /*tp_as_mapping*/
2447 0, /*tp_hash */
2448 0, /*tp_call*/
2449 0, /*tp_str*/
2450 0, /*tp_getattro*/
2451 0, /*tp_setattro*/
2452 0, /*tp_as_buffer*/
2453 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2454 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2455 _io_BufferedReader___init____doc__, /* tp_doc */
2456 (traverseproc)buffered_traverse, /* tp_traverse */
2457 (inquiry)buffered_clear, /* tp_clear */
2458 0, /* tp_richcompare */
2459 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
2460 0, /* tp_iter */
2461 (iternextfunc)buffered_iternext, /* tp_iternext */
2462 bufferedreader_methods, /* tp_methods */
2463 bufferedreader_members, /* tp_members */
2464 bufferedreader_getset, /* tp_getset */
2465 0, /* tp_base */
2466 0, /* tp_dict */
2467 0, /* tp_descr_get */
2468 0, /* tp_descr_set */
2469 offsetof(buffered, dict), /* tp_dictoffset */
2470 _io_BufferedReader___init__, /* tp_init */
2471 0, /* tp_alloc */
2472 PyType_GenericNew, /* tp_new */
2473 0, /* tp_free */
2474 0, /* tp_is_gc */
2475 0, /* tp_bases */
2476 0, /* tp_mro */
2477 0, /* tp_cache */
2478 0, /* tp_subclasses */
2479 0, /* tp_weaklist */
2480 0, /* tp_del */
2481 0, /* tp_version_tag */
2482 0, /* tp_finalize */
2483};
2484
2485
2486static PyMethodDef bufferedwriter_methods[] = {
2487 /* BufferedIOMixin methods */
2488 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2489 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2490 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2491 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
2492 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2493 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2494 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
2495 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
2496 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2497
2498 _IO_BUFFEREDWRITER_WRITE_METHODDEF
2499 _IO__BUFFERED_TRUNCATE_METHODDEF
2500 {"flush", (PyCFunction)buffered_flush, METH_NOARGS},
2501 _IO__BUFFERED_SEEK_METHODDEF
2502 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
2503 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
2504 {NULL, NULL}
2505};
2506
2507static PyMemberDef bufferedwriter_members[] = {
2508 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
2509 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
2510 {NULL}
2511};
2512
2513static PyGetSetDef bufferedwriter_getset[] = {
2514 {"closed", (getter)buffered_closed_get, NULL, NULL},
2515 {"name", (getter)buffered_name_get, NULL, NULL},
2516 {"mode", (getter)buffered_mode_get, NULL, NULL},
2517 {NULL}
2518};
2519
2520
2521PyTypeObject PyBufferedWriter_Type = {
2522 PyVarObject_HEAD_INIT(NULL, 0)
2523 "_io.BufferedWriter", /*tp_name*/
2524 sizeof(buffered), /*tp_basicsize*/
2525 0, /*tp_itemsize*/
2526 (destructor)buffered_dealloc, /*tp_dealloc*/
2527 0, /*tp_print*/
2528 0, /*tp_getattr*/
2529 0, /*tp_setattr*/
2530 0, /*tp_compare */
2531 (reprfunc)buffered_repr, /*tp_repr*/
2532 0, /*tp_as_number*/
2533 0, /*tp_as_sequence*/
2534 0, /*tp_as_mapping*/
2535 0, /*tp_hash */
2536 0, /*tp_call*/
2537 0, /*tp_str*/
2538 0, /*tp_getattro*/
2539 0, /*tp_setattro*/
2540 0, /*tp_as_buffer*/
2541 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
2542 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
2543 _io_BufferedWriter___init____doc__, /* tp_doc */
2544 (traverseproc)buffered_traverse, /* tp_traverse */
2545 (inquiry)buffered_clear, /* tp_clear */
2546 0, /* tp_richcompare */
2547 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
2548 0, /* tp_iter */
2549 0, /* tp_iternext */
2550 bufferedwriter_methods, /* tp_methods */
2551 bufferedwriter_members, /* tp_members */
2552 bufferedwriter_getset, /* tp_getset */
2553 0, /* tp_base */
2554 0, /* tp_dict */
2555 0, /* tp_descr_get */
2556 0, /* tp_descr_set */
2557 offsetof(buffered, dict), /* tp_dictoffset */
2558 _io_BufferedWriter___init__, /* tp_init */
2559 0, /* tp_alloc */
2560 PyType_GenericNew, /* tp_new */
2561 0, /* tp_free */
2562 0, /* tp_is_gc */
2563 0, /* tp_bases */
2564 0, /* tp_mro */
2565 0, /* tp_cache */
2566 0, /* tp_subclasses */
2567 0, /* tp_weaklist */
2568 0, /* tp_del */
2569 0, /* tp_version_tag */
2570 0, /* tp_finalize */
2571};
2572
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002573
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002574static PyMethodDef bufferedrwpair_methods[] = {
2575 {"read", (PyCFunction)bufferedrwpair_read, METH_VARARGS},
2576 {"peek", (PyCFunction)bufferedrwpair_peek, METH_VARARGS},
2577 {"read1", (PyCFunction)bufferedrwpair_read1, METH_VARARGS},
2578 {"readinto", (PyCFunction)bufferedrwpair_readinto, METH_VARARGS},
Benjamin Petersona96fea02014-06-22 14:17:44 -07002579 {"readinto1", (PyCFunction)bufferedrwpair_readinto1, METH_VARARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002580
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002581 {"write", (PyCFunction)bufferedrwpair_write, METH_VARARGS},
2582 {"flush", (PyCFunction)bufferedrwpair_flush, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002583
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002584 {"readable", (PyCFunction)bufferedrwpair_readable, METH_NOARGS},
2585 {"writable", (PyCFunction)bufferedrwpair_writable, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002586
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002587 {"close", (PyCFunction)bufferedrwpair_close, METH_NOARGS},
2588 {"isatty", (PyCFunction)bufferedrwpair_isatty, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002589
Antoine Pitrou243757e2010-11-05 21:15:39 +00002590 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
2591
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002592 {NULL, NULL}
2593};
2594
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002595static PyGetSetDef bufferedrwpair_getset[] = {
2596 {"closed", (getter)bufferedrwpair_closed_get, NULL, NULL},
Benjamin Peterson1fea3212009-04-19 03:15:20 +00002597 {NULL}
Antoine Pitroucf4c7492009-04-19 00:09:36 +00002598};
2599
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002600PyTypeObject PyBufferedRWPair_Type = {
2601 PyVarObject_HEAD_INIT(NULL, 0)
2602 "_io.BufferedRWPair", /*tp_name*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002603 sizeof(rwpair), /*tp_basicsize*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002604 0, /*tp_itemsize*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002605 (destructor)bufferedrwpair_dealloc, /*tp_dealloc*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002606 0, /*tp_print*/
2607 0, /*tp_getattr*/
2608 0, /*tp_setattr*/
2609 0, /*tp_compare */
2610 0, /*tp_repr*/
2611 0, /*tp_as_number*/
2612 0, /*tp_as_sequence*/
2613 0, /*tp_as_mapping*/
2614 0, /*tp_hash */
2615 0, /*tp_call*/
2616 0, /*tp_str*/
2617 0, /*tp_getattro*/
2618 0, /*tp_setattro*/
2619 0, /*tp_as_buffer*/
2620 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
Antoine Pitrou796564c2013-07-30 19:59:21 +02002621 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /* tp_flags */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002622 _io_BufferedRWPair___init____doc__, /* tp_doc */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002623 (traverseproc)bufferedrwpair_traverse, /* tp_traverse */
2624 (inquiry)bufferedrwpair_clear, /* tp_clear */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002625 0, /* tp_richcompare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002626 offsetof(rwpair, weakreflist), /*tp_weaklistoffset*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002627 0, /* tp_iter */
2628 0, /* tp_iternext */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002629 bufferedrwpair_methods, /* tp_methods */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002630 0, /* tp_members */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002631 bufferedrwpair_getset, /* tp_getset */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002632 0, /* tp_base */
2633 0, /* tp_dict */
2634 0, /* tp_descr_get */
2635 0, /* tp_descr_set */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002636 offsetof(rwpair, dict), /* tp_dictoffset */
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002637 _io_BufferedRWPair___init__, /* tp_init */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002638 0, /* tp_alloc */
2639 PyType_GenericNew, /* tp_new */
Antoine Pitrou796564c2013-07-30 19:59:21 +02002640 0, /* tp_free */
2641 0, /* tp_is_gc */
2642 0, /* tp_bases */
2643 0, /* tp_mro */
2644 0, /* tp_cache */
2645 0, /* tp_subclasses */
2646 0, /* tp_weaklist */
2647 0, /* tp_del */
2648 0, /* tp_version_tag */
2649 0, /* tp_finalize */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002650};
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002651
2652
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002653static PyMethodDef bufferedrandom_methods[] = {
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002654 /* BufferedIOMixin methods */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002655 {"close", (PyCFunction)buffered_close, METH_NOARGS},
2656 {"detach", (PyCFunction)buffered_detach, METH_NOARGS},
2657 {"seekable", (PyCFunction)buffered_seekable, METH_NOARGS},
2658 {"readable", (PyCFunction)buffered_readable, METH_NOARGS},
2659 {"writable", (PyCFunction)buffered_writable, METH_NOARGS},
2660 {"fileno", (PyCFunction)buffered_fileno, METH_NOARGS},
2661 {"isatty", (PyCFunction)buffered_isatty, METH_NOARGS},
Antoine Pitroue033e062010-10-29 10:38:18 +00002662 {"_dealloc_warn", (PyCFunction)buffered_dealloc_warn, METH_O},
Antoine Pitrou243757e2010-11-05 21:15:39 +00002663 {"__getstate__", (PyCFunction)buffered_getstate, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002664
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002665 {"flush", (PyCFunction)buffered_flush, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002666
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002667 _IO__BUFFERED_SEEK_METHODDEF
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002668 {"tell", (PyCFunction)buffered_tell, METH_NOARGS},
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002669 _IO__BUFFERED_TRUNCATE_METHODDEF
2670 _IO__BUFFERED_READ_METHODDEF
2671 _IO__BUFFERED_READ1_METHODDEF
2672 _IO__BUFFERED_READINTO_METHODDEF
2673 _IO__BUFFERED_READINTO1_METHODDEF
2674 _IO__BUFFERED_READLINE_METHODDEF
2675 _IO__BUFFERED_PEEK_METHODDEF
2676 _IO_BUFFEREDWRITER_WRITE_METHODDEF
Antoine Pitrou10f0c502012-07-29 19:02:46 +02002677 {"__sizeof__", (PyCFunction)buffered_sizeof, METH_NOARGS},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002678 {NULL, NULL}
2679};
2680
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002681static PyMemberDef bufferedrandom_members[] = {
Antoine Pitrou7f8f4182010-12-21 21:20:59 +00002682 {"raw", T_OBJECT, offsetof(buffered, raw), READONLY},
Antoine Pitrou796564c2013-07-30 19:59:21 +02002683 {"_finalizing", T_BOOL, offsetof(buffered, finalizing), 0},
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002684 {NULL}
2685};
2686
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002687static PyGetSetDef bufferedrandom_getset[] = {
2688 {"closed", (getter)buffered_closed_get, NULL, NULL},
2689 {"name", (getter)buffered_name_get, NULL, NULL},
2690 {"mode", (getter)buffered_mode_get, NULL, NULL},
Benjamin Peterson1fea3212009-04-19 03:15:20 +00002691 {NULL}
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002692};
2693
2694
2695PyTypeObject PyBufferedRandom_Type = {
2696 PyVarObject_HEAD_INIT(NULL, 0)
2697 "_io.BufferedRandom", /*tp_name*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002698 sizeof(buffered), /*tp_basicsize*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002699 0, /*tp_itemsize*/
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002700 (destructor)buffered_dealloc, /*tp_dealloc*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002701 0, /*tp_print*/
2702 0, /*tp_getattr*/
2703 0, /*tp_setattr*/
2704 0, /*tp_compare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002705 (reprfunc)buffered_repr, /*tp_repr*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002706 0, /*tp_as_number*/
2707 0, /*tp_as_sequence*/
2708 0, /*tp_as_mapping*/
2709 0, /*tp_hash */
2710 0, /*tp_call*/
2711 0, /*tp_str*/
2712 0, /*tp_getattro*/
2713 0, /*tp_setattro*/
2714 0, /*tp_as_buffer*/
2715 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE
Antoine Pitrou796564c2013-07-30 19:59:21 +02002716 | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_HAVE_FINALIZE, /*tp_flags*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002717 _io_BufferedRandom___init____doc__, /* tp_doc */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002718 (traverseproc)buffered_traverse, /* tp_traverse */
2719 (inquiry)buffered_clear, /* tp_clear */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002720 0, /* tp_richcompare */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002721 offsetof(buffered, weakreflist), /*tp_weaklistoffset*/
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002722 0, /* tp_iter */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002723 (iternextfunc)buffered_iternext, /* tp_iternext */
2724 bufferedrandom_methods, /* tp_methods */
2725 bufferedrandom_members, /* tp_members */
2726 bufferedrandom_getset, /* tp_getset */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002727 0, /* tp_base */
2728 0, /*tp_dict*/
2729 0, /* tp_descr_get */
2730 0, /* tp_descr_set */
Benjamin Peterson680bf1a2009-06-12 02:07:12 +00002731 offsetof(buffered, dict), /*tp_dictoffset*/
Serhiy Storchakaf24131f2015-04-16 11:19:43 +03002732 _io_BufferedRandom___init__, /* tp_init */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002733 0, /* tp_alloc */
2734 PyType_GenericNew, /* tp_new */
Antoine Pitrou796564c2013-07-30 19:59:21 +02002735 0, /* tp_free */
2736 0, /* tp_is_gc */
2737 0, /* tp_bases */
2738 0, /* tp_mro */
2739 0, /* tp_cache */
2740 0, /* tp_subclasses */
2741 0, /* tp_weaklist */
2742 0, /* tp_del */
2743 0, /* tp_version_tag */
2744 0, /* tp_finalize */
Benjamin Peterson4fa88fa2009-03-04 00:14:51 +00002745};