blob: f0c8fedc3324839341bab276613c7c288cdd4089 [file] [log] [blame]
Guido van Rossuma9e20242007-03-08 00:43:48 +00001/* Author: Daniel Stutzbach */
2
3#define PY_SSIZE_T_CLEAN
4#include "Python.h"
5#include <sys/types.h>
6#include <sys/stat.h>
7#include <fcntl.h>
8#include <stddef.h> /* For offsetof */
9
10/*
11 * Known likely problems:
12 *
13 * - Files larger then 2**32-1
14 * - Files with unicode filenames
15 * - Passing numbers greater than 2**32-1 when an integer is expected
16 * - Making it work on Windows and other oddball platforms
17 *
18 * To Do:
19 *
20 * - autoconfify header file inclusion
Guido van Rossuma9e20242007-03-08 00:43:48 +000021 */
22
23#ifdef MS_WINDOWS
24/* can simulate truncate with Win32 API functions; see file_truncate */
Thomas Hellerfdeee3a2007-07-12 11:21:36 +000025#define HAVE_FTRUNCATE
Guido van Rossuma9e20242007-03-08 00:43:48 +000026#define WIN32_LEAN_AND_MEAN
27#include <windows.h>
28#endif
29
30typedef struct {
31 PyObject_HEAD
32 int fd;
Neal Norwitz88b44da2007-08-12 17:23:54 +000033 unsigned readable : 1;
34 unsigned writable : 1;
35 int seekable : 2; /* -1 means unknown */
Guido van Rossum2dced8b2007-10-30 17:27:30 +000036 int closefd : 1;
Guido van Rossuma9e20242007-03-08 00:43:48 +000037 PyObject *weakreflist;
38} PyFileIOObject;
39
Collin Winteraf334382007-03-08 21:46:15 +000040PyTypeObject PyFileIO_Type;
41
Guido van Rossuma9e20242007-03-08 00:43:48 +000042#define PyFileIO_Check(op) (PyObject_TypeCheck((op), &PyFileIO_Type))
43
Neal Norwitz88b44da2007-08-12 17:23:54 +000044/* Returns 0 on success, errno (which is < 0) on failure. */
45static int
46internal_close(PyFileIOObject *self)
Guido van Rossuma9e20242007-03-08 00:43:48 +000047{
Neal Norwitz88b44da2007-08-12 17:23:54 +000048 int save_errno = 0;
Guido van Rossuma9e20242007-03-08 00:43:48 +000049 if (self->fd >= 0) {
Guido van Rossumb0428152007-04-08 17:44:42 +000050 int fd = self->fd;
51 self->fd = -1;
Guido van Rossuma9e20242007-03-08 00:43:48 +000052 Py_BEGIN_ALLOW_THREADS
Neal Norwitz88b44da2007-08-12 17:23:54 +000053 if (close(fd) < 0)
54 save_errno = errno;
Guido van Rossuma9e20242007-03-08 00:43:48 +000055 Py_END_ALLOW_THREADS
Neal Norwitz88b44da2007-08-12 17:23:54 +000056 }
57 return save_errno;
58}
59
60static PyObject *
61fileio_close(PyFileIOObject *self)
62{
Guido van Rossum2dced8b2007-10-30 17:27:30 +000063 if (!self->closefd) {
64 if (PyErr_WarnEx(PyExc_RuntimeWarning,
65 "Trying to close unclosable fd!", 3) < 0) {
66 return NULL;
67 }
68 Py_RETURN_NONE;
69 }
Neal Norwitz88b44da2007-08-12 17:23:54 +000070 errno = internal_close(self);
71 if (errno < 0) {
72 PyErr_SetFromErrno(PyExc_IOError);
73 return NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +000074 }
75
76 Py_RETURN_NONE;
77}
78
79static PyObject *
80fileio_new(PyTypeObject *type, PyObject *args, PyObject *kews)
81{
82 PyFileIOObject *self;
83
84 assert(type != NULL && type->tp_alloc != NULL);
85
86 self = (PyFileIOObject *) type->tp_alloc(type, 0);
87 if (self != NULL) {
88 self->fd = -1;
89 self->weakreflist = NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +000090 }
91
92 return (PyObject *) self;
93}
94
95/* On Unix, open will succeed for directories.
96 In Python, there should be no file objects referring to
97 directories, so we need a check. */
98
99static int
100dircheck(PyFileIOObject* self)
101{
102#if defined(HAVE_FSTAT) && defined(S_IFDIR) && defined(EISDIR)
103 struct stat buf;
104 if (self->fd < 0)
105 return 0;
106 if (fstat(self->fd, &buf) == 0 && S_ISDIR(buf.st_mode)) {
Guido van Rossuma9e20242007-03-08 00:43:48 +0000107 char *msg = strerror(EISDIR);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000108 PyObject *exc;
Neal Norwitz88b44da2007-08-12 17:23:54 +0000109 internal_close(self);
Guido van Rossum53807da2007-04-10 19:01:47 +0000110
Guido van Rossuma9e20242007-03-08 00:43:48 +0000111 exc = PyObject_CallFunction(PyExc_IOError, "(is)",
112 EISDIR, msg);
113 PyErr_SetObject(PyExc_IOError, exc);
114 Py_XDECREF(exc);
115 return -1;
116 }
117#endif
118 return 0;
119}
120
121
122static int
123fileio_init(PyObject *oself, PyObject *args, PyObject *kwds)
124{
125 PyFileIOObject *self = (PyFileIOObject *) oself;
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000126 static char *kwlist[] = {"file", "mode", "closefd", NULL};
Guido van Rossuma9e20242007-03-08 00:43:48 +0000127 char *name = NULL;
128 char *mode = "r";
Guido van Rossum53807da2007-04-10 19:01:47 +0000129 char *s;
Thomas Helleraf2be262007-07-12 11:03:13 +0000130#ifdef MS_WINDOWS
131 Py_UNICODE *widename = NULL;
132#endif
Guido van Rossuma9e20242007-03-08 00:43:48 +0000133 int ret = 0;
134 int rwa = 0, plus = 0, append = 0;
135 int flags = 0;
Guido van Rossumb0428152007-04-08 17:44:42 +0000136 int fd = -1;
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000137 int closefd = 1;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000138
139 assert(PyFileIO_Check(oself));
Neal Norwitz88b44da2007-08-12 17:23:54 +0000140 if (self->fd >= 0) {
Guido van Rossuma9e20242007-03-08 00:43:48 +0000141 /* Have to close the existing file first. */
Neal Norwitz88b44da2007-08-12 17:23:54 +0000142 if (internal_close(self) < 0)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000143 return -1;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000144 }
145
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000146 if (PyArg_ParseTupleAndKeywords(args, kwds, "i|si:fileio",
147 kwlist, &fd, &mode, &closefd)) {
Guido van Rossumb0428152007-04-08 17:44:42 +0000148 if (fd < 0) {
149 PyErr_SetString(PyExc_ValueError,
150 "Negative filedescriptor");
151 return -1;
152 }
153 }
154 else {
155 PyErr_Clear();
156
Guido van Rossuma9e20242007-03-08 00:43:48 +0000157#ifdef Py_WIN_WIDE_FILENAMES
Guido van Rossumb0428152007-04-08 17:44:42 +0000158 if (GetVersion() < 0x80000000) {
159 /* On NT, so wide API available */
Guido van Rossuma9e20242007-03-08 00:43:48 +0000160 PyObject *po;
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000161 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:fileio",
162 kwlist, &po, &mode, &closefd)
163 ) {
Thomas Helleraf2be262007-07-12 11:03:13 +0000164 widename = PyUnicode_AS_UNICODE(po);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000165 } else {
166 /* Drop the argument parsing error as narrow
167 strings are also valid. */
168 PyErr_Clear();
169 }
Guido van Rossumb0428152007-04-08 17:44:42 +0000170 }
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000171 if (widename == NULL)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000172#endif
Thomas Helleraf2be262007-07-12 11:03:13 +0000173 {
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000174 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:fileio",
Guido van Rossuma9e20242007-03-08 00:43:48 +0000175 kwlist,
176 Py_FileSystemDefaultEncoding,
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000177 &name, &mode, &closefd))
Guido van Rossuma9e20242007-03-08 00:43:48 +0000178 goto error;
Guido van Rossumb0428152007-04-08 17:44:42 +0000179 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000180 }
181
182 self->readable = self->writable = 0;
Thomas Helleraf2be262007-07-12 11:03:13 +0000183 self->seekable = -1;
Guido van Rossum53807da2007-04-10 19:01:47 +0000184 s = mode;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000185 while (*s) {
186 switch (*s++) {
187 case 'r':
188 if (rwa) {
189 bad_mode:
190 PyErr_SetString(PyExc_ValueError,
191 "Must have exactly one of read/write/append mode");
192 goto error;
193 }
194 rwa = 1;
195 self->readable = 1;
196 break;
197 case 'w':
198 if (rwa)
199 goto bad_mode;
200 rwa = 1;
201 self->writable = 1;
202 flags |= O_CREAT | O_TRUNC;
203 break;
204 case 'a':
205 if (rwa)
206 goto bad_mode;
207 rwa = 1;
208 self->writable = 1;
209 flags |= O_CREAT;
210 append = 1;
211 break;
212 case '+':
213 if (plus)
214 goto bad_mode;
215 self->readable = self->writable = 1;
216 plus = 1;
217 break;
218 default:
219 PyErr_Format(PyExc_ValueError,
220 "invalid mode: %.200s", mode);
221 goto error;
222 }
223 }
224
225 if (!rwa)
226 goto bad_mode;
227
228 if (self->readable && self->writable)
229 flags |= O_RDWR;
230 else if (self->readable)
231 flags |= O_RDONLY;
232 else
233 flags |= O_WRONLY;
234
235#ifdef O_BINARY
236 flags |= O_BINARY;
237#endif
238
Walter Dörwald0e411482007-06-06 16:55:38 +0000239#ifdef O_APPEND
240 if (append)
241 flags |= O_APPEND;
242#endif
243
Guido van Rossumb0428152007-04-08 17:44:42 +0000244 if (fd >= 0) {
245 self->fd = fd;
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000246 self->closefd = closefd;
Guido van Rossumb0428152007-04-08 17:44:42 +0000247 }
248 else {
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000249 self->closefd = 1;
250 if (!closefd) {
251 PyErr_SetString(PyExc_ValueError,
252 "Cannot use closefd=True with file name");
253 goto error;
254 }
255
Guido van Rossumb0428152007-04-08 17:44:42 +0000256 Py_BEGIN_ALLOW_THREADS
257 errno = 0;
Thomas Helleraf2be262007-07-12 11:03:13 +0000258#ifdef MS_WINDOWS
259 if (widename != NULL)
Neal Norwitz88b44da2007-08-12 17:23:54 +0000260 self->fd = _wopen(widename, flags, 0666);
Thomas Helleraf2be262007-07-12 11:03:13 +0000261 else
262#endif
Neal Norwitz88b44da2007-08-12 17:23:54 +0000263 self->fd = open(name, flags, 0666);
Guido van Rossumb0428152007-04-08 17:44:42 +0000264 Py_END_ALLOW_THREADS
265 if (self->fd < 0 || dircheck(self) < 0) {
Christian Heimes0b489542007-10-31 19:20:48 +0000266#ifdef MS_WINDOWS
267 PyErr_SetFromErrnoWithUnicodeFilename(PyExc_IOError, widename);
268#else
Guido van Rossumb0428152007-04-08 17:44:42 +0000269 PyErr_SetFromErrnoWithFilename(PyExc_IOError, name);
Christian Heimes0b489542007-10-31 19:20:48 +0000270#endif
Guido van Rossumb0428152007-04-08 17:44:42 +0000271 goto error;
272 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000273 }
274
275 goto done;
276
277 error:
278 ret = -1;
Guido van Rossum53807da2007-04-10 19:01:47 +0000279
Guido van Rossuma9e20242007-03-08 00:43:48 +0000280 done:
Guido van Rossuma9e20242007-03-08 00:43:48 +0000281 return ret;
282}
283
284static void
285fileio_dealloc(PyFileIOObject *self)
286{
287 if (self->weakreflist != NULL)
288 PyObject_ClearWeakRefs((PyObject *) self);
289
Guido van Rossum2dced8b2007-10-30 17:27:30 +0000290 if (self->fd >= 0 && self->closefd) {
Neal Norwitz88b44da2007-08-12 17:23:54 +0000291 errno = internal_close(self);
292 if (errno < 0) {
Guido van Rossum53807da2007-04-10 19:01:47 +0000293 PySys_WriteStderr("close failed: [Errno %d] %s\n",
294 errno, strerror(errno));
Neal Norwitz88b44da2007-08-12 17:23:54 +0000295 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000296 }
297
Christian Heimes90aa7642007-12-19 02:45:37 +0000298 Py_TYPE(self)->tp_free((PyObject *)self);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000299}
300
301static PyObject *
302err_closed(void)
303{
304 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
305 return NULL;
306}
307
308static PyObject *
Guido van Rossum53807da2007-04-10 19:01:47 +0000309err_mode(char *action)
310{
311 PyErr_Format(PyExc_ValueError, "File not open for %s", action);
312 return NULL;
313}
314
315static PyObject *
Guido van Rossuma9e20242007-03-08 00:43:48 +0000316fileio_fileno(PyFileIOObject *self)
317{
318 if (self->fd < 0)
319 return err_closed();
Christian Heimes217cfd12007-12-02 14:31:20 +0000320 return PyLong_FromLong((long) self->fd);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000321}
322
323static PyObject *
324fileio_readable(PyFileIOObject *self)
325{
326 if (self->fd < 0)
327 return err_closed();
Neal Norwitz88b44da2007-08-12 17:23:54 +0000328 return PyBool_FromLong((long) self->readable);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000329}
330
331static PyObject *
332fileio_writable(PyFileIOObject *self)
333{
334 if (self->fd < 0)
335 return err_closed();
Neal Norwitz88b44da2007-08-12 17:23:54 +0000336 return PyBool_FromLong((long) self->writable);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000337}
338
339static PyObject *
340fileio_seekable(PyFileIOObject *self)
341{
342 if (self->fd < 0)
343 return err_closed();
344 if (self->seekable < 0) {
345 int ret;
346 Py_BEGIN_ALLOW_THREADS
347 ret = lseek(self->fd, 0, SEEK_CUR);
348 Py_END_ALLOW_THREADS
349 if (ret < 0)
350 self->seekable = 0;
351 else
352 self->seekable = 1;
353 }
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000354 return PyBool_FromLong((long) self->seekable);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000355}
356
357static PyObject *
358fileio_readinto(PyFileIOObject *self, PyObject *args)
359{
Martin v. Löwis423be952008-08-13 15:53:07 +0000360 Py_buffer pbuf;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000361 Py_ssize_t n;
Guido van Rossum53807da2007-04-10 19:01:47 +0000362
Guido van Rossuma9e20242007-03-08 00:43:48 +0000363 if (self->fd < 0)
364 return err_closed();
Guido van Rossum53807da2007-04-10 19:01:47 +0000365 if (!self->readable)
366 return err_mode("reading");
367
Martin v. Löwis423be952008-08-13 15:53:07 +0000368 if (!PyArg_ParseTuple(args, "w*", &pbuf))
Guido van Rossuma9e20242007-03-08 00:43:48 +0000369 return NULL;
370
371 Py_BEGIN_ALLOW_THREADS
372 errno = 0;
Martin v. Löwis423be952008-08-13 15:53:07 +0000373 n = read(self->fd, pbuf.buf, pbuf.len);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000374 Py_END_ALLOW_THREADS
Martin v. Löwis423be952008-08-13 15:53:07 +0000375 PyBuffer_Release(&pbuf);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000376 if (n < 0) {
377 if (errno == EAGAIN)
378 Py_RETURN_NONE;
379 PyErr_SetFromErrno(PyExc_IOError);
380 return NULL;
381 }
382
Christian Heimes217cfd12007-12-02 14:31:20 +0000383 return PyLong_FromSsize_t(n);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000384}
385
Guido van Rossum7165cb12007-07-10 06:54:34 +0000386#define DEFAULT_BUFFER_SIZE (8*1024)
387
388static PyObject *
389fileio_readall(PyFileIOObject *self)
390{
391 PyObject *result;
392 Py_ssize_t total = 0;
393 int n;
394
Christian Heimes72b710a2008-05-26 13:28:38 +0000395 result = PyBytes_FromStringAndSize(NULL, DEFAULT_BUFFER_SIZE);
Guido van Rossum7165cb12007-07-10 06:54:34 +0000396 if (result == NULL)
397 return NULL;
398
399 while (1) {
400 Py_ssize_t newsize = total + DEFAULT_BUFFER_SIZE;
Christian Heimes72b710a2008-05-26 13:28:38 +0000401 if (PyBytes_GET_SIZE(result) < newsize) {
402 if (_PyBytes_Resize(&result, newsize) < 0) {
Guido van Rossum7165cb12007-07-10 06:54:34 +0000403 if (total == 0) {
404 Py_DECREF(result);
405 return NULL;
406 }
407 PyErr_Clear();
408 break;
409 }
410 }
411 Py_BEGIN_ALLOW_THREADS
412 errno = 0;
413 n = read(self->fd,
Christian Heimes72b710a2008-05-26 13:28:38 +0000414 PyBytes_AS_STRING(result) + total,
Guido van Rossum7165cb12007-07-10 06:54:34 +0000415 newsize - total);
416 Py_END_ALLOW_THREADS
417 if (n == 0)
418 break;
419 if (n < 0) {
420 if (total > 0)
421 break;
422 if (errno == EAGAIN) {
423 Py_DECREF(result);
424 Py_RETURN_NONE;
425 }
426 Py_DECREF(result);
427 PyErr_SetFromErrno(PyExc_IOError);
428 return NULL;
429 }
430 total += n;
431 }
432
Christian Heimes72b710a2008-05-26 13:28:38 +0000433 if (PyBytes_GET_SIZE(result) > total) {
434 if (_PyBytes_Resize(&result, total) < 0) {
Guido van Rossum7165cb12007-07-10 06:54:34 +0000435 /* This should never happen, but just in case */
436 Py_DECREF(result);
437 return NULL;
438 }
439 }
440 return result;
441}
442
Guido van Rossuma9e20242007-03-08 00:43:48 +0000443static PyObject *
444fileio_read(PyFileIOObject *self, PyObject *args)
445{
446 char *ptr;
Guido van Rossum7165cb12007-07-10 06:54:34 +0000447 Py_ssize_t n;
448 Py_ssize_t size = -1;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000449 PyObject *bytes;
450
451 if (self->fd < 0)
452 return err_closed();
Guido van Rossum53807da2007-04-10 19:01:47 +0000453 if (!self->readable)
454 return err_mode("reading");
Guido van Rossuma9e20242007-03-08 00:43:48 +0000455
Neal Norwitz3c8ba932007-08-08 04:36:17 +0000456 if (!PyArg_ParseTuple(args, "|n", &size))
Guido van Rossuma9e20242007-03-08 00:43:48 +0000457 return NULL;
458
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000459 if (size < 0) {
Guido van Rossum7165cb12007-07-10 06:54:34 +0000460 return fileio_readall(self);
Guido van Rossumc2f93dc2007-05-24 00:50:02 +0000461 }
462
Christian Heimes72b710a2008-05-26 13:28:38 +0000463 bytes = PyBytes_FromStringAndSize(NULL, size);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000464 if (bytes == NULL)
465 return NULL;
Christian Heimes72b710a2008-05-26 13:28:38 +0000466 ptr = PyBytes_AS_STRING(bytes);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000467
468 Py_BEGIN_ALLOW_THREADS
469 errno = 0;
470 n = read(self->fd, ptr, size);
471 Py_END_ALLOW_THREADS
472
473 if (n < 0) {
474 if (errno == EAGAIN)
475 Py_RETURN_NONE;
476 PyErr_SetFromErrno(PyExc_IOError);
477 return NULL;
478 }
479
480 if (n != size) {
Christian Heimes72b710a2008-05-26 13:28:38 +0000481 if (_PyBytes_Resize(&bytes, n) < 0) {
Guido van Rossuma9e20242007-03-08 00:43:48 +0000482 Py_DECREF(bytes);
Guido van Rossum53807da2007-04-10 19:01:47 +0000483 return NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000484 }
Guido van Rossum53807da2007-04-10 19:01:47 +0000485 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000486
487 return (PyObject *) bytes;
488}
489
490static PyObject *
491fileio_write(PyFileIOObject *self, PyObject *args)
492{
Martin v. Löwis423be952008-08-13 15:53:07 +0000493 Py_buffer pbuf;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000494 Py_ssize_t n;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000495
496 if (self->fd < 0)
497 return err_closed();
Guido van Rossum53807da2007-04-10 19:01:47 +0000498 if (!self->writable)
499 return err_mode("writing");
500
Martin v. Löwis423be952008-08-13 15:53:07 +0000501 if (!PyArg_ParseTuple(args, "s*", &pbuf))
Guido van Rossuma9e20242007-03-08 00:43:48 +0000502 return NULL;
503
504 Py_BEGIN_ALLOW_THREADS
505 errno = 0;
Martin v. Löwis423be952008-08-13 15:53:07 +0000506 n = write(self->fd, pbuf.buf, pbuf.len);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000507 Py_END_ALLOW_THREADS
508
Martin v. Löwis423be952008-08-13 15:53:07 +0000509 PyBuffer_Release(&pbuf);
510
Guido van Rossuma9e20242007-03-08 00:43:48 +0000511 if (n < 0) {
512 if (errno == EAGAIN)
513 Py_RETURN_NONE;
514 PyErr_SetFromErrno(PyExc_IOError);
515 return NULL;
516 }
517
Christian Heimes217cfd12007-12-02 14:31:20 +0000518 return PyLong_FromSsize_t(n);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000519}
520
Guido van Rossum53807da2007-04-10 19:01:47 +0000521/* XXX Windows support below is likely incomplete */
522
523#if defined(MS_WIN64) || defined(MS_WINDOWS)
524typedef PY_LONG_LONG Py_off_t;
525#else
526typedef off_t Py_off_t;
527#endif
528
529/* Cribbed from posix_lseek() */
530static PyObject *
531portable_lseek(int fd, PyObject *posobj, int whence)
532{
533 Py_off_t pos, res;
534
535#ifdef SEEK_SET
536 /* Turn 0, 1, 2 into SEEK_{SET,CUR,END} */
537 switch (whence) {
538#if SEEK_SET != 0
539 case 0: whence = SEEK_SET; break;
540#endif
541#if SEEK_CUR != 1
542 case 1: whence = SEEK_CUR; break;
543#endif
544#if SEEL_END != 2
545 case 2: whence = SEEK_END; break;
546#endif
547 }
548#endif /* SEEK_SET */
549
550 if (posobj == NULL)
551 pos = 0;
552 else {
Christian Heimes8e42a0a2007-11-08 18:04:45 +0000553 if(PyFloat_Check(posobj)) {
554 PyErr_SetString(PyExc_TypeError, "an integer is required");
555 return NULL;
556 }
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000557#if defined(HAVE_LARGEFILE_SUPPORT)
558 pos = PyLong_AsLongLong(posobj);
Guido van Rossum53807da2007-04-10 19:01:47 +0000559#else
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000560 pos = PyLong_AsLong(posobj);
Guido van Rossum53807da2007-04-10 19:01:47 +0000561#endif
562 if (PyErr_Occurred())
563 return NULL;
564 }
565
566 Py_BEGIN_ALLOW_THREADS
567#if defined(MS_WIN64) || defined(MS_WINDOWS)
568 res = _lseeki64(fd, pos, whence);
569#else
570 res = lseek(fd, pos, whence);
571#endif
572 Py_END_ALLOW_THREADS
573 if (res < 0)
574 return PyErr_SetFromErrno(PyExc_IOError);
575
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000576#if defined(HAVE_LARGEFILE_SUPPORT)
Guido van Rossum53807da2007-04-10 19:01:47 +0000577 return PyLong_FromLongLong(res);
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000578#else
579 return PyLong_FromLong(res);
Guido van Rossum53807da2007-04-10 19:01:47 +0000580#endif
581}
582
Guido van Rossuma9e20242007-03-08 00:43:48 +0000583static PyObject *
584fileio_seek(PyFileIOObject *self, PyObject *args)
585{
Guido van Rossum53807da2007-04-10 19:01:47 +0000586 PyObject *posobj;
587 int whence = 0;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000588
589 if (self->fd < 0)
590 return err_closed();
591
Guido van Rossum53807da2007-04-10 19:01:47 +0000592 if (!PyArg_ParseTuple(args, "O|i", &posobj, &whence))
Guido van Rossuma9e20242007-03-08 00:43:48 +0000593 return NULL;
594
Guido van Rossum53807da2007-04-10 19:01:47 +0000595 return portable_lseek(self->fd, posobj, whence);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000596}
597
598static PyObject *
599fileio_tell(PyFileIOObject *self, PyObject *args)
600{
Guido van Rossuma9e20242007-03-08 00:43:48 +0000601 if (self->fd < 0)
602 return err_closed();
603
Guido van Rossum53807da2007-04-10 19:01:47 +0000604 return portable_lseek(self->fd, NULL, 1);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000605}
606
Thomas Hellerc6a55ee2007-07-11 12:45:46 +0000607#ifdef HAVE_FTRUNCATE
Guido van Rossuma9e20242007-03-08 00:43:48 +0000608static PyObject *
609fileio_truncate(PyFileIOObject *self, PyObject *args)
610{
Guido van Rossum53807da2007-04-10 19:01:47 +0000611 PyObject *posobj = NULL;
612 Py_off_t pos;
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000613 int ret;
Guido van Rossumdc0b1a12007-04-12 22:55:07 +0000614 int fd;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000615
Guido van Rossum53807da2007-04-10 19:01:47 +0000616 fd = self->fd;
617 if (fd < 0)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000618 return err_closed();
Guido van Rossum53807da2007-04-10 19:01:47 +0000619 if (!self->writable)
620 return err_mode("writing");
Guido van Rossuma9e20242007-03-08 00:43:48 +0000621
Guido van Rossum53807da2007-04-10 19:01:47 +0000622 if (!PyArg_ParseTuple(args, "|O", &posobj))
623 return NULL;
624
Guido van Rossumdc0b1a12007-04-12 22:55:07 +0000625 if (posobj == Py_None || posobj == NULL) {
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000626 /* Get the current position. */
Guido van Rossumdc0b1a12007-04-12 22:55:07 +0000627 posobj = portable_lseek(fd, NULL, 1);
628 if (posobj == NULL)
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000629 return NULL;
Guido van Rossumdc0b1a12007-04-12 22:55:07 +0000630 }
631 else {
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000632 /* Move to the position to be truncated. */
633 posobj = portable_lseek(fd, posobj, 0);
Guido van Rossumdc0b1a12007-04-12 22:55:07 +0000634 }
Guido van Rossum53807da2007-04-10 19:01:47 +0000635
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000636#if defined(HAVE_LARGEFILE_SUPPORT)
637 pos = PyLong_AsLongLong(posobj);
Guido van Rossum53807da2007-04-10 19:01:47 +0000638#else
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000639 pos = PyLong_AsLong(posobj);
Guido van Rossum53807da2007-04-10 19:01:47 +0000640#endif
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000641 if (PyErr_Occurred())
Guido van Rossum53807da2007-04-10 19:01:47 +0000642 return NULL;
643
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000644#ifdef MS_WINDOWS
645 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
646 so don't even try using it. */
647 {
648 HANDLE hFile;
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000649
650 /* Truncate. Note that this may grow the file! */
651 Py_BEGIN_ALLOW_THREADS
652 errno = 0;
653 hFile = (HANDLE)_get_osfhandle(fd);
654 ret = hFile == (HANDLE)-1;
655 if (ret == 0) {
656 ret = SetEndOfFile(hFile) == 0;
657 if (ret)
658 errno = EACCES;
659 }
660 Py_END_ALLOW_THREADS
661 }
662#else
Guido van Rossuma9e20242007-03-08 00:43:48 +0000663 Py_BEGIN_ALLOW_THREADS
664 errno = 0;
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000665 ret = ftruncate(fd, pos);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000666 Py_END_ALLOW_THREADS
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000667#endif /* !MS_WINDOWS */
Guido van Rossuma9e20242007-03-08 00:43:48 +0000668
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000669 if (ret != 0) {
Guido van Rossuma9e20242007-03-08 00:43:48 +0000670 PyErr_SetFromErrno(PyExc_IOError);
Thomas Hellerfdeee3a2007-07-12 11:21:36 +0000671 return NULL;
Guido van Rossum87429772007-04-10 21:06:59 +0000672 }
Guido van Rossuma9e20242007-03-08 00:43:48 +0000673
Guido van Rossum87429772007-04-10 21:06:59 +0000674 return posobj;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000675}
Thomas Hellerc6a55ee2007-07-11 12:45:46 +0000676#endif
Guido van Rossum53807da2007-04-10 19:01:47 +0000677
678static char *
679mode_string(PyFileIOObject *self)
680{
681 if (self->readable) {
682 if (self->writable)
683 return "r+";
684 else
685 return "r";
686 }
687 else
688 return "w";
689}
Guido van Rossuma9e20242007-03-08 00:43:48 +0000690
691static PyObject *
692fileio_repr(PyFileIOObject *self)
693{
Guido van Rossum53807da2007-04-10 19:01:47 +0000694 if (self->fd < 0)
Walter Dörwald1ab83302007-05-18 17:15:44 +0000695 return PyUnicode_FromFormat("_fileio._FileIO(-1)");
Guido van Rossuma9e20242007-03-08 00:43:48 +0000696
Walter Dörwald1ab83302007-05-18 17:15:44 +0000697 return PyUnicode_FromFormat("_fileio._FileIO(%d, '%s')",
Guido van Rossum53807da2007-04-10 19:01:47 +0000698 self->fd, mode_string(self));
Guido van Rossuma9e20242007-03-08 00:43:48 +0000699}
700
701static PyObject *
702fileio_isatty(PyFileIOObject *self)
703{
704 long res;
Guido van Rossum53807da2007-04-10 19:01:47 +0000705
Guido van Rossuma9e20242007-03-08 00:43:48 +0000706 if (self->fd < 0)
707 return err_closed();
708 Py_BEGIN_ALLOW_THREADS
709 res = isatty(self->fd);
710 Py_END_ALLOW_THREADS
711 return PyBool_FromLong(res);
712}
713
Guido van Rossuma9e20242007-03-08 00:43:48 +0000714
715PyDoc_STRVAR(fileio_doc,
716"file(name: str[, mode: str]) -> file IO object\n"
717"\n"
718"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
719"writing or appending. The file will be created if it doesn't exist\n"
720"when opened for writing or appending; it will be truncated when\n"
721"opened for writing. Add a '+' to the mode to allow simultaneous\n"
722"reading and writing.");
723
724PyDoc_STRVAR(read_doc,
725"read(size: int) -> bytes. read at most size bytes, returned as bytes.\n"
726"\n"
727"Only makes one system call, so less data may be returned than requested\n"
Guido van Rossum7165cb12007-07-10 06:54:34 +0000728"In non-blocking mode, returns None if no data is available.\n"
729"On end-of-file, returns ''.");
730
731PyDoc_STRVAR(readall_doc,
732"readall() -> bytes. read all data from the file, returned as bytes.\n"
733"\n"
734"In non-blocking mode, returns as much as is immediately available,\n"
735"or None if no data is available. On end-of-file, returns ''.");
Guido van Rossuma9e20242007-03-08 00:43:48 +0000736
737PyDoc_STRVAR(write_doc,
738"write(b: bytes) -> int. Write bytes b to file, return number written.\n"
739"\n"
740"Only makes one system call, so not all of the data may be written.\n"
741"The number of bytes actually written is returned.");
742
743PyDoc_STRVAR(fileno_doc,
744"fileno() -> int. \"file descriptor\".\n"
745"\n"
746"This is needed for lower-level file interfaces, such the fcntl module.");
747
748PyDoc_STRVAR(seek_doc,
749"seek(offset: int[, whence: int]) -> None. Move to new file position.\n"
750"\n"
751"Argument offset is a byte count. Optional argument whence defaults to\n"
752"0 (offset from start of file, offset should be >= 0); other values are 1\n"
753"(move relative to current position, positive or negative), and 2 (move\n"
754"relative to end of file, usually negative, although many platforms allow\n"
755"seeking beyond the end of a file)."
756"\n"
757"Note that not all file objects are seekable.");
758
Thomas Hellerc6a55ee2007-07-11 12:45:46 +0000759#ifdef HAVE_FTRUNCATE
Guido van Rossuma9e20242007-03-08 00:43:48 +0000760PyDoc_STRVAR(truncate_doc,
761"truncate([size: int]) -> None. Truncate the file to at most size bytes.\n"
762"\n"
Alexandre Vassalotti77250f42008-05-06 19:48:38 +0000763"Size defaults to the current file position, as returned by tell()."
764"The current file position is changed to the value of size.");
Thomas Hellerc6a55ee2007-07-11 12:45:46 +0000765#endif
Guido van Rossuma9e20242007-03-08 00:43:48 +0000766
767PyDoc_STRVAR(tell_doc,
768"tell() -> int. Current file position");
769
770PyDoc_STRVAR(readinto_doc,
771"readinto() -> Undocumented. Don't use this; it may go away.");
772
773PyDoc_STRVAR(close_doc,
774"close() -> None. Close the file.\n"
775"\n"
776"A closed file cannot be used for further I/O operations. close() may be\n"
777"called more than once without error. Changes the fileno to -1.");
778
779PyDoc_STRVAR(isatty_doc,
780"isatty() -> bool. True if the file is connected to a tty device.");
781
Guido van Rossuma9e20242007-03-08 00:43:48 +0000782PyDoc_STRVAR(seekable_doc,
783"seekable() -> bool. True if file supports random-access.");
784
785PyDoc_STRVAR(readable_doc,
786"readable() -> bool. True if file was opened in a read mode.");
787
788PyDoc_STRVAR(writable_doc,
789"writable() -> bool. True if file was opened in a write mode.");
790
791static PyMethodDef fileio_methods[] = {
792 {"read", (PyCFunction)fileio_read, METH_VARARGS, read_doc},
Guido van Rossum7165cb12007-07-10 06:54:34 +0000793 {"readall", (PyCFunction)fileio_readall, METH_NOARGS, readall_doc},
Guido van Rossuma9e20242007-03-08 00:43:48 +0000794 {"readinto", (PyCFunction)fileio_readinto, METH_VARARGS, readinto_doc},
795 {"write", (PyCFunction)fileio_write, METH_VARARGS, write_doc},
796 {"seek", (PyCFunction)fileio_seek, METH_VARARGS, seek_doc},
797 {"tell", (PyCFunction)fileio_tell, METH_VARARGS, tell_doc},
Thomas Hellerc6a55ee2007-07-11 12:45:46 +0000798#ifdef HAVE_FTRUNCATE
Guido van Rossuma9e20242007-03-08 00:43:48 +0000799 {"truncate", (PyCFunction)fileio_truncate, METH_VARARGS, truncate_doc},
Thomas Hellerc6a55ee2007-07-11 12:45:46 +0000800#endif
Guido van Rossuma9e20242007-03-08 00:43:48 +0000801 {"close", (PyCFunction)fileio_close, METH_NOARGS, close_doc},
802 {"seekable", (PyCFunction)fileio_seekable, METH_NOARGS, seekable_doc},
803 {"readable", (PyCFunction)fileio_readable, METH_NOARGS, readable_doc},
804 {"writable", (PyCFunction)fileio_writable, METH_NOARGS, writable_doc},
805 {"fileno", (PyCFunction)fileio_fileno, METH_NOARGS, fileno_doc},
806 {"isatty", (PyCFunction)fileio_isatty, METH_NOARGS, isatty_doc},
Guido van Rossuma9e20242007-03-08 00:43:48 +0000807 {NULL, NULL} /* sentinel */
808};
809
Guido van Rossum53807da2007-04-10 19:01:47 +0000810/* 'closed' and 'mode' are attributes for backwards compatibility reasons. */
811
Guido van Rossumb0428152007-04-08 17:44:42 +0000812static PyObject *
Guido van Rossum53807da2007-04-10 19:01:47 +0000813get_closed(PyFileIOObject *self, void *closure)
Guido van Rossumb0428152007-04-08 17:44:42 +0000814{
Guido van Rossum53807da2007-04-10 19:01:47 +0000815 return PyBool_FromLong((long)(self->fd < 0));
816}
817
818static PyObject *
819get_mode(PyFileIOObject *self, void *closure)
820{
Guido van Rossumc43e79f2007-06-18 18:26:36 +0000821 return PyUnicode_FromString(mode_string(self));
Guido van Rossumb0428152007-04-08 17:44:42 +0000822}
823
824static PyGetSetDef fileio_getsetlist[] = {
825 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Guido van Rossum53807da2007-04-10 19:01:47 +0000826 {"mode", (getter)get_mode, NULL, "String giving the file mode"},
Guido van Rossumb0428152007-04-08 17:44:42 +0000827 {0},
828};
829
Guido van Rossuma9e20242007-03-08 00:43:48 +0000830PyTypeObject PyFileIO_Type = {
Martin v. Löwis9f2e3462007-07-21 17:22:18 +0000831 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Amaury Forgeot d'Arc1ff99102007-11-19 20:34:10 +0000832 "_FileIO",
Guido van Rossuma9e20242007-03-08 00:43:48 +0000833 sizeof(PyFileIOObject),
834 0,
835 (destructor)fileio_dealloc, /* tp_dealloc */
836 0, /* tp_print */
837 0, /* tp_getattr */
838 0, /* tp_setattr */
839 0, /* tp_compare */
840 (reprfunc)fileio_repr, /* tp_repr */
841 0, /* tp_as_number */
842 0, /* tp_as_sequence */
843 0, /* tp_as_mapping */
844 0, /* tp_hash */
845 0, /* tp_call */
846 0, /* tp_str */
847 PyObject_GenericGetAttr, /* tp_getattro */
848 0, /* tp_setattro */
849 0, /* tp_as_buffer */
850 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
851 fileio_doc, /* tp_doc */
852 0, /* tp_traverse */
853 0, /* tp_clear */
854 0, /* tp_richcompare */
855 offsetof(PyFileIOObject, weakreflist), /* tp_weaklistoffset */
856 0, /* tp_iter */
857 0, /* tp_iternext */
858 fileio_methods, /* tp_methods */
859 0, /* tp_members */
Guido van Rossumb0428152007-04-08 17:44:42 +0000860 fileio_getsetlist, /* tp_getset */
Guido van Rossuma9e20242007-03-08 00:43:48 +0000861 0, /* tp_base */
862 0, /* tp_dict */
863 0, /* tp_descr_get */
864 0, /* tp_descr_set */
865 0, /* tp_dictoffset */
866 fileio_init, /* tp_init */
867 PyType_GenericAlloc, /* tp_alloc */
868 fileio_new, /* tp_new */
869 PyObject_Del, /* tp_free */
870};
871
872static PyMethodDef module_methods[] = {
873 {NULL, NULL}
874};
875
Martin v. Löwis1a214512008-06-11 05:26:20 +0000876static struct PyModuleDef fileiomodule = {
877 PyModuleDef_HEAD_INIT,
878 "_fileio",
879 "Fast implementation of io.FileIO.",
880 -1,
881 module_methods,
882 NULL,
883 NULL,
884 NULL,
885 NULL
886};
887
Guido van Rossuma9e20242007-03-08 00:43:48 +0000888PyMODINIT_FUNC
Martin v. Löwis1a214512008-06-11 05:26:20 +0000889PyInit__fileio(void)
Guido van Rossuma9e20242007-03-08 00:43:48 +0000890{
891 PyObject *m; /* a module object */
892
Martin v. Löwis1a214512008-06-11 05:26:20 +0000893 m = PyModule_Create(&fileiomodule);
Guido van Rossuma9e20242007-03-08 00:43:48 +0000894 if (m == NULL)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000895 return NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000896 if (PyType_Ready(&PyFileIO_Type) < 0)
Martin v. Löwis1a214512008-06-11 05:26:20 +0000897 return NULL;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000898 Py_INCREF(&PyFileIO_Type);
899 PyModule_AddObject(m, "_FileIO", (PyObject *) &PyFileIO_Type);
Martin v. Löwis1a214512008-06-11 05:26:20 +0000900 return m;
Guido van Rossuma9e20242007-03-08 00:43:48 +0000901}