blob: 54d040de22af76caf6658891e45e5a69a7f21f0b [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 +000041FILE *
Fred Drakefd99de62000-07-09 05:02:18 +000042PyFile_AsFile(PyObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000043{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000044 if (f == NULL || !PyFile_Check(f))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000045 return NULL;
Guido van Rossum3165fe61992-09-25 21:59:05 +000046 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000047 return ((PyFileObject *)f)->f_fp;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000048}
49
Guido van Rossumc0b618a1997-05-02 03:12:38 +000050PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +000051PyFile_Name(PyObject *f)
Guido van Rossumdb3165e1993-10-18 17:06:59 +000052{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000053 if (f == NULL || !PyFile_Check(f))
Guido van Rossumdb3165e1993-10-18 17:06:59 +000054 return NULL;
55 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000056 return ((PyFileObject *)f)->f_name;
Guido van Rossumdb3165e1993-10-18 17:06:59 +000057}
58
Neil Schemenauered19b882002-03-23 02:06:50 +000059/* On Unix, fopen will succeed for directories.
60 In Python, there should be no file objects referring to
61 directories, so we need a check. */
62
63static PyFileObject*
64dircheck(PyFileObject* f)
65{
66#if defined(HAVE_FSTAT) && defined(S_IFDIR) && defined(EISDIR)
67 struct stat buf;
68 if (f->f_fp == NULL)
69 return f;
70 if (fstat(fileno(f->f_fp), &buf) == 0 &&
71 S_ISDIR(buf.st_mode)) {
72#ifdef HAVE_STRERROR
73 char *msg = strerror(EISDIR);
74#else
75 char *msg = "Is a directory";
76#endif
77 PyObject *exc = PyObject_CallFunction(PyExc_IOError, "(is)", EISDIR, msg);
78 PyErr_SetObject(PyExc_IOError, exc);
79 return NULL;
80 }
81#endif
82 return f;
83}
84
Tim Peters59c9a642001-09-13 05:38:56 +000085
86static PyObject *
87fill_file_fields(PyFileObject *f, FILE *fp, char *name, char *mode,
88 int (*close)(FILE *))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000089{
Tim Peters59c9a642001-09-13 05:38:56 +000090 assert(f != NULL);
91 assert(PyFile_Check(f));
Tim Peters44410012001-09-14 03:26:08 +000092 assert(f->f_fp == NULL);
93
94 Py_DECREF(f->f_name);
95 Py_DECREF(f->f_mode);
Guido van Rossumc0b618a1997-05-02 03:12:38 +000096 f->f_name = PyString_FromString(name);
97 f->f_mode = PyString_FromString(mode);
Tim Peters44410012001-09-14 03:26:08 +000098
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +000099 f->f_close = close;
Guido van Rossumeb183da1991-04-04 10:44:06 +0000100 f->f_softspace = 0;
Tim Peters59c9a642001-09-13 05:38:56 +0000101 f->f_binary = strchr(mode,'b') != NULL;
Tim Peters44410012001-09-14 03:26:08 +0000102
Tim Peters59c9a642001-09-13 05:38:56 +0000103 if (f->f_name == NULL || f->f_mode == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000104 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000105 f->f_fp = fp;
Neil Schemenauered19b882002-03-23 02:06:50 +0000106 f = dircheck(f);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000107 return (PyObject *) f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000108}
109
Tim Peters59c9a642001-09-13 05:38:56 +0000110static PyObject *
111open_the_file(PyFileObject *f, char *name, char *mode)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000112{
Tim Peters59c9a642001-09-13 05:38:56 +0000113 assert(f != NULL);
114 assert(PyFile_Check(f));
115 assert(name != NULL);
116 assert(mode != NULL);
Tim Peters44410012001-09-14 03:26:08 +0000117 assert(f->f_fp == NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000118
Tim Peters8fa45672001-09-13 21:01:29 +0000119 /* rexec.py can't stop a user from getting the file() constructor --
120 all they have to do is get *any* file object f, and then do
121 type(f). Here we prevent them from doing damage with it. */
122 if (PyEval_GetRestricted()) {
123 PyErr_SetString(PyExc_IOError,
124 "file() constructor not accessible in restricted mode");
125 return NULL;
126 }
Tim Petersa27a1502001-11-09 20:59:14 +0000127 errno = 0;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000128#ifdef HAVE_FOPENRF
Guido van Rossuma08095a1991-02-13 23:25:27 +0000129 if (*mode == '*') {
130 FILE *fopenRF();
131 f->f_fp = fopenRF(name, mode+1);
132 }
133 else
134#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000135 {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000136 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000137 f->f_fp = fopen(name, mode);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000138 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000139 }
Guido van Rossuma08095a1991-02-13 23:25:27 +0000140 if (f->f_fp == NULL) {
Jack Jansene08dea191995-04-23 22:12:47 +0000141#ifdef NO_FOPEN_ERRNO
Jack Jansenb3be2162001-11-30 14:16:36 +0000142 /* Metroworks only, wich does not always sets errno */
Jeremy Hylton41c83212001-11-09 16:17:24 +0000143 if (errno == 0) {
Jack Jansenb3be2162001-11-30 14:16:36 +0000144 PyObject *v;
145 v = Py_BuildValue("(is)", 0, "Cannot open file");
146 if (v != NULL) {
147 PyErr_SetObject(PyExc_IOError, v);
148 Py_DECREF(v);
149 }
Jack Jansene08dea191995-04-23 22:12:47 +0000150 return NULL;
151 }
152#endif
Tim Peters2ea91112002-04-08 04:13:12 +0000153#ifdef _MSC_VER
154 /* MSVC 6 (Microsoft) leaves errno at 0 for bad mode strings,
155 * across all Windows flavors. When it sets EINVAL varies
156 * across Windows flavors, the exact conditions aren't
157 * documented, and the answer lies in the OS's implementation
158 * of Win32's CreateFile function (whose source is secret).
159 * Seems the best we can do is map EINVAL to ENOENT.
160 */
161 if (errno == 0) /* bad mode string */
162 errno = EINVAL;
163 else if (errno == EINVAL) /* unknown, but not a mode string */
164 errno = ENOENT;
165#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000166 if (errno == EINVAL)
Tim Peters2ea91112002-04-08 04:13:12 +0000167 PyErr_Format(PyExc_IOError, "invalid mode: %s",
Jeremy Hylton41c83212001-11-09 16:17:24 +0000168 mode);
169 else
170 PyErr_SetFromErrnoWithFilename(PyExc_IOError, name);
Tim Peters59c9a642001-09-13 05:38:56 +0000171 f = NULL;
172 }
Tim Peters2ea91112002-04-08 04:13:12 +0000173 if (f != NULL)
Neil Schemenauered19b882002-03-23 02:06:50 +0000174 f = dircheck(f);
Tim Peters59c9a642001-09-13 05:38:56 +0000175 return (PyObject *)f;
176}
177
178PyObject *
179PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
180{
Tim Peters44410012001-09-14 03:26:08 +0000181 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
182 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000183 if (f != NULL) {
184 if (fill_file_fields(f, fp, name, mode, close) == NULL) {
185 Py_DECREF(f);
186 f = NULL;
187 }
188 }
189 return (PyObject *) f;
190}
191
192PyObject *
193PyFile_FromString(char *name, char *mode)
194{
195 extern int fclose(FILE *);
196 PyFileObject *f;
197
198 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
199 if (f != NULL) {
200 if (open_the_file(f, name, mode) == NULL) {
201 Py_DECREF(f);
202 f = NULL;
203 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000204 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000205 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000206}
207
Guido van Rossumb6775db1994-08-01 11:34:53 +0000208void
Fred Drakefd99de62000-07-09 05:02:18 +0000209PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000210{
211 if (bufsize >= 0) {
212#ifdef HAVE_SETVBUF
213 int type;
214 switch (bufsize) {
215 case 0:
216 type = _IONBF;
217 break;
218 case 1:
219 type = _IOLBF;
220 bufsize = BUFSIZ;
221 break;
222 default:
223 type = _IOFBF;
224 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000225 setvbuf(((PyFileObject *)f)->f_fp, (char *)NULL,
226 type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000227#else /* !HAVE_SETVBUF */
228 if (bufsize <= 1)
229 setbuf(((PyFileObject *)f)->f_fp, (char *)NULL);
230#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000231 }
232}
233
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000234static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000235err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000236{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000237 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000238 return NULL;
239}
240
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000241/* Methods */
242
243static void
Fred Drakefd99de62000-07-09 05:02:18 +0000244file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000245{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000246 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000247 Py_BEGIN_ALLOW_THREADS
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000248 (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000249 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000250 }
Tim Peters44410012001-09-14 03:26:08 +0000251 Py_XDECREF(f->f_name);
252 Py_XDECREF(f->f_mode);
Guido van Rossum9475a232001-10-05 20:51:39 +0000253 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000254}
255
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000256static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000257file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000258{
Barry Warsaw7ce36942001-08-24 18:34:26 +0000259 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
260 f->f_fp == NULL ? "closed" : "open",
261 PyString_AsString(f->f_name),
262 PyString_AsString(f->f_mode),
263 f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000264}
265
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000266static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000267file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000268{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000269 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000270 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000271 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000272 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000273 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000274 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000275 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000276 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000277 f->f_fp = NULL;
278 }
Guido van Rossumfebd5511992-03-04 16:39:24 +0000279 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000280 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000281 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000282 return PyInt_FromLong((long)sts);
283 Py_INCREF(Py_None);
284 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000285}
286
Trent Mickf29f47b2000-08-11 19:02:59 +0000287
Guido van Rossumb8552162001-09-05 14:58:11 +0000288/* Our very own off_t-like type, 64-bit if possible */
289#if !defined(HAVE_LARGEFILE_SUPPORT)
290typedef off_t Py_off_t;
291#elif SIZEOF_OFF_T >= 8
292typedef off_t Py_off_t;
293#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000294typedef fpos_t Py_off_t;
295#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000296#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000297#endif
298
299
Trent Mickf29f47b2000-08-11 19:02:59 +0000300/* a portable fseek() function
301 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000302static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000303_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000304{
Guido van Rossumb8552162001-09-05 14:58:11 +0000305#if !defined(HAVE_LARGEFILE_SUPPORT)
306 return fseek(fp, offset, whence);
307#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000308 return fseeko(fp, offset, whence);
309#elif defined(HAVE_FSEEK64)
310 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000311#elif defined(__BEOS__)
312 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000313#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000314 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
315 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000316 fpos_t pos;
317 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000318 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000319#ifdef MS_WINDOWS
320 fflush(fp);
321 if (_lseeki64(fileno(fp), 0, 2) == -1)
322 return -1;
323#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000324 if (fseek(fp, 0, SEEK_END) != 0)
325 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000326#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000327 /* fall through */
328 case SEEK_CUR:
329 if (fgetpos(fp, &pos) != 0)
330 return -1;
331 offset += pos;
332 break;
333 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000334 }
335 return fsetpos(fp, &offset);
336#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000337#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000338#endif
339}
340
341
342/* a portable ftell() function
343 Return -1 on failure with errno set appropriately, current file
344 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000345static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000346_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000347{
Guido van Rossumb8552162001-09-05 14:58:11 +0000348#if !defined(HAVE_LARGEFILE_SUPPORT)
349 return ftell(fp);
350#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
351 return ftello(fp);
352#elif defined(HAVE_FTELL64)
353 return ftell64(fp);
354#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000355 fpos_t pos;
356 if (fgetpos(fp, &pos) != 0)
357 return -1;
358 return pos;
359#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000360#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000361#endif
362}
363
364
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000365static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000366file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000367{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000368 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000369 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000370 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000371 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000372
Guido van Rossumd7297e61992-07-06 14:19:26 +0000373 if (f->f_fp == NULL)
374 return err_closed();
375 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000376 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000377 return NULL;
378#if !defined(HAVE_LARGEFILE_SUPPORT)
379 offset = PyInt_AsLong(offobj);
380#else
381 offset = PyLong_Check(offobj) ?
382 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
383#endif
384 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000385 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000386
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000387 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000388 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000389 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000390 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000391
Guido van Rossumff4949e1992-08-05 19:58:53 +0000392 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000393 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000394 clearerr(f->f_fp);
395 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000396 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000397 Py_INCREF(Py_None);
398 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000399}
400
Trent Mickf29f47b2000-08-11 19:02:59 +0000401
Guido van Rossumd7047b31995-01-02 19:07:15 +0000402#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000403static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000404file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000405{
Guido van Rossumd7047b31995-01-02 19:07:15 +0000406 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000407 Py_off_t newsize;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000408 PyObject *newsizeobj;
Tim Peters86821b22001-01-07 21:19:34 +0000409
Guido van Rossumd7047b31995-01-02 19:07:15 +0000410 if (f->f_fp == NULL)
411 return err_closed();
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000412 newsizeobj = NULL;
Guido van Rossum43713e52000-02-29 13:59:29 +0000413 if (!PyArg_ParseTuple(args, "|O:truncate", &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000414 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000415
416 /* Set newsize to current postion if newsizeobj NULL, else to the
417 specified value. */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000418 if (newsizeobj != NULL) {
419#if !defined(HAVE_LARGEFILE_SUPPORT)
420 newsize = PyInt_AsLong(newsizeobj);
421#else
422 newsize = PyLong_Check(newsizeobj) ?
423 PyLong_AsLongLong(newsizeobj) :
424 PyInt_AsLong(newsizeobj);
425#endif
426 if (PyErr_Occurred())
427 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000428 }
429 else {
430 /* Default to current position. */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000431 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000432 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000433 newsize = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000434 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000435 if (newsize == -1)
436 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000437 }
Tim Petersfb05db22002-03-11 00:24:00 +0000438
439 /* Flush the file. */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000440 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000441 errno = 0;
442 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000443 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000444 if (ret != 0)
445 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000446
447#ifdef MS_WIN32
Tim Petersfb05db22002-03-11 00:24:00 +0000448 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000449 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000450 {
Tim Peters8f01b682002-03-12 03:04:44 +0000451 Py_off_t current; /* current file position */
Tim Petersfb05db22002-03-11 00:24:00 +0000452 HANDLE hFile;
453 int error;
454
Tim Peters8f01b682002-03-12 03:04:44 +0000455 /* current <- current file postion. */
456 if (newsizeobj == NULL)
457 current = newsize;
458 else {
Tim Petersfb05db22002-03-11 00:24:00 +0000459 Py_BEGIN_ALLOW_THREADS
460 errno = 0;
Tim Peters8f01b682002-03-12 03:04:44 +0000461 current = _portable_ftell(f->f_fp);
462 Py_END_ALLOW_THREADS
463 if (current == -1)
464 goto onioerror;
465 }
466
467 /* Move to newsize. */
468 if (current != newsize) {
469 Py_BEGIN_ALLOW_THREADS
470 errno = 0;
471 error = _portable_fseek(f->f_fp, newsize, SEEK_SET)
472 != 0;
Tim Petersfb05db22002-03-11 00:24:00 +0000473 Py_END_ALLOW_THREADS
474 if (error)
475 goto onioerror;
476 }
477
Tim Peters8f01b682002-03-12 03:04:44 +0000478 /* Truncate. Note that this may grow the file! */
479 Py_BEGIN_ALLOW_THREADS
480 errno = 0;
481 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
482 error = hFile == (HANDLE)-1;
483 if (!error) {
484 error = SetEndOfFile(hFile) == 0;
485 if (error)
486 errno = EACCES;
487 }
488 Py_END_ALLOW_THREADS
489 if (error)
490 goto onioerror;
491
492 /* Restore original file position. */
493 if (current != newsize) {
494 Py_BEGIN_ALLOW_THREADS
495 errno = 0;
496 error = _portable_fseek(f->f_fp, current, SEEK_SET)
497 != 0;
498 Py_END_ALLOW_THREADS
499 if (error)
500 goto onioerror;
501 }
Guido van Rossumd7047b31995-01-02 19:07:15 +0000502 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000503#else
504 Py_BEGIN_ALLOW_THREADS
505 errno = 0;
506 ret = ftruncate(fileno(f->f_fp), newsize);
507 Py_END_ALLOW_THREADS
508 if (ret != 0) goto onioerror;
509#endif /* !MS_WIN32 */
Tim Peters86821b22001-01-07 21:19:34 +0000510
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000511 Py_INCREF(Py_None);
512 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000513
514onioerror:
515 PyErr_SetFromErrno(PyExc_IOError);
516 clearerr(f->f_fp);
517 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000518}
519#endif /* HAVE_FTRUNCATE */
520
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000521static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000522file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000523{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000524 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +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;
Trent Mickf29f47b2000-08-11 19:02:59 +0000530 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000531 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000532 if (pos == -1) {
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 Rossum3c9fe0c1999-01-06 18:51:17 +0000537#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000538 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000539#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000540 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000541#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000542}
543
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000544static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000545file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000546{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000547 if (f->f_fp == NULL)
548 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000549 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000550}
551
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000552static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000553file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000554{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000555 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000556
Guido van Rossumd7297e61992-07-06 14:19:26 +0000557 if (f->f_fp == NULL)
558 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000559 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000560 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000561 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000562 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000563 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000564 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000565 clearerr(f->f_fp);
566 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000567 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000568 Py_INCREF(Py_None);
569 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000570}
571
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000572static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000573file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000574{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000575 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000576 if (f->f_fp == NULL)
577 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000578 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000579 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000580 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000581 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000582}
583
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000584
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000585#if BUFSIZ < 8192
586#define SMALLCHUNK 8192
587#else
588#define SMALLCHUNK BUFSIZ
589#endif
590
Guido van Rossum3c259041999-01-14 19:00:14 +0000591#if SIZEOF_INT < 4
592#define BIGCHUNK (512 * 32)
593#else
594#define BIGCHUNK (512 * 1024)
595#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000596
597static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000598new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000599{
600#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000601 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000602 struct stat st;
603 if (fstat(fileno(f->f_fp), &st) == 0) {
604 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000605 /* The following is not a bug: we really need to call lseek()
606 *and* ftell(). The reason is that some stdio libraries
607 mistakenly flush their buffer when ftell() is called and
608 the lseek() call it makes fails, thereby throwing away
609 data that cannot be recovered in any way. To avoid this,
610 we first test lseek(), and only call ftell() if lseek()
611 works. We can't use the lseek() value either, because we
612 need to take the amount of buffered data into account.
613 (Yet another reason why stdio stinks. :-) */
Jack Jansen2771b5b2001-10-10 22:03:27 +0000614#ifdef USE_GUSI2
615 pos = lseek(fileno(f->f_fp), 1L, SEEK_CUR);
616 pos = lseek(fileno(f->f_fp), -1L, SEEK_CUR);
617#else
Guido van Rossum91aaa921998-05-05 22:21:35 +0000618 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000619#endif
620 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000621 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000622 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000623 if (pos < 0)
624 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000625 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000626 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000627 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000628 }
629#endif
630 if (currentsize > SMALLCHUNK) {
631 /* Keep doubling until we reach BIGCHUNK;
632 then keep adding BIGCHUNK. */
633 if (currentsize <= BIGCHUNK)
634 return currentsize + currentsize;
635 else
636 return currentsize + BIGCHUNK;
637 }
638 return currentsize + SMALLCHUNK;
639}
640
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000641static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000642file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000643{
Guido van Rossum789a1611997-05-10 22:33:55 +0000644 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000645 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000646 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000647
Guido van Rossumd7297e61992-07-06 14:19:26 +0000648 if (f->f_fp == NULL)
649 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +0000650 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000651 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000652 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000653 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000654 else
655 buffersize = bytesrequested;
Trent Mickf29f47b2000-08-11 19:02:59 +0000656 if (buffersize > INT_MAX) {
657 PyErr_SetString(PyExc_OverflowError,
658 "requested number of bytes is more than a Python string can hold");
659 return NULL;
660 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000661 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000662 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000663 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000664 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000665 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000666 Py_BEGIN_ALLOW_THREADS
667 errno = 0;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000668 chunksize = fread(BUF(v) + bytesread, 1,
669 buffersize - bytesread, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000670 Py_END_ALLOW_THREADS
671 if (chunksize == 0) {
672 if (!ferror(f->f_fp))
673 break;
674 PyErr_SetFromErrno(PyExc_IOError);
675 clearerr(f->f_fp);
676 Py_DECREF(v);
677 return NULL;
678 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000679 bytesread += chunksize;
680 if (bytesread < buffersize)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000681 break;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000682 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000683 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000684 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000685 return NULL;
686 }
687 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000688 if (bytesread != buffersize)
689 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000690 return v;
691}
692
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000693static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000694file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000695{
696 char *ptr;
Guido van Rossum00ebd462001-10-23 21:25:24 +0000697 int ntodo;
698 size_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000699
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000700 if (f->f_fp == NULL)
701 return err_closed();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000702 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000703 return NULL;
704 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000705 while (ntodo > 0) {
706 Py_BEGIN_ALLOW_THREADS
707 errno = 0;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000708 nnow = fread(ptr+ndone, 1, ntodo, f->f_fp);
Guido van Rossum6263d541997-05-10 22:07:25 +0000709 Py_END_ALLOW_THREADS
710 if (nnow == 0) {
711 if (!ferror(f->f_fp))
712 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000713 PyErr_SetFromErrno(PyExc_IOError);
714 clearerr(f->f_fp);
715 return NULL;
716 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000717 ndone += nnow;
718 ntodo -= nnow;
719 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000720 return PyInt_FromLong((long)ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000721}
722
Tim Peters86821b22001-01-07 21:19:34 +0000723/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000724Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000725
726Under MSVC 6:
727
Tim Peters1c733232001-01-08 04:02:07 +0000728+ MS threadsafe getc is very slow (multiple layers of function calls before+
729 after each character, to lock+unlock the stream).
730+ The stream-locking functions are MS-internal -- can't access them from user
731 code.
732+ There's nothing Tim could find in the MS C or platform SDK libraries that
733 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000734+ MS fgets locks/unlocks only once per line; it's the only hook we have.
735
736So we use fgets for speed(!), despite that it's painful.
737
738MS realloc is also slow.
739
Tim Petersf29b64d2001-01-15 06:33:19 +0000740Reports from other platforms on this method vs getc_unlocked (which MS doesn't
741have):
742 Linux a wash
743 Solaris a wash
744 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000745
Tim Petersf29b64d2001-01-15 06:33:19 +0000746CAUTION: The C std isn't clear about this: in those cases where fgets
747writes something into the buffer, can it write into any position beyond the
748required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
749known on which it does; and it would be a strange way to code fgets. Still,
750getline_via_fgets may not work correctly if it does. The std test
751test_bufio.py should fail if platform fgets() routinely writes beyond the
752trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000753**************************************************************************/
754
Tim Petersf29b64d2001-01-15 06:33:19 +0000755/* Use this routine if told to, or by default on non-get_unlocked()
756 * platforms unless told not to. Yikes! Let's spell that out:
757 * On a platform with getc_unlocked():
758 * By default, use getc_unlocked().
759 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
760 * On a platform without getc_unlocked():
761 * By default, use fgets().
762 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
763 */
764#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
765#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000766#endif
767
Tim Petersf29b64d2001-01-15 06:33:19 +0000768#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
769#undef USE_FGETS_IN_GETLINE
770#endif
771
772#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000773static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000774getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000775{
Tim Peters15b83852001-01-08 00:53:12 +0000776/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000777 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
778 * to fill this much of the buffer with a known value in order to figure out
779 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
780 * than "most" lines, we waste time filling unused buffer slots. 100 is
781 * surely adequate for most peoples' email archives, chewing over source code,
782 * etc -- "regular old text files".
783 * MAXBUFSIZE is the maximum line length that lets us get away with the less
784 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
785 * cautions about boosting that. 300 was chosen because the worst real-life
786 * text-crunching job reported on Python-Dev was a mail-log crawler where over
787 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +0000788 */
Tim Peters142297a2001-01-15 10:36:56 +0000789#define INITBUFSIZE 100
790#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +0000791 char* p; /* temp */
792 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000793 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +0000794 char* pvfree; /* address of next free slot */
795 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +0000796 size_t nfree; /* # of free buffer slots; pvend-pvfree */
797 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +0000798 size_t increment; /* amount to increment the buffer */
Tim Peters86821b22001-01-07 21:19:34 +0000799
Tim Peters15b83852001-01-08 00:53:12 +0000800 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +0000801 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +0000802 */
Tim Peters142297a2001-01-15 10:36:56 +0000803 total_v_size = INITBUFSIZE; /* start small and pray */
804 pvfree = buf;
805 for (;;) {
806 Py_BEGIN_ALLOW_THREADS
807 pvend = buf + total_v_size;
808 nfree = pvend - pvfree;
809 memset(pvfree, '\n', nfree);
810 p = fgets(pvfree, nfree, fp);
811 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +0000812
Tim Peters142297a2001-01-15 10:36:56 +0000813 if (p == NULL) {
814 clearerr(fp);
815 if (PyErr_CheckSignals())
816 return NULL;
817 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +0000818 return v;
819 }
Tim Peters142297a2001-01-15 10:36:56 +0000820 /* fgets read *something* */
821 p = memchr(pvfree, '\n', nfree);
822 if (p != NULL) {
823 /* Did the \n come from fgets or from us?
824 * Since fgets stops at the first \n, and then writes
825 * \0, if it's from fgets a \0 must be next. But if
826 * that's so, it could not have come from us, since
827 * the \n's we filled the buffer with have only more
828 * \n's to the right.
829 */
830 if (p+1 < pvend && *(p+1) == '\0') {
831 /* It's from fgets: we win! In particular,
832 * we haven't done any mallocs yet, and can
833 * build the final result on the first try.
834 */
835 ++p; /* include \n from fgets */
836 }
837 else {
838 /* Must be from us: fgets didn't fill the
839 * buffer and didn't find a newline, so it
840 * must be the last and newline-free line of
841 * the file.
842 */
843 assert(p > pvfree && *(p-1) == '\0');
844 --p; /* don't include \0 from fgets */
845 }
846 v = PyString_FromStringAndSize(buf, p - buf);
847 return v;
848 }
849 /* yuck: fgets overwrote all the newlines, i.e. the entire
850 * buffer. So this line isn't over yet, or maybe it is but
851 * we're exactly at EOF. If we haven't already, try using the
852 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +0000853 */
Tim Peters142297a2001-01-15 10:36:56 +0000854 assert(*(pvend-1) == '\0');
855 if (pvfree == buf) {
856 pvfree = pvend - 1; /* overwrite trailing null */
857 total_v_size = MAXBUFSIZE;
858 }
859 else
860 break;
Tim Peters86821b22001-01-07 21:19:34 +0000861 }
Tim Peters142297a2001-01-15 10:36:56 +0000862
863 /* The stack buffer isn't big enough; malloc a string object and read
864 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +0000865 */
Tim Petersddea2082002-03-23 10:03:50 +0000866 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +0000867 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +0000868 if (v == NULL)
869 return v;
870 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +0000871 memcpy(BUF(v), buf, MAXBUFSIZE-1);
872 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +0000873
874 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +0000875 * after setting p one beyond the end of the line. The code here is
876 * very much like the code above, except reads into v's buffer; see
877 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +0000878 */
879 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +0000880 Py_BEGIN_ALLOW_THREADS
881 pvend = BUF(v) + total_v_size;
882 nfree = pvend - pvfree;
883 memset(pvfree, '\n', nfree);
884 p = fgets(pvfree, nfree, fp);
885 Py_END_ALLOW_THREADS
886
887 if (p == NULL) {
888 clearerr(fp);
889 if (PyErr_CheckSignals()) {
890 Py_DECREF(v);
891 return NULL;
892 }
893 p = pvfree;
894 break;
895 }
Tim Peters86821b22001-01-07 21:19:34 +0000896 p = memchr(pvfree, '\n', nfree);
897 if (p != NULL) {
898 if (p+1 < pvend && *(p+1) == '\0') {
899 /* \n came from fgets */
900 ++p;
901 break;
902 }
903 /* \n came from us; last line of file, no newline */
904 assert(p > pvfree && *(p-1) == '\0');
905 --p;
906 break;
907 }
908 /* expand buffer and try again */
909 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +0000910 increment = total_v_size >> 2; /* mild exponential growth */
911 total_v_size += increment;
Tim Peters86821b22001-01-07 21:19:34 +0000912 if (total_v_size > INT_MAX) {
913 PyErr_SetString(PyExc_OverflowError,
914 "line is longer than a Python string can hold");
915 Py_DECREF(v);
916 return NULL;
917 }
918 if (_PyString_Resize(&v, (int)total_v_size) < 0)
919 return NULL;
920 /* overwrite the trailing null byte */
Tim Petersddea2082002-03-23 10:03:50 +0000921 pvfree = BUF(v) + (total_v_size - increment - 1);
Tim Peters86821b22001-01-07 21:19:34 +0000922 }
923 if (BUF(v) + total_v_size != p)
924 _PyString_Resize(&v, p - BUF(v));
925 return v;
926#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +0000927#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +0000928}
Tim Petersf29b64d2001-01-15 06:33:19 +0000929#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000930
Guido van Rossum0bd24411991-04-04 15:21:57 +0000931/* Internal routine to get a line.
932 Size argument interpretation:
933 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +0000934 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +0000935*/
936
Guido van Rossum1187aa42001-01-05 14:43:05 +0000937#ifdef HAVE_GETC_UNLOCKED
938#define GETC(f) getc_unlocked(f)
939#define FLOCKFILE(f) flockfile(f)
940#define FUNLOCKFILE(f) funlockfile(f)
941#else
942#define GETC(f) getc(f)
943#define FLOCKFILE(f)
944#define FUNLOCKFILE(f)
945#endif
946
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000947static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000948get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000949{
Guido van Rossum1187aa42001-01-05 14:43:05 +0000950 FILE *fp = f->f_fp;
951 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +0000952 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +0000953 size_t total_v_size; /* total # of slots in buffer */
954 size_t used_v_size; /* # used slots in buffer */
955 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000956 PyObject *v;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000957
Tim Petersf29b64d2001-01-15 06:33:19 +0000958#ifdef USE_FGETS_IN_GETLINE
Guido van Rossum86282062001-01-08 01:26:47 +0000959 if (n <= 0)
Tim Petersf29b64d2001-01-15 06:33:19 +0000960 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +0000961#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +0000962 total_v_size = n > 0 ? n : 100;
963 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000964 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000965 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000966 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +0000967 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +0000968
Guido van Rossumce5ba841991-03-06 13:06:18 +0000969 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +0000970 Py_BEGIN_ALLOW_THREADS
971 FLOCKFILE(fp);
972 while ((c = GETC(fp)) != EOF &&
973 (*buf++ = c) != '\n' &&
974 buf != end)
975 ;
976 FUNLOCKFILE(fp);
977 Py_END_ALLOW_THREADS
978 if (c == '\n')
979 break;
980 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +0000981 if (ferror(fp)) {
982 PyErr_SetFromErrno(PyExc_IOError);
983 clearerr(fp);
984 Py_DECREF(v);
985 return NULL;
986 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +0000987 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000988 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000989 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +0000990 return NULL;
991 }
Guido van Rossumce5ba841991-03-06 13:06:18 +0000992 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +0000993 }
Guido van Rossum1187aa42001-01-05 14:43:05 +0000994 /* Must be because buf == end */
995 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +0000996 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +0000997 used_v_size = total_v_size;
998 increment = total_v_size >> 2; /* mild exponential growth */
999 total_v_size += increment;
1000 if (total_v_size > INT_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001001 PyErr_SetString(PyExc_OverflowError,
1002 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001003 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001004 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001005 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001006 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001007 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001008 buf = BUF(v) + used_v_size;
1009 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001010 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001011
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001012 used_v_size = buf - BUF(v);
1013 if (used_v_size != total_v_size)
1014 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001015 return v;
1016}
1017
Guido van Rossum0bd24411991-04-04 15:21:57 +00001018/* External C interface */
1019
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001020PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001021PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001022{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001023 PyObject *result;
1024
Guido van Rossum3165fe61992-09-25 21:59:05 +00001025 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001026 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001027 return NULL;
1028 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001029
1030 if (PyFile_Check(f)) {
1031 if (((PyFileObject*)f)->f_fp == NULL)
1032 return err_closed();
1033 result = get_line((PyFileObject *)f, n);
1034 }
1035 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001036 PyObject *reader;
1037 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001038
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001039 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001040 if (reader == NULL)
1041 return NULL;
1042 if (n <= 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001043 args = Py_BuildValue("()");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001044 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001045 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001046 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001047 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001048 return NULL;
1049 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001050 result = PyEval_CallObject(reader, args);
1051 Py_DECREF(reader);
1052 Py_DECREF(args);
1053 if (result != NULL && !PyString_Check(result)) {
1054 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001055 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001056 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001057 "object.readline() returned non-string");
1058 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001059 }
1060
1061 if (n < 0 && result != NULL && PyString_Check(result)) {
1062 char *s = PyString_AS_STRING(result);
1063 int len = PyString_GET_SIZE(result);
1064 if (len == 0) {
1065 Py_DECREF(result);
1066 result = NULL;
1067 PyErr_SetString(PyExc_EOFError,
1068 "EOF when reading a line");
1069 }
1070 else if (s[len-1] == '\n') {
1071 if (result->ob_refcnt == 1)
1072 _PyString_Resize(&result, len-1);
1073 else {
1074 PyObject *v;
1075 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001076 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001077 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001078 }
1079 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001080 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001081 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001082}
1083
1084/* Python method */
1085
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001086static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001087file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001088{
Guido van Rossum789a1611997-05-10 22:33:55 +00001089 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001090
Guido van Rossumd7297e61992-07-06 14:19:26 +00001091 if (f->f_fp == NULL)
1092 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001093 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001094 return NULL;
1095 if (n == 0)
1096 return PyString_FromString("");
1097 if (n < 0)
1098 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001099 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001100}
1101
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001102static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +00001103file_xreadlines(PyFileObject *f)
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001104{
1105 static PyObject* xreadlines_function = NULL;
Tim Petersf29b64d2001-01-15 06:33:19 +00001106
Neal Norwitz649b7592002-01-01 19:07:13 +00001107 if (f->f_fp == NULL)
1108 return err_closed();
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001109 if (!xreadlines_function) {
1110 PyObject *xreadlines_module =
1111 PyImport_ImportModule("xreadlines");
1112 if(!xreadlines_module)
1113 return NULL;
1114
1115 xreadlines_function = PyObject_GetAttrString(xreadlines_module,
1116 "xreadlines");
1117 Py_DECREF(xreadlines_module);
1118 if(!xreadlines_function)
1119 return NULL;
1120 }
1121 return PyObject_CallFunction(xreadlines_function, "(O)", f);
1122}
1123
1124static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001125file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001126{
Guido van Rossum789a1611997-05-10 22:33:55 +00001127 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001128 PyObject *list;
1129 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001130 char small_buffer[SMALLCHUNK];
1131 char *buffer = small_buffer;
1132 size_t buffersize = SMALLCHUNK;
1133 PyObject *big_buffer = NULL;
1134 size_t nfilled = 0;
1135 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001136 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001137 char *p, *q, *end;
1138 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001139 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001140
Guido van Rossumd7297e61992-07-06 14:19:26 +00001141 if (f->f_fp == NULL)
1142 return err_closed();
Guido van Rossum43713e52000-02-29 13:59:29 +00001143 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001144 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001145 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001146 return NULL;
1147 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001148 if (shortread)
1149 nread = 0;
1150 else {
1151 Py_BEGIN_ALLOW_THREADS
1152 errno = 0;
1153 nread = fread(buffer+nfilled, 1,
1154 buffersize-nfilled, f->f_fp);
1155 Py_END_ALLOW_THREADS
1156 shortread = (nread < buffersize-nfilled);
1157 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001158 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001159 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001160 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001161 break;
1162 PyErr_SetFromErrno(PyExc_IOError);
1163 clearerr(f->f_fp);
1164 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001165 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001166 list = NULL;
1167 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001168 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001169 totalread += nread;
Guido van Rossum6263d541997-05-10 22:07:25 +00001170 p = memchr(buffer+nfilled, '\n', nread);
1171 if (p == NULL) {
1172 /* Need a larger buffer to fit this line */
1173 nfilled += nread;
1174 buffersize *= 2;
Trent Mickf29f47b2000-08-11 19:02:59 +00001175 if (buffersize > INT_MAX) {
1176 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001177 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001178 goto error;
1179 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001180 if (big_buffer == NULL) {
1181 /* Create the big buffer */
1182 big_buffer = PyString_FromStringAndSize(
1183 NULL, buffersize);
1184 if (big_buffer == NULL)
1185 goto error;
1186 buffer = PyString_AS_STRING(big_buffer);
1187 memcpy(buffer, small_buffer, nfilled);
1188 }
1189 else {
1190 /* Grow the big buffer */
1191 _PyString_Resize(&big_buffer, buffersize);
1192 buffer = PyString_AS_STRING(big_buffer);
1193 }
1194 continue;
1195 }
1196 end = buffer+nfilled+nread;
1197 q = buffer;
1198 do {
1199 /* Process complete lines */
1200 p++;
1201 line = PyString_FromStringAndSize(q, p-q);
1202 if (line == NULL)
1203 goto error;
1204 err = PyList_Append(list, line);
1205 Py_DECREF(line);
1206 if (err != 0)
1207 goto error;
1208 q = p;
1209 p = memchr(q, '\n', end-q);
1210 } while (p != NULL);
1211 /* Move the remaining incomplete line to the start */
1212 nfilled = end-q;
1213 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001214 if (sizehint > 0)
1215 if (totalread >= (size_t)sizehint)
1216 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001217 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001218 if (nfilled != 0) {
1219 /* Partial last line */
1220 line = PyString_FromStringAndSize(buffer, nfilled);
1221 if (line == NULL)
1222 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001223 if (sizehint > 0) {
1224 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001225 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001226 if (rest == NULL) {
1227 Py_DECREF(line);
1228 goto error;
1229 }
1230 PyString_Concat(&line, rest);
1231 Py_DECREF(rest);
1232 if (line == NULL)
1233 goto error;
1234 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001235 err = PyList_Append(list, line);
1236 Py_DECREF(line);
1237 if (err != 0)
1238 goto error;
1239 }
1240 cleanup:
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001241 if (big_buffer) {
Guido van Rossum6263d541997-05-10 22:07:25 +00001242 Py_DECREF(big_buffer);
Guido van Rossum1109fbc1998-04-10 22:16:39 +00001243 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001244 return list;
1245}
1246
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001247static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001248file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001249{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001250 char *s;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001251 int n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001252 if (f->f_fp == NULL)
1253 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001254 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001255 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001256 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001257 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001258 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001259 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001260 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001261 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001262 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001263 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001264 return NULL;
1265 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001266 Py_INCREF(Py_None);
1267 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001268}
1269
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001270static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001271file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001272{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001273#define CHUNKSIZE 1000
1274 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001275 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001276 PyObject *result;
1277 int i, j, index, len, nwritten, islist;
1278
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001279 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001280 if (f->f_fp == NULL)
1281 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001282
1283 result = NULL;
1284 list = NULL;
1285 islist = PyList_Check(seq);
1286 if (islist)
1287 it = NULL;
1288 else {
1289 it = PyObject_GetIter(seq);
1290 if (it == NULL) {
1291 PyErr_SetString(PyExc_TypeError,
1292 "writelines() requires an iterable argument");
1293 return NULL;
1294 }
1295 /* From here on, fail by going to error, to reclaim "it". */
1296 list = PyList_New(CHUNKSIZE);
1297 if (list == NULL)
1298 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001299 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001300
1301 /* Strategy: slurp CHUNKSIZE lines into a private list,
1302 checking that they are all strings, then write that list
1303 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001304 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001305 if (islist) {
1306 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001307 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001308 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001309 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001310 j = PyList_GET_SIZE(list);
1311 }
1312 else {
1313 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001314 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001315 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001316 if (PyErr_Occurred())
1317 goto error;
1318 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001319 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001320 PyList_SetItem(list, j, line);
1321 }
1322 }
1323 if (j == 0)
1324 break;
1325
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001326 /* Check that all entries are indeed strings. If not,
1327 apply the same rules as for file.write() and
1328 convert the results to strings. This is slow, but
1329 seems to be the only way since all conversion APIs
1330 could potentially execute Python code. */
1331 for (i = 0; i < j; i++) {
1332 PyObject *v = PyList_GET_ITEM(list, i);
1333 if (!PyString_Check(v)) {
1334 const char *buffer;
1335 int len;
Tim Peters86821b22001-01-07 21:19:34 +00001336 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001337 PyObject_AsReadBuffer(v,
1338 (const void**)&buffer,
1339 &len)) ||
1340 PyObject_AsCharBuffer(v,
1341 &buffer,
1342 &len))) {
1343 PyErr_SetString(PyExc_TypeError,
Fred Drake661ea262000-10-24 19:57:45 +00001344 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001345 goto error;
1346 }
1347 line = PyString_FromStringAndSize(buffer,
1348 len);
1349 if (line == NULL)
1350 goto error;
1351 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001352 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001353 }
1354 }
1355
1356 /* Since we are releasing the global lock, the
1357 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001358 Py_BEGIN_ALLOW_THREADS
1359 f->f_softspace = 0;
1360 errno = 0;
1361 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001362 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001363 len = PyString_GET_SIZE(line);
1364 nwritten = fwrite(PyString_AS_STRING(line),
1365 1, len, f->f_fp);
1366 if (nwritten != len) {
1367 Py_BLOCK_THREADS
1368 PyErr_SetFromErrno(PyExc_IOError);
1369 clearerr(f->f_fp);
1370 goto error;
1371 }
1372 }
1373 Py_END_ALLOW_THREADS
1374
1375 if (j < CHUNKSIZE)
1376 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001377 }
1378
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001379 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001380 result = Py_None;
1381 error:
1382 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001383 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001384 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001385#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001386}
1387
Tim Petersefc3a3a2001-09-20 07:55:22 +00001388static char readline_doc[] =
1389"readline([size]) -> next line from the file, as a string.\n"
1390"\n"
1391"Retain newline. A non-negative size argument limits the maximum\n"
1392"number of bytes to return (an incomplete line may be returned then).\n"
1393"Return an empty string at EOF.";
1394
1395static char read_doc[] =
1396"read([size]) -> read at most size bytes, returned as a string.\n"
1397"\n"
1398"If the size argument is negative or omitted, read until EOF is reached.";
1399
1400static char write_doc[] =
1401"write(str) -> None. Write string str to file.\n"
1402"\n"
1403"Note that due to buffering, flush() or close() may be needed before\n"
1404"the file on disk reflects the data written.";
1405
1406static char fileno_doc[] =
1407"fileno() -> integer \"file descriptor\".\n"
1408"\n"
1409"This is needed for lower-level file interfaces, such os.read().";
1410
1411static char seek_doc[] =
1412"seek(offset[, whence]) -> None. Move to new file position.\n"
1413"\n"
1414"Argument offset is a byte count. Optional argument whence defaults to\n"
1415"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1416"(move relative to current position, positive or negative), and 2 (move\n"
1417"relative to end of file, usually negative, although many platforms allow\n"
1418"seeking beyond the end of a file).\n"
1419"\n"
1420"Note that not all file objects are seekable.";
1421
Guido van Rossumd7047b31995-01-02 19:07:15 +00001422#ifdef HAVE_FTRUNCATE
Tim Petersefc3a3a2001-09-20 07:55:22 +00001423static char truncate_doc[] =
1424"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1425"\n"
1426"Size defaults to the current file position, as returned by tell().";
Guido van Rossumd7047b31995-01-02 19:07:15 +00001427#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001428
1429static char tell_doc[] =
1430"tell() -> current file position, an integer (may be a long integer).";
1431
1432static char readinto_doc[] =
1433"readinto() -> Undocumented. Don't use this; it may go away.";
1434
1435static char readlines_doc[] =
1436"readlines([size]) -> list of strings, each a line from the file.\n"
1437"\n"
1438"Call readline() repeatedly and return a list of the lines so read.\n"
1439"The optional size argument, if given, is an approximate bound on the\n"
1440"total number of bytes in the lines returned.";
1441
1442static char xreadlines_doc[] =
1443"xreadlines() -> next line from the file, as a string.\n"
1444"\n"
1445"Equivalent to xreadlines.xreadlines(file). This is like readline(), but\n"
1446"often quicker, due to reading ahead internally.";
1447
1448static char writelines_doc[] =
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001449"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001450"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001451"Note that newlines are not added. The sequence can be any iterable object\n"
1452"producing strings. This is equivalent to calling write() for each string.";
Tim Petersefc3a3a2001-09-20 07:55:22 +00001453
1454static char flush_doc[] =
1455"flush() -> None. Flush the internal I/O buffer.";
1456
1457static char close_doc[] =
1458"close() -> None or (perhaps) an integer. Close the file.\n"
1459"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001460"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001461"further I/O operations. close() may be called more than once without\n"
1462"error. Some kinds of file objects (for example, opened by popen())\n"
1463"may return an exit status upon closing.";
1464
1465static char isatty_doc[] =
1466"isatty() -> true or false. True if the file is connected to a tty device.";
1467
1468static PyMethodDef file_methods[] = {
1469 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1470 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001471 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001472 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1473 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
1474#ifdef HAVE_FTRUNCATE
1475 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
1476#endif
1477 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
Neal Norwitz62f5a9d2002-04-01 00:09:00 +00001478 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001479 {"readlines", (PyCFunction)file_readlines, METH_VARARGS, readlines_doc},
1480 {"xreadlines", (PyCFunction)file_xreadlines, METH_NOARGS, xreadlines_doc},
1481 {"writelines", (PyCFunction)file_writelines, METH_O, writelines_doc},
1482 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1483 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1484 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001485 {NULL, NULL} /* sentinel */
1486};
1487
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001488#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001489
Guido van Rossum6f799372001-09-20 20:46:19 +00001490static PyMemberDef file_memberlist[] = {
1491 {"softspace", T_INT, OFF(f_softspace), 0,
1492 "flag indicating that a space needs to be printed; used by print"},
1493 {"mode", T_OBJECT, OFF(f_mode), RO,
1494 "file mode ('r', 'w', 'a', possibly with 'b' or '+' added)"},
1495 {"name", T_OBJECT, OFF(f_name), RO,
1496 "file name"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001497 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001498 {NULL} /* Sentinel */
1499};
1500
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001501static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001502get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001503{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001504 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001505}
1506
Guido van Rossum32d34c82001-09-20 21:45:26 +00001507static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001508 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001509 {0},
1510};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001511
Guido van Rossum65967252001-04-21 13:20:18 +00001512static PyObject *
Guido van Rossum5b021842001-05-22 16:48:37 +00001513file_getiter(PyObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001514{
Guido van Rossum5b021842001-05-22 16:48:37 +00001515 return PyObject_CallMethod(f, "xreadlines", "");
Guido van Rossum65967252001-04-21 13:20:18 +00001516}
1517
Tim Peters59c9a642001-09-13 05:38:56 +00001518static PyObject *
1519file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1520{
Tim Peters44410012001-09-14 03:26:08 +00001521 PyObject *self;
1522 static PyObject *not_yet_string;
1523
1524 assert(type != NULL && type->tp_alloc != NULL);
1525
1526 if (not_yet_string == NULL) {
1527 not_yet_string = PyString_FromString("<uninitialized file>");
1528 if (not_yet_string == NULL)
1529 return NULL;
1530 }
1531
1532 self = type->tp_alloc(type, 0);
1533 if (self != NULL) {
1534 /* Always fill in the name and mode, so that nobody else
1535 needs to special-case NULLs there. */
1536 Py_INCREF(not_yet_string);
1537 ((PyFileObject *)self)->f_name = not_yet_string;
1538 Py_INCREF(not_yet_string);
1539 ((PyFileObject *)self)->f_mode = not_yet_string;
1540 }
1541 return self;
1542}
1543
1544static int
1545file_init(PyObject *self, PyObject *args, PyObject *kwds)
1546{
1547 PyFileObject *foself = (PyFileObject *)self;
1548 int ret = 0;
Tim Peters59c9a642001-09-13 05:38:56 +00001549 static char *kwlist[] = {"name", "mode", "buffering", 0};
1550 char *name = NULL;
1551 char *mode = "r";
1552 int bufsize = -1;
Tim Peters44410012001-09-14 03:26:08 +00001553
1554 assert(PyFile_Check(self));
1555 if (foself->f_fp != NULL) {
1556 /* Have to close the existing file first. */
1557 PyObject *closeresult = file_close(foself);
1558 if (closeresult == NULL)
1559 return -1;
1560 Py_DECREF(closeresult);
1561 }
Tim Peters59c9a642001-09-13 05:38:56 +00001562
1563 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
1564 Py_FileSystemDefaultEncoding, &name,
1565 &mode, &bufsize))
Tim Peters44410012001-09-14 03:26:08 +00001566 return -1;
1567 if (fill_file_fields(foself, NULL, name, mode, fclose) == NULL)
1568 goto Error;
1569 if (open_the_file(foself, name, mode) == NULL)
1570 goto Error;
1571 PyFile_SetBufSize(self, bufsize);
1572 goto Done;
1573
1574Error:
1575 ret = -1;
1576 /* fall through */
1577Done:
Tim Peters59c9a642001-09-13 05:38:56 +00001578 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00001579 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00001580}
1581
Tim Peters59c9a642001-09-13 05:38:56 +00001582static char file_doc[] =
1583"file(name[, mode[, buffering]]) -> file object\n"
1584"\n"
1585"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
1586"writing or appending. The file will be created if it doesn't exist\n"
1587"when opened for writing or appending; it will be truncated when\n"
1588"opened for writing. Add a 'b' to the mode for binary files.\n"
1589"Add a '+' to the mode to allow simultaneous reading and writing.\n"
1590"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00001591"buffered, and larger numbers specify the buffer size.\n"
1592"Note: open() is an alias for file().\n";
Tim Peters59c9a642001-09-13 05:38:56 +00001593
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001594PyTypeObject PyFile_Type = {
1595 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001596 0,
1597 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001598 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001599 0,
Guido van Rossum65967252001-04-21 13:20:18 +00001600 (destructor)file_dealloc, /* tp_dealloc */
1601 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001602 0, /* tp_getattr */
1603 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00001604 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001605 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00001606 0, /* tp_as_number */
1607 0, /* tp_as_sequence */
1608 0, /* tp_as_mapping */
1609 0, /* tp_hash */
1610 0, /* tp_call */
1611 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001612 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum65967252001-04-21 13:20:18 +00001613 0, /* tp_setattro */
1614 0, /* tp_as_buffer */
Guido van Rossum9475a232001-10-05 20:51:39 +00001615 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00001616 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001617 0, /* tp_traverse */
1618 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00001619 0, /* tp_richcompare */
1620 0, /* tp_weaklistoffset */
Guido van Rossum5b021842001-05-22 16:48:37 +00001621 file_getiter, /* tp_iter */
Guido van Rossum213c7a62001-04-23 14:08:49 +00001622 0, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00001623 file_methods, /* tp_methods */
1624 file_memberlist, /* tp_members */
1625 file_getsetlist, /* tp_getset */
1626 0, /* tp_base */
1627 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00001628 0, /* tp_descr_get */
1629 0, /* tp_descr_set */
1630 0, /* tp_dictoffset */
Tim Peters44410012001-09-14 03:26:08 +00001631 (initproc)file_init, /* tp_init */
1632 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00001633 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00001634 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001635};
Guido van Rossumeb183da1991-04-04 10:44:06 +00001636
1637/* Interface for the 'soft space' between print items. */
1638
1639int
Fred Drakefd99de62000-07-09 05:02:18 +00001640PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00001641{
1642 int oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001643 if (f == NULL) {
1644 /* Do nothing */
1645 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001646 else if (PyFile_Check(f)) {
1647 oldflag = ((PyFileObject *)f)->f_softspace;
1648 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001649 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001650 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001651 PyObject *v;
1652 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001653 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001654 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001655 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001656 if (PyInt_Check(v))
1657 oldflag = PyInt_AsLong(v);
1658 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001659 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001660 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001661 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001662 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00001663 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001664 if (PyObject_SetAttrString(f, "softspace", v) != 0)
1665 PyErr_Clear();
1666 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001667 }
1668 }
Guido van Rossumeb183da1991-04-04 10:44:06 +00001669 return oldflag;
1670}
Guido van Rossum3165fe61992-09-25 21:59:05 +00001671
1672/* Interfaces to write objects/strings to file-like objects */
1673
1674int
Fred Drakefd99de62000-07-09 05:02:18 +00001675PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001676{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001677 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001678 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001679 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001680 return -1;
1681 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001682 else if (PyFile_Check(f)) {
1683 FILE *fp = PyFile_AsFile(f);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001684 if (fp == NULL) {
1685 err_closed();
1686 return -1;
1687 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001688 return PyObject_Print(v, fp, flags);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001689 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001690 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001691 if (writer == NULL)
1692 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00001693 if (flags & Py_PRINT_RAW) {
1694 if (PyUnicode_Check(v)) {
1695 value = v;
1696 Py_INCREF(value);
1697 } else
1698 value = PyObject_Str(v);
1699 }
1700 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001701 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00001702 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001703 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00001704 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001705 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001706 args = Py_BuildValue("(O)", value);
Guido van Rossume9eec541997-05-22 14:02:25 +00001707 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001708 Py_DECREF(value);
1709 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00001710 return -1;
1711 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001712 result = PyEval_CallObject(writer, args);
1713 Py_DECREF(args);
1714 Py_DECREF(value);
1715 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001716 if (result == NULL)
1717 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001718 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001719 return 0;
1720}
1721
Guido van Rossum27a60b11997-05-22 22:25:11 +00001722int
Tim Petersc1bbcb82001-11-28 22:13:25 +00001723PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00001724{
1725 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00001726 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00001727 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00001728 PyErr_SetString(PyExc_SystemError,
1729 "null file for PyFile_WriteString");
1730 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001731 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001732 else if (PyFile_Check(f)) {
1733 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001734 if (fp == NULL) {
1735 err_closed();
1736 return -1;
1737 }
1738 fputs(s, fp);
1739 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001740 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001741 else if (!PyErr_Occurred()) {
1742 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00001743 int err;
1744 if (v == NULL)
1745 return -1;
1746 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
1747 Py_DECREF(v);
1748 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001749 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00001750 else
1751 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001752}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001753
1754/* Try to get a file-descriptor from a Python object. If the object
1755 is an integer or long integer, its value is returned. If not, the
1756 object's fileno() method is called if it exists; the method must return
1757 an integer or long integer, which is returned as the file descriptor value.
1758 -1 is returned on failure.
1759*/
1760
1761int PyObject_AsFileDescriptor(PyObject *o)
1762{
1763 int fd;
1764 PyObject *meth;
1765
1766 if (PyInt_Check(o)) {
1767 fd = PyInt_AsLong(o);
1768 }
1769 else if (PyLong_Check(o)) {
1770 fd = PyLong_AsLong(o);
1771 }
1772 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
1773 {
1774 PyObject *fno = PyEval_CallObject(meth, NULL);
1775 Py_DECREF(meth);
1776 if (fno == NULL)
1777 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00001778
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00001779 if (PyInt_Check(fno)) {
1780 fd = PyInt_AsLong(fno);
1781 Py_DECREF(fno);
1782 }
1783 else if (PyLong_Check(fno)) {
1784 fd = PyLong_AsLong(fno);
1785 Py_DECREF(fno);
1786 }
1787 else {
1788 PyErr_SetString(PyExc_TypeError,
1789 "fileno() returned a non-integer");
1790 Py_DECREF(fno);
1791 return -1;
1792 }
1793 }
1794 else {
1795 PyErr_SetString(PyExc_TypeError,
1796 "argument must be an int, or have a fileno() method.");
1797 return -1;
1798 }
1799
1800 if (fd < 0) {
1801 PyErr_Format(PyExc_ValueError,
1802 "file descriptor cannot be a negative integer (%i)",
1803 fd);
1804 return -1;
1805 }
1806 return fd;
1807}