blob: b4f9e9b5c68e27e02f7ed7e135141fd3626db4a3 [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 }
Guido van Rossumd7047b31995-01-02 19:07:15 +0000109#ifdef HAVE_FOPENRF
Guido van Rossuma08095a1991-02-13 23:25:27 +0000110 if (*mode == '*') {
111 FILE *fopenRF();
112 f->f_fp = fopenRF(name, mode+1);
113 }
114 else
115#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000116 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000117 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000118 f->f_fp = fopen(name, mode);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000119 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000120 }
Guido van Rossuma08095a1991-02-13 23:25:27 +0000121 if (f->f_fp == NULL) {
Jack Jansene08dea191995-04-23 22:12:47 +0000122#ifdef NO_FOPEN_ERRNO
Barry Warsaw52ddc0e1998-07-23 16:07:02 +0000123 /* Metroworks only, not testable, so unchanged */
Jeremy Hylton41c83212001-11-09 16:17:24 +0000124 if (errno == 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000125 PyErr_SetString(PyExc_IOError, "Cannot open file");
Jack Jansene08dea191995-04-23 22:12:47 +0000126 return NULL;
127 }
128#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000129 if (errno == EINVAL)
130 PyErr_Format(PyExc_IOError, "invalid argument: %s",
131 mode);
132 else
133 PyErr_SetFromErrnoWithFilename(PyExc_IOError, name);
Tim Peters59c9a642001-09-13 05:38:56 +0000134 f = NULL;
135 }
136 return (PyObject *)f;
137}
138
139PyObject *
140PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
141{
Tim Peters44410012001-09-14 03:26:08 +0000142 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
143 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000144 if (f != NULL) {
145 if (fill_file_fields(f, fp, name, mode, close) == NULL) {
146 Py_DECREF(f);
147 f = NULL;
148 }
149 }
150 return (PyObject *) f;
151}
152
153PyObject *
154PyFile_FromString(char *name, char *mode)
155{
156 extern int fclose(FILE *);
157 PyFileObject *f;
158
159 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
160 if (f != NULL) {
161 if (open_the_file(f, name, mode) == NULL) {
162 Py_DECREF(f);
163 f = NULL;
164 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000165 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000166 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000167}
168
Guido van Rossumb6775db1994-08-01 11:34:53 +0000169void
Fred Drakefd99de62000-07-09 05:02:18 +0000170PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000171{
172 if (bufsize >= 0) {
173#ifdef HAVE_SETVBUF
174 int type;
175 switch (bufsize) {
176 case 0:
177 type = _IONBF;
178 break;
179 case 1:
180 type = _IOLBF;
181 bufsize = BUFSIZ;
182 break;
183 default:
184 type = _IOFBF;
185 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000186 setvbuf(((PyFileObject *)f)->f_fp, (char *)NULL,
187 type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000188#else /* !HAVE_SETVBUF */
189 if (bufsize <= 1)
190 setbuf(((PyFileObject *)f)->f_fp, (char *)NULL);
191#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000192 }
193}
194
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000195static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000196err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000197{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000198 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000199 return NULL;
200}
201
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000202/* Methods */
203
204static void
Fred Drakefd99de62000-07-09 05:02:18 +0000205file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000206{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000207 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000208 Py_BEGIN_ALLOW_THREADS
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000209 (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000210 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000211 }
Tim Peters44410012001-09-14 03:26:08 +0000212 Py_XDECREF(f->f_name);
213 Py_XDECREF(f->f_mode);
Guido van Rossum9475a232001-10-05 20:51:39 +0000214 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000215}
216
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000217static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000218file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000219{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000220 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
221 f->f_fp == NULL ? "closed" : "open",
222 PyString_AsString(f->f_name),
223 PyString_AsString(f->f_mode),
224 f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000225}
226
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000227static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000228file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000229{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000230 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000231 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000232 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000233 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000234 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000235 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000236 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000237 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000238 f->f_fp = NULL;
239 }
Guido van Rossumfebd5511992-03-04 16:39:24 +0000240 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000241 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000242 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000243 return PyInt_FromLong((long)sts);
244 Py_INCREF(Py_None);
245 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000246}
247
Trent Mickf29f47b2000-08-11 19:02:59 +0000248
Guido van Rossumb8552162001-09-05 14:58:11 +0000249/* Our very own off_t-like type, 64-bit if possible */
250#if !defined(HAVE_LARGEFILE_SUPPORT)
251typedef off_t Py_off_t;
252#elif SIZEOF_OFF_T >= 8
253typedef off_t Py_off_t;
254#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000255typedef fpos_t Py_off_t;
256#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000257#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000258#endif
259
260
Trent Mickf29f47b2000-08-11 19:02:59 +0000261/* a portable fseek() function
262 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000263static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000264_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000265{
Guido van Rossumb8552162001-09-05 14:58:11 +0000266#if !defined(HAVE_LARGEFILE_SUPPORT)
267 return fseek(fp, offset, whence);
268#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000269 return fseeko(fp, offset, whence);
270#elif defined(HAVE_FSEEK64)
271 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000272#elif defined(__BEOS__)
273 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000274#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000275 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
276 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000277 fpos_t pos;
278 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000279 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000280#ifdef MS_WINDOWS
281 fflush(fp);
282 if (_lseeki64(fileno(fp), 0, 2) == -1)
283 return -1;
284#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000285 if (fseek(fp, 0, SEEK_END) != 0)
286 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000287#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000288 /* fall through */
289 case SEEK_CUR:
290 if (fgetpos(fp, &pos) != 0)
291 return -1;
292 offset += pos;
293 break;
294 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000295 }
296 return fsetpos(fp, &offset);
297#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000298#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000299#endif
300}
301
302
303/* a portable ftell() function
304 Return -1 on failure with errno set appropriately, current file
305 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000306static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000307_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000308{
Guido van Rossumb8552162001-09-05 14:58:11 +0000309#if !defined(HAVE_LARGEFILE_SUPPORT)
310 return ftell(fp);
311#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
312 return ftello(fp);
313#elif defined(HAVE_FTELL64)
314 return ftell64(fp);
315#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000316 fpos_t pos;
317 if (fgetpos(fp, &pos) != 0)
318 return -1;
319 return pos;
320#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000321#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000322#endif
323}
324
325
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000326static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000327file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000328{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000329 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000330 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000331 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000332 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000333
Guido van Rossumd7297e61992-07-06 14:19:26 +0000334 if (f->f_fp == NULL)
335 return err_closed();
336 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000337 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000338 return NULL;
339#if !defined(HAVE_LARGEFILE_SUPPORT)
340 offset = PyInt_AsLong(offobj);
341#else
342 offset = PyLong_Check(offobj) ?
343 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
344#endif
345 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000346 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000347
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000348 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000349 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000350 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000351 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000352
Guido van Rossumff4949e1992-08-05 19:58:53 +0000353 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000354 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000355 clearerr(f->f_fp);
356 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000357 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000358 Py_INCREF(Py_None);
359 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000360}
361
Trent Mickf29f47b2000-08-11 19:02:59 +0000362
Guido van Rossumd7047b31995-01-02 19:07:15 +0000363#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000364static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000365file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000366{
Guido van Rossumd7047b31995-01-02 19:07:15 +0000367 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000368 Py_off_t newsize;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000369 PyObject *newsizeobj;
Tim Peters86821b22001-01-07 21:19:34 +0000370
Guido van Rossumd7047b31995-01-02 19:07:15 +0000371 if (f->f_fp == NULL)
372 return err_closed();
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000373 newsizeobj = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +0000374 if (!PyArg_ParseTuple(args, "|O:truncate", &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000375 return NULL;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000376 if (newsizeobj != NULL) {
377#if !defined(HAVE_LARGEFILE_SUPPORT)
378 newsize = PyInt_AsLong(newsizeobj);
379#else
380 newsize = PyLong_Check(newsizeobj) ?
381 PyLong_AsLongLong(newsizeobj) :
382 PyInt_AsLong(newsizeobj);
383#endif
384 if (PyErr_Occurred())
385 return NULL;
386 } else {
387 /* Default to current position*/
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000388 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000389 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000390 newsize = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000391 Py_END_ALLOW_THREADS
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000392 if (newsize == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000393 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumd7047b31995-01-02 19:07:15 +0000394 clearerr(f->f_fp);
395 return NULL;
396 }
397 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000398 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000399 errno = 0;
400 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000401 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000402 if (ret != 0) goto onioerror;
403
404#ifdef MS_WIN32
405 /* can use _chsize; if, however, the newsize overflows 32-bits then
406 _chsize is *not* adequate; in this case, an OverflowError is raised */
407 if (newsize > LONG_MAX) {
408 PyErr_SetString(PyExc_OverflowError,
409 "the new size is too long for _chsize (it is limited to 32-bit values)");
Guido van Rossumd7047b31995-01-02 19:07:15 +0000410 return NULL;
Trent Mickf29f47b2000-08-11 19:02:59 +0000411 } else {
412 Py_BEGIN_ALLOW_THREADS
413 errno = 0;
Tim Peters6e13a562001-09-06 00:32:15 +0000414 ret = _chsize(fileno(f->f_fp), (long)newsize);
Trent Mickf29f47b2000-08-11 19:02:59 +0000415 Py_END_ALLOW_THREADS
416 if (ret != 0) goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000417 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000418#else
419 Py_BEGIN_ALLOW_THREADS
420 errno = 0;
421 ret = ftruncate(fileno(f->f_fp), newsize);
422 Py_END_ALLOW_THREADS
423 if (ret != 0) goto onioerror;
424#endif /* !MS_WIN32 */
Tim Peters86821b22001-01-07 21:19:34 +0000425
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000426 Py_INCREF(Py_None);
427 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000428
429onioerror:
430 PyErr_SetFromErrno(PyExc_IOError);
431 clearerr(f->f_fp);
432 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000433}
434#endif /* HAVE_FTRUNCATE */
435
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000436static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000437file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000438{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000439 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000440
Guido van Rossumd7297e61992-07-06 14:19:26 +0000441 if (f->f_fp == NULL)
442 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000443 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000444 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000445 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000446 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000447 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000448 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000449 clearerr(f->f_fp);
450 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000451 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000452#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000453 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000454#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000455 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000456#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000457}
458
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000459static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000460file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000461{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000462 if (f->f_fp == NULL)
463 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000464 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000465}
466
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000467static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000468file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000469{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000470 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000471
Guido van Rossumd7297e61992-07-06 14:19:26 +0000472 if (f->f_fp == NULL)
473 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000474 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000475 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000476 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000477 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000478 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000479 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000480 clearerr(f->f_fp);
481 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000482 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000483 Py_INCREF(Py_None);
484 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000485}
486
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000487static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000488file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000489{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000490 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000491 if (f->f_fp == NULL)
492 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000493 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000494 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000495 Py_END_ALLOW_THREADS
496 return PyInt_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000497}
498
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000499
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000500#if BUFSIZ < 8192
501#define SMALLCHUNK 8192
502#else
503#define SMALLCHUNK BUFSIZ
504#endif
505
Guido van Rossum3c259041999-01-14 19:00:14 +0000506#if SIZEOF_INT < 4
507#define BIGCHUNK (512 * 32)
508#else
509#define BIGCHUNK (512 * 1024)
510#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000511
512static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000513new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000514{
515#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000516 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000517 struct stat st;
518 if (fstat(fileno(f->f_fp), &st) == 0) {
519 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000520 /* The following is not a bug: we really need to call lseek()
521 *and* ftell(). The reason is that some stdio libraries
522 mistakenly flush their buffer when ftell() is called and
523 the lseek() call it makes fails, thereby throwing away
524 data that cannot be recovered in any way. To avoid this,
525 we first test lseek(), and only call ftell() if lseek()
526 works. We can't use the lseek() value either, because we
527 need to take the amount of buffered data into account.
528 (Yet another reason why stdio stinks. :-) */
Jack Jansen2771b5b2001-10-10 22:03:27 +0000529#ifdef USE_GUSI2
530 pos = lseek(fileno(f->f_fp), 1L, SEEK_CUR);
531 pos = lseek(fileno(f->f_fp), -1L, SEEK_CUR);
532#else
Guido van Rossum91aaa921998-05-05 22:21:35 +0000533 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000534#endif
535 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000536 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000537 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000538 if (pos < 0)
539 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000540 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000541 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000542 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000543 }
544#endif
545 if (currentsize > SMALLCHUNK) {
546 /* Keep doubling until we reach BIGCHUNK;
547 then keep adding BIGCHUNK. */
548 if (currentsize <= BIGCHUNK)
549 return currentsize + currentsize;
550 else
551 return currentsize + BIGCHUNK;
552 }
553 return currentsize + SMALLCHUNK;
554}
555
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000556static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000557file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000558{
Guido van Rossum789a1611997-05-10 22:33:55 +0000559 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000560 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000561 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000562
Guido van Rossumd7297e61992-07-06 14:19:26 +0000563 if (f->f_fp == NULL)
564 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +0000565 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000566 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000567 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000568 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000569 else
570 buffersize = bytesrequested;
Trent Mickf29f47b2000-08-11 19:02:59 +0000571 if (buffersize > INT_MAX) {
572 PyErr_SetString(PyExc_OverflowError,
573 "requested number of bytes is more than a Python string can hold");
574 return NULL;
575 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000576 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000577 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000578 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000579 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000580 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000581 Py_BEGIN_ALLOW_THREADS
582 errno = 0;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000583 chunksize = fread(BUF(v) + bytesread, 1,
584 buffersize - bytesread, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000585 Py_END_ALLOW_THREADS
586 if (chunksize == 0) {
587 if (!ferror(f->f_fp))
588 break;
589 PyErr_SetFromErrno(PyExc_IOError);
590 clearerr(f->f_fp);
591 Py_DECREF(v);
592 return NULL;
593 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000594 bytesread += chunksize;
595 if (bytesread < buffersize)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000596 break;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000597 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000598 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000599 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000600 return NULL;
601 }
602 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000603 if (bytesread != buffersize)
604 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000605 return v;
606}
607
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000608static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000609file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000610{
611 char *ptr;
Guido van Rossum00ebd462001-10-23 21:25:24 +0000612 int ntodo;
613 size_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000614
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000615 if (f->f_fp == NULL)
616 return err_closed();
617 if (!PyArg_Parse(args, "w#", &ptr, &ntodo))
618 return NULL;
619 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000620 while (ntodo > 0) {
621 Py_BEGIN_ALLOW_THREADS
622 errno = 0;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000623 nnow = fread(ptr+ndone, 1, ntodo, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000624 Py_END_ALLOW_THREADS
625 if (nnow == 0) {
626 if (!ferror(f->f_fp))
627 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000628 PyErr_SetFromErrno(PyExc_IOError);
629 clearerr(f->f_fp);
630 return NULL;
631 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000632 ndone += nnow;
633 ntodo -= nnow;
634 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000635 return PyInt_FromLong((long)ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000636}
637
Tim Peters86821b22001-01-07 21:19:34 +0000638/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000639Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000640
641Under MSVC 6:
642
Tim Peters1c733232001-01-08 04:02:07 +0000643+ MS threadsafe getc is very slow (multiple layers of function calls before+
644 after each character, to lock+unlock the stream).
645+ The stream-locking functions are MS-internal -- can't access them from user
646 code.
647+ There's nothing Tim could find in the MS C or platform SDK libraries that
648 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000649+ MS fgets locks/unlocks only once per line; it's the only hook we have.
650
651So we use fgets for speed(!), despite that it's painful.
652
653MS realloc is also slow.
654
Tim Petersf29b64d2001-01-15 06:33:19 +0000655Reports from other platforms on this method vs getc_unlocked (which MS doesn't
656have):
657 Linux a wash
658 Solaris a wash
659 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000660
Tim Petersf29b64d2001-01-15 06:33:19 +0000661CAUTION: The C std isn't clear about this: in those cases where fgets
662writes something into the buffer, can it write into any position beyond the
663required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
664known on which it does; and it would be a strange way to code fgets. Still,
665getline_via_fgets may not work correctly if it does. The std test
666test_bufio.py should fail if platform fgets() routinely writes beyond the
667trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000668**************************************************************************/
669
Tim Petersf29b64d2001-01-15 06:33:19 +0000670/* Use this routine if told to, or by default on non-get_unlocked()
671 * platforms unless told not to. Yikes! Let's spell that out:
672 * On a platform with getc_unlocked():
673 * By default, use getc_unlocked().
674 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
675 * On a platform without getc_unlocked():
676 * By default, use fgets().
677 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
678 */
679#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
680#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000681#endif
682
Tim Petersf29b64d2001-01-15 06:33:19 +0000683#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
684#undef USE_FGETS_IN_GETLINE
685#endif
686
687#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000688static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000689getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000690{
Tim Peters15b83852001-01-08 00:53:12 +0000691/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000692 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
693 * to fill this much of the buffer with a known value in order to figure out
694 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
695 * than "most" lines, we waste time filling unused buffer slots. 100 is
696 * surely adequate for most peoples' email archives, chewing over source code,
697 * etc -- "regular old text files".
698 * MAXBUFSIZE is the maximum line length that lets us get away with the less
699 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
700 * cautions about boosting that. 300 was chosen because the worst real-life
701 * text-crunching job reported on Python-Dev was a mail-log crawler where over
702 * half the lines were 254 chars.
703 * INCBUFSIZE is the amount by which we grow the buffer, if MAXBUFSIZE isn't
704 * enough. It doesn't much matter what this is set to: we only get here for
705 * absurdly long lines anyway.
Tim Peters15b83852001-01-08 00:53:12 +0000706 */
Tim Peters142297a2001-01-15 10:36:56 +0000707#define INITBUFSIZE 100
708#define MAXBUFSIZE 300
Tim Peters86821b22001-01-07 21:19:34 +0000709#define INCBUFSIZE 1000
Tim Peters142297a2001-01-15 10:36:56 +0000710 char* p; /* temp */
711 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000712 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +0000713 char* pvfree; /* address of next free slot */
714 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +0000715 size_t nfree; /* # of free buffer slots; pvend-pvfree */
716 size_t total_v_size; /* total # of slots in buffer */
Tim Peters86821b22001-01-07 21:19:34 +0000717
Tim Peters15b83852001-01-08 00:53:12 +0000718 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +0000719 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +0000720 */
Tim Peters142297a2001-01-15 10:36:56 +0000721 total_v_size = INITBUFSIZE; /* start small and pray */
722 pvfree = buf;
723 for (;;) {
724 Py_BEGIN_ALLOW_THREADS
725 pvend = buf + total_v_size;
726 nfree = pvend - pvfree;
727 memset(pvfree, '\n', nfree);
728 p = fgets(pvfree, nfree, fp);
729 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +0000730
Tim Peters142297a2001-01-15 10:36:56 +0000731 if (p == NULL) {
732 clearerr(fp);
733 if (PyErr_CheckSignals())
734 return NULL;
735 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +0000736 return v;
737 }
Tim Peters142297a2001-01-15 10:36:56 +0000738 /* fgets read *something* */
739 p = memchr(pvfree, '\n', nfree);
740 if (p != NULL) {
741 /* Did the \n come from fgets or from us?
742 * Since fgets stops at the first \n, and then writes
743 * \0, if it's from fgets a \0 must be next. But if
744 * that's so, it could not have come from us, since
745 * the \n's we filled the buffer with have only more
746 * \n's to the right.
747 */
748 if (p+1 < pvend && *(p+1) == '\0') {
749 /* It's from fgets: we win! In particular,
750 * we haven't done any mallocs yet, and can
751 * build the final result on the first try.
752 */
753 ++p; /* include \n from fgets */
754 }
755 else {
756 /* Must be from us: fgets didn't fill the
757 * buffer and didn't find a newline, so it
758 * must be the last and newline-free line of
759 * the file.
760 */
761 assert(p > pvfree && *(p-1) == '\0');
762 --p; /* don't include \0 from fgets */
763 }
764 v = PyString_FromStringAndSize(buf, p - buf);
765 return v;
766 }
767 /* yuck: fgets overwrote all the newlines, i.e. the entire
768 * buffer. So this line isn't over yet, or maybe it is but
769 * we're exactly at EOF. If we haven't already, try using the
770 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +0000771 */
Tim Peters142297a2001-01-15 10:36:56 +0000772 assert(*(pvend-1) == '\0');
773 if (pvfree == buf) {
774 pvfree = pvend - 1; /* overwrite trailing null */
775 total_v_size = MAXBUFSIZE;
776 }
777 else
778 break;
Tim Peters86821b22001-01-07 21:19:34 +0000779 }
Tim Peters142297a2001-01-15 10:36:56 +0000780
781 /* The stack buffer isn't big enough; malloc a string object and read
782 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +0000783 */
Tim Peters142297a2001-01-15 10:36:56 +0000784 total_v_size = MAXBUFSIZE + INCBUFSIZE;
Tim Peters1c733232001-01-08 04:02:07 +0000785 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +0000786 if (v == NULL)
787 return v;
788 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +0000789 memcpy(BUF(v), buf, MAXBUFSIZE-1);
790 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +0000791
792 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +0000793 * after setting p one beyond the end of the line. The code here is
794 * very much like the code above, except reads into v's buffer; see
795 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +0000796 */
797 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +0000798 Py_BEGIN_ALLOW_THREADS
799 pvend = BUF(v) + total_v_size;
800 nfree = pvend - pvfree;
801 memset(pvfree, '\n', nfree);
802 p = fgets(pvfree, nfree, fp);
803 Py_END_ALLOW_THREADS
804
805 if (p == NULL) {
806 clearerr(fp);
807 if (PyErr_CheckSignals()) {
808 Py_DECREF(v);
809 return NULL;
810 }
811 p = pvfree;
812 break;
813 }
Tim Peters86821b22001-01-07 21:19:34 +0000814 p = memchr(pvfree, '\n', nfree);
815 if (p != NULL) {
816 if (p+1 < pvend && *(p+1) == '\0') {
817 /* \n came from fgets */
818 ++p;
819 break;
820 }
821 /* \n came from us; last line of file, no newline */
822 assert(p > pvfree && *(p-1) == '\0');
823 --p;
824 break;
825 }
826 /* expand buffer and try again */
827 assert(*(pvend-1) == '\0');
828 total_v_size += INCBUFSIZE;
829 if (total_v_size > INT_MAX) {
830 PyErr_SetString(PyExc_OverflowError,
831 "line is longer than a Python string can hold");
832 Py_DECREF(v);
833 return NULL;
834 }
835 if (_PyString_Resize(&v, (int)total_v_size) < 0)
836 return NULL;
837 /* overwrite the trailing null byte */
838 pvfree = BUF(v) + (total_v_size - INCBUFSIZE - 1);
839 }
840 if (BUF(v) + total_v_size != p)
841 _PyString_Resize(&v, p - BUF(v));
842 return v;
843#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +0000844#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +0000845#undef INCBUFSIZE
846}
Tim Petersf29b64d2001-01-15 06:33:19 +0000847#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000848
Guido van Rossum0bd24411991-04-04 15:21:57 +0000849/* Internal routine to get a line.
850 Size argument interpretation:
851 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +0000852 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +0000853*/
854
Guido van Rossum1187aa42001-01-05 14:43:05 +0000855#ifdef HAVE_GETC_UNLOCKED
856#define GETC(f) getc_unlocked(f)
857#define FLOCKFILE(f) flockfile(f)
858#define FUNLOCKFILE(f) funlockfile(f)
859#else
860#define GETC(f) getc(f)
861#define FLOCKFILE(f)
862#define FUNLOCKFILE(f)
863#endif
864
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000865static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000866get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000867{
Guido van Rossum1187aa42001-01-05 14:43:05 +0000868 FILE *fp = f->f_fp;
869 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +0000870 char *buf, *end;
Trent Mickf29f47b2000-08-11 19:02:59 +0000871 size_t n1, n2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000872 PyObject *v;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000873
Tim Petersf29b64d2001-01-15 06:33:19 +0000874#ifdef USE_FGETS_IN_GETLINE
Guido van Rossum86282062001-01-08 01:26:47 +0000875 if (n <= 0)
Tim Petersf29b64d2001-01-15 06:33:19 +0000876 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +0000877#endif
Guido van Rossum0bd24411991-04-04 15:21:57 +0000878 n2 = n > 0 ? n : 100;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000879 v = PyString_FromStringAndSize((char *)NULL, n2);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000880 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000881 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000882 buf = BUF(v);
883 end = buf + n2;
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000884
Guido van Rossumce5ba841991-03-06 13:06:18 +0000885 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +0000886 Py_BEGIN_ALLOW_THREADS
887 FLOCKFILE(fp);
888 while ((c = GETC(fp)) != EOF &&
889 (*buf++ = c) != '\n' &&
890 buf != end)
891 ;
892 FUNLOCKFILE(fp);
893 Py_END_ALLOW_THREADS
894 if (c == '\n')
895 break;
896 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +0000897 if (ferror(fp)) {
898 PyErr_SetFromErrno(PyExc_IOError);
899 clearerr(fp);
900 Py_DECREF(v);
901 return NULL;
902 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +0000903 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000904 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000905 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +0000906 return NULL;
907 }
Guido van Rossumce5ba841991-03-06 13:06:18 +0000908 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000909 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000910 /* Must be because buf == end */
911 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000912 break;
Guido van Rossum1187aa42001-01-05 14:43:05 +0000913 n1 = n2;
914 n2 += 1000;
915 if (n2 > INT_MAX) {
916 PyErr_SetString(PyExc_OverflowError,
917 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +0000918 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +0000919 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000920 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000921 if (_PyString_Resize(&v, n2) < 0)
922 return NULL;
923 buf = BUF(v) + n1;
924 end = BUF(v) + n2;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000925 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000926
Guido van Rossumce5ba841991-03-06 13:06:18 +0000927 n1 = buf - BUF(v);
928 if (n1 != n2)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000929 _PyString_Resize(&v, n1);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000930 return v;
931}
932
Guido van Rossum0bd24411991-04-04 15:21:57 +0000933/* External C interface */
934
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000935PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000936PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000937{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000938 PyObject *result;
939
Guido van Rossum3165fe61992-09-25 21:59:05 +0000940 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000941 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +0000942 return NULL;
943 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000944
945 if (PyFile_Check(f)) {
946 if (((PyFileObject*)f)->f_fp == NULL)
947 return err_closed();
948 result = get_line((PyFileObject *)f, n);
949 }
950 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000951 PyObject *reader;
952 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000953
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000954 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +0000955 if (reader == NULL)
956 return NULL;
957 if (n <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000958 args = Py_BuildValue("()");
Guido van Rossum3165fe61992-09-25 21:59:05 +0000959 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000960 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000961 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000962 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000963 return NULL;
964 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000965 result = PyEval_CallObject(reader, args);
966 Py_DECREF(reader);
967 Py_DECREF(args);
968 if (result != NULL && !PyString_Check(result)) {
969 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000970 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000971 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +0000972 "object.readline() returned non-string");
973 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000974 }
975
976 if (n < 0 && result != NULL && PyString_Check(result)) {
977 char *s = PyString_AS_STRING(result);
978 int len = PyString_GET_SIZE(result);
979 if (len == 0) {
980 Py_DECREF(result);
981 result = NULL;
982 PyErr_SetString(PyExc_EOFError,
983 "EOF when reading a line");
984 }
985 else if (s[len-1] == '\n') {
986 if (result->ob_refcnt == 1)
987 _PyString_Resize(&result, len-1);
988 else {
989 PyObject *v;
990 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000991 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000992 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +0000993 }
994 }
Guido van Rossum3165fe61992-09-25 21:59:05 +0000995 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000996 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000997}
998
999/* Python method */
1000
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001001static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001002file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001003{
Guido van Rossum789a1611997-05-10 22:33:55 +00001004 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001005
Guido van Rossumd7297e61992-07-06 14:19:26 +00001006 if (f->f_fp == NULL)
1007 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001008 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001009 return NULL;
1010 if (n == 0)
1011 return PyString_FromString("");
1012 if (n < 0)
1013 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001014 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001015}
1016
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001017static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001018file_xreadlines(PyFileObject *f)
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001019{
1020 static PyObject* xreadlines_function = NULL;
Tim Petersf29b64d2001-01-15 06:33:19 +00001021
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001022 if (!xreadlines_function) {
1023 PyObject *xreadlines_module =
1024 PyImport_ImportModule("xreadlines");
1025 if(!xreadlines_module)
1026 return NULL;
1027
1028 xreadlines_function = PyObject_GetAttrString(xreadlines_module,
1029 "xreadlines");
1030 Py_DECREF(xreadlines_module);
1031 if(!xreadlines_function)
1032 return NULL;
1033 }
1034 return PyObject_CallFunction(xreadlines_function, "(O)", f);
1035}
1036
1037static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001038file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001039{
Guido van Rossum789a1611997-05-10 22:33:55 +00001040 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001041 PyObject *list;
1042 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001043 char small_buffer[SMALLCHUNK];
1044 char *buffer = small_buffer;
1045 size_t buffersize = SMALLCHUNK;
1046 PyObject *big_buffer = NULL;
1047 size_t nfilled = 0;
1048 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001049 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001050 char *p, *q, *end;
1051 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001052 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001053
Guido van Rossumd7297e61992-07-06 14:19:26 +00001054 if (f->f_fp == NULL)
1055 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001056 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001057 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001058 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001059 return NULL;
1060 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001061 if (shortread)
1062 nread = 0;
1063 else {
1064 Py_BEGIN_ALLOW_THREADS
1065 errno = 0;
1066 nread = fread(buffer+nfilled, 1,
1067 buffersize-nfilled, f->f_fp);
1068 Py_END_ALLOW_THREADS
1069 shortread = (nread < buffersize-nfilled);
1070 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001071 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001072 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001073 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001074 break;
1075 PyErr_SetFromErrno(PyExc_IOError);
1076 clearerr(f->f_fp);
1077 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001078 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001079 list = NULL;
1080 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001081 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001082 totalread += nread;
Guido van Rossum6263d541997-05-10 22:07:25 +00001083 p = memchr(buffer+nfilled, '\n', nread);
1084 if (p == NULL) {
1085 /* Need a larger buffer to fit this line */
1086 nfilled += nread;
1087 buffersize *= 2;
Trent Mickf29f47b2000-08-11 19:02:59 +00001088 if (buffersize > INT_MAX) {
1089 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001090 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001091 goto error;
1092 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001093 if (big_buffer == NULL) {
1094 /* Create the big buffer */
1095 big_buffer = PyString_FromStringAndSize(
1096 NULL, buffersize);
1097 if (big_buffer == NULL)
1098 goto error;
1099 buffer = PyString_AS_STRING(big_buffer);
1100 memcpy(buffer, small_buffer, nfilled);
1101 }
1102 else {
1103 /* Grow the big buffer */
1104 _PyString_Resize(&big_buffer, buffersize);
1105 buffer = PyString_AS_STRING(big_buffer);
1106 }
1107 continue;
1108 }
1109 end = buffer+nfilled+nread;
1110 q = buffer;
1111 do {
1112 /* Process complete lines */
1113 p++;
1114 line = PyString_FromStringAndSize(q, p-q);
1115 if (line == NULL)
1116 goto error;
1117 err = PyList_Append(list, line);
1118 Py_DECREF(line);
1119 if (err != 0)
1120 goto error;
1121 q = p;
1122 p = memchr(q, '\n', end-q);
1123 } while (p != NULL);
1124 /* Move the remaining incomplete line to the start */
1125 nfilled = end-q;
1126 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001127 if (sizehint > 0)
1128 if (totalread >= (size_t)sizehint)
1129 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001130 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001131 if (nfilled != 0) {
1132 /* Partial last line */
1133 line = PyString_FromStringAndSize(buffer, nfilled);
1134 if (line == NULL)
1135 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001136 if (sizehint > 0) {
1137 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001138 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001139 if (rest == NULL) {
1140 Py_DECREF(line);
1141 goto error;
1142 }
1143 PyString_Concat(&line, rest);
1144 Py_DECREF(rest);
1145 if (line == NULL)
1146 goto error;
1147 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001148 err = PyList_Append(list, line);
1149 Py_DECREF(line);
1150 if (err != 0)
1151 goto error;
1152 }
1153 cleanup:
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001154 if (big_buffer) {
Guido van Rossum6263d541997-05-10 22:07:25 +00001155 Py_DECREF(big_buffer);
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001156 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001157 return list;
1158}
1159
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001160static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001161file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001162{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001163 char *s;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001164 int n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001165 if (f->f_fp == NULL)
1166 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001167 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001168 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001169 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001170 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001171 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001172 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001173 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001174 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001175 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001176 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001177 return NULL;
1178 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001179 Py_INCREF(Py_None);
1180 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001181}
1182
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001183static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001184file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001185{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001186#define CHUNKSIZE 1000
1187 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001188 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001189 PyObject *result;
1190 int i, j, index, len, nwritten, islist;
1191
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001192 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001193 if (f->f_fp == NULL)
1194 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001195
1196 result = NULL;
1197 list = NULL;
1198 islist = PyList_Check(seq);
1199 if (islist)
1200 it = NULL;
1201 else {
1202 it = PyObject_GetIter(seq);
1203 if (it == NULL) {
1204 PyErr_SetString(PyExc_TypeError,
1205 "writelines() requires an iterable argument");
1206 return NULL;
1207 }
1208 /* From here on, fail by going to error, to reclaim "it". */
1209 list = PyList_New(CHUNKSIZE);
1210 if (list == NULL)
1211 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001212 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001213
1214 /* Strategy: slurp CHUNKSIZE lines into a private list,
1215 checking that they are all strings, then write that list
1216 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001217 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001218 if (islist) {
1219 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001220 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001221 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001222 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001223 j = PyList_GET_SIZE(list);
1224 }
1225 else {
1226 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001227 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001228 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001229 if (PyErr_Occurred())
1230 goto error;
1231 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001232 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001233 PyList_SetItem(list, j, line);
1234 }
1235 }
1236 if (j == 0)
1237 break;
1238
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001239 /* Check that all entries are indeed strings. If not,
1240 apply the same rules as for file.write() and
1241 convert the results to strings. This is slow, but
1242 seems to be the only way since all conversion APIs
1243 could potentially execute Python code. */
1244 for (i = 0; i < j; i++) {
1245 PyObject *v = PyList_GET_ITEM(list, i);
1246 if (!PyString_Check(v)) {
1247 const char *buffer;
1248 int len;
Tim Peters86821b22001-01-07 21:19:34 +00001249 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001250 PyObject_AsReadBuffer(v,
1251 (const void**)&buffer,
1252 &len)) ||
1253 PyObject_AsCharBuffer(v,
1254 &buffer,
1255 &len))) {
1256 PyErr_SetString(PyExc_TypeError,
Fred Drake661ea262000-10-24 19:57:45 +00001257 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001258 goto error;
1259 }
1260 line = PyString_FromStringAndSize(buffer,
1261 len);
1262 if (line == NULL)
1263 goto error;
1264 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001265 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001266 }
1267 }
1268
1269 /* Since we are releasing the global lock, the
1270 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001271 Py_BEGIN_ALLOW_THREADS
1272 f->f_softspace = 0;
1273 errno = 0;
1274 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001275 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001276 len = PyString_GET_SIZE(line);
1277 nwritten = fwrite(PyString_AS_STRING(line),
1278 1, len, f->f_fp);
1279 if (nwritten != len) {
1280 Py_BLOCK_THREADS
1281 PyErr_SetFromErrno(PyExc_IOError);
1282 clearerr(f->f_fp);
1283 goto error;
1284 }
1285 }
1286 Py_END_ALLOW_THREADS
1287
1288 if (j < CHUNKSIZE)
1289 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001290 }
1291
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001292 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001293 result = Py_None;
1294 error:
1295 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001296 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001297 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001298#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001299}
1300
Tim Petersefc3a3a2001-09-20 07:55:22 +00001301static char readline_doc[] =
1302"readline([size]) -> next line from the file, as a string.\n"
1303"\n"
1304"Retain newline. A non-negative size argument limits the maximum\n"
1305"number of bytes to return (an incomplete line may be returned then).\n"
1306"Return an empty string at EOF.";
1307
1308static char read_doc[] =
1309"read([size]) -> read at most size bytes, returned as a string.\n"
1310"\n"
1311"If the size argument is negative or omitted, read until EOF is reached.";
1312
1313static char write_doc[] =
1314"write(str) -> None. Write string str to file.\n"
1315"\n"
1316"Note that due to buffering, flush() or close() may be needed before\n"
1317"the file on disk reflects the data written.";
1318
1319static char fileno_doc[] =
1320"fileno() -> integer \"file descriptor\".\n"
1321"\n"
1322"This is needed for lower-level file interfaces, such os.read().";
1323
1324static char seek_doc[] =
1325"seek(offset[, whence]) -> None. Move to new file position.\n"
1326"\n"
1327"Argument offset is a byte count. Optional argument whence defaults to\n"
1328"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1329"(move relative to current position, positive or negative), and 2 (move\n"
1330"relative to end of file, usually negative, although many platforms allow\n"
1331"seeking beyond the end of a file).\n"
1332"\n"
1333"Note that not all file objects are seekable.";
1334
Guido van Rossumd7047b31995-01-02 19:07:15 +00001335#ifdef HAVE_FTRUNCATE
Tim Petersefc3a3a2001-09-20 07:55:22 +00001336static char truncate_doc[] =
1337"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1338"\n"
1339"Size defaults to the current file position, as returned by tell().";
Guido van Rossumd7047b31995-01-02 19:07:15 +00001340#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001341
1342static char tell_doc[] =
1343"tell() -> current file position, an integer (may be a long integer).";
1344
1345static char readinto_doc[] =
1346"readinto() -> Undocumented. Don't use this; it may go away.";
1347
1348static char readlines_doc[] =
1349"readlines([size]) -> list of strings, each a line from the file.\n"
1350"\n"
1351"Call readline() repeatedly and return a list of the lines so read.\n"
1352"The optional size argument, if given, is an approximate bound on the\n"
1353"total number of bytes in the lines returned.";
1354
1355static char xreadlines_doc[] =
1356"xreadlines() -> next line from the file, as a string.\n"
1357"\n"
1358"Equivalent to xreadlines.xreadlines(file). This is like readline(), but\n"
1359"often quicker, due to reading ahead internally.";
1360
1361static char writelines_doc[] =
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001362"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001363"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001364"Note that newlines are not added. The sequence can be any iterable object\n"
1365"producing strings. This is equivalent to calling write() for each string.";
Tim Petersefc3a3a2001-09-20 07:55:22 +00001366
1367static char flush_doc[] =
1368"flush() -> None. Flush the internal I/O buffer.";
1369
1370static char close_doc[] =
1371"close() -> None or (perhaps) an integer. Close the file.\n"
1372"\n"
1373"Sets data attribute .closed to true. A closed file cannot be used for\n"
1374"further I/O operations. close() may be called more than once without\n"
1375"error. Some kinds of file objects (for example, opened by popen())\n"
1376"may return an exit status upon closing.";
1377
1378static char isatty_doc[] =
1379"isatty() -> true or false. True if the file is connected to a tty device.";
1380
1381static PyMethodDef file_methods[] = {
1382 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1383 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001384 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001385 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1386 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
1387#ifdef HAVE_FTRUNCATE
1388 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
1389#endif
1390 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1391 {"readinto", (PyCFunction)file_readinto, METH_OLDARGS, readinto_doc},
1392 {"readlines", (PyCFunction)file_readlines, METH_VARARGS, readlines_doc},
1393 {"xreadlines", (PyCFunction)file_xreadlines, METH_NOARGS, xreadlines_doc},
1394 {"writelines", (PyCFunction)file_writelines, METH_O, writelines_doc},
1395 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1396 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1397 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001398 {NULL, NULL} /* sentinel */
1399};
1400
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001401#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001402
Guido van Rossum6f799372001-09-20 20:46:19 +00001403static PyMemberDef file_memberlist[] = {
1404 {"softspace", T_INT, OFF(f_softspace), 0,
1405 "flag indicating that a space needs to be printed; used by print"},
1406 {"mode", T_OBJECT, OFF(f_mode), RO,
1407 "file mode ('r', 'w', 'a', possibly with 'b' or '+' added)"},
1408 {"name", T_OBJECT, OFF(f_name), RO,
1409 "file name"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001410 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001411 {NULL} /* Sentinel */
1412};
1413
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001414static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001415get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001416{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001417 return PyInt_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001418}
1419
Guido van Rossum32d34c82001-09-20 21:45:26 +00001420static PyGetSetDef file_getsetlist[] = {
1421 {"closed", (getter)get_closed, NULL, "flag set if the file is closed"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001422 {0},
1423};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001424
Guido van Rossum65967252001-04-21 13:20:18 +00001425static PyObject *
Guido van Rossum5b021842001-05-22 16:48:37 +00001426file_getiter(PyObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001427{
Guido van Rossum5b021842001-05-22 16:48:37 +00001428 return PyObject_CallMethod(f, "xreadlines", "");
Guido van Rossum65967252001-04-21 13:20:18 +00001429}
1430
Tim Peters59c9a642001-09-13 05:38:56 +00001431static PyObject *
1432file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1433{
Tim Peters44410012001-09-14 03:26:08 +00001434 PyObject *self;
1435 static PyObject *not_yet_string;
1436
1437 assert(type != NULL && type->tp_alloc != NULL);
1438
1439 if (not_yet_string == NULL) {
1440 not_yet_string = PyString_FromString("<uninitialized file>");
1441 if (not_yet_string == NULL)
1442 return NULL;
1443 }
1444
1445 self = type->tp_alloc(type, 0);
1446 if (self != NULL) {
1447 /* Always fill in the name and mode, so that nobody else
1448 needs to special-case NULLs there. */
1449 Py_INCREF(not_yet_string);
1450 ((PyFileObject *)self)->f_name = not_yet_string;
1451 Py_INCREF(not_yet_string);
1452 ((PyFileObject *)self)->f_mode = not_yet_string;
1453 }
1454 return self;
1455}
1456
1457static int
1458file_init(PyObject *self, PyObject *args, PyObject *kwds)
1459{
1460 PyFileObject *foself = (PyFileObject *)self;
1461 int ret = 0;
Tim Peters59c9a642001-09-13 05:38:56 +00001462 static char *kwlist[] = {"name", "mode", "buffering", 0};
1463 char *name = NULL;
1464 char *mode = "r";
1465 int bufsize = -1;
Tim Peters44410012001-09-14 03:26:08 +00001466
1467 assert(PyFile_Check(self));
1468 if (foself->f_fp != NULL) {
1469 /* Have to close the existing file first. */
1470 PyObject *closeresult = file_close(foself);
1471 if (closeresult == NULL)
1472 return -1;
1473 Py_DECREF(closeresult);
1474 }
Tim Peters59c9a642001-09-13 05:38:56 +00001475
1476 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
1477 Py_FileSystemDefaultEncoding, &name,
1478 &mode, &bufsize))
Tim Peters44410012001-09-14 03:26:08 +00001479 return -1;
1480 if (fill_file_fields(foself, NULL, name, mode, fclose) == NULL)
1481 goto Error;
1482 if (open_the_file(foself, name, mode) == NULL)
1483 goto Error;
1484 PyFile_SetBufSize(self, bufsize);
1485 goto Done;
1486
1487Error:
1488 ret = -1;
1489 /* fall through */
1490Done:
Tim Peters59c9a642001-09-13 05:38:56 +00001491 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00001492 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00001493}
1494
Tim Peters59c9a642001-09-13 05:38:56 +00001495static char file_doc[] =
1496"file(name[, mode[, buffering]]) -> file object\n"
1497"\n"
1498"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
1499"writing or appending. The file will be created if it doesn't exist\n"
1500"when opened for writing or appending; it will be truncated when\n"
1501"opened for writing. Add a 'b' to the mode for binary files.\n"
1502"Add a '+' to the mode to allow simultaneous reading and writing.\n"
1503"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00001504"buffered, and larger numbers specify the buffer size.\n"
1505"Note: open() is an alias for file().\n";
Tim Peters59c9a642001-09-13 05:38:56 +00001506
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001507PyTypeObject PyFile_Type = {
1508 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001509 0,
1510 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001511 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001512 0,
Guido van Rossum65967252001-04-21 13:20:18 +00001513 (destructor)file_dealloc, /* tp_dealloc */
1514 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001515 0, /* tp_getattr */
1516 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00001517 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001518 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00001519 0, /* tp_as_number */
1520 0, /* tp_as_sequence */
1521 0, /* tp_as_mapping */
1522 0, /* tp_hash */
1523 0, /* tp_call */
1524 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001525 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum65967252001-04-21 13:20:18 +00001526 0, /* tp_setattro */
1527 0, /* tp_as_buffer */
Guido van Rossum9475a232001-10-05 20:51:39 +00001528 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00001529 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001530 0, /* tp_traverse */
1531 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00001532 0, /* tp_richcompare */
1533 0, /* tp_weaklistoffset */
Guido van Rossum5b021842001-05-22 16:48:37 +00001534 file_getiter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +00001535 0, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001536 file_methods, /* tp_methods */
1537 file_memberlist, /* tp_members */
1538 file_getsetlist, /* tp_getset */
1539 0, /* tp_base */
1540 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00001541 0, /* tp_descr_get */
1542 0, /* tp_descr_set */
1543 0, /* tp_dictoffset */
Tim Peters44410012001-09-14 03:26:08 +00001544 (initproc)file_init, /* tp_init */
1545 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00001546 file_new, /* tp_new */
Guido van Rossum9475a232001-10-05 20:51:39 +00001547 _PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001548};
Guido van Rossumeb183da1991-04-04 10:44:06 +00001549
1550/* Interface for the 'soft space' between print items. */
1551
1552int
Fred Drakefd99de62000-07-09 05:02:18 +00001553PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00001554{
1555 int oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001556 if (f == NULL) {
1557 /* Do nothing */
1558 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001559 else if (PyFile_Check(f)) {
1560 oldflag = ((PyFileObject *)f)->f_softspace;
1561 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001562 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001563 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001564 PyObject *v;
1565 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001566 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001567 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001568 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001569 if (PyInt_Check(v))
1570 oldflag = PyInt_AsLong(v);
1571 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001572 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001573 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001574 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001575 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001576 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001577 if (PyObject_SetAttrString(f, "softspace", v) != 0)
1578 PyErr_Clear();
1579 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001580 }
1581 }
Guido van Rossumeb183da1991-04-04 10:44:06 +00001582 return oldflag;
1583}
Guido van Rossum3165fe61992-09-25 21:59:05 +00001584
1585/* Interfaces to write objects/strings to file-like objects */
1586
1587int
Fred Drakefd99de62000-07-09 05:02:18 +00001588PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001589{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001590 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001591 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001592 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001593 return -1;
1594 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001595 else if (PyFile_Check(f)) {
1596 FILE *fp = PyFile_AsFile(f);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001597 if (fp == NULL) {
1598 err_closed();
1599 return -1;
1600 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001601 return PyObject_Print(v, fp, flags);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001602 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001603 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001604 if (writer == NULL)
1605 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00001606 if (flags & Py_PRINT_RAW) {
1607 if (PyUnicode_Check(v)) {
1608 value = v;
1609 Py_INCREF(value);
1610 } else
1611 value = PyObject_Str(v);
1612 }
1613 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001614 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00001615 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001616 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00001617 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001618 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001619 args = Py_BuildValue("(O)", value);
Guido van Rossume9eec541997-05-22 14:02:25 +00001620 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001621 Py_DECREF(value);
1622 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00001623 return -1;
1624 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001625 result = PyEval_CallObject(writer, args);
1626 Py_DECREF(args);
1627 Py_DECREF(value);
1628 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001629 if (result == NULL)
1630 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001631 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001632 return 0;
1633}
1634
Guido van Rossum27a60b11997-05-22 22:25:11 +00001635int
Fred Drakefd99de62000-07-09 05:02:18 +00001636PyFile_WriteString(char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001637{
1638 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00001639 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00001640 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00001641 PyErr_SetString(PyExc_SystemError,
1642 "null file for PyFile_WriteString");
1643 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001644 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001645 else if (PyFile_Check(f)) {
1646 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001647 if (fp == NULL) {
1648 err_closed();
1649 return -1;
1650 }
1651 fputs(s, fp);
1652 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001653 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001654 else if (!PyErr_Occurred()) {
1655 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001656 int err;
1657 if (v == NULL)
1658 return -1;
1659 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
1660 Py_DECREF(v);
1661 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001662 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00001663 else
1664 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001665}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001666
1667/* Try to get a file-descriptor from a Python object. If the object
1668 is an integer or long integer, its value is returned. If not, the
1669 object's fileno() method is called if it exists; the method must return
1670 an integer or long integer, which is returned as the file descriptor value.
1671 -1 is returned on failure.
1672*/
1673
1674int PyObject_AsFileDescriptor(PyObject *o)
1675{
1676 int fd;
1677 PyObject *meth;
1678
1679 if (PyInt_Check(o)) {
1680 fd = PyInt_AsLong(o);
1681 }
1682 else if (PyLong_Check(o)) {
1683 fd = PyLong_AsLong(o);
1684 }
1685 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
1686 {
1687 PyObject *fno = PyEval_CallObject(meth, NULL);
1688 Py_DECREF(meth);
1689 if (fno == NULL)
1690 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00001691
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001692 if (PyInt_Check(fno)) {
1693 fd = PyInt_AsLong(fno);
1694 Py_DECREF(fno);
1695 }
1696 else if (PyLong_Check(fno)) {
1697 fd = PyLong_AsLong(fno);
1698 Py_DECREF(fno);
1699 }
1700 else {
1701 PyErr_SetString(PyExc_TypeError,
1702 "fileno() returned a non-integer");
1703 Py_DECREF(fno);
1704 return -1;
1705 }
1706 }
1707 else {
1708 PyErr_SetString(PyExc_TypeError,
1709 "argument must be an int, or have a fileno() method.");
1710 return -1;
1711 }
1712
1713 if (fd < 0) {
1714 PyErr_Format(PyExc_ValueError,
1715 "file descriptor cannot be a negative integer (%i)",
1716 fd);
1717 return -1;
1718 }
1719 return fd;
1720}