blob: 125da700b89c5d41101ccb151a7bb373fdd66a88 [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
Trent Mickf29f47b2000-08-11 19:02:59 +000013/* can (almost fully) duplicate with _chsize, see file_truncate */
Guido van Rossumb8199141997-05-06 15:23:24 +000014#define HAVE_FTRUNCATE
15#endif
16
Guido van Rossumf2044e11998-04-28 16:05:59 +000017#ifdef macintosh
18#ifdef USE_GUSI
19#define HAVE_FTRUNCATE
20#endif
21#endif
22
Jack Jansene08dea191995-04-23 22:12:47 +000023#ifdef __MWERKS__
24/* Mwerks fopen() doesn't always set errno */
25#define NO_FOPEN_ERRNO
26#endif
Guido van Rossum295d1711995-02-19 15:55:19 +000027
Guido van Rossumc0b618a1997-05-02 03:12:38 +000028#define BUF(v) PyString_AS_STRING((PyStringObject *)v)
Guido van Rossumce5ba841991-03-06 13:06:18 +000029
Guido van Rossumff7e83d1999-08-27 20:39:37 +000030#ifndef DONT_HAVE_ERRNO_H
Guido van Rossumf1dc5661993-07-05 10:31:29 +000031#include <errno.h>
Guido van Rossumff7e83d1999-08-27 20:39:37 +000032#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000033
Trent Mickf29f47b2000-08-11 19:02:59 +000034
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000035typedef struct {
Guido van Rossumc0b618a1997-05-02 03:12:38 +000036 PyObject_HEAD
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000037 FILE *f_fp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000038 PyObject *f_name;
39 PyObject *f_mode;
Tim Petersdbd9ba62000-07-09 03:09:57 +000040 int (*f_close)(FILE *);
Guido van Rossumeb183da1991-04-04 10:44:06 +000041 int f_softspace; /* Flag used by 'print' command */
Guido van Rossum4c08d552000-03-10 22:55:18 +000042 int f_binary; /* Flag which indicates whether the file is open
43 open in binary (1) or test (0) mode */
Guido van Rossumc0b618a1997-05-02 03:12:38 +000044} PyFileObject;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000045
46FILE *
Fred Drakefd99de62000-07-09 05:02:18 +000047PyFile_AsFile(PyObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000048{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000049 if (f == NULL || !PyFile_Check(f))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000050 return NULL;
Guido van Rossum3165fe61992-09-25 21:59:05 +000051 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000052 return ((PyFileObject *)f)->f_fp;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000053}
54
Guido van Rossumc0b618a1997-05-02 03:12:38 +000055PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +000056PyFile_Name(PyObject *f)
Guido van Rossumdb3165e1993-10-18 17:06:59 +000057{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000058 if (f == NULL || !PyFile_Check(f))
Guido van Rossumdb3165e1993-10-18 17:06:59 +000059 return NULL;
60 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000061 return ((PyFileObject *)f)->f_name;
Guido van Rossumdb3165e1993-10-18 17:06:59 +000062}
63
Tim Peters59c9a642001-09-13 05:38:56 +000064
65static PyObject *
66fill_file_fields(PyFileObject *f, FILE *fp, char *name, char *mode,
67 int (*close)(FILE *))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000068{
Tim Peters59c9a642001-09-13 05:38:56 +000069 assert(f != NULL);
70 assert(PyFile_Check(f));
Tim Peters44410012001-09-14 03:26:08 +000071 assert(f->f_fp == NULL);
72
73 Py_DECREF(f->f_name);
74 Py_DECREF(f->f_mode);
Guido van Rossumc0b618a1997-05-02 03:12:38 +000075 f->f_name = PyString_FromString(name);
76 f->f_mode = PyString_FromString(mode);
Tim Peters44410012001-09-14 03:26:08 +000077
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +000078 f->f_close = close;
Guido van Rossumeb183da1991-04-04 10:44:06 +000079 f->f_softspace = 0;
Tim Peters59c9a642001-09-13 05:38:56 +000080 f->f_binary = strchr(mode,'b') != NULL;
Tim Peters44410012001-09-14 03:26:08 +000081
Tim Peters59c9a642001-09-13 05:38:56 +000082 if (f->f_name == NULL || f->f_mode == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000083 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000084 f->f_fp = fp;
Guido van Rossumc0b618a1997-05-02 03:12:38 +000085 return (PyObject *) f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000086}
87
Tim Peters59c9a642001-09-13 05:38:56 +000088static PyObject *
89open_the_file(PyFileObject *f, char *name, char *mode)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000090{
Tim Peters59c9a642001-09-13 05:38:56 +000091 assert(f != NULL);
92 assert(PyFile_Check(f));
93 assert(name != NULL);
94 assert(mode != NULL);
Tim Peters44410012001-09-14 03:26:08 +000095 assert(f->f_fp == NULL);
Tim Peters59c9a642001-09-13 05:38:56 +000096
Tim Peters8fa45672001-09-13 21:01:29 +000097 /* rexec.py can't stop a user from getting the file() constructor --
98 all they have to do is get *any* file object f, and then do
99 type(f). Here we prevent them from doing damage with it. */
100 if (PyEval_GetRestricted()) {
101 PyErr_SetString(PyExc_IOError,
102 "file() constructor not accessible in restricted mode");
103 return NULL;
104 }
Tim Petersa27a1502001-11-09 20:59:14 +0000105 errno = 0;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000106#ifdef HAVE_FOPENRF
Guido van Rossuma08095a1991-02-13 23:25:27 +0000107 if (*mode == '*') {
108 FILE *fopenRF();
109 f->f_fp = fopenRF(name, mode+1);
110 }
111 else
112#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000113 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000114 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000115 f->f_fp = fopen(name, mode);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000116 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000117 }
Guido van Rossuma08095a1991-02-13 23:25:27 +0000118 if (f->f_fp == NULL) {
Jack Jansene08dea191995-04-23 22:12:47 +0000119#ifdef NO_FOPEN_ERRNO
Jack Jansenb3be2162001-11-30 14:16:36 +0000120 /* Metroworks only, wich does not always sets errno */
Jeremy Hylton41c83212001-11-09 16:17:24 +0000121 if (errno == 0) {
Jack Jansenb3be2162001-11-30 14:16:36 +0000122 PyObject *v;
123 v = Py_BuildValue("(is)", 0, "Cannot open file");
124 if (v != NULL) {
125 PyErr_SetObject(PyExc_IOError, v);
126 Py_DECREF(v);
127 }
Jack Jansene08dea191995-04-23 22:12:47 +0000128 return NULL;
129 }
130#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000131 if (errno == EINVAL)
132 PyErr_Format(PyExc_IOError, "invalid argument: %s",
133 mode);
134 else
135 PyErr_SetFromErrnoWithFilename(PyExc_IOError, name);
Tim Peters59c9a642001-09-13 05:38:56 +0000136 f = NULL;
137 }
138 return (PyObject *)f;
139}
140
141PyObject *
142PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
143{
Tim Peters44410012001-09-14 03:26:08 +0000144 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
145 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000146 if (f != NULL) {
147 if (fill_file_fields(f, fp, name, mode, close) == NULL) {
148 Py_DECREF(f);
149 f = NULL;
150 }
151 }
152 return (PyObject *) f;
153}
154
155PyObject *
156PyFile_FromString(char *name, char *mode)
157{
158 extern int fclose(FILE *);
159 PyFileObject *f;
160
161 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
162 if (f != NULL) {
163 if (open_the_file(f, name, mode) == NULL) {
164 Py_DECREF(f);
165 f = NULL;
166 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000167 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000168 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000169}
170
Guido van Rossumb6775db1994-08-01 11:34:53 +0000171void
Fred Drakefd99de62000-07-09 05:02:18 +0000172PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000173{
174 if (bufsize >= 0) {
175#ifdef HAVE_SETVBUF
176 int type;
177 switch (bufsize) {
178 case 0:
179 type = _IONBF;
180 break;
181 case 1:
182 type = _IOLBF;
183 bufsize = BUFSIZ;
184 break;
185 default:
186 type = _IOFBF;
187 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000188 setvbuf(((PyFileObject *)f)->f_fp, (char *)NULL,
189 type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000190#else /* !HAVE_SETVBUF */
191 if (bufsize <= 1)
192 setbuf(((PyFileObject *)f)->f_fp, (char *)NULL);
193#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000194 }
195}
196
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000197static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000198err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000199{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000200 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000201 return NULL;
202}
203
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000204/* Methods */
205
206static void
Fred Drakefd99de62000-07-09 05:02:18 +0000207file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000208{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000209 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000210 Py_BEGIN_ALLOW_THREADS
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000211 (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000212 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000213 }
Tim Peters44410012001-09-14 03:26:08 +0000214 Py_XDECREF(f->f_name);
215 Py_XDECREF(f->f_mode);
Guido van Rossum9475a232001-10-05 20:51:39 +0000216 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000217}
218
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000219static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000220file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000221{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000222 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
223 f->f_fp == NULL ? "closed" : "open",
224 PyString_AsString(f->f_name),
225 PyString_AsString(f->f_mode),
226 f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000227}
228
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000229static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000230file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000231{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000232 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000233 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000234 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000235 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000236 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000237 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000238 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000239 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000240 f->f_fp = NULL;
241 }
Guido van Rossumfebd5511992-03-04 16:39:24 +0000242 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000243 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000244 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000245 return PyInt_FromLong((long)sts);
246 Py_INCREF(Py_None);
247 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000248}
249
Trent Mickf29f47b2000-08-11 19:02:59 +0000250
Guido van Rossumb8552162001-09-05 14:58:11 +0000251/* Our very own off_t-like type, 64-bit if possible */
252#if !defined(HAVE_LARGEFILE_SUPPORT)
253typedef off_t Py_off_t;
254#elif SIZEOF_OFF_T >= 8
255typedef off_t Py_off_t;
256#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000257typedef fpos_t Py_off_t;
258#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000259#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000260#endif
261
262
Trent Mickf29f47b2000-08-11 19:02:59 +0000263/* a portable fseek() function
264 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000265static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000266_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000267{
Guido van Rossumb8552162001-09-05 14:58:11 +0000268#if !defined(HAVE_LARGEFILE_SUPPORT)
269 return fseek(fp, offset, whence);
270#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000271 return fseeko(fp, offset, whence);
272#elif defined(HAVE_FSEEK64)
273 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000274#elif defined(__BEOS__)
275 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000276#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000277 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
278 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000279 fpos_t pos;
280 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000281 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000282#ifdef MS_WINDOWS
283 fflush(fp);
284 if (_lseeki64(fileno(fp), 0, 2) == -1)
285 return -1;
286#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000287 if (fseek(fp, 0, SEEK_END) != 0)
288 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000289#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000290 /* fall through */
291 case SEEK_CUR:
292 if (fgetpos(fp, &pos) != 0)
293 return -1;
294 offset += pos;
295 break;
296 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000297 }
298 return fsetpos(fp, &offset);
299#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000300#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000301#endif
302}
303
304
305/* a portable ftell() function
306 Return -1 on failure with errno set appropriately, current file
307 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000308static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000309_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000310{
Guido van Rossumb8552162001-09-05 14:58:11 +0000311#if !defined(HAVE_LARGEFILE_SUPPORT)
312 return ftell(fp);
313#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
314 return ftello(fp);
315#elif defined(HAVE_FTELL64)
316 return ftell64(fp);
317#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000318 fpos_t pos;
319 if (fgetpos(fp, &pos) != 0)
320 return -1;
321 return pos;
322#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000323#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000324#endif
325}
326
327
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000328static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000329file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000330{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000331 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000332 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000333 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000334 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000335
Guido van Rossumd7297e61992-07-06 14:19:26 +0000336 if (f->f_fp == NULL)
337 return err_closed();
338 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000339 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000340 return NULL;
341#if !defined(HAVE_LARGEFILE_SUPPORT)
342 offset = PyInt_AsLong(offobj);
343#else
344 offset = PyLong_Check(offobj) ?
345 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
346#endif
347 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000348 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000349
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000350 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000351 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000352 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000353 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000354
Guido van Rossumff4949e1992-08-05 19:58:53 +0000355 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000356 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000357 clearerr(f->f_fp);
358 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000359 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000360 Py_INCREF(Py_None);
361 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000362}
363
Trent Mickf29f47b2000-08-11 19:02:59 +0000364
Guido van Rossumd7047b31995-01-02 19:07:15 +0000365#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000366static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000367file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000368{
Guido van Rossumd7047b31995-01-02 19:07:15 +0000369 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000370 Py_off_t newsize;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000371 PyObject *newsizeobj;
Tim Peters86821b22001-01-07 21:19:34 +0000372
Guido van Rossumd7047b31995-01-02 19:07:15 +0000373 if (f->f_fp == NULL)
374 return err_closed();
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000375 newsizeobj = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +0000376 if (!PyArg_ParseTuple(args, "|O:truncate", &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000377 return NULL;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000378 if (newsizeobj != NULL) {
379#if !defined(HAVE_LARGEFILE_SUPPORT)
380 newsize = PyInt_AsLong(newsizeobj);
381#else
382 newsize = PyLong_Check(newsizeobj) ?
383 PyLong_AsLongLong(newsizeobj) :
384 PyInt_AsLong(newsizeobj);
385#endif
386 if (PyErr_Occurred())
387 return NULL;
388 } else {
389 /* Default to current position*/
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000390 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000391 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000392 newsize = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000393 Py_END_ALLOW_THREADS
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000394 if (newsize == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000395 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumd7047b31995-01-02 19:07:15 +0000396 clearerr(f->f_fp);
397 return NULL;
398 }
399 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000400 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000401 errno = 0;
402 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000403 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000404 if (ret != 0) goto onioerror;
405
406#ifdef MS_WIN32
407 /* can use _chsize; if, however, the newsize overflows 32-bits then
408 _chsize is *not* adequate; in this case, an OverflowError is raised */
409 if (newsize > LONG_MAX) {
410 PyErr_SetString(PyExc_OverflowError,
411 "the new size is too long for _chsize (it is limited to 32-bit values)");
Guido van Rossumd7047b31995-01-02 19:07:15 +0000412 return NULL;
Trent Mickf29f47b2000-08-11 19:02:59 +0000413 } else {
414 Py_BEGIN_ALLOW_THREADS
415 errno = 0;
Tim Peters6e13a562001-09-06 00:32:15 +0000416 ret = _chsize(fileno(f->f_fp), (long)newsize);
Trent Mickf29f47b2000-08-11 19:02:59 +0000417 Py_END_ALLOW_THREADS
418 if (ret != 0) goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000419 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000420#else
421 Py_BEGIN_ALLOW_THREADS
422 errno = 0;
423 ret = ftruncate(fileno(f->f_fp), newsize);
424 Py_END_ALLOW_THREADS
425 if (ret != 0) goto onioerror;
426#endif /* !MS_WIN32 */
Tim Peters86821b22001-01-07 21:19:34 +0000427
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000428 Py_INCREF(Py_None);
429 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000430
431onioerror:
432 PyErr_SetFromErrno(PyExc_IOError);
433 clearerr(f->f_fp);
434 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000435}
436#endif /* HAVE_FTRUNCATE */
437
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000438static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000439file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000440{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000441 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000442
Guido van Rossumd7297e61992-07-06 14:19:26 +0000443 if (f->f_fp == NULL)
444 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000445 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000446 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000447 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000448 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000449 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000450 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000451 clearerr(f->f_fp);
452 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000453 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000454#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000455 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000456#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000457 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000458#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000459}
460
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000461static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000462file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000463{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000464 if (f->f_fp == NULL)
465 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000466 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000467}
468
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000469static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000470file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000471{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000472 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000473
Guido van Rossumd7297e61992-07-06 14:19:26 +0000474 if (f->f_fp == NULL)
475 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000476 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000477 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000478 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000479 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000480 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000481 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000482 clearerr(f->f_fp);
483 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000484 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000485 Py_INCREF(Py_None);
486 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000487}
488
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000489static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000490file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000491{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000492 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000493 if (f->f_fp == NULL)
494 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000495 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000496 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000497 Py_END_ALLOW_THREADS
498 return PyInt_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000499}
500
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000501
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000502#if BUFSIZ < 8192
503#define SMALLCHUNK 8192
504#else
505#define SMALLCHUNK BUFSIZ
506#endif
507
Guido van Rossum3c259041999-01-14 19:00:14 +0000508#if SIZEOF_INT < 4
509#define BIGCHUNK (512 * 32)
510#else
511#define BIGCHUNK (512 * 1024)
512#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000513
514static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000515new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000516{
517#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000518 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000519 struct stat st;
520 if (fstat(fileno(f->f_fp), &st) == 0) {
521 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000522 /* The following is not a bug: we really need to call lseek()
523 *and* ftell(). The reason is that some stdio libraries
524 mistakenly flush their buffer when ftell() is called and
525 the lseek() call it makes fails, thereby throwing away
526 data that cannot be recovered in any way. To avoid this,
527 we first test lseek(), and only call ftell() if lseek()
528 works. We can't use the lseek() value either, because we
529 need to take the amount of buffered data into account.
530 (Yet another reason why stdio stinks. :-) */
Jack Jansen2771b5b2001-10-10 22:03:27 +0000531#ifdef USE_GUSI2
532 pos = lseek(fileno(f->f_fp), 1L, SEEK_CUR);
533 pos = lseek(fileno(f->f_fp), -1L, SEEK_CUR);
534#else
Guido van Rossum91aaa921998-05-05 22:21:35 +0000535 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000536#endif
537 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000538 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000539 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000540 if (pos < 0)
541 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000542 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000543 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000544 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000545 }
546#endif
547 if (currentsize > SMALLCHUNK) {
548 /* Keep doubling until we reach BIGCHUNK;
549 then keep adding BIGCHUNK. */
550 if (currentsize <= BIGCHUNK)
551 return currentsize + currentsize;
552 else
553 return currentsize + BIGCHUNK;
554 }
555 return currentsize + SMALLCHUNK;
556}
557
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000558static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000559file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000560{
Guido van Rossum789a1611997-05-10 22:33:55 +0000561 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000562 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000563 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000564
Guido van Rossumd7297e61992-07-06 14:19:26 +0000565 if (f->f_fp == NULL)
566 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +0000567 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000568 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000569 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000570 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000571 else
572 buffersize = bytesrequested;
Trent Mickf29f47b2000-08-11 19:02:59 +0000573 if (buffersize > INT_MAX) {
574 PyErr_SetString(PyExc_OverflowError,
575 "requested number of bytes is more than a Python string can hold");
576 return NULL;
577 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000578 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000579 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000580 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000581 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000582 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000583 Py_BEGIN_ALLOW_THREADS
584 errno = 0;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000585 chunksize = fread(BUF(v) + bytesread, 1,
586 buffersize - bytesread, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000587 Py_END_ALLOW_THREADS
588 if (chunksize == 0) {
589 if (!ferror(f->f_fp))
590 break;
591 PyErr_SetFromErrno(PyExc_IOError);
592 clearerr(f->f_fp);
593 Py_DECREF(v);
594 return NULL;
595 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000596 bytesread += chunksize;
597 if (bytesread < buffersize)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000598 break;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000599 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000600 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000601 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000602 return NULL;
603 }
604 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000605 if (bytesread != buffersize)
606 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000607 return v;
608}
609
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000610static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000611file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000612{
613 char *ptr;
Guido van Rossum00ebd462001-10-23 21:25:24 +0000614 int ntodo;
615 size_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000616
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000617 if (f->f_fp == NULL)
618 return err_closed();
619 if (!PyArg_Parse(args, "w#", &ptr, &ntodo))
620 return NULL;
621 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000622 while (ntodo > 0) {
623 Py_BEGIN_ALLOW_THREADS
624 errno = 0;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000625 nnow = fread(ptr+ndone, 1, ntodo, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000626 Py_END_ALLOW_THREADS
627 if (nnow == 0) {
628 if (!ferror(f->f_fp))
629 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000630 PyErr_SetFromErrno(PyExc_IOError);
631 clearerr(f->f_fp);
632 return NULL;
633 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000634 ndone += nnow;
635 ntodo -= nnow;
636 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000637 return PyInt_FromLong((long)ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000638}
639
Tim Peters86821b22001-01-07 21:19:34 +0000640/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000641Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000642
643Under MSVC 6:
644
Tim Peters1c733232001-01-08 04:02:07 +0000645+ MS threadsafe getc is very slow (multiple layers of function calls before+
646 after each character, to lock+unlock the stream).
647+ The stream-locking functions are MS-internal -- can't access them from user
648 code.
649+ There's nothing Tim could find in the MS C or platform SDK libraries that
650 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000651+ MS fgets locks/unlocks only once per line; it's the only hook we have.
652
653So we use fgets for speed(!), despite that it's painful.
654
655MS realloc is also slow.
656
Tim Petersf29b64d2001-01-15 06:33:19 +0000657Reports from other platforms on this method vs getc_unlocked (which MS doesn't
658have):
659 Linux a wash
660 Solaris a wash
661 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000662
Tim Petersf29b64d2001-01-15 06:33:19 +0000663CAUTION: The C std isn't clear about this: in those cases where fgets
664writes something into the buffer, can it write into any position beyond the
665required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
666known on which it does; and it would be a strange way to code fgets. Still,
667getline_via_fgets may not work correctly if it does. The std test
668test_bufio.py should fail if platform fgets() routinely writes beyond the
669trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000670**************************************************************************/
671
Tim Petersf29b64d2001-01-15 06:33:19 +0000672/* Use this routine if told to, or by default on non-get_unlocked()
673 * platforms unless told not to. Yikes! Let's spell that out:
674 * On a platform with getc_unlocked():
675 * By default, use getc_unlocked().
676 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
677 * On a platform without getc_unlocked():
678 * By default, use fgets().
679 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
680 */
681#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
682#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000683#endif
684
Tim Petersf29b64d2001-01-15 06:33:19 +0000685#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
686#undef USE_FGETS_IN_GETLINE
687#endif
688
689#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000690static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000691getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000692{
Tim Peters15b83852001-01-08 00:53:12 +0000693/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000694 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
695 * to fill this much of the buffer with a known value in order to figure out
696 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
697 * than "most" lines, we waste time filling unused buffer slots. 100 is
698 * surely adequate for most peoples' email archives, chewing over source code,
699 * etc -- "regular old text files".
700 * MAXBUFSIZE is the maximum line length that lets us get away with the less
701 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
702 * cautions about boosting that. 300 was chosen because the worst real-life
703 * text-crunching job reported on Python-Dev was a mail-log crawler where over
704 * half the lines were 254 chars.
705 * INCBUFSIZE is the amount by which we grow the buffer, if MAXBUFSIZE isn't
706 * enough. It doesn't much matter what this is set to: we only get here for
707 * absurdly long lines anyway.
Tim Peters15b83852001-01-08 00:53:12 +0000708 */
Tim Peters142297a2001-01-15 10:36:56 +0000709#define INITBUFSIZE 100
710#define MAXBUFSIZE 300
Tim Peters86821b22001-01-07 21:19:34 +0000711#define INCBUFSIZE 1000
Tim Peters142297a2001-01-15 10:36:56 +0000712 char* p; /* temp */
713 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000714 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +0000715 char* pvfree; /* address of next free slot */
716 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +0000717 size_t nfree; /* # of free buffer slots; pvend-pvfree */
718 size_t total_v_size; /* total # of slots in buffer */
Tim Peters86821b22001-01-07 21:19:34 +0000719
Tim Peters15b83852001-01-08 00:53:12 +0000720 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +0000721 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +0000722 */
Tim Peters142297a2001-01-15 10:36:56 +0000723 total_v_size = INITBUFSIZE; /* start small and pray */
724 pvfree = buf;
725 for (;;) {
726 Py_BEGIN_ALLOW_THREADS
727 pvend = buf + total_v_size;
728 nfree = pvend - pvfree;
729 memset(pvfree, '\n', nfree);
730 p = fgets(pvfree, nfree, fp);
731 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +0000732
Tim Peters142297a2001-01-15 10:36:56 +0000733 if (p == NULL) {
734 clearerr(fp);
735 if (PyErr_CheckSignals())
736 return NULL;
737 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +0000738 return v;
739 }
Tim Peters142297a2001-01-15 10:36:56 +0000740 /* fgets read *something* */
741 p = memchr(pvfree, '\n', nfree);
742 if (p != NULL) {
743 /* Did the \n come from fgets or from us?
744 * Since fgets stops at the first \n, and then writes
745 * \0, if it's from fgets a \0 must be next. But if
746 * that's so, it could not have come from us, since
747 * the \n's we filled the buffer with have only more
748 * \n's to the right.
749 */
750 if (p+1 < pvend && *(p+1) == '\0') {
751 /* It's from fgets: we win! In particular,
752 * we haven't done any mallocs yet, and can
753 * build the final result on the first try.
754 */
755 ++p; /* include \n from fgets */
756 }
757 else {
758 /* Must be from us: fgets didn't fill the
759 * buffer and didn't find a newline, so it
760 * must be the last and newline-free line of
761 * the file.
762 */
763 assert(p > pvfree && *(p-1) == '\0');
764 --p; /* don't include \0 from fgets */
765 }
766 v = PyString_FromStringAndSize(buf, p - buf);
767 return v;
768 }
769 /* yuck: fgets overwrote all the newlines, i.e. the entire
770 * buffer. So this line isn't over yet, or maybe it is but
771 * we're exactly at EOF. If we haven't already, try using the
772 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +0000773 */
Tim Peters142297a2001-01-15 10:36:56 +0000774 assert(*(pvend-1) == '\0');
775 if (pvfree == buf) {
776 pvfree = pvend - 1; /* overwrite trailing null */
777 total_v_size = MAXBUFSIZE;
778 }
779 else
780 break;
Tim Peters86821b22001-01-07 21:19:34 +0000781 }
Tim Peters142297a2001-01-15 10:36:56 +0000782
783 /* The stack buffer isn't big enough; malloc a string object and read
784 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +0000785 */
Tim Peters142297a2001-01-15 10:36:56 +0000786 total_v_size = MAXBUFSIZE + INCBUFSIZE;
Tim Peters1c733232001-01-08 04:02:07 +0000787 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +0000788 if (v == NULL)
789 return v;
790 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +0000791 memcpy(BUF(v), buf, MAXBUFSIZE-1);
792 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +0000793
794 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +0000795 * after setting p one beyond the end of the line. The code here is
796 * very much like the code above, except reads into v's buffer; see
797 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +0000798 */
799 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +0000800 Py_BEGIN_ALLOW_THREADS
801 pvend = BUF(v) + total_v_size;
802 nfree = pvend - pvfree;
803 memset(pvfree, '\n', nfree);
804 p = fgets(pvfree, nfree, fp);
805 Py_END_ALLOW_THREADS
806
807 if (p == NULL) {
808 clearerr(fp);
809 if (PyErr_CheckSignals()) {
810 Py_DECREF(v);
811 return NULL;
812 }
813 p = pvfree;
814 break;
815 }
Tim Peters86821b22001-01-07 21:19:34 +0000816 p = memchr(pvfree, '\n', nfree);
817 if (p != NULL) {
818 if (p+1 < pvend && *(p+1) == '\0') {
819 /* \n came from fgets */
820 ++p;
821 break;
822 }
823 /* \n came from us; last line of file, no newline */
824 assert(p > pvfree && *(p-1) == '\0');
825 --p;
826 break;
827 }
828 /* expand buffer and try again */
829 assert(*(pvend-1) == '\0');
830 total_v_size += INCBUFSIZE;
831 if (total_v_size > INT_MAX) {
832 PyErr_SetString(PyExc_OverflowError,
833 "line is longer than a Python string can hold");
834 Py_DECREF(v);
835 return NULL;
836 }
837 if (_PyString_Resize(&v, (int)total_v_size) < 0)
838 return NULL;
839 /* overwrite the trailing null byte */
840 pvfree = BUF(v) + (total_v_size - INCBUFSIZE - 1);
841 }
842 if (BUF(v) + total_v_size != p)
843 _PyString_Resize(&v, p - BUF(v));
844 return v;
845#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +0000846#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +0000847#undef INCBUFSIZE
848}
Tim Petersf29b64d2001-01-15 06:33:19 +0000849#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000850
Guido van Rossum0bd24411991-04-04 15:21:57 +0000851/* Internal routine to get a line.
852 Size argument interpretation:
853 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +0000854 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +0000855*/
856
Guido van Rossum1187aa42001-01-05 14:43:05 +0000857#ifdef HAVE_GETC_UNLOCKED
858#define GETC(f) getc_unlocked(f)
859#define FLOCKFILE(f) flockfile(f)
860#define FUNLOCKFILE(f) funlockfile(f)
861#else
862#define GETC(f) getc(f)
863#define FLOCKFILE(f)
864#define FUNLOCKFILE(f)
865#endif
866
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000867static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000868get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000869{
Guido van Rossum1187aa42001-01-05 14:43:05 +0000870 FILE *fp = f->f_fp;
871 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +0000872 char *buf, *end;
Trent Mickf29f47b2000-08-11 19:02:59 +0000873 size_t n1, n2;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000874 PyObject *v;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000875
Tim Petersf29b64d2001-01-15 06:33:19 +0000876#ifdef USE_FGETS_IN_GETLINE
Guido van Rossum86282062001-01-08 01:26:47 +0000877 if (n <= 0)
Tim Petersf29b64d2001-01-15 06:33:19 +0000878 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +0000879#endif
Guido van Rossum0bd24411991-04-04 15:21:57 +0000880 n2 = n > 0 ? n : 100;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000881 v = PyString_FromStringAndSize((char *)NULL, n2);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000882 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000883 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000884 buf = BUF(v);
885 end = buf + n2;
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000886
Guido van Rossumce5ba841991-03-06 13:06:18 +0000887 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +0000888 Py_BEGIN_ALLOW_THREADS
889 FLOCKFILE(fp);
890 while ((c = GETC(fp)) != EOF &&
891 (*buf++ = c) != '\n' &&
892 buf != end)
893 ;
894 FUNLOCKFILE(fp);
895 Py_END_ALLOW_THREADS
896 if (c == '\n')
897 break;
898 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +0000899 if (ferror(fp)) {
900 PyErr_SetFromErrno(PyExc_IOError);
901 clearerr(fp);
902 Py_DECREF(v);
903 return NULL;
904 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +0000905 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000906 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000907 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +0000908 return NULL;
909 }
Guido van Rossumce5ba841991-03-06 13:06:18 +0000910 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000911 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000912 /* Must be because buf == end */
913 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000914 break;
Guido van Rossum1187aa42001-01-05 14:43:05 +0000915 n1 = n2;
916 n2 += 1000;
917 if (n2 > INT_MAX) {
918 PyErr_SetString(PyExc_OverflowError,
919 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +0000920 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +0000921 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000922 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000923 if (_PyString_Resize(&v, n2) < 0)
924 return NULL;
925 buf = BUF(v) + n1;
926 end = BUF(v) + n2;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000927 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000928
Guido van Rossumce5ba841991-03-06 13:06:18 +0000929 n1 = buf - BUF(v);
930 if (n1 != n2)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000931 _PyString_Resize(&v, n1);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000932 return v;
933}
934
Guido van Rossum0bd24411991-04-04 15:21:57 +0000935/* External C interface */
936
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000937PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000938PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000939{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000940 PyObject *result;
941
Guido van Rossum3165fe61992-09-25 21:59:05 +0000942 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000943 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +0000944 return NULL;
945 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000946
947 if (PyFile_Check(f)) {
948 if (((PyFileObject*)f)->f_fp == NULL)
949 return err_closed();
950 result = get_line((PyFileObject *)f, n);
951 }
952 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000953 PyObject *reader;
954 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000955
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000956 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +0000957 if (reader == NULL)
958 return NULL;
959 if (n <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000960 args = Py_BuildValue("()");
Guido van Rossum3165fe61992-09-25 21:59:05 +0000961 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000962 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000963 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000964 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000965 return NULL;
966 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000967 result = PyEval_CallObject(reader, args);
968 Py_DECREF(reader);
969 Py_DECREF(args);
970 if (result != NULL && !PyString_Check(result)) {
971 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +0000972 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000973 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +0000974 "object.readline() returned non-string");
975 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000976 }
977
978 if (n < 0 && result != NULL && PyString_Check(result)) {
979 char *s = PyString_AS_STRING(result);
980 int len = PyString_GET_SIZE(result);
981 if (len == 0) {
982 Py_DECREF(result);
983 result = NULL;
984 PyErr_SetString(PyExc_EOFError,
985 "EOF when reading a line");
986 }
987 else if (s[len-1] == '\n') {
988 if (result->ob_refcnt == 1)
989 _PyString_Resize(&result, len-1);
990 else {
991 PyObject *v;
992 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000993 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000994 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +0000995 }
996 }
Guido van Rossum3165fe61992-09-25 21:59:05 +0000997 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +0000998 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000999}
1000
1001/* Python method */
1002
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001003static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001004file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001005{
Guido van Rossum789a1611997-05-10 22:33:55 +00001006 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001007
Guido van Rossumd7297e61992-07-06 14:19:26 +00001008 if (f->f_fp == NULL)
1009 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001010 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001011 return NULL;
1012 if (n == 0)
1013 return PyString_FromString("");
1014 if (n < 0)
1015 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001016 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001017}
1018
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001019static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001020file_xreadlines(PyFileObject *f)
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001021{
1022 static PyObject* xreadlines_function = NULL;
Tim Petersf29b64d2001-01-15 06:33:19 +00001023
Neal Norwitz649b7592002-01-01 19:07:13 +00001024 if (f->f_fp == NULL)
1025 return err_closed();
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001026 if (!xreadlines_function) {
1027 PyObject *xreadlines_module =
1028 PyImport_ImportModule("xreadlines");
1029 if(!xreadlines_module)
1030 return NULL;
1031
1032 xreadlines_function = PyObject_GetAttrString(xreadlines_module,
1033 "xreadlines");
1034 Py_DECREF(xreadlines_module);
1035 if(!xreadlines_function)
1036 return NULL;
1037 }
1038 return PyObject_CallFunction(xreadlines_function, "(O)", f);
1039}
1040
1041static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001042file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001043{
Guido van Rossum789a1611997-05-10 22:33:55 +00001044 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001045 PyObject *list;
1046 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001047 char small_buffer[SMALLCHUNK];
1048 char *buffer = small_buffer;
1049 size_t buffersize = SMALLCHUNK;
1050 PyObject *big_buffer = NULL;
1051 size_t nfilled = 0;
1052 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001053 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001054 char *p, *q, *end;
1055 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001056 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001057
Guido van Rossumd7297e61992-07-06 14:19:26 +00001058 if (f->f_fp == NULL)
1059 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001060 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001061 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001062 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001063 return NULL;
1064 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001065 if (shortread)
1066 nread = 0;
1067 else {
1068 Py_BEGIN_ALLOW_THREADS
1069 errno = 0;
1070 nread = fread(buffer+nfilled, 1,
1071 buffersize-nfilled, f->f_fp);
1072 Py_END_ALLOW_THREADS
1073 shortread = (nread < buffersize-nfilled);
1074 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001075 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001076 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001077 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001078 break;
1079 PyErr_SetFromErrno(PyExc_IOError);
1080 clearerr(f->f_fp);
1081 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001082 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001083 list = NULL;
1084 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001085 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001086 totalread += nread;
Guido van Rossum6263d541997-05-10 22:07:25 +00001087 p = memchr(buffer+nfilled, '\n', nread);
1088 if (p == NULL) {
1089 /* Need a larger buffer to fit this line */
1090 nfilled += nread;
1091 buffersize *= 2;
Trent Mickf29f47b2000-08-11 19:02:59 +00001092 if (buffersize > INT_MAX) {
1093 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001094 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001095 goto error;
1096 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001097 if (big_buffer == NULL) {
1098 /* Create the big buffer */
1099 big_buffer = PyString_FromStringAndSize(
1100 NULL, buffersize);
1101 if (big_buffer == NULL)
1102 goto error;
1103 buffer = PyString_AS_STRING(big_buffer);
1104 memcpy(buffer, small_buffer, nfilled);
1105 }
1106 else {
1107 /* Grow the big buffer */
1108 _PyString_Resize(&big_buffer, buffersize);
1109 buffer = PyString_AS_STRING(big_buffer);
1110 }
1111 continue;
1112 }
1113 end = buffer+nfilled+nread;
1114 q = buffer;
1115 do {
1116 /* Process complete lines */
1117 p++;
1118 line = PyString_FromStringAndSize(q, p-q);
1119 if (line == NULL)
1120 goto error;
1121 err = PyList_Append(list, line);
1122 Py_DECREF(line);
1123 if (err != 0)
1124 goto error;
1125 q = p;
1126 p = memchr(q, '\n', end-q);
1127 } while (p != NULL);
1128 /* Move the remaining incomplete line to the start */
1129 nfilled = end-q;
1130 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001131 if (sizehint > 0)
1132 if (totalread >= (size_t)sizehint)
1133 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001134 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001135 if (nfilled != 0) {
1136 /* Partial last line */
1137 line = PyString_FromStringAndSize(buffer, nfilled);
1138 if (line == NULL)
1139 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001140 if (sizehint > 0) {
1141 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001142 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001143 if (rest == NULL) {
1144 Py_DECREF(line);
1145 goto error;
1146 }
1147 PyString_Concat(&line, rest);
1148 Py_DECREF(rest);
1149 if (line == NULL)
1150 goto error;
1151 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001152 err = PyList_Append(list, line);
1153 Py_DECREF(line);
1154 if (err != 0)
1155 goto error;
1156 }
1157 cleanup:
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001158 if (big_buffer) {
Guido van Rossum6263d541997-05-10 22:07:25 +00001159 Py_DECREF(big_buffer);
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001160 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001161 return list;
1162}
1163
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001164static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001165file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001166{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001167 char *s;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001168 int n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001169 if (f->f_fp == NULL)
1170 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001171 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001172 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001173 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001174 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001175 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001176 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001177 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001178 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001179 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001180 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001181 return NULL;
1182 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001183 Py_INCREF(Py_None);
1184 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001185}
1186
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001187static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001188file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001189{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001190#define CHUNKSIZE 1000
1191 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001192 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001193 PyObject *result;
1194 int i, j, index, len, nwritten, islist;
1195
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001196 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001197 if (f->f_fp == NULL)
1198 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001199
1200 result = NULL;
1201 list = NULL;
1202 islist = PyList_Check(seq);
1203 if (islist)
1204 it = NULL;
1205 else {
1206 it = PyObject_GetIter(seq);
1207 if (it == NULL) {
1208 PyErr_SetString(PyExc_TypeError,
1209 "writelines() requires an iterable argument");
1210 return NULL;
1211 }
1212 /* From here on, fail by going to error, to reclaim "it". */
1213 list = PyList_New(CHUNKSIZE);
1214 if (list == NULL)
1215 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001216 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001217
1218 /* Strategy: slurp CHUNKSIZE lines into a private list,
1219 checking that they are all strings, then write that list
1220 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001221 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001222 if (islist) {
1223 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001224 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001225 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001226 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001227 j = PyList_GET_SIZE(list);
1228 }
1229 else {
1230 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001231 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001232 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001233 if (PyErr_Occurred())
1234 goto error;
1235 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001236 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001237 PyList_SetItem(list, j, line);
1238 }
1239 }
1240 if (j == 0)
1241 break;
1242
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001243 /* Check that all entries are indeed strings. If not,
1244 apply the same rules as for file.write() and
1245 convert the results to strings. This is slow, but
1246 seems to be the only way since all conversion APIs
1247 could potentially execute Python code. */
1248 for (i = 0; i < j; i++) {
1249 PyObject *v = PyList_GET_ITEM(list, i);
1250 if (!PyString_Check(v)) {
1251 const char *buffer;
1252 int len;
Tim Peters86821b22001-01-07 21:19:34 +00001253 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001254 PyObject_AsReadBuffer(v,
1255 (const void**)&buffer,
1256 &len)) ||
1257 PyObject_AsCharBuffer(v,
1258 &buffer,
1259 &len))) {
1260 PyErr_SetString(PyExc_TypeError,
Fred Drake661ea262000-10-24 19:57:45 +00001261 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001262 goto error;
1263 }
1264 line = PyString_FromStringAndSize(buffer,
1265 len);
1266 if (line == NULL)
1267 goto error;
1268 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001269 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001270 }
1271 }
1272
1273 /* Since we are releasing the global lock, the
1274 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001275 Py_BEGIN_ALLOW_THREADS
1276 f->f_softspace = 0;
1277 errno = 0;
1278 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001279 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001280 len = PyString_GET_SIZE(line);
1281 nwritten = fwrite(PyString_AS_STRING(line),
1282 1, len, f->f_fp);
1283 if (nwritten != len) {
1284 Py_BLOCK_THREADS
1285 PyErr_SetFromErrno(PyExc_IOError);
1286 clearerr(f->f_fp);
1287 goto error;
1288 }
1289 }
1290 Py_END_ALLOW_THREADS
1291
1292 if (j < CHUNKSIZE)
1293 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001294 }
1295
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001296 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001297 result = Py_None;
1298 error:
1299 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001300 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001301 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001302#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001303}
1304
Tim Petersefc3a3a2001-09-20 07:55:22 +00001305static char readline_doc[] =
1306"readline([size]) -> next line from the file, as a string.\n"
1307"\n"
1308"Retain newline. A non-negative size argument limits the maximum\n"
1309"number of bytes to return (an incomplete line may be returned then).\n"
1310"Return an empty string at EOF.";
1311
1312static char read_doc[] =
1313"read([size]) -> read at most size bytes, returned as a string.\n"
1314"\n"
1315"If the size argument is negative or omitted, read until EOF is reached.";
1316
1317static char write_doc[] =
1318"write(str) -> None. Write string str to file.\n"
1319"\n"
1320"Note that due to buffering, flush() or close() may be needed before\n"
1321"the file on disk reflects the data written.";
1322
1323static char fileno_doc[] =
1324"fileno() -> integer \"file descriptor\".\n"
1325"\n"
1326"This is needed for lower-level file interfaces, such os.read().";
1327
1328static char seek_doc[] =
1329"seek(offset[, whence]) -> None. Move to new file position.\n"
1330"\n"
1331"Argument offset is a byte count. Optional argument whence defaults to\n"
1332"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1333"(move relative to current position, positive or negative), and 2 (move\n"
1334"relative to end of file, usually negative, although many platforms allow\n"
1335"seeking beyond the end of a file).\n"
1336"\n"
1337"Note that not all file objects are seekable.";
1338
Guido van Rossumd7047b31995-01-02 19:07:15 +00001339#ifdef HAVE_FTRUNCATE
Tim Petersefc3a3a2001-09-20 07:55:22 +00001340static char truncate_doc[] =
1341"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1342"\n"
1343"Size defaults to the current file position, as returned by tell().";
Guido van Rossumd7047b31995-01-02 19:07:15 +00001344#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001345
1346static char tell_doc[] =
1347"tell() -> current file position, an integer (may be a long integer).";
1348
1349static char readinto_doc[] =
1350"readinto() -> Undocumented. Don't use this; it may go away.";
1351
1352static char readlines_doc[] =
1353"readlines([size]) -> list of strings, each a line from the file.\n"
1354"\n"
1355"Call readline() repeatedly and return a list of the lines so read.\n"
1356"The optional size argument, if given, is an approximate bound on the\n"
1357"total number of bytes in the lines returned.";
1358
1359static char xreadlines_doc[] =
1360"xreadlines() -> next line from the file, as a string.\n"
1361"\n"
1362"Equivalent to xreadlines.xreadlines(file). This is like readline(), but\n"
1363"often quicker, due to reading ahead internally.";
1364
1365static char writelines_doc[] =
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001366"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001367"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001368"Note that newlines are not added. The sequence can be any iterable object\n"
1369"producing strings. This is equivalent to calling write() for each string.";
Tim Petersefc3a3a2001-09-20 07:55:22 +00001370
1371static char flush_doc[] =
1372"flush() -> None. Flush the internal I/O buffer.";
1373
1374static char close_doc[] =
1375"close() -> None or (perhaps) an integer. Close the file.\n"
1376"\n"
1377"Sets data attribute .closed to true. A closed file cannot be used for\n"
1378"further I/O operations. close() may be called more than once without\n"
1379"error. Some kinds of file objects (for example, opened by popen())\n"
1380"may return an exit status upon closing.";
1381
1382static char isatty_doc[] =
1383"isatty() -> true or false. True if the file is connected to a tty device.";
1384
1385static PyMethodDef file_methods[] = {
1386 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1387 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001388 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001389 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1390 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
1391#ifdef HAVE_FTRUNCATE
1392 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
1393#endif
1394 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1395 {"readinto", (PyCFunction)file_readinto, METH_OLDARGS, readinto_doc},
1396 {"readlines", (PyCFunction)file_readlines, METH_VARARGS, readlines_doc},
1397 {"xreadlines", (PyCFunction)file_xreadlines, METH_NOARGS, xreadlines_doc},
1398 {"writelines", (PyCFunction)file_writelines, METH_O, writelines_doc},
1399 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1400 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1401 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001402 {NULL, NULL} /* sentinel */
1403};
1404
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001405#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001406
Guido van Rossum6f799372001-09-20 20:46:19 +00001407static PyMemberDef file_memberlist[] = {
1408 {"softspace", T_INT, OFF(f_softspace), 0,
1409 "flag indicating that a space needs to be printed; used by print"},
1410 {"mode", T_OBJECT, OFF(f_mode), RO,
1411 "file mode ('r', 'w', 'a', possibly with 'b' or '+' added)"},
1412 {"name", T_OBJECT, OFF(f_name), RO,
1413 "file name"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001414 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001415 {NULL} /* Sentinel */
1416};
1417
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001418static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001419get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001420{
Tim Peters6d6c1a32001-08-02 04:15:00 +00001421 return PyInt_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001422}
1423
Guido van Rossum32d34c82001-09-20 21:45:26 +00001424static PyGetSetDef file_getsetlist[] = {
1425 {"closed", (getter)get_closed, NULL, "flag set if the file is closed"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001426 {0},
1427};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001428
Guido van Rossum65967252001-04-21 13:20:18 +00001429static PyObject *
Guido van Rossum5b021842001-05-22 16:48:37 +00001430file_getiter(PyObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001431{
Guido van Rossum5b021842001-05-22 16:48:37 +00001432 return PyObject_CallMethod(f, "xreadlines", "");
Guido van Rossum65967252001-04-21 13:20:18 +00001433}
1434
Tim Peters59c9a642001-09-13 05:38:56 +00001435static PyObject *
1436file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1437{
Tim Peters44410012001-09-14 03:26:08 +00001438 PyObject *self;
1439 static PyObject *not_yet_string;
1440
1441 assert(type != NULL && type->tp_alloc != NULL);
1442
1443 if (not_yet_string == NULL) {
1444 not_yet_string = PyString_FromString("<uninitialized file>");
1445 if (not_yet_string == NULL)
1446 return NULL;
1447 }
1448
1449 self = type->tp_alloc(type, 0);
1450 if (self != NULL) {
1451 /* Always fill in the name and mode, so that nobody else
1452 needs to special-case NULLs there. */
1453 Py_INCREF(not_yet_string);
1454 ((PyFileObject *)self)->f_name = not_yet_string;
1455 Py_INCREF(not_yet_string);
1456 ((PyFileObject *)self)->f_mode = not_yet_string;
1457 }
1458 return self;
1459}
1460
1461static int
1462file_init(PyObject *self, PyObject *args, PyObject *kwds)
1463{
1464 PyFileObject *foself = (PyFileObject *)self;
1465 int ret = 0;
Tim Peters59c9a642001-09-13 05:38:56 +00001466 static char *kwlist[] = {"name", "mode", "buffering", 0};
1467 char *name = NULL;
1468 char *mode = "r";
1469 int bufsize = -1;
Tim Peters44410012001-09-14 03:26:08 +00001470
1471 assert(PyFile_Check(self));
1472 if (foself->f_fp != NULL) {
1473 /* Have to close the existing file first. */
1474 PyObject *closeresult = file_close(foself);
1475 if (closeresult == NULL)
1476 return -1;
1477 Py_DECREF(closeresult);
1478 }
Tim Peters59c9a642001-09-13 05:38:56 +00001479
1480 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
1481 Py_FileSystemDefaultEncoding, &name,
1482 &mode, &bufsize))
Tim Peters44410012001-09-14 03:26:08 +00001483 return -1;
1484 if (fill_file_fields(foself, NULL, name, mode, fclose) == NULL)
1485 goto Error;
1486 if (open_the_file(foself, name, mode) == NULL)
1487 goto Error;
1488 PyFile_SetBufSize(self, bufsize);
1489 goto Done;
1490
1491Error:
1492 ret = -1;
1493 /* fall through */
1494Done:
Tim Peters59c9a642001-09-13 05:38:56 +00001495 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00001496 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00001497}
1498
Tim Peters59c9a642001-09-13 05:38:56 +00001499static char file_doc[] =
1500"file(name[, mode[, buffering]]) -> file object\n"
1501"\n"
1502"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
1503"writing or appending. The file will be created if it doesn't exist\n"
1504"when opened for writing or appending; it will be truncated when\n"
1505"opened for writing. Add a 'b' to the mode for binary files.\n"
1506"Add a '+' to the mode to allow simultaneous reading and writing.\n"
1507"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00001508"buffered, and larger numbers specify the buffer size.\n"
1509"Note: open() is an alias for file().\n";
Tim Peters59c9a642001-09-13 05:38:56 +00001510
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001511PyTypeObject PyFile_Type = {
1512 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001513 0,
1514 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001515 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001516 0,
Guido van Rossum65967252001-04-21 13:20:18 +00001517 (destructor)file_dealloc, /* tp_dealloc */
1518 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001519 0, /* tp_getattr */
1520 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00001521 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001522 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00001523 0, /* tp_as_number */
1524 0, /* tp_as_sequence */
1525 0, /* tp_as_mapping */
1526 0, /* tp_hash */
1527 0, /* tp_call */
1528 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001529 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum65967252001-04-21 13:20:18 +00001530 0, /* tp_setattro */
1531 0, /* tp_as_buffer */
Guido van Rossum9475a232001-10-05 20:51:39 +00001532 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00001533 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001534 0, /* tp_traverse */
1535 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00001536 0, /* tp_richcompare */
1537 0, /* tp_weaklistoffset */
Guido van Rossum5b021842001-05-22 16:48:37 +00001538 file_getiter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +00001539 0, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001540 file_methods, /* tp_methods */
1541 file_memberlist, /* tp_members */
1542 file_getsetlist, /* tp_getset */
1543 0, /* tp_base */
1544 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00001545 0, /* tp_descr_get */
1546 0, /* tp_descr_set */
1547 0, /* tp_dictoffset */
Tim Peters44410012001-09-14 03:26:08 +00001548 (initproc)file_init, /* tp_init */
1549 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00001550 file_new, /* tp_new */
Guido van Rossum9475a232001-10-05 20:51:39 +00001551 _PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001552};
Guido van Rossumeb183da1991-04-04 10:44:06 +00001553
1554/* Interface for the 'soft space' between print items. */
1555
1556int
Fred Drakefd99de62000-07-09 05:02:18 +00001557PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00001558{
1559 int oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001560 if (f == NULL) {
1561 /* Do nothing */
1562 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001563 else if (PyFile_Check(f)) {
1564 oldflag = ((PyFileObject *)f)->f_softspace;
1565 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001566 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001567 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001568 PyObject *v;
1569 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001570 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001571 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001572 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001573 if (PyInt_Check(v))
1574 oldflag = PyInt_AsLong(v);
1575 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001576 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001577 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001578 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001579 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001580 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001581 if (PyObject_SetAttrString(f, "softspace", v) != 0)
1582 PyErr_Clear();
1583 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001584 }
1585 }
Guido van Rossumeb183da1991-04-04 10:44:06 +00001586 return oldflag;
1587}
Guido van Rossum3165fe61992-09-25 21:59:05 +00001588
1589/* Interfaces to write objects/strings to file-like objects */
1590
1591int
Fred Drakefd99de62000-07-09 05:02:18 +00001592PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001593{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001594 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001595 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001596 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001597 return -1;
1598 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001599 else if (PyFile_Check(f)) {
1600 FILE *fp = PyFile_AsFile(f);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001601 if (fp == NULL) {
1602 err_closed();
1603 return -1;
1604 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001605 return PyObject_Print(v, fp, flags);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001606 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001607 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001608 if (writer == NULL)
1609 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00001610 if (flags & Py_PRINT_RAW) {
1611 if (PyUnicode_Check(v)) {
1612 value = v;
1613 Py_INCREF(value);
1614 } else
1615 value = PyObject_Str(v);
1616 }
1617 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001618 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00001619 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001620 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00001621 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001622 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001623 args = Py_BuildValue("(O)", value);
Guido van Rossume9eec541997-05-22 14:02:25 +00001624 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001625 Py_DECREF(value);
1626 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00001627 return -1;
1628 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001629 result = PyEval_CallObject(writer, args);
1630 Py_DECREF(args);
1631 Py_DECREF(value);
1632 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001633 if (result == NULL)
1634 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001635 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001636 return 0;
1637}
1638
Guido van Rossum27a60b11997-05-22 22:25:11 +00001639int
Tim Petersc1bbcb82001-11-28 22:13:25 +00001640PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001641{
1642 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00001643 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00001644 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00001645 PyErr_SetString(PyExc_SystemError,
1646 "null file for PyFile_WriteString");
1647 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001648 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001649 else if (PyFile_Check(f)) {
1650 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001651 if (fp == NULL) {
1652 err_closed();
1653 return -1;
1654 }
1655 fputs(s, fp);
1656 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001657 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001658 else if (!PyErr_Occurred()) {
1659 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001660 int err;
1661 if (v == NULL)
1662 return -1;
1663 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
1664 Py_DECREF(v);
1665 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001666 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00001667 else
1668 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001669}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001670
1671/* Try to get a file-descriptor from a Python object. If the object
1672 is an integer or long integer, its value is returned. If not, the
1673 object's fileno() method is called if it exists; the method must return
1674 an integer or long integer, which is returned as the file descriptor value.
1675 -1 is returned on failure.
1676*/
1677
1678int PyObject_AsFileDescriptor(PyObject *o)
1679{
1680 int fd;
1681 PyObject *meth;
1682
1683 if (PyInt_Check(o)) {
1684 fd = PyInt_AsLong(o);
1685 }
1686 else if (PyLong_Check(o)) {
1687 fd = PyLong_AsLong(o);
1688 }
1689 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
1690 {
1691 PyObject *fno = PyEval_CallObject(meth, NULL);
1692 Py_DECREF(meth);
1693 if (fno == NULL)
1694 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00001695
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001696 if (PyInt_Check(fno)) {
1697 fd = PyInt_AsLong(fno);
1698 Py_DECREF(fno);
1699 }
1700 else if (PyLong_Check(fno)) {
1701 fd = PyLong_AsLong(fno);
1702 Py_DECREF(fno);
1703 }
1704 else {
1705 PyErr_SetString(PyExc_TypeError,
1706 "fileno() returned a non-integer");
1707 Py_DECREF(fno);
1708 return -1;
1709 }
1710 }
1711 else {
1712 PyErr_SetString(PyExc_TypeError,
1713 "argument must be an int, or have a fileno() method.");
1714 return -1;
1715 }
1716
1717 if (fd < 0) {
1718 PyErr_Format(PyExc_ValueError,
1719 "file descriptor cannot be a negative integer (%i)",
1720 fd);
1721 return -1;
1722 }
1723 return fd;
1724}