blob: b6c039ccbcbf03783374a16ea3e345ceae061638 [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 Rossumb18618d2000-05-03 23:44:39 +0000211 PyObject_DEL(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. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000526 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
527 if (pos >= 0)
528 pos = ftell(f->f_fp);
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000529 if (pos < 0)
530 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000531 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000532 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000533 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000534 }
535#endif
536 if (currentsize > SMALLCHUNK) {
537 /* Keep doubling until we reach BIGCHUNK;
538 then keep adding BIGCHUNK. */
539 if (currentsize <= BIGCHUNK)
540 return currentsize + currentsize;
541 else
542 return currentsize + BIGCHUNK;
543 }
544 return currentsize + SMALLCHUNK;
545}
546
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000547static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000548file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000549{
Guido van Rossum789a1611997-05-10 22:33:55 +0000550 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000551 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000552 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000553
Guido van Rossumd7297e61992-07-06 14:19:26 +0000554 if (f->f_fp == NULL)
555 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +0000556 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000557 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000558 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000559 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000560 else
561 buffersize = bytesrequested;
Trent Mickf29f47b2000-08-11 19:02:59 +0000562 if (buffersize > INT_MAX) {
563 PyErr_SetString(PyExc_OverflowError,
564 "requested number of bytes is more than a Python string can hold");
565 return NULL;
566 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000567 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000568 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000569 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000570 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000571 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000572 Py_BEGIN_ALLOW_THREADS
573 errno = 0;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000574 chunksize = fread(BUF(v) + bytesread, 1,
575 buffersize - bytesread, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000576 Py_END_ALLOW_THREADS
577 if (chunksize == 0) {
578 if (!ferror(f->f_fp))
579 break;
580 PyErr_SetFromErrno(PyExc_IOError);
581 clearerr(f->f_fp);
582 Py_DECREF(v);
583 return NULL;
584 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000585 bytesread += chunksize;
586 if (bytesread < buffersize)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000587 break;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000588 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000589 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000590 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000591 return NULL;
592 }
593 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000594 if (bytesread != buffersize)
595 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000596 return v;
597}
598
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000599static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000600file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000601{
602 char *ptr;
Trent Mickf29f47b2000-08-11 19:02:59 +0000603 size_t ntodo, ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000604
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000605 if (f->f_fp == NULL)
606 return err_closed();
607 if (!PyArg_Parse(args, "w#", &ptr, &ntodo))
608 return NULL;
609 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000610 while (ntodo > 0) {
611 Py_BEGIN_ALLOW_THREADS
612 errno = 0;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000613 nnow = fread(ptr+ndone, 1, ntodo, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000614 Py_END_ALLOW_THREADS
615 if (nnow == 0) {
616 if (!ferror(f->f_fp))
617 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000618 PyErr_SetFromErrno(PyExc_IOError);
619 clearerr(f->f_fp);
620 return NULL;
621 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000622 ndone += nnow;
623 ntodo -= nnow;
624 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000625 return PyInt_FromLong((long)ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000626}
627
Tim Peters86821b22001-01-07 21:19:34 +0000628/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000629Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000630
631Under MSVC 6:
632
Tim Peters1c733232001-01-08 04:02:07 +0000633+ MS threadsafe getc is very slow (multiple layers of function calls before+
634 after each character, to lock+unlock the stream).
635+ The stream-locking functions are MS-internal -- can't access them from user
636 code.
637+ There's nothing Tim could find in the MS C or platform SDK libraries that
638 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000639+ MS fgets locks/unlocks only once per line; it's the only hook we have.
640
641So we use fgets for speed(!), despite that it's painful.
642
643MS realloc is also slow.
644
Tim Petersf29b64d2001-01-15 06:33:19 +0000645Reports from other platforms on this method vs getc_unlocked (which MS doesn't
646have):
647 Linux a wash
648 Solaris a wash
649 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000650
Tim Petersf29b64d2001-01-15 06:33:19 +0000651CAUTION: The C std isn't clear about this: in those cases where fgets
652writes something into the buffer, can it write into any position beyond the
653required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
654known on which it does; and it would be a strange way to code fgets. Still,
655getline_via_fgets may not work correctly if it does. The std test
656test_bufio.py should fail if platform fgets() routinely writes beyond the
657trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000658**************************************************************************/
659
Tim Petersf29b64d2001-01-15 06:33:19 +0000660/* Use this routine if told to, or by default on non-get_unlocked()
661 * platforms unless told not to. Yikes! Let's spell that out:
662 * On a platform with getc_unlocked():
663 * By default, use getc_unlocked().
664 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
665 * On a platform without getc_unlocked():
666 * By default, use fgets().
667 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
668 */
669#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
670#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000671#endif
672
Tim Petersf29b64d2001-01-15 06:33:19 +0000673#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
674#undef USE_FGETS_IN_GETLINE
675#endif
676
677#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000678static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000679getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000680{
Tim Peters15b83852001-01-08 00:53:12 +0000681/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000682 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
683 * to fill this much of the buffer with a known value in order to figure out
684 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
685 * than "most" lines, we waste time filling unused buffer slots. 100 is
686 * surely adequate for most peoples' email archives, chewing over source code,
687 * etc -- "regular old text files".
688 * MAXBUFSIZE is the maximum line length that lets us get away with the less
689 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
690 * cautions about boosting that. 300 was chosen because the worst real-life
691 * text-crunching job reported on Python-Dev was a mail-log crawler where over
692 * half the lines were 254 chars.
693 * INCBUFSIZE is the amount by which we grow the buffer, if MAXBUFSIZE isn't
694 * enough. It doesn't much matter what this is set to: we only get here for
695 * absurdly long lines anyway.
Tim Peters15b83852001-01-08 00:53:12 +0000696 */
Tim Peters142297a2001-01-15 10:36:56 +0000697#define INITBUFSIZE 100
698#define MAXBUFSIZE 300
Tim Peters86821b22001-01-07 21:19:34 +0000699#define INCBUFSIZE 1000
Tim Peters142297a2001-01-15 10:36:56 +0000700 char* p; /* temp */
701 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000702 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +0000703 char* pvfree; /* address of next free slot */
704 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +0000705 size_t nfree; /* # of free buffer slots; pvend-pvfree */
706 size_t total_v_size; /* total # of slots in buffer */
Tim Peters86821b22001-01-07 21:19:34 +0000707
Tim Peters15b83852001-01-08 00:53:12 +0000708 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +0000709 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +0000710 */
Tim Peters142297a2001-01-15 10:36:56 +0000711 total_v_size = INITBUFSIZE; /* start small and pray */
712 pvfree = buf;
713 for (;;) {
714 Py_BEGIN_ALLOW_THREADS
715 pvend = buf + total_v_size;
716 nfree = pvend - pvfree;
717 memset(pvfree, '\n', nfree);
718 p = fgets(pvfree, nfree, fp);
719 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +0000720
Tim Peters142297a2001-01-15 10:36:56 +0000721 if (p == NULL) {
722 clearerr(fp);
723 if (PyErr_CheckSignals())
724 return NULL;
725 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +0000726 return v;
727 }
Tim Peters142297a2001-01-15 10:36:56 +0000728 /* fgets read *something* */
729 p = memchr(pvfree, '\n', nfree);
730 if (p != NULL) {
731 /* Did the \n come from fgets or from us?
732 * Since fgets stops at the first \n, and then writes
733 * \0, if it's from fgets a \0 must be next. But if
734 * that's so, it could not have come from us, since
735 * the \n's we filled the buffer with have only more
736 * \n's to the right.
737 */
738 if (p+1 < pvend && *(p+1) == '\0') {
739 /* It's from fgets: we win! In particular,
740 * we haven't done any mallocs yet, and can
741 * build the final result on the first try.
742 */
743 ++p; /* include \n from fgets */
744 }
745 else {
746 /* Must be from us: fgets didn't fill the
747 * buffer and didn't find a newline, so it
748 * must be the last and newline-free line of
749 * the file.
750 */
751 assert(p > pvfree && *(p-1) == '\0');
752 --p; /* don't include \0 from fgets */
753 }
754 v = PyString_FromStringAndSize(buf, p - buf);
755 return v;
756 }
757 /* yuck: fgets overwrote all the newlines, i.e. the entire
758 * buffer. So this line isn't over yet, or maybe it is but
759 * we're exactly at EOF. If we haven't already, try using the
760 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +0000761 */
Tim Peters142297a2001-01-15 10:36:56 +0000762 assert(*(pvend-1) == '\0');
763 if (pvfree == buf) {
764 pvfree = pvend - 1; /* overwrite trailing null */
765 total_v_size = MAXBUFSIZE;
766 }
767 else
768 break;
Tim Peters86821b22001-01-07 21:19:34 +0000769 }
Tim Peters142297a2001-01-15 10:36:56 +0000770
771 /* The stack buffer isn't big enough; malloc a string object and read
772 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +0000773 */
Tim Peters142297a2001-01-15 10:36:56 +0000774 total_v_size = MAXBUFSIZE + INCBUFSIZE;
Tim Peters1c733232001-01-08 04:02:07 +0000775 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +0000776 if (v == NULL)
777 return v;
778 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +0000779 memcpy(BUF(v), buf, MAXBUFSIZE-1);
780 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +0000781
782 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +0000783 * after setting p one beyond the end of the line. The code here is
784 * very much like the code above, except reads into v's buffer; see
785 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +0000786 */
787 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +0000788 Py_BEGIN_ALLOW_THREADS
789 pvend = BUF(v) + total_v_size;
790 nfree = pvend - pvfree;
791 memset(pvfree, '\n', nfree);
792 p = fgets(pvfree, nfree, fp);
793 Py_END_ALLOW_THREADS
794
795 if (p == NULL) {
796 clearerr(fp);
797 if (PyErr_CheckSignals()) {
798 Py_DECREF(v);
799 return NULL;
800 }
801 p = pvfree;
802 break;
803 }
Tim Peters86821b22001-01-07 21:19:34 +0000804 p = memchr(pvfree, '\n', nfree);
805 if (p != NULL) {
806 if (p+1 < pvend && *(p+1) == '\0') {
807 /* \n came from fgets */
808 ++p;
809 break;
810 }
811 /* \n came from us; last line of file, no newline */
812 assert(p > pvfree && *(p-1) == '\0');
813 --p;
814 break;
815 }
816 /* expand buffer and try again */
817 assert(*(pvend-1) == '\0');
818 total_v_size += INCBUFSIZE;
819 if (total_v_size > INT_MAX) {
820 PyErr_SetString(PyExc_OverflowError,
821 "line is longer than a Python string can hold");
822 Py_DECREF(v);
823 return NULL;
824 }
825 if (_PyString_Resize(&v, (int)total_v_size) < 0)
826 return NULL;
827 /* overwrite the trailing null byte */
828 pvfree = BUF(v) + (total_v_size - INCBUFSIZE - 1);
829 }
830 if (BUF(v) + total_v_size != p)
831 _PyString_Resize(&v, p - BUF(v));
832 return v;
833#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +0000834#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +0000835#undef INCBUFSIZE
836}
Tim Petersf29b64d2001-01-15 06:33:19 +0000837#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000838
Guido van Rossum0bd24411991-04-04 15:21:57 +0000839/* Internal routine to get a line.
840 Size argument interpretation:
841 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +0000842 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +0000843*/
844
Guido van Rossum1187aa42001-01-05 14:43:05 +0000845#ifdef HAVE_GETC_UNLOCKED
846#define GETC(f) getc_unlocked(f)
847#define FLOCKFILE(f) flockfile(f)
848#define FUNLOCKFILE(f) funlockfile(f)
849#else
850#define GETC(f) getc(f)
851#define FLOCKFILE(f)
852#define FUNLOCKFILE(f)
853#endif
854
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000855static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000856get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000857{
Guido van Rossum1187aa42001-01-05 14:43:05 +0000858 FILE *fp = f->f_fp;
859 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +0000860 char *buf, *end;
Trent Mickf29f47b2000-08-11 19:02:59 +0000861 size_t n1, n2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000862 PyObject *v;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000863
Tim Petersf29b64d2001-01-15 06:33:19 +0000864#ifdef USE_FGETS_IN_GETLINE
Guido van Rossum86282062001-01-08 01:26:47 +0000865 if (n <= 0)
Tim Petersf29b64d2001-01-15 06:33:19 +0000866 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +0000867#endif
Guido van Rossum0bd24411991-04-04 15:21:57 +0000868 n2 = n > 0 ? n : 100;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000869 v = PyString_FromStringAndSize((char *)NULL, n2);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000870 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000871 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000872 buf = BUF(v);
873 end = buf + n2;
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000874
Guido van Rossumce5ba841991-03-06 13:06:18 +0000875 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +0000876 Py_BEGIN_ALLOW_THREADS
877 FLOCKFILE(fp);
878 while ((c = GETC(fp)) != EOF &&
879 (*buf++ = c) != '\n' &&
880 buf != end)
881 ;
882 FUNLOCKFILE(fp);
883 Py_END_ALLOW_THREADS
884 if (c == '\n')
885 break;
886 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +0000887 if (ferror(fp)) {
888 PyErr_SetFromErrno(PyExc_IOError);
889 clearerr(fp);
890 Py_DECREF(v);
891 return NULL;
892 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +0000893 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000894 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000895 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +0000896 return NULL;
897 }
Guido van Rossumce5ba841991-03-06 13:06:18 +0000898 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000899 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000900 /* Must be because buf == end */
901 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000902 break;
Guido van Rossum1187aa42001-01-05 14:43:05 +0000903 n1 = n2;
904 n2 += 1000;
905 if (n2 > INT_MAX) {
906 PyErr_SetString(PyExc_OverflowError,
907 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +0000908 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +0000909 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000910 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000911 if (_PyString_Resize(&v, n2) < 0)
912 return NULL;
913 buf = BUF(v) + n1;
914 end = BUF(v) + n2;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000915 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000916
Guido van Rossumce5ba841991-03-06 13:06:18 +0000917 n1 = buf - BUF(v);
918 if (n1 != n2)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000919 _PyString_Resize(&v, n1);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000920 return v;
921}
922
Guido van Rossum0bd24411991-04-04 15:21:57 +0000923/* External C interface */
924
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000925PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000926PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000927{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000928 PyObject *result;
929
Guido van Rossum3165fe61992-09-25 21:59:05 +0000930 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000931 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +0000932 return NULL;
933 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000934
935 if (PyFile_Check(f)) {
936 if (((PyFileObject*)f)->f_fp == NULL)
937 return err_closed();
938 result = get_line((PyFileObject *)f, n);
939 }
940 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000941 PyObject *reader;
942 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000943
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000944 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +0000945 if (reader == NULL)
946 return NULL;
947 if (n <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000948 args = Py_BuildValue("()");
Guido van Rossum3165fe61992-09-25 21:59:05 +0000949 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000950 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000951 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000952 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000953 return NULL;
954 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000955 result = PyEval_CallObject(reader, args);
956 Py_DECREF(reader);
957 Py_DECREF(args);
958 if (result != NULL && !PyString_Check(result)) {
959 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000960 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000961 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +0000962 "object.readline() returned non-string");
963 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000964 }
965
966 if (n < 0 && result != NULL && PyString_Check(result)) {
967 char *s = PyString_AS_STRING(result);
968 int len = PyString_GET_SIZE(result);
969 if (len == 0) {
970 Py_DECREF(result);
971 result = NULL;
972 PyErr_SetString(PyExc_EOFError,
973 "EOF when reading a line");
974 }
975 else if (s[len-1] == '\n') {
976 if (result->ob_refcnt == 1)
977 _PyString_Resize(&result, len-1);
978 else {
979 PyObject *v;
980 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000981 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000982 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +0000983 }
984 }
Guido van Rossum3165fe61992-09-25 21:59:05 +0000985 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000986 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000987}
988
989/* Python method */
990
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000991static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000992file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000993{
Guido van Rossum789a1611997-05-10 22:33:55 +0000994 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000995
Guido van Rossumd7297e61992-07-06 14:19:26 +0000996 if (f->f_fp == NULL)
997 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +0000998 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +0000999 return NULL;
1000 if (n == 0)
1001 return PyString_FromString("");
1002 if (n < 0)
1003 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001004 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001005}
1006
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001007static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001008file_xreadlines(PyFileObject *f)
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001009{
1010 static PyObject* xreadlines_function = NULL;
Tim Petersf29b64d2001-01-15 06:33:19 +00001011
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001012 if (!xreadlines_function) {
1013 PyObject *xreadlines_module =
1014 PyImport_ImportModule("xreadlines");
1015 if(!xreadlines_module)
1016 return NULL;
1017
1018 xreadlines_function = PyObject_GetAttrString(xreadlines_module,
1019 "xreadlines");
1020 Py_DECREF(xreadlines_module);
1021 if(!xreadlines_function)
1022 return NULL;
1023 }
1024 return PyObject_CallFunction(xreadlines_function, "(O)", f);
1025}
1026
1027static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001028file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001029{
Guido van Rossum789a1611997-05-10 22:33:55 +00001030 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001031 PyObject *list;
1032 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001033 char small_buffer[SMALLCHUNK];
1034 char *buffer = small_buffer;
1035 size_t buffersize = SMALLCHUNK;
1036 PyObject *big_buffer = NULL;
1037 size_t nfilled = 0;
1038 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001039 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001040 char *p, *q, *end;
1041 int err;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001042
Guido van Rossumd7297e61992-07-06 14:19:26 +00001043 if (f->f_fp == NULL)
1044 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001045 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001046 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001047 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001048 return NULL;
1049 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +00001050 Py_BEGIN_ALLOW_THREADS
1051 errno = 0;
1052 nread = fread(buffer+nfilled, 1, buffersize-nfilled, f->f_fp);
1053 Py_END_ALLOW_THREADS
1054 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001055 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001056 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001057 break;
1058 PyErr_SetFromErrno(PyExc_IOError);
1059 clearerr(f->f_fp);
1060 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001061 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001062 list = NULL;
1063 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001064 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001065 totalread += nread;
Guido van Rossum6263d541997-05-10 22:07:25 +00001066 p = memchr(buffer+nfilled, '\n', nread);
1067 if (p == NULL) {
1068 /* Need a larger buffer to fit this line */
1069 nfilled += nread;
1070 buffersize *= 2;
Trent Mickf29f47b2000-08-11 19:02:59 +00001071 if (buffersize > INT_MAX) {
1072 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001073 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001074 goto error;
1075 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001076 if (big_buffer == NULL) {
1077 /* Create the big buffer */
1078 big_buffer = PyString_FromStringAndSize(
1079 NULL, buffersize);
1080 if (big_buffer == NULL)
1081 goto error;
1082 buffer = PyString_AS_STRING(big_buffer);
1083 memcpy(buffer, small_buffer, nfilled);
1084 }
1085 else {
1086 /* Grow the big buffer */
1087 _PyString_Resize(&big_buffer, buffersize);
1088 buffer = PyString_AS_STRING(big_buffer);
1089 }
1090 continue;
1091 }
1092 end = buffer+nfilled+nread;
1093 q = buffer;
1094 do {
1095 /* Process complete lines */
1096 p++;
1097 line = PyString_FromStringAndSize(q, p-q);
1098 if (line == NULL)
1099 goto error;
1100 err = PyList_Append(list, line);
1101 Py_DECREF(line);
1102 if (err != 0)
1103 goto error;
1104 q = p;
1105 p = memchr(q, '\n', end-q);
1106 } while (p != NULL);
1107 /* Move the remaining incomplete line to the start */
1108 nfilled = end-q;
1109 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001110 if (sizehint > 0)
1111 if (totalread >= (size_t)sizehint)
1112 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001113 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001114 if (nfilled != 0) {
1115 /* Partial last line */
1116 line = PyString_FromStringAndSize(buffer, nfilled);
1117 if (line == NULL)
1118 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001119 if (sizehint > 0) {
1120 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001121 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001122 if (rest == NULL) {
1123 Py_DECREF(line);
1124 goto error;
1125 }
1126 PyString_Concat(&line, rest);
1127 Py_DECREF(rest);
1128 if (line == NULL)
1129 goto error;
1130 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001131 err = PyList_Append(list, line);
1132 Py_DECREF(line);
1133 if (err != 0)
1134 goto error;
1135 }
1136 cleanup:
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001137 if (big_buffer) {
Guido van Rossum6263d541997-05-10 22:07:25 +00001138 Py_DECREF(big_buffer);
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001139 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001140 return list;
1141}
1142
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001143static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001144file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001145{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001146 char *s;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001147 int n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001148 if (f->f_fp == NULL)
1149 return err_closed();
Guido van Rossum4c08d552000-03-10 22:55:18 +00001150 if (!PyArg_Parse(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001151 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001152 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001153 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001154 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001155 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001156 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001157 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001158 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001159 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001160 return NULL;
1161 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001162 Py_INCREF(Py_None);
1163 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001164}
1165
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001166static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001167file_writelines(PyFileObject *f, PyObject *args)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001168{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001169#define CHUNKSIZE 1000
1170 PyObject *list, *line;
1171 PyObject *result;
1172 int i, j, index, len, nwritten, islist;
1173
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001174 if (f->f_fp == NULL)
1175 return err_closed();
Guido van Rossumee70ad12000-03-13 16:27:06 +00001176 if (args == NULL || !PySequence_Check(args)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001177 PyErr_SetString(PyExc_TypeError,
Fred Drake661ea262000-10-24 19:57:45 +00001178 "writelines() argument must be a sequence of strings");
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001179 return NULL;
1180 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001181 islist = PyList_Check(args);
1182
1183 /* Strategy: slurp CHUNKSIZE lines into a private list,
1184 checking that they are all strings, then write that list
1185 without holding the interpreter lock, then come back for more. */
1186 index = 0;
1187 if (islist)
1188 list = NULL;
1189 else {
1190 list = PyList_New(CHUNKSIZE);
1191 if (list == NULL)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001192 return NULL;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001193 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001194 result = NULL;
1195
1196 for (;;) {
1197 if (islist) {
1198 Py_XDECREF(list);
1199 list = PyList_GetSlice(args, index, index+CHUNKSIZE);
1200 if (list == NULL)
1201 return NULL;
1202 j = PyList_GET_SIZE(list);
1203 }
1204 else {
1205 for (j = 0; j < CHUNKSIZE; j++) {
1206 line = PySequence_GetItem(args, index+j);
1207 if (line == NULL) {
1208 if (PyErr_ExceptionMatches(
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001209 PyExc_IndexError)) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001210 PyErr_Clear();
1211 break;
1212 }
1213 /* Some other error occurred.
1214 XXX We may lose some output. */
1215 goto error;
1216 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001217 PyList_SetItem(list, j, line);
1218 }
1219 }
1220 if (j == 0)
1221 break;
1222
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001223 /* Check that all entries are indeed strings. If not,
1224 apply the same rules as for file.write() and
1225 convert the results to strings. This is slow, but
1226 seems to be the only way since all conversion APIs
1227 could potentially execute Python code. */
1228 for (i = 0; i < j; i++) {
1229 PyObject *v = PyList_GET_ITEM(list, i);
1230 if (!PyString_Check(v)) {
1231 const char *buffer;
1232 int len;
Tim Peters86821b22001-01-07 21:19:34 +00001233 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001234 PyObject_AsReadBuffer(v,
1235 (const void**)&buffer,
1236 &len)) ||
1237 PyObject_AsCharBuffer(v,
1238 &buffer,
1239 &len))) {
1240 PyErr_SetString(PyExc_TypeError,
Fred Drake661ea262000-10-24 19:57:45 +00001241 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001242 goto error;
1243 }
1244 line = PyString_FromStringAndSize(buffer,
1245 len);
1246 if (line == NULL)
1247 goto error;
1248 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001249 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001250 }
1251 }
1252
1253 /* Since we are releasing the global lock, the
1254 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001255 Py_BEGIN_ALLOW_THREADS
1256 f->f_softspace = 0;
1257 errno = 0;
1258 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001259 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001260 len = PyString_GET_SIZE(line);
1261 nwritten = fwrite(PyString_AS_STRING(line),
1262 1, len, f->f_fp);
1263 if (nwritten != len) {
1264 Py_BLOCK_THREADS
1265 PyErr_SetFromErrno(PyExc_IOError);
1266 clearerr(f->f_fp);
1267 goto error;
1268 }
1269 }
1270 Py_END_ALLOW_THREADS
1271
1272 if (j < CHUNKSIZE)
1273 break;
1274 index += CHUNKSIZE;
1275 }
1276
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001277 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001278 result = Py_None;
1279 error:
1280 Py_XDECREF(list);
1281 return result;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001282}
1283
Tim Petersefc3a3a2001-09-20 07:55:22 +00001284static char readline_doc[] =
1285"readline([size]) -> next line from the file, as a string.\n"
1286"\n"
1287"Retain newline. A non-negative size argument limits the maximum\n"
1288"number of bytes to return (an incomplete line may be returned then).\n"
1289"Return an empty string at EOF.";
1290
1291static char read_doc[] =
1292"read([size]) -> read at most size bytes, returned as a string.\n"
1293"\n"
1294"If the size argument is negative or omitted, read until EOF is reached.";
1295
1296static char write_doc[] =
1297"write(str) -> None. Write string str to file.\n"
1298"\n"
1299"Note that due to buffering, flush() or close() may be needed before\n"
1300"the file on disk reflects the data written.";
1301
1302static char fileno_doc[] =
1303"fileno() -> integer \"file descriptor\".\n"
1304"\n"
1305"This is needed for lower-level file interfaces, such os.read().";
1306
1307static char seek_doc[] =
1308"seek(offset[, whence]) -> None. Move to new file position.\n"
1309"\n"
1310"Argument offset is a byte count. Optional argument whence defaults to\n"
1311"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1312"(move relative to current position, positive or negative), and 2 (move\n"
1313"relative to end of file, usually negative, although many platforms allow\n"
1314"seeking beyond the end of a file).\n"
1315"\n"
1316"Note that not all file objects are seekable.";
1317
Guido van Rossumd7047b31995-01-02 19:07:15 +00001318#ifdef HAVE_FTRUNCATE
Tim Petersefc3a3a2001-09-20 07:55:22 +00001319static char truncate_doc[] =
1320"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1321"\n"
1322"Size defaults to the current file position, as returned by tell().";
Guido van Rossumd7047b31995-01-02 19:07:15 +00001323#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001324
1325static char tell_doc[] =
1326"tell() -> current file position, an integer (may be a long integer).";
1327
1328static char readinto_doc[] =
1329"readinto() -> Undocumented. Don't use this; it may go away.";
1330
1331static char readlines_doc[] =
1332"readlines([size]) -> list of strings, each a line from the file.\n"
1333"\n"
1334"Call readline() repeatedly and return a list of the lines so read.\n"
1335"The optional size argument, if given, is an approximate bound on the\n"
1336"total number of bytes in the lines returned.";
1337
1338static char xreadlines_doc[] =
1339"xreadlines() -> next line from the file, as a string.\n"
1340"\n"
1341"Equivalent to xreadlines.xreadlines(file). This is like readline(), but\n"
1342"often quicker, due to reading ahead internally.";
1343
1344static char writelines_doc[] =
1345"writelines(list of strings) -> None. Write the strings to the file.\n"
1346"\n"
1347"Note that newlines are not added. This is equivalent to calling write()\n"
1348"for each string in the list.";
1349
1350static char flush_doc[] =
1351"flush() -> None. Flush the internal I/O buffer.";
1352
1353static char close_doc[] =
1354"close() -> None or (perhaps) an integer. Close the file.\n"
1355"\n"
1356"Sets data attribute .closed to true. A closed file cannot be used for\n"
1357"further I/O operations. close() may be called more than once without\n"
1358"error. Some kinds of file objects (for example, opened by popen())\n"
1359"may return an exit status upon closing.";
1360
1361static char isatty_doc[] =
1362"isatty() -> true or false. True if the file is connected to a tty device.";
1363
1364static PyMethodDef file_methods[] = {
1365 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1366 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1367 {"write", (PyCFunction)file_write, METH_OLDARGS, write_doc},
1368 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1369 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
1370#ifdef HAVE_FTRUNCATE
1371 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
1372#endif
1373 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1374 {"readinto", (PyCFunction)file_readinto, METH_OLDARGS, readinto_doc},
1375 {"readlines", (PyCFunction)file_readlines, METH_VARARGS, readlines_doc},
1376 {"xreadlines", (PyCFunction)file_xreadlines, METH_NOARGS, xreadlines_doc},
1377 {"writelines", (PyCFunction)file_writelines, METH_O, writelines_doc},
1378 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1379 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1380 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001381 {NULL, NULL} /* sentinel */
1382};
1383
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001384#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001385
Guido van Rossum6f799372001-09-20 20:46:19 +00001386static PyMemberDef file_memberlist[] = {
1387 {"softspace", T_INT, OFF(f_softspace), 0,
1388 "flag indicating that a space needs to be printed; used by print"},
1389 {"mode", T_OBJECT, OFF(f_mode), RO,
1390 "file mode ('r', 'w', 'a', possibly with 'b' or '+' added)"},
1391 {"name", T_OBJECT, OFF(f_name), RO,
1392 "file name"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001393 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001394 {NULL} /* Sentinel */
1395};
1396
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001397static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001398get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001399{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001400 return PyInt_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001401}
1402
Guido van Rossum32d34c82001-09-20 21:45:26 +00001403static PyGetSetDef file_getsetlist[] = {
1404 {"closed", (getter)get_closed, NULL, "flag set if the file is closed"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001405 {0},
1406};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001407
Guido van Rossum65967252001-04-21 13:20:18 +00001408static PyObject *
Guido van Rossum5b021842001-05-22 16:48:37 +00001409file_getiter(PyObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001410{
Guido van Rossum5b021842001-05-22 16:48:37 +00001411 return PyObject_CallMethod(f, "xreadlines", "");
Guido van Rossum65967252001-04-21 13:20:18 +00001412}
1413
Tim Peters59c9a642001-09-13 05:38:56 +00001414static PyObject *
1415file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1416{
Tim Peters44410012001-09-14 03:26:08 +00001417 PyObject *self;
1418 static PyObject *not_yet_string;
1419
1420 assert(type != NULL && type->tp_alloc != NULL);
1421
1422 if (not_yet_string == NULL) {
1423 not_yet_string = PyString_FromString("<uninitialized file>");
1424 if (not_yet_string == NULL)
1425 return NULL;
1426 }
1427
1428 self = type->tp_alloc(type, 0);
1429 if (self != NULL) {
1430 /* Always fill in the name and mode, so that nobody else
1431 needs to special-case NULLs there. */
1432 Py_INCREF(not_yet_string);
1433 ((PyFileObject *)self)->f_name = not_yet_string;
1434 Py_INCREF(not_yet_string);
1435 ((PyFileObject *)self)->f_mode = not_yet_string;
1436 }
1437 return self;
1438}
1439
1440static int
1441file_init(PyObject *self, PyObject *args, PyObject *kwds)
1442{
1443 PyFileObject *foself = (PyFileObject *)self;
1444 int ret = 0;
Tim Peters59c9a642001-09-13 05:38:56 +00001445 static char *kwlist[] = {"name", "mode", "buffering", 0};
1446 char *name = NULL;
1447 char *mode = "r";
1448 int bufsize = -1;
Tim Peters44410012001-09-14 03:26:08 +00001449
1450 assert(PyFile_Check(self));
1451 if (foself->f_fp != NULL) {
1452 /* Have to close the existing file first. */
1453 PyObject *closeresult = file_close(foself);
1454 if (closeresult == NULL)
1455 return -1;
1456 Py_DECREF(closeresult);
1457 }
Tim Peters59c9a642001-09-13 05:38:56 +00001458
1459 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
1460 Py_FileSystemDefaultEncoding, &name,
1461 &mode, &bufsize))
Tim Peters44410012001-09-14 03:26:08 +00001462 return -1;
1463 if (fill_file_fields(foself, NULL, name, mode, fclose) == NULL)
1464 goto Error;
1465 if (open_the_file(foself, name, mode) == NULL)
1466 goto Error;
1467 PyFile_SetBufSize(self, bufsize);
1468 goto Done;
1469
1470Error:
1471 ret = -1;
1472 /* fall through */
1473Done:
Tim Peters59c9a642001-09-13 05:38:56 +00001474 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00001475 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00001476}
1477
Tim Peters59c9a642001-09-13 05:38:56 +00001478static char file_doc[] =
1479"file(name[, mode[, buffering]]) -> file object\n"
1480"\n"
1481"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
1482"writing or appending. The file will be created if it doesn't exist\n"
1483"when opened for writing or appending; it will be truncated when\n"
1484"opened for writing. Add a 'b' to the mode for binary files.\n"
1485"Add a '+' to the mode to allow simultaneous reading and writing.\n"
1486"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00001487"buffered, and larger numbers specify the buffer size.\n"
1488"Note: open() is an alias for file().\n";
Tim Peters59c9a642001-09-13 05:38:56 +00001489
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001490PyTypeObject PyFile_Type = {
1491 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001492 0,
1493 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001494 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001495 0,
Guido van Rossum65967252001-04-21 13:20:18 +00001496 (destructor)file_dealloc, /* tp_dealloc */
1497 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001498 0, /* tp_getattr */
1499 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00001500 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001501 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00001502 0, /* tp_as_number */
1503 0, /* tp_as_sequence */
1504 0, /* tp_as_mapping */
1505 0, /* tp_hash */
1506 0, /* tp_call */
1507 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001508 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum65967252001-04-21 13:20:18 +00001509 0, /* tp_setattro */
1510 0, /* tp_as_buffer */
Tim Peters59c9a642001-09-13 05:38:56 +00001511 Py_TPFLAGS_DEFAULT |
1512 Py_TPFLAGS_BASETYPE, /* tp_flags */
1513 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001514 0, /* tp_traverse */
1515 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00001516 0, /* tp_richcompare */
1517 0, /* tp_weaklistoffset */
Guido van Rossum5b021842001-05-22 16:48:37 +00001518 file_getiter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +00001519 0, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001520 file_methods, /* tp_methods */
1521 file_memberlist, /* tp_members */
1522 file_getsetlist, /* tp_getset */
1523 0, /* tp_base */
1524 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00001525 0, /* tp_descr_get */
1526 0, /* tp_descr_set */
1527 0, /* tp_dictoffset */
Tim Peters44410012001-09-14 03:26:08 +00001528 (initproc)file_init, /* tp_init */
1529 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00001530 file_new, /* tp_new */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001531};
Guido van Rossumeb183da1991-04-04 10:44:06 +00001532
1533/* Interface for the 'soft space' between print items. */
1534
1535int
Fred Drakefd99de62000-07-09 05:02:18 +00001536PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00001537{
1538 int oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001539 if (f == NULL) {
1540 /* Do nothing */
1541 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001542 else if (PyFile_Check(f)) {
1543 oldflag = ((PyFileObject *)f)->f_softspace;
1544 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001545 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001546 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001547 PyObject *v;
1548 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001549 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001550 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001551 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001552 if (PyInt_Check(v))
1553 oldflag = PyInt_AsLong(v);
1554 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001555 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001556 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001557 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001558 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001559 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001560 if (PyObject_SetAttrString(f, "softspace", v) != 0)
1561 PyErr_Clear();
1562 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001563 }
1564 }
Guido van Rossumeb183da1991-04-04 10:44:06 +00001565 return oldflag;
1566}
Guido van Rossum3165fe61992-09-25 21:59:05 +00001567
1568/* Interfaces to write objects/strings to file-like objects */
1569
1570int
Fred Drakefd99de62000-07-09 05:02:18 +00001571PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001572{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001573 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001574 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001575 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001576 return -1;
1577 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001578 else if (PyFile_Check(f)) {
1579 FILE *fp = PyFile_AsFile(f);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001580 if (fp == NULL) {
1581 err_closed();
1582 return -1;
1583 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001584 return PyObject_Print(v, fp, flags);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001585 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001586 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001587 if (writer == NULL)
1588 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00001589 if (flags & Py_PRINT_RAW) {
1590 if (PyUnicode_Check(v)) {
1591 value = v;
1592 Py_INCREF(value);
1593 } else
1594 value = PyObject_Str(v);
1595 }
1596 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001597 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00001598 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001599 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00001600 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001601 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001602 args = Py_BuildValue("(O)", value);
Guido van Rossume9eec541997-05-22 14:02:25 +00001603 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001604 Py_DECREF(value);
1605 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00001606 return -1;
1607 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001608 result = PyEval_CallObject(writer, args);
1609 Py_DECREF(args);
1610 Py_DECREF(value);
1611 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001612 if (result == NULL)
1613 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001614 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001615 return 0;
1616}
1617
Guido van Rossum27a60b11997-05-22 22:25:11 +00001618int
Fred Drakefd99de62000-07-09 05:02:18 +00001619PyFile_WriteString(char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001620{
1621 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00001622 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00001623 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00001624 PyErr_SetString(PyExc_SystemError,
1625 "null file for PyFile_WriteString");
1626 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001627 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001628 else if (PyFile_Check(f)) {
1629 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001630 if (fp == NULL) {
1631 err_closed();
1632 return -1;
1633 }
1634 fputs(s, fp);
1635 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001636 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001637 else if (!PyErr_Occurred()) {
1638 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001639 int err;
1640 if (v == NULL)
1641 return -1;
1642 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
1643 Py_DECREF(v);
1644 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001645 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00001646 else
1647 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001648}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001649
1650/* Try to get a file-descriptor from a Python object. If the object
1651 is an integer or long integer, its value is returned. If not, the
1652 object's fileno() method is called if it exists; the method must return
1653 an integer or long integer, which is returned as the file descriptor value.
1654 -1 is returned on failure.
1655*/
1656
1657int PyObject_AsFileDescriptor(PyObject *o)
1658{
1659 int fd;
1660 PyObject *meth;
1661
1662 if (PyInt_Check(o)) {
1663 fd = PyInt_AsLong(o);
1664 }
1665 else if (PyLong_Check(o)) {
1666 fd = PyLong_AsLong(o);
1667 }
1668 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
1669 {
1670 PyObject *fno = PyEval_CallObject(meth, NULL);
1671 Py_DECREF(meth);
1672 if (fno == NULL)
1673 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00001674
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001675 if (PyInt_Check(fno)) {
1676 fd = PyInt_AsLong(fno);
1677 Py_DECREF(fno);
1678 }
1679 else if (PyLong_Check(fno)) {
1680 fd = PyLong_AsLong(fno);
1681 Py_DECREF(fno);
1682 }
1683 else {
1684 PyErr_SetString(PyExc_TypeError,
1685 "fileno() returned a non-integer");
1686 Py_DECREF(fno);
1687 return -1;
1688 }
1689 }
1690 else {
1691 PyErr_SetString(PyExc_TypeError,
1692 "argument must be an int, or have a fileno() method.");
1693 return -1;
1694 }
1695
1696 if (fd < 0) {
1697 PyErr_Format(PyExc_ValueError,
1698 "file descriptor cannot be a negative integer (%i)",
1699 fd);
1700 return -1;
1701 }
1702 return fd;
1703}