blob: cda5ff25bf22c0e835f2634aea0e3ba10976b0ce [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 */
Jack Jansene08dea191995-04-23 22:12:47 +0000124 if ( errno == 0 ) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000125 PyErr_SetString(PyExc_IOError, "Cannot open file");
126 Py_DECREF(f);
Jack Jansene08dea191995-04-23 22:12:47 +0000127 return NULL;
128 }
129#endif
Barry Warsaw52ddc0e1998-07-23 16:07:02 +0000130 PyErr_SetFromErrnoWithFilename(PyExc_IOError, name);
Tim Peters59c9a642001-09-13 05:38:56 +0000131 f = NULL;
132 }
133 return (PyObject *)f;
134}
135
136PyObject *
137PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
138{
Tim Peters44410012001-09-14 03:26:08 +0000139 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
140 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000141 if (f != NULL) {
142 if (fill_file_fields(f, fp, name, mode, close) == NULL) {
143 Py_DECREF(f);
144 f = NULL;
145 }
146 }
147 return (PyObject *) f;
148}
149
150PyObject *
151PyFile_FromString(char *name, char *mode)
152{
153 extern int fclose(FILE *);
154 PyFileObject *f;
155
156 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
157 if (f != NULL) {
158 if (open_the_file(f, name, mode) == NULL) {
159 Py_DECREF(f);
160 f = NULL;
161 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000162 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000163 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000164}
165
Guido van Rossumb6775db1994-08-01 11:34:53 +0000166void
Fred Drakefd99de62000-07-09 05:02:18 +0000167PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000168{
169 if (bufsize >= 0) {
170#ifdef HAVE_SETVBUF
171 int type;
172 switch (bufsize) {
173 case 0:
174 type = _IONBF;
175 break;
176 case 1:
177 type = _IOLBF;
178 bufsize = BUFSIZ;
179 break;
180 default:
181 type = _IOFBF;
182 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000183 setvbuf(((PyFileObject *)f)->f_fp, (char *)NULL,
184 type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000185#else /* !HAVE_SETVBUF */
186 if (bufsize <= 1)
187 setbuf(((PyFileObject *)f)->f_fp, (char *)NULL);
188#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000189 }
190}
191
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000192static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000193err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000194{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000195 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000196 return NULL;
197}
198
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000199/* Methods */
200
201static void
Fred Drakefd99de62000-07-09 05:02:18 +0000202file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000203{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000204 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000205 Py_BEGIN_ALLOW_THREADS
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000206 (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000207 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000208 }
Tim Peters44410012001-09-14 03:26:08 +0000209 Py_XDECREF(f->f_name);
210 Py_XDECREF(f->f_mode);
Guido van Rossum9475a232001-10-05 20:51:39 +0000211 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000212}
213
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000214static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000215file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000216{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000217 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
218 f->f_fp == NULL ? "closed" : "open",
219 PyString_AsString(f->f_name),
220 PyString_AsString(f->f_mode),
221 f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000222}
223
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000224static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000225file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000226{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000227 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000228 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000229 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000230 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000231 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000232 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000233 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000234 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000235 f->f_fp = NULL;
236 }
Guido van Rossumfebd5511992-03-04 16:39:24 +0000237 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000238 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000239 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000240 return PyInt_FromLong((long)sts);
241 Py_INCREF(Py_None);
242 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000243}
244
Trent Mickf29f47b2000-08-11 19:02:59 +0000245
Guido van Rossumb8552162001-09-05 14:58:11 +0000246/* Our very own off_t-like type, 64-bit if possible */
247#if !defined(HAVE_LARGEFILE_SUPPORT)
248typedef off_t Py_off_t;
249#elif SIZEOF_OFF_T >= 8
250typedef off_t Py_off_t;
251#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000252typedef fpos_t Py_off_t;
253#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000254#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000255#endif
256
257
Trent Mickf29f47b2000-08-11 19:02:59 +0000258/* a portable fseek() function
259 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000260static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000261_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000262{
Guido van Rossumb8552162001-09-05 14:58:11 +0000263#if !defined(HAVE_LARGEFILE_SUPPORT)
264 return fseek(fp, offset, whence);
265#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000266 return fseeko(fp, offset, whence);
267#elif defined(HAVE_FSEEK64)
268 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000269#elif defined(__BEOS__)
270 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000271#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000272 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
273 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000274 fpos_t pos;
275 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000276 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000277#ifdef MS_WINDOWS
278 fflush(fp);
279 if (_lseeki64(fileno(fp), 0, 2) == -1)
280 return -1;
281#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000282 if (fseek(fp, 0, SEEK_END) != 0)
283 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000284#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000285 /* fall through */
286 case SEEK_CUR:
287 if (fgetpos(fp, &pos) != 0)
288 return -1;
289 offset += pos;
290 break;
291 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000292 }
293 return fsetpos(fp, &offset);
294#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000295#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000296#endif
297}
298
299
300/* a portable ftell() function
301 Return -1 on failure with errno set appropriately, current file
302 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000303static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000304_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000305{
Guido van Rossumb8552162001-09-05 14:58:11 +0000306#if !defined(HAVE_LARGEFILE_SUPPORT)
307 return ftell(fp);
308#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
309 return ftello(fp);
310#elif defined(HAVE_FTELL64)
311 return ftell64(fp);
312#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000313 fpos_t pos;
314 if (fgetpos(fp, &pos) != 0)
315 return -1;
316 return pos;
317#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000318#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000319#endif
320}
321
322
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000323static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000324file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000325{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000326 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000327 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000328 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000329 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000330
Guido van Rossumd7297e61992-07-06 14:19:26 +0000331 if (f->f_fp == NULL)
332 return err_closed();
333 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000334 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000335 return NULL;
336#if !defined(HAVE_LARGEFILE_SUPPORT)
337 offset = PyInt_AsLong(offobj);
338#else
339 offset = PyLong_Check(offobj) ?
340 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
341#endif
342 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000343 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000344
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000345 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000346 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000347 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000348 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000349
Guido van Rossumff4949e1992-08-05 19:58:53 +0000350 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000351 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000352 clearerr(f->f_fp);
353 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000354 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000355 Py_INCREF(Py_None);
356 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000357}
358
Trent Mickf29f47b2000-08-11 19:02:59 +0000359
Guido van Rossumd7047b31995-01-02 19:07:15 +0000360#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000361static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000362file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000363{
Guido van Rossumd7047b31995-01-02 19:07:15 +0000364 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000365 Py_off_t newsize;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000366 PyObject *newsizeobj;
Tim Peters86821b22001-01-07 21:19:34 +0000367
Guido van Rossumd7047b31995-01-02 19:07:15 +0000368 if (f->f_fp == NULL)
369 return err_closed();
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000370 newsizeobj = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +0000371 if (!PyArg_ParseTuple(args, "|O:truncate", &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000372 return NULL;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000373 if (newsizeobj != NULL) {
374#if !defined(HAVE_LARGEFILE_SUPPORT)
375 newsize = PyInt_AsLong(newsizeobj);
376#else
377 newsize = PyLong_Check(newsizeobj) ?
378 PyLong_AsLongLong(newsizeobj) :
379 PyInt_AsLong(newsizeobj);
380#endif
381 if (PyErr_Occurred())
382 return NULL;
383 } else {
384 /* Default to current position*/
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000385 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000386 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000387 newsize = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000388 Py_END_ALLOW_THREADS
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000389 if (newsize == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000390 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumd7047b31995-01-02 19:07:15 +0000391 clearerr(f->f_fp);
392 return NULL;
393 }
394 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000395 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000396 errno = 0;
397 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000398 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000399 if (ret != 0) goto onioerror;
400
401#ifdef MS_WIN32
402 /* can use _chsize; if, however, the newsize overflows 32-bits then
403 _chsize is *not* adequate; in this case, an OverflowError is raised */
404 if (newsize > LONG_MAX) {
405 PyErr_SetString(PyExc_OverflowError,
406 "the new size is too long for _chsize (it is limited to 32-bit values)");
Guido van Rossumd7047b31995-01-02 19:07:15 +0000407 return NULL;
Trent Mickf29f47b2000-08-11 19:02:59 +0000408 } else {
409 Py_BEGIN_ALLOW_THREADS
410 errno = 0;
Tim Peters6e13a562001-09-06 00:32:15 +0000411 ret = _chsize(fileno(f->f_fp), (long)newsize);
Trent Mickf29f47b2000-08-11 19:02:59 +0000412 Py_END_ALLOW_THREADS
413 if (ret != 0) goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000414 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000415#else
416 Py_BEGIN_ALLOW_THREADS
417 errno = 0;
418 ret = ftruncate(fileno(f->f_fp), newsize);
419 Py_END_ALLOW_THREADS
420 if (ret != 0) goto onioerror;
421#endif /* !MS_WIN32 */
Tim Peters86821b22001-01-07 21:19:34 +0000422
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000423 Py_INCREF(Py_None);
424 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000425
426onioerror:
427 PyErr_SetFromErrno(PyExc_IOError);
428 clearerr(f->f_fp);
429 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000430}
431#endif /* HAVE_FTRUNCATE */
432
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000433static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000434file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000435{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000436 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000437
Guido van Rossumd7297e61992-07-06 14:19:26 +0000438 if (f->f_fp == NULL)
439 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000440 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000441 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000442 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000443 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000444 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000445 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000446 clearerr(f->f_fp);
447 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000448 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000449#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000450 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000451#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000452 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000453#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000454}
455
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000456static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000457file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000458{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000459 if (f->f_fp == NULL)
460 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000461 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000462}
463
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000464static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000465file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000466{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000467 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000468
Guido van Rossumd7297e61992-07-06 14:19:26 +0000469 if (f->f_fp == NULL)
470 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000471 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000472 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000473 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000474 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000475 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000476 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000477 clearerr(f->f_fp);
478 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000479 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000480 Py_INCREF(Py_None);
481 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000482}
483
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000484static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000485file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000486{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000487 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000488 if (f->f_fp == NULL)
489 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000490 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000491 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000492 Py_END_ALLOW_THREADS
493 return PyInt_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000494}
495
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000496
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000497#if BUFSIZ < 8192
498#define SMALLCHUNK 8192
499#else
500#define SMALLCHUNK BUFSIZ
501#endif
502
Guido van Rossum3c259041999-01-14 19:00:14 +0000503#if SIZEOF_INT < 4
504#define BIGCHUNK (512 * 32)
505#else
506#define BIGCHUNK (512 * 1024)
507#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000508
509static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000510new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000511{
512#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000513 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000514 struct stat st;
515 if (fstat(fileno(f->f_fp), &st) == 0) {
516 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000517 /* The following is not a bug: we really need to call lseek()
518 *and* ftell(). The reason is that some stdio libraries
519 mistakenly flush their buffer when ftell() is called and
520 the lseek() call it makes fails, thereby throwing away
521 data that cannot be recovered in any way. To avoid this,
522 we first test lseek(), and only call ftell() if lseek()
523 works. We can't use the lseek() value either, because we
524 need to take the amount of buffered data into account.
525 (Yet another reason why stdio stinks. :-) */
Jack Jansen2771b5b2001-10-10 22:03:27 +0000526#ifdef USE_GUSI2
527 pos = lseek(fileno(f->f_fp), 1L, SEEK_CUR);
528 pos = lseek(fileno(f->f_fp), -1L, SEEK_CUR);
529#else
Guido van Rossum91aaa921998-05-05 22:21:35 +0000530 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000531#endif
532 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000533 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000534 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000535 if (pos < 0)
536 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000537 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000538 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000539 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000540 }
541#endif
542 if (currentsize > SMALLCHUNK) {
543 /* Keep doubling until we reach BIGCHUNK;
544 then keep adding BIGCHUNK. */
545 if (currentsize <= BIGCHUNK)
546 return currentsize + currentsize;
547 else
548 return currentsize + BIGCHUNK;
549 }
550 return currentsize + SMALLCHUNK;
551}
552
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000553static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000554file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000555{
Guido van Rossum789a1611997-05-10 22:33:55 +0000556 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000557 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000558 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000559
Guido van Rossumd7297e61992-07-06 14:19:26 +0000560 if (f->f_fp == NULL)
561 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +0000562 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000563 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000564 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000565 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000566 else
567 buffersize = bytesrequested;
Trent Mickf29f47b2000-08-11 19:02:59 +0000568 if (buffersize > INT_MAX) {
569 PyErr_SetString(PyExc_OverflowError,
570 "requested number of bytes is more than a Python string can hold");
571 return NULL;
572 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000573 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000574 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000575 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000576 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000577 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000578 Py_BEGIN_ALLOW_THREADS
579 errno = 0;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000580 chunksize = fread(BUF(v) + bytesread, 1,
581 buffersize - bytesread, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000582 Py_END_ALLOW_THREADS
583 if (chunksize == 0) {
584 if (!ferror(f->f_fp))
585 break;
586 PyErr_SetFromErrno(PyExc_IOError);
587 clearerr(f->f_fp);
588 Py_DECREF(v);
589 return NULL;
590 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000591 bytesread += chunksize;
592 if (bytesread < buffersize)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000593 break;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000594 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000595 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000596 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000597 return NULL;
598 }
599 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000600 if (bytesread != buffersize)
601 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000602 return v;
603}
604
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000605static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000606file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000607{
608 char *ptr;
Guido van Rossum00ebd462001-10-23 21:25:24 +0000609 int ntodo;
610 size_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000611
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000612 if (f->f_fp == NULL)
613 return err_closed();
614 if (!PyArg_Parse(args, "w#", &ptr, &ntodo))
615 return NULL;
616 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000617 while (ntodo > 0) {
618 Py_BEGIN_ALLOW_THREADS
619 errno = 0;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000620 nnow = fread(ptr+ndone, 1, ntodo, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000621 Py_END_ALLOW_THREADS
622 if (nnow == 0) {
623 if (!ferror(f->f_fp))
624 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000625 PyErr_SetFromErrno(PyExc_IOError);
626 clearerr(f->f_fp);
627 return NULL;
628 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000629 ndone += nnow;
630 ntodo -= nnow;
631 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000632 return PyInt_FromLong((long)ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000633}
634
Tim Peters86821b22001-01-07 21:19:34 +0000635/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000636Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000637
638Under MSVC 6:
639
Tim Peters1c733232001-01-08 04:02:07 +0000640+ MS threadsafe getc is very slow (multiple layers of function calls before+
641 after each character, to lock+unlock the stream).
642+ The stream-locking functions are MS-internal -- can't access them from user
643 code.
644+ There's nothing Tim could find in the MS C or platform SDK libraries that
645 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000646+ MS fgets locks/unlocks only once per line; it's the only hook we have.
647
648So we use fgets for speed(!), despite that it's painful.
649
650MS realloc is also slow.
651
Tim Petersf29b64d2001-01-15 06:33:19 +0000652Reports from other platforms on this method vs getc_unlocked (which MS doesn't
653have):
654 Linux a wash
655 Solaris a wash
656 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000657
Tim Petersf29b64d2001-01-15 06:33:19 +0000658CAUTION: The C std isn't clear about this: in those cases where fgets
659writes something into the buffer, can it write into any position beyond the
660required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
661known on which it does; and it would be a strange way to code fgets. Still,
662getline_via_fgets may not work correctly if it does. The std test
663test_bufio.py should fail if platform fgets() routinely writes beyond the
664trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000665**************************************************************************/
666
Tim Petersf29b64d2001-01-15 06:33:19 +0000667/* Use this routine if told to, or by default on non-get_unlocked()
668 * platforms unless told not to. Yikes! Let's spell that out:
669 * On a platform with getc_unlocked():
670 * By default, use getc_unlocked().
671 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
672 * On a platform without getc_unlocked():
673 * By default, use fgets().
674 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
675 */
676#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
677#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000678#endif
679
Tim Petersf29b64d2001-01-15 06:33:19 +0000680#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
681#undef USE_FGETS_IN_GETLINE
682#endif
683
684#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000685static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000686getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000687{
Tim Peters15b83852001-01-08 00:53:12 +0000688/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000689 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
690 * to fill this much of the buffer with a known value in order to figure out
691 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
692 * than "most" lines, we waste time filling unused buffer slots. 100 is
693 * surely adequate for most peoples' email archives, chewing over source code,
694 * etc -- "regular old text files".
695 * MAXBUFSIZE is the maximum line length that lets us get away with the less
696 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
697 * cautions about boosting that. 300 was chosen because the worst real-life
698 * text-crunching job reported on Python-Dev was a mail-log crawler where over
699 * half the lines were 254 chars.
700 * INCBUFSIZE is the amount by which we grow the buffer, if MAXBUFSIZE isn't
701 * enough. It doesn't much matter what this is set to: we only get here for
702 * absurdly long lines anyway.
Tim Peters15b83852001-01-08 00:53:12 +0000703 */
Tim Peters142297a2001-01-15 10:36:56 +0000704#define INITBUFSIZE 100
705#define MAXBUFSIZE 300
Tim Peters86821b22001-01-07 21:19:34 +0000706#define INCBUFSIZE 1000
Tim Peters142297a2001-01-15 10:36:56 +0000707 char* p; /* temp */
708 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000709 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +0000710 char* pvfree; /* address of next free slot */
711 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +0000712 size_t nfree; /* # of free buffer slots; pvend-pvfree */
713 size_t total_v_size; /* total # of slots in buffer */
Tim Peters86821b22001-01-07 21:19:34 +0000714
Tim Peters15b83852001-01-08 00:53:12 +0000715 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +0000716 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +0000717 */
Tim Peters142297a2001-01-15 10:36:56 +0000718 total_v_size = INITBUFSIZE; /* start small and pray */
719 pvfree = buf;
720 for (;;) {
721 Py_BEGIN_ALLOW_THREADS
722 pvend = buf + total_v_size;
723 nfree = pvend - pvfree;
724 memset(pvfree, '\n', nfree);
725 p = fgets(pvfree, nfree, fp);
726 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +0000727
Tim Peters142297a2001-01-15 10:36:56 +0000728 if (p == NULL) {
729 clearerr(fp);
730 if (PyErr_CheckSignals())
731 return NULL;
732 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +0000733 return v;
734 }
Tim Peters142297a2001-01-15 10:36:56 +0000735 /* fgets read *something* */
736 p = memchr(pvfree, '\n', nfree);
737 if (p != NULL) {
738 /* Did the \n come from fgets or from us?
739 * Since fgets stops at the first \n, and then writes
740 * \0, if it's from fgets a \0 must be next. But if
741 * that's so, it could not have come from us, since
742 * the \n's we filled the buffer with have only more
743 * \n's to the right.
744 */
745 if (p+1 < pvend && *(p+1) == '\0') {
746 /* It's from fgets: we win! In particular,
747 * we haven't done any mallocs yet, and can
748 * build the final result on the first try.
749 */
750 ++p; /* include \n from fgets */
751 }
752 else {
753 /* Must be from us: fgets didn't fill the
754 * buffer and didn't find a newline, so it
755 * must be the last and newline-free line of
756 * the file.
757 */
758 assert(p > pvfree && *(p-1) == '\0');
759 --p; /* don't include \0 from fgets */
760 }
761 v = PyString_FromStringAndSize(buf, p - buf);
762 return v;
763 }
764 /* yuck: fgets overwrote all the newlines, i.e. the entire
765 * buffer. So this line isn't over yet, or maybe it is but
766 * we're exactly at EOF. If we haven't already, try using the
767 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +0000768 */
Tim Peters142297a2001-01-15 10:36:56 +0000769 assert(*(pvend-1) == '\0');
770 if (pvfree == buf) {
771 pvfree = pvend - 1; /* overwrite trailing null */
772 total_v_size = MAXBUFSIZE;
773 }
774 else
775 break;
Tim Peters86821b22001-01-07 21:19:34 +0000776 }
Tim Peters142297a2001-01-15 10:36:56 +0000777
778 /* The stack buffer isn't big enough; malloc a string object and read
779 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +0000780 */
Tim Peters142297a2001-01-15 10:36:56 +0000781 total_v_size = MAXBUFSIZE + INCBUFSIZE;
Tim Peters1c733232001-01-08 04:02:07 +0000782 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +0000783 if (v == NULL)
784 return v;
785 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +0000786 memcpy(BUF(v), buf, MAXBUFSIZE-1);
787 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +0000788
789 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +0000790 * after setting p one beyond the end of the line. The code here is
791 * very much like the code above, except reads into v's buffer; see
792 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +0000793 */
794 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +0000795 Py_BEGIN_ALLOW_THREADS
796 pvend = BUF(v) + total_v_size;
797 nfree = pvend - pvfree;
798 memset(pvfree, '\n', nfree);
799 p = fgets(pvfree, nfree, fp);
800 Py_END_ALLOW_THREADS
801
802 if (p == NULL) {
803 clearerr(fp);
804 if (PyErr_CheckSignals()) {
805 Py_DECREF(v);
806 return NULL;
807 }
808 p = pvfree;
809 break;
810 }
Tim Peters86821b22001-01-07 21:19:34 +0000811 p = memchr(pvfree, '\n', nfree);
812 if (p != NULL) {
813 if (p+1 < pvend && *(p+1) == '\0') {
814 /* \n came from fgets */
815 ++p;
816 break;
817 }
818 /* \n came from us; last line of file, no newline */
819 assert(p > pvfree && *(p-1) == '\0');
820 --p;
821 break;
822 }
823 /* expand buffer and try again */
824 assert(*(pvend-1) == '\0');
825 total_v_size += INCBUFSIZE;
826 if (total_v_size > INT_MAX) {
827 PyErr_SetString(PyExc_OverflowError,
828 "line is longer than a Python string can hold");
829 Py_DECREF(v);
830 return NULL;
831 }
832 if (_PyString_Resize(&v, (int)total_v_size) < 0)
833 return NULL;
834 /* overwrite the trailing null byte */
835 pvfree = BUF(v) + (total_v_size - INCBUFSIZE - 1);
836 }
837 if (BUF(v) + total_v_size != p)
838 _PyString_Resize(&v, p - BUF(v));
839 return v;
840#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +0000841#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +0000842#undef INCBUFSIZE
843}
Tim Petersf29b64d2001-01-15 06:33:19 +0000844#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000845
Guido van Rossum0bd24411991-04-04 15:21:57 +0000846/* Internal routine to get a line.
847 Size argument interpretation:
848 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +0000849 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +0000850*/
851
Guido van Rossum1187aa42001-01-05 14:43:05 +0000852#ifdef HAVE_GETC_UNLOCKED
853#define GETC(f) getc_unlocked(f)
854#define FLOCKFILE(f) flockfile(f)
855#define FUNLOCKFILE(f) funlockfile(f)
856#else
857#define GETC(f) getc(f)
858#define FLOCKFILE(f)
859#define FUNLOCKFILE(f)
860#endif
861
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000862static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000863get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000864{
Guido van Rossum1187aa42001-01-05 14:43:05 +0000865 FILE *fp = f->f_fp;
866 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +0000867 char *buf, *end;
Trent Mickf29f47b2000-08-11 19:02:59 +0000868 size_t n1, n2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000869 PyObject *v;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000870
Tim Petersf29b64d2001-01-15 06:33:19 +0000871#ifdef USE_FGETS_IN_GETLINE
Guido van Rossum86282062001-01-08 01:26:47 +0000872 if (n <= 0)
Tim Petersf29b64d2001-01-15 06:33:19 +0000873 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +0000874#endif
Guido van Rossum0bd24411991-04-04 15:21:57 +0000875 n2 = n > 0 ? n : 100;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000876 v = PyString_FromStringAndSize((char *)NULL, n2);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000877 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000878 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000879 buf = BUF(v);
880 end = buf + n2;
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000881
Guido van Rossumce5ba841991-03-06 13:06:18 +0000882 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +0000883 Py_BEGIN_ALLOW_THREADS
884 FLOCKFILE(fp);
885 while ((c = GETC(fp)) != EOF &&
886 (*buf++ = c) != '\n' &&
887 buf != end)
888 ;
889 FUNLOCKFILE(fp);
890 Py_END_ALLOW_THREADS
891 if (c == '\n')
892 break;
893 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +0000894 if (ferror(fp)) {
895 PyErr_SetFromErrno(PyExc_IOError);
896 clearerr(fp);
897 Py_DECREF(v);
898 return NULL;
899 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +0000900 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000901 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000902 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +0000903 return NULL;
904 }
Guido van Rossumce5ba841991-03-06 13:06:18 +0000905 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000906 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000907 /* Must be because buf == end */
908 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000909 break;
Guido van Rossum1187aa42001-01-05 14:43:05 +0000910 n1 = n2;
911 n2 += 1000;
912 if (n2 > INT_MAX) {
913 PyErr_SetString(PyExc_OverflowError,
914 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +0000915 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +0000916 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000917 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000918 if (_PyString_Resize(&v, n2) < 0)
919 return NULL;
920 buf = BUF(v) + n1;
921 end = BUF(v) + n2;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000922 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000923
Guido van Rossumce5ba841991-03-06 13:06:18 +0000924 n1 = buf - BUF(v);
925 if (n1 != n2)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000926 _PyString_Resize(&v, n1);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000927 return v;
928}
929
Guido van Rossum0bd24411991-04-04 15:21:57 +0000930/* External C interface */
931
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000932PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000933PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000934{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000935 PyObject *result;
936
Guido van Rossum3165fe61992-09-25 21:59:05 +0000937 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000938 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +0000939 return NULL;
940 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000941
942 if (PyFile_Check(f)) {
943 if (((PyFileObject*)f)->f_fp == NULL)
944 return err_closed();
945 result = get_line((PyFileObject *)f, n);
946 }
947 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000948 PyObject *reader;
949 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000950
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000951 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +0000952 if (reader == NULL)
953 return NULL;
954 if (n <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000955 args = Py_BuildValue("()");
Guido van Rossum3165fe61992-09-25 21:59:05 +0000956 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000957 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000958 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000959 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000960 return NULL;
961 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000962 result = PyEval_CallObject(reader, args);
963 Py_DECREF(reader);
964 Py_DECREF(args);
965 if (result != NULL && !PyString_Check(result)) {
966 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000967 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000968 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +0000969 "object.readline() returned non-string");
970 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000971 }
972
973 if (n < 0 && result != NULL && PyString_Check(result)) {
974 char *s = PyString_AS_STRING(result);
975 int len = PyString_GET_SIZE(result);
976 if (len == 0) {
977 Py_DECREF(result);
978 result = NULL;
979 PyErr_SetString(PyExc_EOFError,
980 "EOF when reading a line");
981 }
982 else if (s[len-1] == '\n') {
983 if (result->ob_refcnt == 1)
984 _PyString_Resize(&result, len-1);
985 else {
986 PyObject *v;
987 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000988 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000989 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +0000990 }
991 }
Guido van Rossum3165fe61992-09-25 21:59:05 +0000992 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000993 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000994}
995
996/* Python method */
997
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000998static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000999file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001000{
Guido van Rossum789a1611997-05-10 22:33:55 +00001001 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001002
Guido van Rossumd7297e61992-07-06 14:19:26 +00001003 if (f->f_fp == NULL)
1004 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001005 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001006 return NULL;
1007 if (n == 0)
1008 return PyString_FromString("");
1009 if (n < 0)
1010 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001011 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001012}
1013
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001014static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001015file_xreadlines(PyFileObject *f)
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001016{
1017 static PyObject* xreadlines_function = NULL;
Tim Petersf29b64d2001-01-15 06:33:19 +00001018
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001019 if (!xreadlines_function) {
1020 PyObject *xreadlines_module =
1021 PyImport_ImportModule("xreadlines");
1022 if(!xreadlines_module)
1023 return NULL;
1024
1025 xreadlines_function = PyObject_GetAttrString(xreadlines_module,
1026 "xreadlines");
1027 Py_DECREF(xreadlines_module);
1028 if(!xreadlines_function)
1029 return NULL;
1030 }
1031 return PyObject_CallFunction(xreadlines_function, "(O)", f);
1032}
1033
1034static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001035file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001036{
Guido van Rossum789a1611997-05-10 22:33:55 +00001037 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001038 PyObject *list;
1039 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001040 char small_buffer[SMALLCHUNK];
1041 char *buffer = small_buffer;
1042 size_t buffersize = SMALLCHUNK;
1043 PyObject *big_buffer = NULL;
1044 size_t nfilled = 0;
1045 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001046 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001047 char *p, *q, *end;
1048 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001049 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001050
Guido van Rossumd7297e61992-07-06 14:19:26 +00001051 if (f->f_fp == NULL)
1052 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001053 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001054 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001055 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001056 return NULL;
1057 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001058 if (shortread)
1059 nread = 0;
1060 else {
1061 Py_BEGIN_ALLOW_THREADS
1062 errno = 0;
1063 nread = fread(buffer+nfilled, 1,
1064 buffersize-nfilled, f->f_fp);
1065 Py_END_ALLOW_THREADS
1066 shortread = (nread < buffersize-nfilled);
1067 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001068 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001069 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001070 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001071 break;
1072 PyErr_SetFromErrno(PyExc_IOError);
1073 clearerr(f->f_fp);
1074 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001075 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001076 list = NULL;
1077 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001078 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001079 totalread += nread;
Guido van Rossum6263d541997-05-10 22:07:25 +00001080 p = memchr(buffer+nfilled, '\n', nread);
1081 if (p == NULL) {
1082 /* Need a larger buffer to fit this line */
1083 nfilled += nread;
1084 buffersize *= 2;
Trent Mickf29f47b2000-08-11 19:02:59 +00001085 if (buffersize > INT_MAX) {
1086 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001087 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001088 goto error;
1089 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001090 if (big_buffer == NULL) {
1091 /* Create the big buffer */
1092 big_buffer = PyString_FromStringAndSize(
1093 NULL, buffersize);
1094 if (big_buffer == NULL)
1095 goto error;
1096 buffer = PyString_AS_STRING(big_buffer);
1097 memcpy(buffer, small_buffer, nfilled);
1098 }
1099 else {
1100 /* Grow the big buffer */
1101 _PyString_Resize(&big_buffer, buffersize);
1102 buffer = PyString_AS_STRING(big_buffer);
1103 }
1104 continue;
1105 }
1106 end = buffer+nfilled+nread;
1107 q = buffer;
1108 do {
1109 /* Process complete lines */
1110 p++;
1111 line = PyString_FromStringAndSize(q, p-q);
1112 if (line == NULL)
1113 goto error;
1114 err = PyList_Append(list, line);
1115 Py_DECREF(line);
1116 if (err != 0)
1117 goto error;
1118 q = p;
1119 p = memchr(q, '\n', end-q);
1120 } while (p != NULL);
1121 /* Move the remaining incomplete line to the start */
1122 nfilled = end-q;
1123 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001124 if (sizehint > 0)
1125 if (totalread >= (size_t)sizehint)
1126 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001127 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001128 if (nfilled != 0) {
1129 /* Partial last line */
1130 line = PyString_FromStringAndSize(buffer, nfilled);
1131 if (line == NULL)
1132 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001133 if (sizehint > 0) {
1134 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001135 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001136 if (rest == NULL) {
1137 Py_DECREF(line);
1138 goto error;
1139 }
1140 PyString_Concat(&line, rest);
1141 Py_DECREF(rest);
1142 if (line == NULL)
1143 goto error;
1144 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001145 err = PyList_Append(list, line);
1146 Py_DECREF(line);
1147 if (err != 0)
1148 goto error;
1149 }
1150 cleanup:
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001151 if (big_buffer) {
Guido van Rossum6263d541997-05-10 22:07:25 +00001152 Py_DECREF(big_buffer);
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001153 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001154 return list;
1155}
1156
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001157static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001158file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001159{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001160 char *s;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001161 int n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001162 if (f->f_fp == NULL)
1163 return err_closed();
Guido van Rossum4c08d552000-03-10 22:55:18 +00001164 if (!PyArg_Parse(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001165 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001166 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001167 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001168 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001169 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001170 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001171 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001172 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001173 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001174 return NULL;
1175 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001176 Py_INCREF(Py_None);
1177 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001178}
1179
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001180static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001181file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001182{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001183#define CHUNKSIZE 1000
1184 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001185 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001186 PyObject *result;
1187 int i, j, index, len, nwritten, islist;
1188
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001189 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001190 if (f->f_fp == NULL)
1191 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001192
1193 result = NULL;
1194 list = NULL;
1195 islist = PyList_Check(seq);
1196 if (islist)
1197 it = NULL;
1198 else {
1199 it = PyObject_GetIter(seq);
1200 if (it == NULL) {
1201 PyErr_SetString(PyExc_TypeError,
1202 "writelines() requires an iterable argument");
1203 return NULL;
1204 }
1205 /* From here on, fail by going to error, to reclaim "it". */
1206 list = PyList_New(CHUNKSIZE);
1207 if (list == NULL)
1208 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001209 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001210
1211 /* Strategy: slurp CHUNKSIZE lines into a private list,
1212 checking that they are all strings, then write that list
1213 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001214 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001215 if (islist) {
1216 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001217 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001218 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001219 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001220 j = PyList_GET_SIZE(list);
1221 }
1222 else {
1223 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001224 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001225 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001226 if (PyErr_Occurred())
1227 goto error;
1228 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001229 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001230 PyList_SetItem(list, j, line);
1231 }
1232 }
1233 if (j == 0)
1234 break;
1235
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001236 /* Check that all entries are indeed strings. If not,
1237 apply the same rules as for file.write() and
1238 convert the results to strings. This is slow, but
1239 seems to be the only way since all conversion APIs
1240 could potentially execute Python code. */
1241 for (i = 0; i < j; i++) {
1242 PyObject *v = PyList_GET_ITEM(list, i);
1243 if (!PyString_Check(v)) {
1244 const char *buffer;
1245 int len;
Tim Peters86821b22001-01-07 21:19:34 +00001246 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001247 PyObject_AsReadBuffer(v,
1248 (const void**)&buffer,
1249 &len)) ||
1250 PyObject_AsCharBuffer(v,
1251 &buffer,
1252 &len))) {
1253 PyErr_SetString(PyExc_TypeError,
Fred Drake661ea262000-10-24 19:57:45 +00001254 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001255 goto error;
1256 }
1257 line = PyString_FromStringAndSize(buffer,
1258 len);
1259 if (line == NULL)
1260 goto error;
1261 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001262 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001263 }
1264 }
1265
1266 /* Since we are releasing the global lock, the
1267 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001268 Py_BEGIN_ALLOW_THREADS
1269 f->f_softspace = 0;
1270 errno = 0;
1271 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001272 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001273 len = PyString_GET_SIZE(line);
1274 nwritten = fwrite(PyString_AS_STRING(line),
1275 1, len, f->f_fp);
1276 if (nwritten != len) {
1277 Py_BLOCK_THREADS
1278 PyErr_SetFromErrno(PyExc_IOError);
1279 clearerr(f->f_fp);
1280 goto error;
1281 }
1282 }
1283 Py_END_ALLOW_THREADS
1284
1285 if (j < CHUNKSIZE)
1286 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001287 }
1288
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001289 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001290 result = Py_None;
1291 error:
1292 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001293 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001294 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001295#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001296}
1297
Tim Petersefc3a3a2001-09-20 07:55:22 +00001298static char readline_doc[] =
1299"readline([size]) -> next line from the file, as a string.\n"
1300"\n"
1301"Retain newline. A non-negative size argument limits the maximum\n"
1302"number of bytes to return (an incomplete line may be returned then).\n"
1303"Return an empty string at EOF.";
1304
1305static char read_doc[] =
1306"read([size]) -> read at most size bytes, returned as a string.\n"
1307"\n"
1308"If the size argument is negative or omitted, read until EOF is reached.";
1309
1310static char write_doc[] =
1311"write(str) -> None. Write string str to file.\n"
1312"\n"
1313"Note that due to buffering, flush() or close() may be needed before\n"
1314"the file on disk reflects the data written.";
1315
1316static char fileno_doc[] =
1317"fileno() -> integer \"file descriptor\".\n"
1318"\n"
1319"This is needed for lower-level file interfaces, such os.read().";
1320
1321static char seek_doc[] =
1322"seek(offset[, whence]) -> None. Move to new file position.\n"
1323"\n"
1324"Argument offset is a byte count. Optional argument whence defaults to\n"
1325"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1326"(move relative to current position, positive or negative), and 2 (move\n"
1327"relative to end of file, usually negative, although many platforms allow\n"
1328"seeking beyond the end of a file).\n"
1329"\n"
1330"Note that not all file objects are seekable.";
1331
Guido van Rossumd7047b31995-01-02 19:07:15 +00001332#ifdef HAVE_FTRUNCATE
Tim Petersefc3a3a2001-09-20 07:55:22 +00001333static char truncate_doc[] =
1334"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1335"\n"
1336"Size defaults to the current file position, as returned by tell().";
Guido van Rossumd7047b31995-01-02 19:07:15 +00001337#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001338
1339static char tell_doc[] =
1340"tell() -> current file position, an integer (may be a long integer).";
1341
1342static char readinto_doc[] =
1343"readinto() -> Undocumented. Don't use this; it may go away.";
1344
1345static char readlines_doc[] =
1346"readlines([size]) -> list of strings, each a line from the file.\n"
1347"\n"
1348"Call readline() repeatedly and return a list of the lines so read.\n"
1349"The optional size argument, if given, is an approximate bound on the\n"
1350"total number of bytes in the lines returned.";
1351
1352static char xreadlines_doc[] =
1353"xreadlines() -> next line from the file, as a string.\n"
1354"\n"
1355"Equivalent to xreadlines.xreadlines(file). This is like readline(), but\n"
1356"often quicker, due to reading ahead internally.";
1357
1358static char writelines_doc[] =
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001359"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001360"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001361"Note that newlines are not added. The sequence can be any iterable object\n"
1362"producing strings. This is equivalent to calling write() for each string.";
Tim Petersefc3a3a2001-09-20 07:55:22 +00001363
1364static char flush_doc[] =
1365"flush() -> None. Flush the internal I/O buffer.";
1366
1367static char close_doc[] =
1368"close() -> None or (perhaps) an integer. Close the file.\n"
1369"\n"
1370"Sets data attribute .closed to true. A closed file cannot be used for\n"
1371"further I/O operations. close() may be called more than once without\n"
1372"error. Some kinds of file objects (for example, opened by popen())\n"
1373"may return an exit status upon closing.";
1374
1375static char isatty_doc[] =
1376"isatty() -> true or false. True if the file is connected to a tty device.";
1377
1378static PyMethodDef file_methods[] = {
1379 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1380 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1381 {"write", (PyCFunction)file_write, METH_OLDARGS, write_doc},
1382 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1383 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
1384#ifdef HAVE_FTRUNCATE
1385 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
1386#endif
1387 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1388 {"readinto", (PyCFunction)file_readinto, METH_OLDARGS, readinto_doc},
1389 {"readlines", (PyCFunction)file_readlines, METH_VARARGS, readlines_doc},
1390 {"xreadlines", (PyCFunction)file_xreadlines, METH_NOARGS, xreadlines_doc},
1391 {"writelines", (PyCFunction)file_writelines, METH_O, writelines_doc},
1392 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1393 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1394 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001395 {NULL, NULL} /* sentinel */
1396};
1397
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001398#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001399
Guido van Rossum6f799372001-09-20 20:46:19 +00001400static PyMemberDef file_memberlist[] = {
1401 {"softspace", T_INT, OFF(f_softspace), 0,
1402 "flag indicating that a space needs to be printed; used by print"},
1403 {"mode", T_OBJECT, OFF(f_mode), RO,
1404 "file mode ('r', 'w', 'a', possibly with 'b' or '+' added)"},
1405 {"name", T_OBJECT, OFF(f_name), RO,
1406 "file name"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001407 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001408 {NULL} /* Sentinel */
1409};
1410
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001411static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001412get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001413{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001414 return PyInt_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001415}
1416
Guido van Rossum32d34c82001-09-20 21:45:26 +00001417static PyGetSetDef file_getsetlist[] = {
1418 {"closed", (getter)get_closed, NULL, "flag set if the file is closed"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001419 {0},
1420};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001421
Guido van Rossum65967252001-04-21 13:20:18 +00001422static PyObject *
Guido van Rossum5b021842001-05-22 16:48:37 +00001423file_getiter(PyObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001424{
Guido van Rossum5b021842001-05-22 16:48:37 +00001425 return PyObject_CallMethod(f, "xreadlines", "");
Guido van Rossum65967252001-04-21 13:20:18 +00001426}
1427
Tim Peters59c9a642001-09-13 05:38:56 +00001428static PyObject *
1429file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1430{
Tim Peters44410012001-09-14 03:26:08 +00001431 PyObject *self;
1432 static PyObject *not_yet_string;
1433
1434 assert(type != NULL && type->tp_alloc != NULL);
1435
1436 if (not_yet_string == NULL) {
1437 not_yet_string = PyString_FromString("<uninitialized file>");
1438 if (not_yet_string == NULL)
1439 return NULL;
1440 }
1441
1442 self = type->tp_alloc(type, 0);
1443 if (self != NULL) {
1444 /* Always fill in the name and mode, so that nobody else
1445 needs to special-case NULLs there. */
1446 Py_INCREF(not_yet_string);
1447 ((PyFileObject *)self)->f_name = not_yet_string;
1448 Py_INCREF(not_yet_string);
1449 ((PyFileObject *)self)->f_mode = not_yet_string;
1450 }
1451 return self;
1452}
1453
1454static int
1455file_init(PyObject *self, PyObject *args, PyObject *kwds)
1456{
1457 PyFileObject *foself = (PyFileObject *)self;
1458 int ret = 0;
Tim Peters59c9a642001-09-13 05:38:56 +00001459 static char *kwlist[] = {"name", "mode", "buffering", 0};
1460 char *name = NULL;
1461 char *mode = "r";
1462 int bufsize = -1;
Tim Peters44410012001-09-14 03:26:08 +00001463
1464 assert(PyFile_Check(self));
1465 if (foself->f_fp != NULL) {
1466 /* Have to close the existing file first. */
1467 PyObject *closeresult = file_close(foself);
1468 if (closeresult == NULL)
1469 return -1;
1470 Py_DECREF(closeresult);
1471 }
Tim Peters59c9a642001-09-13 05:38:56 +00001472
1473 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
1474 Py_FileSystemDefaultEncoding, &name,
1475 &mode, &bufsize))
Tim Peters44410012001-09-14 03:26:08 +00001476 return -1;
1477 if (fill_file_fields(foself, NULL, name, mode, fclose) == NULL)
1478 goto Error;
1479 if (open_the_file(foself, name, mode) == NULL)
1480 goto Error;
1481 PyFile_SetBufSize(self, bufsize);
1482 goto Done;
1483
1484Error:
1485 ret = -1;
1486 /* fall through */
1487Done:
Tim Peters59c9a642001-09-13 05:38:56 +00001488 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00001489 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00001490}
1491
Tim Peters59c9a642001-09-13 05:38:56 +00001492static char file_doc[] =
1493"file(name[, mode[, buffering]]) -> file object\n"
1494"\n"
1495"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
1496"writing or appending. The file will be created if it doesn't exist\n"
1497"when opened for writing or appending; it will be truncated when\n"
1498"opened for writing. Add a 'b' to the mode for binary files.\n"
1499"Add a '+' to the mode to allow simultaneous reading and writing.\n"
1500"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00001501"buffered, and larger numbers specify the buffer size.\n"
1502"Note: open() is an alias for file().\n";
Tim Peters59c9a642001-09-13 05:38:56 +00001503
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001504PyTypeObject PyFile_Type = {
1505 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001506 0,
1507 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001508 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001509 0,
Guido van Rossum65967252001-04-21 13:20:18 +00001510 (destructor)file_dealloc, /* tp_dealloc */
1511 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001512 0, /* tp_getattr */
1513 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00001514 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001515 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00001516 0, /* tp_as_number */
1517 0, /* tp_as_sequence */
1518 0, /* tp_as_mapping */
1519 0, /* tp_hash */
1520 0, /* tp_call */
1521 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001522 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum65967252001-04-21 13:20:18 +00001523 0, /* tp_setattro */
1524 0, /* tp_as_buffer */
Guido van Rossum9475a232001-10-05 20:51:39 +00001525 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00001526 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001527 0, /* tp_traverse */
1528 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00001529 0, /* tp_richcompare */
1530 0, /* tp_weaklistoffset */
Guido van Rossum5b021842001-05-22 16:48:37 +00001531 file_getiter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +00001532 0, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001533 file_methods, /* tp_methods */
1534 file_memberlist, /* tp_members */
1535 file_getsetlist, /* tp_getset */
1536 0, /* tp_base */
1537 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00001538 0, /* tp_descr_get */
1539 0, /* tp_descr_set */
1540 0, /* tp_dictoffset */
Tim Peters44410012001-09-14 03:26:08 +00001541 (initproc)file_init, /* tp_init */
1542 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00001543 file_new, /* tp_new */
Guido van Rossum9475a232001-10-05 20:51:39 +00001544 _PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001545};
Guido van Rossumeb183da1991-04-04 10:44:06 +00001546
1547/* Interface for the 'soft space' between print items. */
1548
1549int
Fred Drakefd99de62000-07-09 05:02:18 +00001550PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00001551{
1552 int oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001553 if (f == NULL) {
1554 /* Do nothing */
1555 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001556 else if (PyFile_Check(f)) {
1557 oldflag = ((PyFileObject *)f)->f_softspace;
1558 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001559 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001560 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001561 PyObject *v;
1562 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001563 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001564 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001565 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001566 if (PyInt_Check(v))
1567 oldflag = PyInt_AsLong(v);
1568 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001569 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001570 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001571 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001572 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001573 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001574 if (PyObject_SetAttrString(f, "softspace", v) != 0)
1575 PyErr_Clear();
1576 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001577 }
1578 }
Guido van Rossumeb183da1991-04-04 10:44:06 +00001579 return oldflag;
1580}
Guido van Rossum3165fe61992-09-25 21:59:05 +00001581
1582/* Interfaces to write objects/strings to file-like objects */
1583
1584int
Fred Drakefd99de62000-07-09 05:02:18 +00001585PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001586{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001587 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001588 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001589 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001590 return -1;
1591 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001592 else if (PyFile_Check(f)) {
1593 FILE *fp = PyFile_AsFile(f);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001594 if (fp == NULL) {
1595 err_closed();
1596 return -1;
1597 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001598 return PyObject_Print(v, fp, flags);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001599 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001600 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001601 if (writer == NULL)
1602 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00001603 if (flags & Py_PRINT_RAW) {
1604 if (PyUnicode_Check(v)) {
1605 value = v;
1606 Py_INCREF(value);
1607 } else
1608 value = PyObject_Str(v);
1609 }
1610 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001611 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00001612 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001613 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00001614 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001615 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001616 args = Py_BuildValue("(O)", value);
Guido van Rossume9eec541997-05-22 14:02:25 +00001617 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001618 Py_DECREF(value);
1619 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00001620 return -1;
1621 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001622 result = PyEval_CallObject(writer, args);
1623 Py_DECREF(args);
1624 Py_DECREF(value);
1625 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001626 if (result == NULL)
1627 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001628 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001629 return 0;
1630}
1631
Guido van Rossum27a60b11997-05-22 22:25:11 +00001632int
Fred Drakefd99de62000-07-09 05:02:18 +00001633PyFile_WriteString(char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001634{
1635 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00001636 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00001637 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00001638 PyErr_SetString(PyExc_SystemError,
1639 "null file for PyFile_WriteString");
1640 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001641 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001642 else if (PyFile_Check(f)) {
1643 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001644 if (fp == NULL) {
1645 err_closed();
1646 return -1;
1647 }
1648 fputs(s, fp);
1649 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001650 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001651 else if (!PyErr_Occurred()) {
1652 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001653 int err;
1654 if (v == NULL)
1655 return -1;
1656 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
1657 Py_DECREF(v);
1658 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001659 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00001660 else
1661 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001662}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001663
1664/* Try to get a file-descriptor from a Python object. If the object
1665 is an integer or long integer, its value is returned. If not, the
1666 object's fileno() method is called if it exists; the method must return
1667 an integer or long integer, which is returned as the file descriptor value.
1668 -1 is returned on failure.
1669*/
1670
1671int PyObject_AsFileDescriptor(PyObject *o)
1672{
1673 int fd;
1674 PyObject *meth;
1675
1676 if (PyInt_Check(o)) {
1677 fd = PyInt_AsLong(o);
1678 }
1679 else if (PyLong_Check(o)) {
1680 fd = PyLong_AsLong(o);
1681 }
1682 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
1683 {
1684 PyObject *fno = PyEval_CallObject(meth, NULL);
1685 Py_DECREF(meth);
1686 if (fno == NULL)
1687 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00001688
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001689 if (PyInt_Check(fno)) {
1690 fd = PyInt_AsLong(fno);
1691 Py_DECREF(fno);
1692 }
1693 else if (PyLong_Check(fno)) {
1694 fd = PyLong_AsLong(fno);
1695 Py_DECREF(fno);
1696 }
1697 else {
1698 PyErr_SetString(PyExc_TypeError,
1699 "fileno() returned a non-integer");
1700 Py_DECREF(fno);
1701 return -1;
1702 }
1703 }
1704 else {
1705 PyErr_SetString(PyExc_TypeError,
1706 "argument must be an int, or have a fileno() method.");
1707 return -1;
1708 }
1709
1710 if (fd < 0) {
1711 PyErr_Format(PyExc_ValueError,
1712 "file descriptor cannot be a negative integer (%i)",
1713 fd);
1714 return -1;
1715 }
1716 return fd;
1717}