blob: a60d3ef44aaa44e293291744ce17d49ec57bbb8e [file] [log] [blame]
Guido van Rossumf70e43a1991-02-19 12:39:46 +00001
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002/* File object implementation */
3
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Guido van Rossumb6775db1994-08-01 11:34:53 +00005#include "structmember.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006
Guido van Rossumff7e83d1999-08-27 20:39:37 +00007#ifndef DONT_HAVE_SYS_TYPES_H
Guido van Rossum41498431999-01-07 22:09:51 +00008#include <sys/types.h>
Guido van Rossumff7e83d1999-08-27 20:39:37 +00009#endif /* DONT_HAVE_SYS_TYPES_H */
Guido van Rossum41498431999-01-07 22:09:51 +000010
Guido van Rossum685a38e1996-12-05 21:54:17 +000011#ifdef HAVE_UNISTD_H
12#include <unistd.h>
13#endif
14
Guido van Rossumb8199141997-05-06 15:23:24 +000015#ifdef MS_WIN32
Guido van Rossumb8199141997-05-06 15:23:24 +000016#define fileno _fileno
Trent Mickf29f47b2000-08-11 19:02:59 +000017/* can (almost fully) duplicate with _chsize, see file_truncate */
Guido van Rossumb8199141997-05-06 15:23:24 +000018#define HAVE_FTRUNCATE
19#endif
20
Guido van Rossumf2044e11998-04-28 16:05:59 +000021#ifdef macintosh
22#ifdef USE_GUSI
23#define HAVE_FTRUNCATE
24#endif
25#endif
26
Jack Jansene08dea191995-04-23 22:12:47 +000027#ifdef __MWERKS__
28/* Mwerks fopen() doesn't always set errno */
29#define NO_FOPEN_ERRNO
30#endif
Guido van Rossum295d1711995-02-19 15:55:19 +000031
Guido van Rossumc0b618a1997-05-02 03:12:38 +000032#define BUF(v) PyString_AS_STRING((PyStringObject *)v)
Guido van Rossumce5ba841991-03-06 13:06:18 +000033
Guido van Rossumff7e83d1999-08-27 20:39:37 +000034#ifndef DONT_HAVE_ERRNO_H
Guido van Rossumf1dc5661993-07-05 10:31:29 +000035#include <errno.h>
Guido van Rossumff7e83d1999-08-27 20:39:37 +000036#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000037
Trent Mickf29f47b2000-08-11 19:02:59 +000038
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000039typedef struct {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000040 PyObject_HEAD
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000041 FILE *f_fp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000042 PyObject *f_name;
43 PyObject *f_mode;
Tim Petersdbd9ba62000-07-09 03:09:57 +000044 int (*f_close)(FILE *);
Guido van Rossumeb183da1991-04-04 10:44:06 +000045 int f_softspace; /* Flag used by 'print' command */
Guido van Rossum4c08d552000-03-10 22:55:18 +000046 int f_binary; /* Flag which indicates whether the file is open
47 open in binary (1) or test (0) mode */
Guido van Rossumc0b618a1997-05-02 03:12:38 +000048} PyFileObject;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000049
50FILE *
Fred Drakefd99de62000-07-09 05:02:18 +000051PyFile_AsFile(PyObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000052{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000053 if (f == NULL || !PyFile_Check(f))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000054 return NULL;
Guido van Rossum3165fe61992-09-25 21:59:05 +000055 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000056 return ((PyFileObject *)f)->f_fp;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000057}
58
Guido van Rossumc0b618a1997-05-02 03:12:38 +000059PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +000060PyFile_Name(PyObject *f)
Guido van Rossumdb3165e1993-10-18 17:06:59 +000061{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000062 if (f == NULL || !PyFile_Check(f))
Guido van Rossumdb3165e1993-10-18 17:06:59 +000063 return NULL;
64 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000065 return ((PyFileObject *)f)->f_name;
Guido van Rossumdb3165e1993-10-18 17:06:59 +000066}
67
Tim Peters59c9a642001-09-13 05:38:56 +000068
69static PyObject *
70fill_file_fields(PyFileObject *f, FILE *fp, char *name, char *mode,
71 int (*close)(FILE *))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000072{
Tim Peters59c9a642001-09-13 05:38:56 +000073 assert(f != NULL);
74 assert(PyFile_Check(f));
Tim Peters44410012001-09-14 03:26:08 +000075 assert(f->f_fp == NULL);
76
77 Py_DECREF(f->f_name);
78 Py_DECREF(f->f_mode);
Guido van Rossumc0b618a1997-05-02 03:12:38 +000079 f->f_name = PyString_FromString(name);
80 f->f_mode = PyString_FromString(mode);
Tim Peters44410012001-09-14 03:26:08 +000081
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +000082 f->f_close = close;
Guido van Rossumeb183da1991-04-04 10:44:06 +000083 f->f_softspace = 0;
Tim Peters59c9a642001-09-13 05:38:56 +000084 f->f_binary = strchr(mode,'b') != NULL;
Tim Peters44410012001-09-14 03:26:08 +000085
Tim Peters59c9a642001-09-13 05:38:56 +000086 if (f->f_name == NULL || f->f_mode == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000087 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000088 f->f_fp = fp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000089 return (PyObject *) f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000090}
91
Tim Peters59c9a642001-09-13 05:38:56 +000092static PyObject *
93open_the_file(PyFileObject *f, char *name, char *mode)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000094{
Tim Peters59c9a642001-09-13 05:38:56 +000095 assert(f != NULL);
96 assert(PyFile_Check(f));
97 assert(name != NULL);
98 assert(mode != NULL);
Tim Peters44410012001-09-14 03:26:08 +000099 assert(f->f_fp == NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000100
Tim Peters8fa45672001-09-13 21:01:29 +0000101 /* rexec.py can't stop a user from getting the file() constructor --
102 all they have to do is get *any* file object f, and then do
103 type(f). Here we prevent them from doing damage with it. */
104 if (PyEval_GetRestricted()) {
105 PyErr_SetString(PyExc_IOError,
106 "file() constructor not accessible in restricted mode");
107 return NULL;
108 }
Tim Petersa27a1502001-11-09 20:59:14 +0000109 errno = 0;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000110#ifdef HAVE_FOPENRF
Guido van Rossuma08095a1991-02-13 23:25:27 +0000111 if (*mode == '*') {
112 FILE *fopenRF();
113 f->f_fp = fopenRF(name, mode+1);
114 }
115 else
116#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000117 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000118 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000119 f->f_fp = fopen(name, mode);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000120 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000121 }
Guido van Rossuma08095a1991-02-13 23:25:27 +0000122 if (f->f_fp == NULL) {
Jack Jansene08dea191995-04-23 22:12:47 +0000123#ifdef NO_FOPEN_ERRNO
Barry Warsaw52ddc0e1998-07-23 16:07:02 +0000124 /* Metroworks only, not testable, so unchanged */
Jeremy Hylton41c83212001-11-09 16:17:24 +0000125 if (errno == 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000126 PyErr_SetString(PyExc_IOError, "Cannot open file");
Jack Jansene08dea191995-04-23 22:12:47 +0000127 return NULL;
128 }
129#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000130 if (errno == EINVAL)
131 PyErr_Format(PyExc_IOError, "invalid argument: %s",
132 mode);
133 else
134 PyErr_SetFromErrnoWithFilename(PyExc_IOError, name);
Tim Peters59c9a642001-09-13 05:38:56 +0000135 f = NULL;
136 }
137 return (PyObject *)f;
138}
139
140PyObject *
141PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
142{
Tim Peters44410012001-09-14 03:26:08 +0000143 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
144 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000145 if (f != NULL) {
146 if (fill_file_fields(f, fp, name, mode, close) == NULL) {
147 Py_DECREF(f);
148 f = NULL;
149 }
150 }
151 return (PyObject *) f;
152}
153
154PyObject *
155PyFile_FromString(char *name, char *mode)
156{
157 extern int fclose(FILE *);
158 PyFileObject *f;
159
160 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
161 if (f != NULL) {
162 if (open_the_file(f, name, mode) == NULL) {
163 Py_DECREF(f);
164 f = NULL;
165 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000166 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000167 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000168}
169
Guido van Rossumb6775db1994-08-01 11:34:53 +0000170void
Fred Drakefd99de62000-07-09 05:02:18 +0000171PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000172{
173 if (bufsize >= 0) {
174#ifdef HAVE_SETVBUF
175 int type;
176 switch (bufsize) {
177 case 0:
178 type = _IONBF;
179 break;
180 case 1:
181 type = _IOLBF;
182 bufsize = BUFSIZ;
183 break;
184 default:
185 type = _IOFBF;
186 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000187 setvbuf(((PyFileObject *)f)->f_fp, (char *)NULL,
188 type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000189#else /* !HAVE_SETVBUF */
190 if (bufsize <= 1)
191 setbuf(((PyFileObject *)f)->f_fp, (char *)NULL);
192#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000193 }
194}
195
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000196static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000197err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000198{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000199 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000200 return NULL;
201}
202
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000203/* Methods */
204
205static void
Fred Drakefd99de62000-07-09 05:02:18 +0000206file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000207{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000208 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000209 Py_BEGIN_ALLOW_THREADS
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000210 (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000211 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000212 }
Tim Peters44410012001-09-14 03:26:08 +0000213 Py_XDECREF(f->f_name);
214 Py_XDECREF(f->f_mode);
Guido van Rossum9475a232001-10-05 20:51:39 +0000215 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000216}
217
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000218static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000219file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000220{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000221 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
222 f->f_fp == NULL ? "closed" : "open",
223 PyString_AsString(f->f_name),
224 PyString_AsString(f->f_mode),
225 f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000226}
227
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000228static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000229file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000230{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000231 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000232 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000233 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000234 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000235 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000236 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000237 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000238 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000239 f->f_fp = NULL;
240 }
Guido van Rossumfebd5511992-03-04 16:39:24 +0000241 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000242 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000243 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000244 return PyInt_FromLong((long)sts);
245 Py_INCREF(Py_None);
246 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000247}
248
Trent Mickf29f47b2000-08-11 19:02:59 +0000249
Guido van Rossumb8552162001-09-05 14:58:11 +0000250/* Our very own off_t-like type, 64-bit if possible */
251#if !defined(HAVE_LARGEFILE_SUPPORT)
252typedef off_t Py_off_t;
253#elif SIZEOF_OFF_T >= 8
254typedef off_t Py_off_t;
255#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000256typedef fpos_t Py_off_t;
257#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000258#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000259#endif
260
261
Trent Mickf29f47b2000-08-11 19:02:59 +0000262/* a portable fseek() function
263 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000264static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000265_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000266{
Guido van Rossumb8552162001-09-05 14:58:11 +0000267#if !defined(HAVE_LARGEFILE_SUPPORT)
268 return fseek(fp, offset, whence);
269#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000270 return fseeko(fp, offset, whence);
271#elif defined(HAVE_FSEEK64)
272 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000273#elif defined(__BEOS__)
274 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000275#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000276 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
277 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000278 fpos_t pos;
279 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000280 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000281#ifdef MS_WINDOWS
282 fflush(fp);
283 if (_lseeki64(fileno(fp), 0, 2) == -1)
284 return -1;
285#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000286 if (fseek(fp, 0, SEEK_END) != 0)
287 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000288#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000289 /* fall through */
290 case SEEK_CUR:
291 if (fgetpos(fp, &pos) != 0)
292 return -1;
293 offset += pos;
294 break;
295 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000296 }
297 return fsetpos(fp, &offset);
298#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000299#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000300#endif
301}
302
303
304/* a portable ftell() function
305 Return -1 on failure with errno set appropriately, current file
306 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000307static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000308_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000309{
Guido van Rossumb8552162001-09-05 14:58:11 +0000310#if !defined(HAVE_LARGEFILE_SUPPORT)
311 return ftell(fp);
312#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
313 return ftello(fp);
314#elif defined(HAVE_FTELL64)
315 return ftell64(fp);
316#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000317 fpos_t pos;
318 if (fgetpos(fp, &pos) != 0)
319 return -1;
320 return pos;
321#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000322#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000323#endif
324}
325
326
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000327static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000328file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000329{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000330 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000331 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000332 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000333 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000334
Guido van Rossumd7297e61992-07-06 14:19:26 +0000335 if (f->f_fp == NULL)
336 return err_closed();
337 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000338 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000339 return NULL;
340#if !defined(HAVE_LARGEFILE_SUPPORT)
341 offset = PyInt_AsLong(offobj);
342#else
343 offset = PyLong_Check(offobj) ?
344 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
345#endif
346 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000347 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000348
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000349 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000350 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000351 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000352 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000353
Guido van Rossumff4949e1992-08-05 19:58:53 +0000354 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000355 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000356 clearerr(f->f_fp);
357 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000358 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000359 Py_INCREF(Py_None);
360 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000361}
362
Trent Mickf29f47b2000-08-11 19:02:59 +0000363
Guido van Rossumd7047b31995-01-02 19:07:15 +0000364#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000365static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000366file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000367{
Guido van Rossumd7047b31995-01-02 19:07:15 +0000368 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000369 Py_off_t newsize;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000370 PyObject *newsizeobj;
Tim Peters86821b22001-01-07 21:19:34 +0000371
Guido van Rossumd7047b31995-01-02 19:07:15 +0000372 if (f->f_fp == NULL)
373 return err_closed();
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000374 newsizeobj = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +0000375 if (!PyArg_ParseTuple(args, "|O:truncate", &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000376 return NULL;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000377 if (newsizeobj != NULL) {
378#if !defined(HAVE_LARGEFILE_SUPPORT)
379 newsize = PyInt_AsLong(newsizeobj);
380#else
381 newsize = PyLong_Check(newsizeobj) ?
382 PyLong_AsLongLong(newsizeobj) :
383 PyInt_AsLong(newsizeobj);
384#endif
385 if (PyErr_Occurred())
386 return NULL;
387 } else {
388 /* Default to current position*/
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000389 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000390 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000391 newsize = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000392 Py_END_ALLOW_THREADS
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000393 if (newsize == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000394 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumd7047b31995-01-02 19:07:15 +0000395 clearerr(f->f_fp);
396 return NULL;
397 }
398 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000399 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000400 errno = 0;
401 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000402 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000403 if (ret != 0) goto onioerror;
404
405#ifdef MS_WIN32
406 /* can use _chsize; if, however, the newsize overflows 32-bits then
407 _chsize is *not* adequate; in this case, an OverflowError is raised */
408 if (newsize > LONG_MAX) {
409 PyErr_SetString(PyExc_OverflowError,
410 "the new size is too long for _chsize (it is limited to 32-bit values)");
Guido van Rossumd7047b31995-01-02 19:07:15 +0000411 return NULL;
Trent Mickf29f47b2000-08-11 19:02:59 +0000412 } else {
413 Py_BEGIN_ALLOW_THREADS
414 errno = 0;
Tim Peters6e13a562001-09-06 00:32:15 +0000415 ret = _chsize(fileno(f->f_fp), (long)newsize);
Trent Mickf29f47b2000-08-11 19:02:59 +0000416 Py_END_ALLOW_THREADS
417 if (ret != 0) goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000418 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000419#else
420 Py_BEGIN_ALLOW_THREADS
421 errno = 0;
422 ret = ftruncate(fileno(f->f_fp), newsize);
423 Py_END_ALLOW_THREADS
424 if (ret != 0) goto onioerror;
425#endif /* !MS_WIN32 */
Tim Peters86821b22001-01-07 21:19:34 +0000426
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000427 Py_INCREF(Py_None);
428 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000429
430onioerror:
431 PyErr_SetFromErrno(PyExc_IOError);
432 clearerr(f->f_fp);
433 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000434}
435#endif /* HAVE_FTRUNCATE */
436
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000437static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000438file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000439{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000440 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000441
Guido van Rossumd7297e61992-07-06 14:19:26 +0000442 if (f->f_fp == NULL)
443 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000444 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000445 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000446 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000447 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000448 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000449 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000450 clearerr(f->f_fp);
451 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000452 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000453#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000454 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000455#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000456 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000457#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000458}
459
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000460static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000461file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000462{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000463 if (f->f_fp == NULL)
464 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000465 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000466}
467
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000468static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000469file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000470{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000471 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000472
Guido van Rossumd7297e61992-07-06 14:19:26 +0000473 if (f->f_fp == NULL)
474 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000475 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000476 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000477 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000478 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000479 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000480 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000481 clearerr(f->f_fp);
482 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000483 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000484 Py_INCREF(Py_None);
485 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000486}
487
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000488static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000489file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000490{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000491 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000492 if (f->f_fp == NULL)
493 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000494 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000495 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000496 Py_END_ALLOW_THREADS
497 return PyInt_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000498}
499
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000500
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000501#if BUFSIZ < 8192
502#define SMALLCHUNK 8192
503#else
504#define SMALLCHUNK BUFSIZ
505#endif
506
Guido van Rossum3c259041999-01-14 19:00:14 +0000507#if SIZEOF_INT < 4
508#define BIGCHUNK (512 * 32)
509#else
510#define BIGCHUNK (512 * 1024)
511#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000512
513static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000514new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000515{
516#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000517 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000518 struct stat st;
519 if (fstat(fileno(f->f_fp), &st) == 0) {
520 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000521 /* The following is not a bug: we really need to call lseek()
522 *and* ftell(). The reason is that some stdio libraries
523 mistakenly flush their buffer when ftell() is called and
524 the lseek() call it makes fails, thereby throwing away
525 data that cannot be recovered in any way. To avoid this,
526 we first test lseek(), and only call ftell() if lseek()
527 works. We can't use the lseek() value either, because we
528 need to take the amount of buffered data into account.
529 (Yet another reason why stdio stinks. :-) */
Jack Jansen2771b5b2001-10-10 22:03:27 +0000530#ifdef USE_GUSI2
531 pos = lseek(fileno(f->f_fp), 1L, SEEK_CUR);
532 pos = lseek(fileno(f->f_fp), -1L, SEEK_CUR);
533#else
Guido van Rossum91aaa921998-05-05 22:21:35 +0000534 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000535#endif
536 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000537 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000538 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000539 if (pos < 0)
540 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000541 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000542 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000543 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000544 }
545#endif
546 if (currentsize > SMALLCHUNK) {
547 /* Keep doubling until we reach BIGCHUNK;
548 then keep adding BIGCHUNK. */
549 if (currentsize <= BIGCHUNK)
550 return currentsize + currentsize;
551 else
552 return currentsize + BIGCHUNK;
553 }
554 return currentsize + SMALLCHUNK;
555}
556
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000557static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000558file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000559{
Guido van Rossum789a1611997-05-10 22:33:55 +0000560 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000561 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000562 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000563
Guido van Rossumd7297e61992-07-06 14:19:26 +0000564 if (f->f_fp == NULL)
565 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +0000566 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000567 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000568 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000569 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000570 else
571 buffersize = bytesrequested;
Trent Mickf29f47b2000-08-11 19:02:59 +0000572 if (buffersize > INT_MAX) {
573 PyErr_SetString(PyExc_OverflowError,
574 "requested number of bytes is more than a Python string can hold");
575 return NULL;
576 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000577 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000578 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000579 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000580 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000581 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000582 Py_BEGIN_ALLOW_THREADS
583 errno = 0;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000584 chunksize = fread(BUF(v) + bytesread, 1,
585 buffersize - bytesread, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000586 Py_END_ALLOW_THREADS
587 if (chunksize == 0) {
588 if (!ferror(f->f_fp))
589 break;
590 PyErr_SetFromErrno(PyExc_IOError);
591 clearerr(f->f_fp);
592 Py_DECREF(v);
593 return NULL;
594 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000595 bytesread += chunksize;
596 if (bytesread < buffersize)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000597 break;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000598 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000599 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000600 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000601 return NULL;
602 }
603 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000604 if (bytesread != buffersize)
605 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000606 return v;
607}
608
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000609static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000610file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000611{
612 char *ptr;
Guido van Rossum00ebd462001-10-23 21:25:24 +0000613 int ntodo;
614 size_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000615
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000616 if (f->f_fp == NULL)
617 return err_closed();
618 if (!PyArg_Parse(args, "w#", &ptr, &ntodo))
619 return NULL;
620 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000621 while (ntodo > 0) {
622 Py_BEGIN_ALLOW_THREADS
623 errno = 0;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000624 nnow = fread(ptr+ndone, 1, ntodo, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000625 Py_END_ALLOW_THREADS
626 if (nnow == 0) {
627 if (!ferror(f->f_fp))
628 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000629 PyErr_SetFromErrno(PyExc_IOError);
630 clearerr(f->f_fp);
631 return NULL;
632 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000633 ndone += nnow;
634 ntodo -= nnow;
635 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000636 return PyInt_FromLong((long)ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000637}
638
Tim Peters86821b22001-01-07 21:19:34 +0000639/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000640Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000641
642Under MSVC 6:
643
Tim Peters1c733232001-01-08 04:02:07 +0000644+ MS threadsafe getc is very slow (multiple layers of function calls before+
645 after each character, to lock+unlock the stream).
646+ The stream-locking functions are MS-internal -- can't access them from user
647 code.
648+ There's nothing Tim could find in the MS C or platform SDK libraries that
649 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000650+ MS fgets locks/unlocks only once per line; it's the only hook we have.
651
652So we use fgets for speed(!), despite that it's painful.
653
654MS realloc is also slow.
655
Tim Petersf29b64d2001-01-15 06:33:19 +0000656Reports from other platforms on this method vs getc_unlocked (which MS doesn't
657have):
658 Linux a wash
659 Solaris a wash
660 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000661
Tim Petersf29b64d2001-01-15 06:33:19 +0000662CAUTION: The C std isn't clear about this: in those cases where fgets
663writes something into the buffer, can it write into any position beyond the
664required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
665known on which it does; and it would be a strange way to code fgets. Still,
666getline_via_fgets may not work correctly if it does. The std test
667test_bufio.py should fail if platform fgets() routinely writes beyond the
668trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000669**************************************************************************/
670
Tim Petersf29b64d2001-01-15 06:33:19 +0000671/* Use this routine if told to, or by default on non-get_unlocked()
672 * platforms unless told not to. Yikes! Let's spell that out:
673 * On a platform with getc_unlocked():
674 * By default, use getc_unlocked().
675 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
676 * On a platform without getc_unlocked():
677 * By default, use fgets().
678 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
679 */
680#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
681#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000682#endif
683
Tim Petersf29b64d2001-01-15 06:33:19 +0000684#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
685#undef USE_FGETS_IN_GETLINE
686#endif
687
688#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000689static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000690getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000691{
Tim Peters15b83852001-01-08 00:53:12 +0000692/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000693 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
694 * to fill this much of the buffer with a known value in order to figure out
695 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
696 * than "most" lines, we waste time filling unused buffer slots. 100 is
697 * surely adequate for most peoples' email archives, chewing over source code,
698 * etc -- "regular old text files".
699 * MAXBUFSIZE is the maximum line length that lets us get away with the less
700 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
701 * cautions about boosting that. 300 was chosen because the worst real-life
702 * text-crunching job reported on Python-Dev was a mail-log crawler where over
703 * half the lines were 254 chars.
704 * INCBUFSIZE is the amount by which we grow the buffer, if MAXBUFSIZE isn't
705 * enough. It doesn't much matter what this is set to: we only get here for
706 * absurdly long lines anyway.
Tim Peters15b83852001-01-08 00:53:12 +0000707 */
Tim Peters142297a2001-01-15 10:36:56 +0000708#define INITBUFSIZE 100
709#define MAXBUFSIZE 300
Tim Peters86821b22001-01-07 21:19:34 +0000710#define INCBUFSIZE 1000
Tim Peters142297a2001-01-15 10:36:56 +0000711 char* p; /* temp */
712 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000713 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +0000714 char* pvfree; /* address of next free slot */
715 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +0000716 size_t nfree; /* # of free buffer slots; pvend-pvfree */
717 size_t total_v_size; /* total # of slots in buffer */
Tim Peters86821b22001-01-07 21:19:34 +0000718
Tim Peters15b83852001-01-08 00:53:12 +0000719 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +0000720 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +0000721 */
Tim Peters142297a2001-01-15 10:36:56 +0000722 total_v_size = INITBUFSIZE; /* start small and pray */
723 pvfree = buf;
724 for (;;) {
725 Py_BEGIN_ALLOW_THREADS
726 pvend = buf + total_v_size;
727 nfree = pvend - pvfree;
728 memset(pvfree, '\n', nfree);
729 p = fgets(pvfree, nfree, fp);
730 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +0000731
Tim Peters142297a2001-01-15 10:36:56 +0000732 if (p == NULL) {
733 clearerr(fp);
734 if (PyErr_CheckSignals())
735 return NULL;
736 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +0000737 return v;
738 }
Tim Peters142297a2001-01-15 10:36:56 +0000739 /* fgets read *something* */
740 p = memchr(pvfree, '\n', nfree);
741 if (p != NULL) {
742 /* Did the \n come from fgets or from us?
743 * Since fgets stops at the first \n, and then writes
744 * \0, if it's from fgets a \0 must be next. But if
745 * that's so, it could not have come from us, since
746 * the \n's we filled the buffer with have only more
747 * \n's to the right.
748 */
749 if (p+1 < pvend && *(p+1) == '\0') {
750 /* It's from fgets: we win! In particular,
751 * we haven't done any mallocs yet, and can
752 * build the final result on the first try.
753 */
754 ++p; /* include \n from fgets */
755 }
756 else {
757 /* Must be from us: fgets didn't fill the
758 * buffer and didn't find a newline, so it
759 * must be the last and newline-free line of
760 * the file.
761 */
762 assert(p > pvfree && *(p-1) == '\0');
763 --p; /* don't include \0 from fgets */
764 }
765 v = PyString_FromStringAndSize(buf, p - buf);
766 return v;
767 }
768 /* yuck: fgets overwrote all the newlines, i.e. the entire
769 * buffer. So this line isn't over yet, or maybe it is but
770 * we're exactly at EOF. If we haven't already, try using the
771 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +0000772 */
Tim Peters142297a2001-01-15 10:36:56 +0000773 assert(*(pvend-1) == '\0');
774 if (pvfree == buf) {
775 pvfree = pvend - 1; /* overwrite trailing null */
776 total_v_size = MAXBUFSIZE;
777 }
778 else
779 break;
Tim Peters86821b22001-01-07 21:19:34 +0000780 }
Tim Peters142297a2001-01-15 10:36:56 +0000781
782 /* The stack buffer isn't big enough; malloc a string object and read
783 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +0000784 */
Tim Peters142297a2001-01-15 10:36:56 +0000785 total_v_size = MAXBUFSIZE + INCBUFSIZE;
Tim Peters1c733232001-01-08 04:02:07 +0000786 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +0000787 if (v == NULL)
788 return v;
789 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +0000790 memcpy(BUF(v), buf, MAXBUFSIZE-1);
791 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +0000792
793 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +0000794 * after setting p one beyond the end of the line. The code here is
795 * very much like the code above, except reads into v's buffer; see
796 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +0000797 */
798 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +0000799 Py_BEGIN_ALLOW_THREADS
800 pvend = BUF(v) + total_v_size;
801 nfree = pvend - pvfree;
802 memset(pvfree, '\n', nfree);
803 p = fgets(pvfree, nfree, fp);
804 Py_END_ALLOW_THREADS
805
806 if (p == NULL) {
807 clearerr(fp);
808 if (PyErr_CheckSignals()) {
809 Py_DECREF(v);
810 return NULL;
811 }
812 p = pvfree;
813 break;
814 }
Tim Peters86821b22001-01-07 21:19:34 +0000815 p = memchr(pvfree, '\n', nfree);
816 if (p != NULL) {
817 if (p+1 < pvend && *(p+1) == '\0') {
818 /* \n came from fgets */
819 ++p;
820 break;
821 }
822 /* \n came from us; last line of file, no newline */
823 assert(p > pvfree && *(p-1) == '\0');
824 --p;
825 break;
826 }
827 /* expand buffer and try again */
828 assert(*(pvend-1) == '\0');
829 total_v_size += INCBUFSIZE;
830 if (total_v_size > INT_MAX) {
831 PyErr_SetString(PyExc_OverflowError,
832 "line is longer than a Python string can hold");
833 Py_DECREF(v);
834 return NULL;
835 }
836 if (_PyString_Resize(&v, (int)total_v_size) < 0)
837 return NULL;
838 /* overwrite the trailing null byte */
839 pvfree = BUF(v) + (total_v_size - INCBUFSIZE - 1);
840 }
841 if (BUF(v) + total_v_size != p)
842 _PyString_Resize(&v, p - BUF(v));
843 return v;
844#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +0000845#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +0000846#undef INCBUFSIZE
847}
Tim Petersf29b64d2001-01-15 06:33:19 +0000848#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000849
Guido van Rossum0bd24411991-04-04 15:21:57 +0000850/* Internal routine to get a line.
851 Size argument interpretation:
852 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +0000853 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +0000854*/
855
Guido van Rossum1187aa42001-01-05 14:43:05 +0000856#ifdef HAVE_GETC_UNLOCKED
857#define GETC(f) getc_unlocked(f)
858#define FLOCKFILE(f) flockfile(f)
859#define FUNLOCKFILE(f) funlockfile(f)
860#else
861#define GETC(f) getc(f)
862#define FLOCKFILE(f)
863#define FUNLOCKFILE(f)
864#endif
865
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000866static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000867get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000868{
Guido van Rossum1187aa42001-01-05 14:43:05 +0000869 FILE *fp = f->f_fp;
870 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +0000871 char *buf, *end;
Trent Mickf29f47b2000-08-11 19:02:59 +0000872 size_t n1, n2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000873 PyObject *v;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000874
Tim Petersf29b64d2001-01-15 06:33:19 +0000875#ifdef USE_FGETS_IN_GETLINE
Guido van Rossum86282062001-01-08 01:26:47 +0000876 if (n <= 0)
Tim Petersf29b64d2001-01-15 06:33:19 +0000877 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +0000878#endif
Guido van Rossum0bd24411991-04-04 15:21:57 +0000879 n2 = n > 0 ? n : 100;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000880 v = PyString_FromStringAndSize((char *)NULL, n2);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000881 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000882 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000883 buf = BUF(v);
884 end = buf + n2;
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000885
Guido van Rossumce5ba841991-03-06 13:06:18 +0000886 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +0000887 Py_BEGIN_ALLOW_THREADS
888 FLOCKFILE(fp);
889 while ((c = GETC(fp)) != EOF &&
890 (*buf++ = c) != '\n' &&
891 buf != end)
892 ;
893 FUNLOCKFILE(fp);
894 Py_END_ALLOW_THREADS
895 if (c == '\n')
896 break;
897 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +0000898 if (ferror(fp)) {
899 PyErr_SetFromErrno(PyExc_IOError);
900 clearerr(fp);
901 Py_DECREF(v);
902 return NULL;
903 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +0000904 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000905 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000906 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +0000907 return NULL;
908 }
Guido van Rossumce5ba841991-03-06 13:06:18 +0000909 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000910 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000911 /* Must be because buf == end */
912 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000913 break;
Guido van Rossum1187aa42001-01-05 14:43:05 +0000914 n1 = n2;
915 n2 += 1000;
916 if (n2 > INT_MAX) {
917 PyErr_SetString(PyExc_OverflowError,
918 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +0000919 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +0000920 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000921 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000922 if (_PyString_Resize(&v, n2) < 0)
923 return NULL;
924 buf = BUF(v) + n1;
925 end = BUF(v) + n2;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000926 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000927
Guido van Rossumce5ba841991-03-06 13:06:18 +0000928 n1 = buf - BUF(v);
929 if (n1 != n2)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000930 _PyString_Resize(&v, n1);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000931 return v;
932}
933
Guido van Rossum0bd24411991-04-04 15:21:57 +0000934/* External C interface */
935
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000936PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000937PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000938{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000939 PyObject *result;
940
Guido van Rossum3165fe61992-09-25 21:59:05 +0000941 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000942 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +0000943 return NULL;
944 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000945
946 if (PyFile_Check(f)) {
947 if (((PyFileObject*)f)->f_fp == NULL)
948 return err_closed();
949 result = get_line((PyFileObject *)f, n);
950 }
951 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000952 PyObject *reader;
953 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000954
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000955 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +0000956 if (reader == NULL)
957 return NULL;
958 if (n <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000959 args = Py_BuildValue("()");
Guido van Rossum3165fe61992-09-25 21:59:05 +0000960 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000961 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000962 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000963 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000964 return NULL;
965 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000966 result = PyEval_CallObject(reader, args);
967 Py_DECREF(reader);
968 Py_DECREF(args);
969 if (result != NULL && !PyString_Check(result)) {
970 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000971 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000972 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +0000973 "object.readline() returned non-string");
974 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000975 }
976
977 if (n < 0 && result != NULL && PyString_Check(result)) {
978 char *s = PyString_AS_STRING(result);
979 int len = PyString_GET_SIZE(result);
980 if (len == 0) {
981 Py_DECREF(result);
982 result = NULL;
983 PyErr_SetString(PyExc_EOFError,
984 "EOF when reading a line");
985 }
986 else if (s[len-1] == '\n') {
987 if (result->ob_refcnt == 1)
988 _PyString_Resize(&result, len-1);
989 else {
990 PyObject *v;
991 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000992 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000993 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +0000994 }
995 }
Guido van Rossum3165fe61992-09-25 21:59:05 +0000996 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000997 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000998}
999
1000/* Python method */
1001
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001002static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001003file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001004{
Guido van Rossum789a1611997-05-10 22:33:55 +00001005 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001006
Guido van Rossumd7297e61992-07-06 14:19:26 +00001007 if (f->f_fp == NULL)
1008 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001009 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001010 return NULL;
1011 if (n == 0)
1012 return PyString_FromString("");
1013 if (n < 0)
1014 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001015 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001016}
1017
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001018static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001019file_xreadlines(PyFileObject *f)
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001020{
1021 static PyObject* xreadlines_function = NULL;
Tim Petersf29b64d2001-01-15 06:33:19 +00001022
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001023 if (!xreadlines_function) {
1024 PyObject *xreadlines_module =
1025 PyImport_ImportModule("xreadlines");
1026 if(!xreadlines_module)
1027 return NULL;
1028
1029 xreadlines_function = PyObject_GetAttrString(xreadlines_module,
1030 "xreadlines");
1031 Py_DECREF(xreadlines_module);
1032 if(!xreadlines_function)
1033 return NULL;
1034 }
1035 return PyObject_CallFunction(xreadlines_function, "(O)", f);
1036}
1037
1038static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001039file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001040{
Guido van Rossum789a1611997-05-10 22:33:55 +00001041 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001042 PyObject *list;
1043 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001044 char small_buffer[SMALLCHUNK];
1045 char *buffer = small_buffer;
1046 size_t buffersize = SMALLCHUNK;
1047 PyObject *big_buffer = NULL;
1048 size_t nfilled = 0;
1049 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001050 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001051 char *p, *q, *end;
1052 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001053 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001054
Guido van Rossumd7297e61992-07-06 14:19:26 +00001055 if (f->f_fp == NULL)
1056 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001057 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001058 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001059 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001060 return NULL;
1061 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001062 if (shortread)
1063 nread = 0;
1064 else {
1065 Py_BEGIN_ALLOW_THREADS
1066 errno = 0;
1067 nread = fread(buffer+nfilled, 1,
1068 buffersize-nfilled, f->f_fp);
1069 Py_END_ALLOW_THREADS
1070 shortread = (nread < buffersize-nfilled);
1071 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001072 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001073 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001074 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001075 break;
1076 PyErr_SetFromErrno(PyExc_IOError);
1077 clearerr(f->f_fp);
1078 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001079 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001080 list = NULL;
1081 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001082 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001083 totalread += nread;
Guido van Rossum6263d541997-05-10 22:07:25 +00001084 p = memchr(buffer+nfilled, '\n', nread);
1085 if (p == NULL) {
1086 /* Need a larger buffer to fit this line */
1087 nfilled += nread;
1088 buffersize *= 2;
Trent Mickf29f47b2000-08-11 19:02:59 +00001089 if (buffersize > INT_MAX) {
1090 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001091 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001092 goto error;
1093 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001094 if (big_buffer == NULL) {
1095 /* Create the big buffer */
1096 big_buffer = PyString_FromStringAndSize(
1097 NULL, buffersize);
1098 if (big_buffer == NULL)
1099 goto error;
1100 buffer = PyString_AS_STRING(big_buffer);
1101 memcpy(buffer, small_buffer, nfilled);
1102 }
1103 else {
1104 /* Grow the big buffer */
1105 _PyString_Resize(&big_buffer, buffersize);
1106 buffer = PyString_AS_STRING(big_buffer);
1107 }
1108 continue;
1109 }
1110 end = buffer+nfilled+nread;
1111 q = buffer;
1112 do {
1113 /* Process complete lines */
1114 p++;
1115 line = PyString_FromStringAndSize(q, p-q);
1116 if (line == NULL)
1117 goto error;
1118 err = PyList_Append(list, line);
1119 Py_DECREF(line);
1120 if (err != 0)
1121 goto error;
1122 q = p;
1123 p = memchr(q, '\n', end-q);
1124 } while (p != NULL);
1125 /* Move the remaining incomplete line to the start */
1126 nfilled = end-q;
1127 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001128 if (sizehint > 0)
1129 if (totalread >= (size_t)sizehint)
1130 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001131 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001132 if (nfilled != 0) {
1133 /* Partial last line */
1134 line = PyString_FromStringAndSize(buffer, nfilled);
1135 if (line == NULL)
1136 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001137 if (sizehint > 0) {
1138 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001139 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001140 if (rest == NULL) {
1141 Py_DECREF(line);
1142 goto error;
1143 }
1144 PyString_Concat(&line, rest);
1145 Py_DECREF(rest);
1146 if (line == NULL)
1147 goto error;
1148 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001149 err = PyList_Append(list, line);
1150 Py_DECREF(line);
1151 if (err != 0)
1152 goto error;
1153 }
1154 cleanup:
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001155 if (big_buffer) {
Guido van Rossum6263d541997-05-10 22:07:25 +00001156 Py_DECREF(big_buffer);
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001157 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001158 return list;
1159}
1160
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001161static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001162file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001163{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001164 char *s;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001165 int n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001166 if (f->f_fp == NULL)
1167 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001168 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001169 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001170 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001171 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001172 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001173 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001174 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001175 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001176 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001177 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001178 return NULL;
1179 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001180 Py_INCREF(Py_None);
1181 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001182}
1183
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001184static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001185file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001186{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001187#define CHUNKSIZE 1000
1188 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001189 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001190 PyObject *result;
1191 int i, j, index, len, nwritten, islist;
1192
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001193 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001194 if (f->f_fp == NULL)
1195 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001196
1197 result = NULL;
1198 list = NULL;
1199 islist = PyList_Check(seq);
1200 if (islist)
1201 it = NULL;
1202 else {
1203 it = PyObject_GetIter(seq);
1204 if (it == NULL) {
1205 PyErr_SetString(PyExc_TypeError,
1206 "writelines() requires an iterable argument");
1207 return NULL;
1208 }
1209 /* From here on, fail by going to error, to reclaim "it". */
1210 list = PyList_New(CHUNKSIZE);
1211 if (list == NULL)
1212 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001213 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001214
1215 /* Strategy: slurp CHUNKSIZE lines into a private list,
1216 checking that they are all strings, then write that list
1217 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001218 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001219 if (islist) {
1220 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001221 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001222 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001223 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001224 j = PyList_GET_SIZE(list);
1225 }
1226 else {
1227 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001228 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001229 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001230 if (PyErr_Occurred())
1231 goto error;
1232 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001233 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001234 PyList_SetItem(list, j, line);
1235 }
1236 }
1237 if (j == 0)
1238 break;
1239
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001240 /* Check that all entries are indeed strings. If not,
1241 apply the same rules as for file.write() and
1242 convert the results to strings. This is slow, but
1243 seems to be the only way since all conversion APIs
1244 could potentially execute Python code. */
1245 for (i = 0; i < j; i++) {
1246 PyObject *v = PyList_GET_ITEM(list, i);
1247 if (!PyString_Check(v)) {
1248 const char *buffer;
1249 int len;
Tim Peters86821b22001-01-07 21:19:34 +00001250 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001251 PyObject_AsReadBuffer(v,
1252 (const void**)&buffer,
1253 &len)) ||
1254 PyObject_AsCharBuffer(v,
1255 &buffer,
1256 &len))) {
1257 PyErr_SetString(PyExc_TypeError,
Fred Drake661ea262000-10-24 19:57:45 +00001258 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001259 goto error;
1260 }
1261 line = PyString_FromStringAndSize(buffer,
1262 len);
1263 if (line == NULL)
1264 goto error;
1265 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001266 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001267 }
1268 }
1269
1270 /* Since we are releasing the global lock, the
1271 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001272 Py_BEGIN_ALLOW_THREADS
1273 f->f_softspace = 0;
1274 errno = 0;
1275 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001276 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001277 len = PyString_GET_SIZE(line);
1278 nwritten = fwrite(PyString_AS_STRING(line),
1279 1, len, f->f_fp);
1280 if (nwritten != len) {
1281 Py_BLOCK_THREADS
1282 PyErr_SetFromErrno(PyExc_IOError);
1283 clearerr(f->f_fp);
1284 goto error;
1285 }
1286 }
1287 Py_END_ALLOW_THREADS
1288
1289 if (j < CHUNKSIZE)
1290 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001291 }
1292
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001293 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001294 result = Py_None;
1295 error:
1296 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001297 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001298 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001299#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001300}
1301
Tim Petersefc3a3a2001-09-20 07:55:22 +00001302static char readline_doc[] =
1303"readline([size]) -> next line from the file, as a string.\n"
1304"\n"
1305"Retain newline. A non-negative size argument limits the maximum\n"
1306"number of bytes to return (an incomplete line may be returned then).\n"
1307"Return an empty string at EOF.";
1308
1309static char read_doc[] =
1310"read([size]) -> read at most size bytes, returned as a string.\n"
1311"\n"
1312"If the size argument is negative or omitted, read until EOF is reached.";
1313
1314static char write_doc[] =
1315"write(str) -> None. Write string str to file.\n"
1316"\n"
1317"Note that due to buffering, flush() or close() may be needed before\n"
1318"the file on disk reflects the data written.";
1319
1320static char fileno_doc[] =
1321"fileno() -> integer \"file descriptor\".\n"
1322"\n"
1323"This is needed for lower-level file interfaces, such os.read().";
1324
1325static char seek_doc[] =
1326"seek(offset[, whence]) -> None. Move to new file position.\n"
1327"\n"
1328"Argument offset is a byte count. Optional argument whence defaults to\n"
1329"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1330"(move relative to current position, positive or negative), and 2 (move\n"
1331"relative to end of file, usually negative, although many platforms allow\n"
1332"seeking beyond the end of a file).\n"
1333"\n"
1334"Note that not all file objects are seekable.";
1335
Guido van Rossumd7047b31995-01-02 19:07:15 +00001336#ifdef HAVE_FTRUNCATE
Tim Petersefc3a3a2001-09-20 07:55:22 +00001337static char truncate_doc[] =
1338"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1339"\n"
1340"Size defaults to the current file position, as returned by tell().";
Guido van Rossumd7047b31995-01-02 19:07:15 +00001341#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001342
1343static char tell_doc[] =
1344"tell() -> current file position, an integer (may be a long integer).";
1345
1346static char readinto_doc[] =
1347"readinto() -> Undocumented. Don't use this; it may go away.";
1348
1349static char readlines_doc[] =
1350"readlines([size]) -> list of strings, each a line from the file.\n"
1351"\n"
1352"Call readline() repeatedly and return a list of the lines so read.\n"
1353"The optional size argument, if given, is an approximate bound on the\n"
1354"total number of bytes in the lines returned.";
1355
1356static char xreadlines_doc[] =
1357"xreadlines() -> next line from the file, as a string.\n"
1358"\n"
1359"Equivalent to xreadlines.xreadlines(file). This is like readline(), but\n"
1360"often quicker, due to reading ahead internally.";
1361
1362static char writelines_doc[] =
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001363"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001364"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001365"Note that newlines are not added. The sequence can be any iterable object\n"
1366"producing strings. This is equivalent to calling write() for each string.";
Tim Petersefc3a3a2001-09-20 07:55:22 +00001367
1368static char flush_doc[] =
1369"flush() -> None. Flush the internal I/O buffer.";
1370
1371static char close_doc[] =
1372"close() -> None or (perhaps) an integer. Close the file.\n"
1373"\n"
1374"Sets data attribute .closed to true. A closed file cannot be used for\n"
1375"further I/O operations. close() may be called more than once without\n"
1376"error. Some kinds of file objects (for example, opened by popen())\n"
1377"may return an exit status upon closing.";
1378
1379static char isatty_doc[] =
1380"isatty() -> true or false. True if the file is connected to a tty device.";
1381
1382static PyMethodDef file_methods[] = {
1383 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1384 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001385 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001386 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1387 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
1388#ifdef HAVE_FTRUNCATE
1389 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
1390#endif
1391 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1392 {"readinto", (PyCFunction)file_readinto, METH_OLDARGS, readinto_doc},
1393 {"readlines", (PyCFunction)file_readlines, METH_VARARGS, readlines_doc},
1394 {"xreadlines", (PyCFunction)file_xreadlines, METH_NOARGS, xreadlines_doc},
1395 {"writelines", (PyCFunction)file_writelines, METH_O, writelines_doc},
1396 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1397 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1398 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001399 {NULL, NULL} /* sentinel */
1400};
1401
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001402#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001403
Guido van Rossum6f799372001-09-20 20:46:19 +00001404static PyMemberDef file_memberlist[] = {
1405 {"softspace", T_INT, OFF(f_softspace), 0,
1406 "flag indicating that a space needs to be printed; used by print"},
1407 {"mode", T_OBJECT, OFF(f_mode), RO,
1408 "file mode ('r', 'w', 'a', possibly with 'b' or '+' added)"},
1409 {"name", T_OBJECT, OFF(f_name), RO,
1410 "file name"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001411 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001412 {NULL} /* Sentinel */
1413};
1414
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001415static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001416get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001417{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001418 return PyInt_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001419}
1420
Guido van Rossum32d34c82001-09-20 21:45:26 +00001421static PyGetSetDef file_getsetlist[] = {
1422 {"closed", (getter)get_closed, NULL, "flag set if the file is closed"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001423 {0},
1424};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001425
Guido van Rossum65967252001-04-21 13:20:18 +00001426static PyObject *
Guido van Rossum5b021842001-05-22 16:48:37 +00001427file_getiter(PyObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001428{
Guido van Rossum5b021842001-05-22 16:48:37 +00001429 return PyObject_CallMethod(f, "xreadlines", "");
Guido van Rossum65967252001-04-21 13:20:18 +00001430}
1431
Tim Peters59c9a642001-09-13 05:38:56 +00001432static PyObject *
1433file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1434{
Tim Peters44410012001-09-14 03:26:08 +00001435 PyObject *self;
1436 static PyObject *not_yet_string;
1437
1438 assert(type != NULL && type->tp_alloc != NULL);
1439
1440 if (not_yet_string == NULL) {
1441 not_yet_string = PyString_FromString("<uninitialized file>");
1442 if (not_yet_string == NULL)
1443 return NULL;
1444 }
1445
1446 self = type->tp_alloc(type, 0);
1447 if (self != NULL) {
1448 /* Always fill in the name and mode, so that nobody else
1449 needs to special-case NULLs there. */
1450 Py_INCREF(not_yet_string);
1451 ((PyFileObject *)self)->f_name = not_yet_string;
1452 Py_INCREF(not_yet_string);
1453 ((PyFileObject *)self)->f_mode = not_yet_string;
1454 }
1455 return self;
1456}
1457
1458static int
1459file_init(PyObject *self, PyObject *args, PyObject *kwds)
1460{
1461 PyFileObject *foself = (PyFileObject *)self;
1462 int ret = 0;
Tim Peters59c9a642001-09-13 05:38:56 +00001463 static char *kwlist[] = {"name", "mode", "buffering", 0};
1464 char *name = NULL;
1465 char *mode = "r";
1466 int bufsize = -1;
Tim Peters44410012001-09-14 03:26:08 +00001467
1468 assert(PyFile_Check(self));
1469 if (foself->f_fp != NULL) {
1470 /* Have to close the existing file first. */
1471 PyObject *closeresult = file_close(foself);
1472 if (closeresult == NULL)
1473 return -1;
1474 Py_DECREF(closeresult);
1475 }
Tim Peters59c9a642001-09-13 05:38:56 +00001476
1477 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
1478 Py_FileSystemDefaultEncoding, &name,
1479 &mode, &bufsize))
Tim Peters44410012001-09-14 03:26:08 +00001480 return -1;
1481 if (fill_file_fields(foself, NULL, name, mode, fclose) == NULL)
1482 goto Error;
1483 if (open_the_file(foself, name, mode) == NULL)
1484 goto Error;
1485 PyFile_SetBufSize(self, bufsize);
1486 goto Done;
1487
1488Error:
1489 ret = -1;
1490 /* fall through */
1491Done:
Tim Peters59c9a642001-09-13 05:38:56 +00001492 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00001493 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00001494}
1495
Tim Peters59c9a642001-09-13 05:38:56 +00001496static char file_doc[] =
1497"file(name[, mode[, buffering]]) -> file object\n"
1498"\n"
1499"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
1500"writing or appending. The file will be created if it doesn't exist\n"
1501"when opened for writing or appending; it will be truncated when\n"
1502"opened for writing. Add a 'b' to the mode for binary files.\n"
1503"Add a '+' to the mode to allow simultaneous reading and writing.\n"
1504"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00001505"buffered, and larger numbers specify the buffer size.\n"
1506"Note: open() is an alias for file().\n";
Tim Peters59c9a642001-09-13 05:38:56 +00001507
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001508PyTypeObject PyFile_Type = {
1509 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001510 0,
1511 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001512 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001513 0,
Guido van Rossum65967252001-04-21 13:20:18 +00001514 (destructor)file_dealloc, /* tp_dealloc */
1515 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001516 0, /* tp_getattr */
1517 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00001518 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001519 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00001520 0, /* tp_as_number */
1521 0, /* tp_as_sequence */
1522 0, /* tp_as_mapping */
1523 0, /* tp_hash */
1524 0, /* tp_call */
1525 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001526 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum65967252001-04-21 13:20:18 +00001527 0, /* tp_setattro */
1528 0, /* tp_as_buffer */
Guido van Rossum9475a232001-10-05 20:51:39 +00001529 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00001530 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001531 0, /* tp_traverse */
1532 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00001533 0, /* tp_richcompare */
1534 0, /* tp_weaklistoffset */
Guido van Rossum5b021842001-05-22 16:48:37 +00001535 file_getiter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +00001536 0, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001537 file_methods, /* tp_methods */
1538 file_memberlist, /* tp_members */
1539 file_getsetlist, /* tp_getset */
1540 0, /* tp_base */
1541 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00001542 0, /* tp_descr_get */
1543 0, /* tp_descr_set */
1544 0, /* tp_dictoffset */
Tim Peters44410012001-09-14 03:26:08 +00001545 (initproc)file_init, /* tp_init */
1546 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00001547 file_new, /* tp_new */
Guido van Rossum9475a232001-10-05 20:51:39 +00001548 _PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001549};
Guido van Rossumeb183da1991-04-04 10:44:06 +00001550
1551/* Interface for the 'soft space' between print items. */
1552
1553int
Fred Drakefd99de62000-07-09 05:02:18 +00001554PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00001555{
1556 int oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001557 if (f == NULL) {
1558 /* Do nothing */
1559 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001560 else if (PyFile_Check(f)) {
1561 oldflag = ((PyFileObject *)f)->f_softspace;
1562 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001563 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001564 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001565 PyObject *v;
1566 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001567 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001568 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001569 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001570 if (PyInt_Check(v))
1571 oldflag = PyInt_AsLong(v);
1572 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001573 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001574 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001575 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001576 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001577 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001578 if (PyObject_SetAttrString(f, "softspace", v) != 0)
1579 PyErr_Clear();
1580 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001581 }
1582 }
Guido van Rossumeb183da1991-04-04 10:44:06 +00001583 return oldflag;
1584}
Guido van Rossum3165fe61992-09-25 21:59:05 +00001585
1586/* Interfaces to write objects/strings to file-like objects */
1587
1588int
Fred Drakefd99de62000-07-09 05:02:18 +00001589PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001590{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001591 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001592 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001593 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001594 return -1;
1595 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001596 else if (PyFile_Check(f)) {
1597 FILE *fp = PyFile_AsFile(f);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001598 if (fp == NULL) {
1599 err_closed();
1600 return -1;
1601 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001602 return PyObject_Print(v, fp, flags);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001603 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001604 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001605 if (writer == NULL)
1606 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00001607 if (flags & Py_PRINT_RAW) {
1608 if (PyUnicode_Check(v)) {
1609 value = v;
1610 Py_INCREF(value);
1611 } else
1612 value = PyObject_Str(v);
1613 }
1614 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001615 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00001616 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001617 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00001618 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001619 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001620 args = Py_BuildValue("(O)", value);
Guido van Rossume9eec541997-05-22 14:02:25 +00001621 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001622 Py_DECREF(value);
1623 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00001624 return -1;
1625 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001626 result = PyEval_CallObject(writer, args);
1627 Py_DECREF(args);
1628 Py_DECREF(value);
1629 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001630 if (result == NULL)
1631 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001632 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001633 return 0;
1634}
1635
Guido van Rossum27a60b11997-05-22 22:25:11 +00001636int
Tim Petersc1bbcb82001-11-28 22:13:25 +00001637PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001638{
1639 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00001640 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00001641 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00001642 PyErr_SetString(PyExc_SystemError,
1643 "null file for PyFile_WriteString");
1644 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001645 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001646 else if (PyFile_Check(f)) {
1647 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001648 if (fp == NULL) {
1649 err_closed();
1650 return -1;
1651 }
1652 fputs(s, fp);
1653 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001654 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001655 else if (!PyErr_Occurred()) {
1656 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001657 int err;
1658 if (v == NULL)
1659 return -1;
1660 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
1661 Py_DECREF(v);
1662 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001663 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00001664 else
1665 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001666}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001667
1668/* Try to get a file-descriptor from a Python object. If the object
1669 is an integer or long integer, its value is returned. If not, the
1670 object's fileno() method is called if it exists; the method must return
1671 an integer or long integer, which is returned as the file descriptor value.
1672 -1 is returned on failure.
1673*/
1674
1675int PyObject_AsFileDescriptor(PyObject *o)
1676{
1677 int fd;
1678 PyObject *meth;
1679
1680 if (PyInt_Check(o)) {
1681 fd = PyInt_AsLong(o);
1682 }
1683 else if (PyLong_Check(o)) {
1684 fd = PyLong_AsLong(o);
1685 }
1686 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
1687 {
1688 PyObject *fno = PyEval_CallObject(meth, NULL);
1689 Py_DECREF(meth);
1690 if (fno == NULL)
1691 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00001692
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001693 if (PyInt_Check(fno)) {
1694 fd = PyInt_AsLong(fno);
1695 Py_DECREF(fno);
1696 }
1697 else if (PyLong_Check(fno)) {
1698 fd = PyLong_AsLong(fno);
1699 Py_DECREF(fno);
1700 }
1701 else {
1702 PyErr_SetString(PyExc_TypeError,
1703 "fileno() returned a non-integer");
1704 Py_DECREF(fno);
1705 return -1;
1706 }
1707 }
1708 else {
1709 PyErr_SetString(PyExc_TypeError,
1710 "argument must be an int, or have a fileno() method.");
1711 return -1;
1712 }
1713
1714 if (fd < 0) {
1715 PyErr_Format(PyExc_ValueError,
1716 "file descriptor cannot be a negative integer (%i)",
1717 fd);
1718 return -1;
1719 }
1720 return fd;
1721}