blob: 7bcc82aa1c52f0bf18f18aa99cab1a40ff05b884 [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 Rossumb8199141997-05-06 15:23:24 +000011#ifdef MS_WIN32
Guido van Rossumb8199141997-05-06 15:23:24 +000012#define fileno _fileno
Tim Petersfb05db22002-03-11 00:24:00 +000013/* can simulate truncate with Win32 API functions; see file_truncate */
Guido van Rossumb8199141997-05-06 15:23:24 +000014#define HAVE_FTRUNCATE
Tim Petersfb05db22002-03-11 00:24:00 +000015#define WINDOWS_LEAN_AND_MEAN
16#include <windows.h>
Guido van Rossumb8199141997-05-06 15:23:24 +000017#endif
18
Guido van Rossumf2044e11998-04-28 16:05:59 +000019#ifdef macintosh
20#ifdef USE_GUSI
21#define HAVE_FTRUNCATE
22#endif
23#endif
24
Jack Jansene08dea191995-04-23 22:12:47 +000025#ifdef __MWERKS__
26/* Mwerks fopen() doesn't always set errno */
27#define NO_FOPEN_ERRNO
28#endif
Guido van Rossum295d1711995-02-19 15:55:19 +000029
Andrew MacIntyrec4874392002-02-26 11:36:35 +000030#if defined(PYOS_OS2) && defined(PYCC_GCC)
31#include <io.h>
32#endif
33
Guido van Rossumc0b618a1997-05-02 03:12:38 +000034#define BUF(v) PyString_AS_STRING((PyStringObject *)v)
Guido van Rossumce5ba841991-03-06 13:06:18 +000035
Guido van Rossumff7e83d1999-08-27 20:39:37 +000036#ifndef DONT_HAVE_ERRNO_H
Guido van Rossumf1dc5661993-07-05 10:31:29 +000037#include <errno.h>
Guido van Rossumff7e83d1999-08-27 20:39:37 +000038#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000039
Trent Mickf29f47b2000-08-11 19:02:59 +000040
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000041typedef struct {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000042 PyObject_HEAD
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000043 FILE *f_fp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000044 PyObject *f_name;
45 PyObject *f_mode;
Tim Petersdbd9ba62000-07-09 03:09:57 +000046 int (*f_close)(FILE *);
Guido van Rossumeb183da1991-04-04 10:44:06 +000047 int f_softspace; /* Flag used by 'print' command */
Guido van Rossum4c08d552000-03-10 22:55:18 +000048 int f_binary; /* Flag which indicates whether the file is open
49 open in binary (1) or test (0) mode */
Guido van Rossumc0b618a1997-05-02 03:12:38 +000050} PyFileObject;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000051
52FILE *
Fred Drakefd99de62000-07-09 05:02:18 +000053PyFile_AsFile(PyObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000054{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000055 if (f == NULL || !PyFile_Check(f))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000056 return NULL;
Guido van Rossum3165fe61992-09-25 21:59:05 +000057 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000058 return ((PyFileObject *)f)->f_fp;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000059}
60
Guido van Rossumc0b618a1997-05-02 03:12:38 +000061PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +000062PyFile_Name(PyObject *f)
Guido van Rossumdb3165e1993-10-18 17:06:59 +000063{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000064 if (f == NULL || !PyFile_Check(f))
Guido van Rossumdb3165e1993-10-18 17:06:59 +000065 return NULL;
66 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000067 return ((PyFileObject *)f)->f_name;
Guido van Rossumdb3165e1993-10-18 17:06:59 +000068}
69
Tim Peters59c9a642001-09-13 05:38:56 +000070
71static PyObject *
72fill_file_fields(PyFileObject *f, FILE *fp, char *name, char *mode,
73 int (*close)(FILE *))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000074{
Tim Peters59c9a642001-09-13 05:38:56 +000075 assert(f != NULL);
76 assert(PyFile_Check(f));
Tim Peters44410012001-09-14 03:26:08 +000077 assert(f->f_fp == NULL);
78
79 Py_DECREF(f->f_name);
80 Py_DECREF(f->f_mode);
Guido van Rossumc0b618a1997-05-02 03:12:38 +000081 f->f_name = PyString_FromString(name);
82 f->f_mode = PyString_FromString(mode);
Tim Peters44410012001-09-14 03:26:08 +000083
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +000084 f->f_close = close;
Guido van Rossumeb183da1991-04-04 10:44:06 +000085 f->f_softspace = 0;
Tim Peters59c9a642001-09-13 05:38:56 +000086 f->f_binary = strchr(mode,'b') != NULL;
Tim Peters44410012001-09-14 03:26:08 +000087
Tim Peters59c9a642001-09-13 05:38:56 +000088 if (f->f_name == NULL || f->f_mode == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000089 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000090 f->f_fp = fp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000091 return (PyObject *) f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000092}
93
Tim Peters59c9a642001-09-13 05:38:56 +000094static PyObject *
95open_the_file(PyFileObject *f, char *name, char *mode)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000096{
Tim Peters59c9a642001-09-13 05:38:56 +000097 assert(f != NULL);
98 assert(PyFile_Check(f));
99 assert(name != NULL);
100 assert(mode != NULL);
Tim Peters44410012001-09-14 03:26:08 +0000101 assert(f->f_fp == NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000102
Tim Peters8fa45672001-09-13 21:01:29 +0000103 /* rexec.py can't stop a user from getting the file() constructor --
104 all they have to do is get *any* file object f, and then do
105 type(f). Here we prevent them from doing damage with it. */
106 if (PyEval_GetRestricted()) {
107 PyErr_SetString(PyExc_IOError,
108 "file() constructor not accessible in restricted mode");
109 return NULL;
110 }
Tim Petersa27a1502001-11-09 20:59:14 +0000111 errno = 0;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000112#ifdef HAVE_FOPENRF
Guido van Rossuma08095a1991-02-13 23:25:27 +0000113 if (*mode == '*') {
114 FILE *fopenRF();
115 f->f_fp = fopenRF(name, mode+1);
116 }
117 else
118#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000119 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000120 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000121 f->f_fp = fopen(name, mode);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000122 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000123 }
Guido van Rossuma08095a1991-02-13 23:25:27 +0000124 if (f->f_fp == NULL) {
Jack Jansene08dea191995-04-23 22:12:47 +0000125#ifdef NO_FOPEN_ERRNO
Jack Jansenb3be2162001-11-30 14:16:36 +0000126 /* Metroworks only, wich does not always sets errno */
Jeremy Hylton41c83212001-11-09 16:17:24 +0000127 if (errno == 0) {
Jack Jansenb3be2162001-11-30 14:16:36 +0000128 PyObject *v;
129 v = Py_BuildValue("(is)", 0, "Cannot open file");
130 if (v != NULL) {
131 PyErr_SetObject(PyExc_IOError, v);
132 Py_DECREF(v);
133 }
Jack Jansene08dea191995-04-23 22:12:47 +0000134 return NULL;
135 }
136#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000137 if (errno == EINVAL)
138 PyErr_Format(PyExc_IOError, "invalid argument: %s",
139 mode);
140 else
141 PyErr_SetFromErrnoWithFilename(PyExc_IOError, name);
Tim Peters59c9a642001-09-13 05:38:56 +0000142 f = NULL;
143 }
144 return (PyObject *)f;
145}
146
147PyObject *
148PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
149{
Tim Peters44410012001-09-14 03:26:08 +0000150 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
151 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000152 if (f != NULL) {
153 if (fill_file_fields(f, fp, name, mode, close) == NULL) {
154 Py_DECREF(f);
155 f = NULL;
156 }
157 }
158 return (PyObject *) f;
159}
160
161PyObject *
162PyFile_FromString(char *name, char *mode)
163{
164 extern int fclose(FILE *);
165 PyFileObject *f;
166
167 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
168 if (f != NULL) {
169 if (open_the_file(f, name, mode) == NULL) {
170 Py_DECREF(f);
171 f = NULL;
172 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000173 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000174 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000175}
176
Guido van Rossumb6775db1994-08-01 11:34:53 +0000177void
Fred Drakefd99de62000-07-09 05:02:18 +0000178PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000179{
180 if (bufsize >= 0) {
181#ifdef HAVE_SETVBUF
182 int type;
183 switch (bufsize) {
184 case 0:
185 type = _IONBF;
186 break;
187 case 1:
188 type = _IOLBF;
189 bufsize = BUFSIZ;
190 break;
191 default:
192 type = _IOFBF;
193 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000194 setvbuf(((PyFileObject *)f)->f_fp, (char *)NULL,
195 type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000196#else /* !HAVE_SETVBUF */
197 if (bufsize <= 1)
198 setbuf(((PyFileObject *)f)->f_fp, (char *)NULL);
199#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000200 }
201}
202
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000203static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000204err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000205{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000206 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000207 return NULL;
208}
209
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000210/* Methods */
211
212static void
Fred Drakefd99de62000-07-09 05:02:18 +0000213file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000214{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000215 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000216 Py_BEGIN_ALLOW_THREADS
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000217 (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000218 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000219 }
Tim Peters44410012001-09-14 03:26:08 +0000220 Py_XDECREF(f->f_name);
221 Py_XDECREF(f->f_mode);
Guido van Rossum9475a232001-10-05 20:51:39 +0000222 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000223}
224
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000225static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000226file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000227{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000228 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
229 f->f_fp == NULL ? "closed" : "open",
230 PyString_AsString(f->f_name),
231 PyString_AsString(f->f_mode),
232 f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000233}
234
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000235static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000236file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000237{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000238 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000239 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000240 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000241 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000242 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000243 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000244 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000245 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000246 f->f_fp = NULL;
247 }
Guido van Rossumfebd5511992-03-04 16:39:24 +0000248 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000249 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000250 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000251 return PyInt_FromLong((long)sts);
252 Py_INCREF(Py_None);
253 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000254}
255
Trent Mickf29f47b2000-08-11 19:02:59 +0000256
Guido van Rossumb8552162001-09-05 14:58:11 +0000257/* Our very own off_t-like type, 64-bit if possible */
258#if !defined(HAVE_LARGEFILE_SUPPORT)
259typedef off_t Py_off_t;
260#elif SIZEOF_OFF_T >= 8
261typedef off_t Py_off_t;
262#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000263typedef fpos_t Py_off_t;
264#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000265#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000266#endif
267
268
Trent Mickf29f47b2000-08-11 19:02:59 +0000269/* a portable fseek() function
270 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000271static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000272_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000273{
Guido van Rossumb8552162001-09-05 14:58:11 +0000274#if !defined(HAVE_LARGEFILE_SUPPORT)
275 return fseek(fp, offset, whence);
276#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000277 return fseeko(fp, offset, whence);
278#elif defined(HAVE_FSEEK64)
279 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000280#elif defined(__BEOS__)
281 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000282#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000283 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
284 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000285 fpos_t pos;
286 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000287 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000288#ifdef MS_WINDOWS
289 fflush(fp);
290 if (_lseeki64(fileno(fp), 0, 2) == -1)
291 return -1;
292#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000293 if (fseek(fp, 0, SEEK_END) != 0)
294 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000295#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000296 /* fall through */
297 case SEEK_CUR:
298 if (fgetpos(fp, &pos) != 0)
299 return -1;
300 offset += pos;
301 break;
302 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000303 }
304 return fsetpos(fp, &offset);
305#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000306#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000307#endif
308}
309
310
311/* a portable ftell() function
312 Return -1 on failure with errno set appropriately, current file
313 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000314static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000315_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000316{
Guido van Rossumb8552162001-09-05 14:58:11 +0000317#if !defined(HAVE_LARGEFILE_SUPPORT)
318 return ftell(fp);
319#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
320 return ftello(fp);
321#elif defined(HAVE_FTELL64)
322 return ftell64(fp);
323#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000324 fpos_t pos;
325 if (fgetpos(fp, &pos) != 0)
326 return -1;
327 return pos;
328#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000329#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000330#endif
331}
332
333
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000334static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000335file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000336{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000337 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000338 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000339 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000340 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000341
Guido van Rossumd7297e61992-07-06 14:19:26 +0000342 if (f->f_fp == NULL)
343 return err_closed();
344 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000345 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000346 return NULL;
347#if !defined(HAVE_LARGEFILE_SUPPORT)
348 offset = PyInt_AsLong(offobj);
349#else
350 offset = PyLong_Check(offobj) ?
351 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
352#endif
353 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000354 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000355
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000356 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000357 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000358 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000359 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000360
Guido van Rossumff4949e1992-08-05 19:58:53 +0000361 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000362 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000363 clearerr(f->f_fp);
364 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000365 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000366 Py_INCREF(Py_None);
367 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000368}
369
Trent Mickf29f47b2000-08-11 19:02:59 +0000370
Guido van Rossumd7047b31995-01-02 19:07:15 +0000371#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000372static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000373file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000374{
Guido van Rossumd7047b31995-01-02 19:07:15 +0000375 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000376 Py_off_t newsize;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000377 PyObject *newsizeobj;
Tim Peters86821b22001-01-07 21:19:34 +0000378
Guido van Rossumd7047b31995-01-02 19:07:15 +0000379 if (f->f_fp == NULL)
380 return err_closed();
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000381 newsizeobj = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +0000382 if (!PyArg_ParseTuple(args, "|O:truncate", &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000383 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000384
385 /* Set newsize to current postion if newsizeobj NULL, else to the
386 specified value. */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000387 if (newsizeobj != NULL) {
388#if !defined(HAVE_LARGEFILE_SUPPORT)
389 newsize = PyInt_AsLong(newsizeobj);
390#else
391 newsize = PyLong_Check(newsizeobj) ?
392 PyLong_AsLongLong(newsizeobj) :
393 PyInt_AsLong(newsizeobj);
394#endif
395 if (PyErr_Occurred())
396 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000397 }
398 else {
399 /* Default to current position. */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000400 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000401 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000402 newsize = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000403 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000404 if (newsize == -1)
405 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000406 }
Tim Petersfb05db22002-03-11 00:24:00 +0000407
408 /* Flush the file. */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000409 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000410 errno = 0;
411 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000412 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000413 if (ret != 0)
414 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000415
416#ifdef MS_WIN32
Tim Petersfb05db22002-03-11 00:24:00 +0000417 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000418 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000419 {
Tim Peters8f01b682002-03-12 03:04:44 +0000420 Py_off_t current; /* current file position */
Tim Petersfb05db22002-03-11 00:24:00 +0000421 HANDLE hFile;
422 int error;
423
Tim Peters8f01b682002-03-12 03:04:44 +0000424 /* current <- current file postion. */
425 if (newsizeobj == NULL)
426 current = newsize;
427 else {
Tim Petersfb05db22002-03-11 00:24:00 +0000428 Py_BEGIN_ALLOW_THREADS
429 errno = 0;
Tim Peters8f01b682002-03-12 03:04:44 +0000430 current = _portable_ftell(f->f_fp);
431 Py_END_ALLOW_THREADS
432 if (current == -1)
433 goto onioerror;
434 }
435
436 /* Move to newsize. */
437 if (current != newsize) {
438 Py_BEGIN_ALLOW_THREADS
439 errno = 0;
440 error = _portable_fseek(f->f_fp, newsize, SEEK_SET)
441 != 0;
Tim Petersfb05db22002-03-11 00:24:00 +0000442 Py_END_ALLOW_THREADS
443 if (error)
444 goto onioerror;
445 }
446
Tim Peters8f01b682002-03-12 03:04:44 +0000447 /* Truncate. Note that this may grow the file! */
448 Py_BEGIN_ALLOW_THREADS
449 errno = 0;
450 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
451 error = hFile == (HANDLE)-1;
452 if (!error) {
453 error = SetEndOfFile(hFile) == 0;
454 if (error)
455 errno = EACCES;
456 }
457 Py_END_ALLOW_THREADS
458 if (error)
459 goto onioerror;
460
461 /* Restore original file position. */
462 if (current != newsize) {
463 Py_BEGIN_ALLOW_THREADS
464 errno = 0;
465 error = _portable_fseek(f->f_fp, current, SEEK_SET)
466 != 0;
467 Py_END_ALLOW_THREADS
468 if (error)
469 goto onioerror;
470 }
Guido van Rossumd7047b31995-01-02 19:07:15 +0000471 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000472#else
473 Py_BEGIN_ALLOW_THREADS
474 errno = 0;
475 ret = ftruncate(fileno(f->f_fp), newsize);
476 Py_END_ALLOW_THREADS
477 if (ret != 0) goto onioerror;
478#endif /* !MS_WIN32 */
Tim Peters86821b22001-01-07 21:19:34 +0000479
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000480 Py_INCREF(Py_None);
481 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000482
483onioerror:
484 PyErr_SetFromErrno(PyExc_IOError);
485 clearerr(f->f_fp);
486 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000487}
488#endif /* HAVE_FTRUNCATE */
489
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000490static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000491file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000492{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000493 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000494
Guido van Rossumd7297e61992-07-06 14:19:26 +0000495 if (f->f_fp == NULL)
496 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000497 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000498 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000499 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000500 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000501 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000502 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000503 clearerr(f->f_fp);
504 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000505 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000506#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000507 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000508#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000509 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000510#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000511}
512
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000513static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000514file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000515{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000516 if (f->f_fp == NULL)
517 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000518 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000519}
520
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000521static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000522file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000523{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000524 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000525
Guido van Rossumd7297e61992-07-06 14:19:26 +0000526 if (f->f_fp == NULL)
527 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000528 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000529 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000530 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000531 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000532 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000533 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000534 clearerr(f->f_fp);
535 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000536 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000537 Py_INCREF(Py_None);
538 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000539}
540
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000541static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000542file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000543{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000544 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000545 if (f->f_fp == NULL)
546 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000547 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000548 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000549 Py_END_ALLOW_THREADS
550 return PyInt_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000551}
552
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000553
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000554#if BUFSIZ < 8192
555#define SMALLCHUNK 8192
556#else
557#define SMALLCHUNK BUFSIZ
558#endif
559
Guido van Rossum3c259041999-01-14 19:00:14 +0000560#if SIZEOF_INT < 4
561#define BIGCHUNK (512 * 32)
562#else
563#define BIGCHUNK (512 * 1024)
564#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000565
566static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000567new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000568{
569#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000570 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000571 struct stat st;
572 if (fstat(fileno(f->f_fp), &st) == 0) {
573 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000574 /* The following is not a bug: we really need to call lseek()
575 *and* ftell(). The reason is that some stdio libraries
576 mistakenly flush their buffer when ftell() is called and
577 the lseek() call it makes fails, thereby throwing away
578 data that cannot be recovered in any way. To avoid this,
579 we first test lseek(), and only call ftell() if lseek()
580 works. We can't use the lseek() value either, because we
581 need to take the amount of buffered data into account.
582 (Yet another reason why stdio stinks. :-) */
Jack Jansen2771b5b2001-10-10 22:03:27 +0000583#ifdef USE_GUSI2
584 pos = lseek(fileno(f->f_fp), 1L, SEEK_CUR);
585 pos = lseek(fileno(f->f_fp), -1L, SEEK_CUR);
586#else
Guido van Rossum91aaa921998-05-05 22:21:35 +0000587 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000588#endif
589 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000590 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000591 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000592 if (pos < 0)
593 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000594 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000595 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000596 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000597 }
598#endif
599 if (currentsize > SMALLCHUNK) {
600 /* Keep doubling until we reach BIGCHUNK;
601 then keep adding BIGCHUNK. */
602 if (currentsize <= BIGCHUNK)
603 return currentsize + currentsize;
604 else
605 return currentsize + BIGCHUNK;
606 }
607 return currentsize + SMALLCHUNK;
608}
609
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000610static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000611file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000612{
Guido van Rossum789a1611997-05-10 22:33:55 +0000613 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000614 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000615 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000616
Guido van Rossumd7297e61992-07-06 14:19:26 +0000617 if (f->f_fp == NULL)
618 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +0000619 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000620 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000621 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000622 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000623 else
624 buffersize = bytesrequested;
Trent Mickf29f47b2000-08-11 19:02:59 +0000625 if (buffersize > INT_MAX) {
626 PyErr_SetString(PyExc_OverflowError,
627 "requested number of bytes is more than a Python string can hold");
628 return NULL;
629 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000630 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000631 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000632 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000633 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000634 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000635 Py_BEGIN_ALLOW_THREADS
636 errno = 0;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000637 chunksize = fread(BUF(v) + bytesread, 1,
638 buffersize - bytesread, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000639 Py_END_ALLOW_THREADS
640 if (chunksize == 0) {
641 if (!ferror(f->f_fp))
642 break;
643 PyErr_SetFromErrno(PyExc_IOError);
644 clearerr(f->f_fp);
645 Py_DECREF(v);
646 return NULL;
647 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000648 bytesread += chunksize;
649 if (bytesread < buffersize)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000650 break;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000651 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000652 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000653 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000654 return NULL;
655 }
656 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000657 if (bytesread != buffersize)
658 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000659 return v;
660}
661
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000662static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000663file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000664{
665 char *ptr;
Guido van Rossum00ebd462001-10-23 21:25:24 +0000666 int ntodo;
667 size_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000668
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000669 if (f->f_fp == NULL)
670 return err_closed();
671 if (!PyArg_Parse(args, "w#", &ptr, &ntodo))
672 return NULL;
673 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000674 while (ntodo > 0) {
675 Py_BEGIN_ALLOW_THREADS
676 errno = 0;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000677 nnow = fread(ptr+ndone, 1, ntodo, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000678 Py_END_ALLOW_THREADS
679 if (nnow == 0) {
680 if (!ferror(f->f_fp))
681 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000682 PyErr_SetFromErrno(PyExc_IOError);
683 clearerr(f->f_fp);
684 return NULL;
685 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000686 ndone += nnow;
687 ntodo -= nnow;
688 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000689 return PyInt_FromLong((long)ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000690}
691
Tim Peters86821b22001-01-07 21:19:34 +0000692/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000693Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000694
695Under MSVC 6:
696
Tim Peters1c733232001-01-08 04:02:07 +0000697+ MS threadsafe getc is very slow (multiple layers of function calls before+
698 after each character, to lock+unlock the stream).
699+ The stream-locking functions are MS-internal -- can't access them from user
700 code.
701+ There's nothing Tim could find in the MS C or platform SDK libraries that
702 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000703+ MS fgets locks/unlocks only once per line; it's the only hook we have.
704
705So we use fgets for speed(!), despite that it's painful.
706
707MS realloc is also slow.
708
Tim Petersf29b64d2001-01-15 06:33:19 +0000709Reports from other platforms on this method vs getc_unlocked (which MS doesn't
710have):
711 Linux a wash
712 Solaris a wash
713 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000714
Tim Petersf29b64d2001-01-15 06:33:19 +0000715CAUTION: The C std isn't clear about this: in those cases where fgets
716writes something into the buffer, can it write into any position beyond the
717required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
718known on which it does; and it would be a strange way to code fgets. Still,
719getline_via_fgets may not work correctly if it does. The std test
720test_bufio.py should fail if platform fgets() routinely writes beyond the
721trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000722**************************************************************************/
723
Tim Petersf29b64d2001-01-15 06:33:19 +0000724/* Use this routine if told to, or by default on non-get_unlocked()
725 * platforms unless told not to. Yikes! Let's spell that out:
726 * On a platform with getc_unlocked():
727 * By default, use getc_unlocked().
728 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
729 * On a platform without getc_unlocked():
730 * By default, use fgets().
731 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
732 */
733#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
734#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000735#endif
736
Tim Petersf29b64d2001-01-15 06:33:19 +0000737#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
738#undef USE_FGETS_IN_GETLINE
739#endif
740
741#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000742static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000743getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000744{
Tim Peters15b83852001-01-08 00:53:12 +0000745/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000746 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
747 * to fill this much of the buffer with a known value in order to figure out
748 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
749 * than "most" lines, we waste time filling unused buffer slots. 100 is
750 * surely adequate for most peoples' email archives, chewing over source code,
751 * etc -- "regular old text files".
752 * MAXBUFSIZE is the maximum line length that lets us get away with the less
753 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
754 * cautions about boosting that. 300 was chosen because the worst real-life
755 * text-crunching job reported on Python-Dev was a mail-log crawler where over
756 * half the lines were 254 chars.
757 * INCBUFSIZE is the amount by which we grow the buffer, if MAXBUFSIZE isn't
758 * enough. It doesn't much matter what this is set to: we only get here for
759 * absurdly long lines anyway.
Tim Peters15b83852001-01-08 00:53:12 +0000760 */
Tim Peters142297a2001-01-15 10:36:56 +0000761#define INITBUFSIZE 100
762#define MAXBUFSIZE 300
Tim Peters86821b22001-01-07 21:19:34 +0000763#define INCBUFSIZE 1000
Tim Peters142297a2001-01-15 10:36:56 +0000764 char* p; /* temp */
765 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000766 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +0000767 char* pvfree; /* address of next free slot */
768 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +0000769 size_t nfree; /* # of free buffer slots; pvend-pvfree */
770 size_t total_v_size; /* total # of slots in buffer */
Tim Peters86821b22001-01-07 21:19:34 +0000771
Tim Peters15b83852001-01-08 00:53:12 +0000772 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +0000773 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +0000774 */
Tim Peters142297a2001-01-15 10:36:56 +0000775 total_v_size = INITBUFSIZE; /* start small and pray */
776 pvfree = buf;
777 for (;;) {
778 Py_BEGIN_ALLOW_THREADS
779 pvend = buf + total_v_size;
780 nfree = pvend - pvfree;
781 memset(pvfree, '\n', nfree);
782 p = fgets(pvfree, nfree, fp);
783 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +0000784
Tim Peters142297a2001-01-15 10:36:56 +0000785 if (p == NULL) {
786 clearerr(fp);
787 if (PyErr_CheckSignals())
788 return NULL;
789 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +0000790 return v;
791 }
Tim Peters142297a2001-01-15 10:36:56 +0000792 /* fgets read *something* */
793 p = memchr(pvfree, '\n', nfree);
794 if (p != NULL) {
795 /* Did the \n come from fgets or from us?
796 * Since fgets stops at the first \n, and then writes
797 * \0, if it's from fgets a \0 must be next. But if
798 * that's so, it could not have come from us, since
799 * the \n's we filled the buffer with have only more
800 * \n's to the right.
801 */
802 if (p+1 < pvend && *(p+1) == '\0') {
803 /* It's from fgets: we win! In particular,
804 * we haven't done any mallocs yet, and can
805 * build the final result on the first try.
806 */
807 ++p; /* include \n from fgets */
808 }
809 else {
810 /* Must be from us: fgets didn't fill the
811 * buffer and didn't find a newline, so it
812 * must be the last and newline-free line of
813 * the file.
814 */
815 assert(p > pvfree && *(p-1) == '\0');
816 --p; /* don't include \0 from fgets */
817 }
818 v = PyString_FromStringAndSize(buf, p - buf);
819 return v;
820 }
821 /* yuck: fgets overwrote all the newlines, i.e. the entire
822 * buffer. So this line isn't over yet, or maybe it is but
823 * we're exactly at EOF. If we haven't already, try using the
824 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +0000825 */
Tim Peters142297a2001-01-15 10:36:56 +0000826 assert(*(pvend-1) == '\0');
827 if (pvfree == buf) {
828 pvfree = pvend - 1; /* overwrite trailing null */
829 total_v_size = MAXBUFSIZE;
830 }
831 else
832 break;
Tim Peters86821b22001-01-07 21:19:34 +0000833 }
Tim Peters142297a2001-01-15 10:36:56 +0000834
835 /* The stack buffer isn't big enough; malloc a string object and read
836 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +0000837 */
Tim Peters142297a2001-01-15 10:36:56 +0000838 total_v_size = MAXBUFSIZE + INCBUFSIZE;
Tim Peters1c733232001-01-08 04:02:07 +0000839 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +0000840 if (v == NULL)
841 return v;
842 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +0000843 memcpy(BUF(v), buf, MAXBUFSIZE-1);
844 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +0000845
846 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +0000847 * after setting p one beyond the end of the line. The code here is
848 * very much like the code above, except reads into v's buffer; see
849 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +0000850 */
851 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +0000852 Py_BEGIN_ALLOW_THREADS
853 pvend = BUF(v) + total_v_size;
854 nfree = pvend - pvfree;
855 memset(pvfree, '\n', nfree);
856 p = fgets(pvfree, nfree, fp);
857 Py_END_ALLOW_THREADS
858
859 if (p == NULL) {
860 clearerr(fp);
861 if (PyErr_CheckSignals()) {
862 Py_DECREF(v);
863 return NULL;
864 }
865 p = pvfree;
866 break;
867 }
Tim Peters86821b22001-01-07 21:19:34 +0000868 p = memchr(pvfree, '\n', nfree);
869 if (p != NULL) {
870 if (p+1 < pvend && *(p+1) == '\0') {
871 /* \n came from fgets */
872 ++p;
873 break;
874 }
875 /* \n came from us; last line of file, no newline */
876 assert(p > pvfree && *(p-1) == '\0');
877 --p;
878 break;
879 }
880 /* expand buffer and try again */
881 assert(*(pvend-1) == '\0');
882 total_v_size += INCBUFSIZE;
883 if (total_v_size > INT_MAX) {
884 PyErr_SetString(PyExc_OverflowError,
885 "line is longer than a Python string can hold");
886 Py_DECREF(v);
887 return NULL;
888 }
889 if (_PyString_Resize(&v, (int)total_v_size) < 0)
890 return NULL;
891 /* overwrite the trailing null byte */
892 pvfree = BUF(v) + (total_v_size - INCBUFSIZE - 1);
893 }
894 if (BUF(v) + total_v_size != p)
895 _PyString_Resize(&v, p - BUF(v));
896 return v;
897#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +0000898#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +0000899#undef INCBUFSIZE
900}
Tim Petersf29b64d2001-01-15 06:33:19 +0000901#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000902
Guido van Rossum0bd24411991-04-04 15:21:57 +0000903/* Internal routine to get a line.
904 Size argument interpretation:
905 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +0000906 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +0000907*/
908
Guido van Rossum1187aa42001-01-05 14:43:05 +0000909#ifdef HAVE_GETC_UNLOCKED
910#define GETC(f) getc_unlocked(f)
911#define FLOCKFILE(f) flockfile(f)
912#define FUNLOCKFILE(f) funlockfile(f)
913#else
914#define GETC(f) getc(f)
915#define FLOCKFILE(f)
916#define FUNLOCKFILE(f)
917#endif
918
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000919static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000920get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000921{
Guido van Rossum1187aa42001-01-05 14:43:05 +0000922 FILE *fp = f->f_fp;
923 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +0000924 char *buf, *end;
Trent Mickf29f47b2000-08-11 19:02:59 +0000925 size_t n1, n2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000926 PyObject *v;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000927
Tim Petersf29b64d2001-01-15 06:33:19 +0000928#ifdef USE_FGETS_IN_GETLINE
Guido van Rossum86282062001-01-08 01:26:47 +0000929 if (n <= 0)
Tim Petersf29b64d2001-01-15 06:33:19 +0000930 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +0000931#endif
Guido van Rossum0bd24411991-04-04 15:21:57 +0000932 n2 = n > 0 ? n : 100;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000933 v = PyString_FromStringAndSize((char *)NULL, n2);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000934 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000935 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000936 buf = BUF(v);
937 end = buf + n2;
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000938
Guido van Rossumce5ba841991-03-06 13:06:18 +0000939 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +0000940 Py_BEGIN_ALLOW_THREADS
941 FLOCKFILE(fp);
942 while ((c = GETC(fp)) != EOF &&
943 (*buf++ = c) != '\n' &&
944 buf != end)
945 ;
946 FUNLOCKFILE(fp);
947 Py_END_ALLOW_THREADS
948 if (c == '\n')
949 break;
950 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +0000951 if (ferror(fp)) {
952 PyErr_SetFromErrno(PyExc_IOError);
953 clearerr(fp);
954 Py_DECREF(v);
955 return NULL;
956 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +0000957 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000958 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000959 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +0000960 return NULL;
961 }
Guido van Rossumce5ba841991-03-06 13:06:18 +0000962 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000963 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000964 /* Must be because buf == end */
965 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000966 break;
Guido van Rossum1187aa42001-01-05 14:43:05 +0000967 n1 = n2;
968 n2 += 1000;
969 if (n2 > INT_MAX) {
970 PyErr_SetString(PyExc_OverflowError,
971 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +0000972 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +0000973 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000974 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000975 if (_PyString_Resize(&v, n2) < 0)
976 return NULL;
977 buf = BUF(v) + n1;
978 end = BUF(v) + n2;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000979 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000980
Guido van Rossumce5ba841991-03-06 13:06:18 +0000981 n1 = buf - BUF(v);
982 if (n1 != n2)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000983 _PyString_Resize(&v, n1);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000984 return v;
985}
986
Guido van Rossum0bd24411991-04-04 15:21:57 +0000987/* External C interface */
988
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000989PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000990PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000991{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000992 PyObject *result;
993
Guido van Rossum3165fe61992-09-25 21:59:05 +0000994 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000995 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +0000996 return NULL;
997 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000998
999 if (PyFile_Check(f)) {
1000 if (((PyFileObject*)f)->f_fp == NULL)
1001 return err_closed();
1002 result = get_line((PyFileObject *)f, n);
1003 }
1004 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001005 PyObject *reader;
1006 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001007
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001008 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001009 if (reader == NULL)
1010 return NULL;
1011 if (n <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001012 args = Py_BuildValue("()");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001013 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001014 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001015 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001016 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001017 return NULL;
1018 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001019 result = PyEval_CallObject(reader, args);
1020 Py_DECREF(reader);
1021 Py_DECREF(args);
1022 if (result != NULL && !PyString_Check(result)) {
1023 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001024 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001025 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001026 "object.readline() returned non-string");
1027 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001028 }
1029
1030 if (n < 0 && result != NULL && PyString_Check(result)) {
1031 char *s = PyString_AS_STRING(result);
1032 int len = PyString_GET_SIZE(result);
1033 if (len == 0) {
1034 Py_DECREF(result);
1035 result = NULL;
1036 PyErr_SetString(PyExc_EOFError,
1037 "EOF when reading a line");
1038 }
1039 else if (s[len-1] == '\n') {
1040 if (result->ob_refcnt == 1)
1041 _PyString_Resize(&result, len-1);
1042 else {
1043 PyObject *v;
1044 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001045 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001046 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001047 }
1048 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001049 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001050 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001051}
1052
1053/* Python method */
1054
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001055static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001056file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001057{
Guido van Rossum789a1611997-05-10 22:33:55 +00001058 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001059
Guido van Rossumd7297e61992-07-06 14:19:26 +00001060 if (f->f_fp == NULL)
1061 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001062 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001063 return NULL;
1064 if (n == 0)
1065 return PyString_FromString("");
1066 if (n < 0)
1067 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001068 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001069}
1070
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001071static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001072file_xreadlines(PyFileObject *f)
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001073{
1074 static PyObject* xreadlines_function = NULL;
Tim Petersf29b64d2001-01-15 06:33:19 +00001075
Neal Norwitz649b7592002-01-01 19:07:13 +00001076 if (f->f_fp == NULL)
1077 return err_closed();
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001078 if (!xreadlines_function) {
1079 PyObject *xreadlines_module =
1080 PyImport_ImportModule("xreadlines");
1081 if(!xreadlines_module)
1082 return NULL;
1083
1084 xreadlines_function = PyObject_GetAttrString(xreadlines_module,
1085 "xreadlines");
1086 Py_DECREF(xreadlines_module);
1087 if(!xreadlines_function)
1088 return NULL;
1089 }
1090 return PyObject_CallFunction(xreadlines_function, "(O)", f);
1091}
1092
1093static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001094file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001095{
Guido van Rossum789a1611997-05-10 22:33:55 +00001096 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001097 PyObject *list;
1098 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001099 char small_buffer[SMALLCHUNK];
1100 char *buffer = small_buffer;
1101 size_t buffersize = SMALLCHUNK;
1102 PyObject *big_buffer = NULL;
1103 size_t nfilled = 0;
1104 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001105 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001106 char *p, *q, *end;
1107 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001108 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001109
Guido van Rossumd7297e61992-07-06 14:19:26 +00001110 if (f->f_fp == NULL)
1111 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001112 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001113 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001114 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001115 return NULL;
1116 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001117 if (shortread)
1118 nread = 0;
1119 else {
1120 Py_BEGIN_ALLOW_THREADS
1121 errno = 0;
1122 nread = fread(buffer+nfilled, 1,
1123 buffersize-nfilled, f->f_fp);
1124 Py_END_ALLOW_THREADS
1125 shortread = (nread < buffersize-nfilled);
1126 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001127 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001128 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001129 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001130 break;
1131 PyErr_SetFromErrno(PyExc_IOError);
1132 clearerr(f->f_fp);
1133 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001134 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001135 list = NULL;
1136 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001137 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001138 totalread += nread;
Guido van Rossum6263d541997-05-10 22:07:25 +00001139 p = memchr(buffer+nfilled, '\n', nread);
1140 if (p == NULL) {
1141 /* Need a larger buffer to fit this line */
1142 nfilled += nread;
1143 buffersize *= 2;
Trent Mickf29f47b2000-08-11 19:02:59 +00001144 if (buffersize > INT_MAX) {
1145 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001146 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001147 goto error;
1148 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001149 if (big_buffer == NULL) {
1150 /* Create the big buffer */
1151 big_buffer = PyString_FromStringAndSize(
1152 NULL, buffersize);
1153 if (big_buffer == NULL)
1154 goto error;
1155 buffer = PyString_AS_STRING(big_buffer);
1156 memcpy(buffer, small_buffer, nfilled);
1157 }
1158 else {
1159 /* Grow the big buffer */
1160 _PyString_Resize(&big_buffer, buffersize);
1161 buffer = PyString_AS_STRING(big_buffer);
1162 }
1163 continue;
1164 }
1165 end = buffer+nfilled+nread;
1166 q = buffer;
1167 do {
1168 /* Process complete lines */
1169 p++;
1170 line = PyString_FromStringAndSize(q, p-q);
1171 if (line == NULL)
1172 goto error;
1173 err = PyList_Append(list, line);
1174 Py_DECREF(line);
1175 if (err != 0)
1176 goto error;
1177 q = p;
1178 p = memchr(q, '\n', end-q);
1179 } while (p != NULL);
1180 /* Move the remaining incomplete line to the start */
1181 nfilled = end-q;
1182 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001183 if (sizehint > 0)
1184 if (totalread >= (size_t)sizehint)
1185 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001186 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001187 if (nfilled != 0) {
1188 /* Partial last line */
1189 line = PyString_FromStringAndSize(buffer, nfilled);
1190 if (line == NULL)
1191 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001192 if (sizehint > 0) {
1193 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001194 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001195 if (rest == NULL) {
1196 Py_DECREF(line);
1197 goto error;
1198 }
1199 PyString_Concat(&line, rest);
1200 Py_DECREF(rest);
1201 if (line == NULL)
1202 goto error;
1203 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001204 err = PyList_Append(list, line);
1205 Py_DECREF(line);
1206 if (err != 0)
1207 goto error;
1208 }
1209 cleanup:
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001210 if (big_buffer) {
Guido van Rossum6263d541997-05-10 22:07:25 +00001211 Py_DECREF(big_buffer);
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001212 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001213 return list;
1214}
1215
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001216static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001217file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001218{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001219 char *s;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001220 int n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001221 if (f->f_fp == NULL)
1222 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001223 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001224 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001225 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001226 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001227 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001228 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001229 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001230 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001231 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001232 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001233 return NULL;
1234 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001235 Py_INCREF(Py_None);
1236 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001237}
1238
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001239static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001240file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001241{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001242#define CHUNKSIZE 1000
1243 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001244 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001245 PyObject *result;
1246 int i, j, index, len, nwritten, islist;
1247
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001248 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001249 if (f->f_fp == NULL)
1250 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001251
1252 result = NULL;
1253 list = NULL;
1254 islist = PyList_Check(seq);
1255 if (islist)
1256 it = NULL;
1257 else {
1258 it = PyObject_GetIter(seq);
1259 if (it == NULL) {
1260 PyErr_SetString(PyExc_TypeError,
1261 "writelines() requires an iterable argument");
1262 return NULL;
1263 }
1264 /* From here on, fail by going to error, to reclaim "it". */
1265 list = PyList_New(CHUNKSIZE);
1266 if (list == NULL)
1267 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001268 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001269
1270 /* Strategy: slurp CHUNKSIZE lines into a private list,
1271 checking that they are all strings, then write that list
1272 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001273 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001274 if (islist) {
1275 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001276 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001277 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001278 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001279 j = PyList_GET_SIZE(list);
1280 }
1281 else {
1282 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001283 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001284 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001285 if (PyErr_Occurred())
1286 goto error;
1287 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001288 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001289 PyList_SetItem(list, j, line);
1290 }
1291 }
1292 if (j == 0)
1293 break;
1294
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001295 /* Check that all entries are indeed strings. If not,
1296 apply the same rules as for file.write() and
1297 convert the results to strings. This is slow, but
1298 seems to be the only way since all conversion APIs
1299 could potentially execute Python code. */
1300 for (i = 0; i < j; i++) {
1301 PyObject *v = PyList_GET_ITEM(list, i);
1302 if (!PyString_Check(v)) {
1303 const char *buffer;
1304 int len;
Tim Peters86821b22001-01-07 21:19:34 +00001305 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001306 PyObject_AsReadBuffer(v,
1307 (const void**)&buffer,
1308 &len)) ||
1309 PyObject_AsCharBuffer(v,
1310 &buffer,
1311 &len))) {
1312 PyErr_SetString(PyExc_TypeError,
Fred Drake661ea262000-10-24 19:57:45 +00001313 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001314 goto error;
1315 }
1316 line = PyString_FromStringAndSize(buffer,
1317 len);
1318 if (line == NULL)
1319 goto error;
1320 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001321 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001322 }
1323 }
1324
1325 /* Since we are releasing the global lock, the
1326 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001327 Py_BEGIN_ALLOW_THREADS
1328 f->f_softspace = 0;
1329 errno = 0;
1330 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001331 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001332 len = PyString_GET_SIZE(line);
1333 nwritten = fwrite(PyString_AS_STRING(line),
1334 1, len, f->f_fp);
1335 if (nwritten != len) {
1336 Py_BLOCK_THREADS
1337 PyErr_SetFromErrno(PyExc_IOError);
1338 clearerr(f->f_fp);
1339 goto error;
1340 }
1341 }
1342 Py_END_ALLOW_THREADS
1343
1344 if (j < CHUNKSIZE)
1345 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001346 }
1347
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001348 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001349 result = Py_None;
1350 error:
1351 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001352 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001353 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001354#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001355}
1356
Tim Petersefc3a3a2001-09-20 07:55:22 +00001357static char readline_doc[] =
1358"readline([size]) -> next line from the file, as a string.\n"
1359"\n"
1360"Retain newline. A non-negative size argument limits the maximum\n"
1361"number of bytes to return (an incomplete line may be returned then).\n"
1362"Return an empty string at EOF.";
1363
1364static char read_doc[] =
1365"read([size]) -> read at most size bytes, returned as a string.\n"
1366"\n"
1367"If the size argument is negative or omitted, read until EOF is reached.";
1368
1369static char write_doc[] =
1370"write(str) -> None. Write string str to file.\n"
1371"\n"
1372"Note that due to buffering, flush() or close() may be needed before\n"
1373"the file on disk reflects the data written.";
1374
1375static char fileno_doc[] =
1376"fileno() -> integer \"file descriptor\".\n"
1377"\n"
1378"This is needed for lower-level file interfaces, such os.read().";
1379
1380static char seek_doc[] =
1381"seek(offset[, whence]) -> None. Move to new file position.\n"
1382"\n"
1383"Argument offset is a byte count. Optional argument whence defaults to\n"
1384"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1385"(move relative to current position, positive or negative), and 2 (move\n"
1386"relative to end of file, usually negative, although many platforms allow\n"
1387"seeking beyond the end of a file).\n"
1388"\n"
1389"Note that not all file objects are seekable.";
1390
Guido van Rossumd7047b31995-01-02 19:07:15 +00001391#ifdef HAVE_FTRUNCATE
Tim Petersefc3a3a2001-09-20 07:55:22 +00001392static char truncate_doc[] =
1393"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1394"\n"
1395"Size defaults to the current file position, as returned by tell().";
Guido van Rossumd7047b31995-01-02 19:07:15 +00001396#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001397
1398static char tell_doc[] =
1399"tell() -> current file position, an integer (may be a long integer).";
1400
1401static char readinto_doc[] =
1402"readinto() -> Undocumented. Don't use this; it may go away.";
1403
1404static char readlines_doc[] =
1405"readlines([size]) -> list of strings, each a line from the file.\n"
1406"\n"
1407"Call readline() repeatedly and return a list of the lines so read.\n"
1408"The optional size argument, if given, is an approximate bound on the\n"
1409"total number of bytes in the lines returned.";
1410
1411static char xreadlines_doc[] =
1412"xreadlines() -> next line from the file, as a string.\n"
1413"\n"
1414"Equivalent to xreadlines.xreadlines(file). This is like readline(), but\n"
1415"often quicker, due to reading ahead internally.";
1416
1417static char writelines_doc[] =
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001418"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001419"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001420"Note that newlines are not added. The sequence can be any iterable object\n"
1421"producing strings. This is equivalent to calling write() for each string.";
Tim Petersefc3a3a2001-09-20 07:55:22 +00001422
1423static char flush_doc[] =
1424"flush() -> None. Flush the internal I/O buffer.";
1425
1426static char close_doc[] =
1427"close() -> None or (perhaps) an integer. Close the file.\n"
1428"\n"
1429"Sets data attribute .closed to true. A closed file cannot be used for\n"
1430"further I/O operations. close() may be called more than once without\n"
1431"error. Some kinds of file objects (for example, opened by popen())\n"
1432"may return an exit status upon closing.";
1433
1434static char isatty_doc[] =
1435"isatty() -> true or false. True if the file is connected to a tty device.";
1436
1437static PyMethodDef file_methods[] = {
1438 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1439 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001440 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001441 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1442 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
1443#ifdef HAVE_FTRUNCATE
1444 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
1445#endif
1446 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1447 {"readinto", (PyCFunction)file_readinto, METH_OLDARGS, readinto_doc},
1448 {"readlines", (PyCFunction)file_readlines, METH_VARARGS, readlines_doc},
1449 {"xreadlines", (PyCFunction)file_xreadlines, METH_NOARGS, xreadlines_doc},
1450 {"writelines", (PyCFunction)file_writelines, METH_O, writelines_doc},
1451 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1452 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1453 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001454 {NULL, NULL} /* sentinel */
1455};
1456
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001457#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001458
Guido van Rossum6f799372001-09-20 20:46:19 +00001459static PyMemberDef file_memberlist[] = {
1460 {"softspace", T_INT, OFF(f_softspace), 0,
1461 "flag indicating that a space needs to be printed; used by print"},
1462 {"mode", T_OBJECT, OFF(f_mode), RO,
1463 "file mode ('r', 'w', 'a', possibly with 'b' or '+' added)"},
1464 {"name", T_OBJECT, OFF(f_name), RO,
1465 "file name"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001466 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001467 {NULL} /* Sentinel */
1468};
1469
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001470static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001471get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001472{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001473 return PyInt_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001474}
1475
Guido van Rossum32d34c82001-09-20 21:45:26 +00001476static PyGetSetDef file_getsetlist[] = {
1477 {"closed", (getter)get_closed, NULL, "flag set if the file is closed"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001478 {0},
1479};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001480
Guido van Rossum65967252001-04-21 13:20:18 +00001481static PyObject *
Guido van Rossum5b021842001-05-22 16:48:37 +00001482file_getiter(PyObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001483{
Guido van Rossum5b021842001-05-22 16:48:37 +00001484 return PyObject_CallMethod(f, "xreadlines", "");
Guido van Rossum65967252001-04-21 13:20:18 +00001485}
1486
Tim Peters59c9a642001-09-13 05:38:56 +00001487static PyObject *
1488file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1489{
Tim Peters44410012001-09-14 03:26:08 +00001490 PyObject *self;
1491 static PyObject *not_yet_string;
1492
1493 assert(type != NULL && type->tp_alloc != NULL);
1494
1495 if (not_yet_string == NULL) {
1496 not_yet_string = PyString_FromString("<uninitialized file>");
1497 if (not_yet_string == NULL)
1498 return NULL;
1499 }
1500
1501 self = type->tp_alloc(type, 0);
1502 if (self != NULL) {
1503 /* Always fill in the name and mode, so that nobody else
1504 needs to special-case NULLs there. */
1505 Py_INCREF(not_yet_string);
1506 ((PyFileObject *)self)->f_name = not_yet_string;
1507 Py_INCREF(not_yet_string);
1508 ((PyFileObject *)self)->f_mode = not_yet_string;
1509 }
1510 return self;
1511}
1512
1513static int
1514file_init(PyObject *self, PyObject *args, PyObject *kwds)
1515{
1516 PyFileObject *foself = (PyFileObject *)self;
1517 int ret = 0;
Tim Peters59c9a642001-09-13 05:38:56 +00001518 static char *kwlist[] = {"name", "mode", "buffering", 0};
1519 char *name = NULL;
1520 char *mode = "r";
1521 int bufsize = -1;
Tim Peters44410012001-09-14 03:26:08 +00001522
1523 assert(PyFile_Check(self));
1524 if (foself->f_fp != NULL) {
1525 /* Have to close the existing file first. */
1526 PyObject *closeresult = file_close(foself);
1527 if (closeresult == NULL)
1528 return -1;
1529 Py_DECREF(closeresult);
1530 }
Tim Peters59c9a642001-09-13 05:38:56 +00001531
1532 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
1533 Py_FileSystemDefaultEncoding, &name,
1534 &mode, &bufsize))
Tim Peters44410012001-09-14 03:26:08 +00001535 return -1;
1536 if (fill_file_fields(foself, NULL, name, mode, fclose) == NULL)
1537 goto Error;
1538 if (open_the_file(foself, name, mode) == NULL)
1539 goto Error;
1540 PyFile_SetBufSize(self, bufsize);
1541 goto Done;
1542
1543Error:
1544 ret = -1;
1545 /* fall through */
1546Done:
Tim Peters59c9a642001-09-13 05:38:56 +00001547 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00001548 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00001549}
1550
Tim Peters59c9a642001-09-13 05:38:56 +00001551static char file_doc[] =
1552"file(name[, mode[, buffering]]) -> file object\n"
1553"\n"
1554"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
1555"writing or appending. The file will be created if it doesn't exist\n"
1556"when opened for writing or appending; it will be truncated when\n"
1557"opened for writing. Add a 'b' to the mode for binary files.\n"
1558"Add a '+' to the mode to allow simultaneous reading and writing.\n"
1559"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00001560"buffered, and larger numbers specify the buffer size.\n"
1561"Note: open() is an alias for file().\n";
Tim Peters59c9a642001-09-13 05:38:56 +00001562
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001563PyTypeObject PyFile_Type = {
1564 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001565 0,
1566 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001567 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001568 0,
Guido van Rossum65967252001-04-21 13:20:18 +00001569 (destructor)file_dealloc, /* tp_dealloc */
1570 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001571 0, /* tp_getattr */
1572 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00001573 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001574 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00001575 0, /* tp_as_number */
1576 0, /* tp_as_sequence */
1577 0, /* tp_as_mapping */
1578 0, /* tp_hash */
1579 0, /* tp_call */
1580 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001581 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum65967252001-04-21 13:20:18 +00001582 0, /* tp_setattro */
1583 0, /* tp_as_buffer */
Guido van Rossum9475a232001-10-05 20:51:39 +00001584 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00001585 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001586 0, /* tp_traverse */
1587 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00001588 0, /* tp_richcompare */
1589 0, /* tp_weaklistoffset */
Guido van Rossum5b021842001-05-22 16:48:37 +00001590 file_getiter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +00001591 0, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001592 file_methods, /* tp_methods */
1593 file_memberlist, /* tp_members */
1594 file_getsetlist, /* tp_getset */
1595 0, /* tp_base */
1596 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00001597 0, /* tp_descr_get */
1598 0, /* tp_descr_set */
1599 0, /* tp_dictoffset */
Tim Peters44410012001-09-14 03:26:08 +00001600 (initproc)file_init, /* tp_init */
1601 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00001602 file_new, /* tp_new */
Guido van Rossum9475a232001-10-05 20:51:39 +00001603 _PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001604};
Guido van Rossumeb183da1991-04-04 10:44:06 +00001605
1606/* Interface for the 'soft space' between print items. */
1607
1608int
Fred Drakefd99de62000-07-09 05:02:18 +00001609PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00001610{
1611 int oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001612 if (f == NULL) {
1613 /* Do nothing */
1614 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001615 else if (PyFile_Check(f)) {
1616 oldflag = ((PyFileObject *)f)->f_softspace;
1617 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001618 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001619 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001620 PyObject *v;
1621 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001622 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001623 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001624 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001625 if (PyInt_Check(v))
1626 oldflag = PyInt_AsLong(v);
1627 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001628 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001629 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001630 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001631 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001632 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001633 if (PyObject_SetAttrString(f, "softspace", v) != 0)
1634 PyErr_Clear();
1635 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001636 }
1637 }
Guido van Rossumeb183da1991-04-04 10:44:06 +00001638 return oldflag;
1639}
Guido van Rossum3165fe61992-09-25 21:59:05 +00001640
1641/* Interfaces to write objects/strings to file-like objects */
1642
1643int
Fred Drakefd99de62000-07-09 05:02:18 +00001644PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001645{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001646 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001647 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001648 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001649 return -1;
1650 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001651 else if (PyFile_Check(f)) {
1652 FILE *fp = PyFile_AsFile(f);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001653 if (fp == NULL) {
1654 err_closed();
1655 return -1;
1656 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001657 return PyObject_Print(v, fp, flags);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001658 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001659 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001660 if (writer == NULL)
1661 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00001662 if (flags & Py_PRINT_RAW) {
1663 if (PyUnicode_Check(v)) {
1664 value = v;
1665 Py_INCREF(value);
1666 } else
1667 value = PyObject_Str(v);
1668 }
1669 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001670 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00001671 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001672 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00001673 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001674 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001675 args = Py_BuildValue("(O)", value);
Guido van Rossume9eec541997-05-22 14:02:25 +00001676 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001677 Py_DECREF(value);
1678 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00001679 return -1;
1680 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001681 result = PyEval_CallObject(writer, args);
1682 Py_DECREF(args);
1683 Py_DECREF(value);
1684 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001685 if (result == NULL)
1686 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001687 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001688 return 0;
1689}
1690
Guido van Rossum27a60b11997-05-22 22:25:11 +00001691int
Tim Petersc1bbcb82001-11-28 22:13:25 +00001692PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001693{
1694 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00001695 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00001696 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00001697 PyErr_SetString(PyExc_SystemError,
1698 "null file for PyFile_WriteString");
1699 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001700 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001701 else if (PyFile_Check(f)) {
1702 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001703 if (fp == NULL) {
1704 err_closed();
1705 return -1;
1706 }
1707 fputs(s, fp);
1708 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001709 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001710 else if (!PyErr_Occurred()) {
1711 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001712 int err;
1713 if (v == NULL)
1714 return -1;
1715 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
1716 Py_DECREF(v);
1717 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001718 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00001719 else
1720 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001721}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001722
1723/* Try to get a file-descriptor from a Python object. If the object
1724 is an integer or long integer, its value is returned. If not, the
1725 object's fileno() method is called if it exists; the method must return
1726 an integer or long integer, which is returned as the file descriptor value.
1727 -1 is returned on failure.
1728*/
1729
1730int PyObject_AsFileDescriptor(PyObject *o)
1731{
1732 int fd;
1733 PyObject *meth;
1734
1735 if (PyInt_Check(o)) {
1736 fd = PyInt_AsLong(o);
1737 }
1738 else if (PyLong_Check(o)) {
1739 fd = PyLong_AsLong(o);
1740 }
1741 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
1742 {
1743 PyObject *fno = PyEval_CallObject(meth, NULL);
1744 Py_DECREF(meth);
1745 if (fno == NULL)
1746 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00001747
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001748 if (PyInt_Check(fno)) {
1749 fd = PyInt_AsLong(fno);
1750 Py_DECREF(fno);
1751 }
1752 else if (PyLong_Check(fno)) {
1753 fd = PyLong_AsLong(fno);
1754 Py_DECREF(fno);
1755 }
1756 else {
1757 PyErr_SetString(PyExc_TypeError,
1758 "fileno() returned a non-integer");
1759 Py_DECREF(fno);
1760 return -1;
1761 }
1762 }
1763 else {
1764 PyErr_SetString(PyExc_TypeError,
1765 "argument must be an int, or have a fileno() method.");
1766 return -1;
1767 }
1768
1769 if (fd < 0) {
1770 PyErr_Format(PyExc_ValueError,
1771 "file descriptor cannot be a negative integer (%i)",
1772 fd);
1773 return -1;
1774 }
1775 return fd;
1776}