blob: 76b7da641950399bb85c330842a0832c970258de [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* File object implementation */
2
Martin v. Löwis18e16552006-02-15 17:27:45 +00003#define PY_SSIZE_T_CLEAN
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
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +00007#ifdef HAVE_SYS_TYPES_H
Guido van Rossum41498431999-01-07 22:09:51 +00008#include <sys/types.h>
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +00009#endif /* HAVE_SYS_TYPES_H */
Guido van Rossum41498431999-01-07 22:09:51 +000010
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000011#ifdef MS_WINDOWS
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 Peters7a1f9172002-07-14 22:14:19 +000015#define WIN32_LEAN_AND_MEAN
Tim Petersfb05db22002-03-11 00:24:00 +000016#include <windows.h>
Guido van Rossumb8199141997-05-06 15:23:24 +000017#endif
18
Mark Hammondc2e85bd2002-10-03 05:10:39 +000019#ifdef _MSC_VER
20/* Need GetVersion to see if on NT so safe to use _wfopen */
21#define WIN32_LEAN_AND_MEAN
22#include <windows.h>
23#endif /* _MSC_VER */
24
Andrew MacIntyrec4874392002-02-26 11:36:35 +000025#if defined(PYOS_OS2) && defined(PYCC_GCC)
26#include <io.h>
27#endif
28
Guido van Rossumc0b618a1997-05-02 03:12:38 +000029#define BUF(v) PyString_AS_STRING((PyStringObject *)v)
Guido van Rossumce5ba841991-03-06 13:06:18 +000030
Guido van Rossumff7e83d1999-08-27 20:39:37 +000031#ifndef DONT_HAVE_ERRNO_H
Guido van Rossumf1dc5661993-07-05 10:31:29 +000032#include <errno.h>
Guido van Rossumff7e83d1999-08-27 20:39:37 +000033#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000034
Jack Jansen7b8c7542002-04-14 20:12:41 +000035#ifdef HAVE_GETC_UNLOCKED
36#define GETC(f) getc_unlocked(f)
37#define FLOCKFILE(f) flockfile(f)
38#define FUNLOCKFILE(f) funlockfile(f)
39#else
40#define GETC(f) getc(f)
41#define FLOCKFILE(f)
42#define FUNLOCKFILE(f)
43#endif
44
Jack Jansen7b8c7542002-04-14 20:12:41 +000045/* Bits in f_newlinetypes */
46#define NEWLINE_UNKNOWN 0 /* No newline seen, yet */
47#define NEWLINE_CR 1 /* \r newline seen */
48#define NEWLINE_LF 2 /* \n newline seen */
49#define NEWLINE_CRLF 4 /* \r\n newline seen */
Trent Mickf29f47b2000-08-11 19:02:59 +000050
Anthony Baxterac6bd462006-04-13 02:06:09 +000051#ifdef __cplusplus
52extern "C" {
53#endif
54
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000055FILE *
Fred Drakefd99de62000-07-09 05:02:18 +000056PyFile_AsFile(PyObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000057{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000058 if (f == NULL || !PyFile_Check(f))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000059 return NULL;
Guido van Rossum3165fe61992-09-25 21:59:05 +000060 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000061 return ((PyFileObject *)f)->f_fp;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000062}
63
Guido van Rossumc0b618a1997-05-02 03:12:38 +000064PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +000065PyFile_Name(PyObject *f)
Guido van Rossumdb3165e1993-10-18 17:06:59 +000066{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000067 if (f == NULL || !PyFile_Check(f))
Guido van Rossumdb3165e1993-10-18 17:06:59 +000068 return NULL;
69 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000070 return ((PyFileObject *)f)->f_name;
Guido van Rossumdb3165e1993-10-18 17:06:59 +000071}
72
Neil Schemenauered19b882002-03-23 02:06:50 +000073/* On Unix, fopen will succeed for directories.
74 In Python, there should be no file objects referring to
75 directories, so we need a check. */
76
77static PyFileObject*
78dircheck(PyFileObject* f)
79{
80#if defined(HAVE_FSTAT) && defined(S_IFDIR) && defined(EISDIR)
81 struct stat buf;
82 if (f->f_fp == NULL)
83 return f;
84 if (fstat(fileno(f->f_fp), &buf) == 0 &&
85 S_ISDIR(buf.st_mode)) {
86#ifdef HAVE_STRERROR
87 char *msg = strerror(EISDIR);
88#else
89 char *msg = "Is a directory";
90#endif
Tim Petersf1827cf2003-09-07 03:30:18 +000091 PyObject *exc = PyObject_CallFunction(PyExc_IOError, "(is)",
Jeremy Hylton8b735422002-08-14 21:01:41 +000092 EISDIR, msg);
Neil Schemenauered19b882002-03-23 02:06:50 +000093 PyErr_SetObject(PyExc_IOError, exc);
Neal Norwitz98cad482003-08-15 20:05:45 +000094 Py_XDECREF(exc);
Neil Schemenauered19b882002-03-23 02:06:50 +000095 return NULL;
96 }
97#endif
98 return f;
99}
100
Tim Peters59c9a642001-09-13 05:38:56 +0000101
102static PyObject *
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000103fill_file_fields(PyFileObject *f, FILE *fp, PyObject *name, char *mode,
104 int (*close)(FILE *))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000105{
Tim Peters59c9a642001-09-13 05:38:56 +0000106 assert(f != NULL);
107 assert(PyFile_Check(f));
Tim Peters44410012001-09-14 03:26:08 +0000108 assert(f->f_fp == NULL);
109
110 Py_DECREF(f->f_name);
111 Py_DECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000112 Py_DECREF(f->f_encoding);
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000113
114 Py_INCREF (name);
115 f->f_name = name;
116
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000117 f->f_mode = PyString_FromString(mode);
Tim Peters44410012001-09-14 03:26:08 +0000118
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000119 f->f_close = close;
Guido van Rossumeb183da1991-04-04 10:44:06 +0000120 f->f_softspace = 0;
Tim Peters59c9a642001-09-13 05:38:56 +0000121 f->f_binary = strchr(mode,'b') != NULL;
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000122 f->f_buf = NULL;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000123 f->f_univ_newline = (strchr(mode, 'U') != NULL);
124 f->f_newlinetypes = NEWLINE_UNKNOWN;
125 f->f_skipnextlf = 0;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000126 Py_INCREF(Py_None);
127 f->f_encoding = Py_None;
Tim Petersf1827cf2003-09-07 03:30:18 +0000128
Tim Peters59c9a642001-09-13 05:38:56 +0000129 if (f->f_name == NULL || f->f_mode == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000130 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000131 f->f_fp = fp;
Neil Schemenauered19b882002-03-23 02:06:50 +0000132 f = dircheck(f);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000133 return (PyObject *) f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000134}
135
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000136/* check for known incorrect mode strings - problem is, platforms are
137 free to accept any mode characters they like and are supposed to
138 ignore stuff they don't understand... write or append mode with
Georg Brandl7b90e162006-05-18 07:01:27 +0000139 universal newline support is expressly forbidden by PEP 278.
140 Additionally, remove the 'U' from the mode string as platforms
141 won't know what it is. */
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000142/* zero return is kewl - one is un-kewl */
143static int
Georg Brandl7b90e162006-05-18 07:01:27 +0000144sanitize_the_mode(char *mode)
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000145{
Georg Brandl7b90e162006-05-18 07:01:27 +0000146 char *upos;
Neal Norwitz76dc0812006-01-08 06:13:13 +0000147 size_t len = strlen(mode);
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000148
Georg Brandl7b90e162006-05-18 07:01:27 +0000149 if (!len) {
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000150 PyErr_SetString(PyExc_ValueError, "empty mode string");
151 return 1;
Georg Brandl7b90e162006-05-18 07:01:27 +0000152 }
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000153
Georg Brandl7b90e162006-05-18 07:01:27 +0000154 upos = strchr(mode, 'U');
155 if (upos) {
156 memmove(upos, upos+1, len-(upos-mode)); /* incl null char */
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000157
Georg Brandl7b90e162006-05-18 07:01:27 +0000158 if (mode[0] == 'w' || mode[0] == 'a') {
159 PyErr_Format(PyExc_ValueError, "universal newline "
160 "mode can only be used with modes "
161 "starting with 'r'");
162 return 1;
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000163 }
Georg Brandl7b90e162006-05-18 07:01:27 +0000164
165 if (mode[0] != 'r') {
166 memmove(mode+1, mode, strlen(mode)+1);
167 mode[0] = 'r';
168 }
169
170 if (!strchr(mode, 'b')) {
171 memmove(mode+2, mode+1, strlen(mode));
172 mode[1] = 'b';
173 }
174 } else if (mode[0] != 'r' && mode[0] != 'w' && mode[0] != 'a') {
175 PyErr_Format(PyExc_ValueError, "mode string must begin with "
176 "one of 'r', 'w', 'a' or 'U', not '%.200s'", mode);
177 return 1;
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000178 }
179
180 return 0;
181}
182
Tim Peters59c9a642001-09-13 05:38:56 +0000183static PyObject *
184open_the_file(PyFileObject *f, char *name, char *mode)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000185{
Georg Brandl7b90e162006-05-18 07:01:27 +0000186 char *newmode;
Tim Peters59c9a642001-09-13 05:38:56 +0000187 assert(f != NULL);
188 assert(PyFile_Check(f));
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000189#ifdef MS_WINDOWS
190 /* windows ignores the passed name in order to support Unicode */
191 assert(f->f_name != NULL);
192#else
Tim Peters59c9a642001-09-13 05:38:56 +0000193 assert(name != NULL);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000194#endif
Tim Peters59c9a642001-09-13 05:38:56 +0000195 assert(mode != NULL);
Tim Peters44410012001-09-14 03:26:08 +0000196 assert(f->f_fp == NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000197
Georg Brandl7b90e162006-05-18 07:01:27 +0000198 /* probably need to replace 'U' by 'rb' */
199 newmode = PyMem_MALLOC(strlen(mode) + 3);
200 if (!newmode) {
201 PyErr_NoMemory();
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000202 return NULL;
Georg Brandl7b90e162006-05-18 07:01:27 +0000203 }
204 strcpy(newmode, mode);
205
206 if (sanitize_the_mode(newmode)) {
207 f = NULL;
208 goto cleanup;
209 }
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000210
Tim Peters8fa45672001-09-13 21:01:29 +0000211 /* rexec.py can't stop a user from getting the file() constructor --
212 all they have to do is get *any* file object f, and then do
213 type(f). Here we prevent them from doing damage with it. */
214 if (PyEval_GetRestricted()) {
215 PyErr_SetString(PyExc_IOError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000216 "file() constructor not accessible in restricted mode");
Georg Brandl7b90e162006-05-18 07:01:27 +0000217 f = NULL;
218 goto cleanup;
Tim Peters8fa45672001-09-13 21:01:29 +0000219 }
Tim Petersa27a1502001-11-09 20:59:14 +0000220 errno = 0;
Skip Montanaro51ffac62004-06-11 04:49:03 +0000221
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000222#ifdef MS_WINDOWS
Skip Montanaro51ffac62004-06-11 04:49:03 +0000223 if (PyUnicode_Check(f->f_name)) {
224 PyObject *wmode;
Georg Brandl7b90e162006-05-18 07:01:27 +0000225 wmode = PyUnicode_DecodeASCII(newmode, strlen(newmode), NULL);
Skip Montanaro51ffac62004-06-11 04:49:03 +0000226 if (f->f_name && wmode) {
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000227 Py_BEGIN_ALLOW_THREADS
Skip Montanaro51ffac62004-06-11 04:49:03 +0000228 /* PyUnicode_AS_UNICODE OK without thread
229 lock as it is a simple dereference. */
230 f->f_fp = _wfopen(PyUnicode_AS_UNICODE(f->f_name),
231 PyUnicode_AS_UNICODE(wmode));
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000232 Py_END_ALLOW_THREADS
233 }
Skip Montanaro51ffac62004-06-11 04:49:03 +0000234 Py_XDECREF(wmode);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000235 }
Skip Montanaro51ffac62004-06-11 04:49:03 +0000236#endif
237 if (NULL == f->f_fp && NULL != name) {
238 Py_BEGIN_ALLOW_THREADS
Georg Brandl7b90e162006-05-18 07:01:27 +0000239 f->f_fp = fopen(name, newmode);
Skip Montanaro51ffac62004-06-11 04:49:03 +0000240 Py_END_ALLOW_THREADS
241 }
242
Guido van Rossuma08095a1991-02-13 23:25:27 +0000243 if (f->f_fp == NULL) {
Kristján Valur Jónsson74c3ea02006-07-03 14:59:05 +0000244#if defined _MSC_VER && (_MSC_VER < 1400 || !defined(__STDC_SECURE_LIB__))
Tim Peters2ea91112002-04-08 04:13:12 +0000245 /* MSVC 6 (Microsoft) leaves errno at 0 for bad mode strings,
246 * across all Windows flavors. When it sets EINVAL varies
247 * across Windows flavors, the exact conditions aren't
248 * documented, and the answer lies in the OS's implementation
249 * of Win32's CreateFile function (whose source is secret).
250 * Seems the best we can do is map EINVAL to ENOENT.
Kristján Valur Jónssonf6083172006-06-12 15:45:12 +0000251 * Starting with Visual Studio .NET 2005, EINVAL is correctly
252 * set by our CRT error handler (set in exceptions.c.)
Tim Peters2ea91112002-04-08 04:13:12 +0000253 */
254 if (errno == 0) /* bad mode string */
255 errno = EINVAL;
256 else if (errno == EINVAL) /* unknown, but not a mode string */
257 errno = ENOENT;
258#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000259 if (errno == EINVAL)
Tim Peters2ea91112002-04-08 04:13:12 +0000260 PyErr_Format(PyExc_IOError, "invalid mode: %s",
Jeremy Hylton41c83212001-11-09 16:17:24 +0000261 mode);
262 else
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000263 PyErr_SetFromErrnoWithFilenameObject(PyExc_IOError, f->f_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000264 f = NULL;
265 }
Tim Peters2ea91112002-04-08 04:13:12 +0000266 if (f != NULL)
Neil Schemenauered19b882002-03-23 02:06:50 +0000267 f = dircheck(f);
Georg Brandl7b90e162006-05-18 07:01:27 +0000268
269cleanup:
270 PyMem_FREE(newmode);
271
Tim Peters59c9a642001-09-13 05:38:56 +0000272 return (PyObject *)f;
273}
274
275PyObject *
276PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
277{
Tim Peters44410012001-09-14 03:26:08 +0000278 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
279 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000280 if (f != NULL) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000281 PyObject *o_name = PyString_FromString(name);
282 if (fill_file_fields(f, fp, o_name, mode, close) == NULL) {
Tim Peters59c9a642001-09-13 05:38:56 +0000283 Py_DECREF(f);
284 f = NULL;
285 }
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000286 Py_DECREF(o_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000287 }
288 return (PyObject *) f;
289}
290
291PyObject *
292PyFile_FromString(char *name, char *mode)
293{
294 extern int fclose(FILE *);
295 PyFileObject *f;
296
297 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
298 if (f != NULL) {
299 if (open_the_file(f, name, mode) == NULL) {
300 Py_DECREF(f);
301 f = NULL;
302 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000303 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000304 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000305}
306
Guido van Rossumb6775db1994-08-01 11:34:53 +0000307void
Fred Drakefd99de62000-07-09 05:02:18 +0000308PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000309{
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000310 PyFileObject *file = (PyFileObject *)f;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000311 if (bufsize >= 0) {
Guido van Rossumb6775db1994-08-01 11:34:53 +0000312 int type;
313 switch (bufsize) {
314 case 0:
315 type = _IONBF;
316 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000317#ifdef HAVE_SETVBUF
Guido van Rossumb6775db1994-08-01 11:34:53 +0000318 case 1:
319 type = _IOLBF;
320 bufsize = BUFSIZ;
321 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000322#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000323 default:
324 type = _IOFBF;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000325#ifndef HAVE_SETVBUF
326 bufsize = BUFSIZ;
327#endif
328 break;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000329 }
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000330 fflush(file->f_fp);
331 if (type == _IONBF) {
332 PyMem_Free(file->f_setbuf);
333 file->f_setbuf = NULL;
334 } else {
Anthony Baxter377be112006-04-11 06:54:30 +0000335 file->f_setbuf = (char *)PyMem_Realloc(file->f_setbuf,
336 bufsize);
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000337 }
338#ifdef HAVE_SETVBUF
339 setvbuf(file->f_fp, file->f_setbuf, type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000340#else /* !HAVE_SETVBUF */
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000341 setbuf(file->f_fp, file->f_setbuf);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000342#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000343 }
344}
345
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000346/* Set the encoding used to output Unicode strings.
347 Returh 1 on success, 0 on failure. */
348
349int
350PyFile_SetEncoding(PyObject *f, const char *enc)
351{
352 PyFileObject *file = (PyFileObject*)f;
353 PyObject *str = PyString_FromString(enc);
354 if (!str)
355 return 0;
356 Py_DECREF(file->f_encoding);
357 file->f_encoding = str;
358 return 1;
359}
360
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000361static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000362err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000363{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000364 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000365 return NULL;
366}
367
Thomas Woutersc45251a2006-02-12 11:53:32 +0000368/* Refuse regular file I/O if there's data in the iteration-buffer.
369 * Mixing them would cause data to arrive out of order, as the read*
370 * methods don't use the iteration buffer. */
371static PyObject *
372err_iterbuffered(void)
373{
374 PyErr_SetString(PyExc_ValueError,
375 "Mixing iteration and read methods would lose data");
376 return NULL;
377}
378
Neal Norwitzd8b995f2002-08-06 21:50:54 +0000379static void drop_readahead(PyFileObject *);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000380
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000381/* Methods */
382
383static void
Fred Drakefd99de62000-07-09 05:02:18 +0000384file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000385{
Peter Astrandf8e74b12004-11-07 14:15:28 +0000386 int sts = 0;
Raymond Hettingercb87bc82004-05-31 00:35:52 +0000387 if (f->weakreflist != NULL)
388 PyObject_ClearWeakRefs((PyObject *) f);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000389 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000390 Py_BEGIN_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000391 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000392 Py_END_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000393 if (sts == EOF)
394#ifdef HAVE_STRERROR
395 PySys_WriteStderr("close failed: [Errno %d] %s\n", errno, strerror(errno));
396#else
397 PySys_WriteStderr("close failed: [Errno %d]\n", errno);
398#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000399 }
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000400 PyMem_Free(f->f_setbuf);
Tim Peters44410012001-09-14 03:26:08 +0000401 Py_XDECREF(f->f_name);
402 Py_XDECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000403 Py_XDECREF(f->f_encoding);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000404 drop_readahead(f);
Guido van Rossum9475a232001-10-05 20:51:39 +0000405 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000406}
407
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000408static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000409file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000410{
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000411 if (PyUnicode_Check(f->f_name)) {
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000412#ifdef Py_USING_UNICODE
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000413 PyObject *ret = NULL;
414 PyObject *name;
415 name = PyUnicode_AsUnicodeEscapeString(f->f_name);
416 ret = PyString_FromFormat("<%s file u'%s', mode '%s' at %p>",
417 f->f_fp == NULL ? "closed" : "open",
418 PyString_AsString(name),
419 PyString_AsString(f->f_mode),
420 f);
421 Py_XDECREF(name);
422 return ret;
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000423#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000424 } else {
425 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000426 f->f_fp == NULL ? "closed" : "open",
427 PyString_AsString(f->f_name),
428 PyString_AsString(f->f_mode),
429 f);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000430 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000431}
432
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000433static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000434file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000435{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000436 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000437 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000438 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000439 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000440 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000441 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000442 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000443 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000444 f->f_fp = NULL;
445 }
Martin v. Löwis7bbcde72003-09-07 20:42:29 +0000446 PyMem_Free(f->f_setbuf);
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000447 f->f_setbuf = NULL;
Guido van Rossumfebd5511992-03-04 16:39:24 +0000448 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000449 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000450 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000451 return PyInt_FromLong((long)sts);
452 Py_INCREF(Py_None);
453 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000454}
455
Trent Mickf29f47b2000-08-11 19:02:59 +0000456
Guido van Rossumb8552162001-09-05 14:58:11 +0000457/* Our very own off_t-like type, 64-bit if possible */
458#if !defined(HAVE_LARGEFILE_SUPPORT)
459typedef off_t Py_off_t;
460#elif SIZEOF_OFF_T >= 8
461typedef off_t Py_off_t;
462#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000463typedef fpos_t Py_off_t;
464#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000465#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000466#endif
467
468
Trent Mickf29f47b2000-08-11 19:02:59 +0000469/* a portable fseek() function
470 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000471static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000472_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000473{
Guido van Rossumb8552162001-09-05 14:58:11 +0000474#if !defined(HAVE_LARGEFILE_SUPPORT)
475 return fseek(fp, offset, whence);
476#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000477 return fseeko(fp, offset, whence);
478#elif defined(HAVE_FSEEK64)
479 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000480#elif defined(__BEOS__)
481 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000482#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000483 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
484 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000485 fpos_t pos;
486 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000487 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000488#ifdef MS_WINDOWS
489 fflush(fp);
490 if (_lseeki64(fileno(fp), 0, 2) == -1)
491 return -1;
492#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000493 if (fseek(fp, 0, SEEK_END) != 0)
494 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000495#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000496 /* fall through */
497 case SEEK_CUR:
498 if (fgetpos(fp, &pos) != 0)
499 return -1;
500 offset += pos;
501 break;
502 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000503 }
504 return fsetpos(fp, &offset);
505#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000506#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000507#endif
508}
509
510
511/* a portable ftell() function
512 Return -1 on failure with errno set appropriately, current file
513 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000514static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000515_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000516{
Guido van Rossumb8552162001-09-05 14:58:11 +0000517#if !defined(HAVE_LARGEFILE_SUPPORT)
518 return ftell(fp);
519#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
520 return ftello(fp);
521#elif defined(HAVE_FTELL64)
522 return ftell64(fp);
523#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000524 fpos_t pos;
525 if (fgetpos(fp, &pos) != 0)
526 return -1;
527 return pos;
528#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000529#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000530#endif
531}
532
533
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000534static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000535file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000536{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000537 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000538 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000539 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000540 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000541
Guido van Rossumd7297e61992-07-06 14:19:26 +0000542 if (f->f_fp == NULL)
543 return err_closed();
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000544 drop_readahead(f);
Guido van Rossumd7297e61992-07-06 14:19:26 +0000545 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000546 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000547 return NULL;
548#if !defined(HAVE_LARGEFILE_SUPPORT)
549 offset = PyInt_AsLong(offobj);
550#else
551 offset = PyLong_Check(offobj) ?
552 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
553#endif
554 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000555 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000556
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000557 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000558 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000559 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000560 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000561
Guido van Rossumff4949e1992-08-05 19:58:53 +0000562 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000563 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000564 clearerr(f->f_fp);
565 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000566 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000567 f->f_skipnextlf = 0;
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
Trent Mickf29f47b2000-08-11 19:02:59 +0000572
Guido van Rossumd7047b31995-01-02 19:07:15 +0000573#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000574static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000575file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000576{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000577 Py_off_t newsize;
Tim Petersf1827cf2003-09-07 03:30:18 +0000578 PyObject *newsizeobj = NULL;
579 Py_off_t initialpos;
580 int ret;
Tim Peters86821b22001-01-07 21:19:34 +0000581
Guido van Rossumd7047b31995-01-02 19:07:15 +0000582 if (f->f_fp == NULL)
583 return err_closed();
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000584 if (!PyArg_UnpackTuple(args, "truncate", 0, 1, &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000585 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000586
Tim Petersf1827cf2003-09-07 03:30:18 +0000587 /* Get current file position. If the file happens to be open for
588 * update and the last operation was an input operation, C doesn't
589 * define what the later fflush() will do, but we promise truncate()
590 * won't change the current position (and fflush() *does* change it
591 * then at least on Windows). The easiest thing is to capture
592 * current pos now and seek back to it at the end.
593 */
594 Py_BEGIN_ALLOW_THREADS
595 errno = 0;
596 initialpos = _portable_ftell(f->f_fp);
597 Py_END_ALLOW_THREADS
598 if (initialpos == -1)
599 goto onioerror;
600
Tim Petersfb05db22002-03-11 00:24:00 +0000601 /* Set newsize to current postion if newsizeobj NULL, else to the
Tim Petersf1827cf2003-09-07 03:30:18 +0000602 * specified value.
603 */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000604 if (newsizeobj != NULL) {
605#if !defined(HAVE_LARGEFILE_SUPPORT)
606 newsize = PyInt_AsLong(newsizeobj);
607#else
608 newsize = PyLong_Check(newsizeobj) ?
609 PyLong_AsLongLong(newsizeobj) :
610 PyInt_AsLong(newsizeobj);
611#endif
612 if (PyErr_Occurred())
613 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000614 }
Tim Petersf1827cf2003-09-07 03:30:18 +0000615 else /* default to current position */
616 newsize = initialpos;
Tim Petersfb05db22002-03-11 00:24:00 +0000617
Tim Petersf1827cf2003-09-07 03:30:18 +0000618 /* Flush the stream. We're mixing stream-level I/O with lower-level
619 * I/O, and a flush may be necessary to synch both platform views
620 * of the current file state.
621 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000622 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000623 errno = 0;
624 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000625 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000626 if (ret != 0)
627 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000628
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000629#ifdef MS_WINDOWS
Tim Petersfb05db22002-03-11 00:24:00 +0000630 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000631 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000632 {
Tim Petersfb05db22002-03-11 00:24:00 +0000633 HANDLE hFile;
Tim Petersfb05db22002-03-11 00:24:00 +0000634
Tim Petersf1827cf2003-09-07 03:30:18 +0000635 /* Have to move current pos to desired endpoint on Windows. */
636 Py_BEGIN_ALLOW_THREADS
637 errno = 0;
638 ret = _portable_fseek(f->f_fp, newsize, SEEK_SET) != 0;
639 Py_END_ALLOW_THREADS
640 if (ret)
641 goto onioerror;
Tim Petersfb05db22002-03-11 00:24:00 +0000642
Tim Peters8f01b682002-03-12 03:04:44 +0000643 /* Truncate. Note that this may grow the file! */
644 Py_BEGIN_ALLOW_THREADS
645 errno = 0;
646 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
Tim Petersf1827cf2003-09-07 03:30:18 +0000647 ret = hFile == (HANDLE)-1;
648 if (ret == 0) {
649 ret = SetEndOfFile(hFile) == 0;
650 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000651 errno = EACCES;
652 }
653 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000654 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000655 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000656 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000657#else
658 Py_BEGIN_ALLOW_THREADS
659 errno = 0;
660 ret = ftruncate(fileno(f->f_fp), newsize);
661 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000662 if (ret != 0)
663 goto onioerror;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000664#endif /* !MS_WINDOWS */
Tim Peters86821b22001-01-07 21:19:34 +0000665
Tim Petersf1827cf2003-09-07 03:30:18 +0000666 /* Restore original file position. */
667 Py_BEGIN_ALLOW_THREADS
668 errno = 0;
669 ret = _portable_fseek(f->f_fp, initialpos, SEEK_SET) != 0;
670 Py_END_ALLOW_THREADS
671 if (ret)
672 goto onioerror;
673
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000674 Py_INCREF(Py_None);
675 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000676
677onioerror:
678 PyErr_SetFromErrno(PyExc_IOError);
679 clearerr(f->f_fp);
680 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000681}
682#endif /* HAVE_FTRUNCATE */
683
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000684static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000685file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000686{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000687 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000688
Guido van Rossumd7297e61992-07-06 14:19:26 +0000689 if (f->f_fp == NULL)
690 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000691 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000692 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000693 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000694 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000695 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000696 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000697 clearerr(f->f_fp);
698 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000699 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000700 if (f->f_skipnextlf) {
701 int c;
702 c = GETC(f->f_fp);
703 if (c == '\n') {
704 pos++;
705 f->f_skipnextlf = 0;
706 } else if (c != EOF) ungetc(c, f->f_fp);
707 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000708#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000709 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000710#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000711 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000712#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000713}
714
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000715static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000716file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000717{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000718 if (f->f_fp == NULL)
719 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000720 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000721}
722
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000723static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000724file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000725{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000726 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000727
Guido van Rossumd7297e61992-07-06 14:19:26 +0000728 if (f->f_fp == NULL)
729 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000730 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000731 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000732 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000733 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000734 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000735 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000736 clearerr(f->f_fp);
737 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000738 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000739 Py_INCREF(Py_None);
740 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000741}
742
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000743static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000744file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000745{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000746 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000747 if (f->f_fp == NULL)
748 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000749 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000750 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000751 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000752 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000753}
754
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000755
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000756#if BUFSIZ < 8192
757#define SMALLCHUNK 8192
758#else
759#define SMALLCHUNK BUFSIZ
760#endif
761
Guido van Rossum3c259041999-01-14 19:00:14 +0000762#if SIZEOF_INT < 4
763#define BIGCHUNK (512 * 32)
764#else
765#define BIGCHUNK (512 * 1024)
766#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000767
768static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000769new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000770{
771#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000772 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000773 struct stat st;
774 if (fstat(fileno(f->f_fp), &st) == 0) {
775 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000776 /* The following is not a bug: we really need to call lseek()
777 *and* ftell(). The reason is that some stdio libraries
778 mistakenly flush their buffer when ftell() is called and
779 the lseek() call it makes fails, thereby throwing away
780 data that cannot be recovered in any way. To avoid this,
781 we first test lseek(), and only call ftell() if lseek()
782 works. We can't use the lseek() value either, because we
783 need to take the amount of buffered data into account.
784 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000785 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000786 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000787 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000788 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000789 if (pos < 0)
790 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000791 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000792 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000793 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000794 }
795#endif
796 if (currentsize > SMALLCHUNK) {
797 /* Keep doubling until we reach BIGCHUNK;
798 then keep adding BIGCHUNK. */
799 if (currentsize <= BIGCHUNK)
800 return currentsize + currentsize;
801 else
802 return currentsize + BIGCHUNK;
803 }
804 return currentsize + SMALLCHUNK;
805}
806
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000807#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
808#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
809#else
810#ifdef EWOULDBLOCK
811#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
812#else
813#ifdef EAGAIN
814#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
815#else
816#define BLOCKED_ERRNO(x) 0
817#endif
818#endif
819#endif
820
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000821static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000822file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000823{
Guido van Rossum789a1611997-05-10 22:33:55 +0000824 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000825 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000826 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000827
Guido van Rossumd7297e61992-07-06 14:19:26 +0000828 if (f->f_fp == NULL)
829 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000830 /* refuse to mix with f.next() */
831 if (f->f_buf != NULL &&
832 (f->f_bufend - f->f_bufptr) > 0 &&
833 f->f_buf[0] != '\0')
834 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000835 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000836 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000837 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000838 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000839 else
840 buffersize = bytesrequested;
Martin v. Löwis2a190742006-04-13 07:37:25 +0000841 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000842 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000843 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000844 return NULL;
845 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000846 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000847 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000848 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000849 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000850 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000851 Py_BEGIN_ALLOW_THREADS
852 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000853 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000854 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000855 Py_END_ALLOW_THREADS
856 if (chunksize == 0) {
857 if (!ferror(f->f_fp))
858 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000859 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000860 /* When in non-blocking mode, data shouldn't
861 * be discarded if a blocking signal was
862 * received. That will also happen if
863 * chunksize != 0, but bytesread < buffersize. */
864 if (bytesread > 0 && BLOCKED_ERRNO(errno))
865 break;
866 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum6263d541997-05-10 22:07:25 +0000867 Py_DECREF(v);
868 return NULL;
869 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000870 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000871 if (bytesread < buffersize) {
872 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000873 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000874 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000875 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000876 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000877 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000878 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000879 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000880 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000881 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000882 }
883 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000884 if (bytesread != buffersize)
885 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000886 return v;
887}
888
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000889static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000890file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000891{
892 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000893 Py_ssize_t ntodo;
894 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000895
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000896 if (f->f_fp == NULL)
897 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000898 /* refuse to mix with f.next() */
899 if (f->f_buf != NULL &&
900 (f->f_bufend - f->f_bufptr) > 0 &&
901 f->f_buf[0] != '\0')
902 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000903 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000904 return NULL;
905 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000906 while (ntodo > 0) {
907 Py_BEGIN_ALLOW_THREADS
908 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000909 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000910 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000911 Py_END_ALLOW_THREADS
912 if (nnow == 0) {
913 if (!ferror(f->f_fp))
914 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000915 PyErr_SetFromErrno(PyExc_IOError);
916 clearerr(f->f_fp);
917 return NULL;
918 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000919 ndone += nnow;
920 ntodo -= nnow;
921 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000922 return PyInt_FromLong((long)ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000923}
924
Tim Peters86821b22001-01-07 21:19:34 +0000925/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000926Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000927
928Under MSVC 6:
929
Tim Peters1c733232001-01-08 04:02:07 +0000930+ MS threadsafe getc is very slow (multiple layers of function calls before+
931 after each character, to lock+unlock the stream).
932+ The stream-locking functions are MS-internal -- can't access them from user
933 code.
934+ There's nothing Tim could find in the MS C or platform SDK libraries that
935 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000936+ MS fgets locks/unlocks only once per line; it's the only hook we have.
937
938So we use fgets for speed(!), despite that it's painful.
939
940MS realloc is also slow.
941
Tim Petersf29b64d2001-01-15 06:33:19 +0000942Reports from other platforms on this method vs getc_unlocked (which MS doesn't
943have):
944 Linux a wash
945 Solaris a wash
946 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000947
Tim Petersf29b64d2001-01-15 06:33:19 +0000948CAUTION: The C std isn't clear about this: in those cases where fgets
949writes something into the buffer, can it write into any position beyond the
950required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
951known on which it does; and it would be a strange way to code fgets. Still,
952getline_via_fgets may not work correctly if it does. The std test
953test_bufio.py should fail if platform fgets() routinely writes beyond the
954trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000955**************************************************************************/
956
Tim Petersf29b64d2001-01-15 06:33:19 +0000957/* Use this routine if told to, or by default on non-get_unlocked()
958 * platforms unless told not to. Yikes! Let's spell that out:
959 * On a platform with getc_unlocked():
960 * By default, use getc_unlocked().
961 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
962 * On a platform without getc_unlocked():
963 * By default, use fgets().
964 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
965 */
966#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
967#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000968#endif
969
Tim Petersf29b64d2001-01-15 06:33:19 +0000970#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
971#undef USE_FGETS_IN_GETLINE
972#endif
973
974#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000975static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000976getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000977{
Tim Peters15b83852001-01-08 00:53:12 +0000978/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000979 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
980 * to fill this much of the buffer with a known value in order to figure out
981 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
982 * than "most" lines, we waste time filling unused buffer slots. 100 is
983 * surely adequate for most peoples' email archives, chewing over source code,
984 * etc -- "regular old text files".
985 * MAXBUFSIZE is the maximum line length that lets us get away with the less
986 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
987 * cautions about boosting that. 300 was chosen because the worst real-life
988 * text-crunching job reported on Python-Dev was a mail-log crawler where over
989 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +0000990 */
Tim Peters142297a2001-01-15 10:36:56 +0000991#define INITBUFSIZE 100
992#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +0000993 char* p; /* temp */
994 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000995 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +0000996 char* pvfree; /* address of next free slot */
997 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +0000998 size_t nfree; /* # of free buffer slots; pvend-pvfree */
999 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001000 size_t increment; /* amount to increment the buffer */
Tim Peters86821b22001-01-07 21:19:34 +00001001
Tim Peters15b83852001-01-08 00:53:12 +00001002 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001003 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001004 */
Tim Peters142297a2001-01-15 10:36:56 +00001005 total_v_size = INITBUFSIZE; /* start small and pray */
1006 pvfree = buf;
1007 for (;;) {
1008 Py_BEGIN_ALLOW_THREADS
1009 pvend = buf + total_v_size;
1010 nfree = pvend - pvfree;
1011 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001012 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1013 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001014 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001015
Tim Peters142297a2001-01-15 10:36:56 +00001016 if (p == NULL) {
1017 clearerr(fp);
1018 if (PyErr_CheckSignals())
1019 return NULL;
1020 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001021 return v;
1022 }
Tim Peters142297a2001-01-15 10:36:56 +00001023 /* fgets read *something* */
1024 p = memchr(pvfree, '\n', nfree);
1025 if (p != NULL) {
1026 /* Did the \n come from fgets or from us?
1027 * Since fgets stops at the first \n, and then writes
1028 * \0, if it's from fgets a \0 must be next. But if
1029 * that's so, it could not have come from us, since
1030 * the \n's we filled the buffer with have only more
1031 * \n's to the right.
1032 */
1033 if (p+1 < pvend && *(p+1) == '\0') {
1034 /* It's from fgets: we win! In particular,
1035 * we haven't done any mallocs yet, and can
1036 * build the final result on the first try.
1037 */
1038 ++p; /* include \n from fgets */
1039 }
1040 else {
1041 /* Must be from us: fgets didn't fill the
1042 * buffer and didn't find a newline, so it
1043 * must be the last and newline-free line of
1044 * the file.
1045 */
1046 assert(p > pvfree && *(p-1) == '\0');
1047 --p; /* don't include \0 from fgets */
1048 }
1049 v = PyString_FromStringAndSize(buf, p - buf);
1050 return v;
1051 }
1052 /* yuck: fgets overwrote all the newlines, i.e. the entire
1053 * buffer. So this line isn't over yet, or maybe it is but
1054 * we're exactly at EOF. If we haven't already, try using the
1055 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001056 */
Tim Peters142297a2001-01-15 10:36:56 +00001057 assert(*(pvend-1) == '\0');
1058 if (pvfree == buf) {
1059 pvfree = pvend - 1; /* overwrite trailing null */
1060 total_v_size = MAXBUFSIZE;
1061 }
1062 else
1063 break;
Tim Peters86821b22001-01-07 21:19:34 +00001064 }
Tim Peters142297a2001-01-15 10:36:56 +00001065
1066 /* The stack buffer isn't big enough; malloc a string object and read
1067 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001068 */
Tim Petersddea2082002-03-23 10:03:50 +00001069 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001070 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001071 if (v == NULL)
1072 return v;
1073 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001074 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1075 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001076
1077 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001078 * after setting p one beyond the end of the line. The code here is
1079 * very much like the code above, except reads into v's buffer; see
1080 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001081 */
1082 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001083 Py_BEGIN_ALLOW_THREADS
1084 pvend = BUF(v) + total_v_size;
1085 nfree = pvend - pvfree;
1086 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001087 assert(nfree < INT_MAX);
1088 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001089 Py_END_ALLOW_THREADS
1090
1091 if (p == NULL) {
1092 clearerr(fp);
1093 if (PyErr_CheckSignals()) {
1094 Py_DECREF(v);
1095 return NULL;
1096 }
1097 p = pvfree;
1098 break;
1099 }
Tim Peters86821b22001-01-07 21:19:34 +00001100 p = memchr(pvfree, '\n', nfree);
1101 if (p != NULL) {
1102 if (p+1 < pvend && *(p+1) == '\0') {
1103 /* \n came from fgets */
1104 ++p;
1105 break;
1106 }
1107 /* \n came from us; last line of file, no newline */
1108 assert(p > pvfree && *(p-1) == '\0');
1109 --p;
1110 break;
1111 }
1112 /* expand buffer and try again */
1113 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001114 increment = total_v_size >> 2; /* mild exponential growth */
1115 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001116 if (total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001117 PyErr_SetString(PyExc_OverflowError,
1118 "line is longer than a Python string can hold");
1119 Py_DECREF(v);
1120 return NULL;
1121 }
1122 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1123 return NULL;
1124 /* overwrite the trailing null byte */
Tim Petersddea2082002-03-23 10:03:50 +00001125 pvfree = BUF(v) + (total_v_size - increment - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001126 }
1127 if (BUF(v) + total_v_size != p)
1128 _PyString_Resize(&v, p - BUF(v));
1129 return v;
1130#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001131#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001132}
Tim Petersf29b64d2001-01-15 06:33:19 +00001133#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001134
Guido van Rossum0bd24411991-04-04 15:21:57 +00001135/* Internal routine to get a line.
1136 Size argument interpretation:
1137 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001138 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001139*/
1140
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001141static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001142get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001143{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001144 FILE *fp = f->f_fp;
1145 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001146 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001147 size_t total_v_size; /* total # of slots in buffer */
1148 size_t used_v_size; /* # used slots in buffer */
1149 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001150 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001151 int newlinetypes = f->f_newlinetypes;
1152 int skipnextlf = f->f_skipnextlf;
1153 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001154
Jack Jansen7b8c7542002-04-14 20:12:41 +00001155#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001156 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001157 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001158#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001159 total_v_size = n > 0 ? n : 100;
1160 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001161 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001162 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001163 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001164 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001165
Guido van Rossumce5ba841991-03-06 13:06:18 +00001166 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001167 Py_BEGIN_ALLOW_THREADS
1168 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001169 if (univ_newline) {
1170 c = 'x'; /* Shut up gcc warning */
1171 while ( buf != end && (c = GETC(fp)) != EOF ) {
1172 if (skipnextlf ) {
1173 skipnextlf = 0;
1174 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001175 /* Seeing a \n here with
1176 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001177 * saw a \r before.
1178 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001179 newlinetypes |= NEWLINE_CRLF;
1180 c = GETC(fp);
1181 if (c == EOF) break;
1182 } else {
1183 newlinetypes |= NEWLINE_CR;
1184 }
1185 }
1186 if (c == '\r') {
1187 skipnextlf = 1;
1188 c = '\n';
1189 } else if ( c == '\n')
1190 newlinetypes |= NEWLINE_LF;
1191 *buf++ = c;
1192 if (c == '\n') break;
1193 }
1194 if ( c == EOF && skipnextlf )
1195 newlinetypes |= NEWLINE_CR;
1196 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001197 while ((c = GETC(fp)) != EOF &&
1198 (*buf++ = c) != '\n' &&
1199 buf != end)
1200 ;
1201 FUNLOCKFILE(fp);
1202 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001203 f->f_newlinetypes = newlinetypes;
1204 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001205 if (c == '\n')
1206 break;
1207 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001208 if (ferror(fp)) {
1209 PyErr_SetFromErrno(PyExc_IOError);
1210 clearerr(fp);
1211 Py_DECREF(v);
1212 return NULL;
1213 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001214 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001215 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001216 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001217 return NULL;
1218 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001219 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001220 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001221 /* Must be because buf == end */
1222 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001223 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001224 used_v_size = total_v_size;
1225 increment = total_v_size >> 2; /* mild exponential growth */
1226 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001227 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001228 PyErr_SetString(PyExc_OverflowError,
1229 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001230 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001231 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001232 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001233 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001234 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001235 buf = BUF(v) + used_v_size;
1236 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001237 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001238
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001239 used_v_size = buf - BUF(v);
1240 if (used_v_size != total_v_size)
1241 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001242 return v;
1243}
1244
Guido van Rossum0bd24411991-04-04 15:21:57 +00001245/* External C interface */
1246
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001247PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001248PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001249{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001250 PyObject *result;
1251
Guido van Rossum3165fe61992-09-25 21:59:05 +00001252 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001253 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001254 return NULL;
1255 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001256
1257 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001258 PyFileObject *fo = (PyFileObject *)f;
1259 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001260 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001261 /* refuse to mix with f.next() */
1262 if (fo->f_buf != NULL &&
1263 (fo->f_bufend - fo->f_bufptr) > 0 &&
1264 fo->f_buf[0] != '\0')
1265 return err_iterbuffered();
1266 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001267 }
1268 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001269 PyObject *reader;
1270 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001271
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001272 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001273 if (reader == NULL)
1274 return NULL;
1275 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001276 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001277 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001278 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001279 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001280 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001281 return NULL;
1282 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001283 result = PyEval_CallObject(reader, args);
1284 Py_DECREF(reader);
1285 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001286 if (result != NULL && !PyString_Check(result) &&
1287 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001288 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001289 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001290 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001291 "object.readline() returned non-string");
1292 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001293 }
1294
1295 if (n < 0 && result != NULL && PyString_Check(result)) {
1296 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001297 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001298 if (len == 0) {
1299 Py_DECREF(result);
1300 result = NULL;
1301 PyErr_SetString(PyExc_EOFError,
1302 "EOF when reading a line");
1303 }
1304 else if (s[len-1] == '\n') {
1305 if (result->ob_refcnt == 1)
1306 _PyString_Resize(&result, len-1);
1307 else {
1308 PyObject *v;
1309 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001310 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001311 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001312 }
1313 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001314 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001315#ifdef Py_USING_UNICODE
1316 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1317 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001318 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001319 if (len == 0) {
1320 Py_DECREF(result);
1321 result = NULL;
1322 PyErr_SetString(PyExc_EOFError,
1323 "EOF when reading a line");
1324 }
1325 else if (s[len-1] == '\n') {
1326 if (result->ob_refcnt == 1)
1327 PyUnicode_Resize(&result, len-1);
1328 else {
1329 PyObject *v;
1330 v = PyUnicode_FromUnicode(s, len-1);
1331 Py_DECREF(result);
1332 result = v;
1333 }
1334 }
1335 }
1336#endif
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001337 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001338}
1339
1340/* Python method */
1341
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001342static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001343file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001344{
Guido van Rossum789a1611997-05-10 22:33:55 +00001345 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001346
Guido van Rossumd7297e61992-07-06 14:19:26 +00001347 if (f->f_fp == NULL)
1348 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001349 /* refuse to mix with f.next() */
1350 if (f->f_buf != NULL &&
1351 (f->f_bufend - f->f_bufptr) > 0 &&
1352 f->f_buf[0] != '\0')
1353 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001354 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001355 return NULL;
1356 if (n == 0)
1357 return PyString_FromString("");
1358 if (n < 0)
1359 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001360 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001361}
1362
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001363static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001364file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001365{
Guido van Rossum789a1611997-05-10 22:33:55 +00001366 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001367 PyObject *list;
1368 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001369 char small_buffer[SMALLCHUNK];
1370 char *buffer = small_buffer;
1371 size_t buffersize = SMALLCHUNK;
1372 PyObject *big_buffer = NULL;
1373 size_t nfilled = 0;
1374 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001375 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001376 char *p, *q, *end;
1377 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001378 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001379
Guido van Rossumd7297e61992-07-06 14:19:26 +00001380 if (f->f_fp == NULL)
1381 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001382 /* refuse to mix with f.next() */
1383 if (f->f_buf != NULL &&
1384 (f->f_bufend - f->f_bufptr) > 0 &&
1385 f->f_buf[0] != '\0')
1386 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001387 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001388 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001389 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001390 return NULL;
1391 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001392 if (shortread)
1393 nread = 0;
1394 else {
1395 Py_BEGIN_ALLOW_THREADS
1396 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001397 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001398 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001399 Py_END_ALLOW_THREADS
1400 shortread = (nread < buffersize-nfilled);
1401 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001402 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001403 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001404 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001405 break;
1406 PyErr_SetFromErrno(PyExc_IOError);
1407 clearerr(f->f_fp);
1408 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001409 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001410 list = NULL;
1411 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001412 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001413 totalread += nread;
Anthony Baxter377be112006-04-11 06:54:30 +00001414 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001415 if (p == NULL) {
1416 /* Need a larger buffer to fit this line */
1417 nfilled += nread;
1418 buffersize *= 2;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001419 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001420 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001421 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001422 goto error;
1423 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001424 if (big_buffer == NULL) {
1425 /* Create the big buffer */
1426 big_buffer = PyString_FromStringAndSize(
1427 NULL, buffersize);
1428 if (big_buffer == NULL)
1429 goto error;
1430 buffer = PyString_AS_STRING(big_buffer);
1431 memcpy(buffer, small_buffer, nfilled);
1432 }
1433 else {
1434 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001435 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1436 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001437 buffer = PyString_AS_STRING(big_buffer);
1438 }
1439 continue;
1440 }
1441 end = buffer+nfilled+nread;
1442 q = buffer;
1443 do {
1444 /* Process complete lines */
1445 p++;
1446 line = PyString_FromStringAndSize(q, p-q);
1447 if (line == NULL)
1448 goto error;
1449 err = PyList_Append(list, line);
1450 Py_DECREF(line);
1451 if (err != 0)
1452 goto error;
1453 q = p;
Anthony Baxter377be112006-04-11 06:54:30 +00001454 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001455 } while (p != NULL);
1456 /* Move the remaining incomplete line to the start */
1457 nfilled = end-q;
1458 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001459 if (sizehint > 0)
1460 if (totalread >= (size_t)sizehint)
1461 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001462 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001463 if (nfilled != 0) {
1464 /* Partial last line */
1465 line = PyString_FromStringAndSize(buffer, nfilled);
1466 if (line == NULL)
1467 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001468 if (sizehint > 0) {
1469 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001470 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001471 if (rest == NULL) {
1472 Py_DECREF(line);
1473 goto error;
1474 }
1475 PyString_Concat(&line, rest);
1476 Py_DECREF(rest);
1477 if (line == NULL)
1478 goto error;
1479 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001480 err = PyList_Append(list, line);
1481 Py_DECREF(line);
1482 if (err != 0)
1483 goto error;
1484 }
1485 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001486 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001487 return list;
1488}
1489
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001490static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001491file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001492{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001493 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001494 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001495 if (f->f_fp == NULL)
1496 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001497 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001498 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001499 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001500 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001501 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001502 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001503 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001504 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001505 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001506 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001507 return NULL;
1508 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001509 Py_INCREF(Py_None);
1510 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001511}
1512
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001513static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001514file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001515{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001516#define CHUNKSIZE 1000
1517 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001518 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001519 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001520 int index, islist;
1521 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001522
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001523 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001524 if (f->f_fp == NULL)
1525 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001526
1527 result = NULL;
1528 list = NULL;
1529 islist = PyList_Check(seq);
1530 if (islist)
1531 it = NULL;
1532 else {
1533 it = PyObject_GetIter(seq);
1534 if (it == NULL) {
1535 PyErr_SetString(PyExc_TypeError,
1536 "writelines() requires an iterable argument");
1537 return NULL;
1538 }
1539 /* From here on, fail by going to error, to reclaim "it". */
1540 list = PyList_New(CHUNKSIZE);
1541 if (list == NULL)
1542 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001543 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001544
1545 /* Strategy: slurp CHUNKSIZE lines into a private list,
1546 checking that they are all strings, then write that list
1547 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001548 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001549 if (islist) {
1550 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001551 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001552 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001553 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001554 j = PyList_GET_SIZE(list);
1555 }
1556 else {
1557 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001558 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001559 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001560 if (PyErr_Occurred())
1561 goto error;
1562 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001563 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001564 PyList_SetItem(list, j, line);
1565 }
1566 }
1567 if (j == 0)
1568 break;
1569
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001570 /* Check that all entries are indeed strings. If not,
1571 apply the same rules as for file.write() and
1572 convert the results to strings. This is slow, but
1573 seems to be the only way since all conversion APIs
1574 could potentially execute Python code. */
1575 for (i = 0; i < j; i++) {
1576 PyObject *v = PyList_GET_ITEM(list, i);
1577 if (!PyString_Check(v)) {
1578 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001579 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001580 PyObject_AsReadBuffer(v,
1581 (const void**)&buffer,
1582 &len)) ||
1583 PyObject_AsCharBuffer(v,
1584 &buffer,
1585 &len))) {
1586 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001587 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001588 goto error;
1589 }
1590 line = PyString_FromStringAndSize(buffer,
1591 len);
1592 if (line == NULL)
1593 goto error;
1594 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001595 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001596 }
1597 }
1598
1599 /* Since we are releasing the global lock, the
1600 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001601 Py_BEGIN_ALLOW_THREADS
1602 f->f_softspace = 0;
1603 errno = 0;
1604 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001605 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001606 len = PyString_GET_SIZE(line);
1607 nwritten = fwrite(PyString_AS_STRING(line),
1608 1, len, f->f_fp);
1609 if (nwritten != len) {
1610 Py_BLOCK_THREADS
1611 PyErr_SetFromErrno(PyExc_IOError);
1612 clearerr(f->f_fp);
1613 goto error;
1614 }
1615 }
1616 Py_END_ALLOW_THREADS
1617
1618 if (j < CHUNKSIZE)
1619 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001620 }
1621
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001622 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001623 result = Py_None;
1624 error:
1625 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001626 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001627 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001628#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001629}
1630
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001631static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001632file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001633{
1634 if (f->f_fp == NULL)
1635 return err_closed();
1636 Py_INCREF(f);
1637 return (PyObject *)f;
1638}
1639
Georg Brandl98b40ad2006-06-08 14:50:21 +00001640static PyObject *
1641file_exit(PyFileObject *f, PyObject *args)
1642{
1643 PyObject *ret = file_close(f);
1644 if (!ret)
1645 /* If error occurred, pass through */
1646 return NULL;
1647 Py_DECREF(ret);
1648 /* We cannot return the result of close since a true
1649 * value will be interpreted as "yes, swallow the
1650 * exception if one was raised inside the with block". */
1651 Py_RETURN_NONE;
1652}
1653
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001654PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001655"readline([size]) -> next line from the file, as a string.\n"
1656"\n"
1657"Retain newline. A non-negative size argument limits the maximum\n"
1658"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001659"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001660
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001661PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001662"read([size]) -> read at most size bytes, returned as a string.\n"
1663"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001664"If the size argument is negative or omitted, read until EOF is reached.\n"
1665"Notice that when in non-blocking mode, less data than what was requested\n"
1666"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001667
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001668PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001669"write(str) -> None. Write string str to file.\n"
1670"\n"
1671"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001672"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001673
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001674PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001675"fileno() -> integer \"file descriptor\".\n"
1676"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001677"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001678
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001679PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001680"seek(offset[, whence]) -> None. Move to new file position.\n"
1681"\n"
1682"Argument offset is a byte count. Optional argument whence defaults to\n"
1683"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1684"(move relative to current position, positive or negative), and 2 (move\n"
1685"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001686"seeking beyond the end of a file). If the file is opened in text mode,\n"
1687"only offsets returned by tell() are legal. Use of other offsets causes\n"
1688"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001689"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001690"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001691
Guido van Rossumd7047b31995-01-02 19:07:15 +00001692#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001693PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001694"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1695"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001696"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001697#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001698
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001699PyDoc_STRVAR(tell_doc,
1700"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001701
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001702PyDoc_STRVAR(readinto_doc,
1703"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001704
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001705PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001706"readlines([size]) -> list of strings, each a line from the file.\n"
1707"\n"
1708"Call readline() repeatedly and return a list of the lines so read.\n"
1709"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001710"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001711
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001712PyDoc_STRVAR(xreadlines_doc,
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001713"xreadlines() -> returns self.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001714"\n"
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001715"For backward compatibility. File objects now include the performance\n"
1716"optimizations previously implemented in the xreadlines module.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001717
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001718PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001719"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001720"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001721"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001722"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001723
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001724PyDoc_STRVAR(flush_doc,
1725"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001726
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001727PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001728"close() -> None or (perhaps) an integer. Close the file.\n"
1729"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001730"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001731"further I/O operations. close() may be called more than once without\n"
1732"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001733"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001734
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001735PyDoc_STRVAR(isatty_doc,
1736"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001737
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001738PyDoc_STRVAR(enter_doc,
1739 "__enter__() -> self.");
1740
Georg Brandl98b40ad2006-06-08 14:50:21 +00001741PyDoc_STRVAR(exit_doc,
1742 "__exit__(*excinfo) -> None. Closes the file.");
1743
Tim Petersefc3a3a2001-09-20 07:55:22 +00001744static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001745 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1746 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1747 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1748 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1749 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001750#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001751 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001752#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001753 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1754 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1755 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001756 {"xreadlines",(PyCFunction)file_self, METH_NOARGS, xreadlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001757 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1758 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1759 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1760 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001761 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Georg Brandl98b40ad2006-06-08 14:50:21 +00001762 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001763 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001764};
1765
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001766#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001767
Guido van Rossum6f799372001-09-20 20:46:19 +00001768static PyMemberDef file_memberlist[] = {
1769 {"softspace", T_INT, OFF(f_softspace), 0,
1770 "flag indicating that a space needs to be printed; used by print"},
1771 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001772 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001773 {"name", T_OBJECT, OFF(f_name), RO,
1774 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001775 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1776 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001777 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001778 {NULL} /* Sentinel */
1779};
1780
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001781static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001782get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001783{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001784 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001785}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001786static PyObject *
1787get_newlines(PyFileObject *f, void *closure)
1788{
1789 switch (f->f_newlinetypes) {
1790 case NEWLINE_UNKNOWN:
1791 Py_INCREF(Py_None);
1792 return Py_None;
1793 case NEWLINE_CR:
1794 return PyString_FromString("\r");
1795 case NEWLINE_LF:
1796 return PyString_FromString("\n");
1797 case NEWLINE_CR|NEWLINE_LF:
1798 return Py_BuildValue("(ss)", "\r", "\n");
1799 case NEWLINE_CRLF:
1800 return PyString_FromString("\r\n");
1801 case NEWLINE_CR|NEWLINE_CRLF:
1802 return Py_BuildValue("(ss)", "\r", "\r\n");
1803 case NEWLINE_LF|NEWLINE_CRLF:
1804 return Py_BuildValue("(ss)", "\n", "\r\n");
1805 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1806 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1807 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001808 PyErr_Format(PyExc_SystemError,
1809 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001810 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001811 return NULL;
1812 }
1813}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001814
Guido van Rossum32d34c82001-09-20 21:45:26 +00001815static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001816 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001817 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001818 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001819 {0},
1820};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001821
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001822static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001823drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001824{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001825 if (f->f_buf != NULL) {
1826 PyMem_Free(f->f_buf);
1827 f->f_buf = NULL;
1828 }
Guido van Rossum65967252001-04-21 13:20:18 +00001829}
1830
Tim Petersf1827cf2003-09-07 03:30:18 +00001831/* Make sure that file has a readahead buffer with at least one byte
1832 (unless at EOF) and no more than bufsize. Returns negative value on
Georg Brandled02eb62006-03-31 20:31:02 +00001833 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001834static int
1835readahead(PyFileObject *f, int bufsize)
1836{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001837 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001838
1839 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001840 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001841 return 0;
1842 else
1843 drop_readahead(f);
1844 }
Anthony Baxter377be112006-04-11 06:54:30 +00001845 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
Georg Brandled02eb62006-03-31 20:31:02 +00001846 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001847 return -1;
1848 }
1849 Py_BEGIN_ALLOW_THREADS
1850 errno = 0;
1851 chunksize = Py_UniversalNewlineFread(
1852 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1853 Py_END_ALLOW_THREADS
1854 if (chunksize == 0) {
1855 if (ferror(f->f_fp)) {
1856 PyErr_SetFromErrno(PyExc_IOError);
1857 clearerr(f->f_fp);
1858 drop_readahead(f);
1859 return -1;
1860 }
1861 }
1862 f->f_bufptr = f->f_buf;
1863 f->f_bufend = f->f_buf + chunksize;
1864 return 0;
1865}
1866
1867/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001868 uninitialized bytes followed by the remainder of the line. Don't be
1869 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001870 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1871
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001872static PyStringObject *
1873readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1874{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001875 PyStringObject* s;
1876 char *bufptr;
1877 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001878 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001879
1880 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001881 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001882 return NULL;
1883
1884 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001885 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001886 return (PyStringObject *)
1887 PyString_FromStringAndSize(NULL, skip);
Anthony Baxter377be112006-04-11 06:54:30 +00001888 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001889 if (bufptr != NULL) {
1890 bufptr++; /* Count the '\n' */
1891 len = bufptr - f->f_bufptr;
1892 s = (PyStringObject *)
1893 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001894 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001895 return NULL;
1896 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1897 f->f_bufptr = bufptr;
1898 if (bufptr == f->f_bufend)
1899 drop_readahead(f);
1900 } else {
1901 bufptr = f->f_bufptr;
1902 buf = f->f_buf;
1903 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001904 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001905 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001906 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001907 if (s == NULL) {
1908 PyMem_Free(buf);
1909 return NULL;
1910 }
1911 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1912 PyMem_Free(buf);
1913 }
1914 return s;
1915}
1916
1917/* A larger buffer size may actually decrease performance. */
1918#define READAHEAD_BUFSIZE 8192
1919
1920static PyObject *
1921file_iternext(PyFileObject *f)
1922{
1923 PyStringObject* l;
1924
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001925 if (f->f_fp == NULL)
1926 return err_closed();
1927
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001928 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1929 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1930 Py_XDECREF(l);
1931 return NULL;
1932 }
1933 return (PyObject *)l;
1934}
1935
1936
Tim Peters59c9a642001-09-13 05:38:56 +00001937static PyObject *
1938file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1939{
Tim Peters44410012001-09-14 03:26:08 +00001940 PyObject *self;
1941 static PyObject *not_yet_string;
1942
1943 assert(type != NULL && type->tp_alloc != NULL);
1944
1945 if (not_yet_string == NULL) {
1946 not_yet_string = PyString_FromString("<uninitialized file>");
1947 if (not_yet_string == NULL)
1948 return NULL;
1949 }
1950
1951 self = type->tp_alloc(type, 0);
1952 if (self != NULL) {
1953 /* Always fill in the name and mode, so that nobody else
1954 needs to special-case NULLs there. */
1955 Py_INCREF(not_yet_string);
1956 ((PyFileObject *)self)->f_name = not_yet_string;
1957 Py_INCREF(not_yet_string);
1958 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001959 Py_INCREF(Py_None);
1960 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001961 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001962 }
1963 return self;
1964}
1965
1966static int
1967file_init(PyObject *self, PyObject *args, PyObject *kwds)
1968{
1969 PyFileObject *foself = (PyFileObject *)self;
1970 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001971 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001972 char *name = NULL;
1973 char *mode = "r";
1974 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001975 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001976
1977 assert(PyFile_Check(self));
1978 if (foself->f_fp != NULL) {
1979 /* Have to close the existing file first. */
1980 PyObject *closeresult = file_close(foself);
1981 if (closeresult == NULL)
1982 return -1;
1983 Py_DECREF(closeresult);
1984 }
Tim Peters59c9a642001-09-13 05:38:56 +00001985
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001986#ifdef Py_WIN_WIDE_FILENAMES
1987 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
1988 PyObject *po;
1989 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
1990 kwlist, &po, &mode, &bufsize)) {
1991 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00001992 if (fill_file_fields(foself, NULL, po, mode,
1993 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001994 goto Error;
1995 } else {
1996 /* Drop the argument parsing error as narrow
1997 strings are also valid. */
1998 PyErr_Clear();
1999 }
2000 }
2001#endif
2002
2003 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002004 PyObject *o_name;
2005
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002006 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2007 Py_FileSystemDefaultEncoding,
2008 &name,
2009 &mode, &bufsize))
2010 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002011
2012 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002013 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2014 kwlist, &o_name, &mode,
2015 &bufsize))
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002016 return -1;
2017
2018 if (fill_file_fields(foself, NULL, o_name, mode,
2019 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002020 goto Error;
2021 }
Tim Peters44410012001-09-14 03:26:08 +00002022 if (open_the_file(foself, name, mode) == NULL)
2023 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002024 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002025 PyFile_SetBufSize(self, bufsize);
2026 goto Done;
2027
2028Error:
2029 ret = -1;
2030 /* fall through */
2031Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002032 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002033 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002034}
2035
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002036PyDoc_VAR(file_doc) =
2037PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002038"file(name[, mode[, buffering]]) -> file object\n"
2039"\n"
2040"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2041"writing or appending. The file will be created if it doesn't exist\n"
2042"when opened for writing or appending; it will be truncated when\n"
2043"opened for writing. Add a 'b' to the mode for binary files.\n"
2044"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2045"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002046"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002047)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002048PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002049"Add a 'U' to mode to open the file for input with universal newline\n"
2050"support. Any line ending in the input file will be seen as a '\\n'\n"
2051"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2052"the value for this attribute is one of None (no newline read yet),\n"
2053"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2054"\n"
2055"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002056);
Tim Peters59c9a642001-09-13 05:38:56 +00002057
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002058PyTypeObject PyFile_Type = {
2059 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002060 0,
2061 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002062 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002063 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002064 (destructor)file_dealloc, /* tp_dealloc */
2065 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002066 0, /* tp_getattr */
2067 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002068 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002069 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002070 0, /* tp_as_number */
2071 0, /* tp_as_sequence */
2072 0, /* tp_as_mapping */
2073 0, /* tp_hash */
2074 0, /* tp_call */
2075 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002076 PyObject_GenericGetAttr, /* tp_getattro */
Tim Peters015dd822003-05-04 04:16:52 +00002077 /* softspace is writable: we must supply tp_setattro */
2078 PyObject_GenericSetAttr, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002079 0, /* tp_as_buffer */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002080 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002081 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002082 0, /* tp_traverse */
2083 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002084 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002085 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002086 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002087 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002088 file_methods, /* tp_methods */
2089 file_memberlist, /* tp_members */
2090 file_getsetlist, /* tp_getset */
2091 0, /* tp_base */
2092 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002093 0, /* tp_descr_get */
2094 0, /* tp_descr_set */
2095 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002096 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002097 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002098 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002099 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002100};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002101
2102/* Interface for the 'soft space' between print items. */
2103
2104int
Fred Drakefd99de62000-07-09 05:02:18 +00002105PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00002106{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002107 long oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002108 if (f == NULL) {
2109 /* Do nothing */
2110 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002111 else if (PyFile_Check(f)) {
2112 oldflag = ((PyFileObject *)f)->f_softspace;
2113 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002114 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00002115 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002116 PyObject *v;
2117 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002118 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002119 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002120 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002121 if (PyInt_Check(v))
2122 oldflag = PyInt_AsLong(v);
Martin v. Löwis18e16552006-02-15 17:27:45 +00002123 assert(oldflag < INT_MAX);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002124 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002125 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002126 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002127 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002128 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002129 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002130 if (PyObject_SetAttrString(f, "softspace", v) != 0)
2131 PyErr_Clear();
2132 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002133 }
2134 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002135 return (int)oldflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002136}
Guido van Rossum3165fe61992-09-25 21:59:05 +00002137
2138/* Interfaces to write objects/strings to file-like objects */
2139
2140int
Fred Drakefd99de62000-07-09 05:02:18 +00002141PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002142{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002143 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002144 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002145 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002146 return -1;
2147 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002148 else if (PyFile_Check(f)) {
2149 FILE *fp = PyFile_AsFile(f);
Fred Drake086a0f72004-03-19 15:22:36 +00002150#ifdef Py_USING_UNICODE
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002151 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2152 int result;
Fred Drake086a0f72004-03-19 15:22:36 +00002153#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002154 if (fp == NULL) {
2155 err_closed();
2156 return -1;
2157 }
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002158#ifdef Py_USING_UNICODE
Tim Petersf1827cf2003-09-07 03:30:18 +00002159 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002160 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002161 char *cenc = PyString_AS_STRING(enc);
2162 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2163 if (value == NULL)
2164 return -1;
2165 } else {
2166 value = v;
2167 Py_INCREF(value);
2168 }
2169 result = PyObject_Print(value, fp, flags);
2170 Py_DECREF(value);
2171 return result;
2172#else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002173 return PyObject_Print(v, fp, flags);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002174#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002175 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002176 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002177 if (writer == NULL)
2178 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002179 if (flags & Py_PRINT_RAW) {
2180 if (PyUnicode_Check(v)) {
2181 value = v;
2182 Py_INCREF(value);
2183 } else
2184 value = PyObject_Str(v);
2185 }
2186 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002187 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002188 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002189 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002190 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002191 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002192 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002193 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002194 Py_DECREF(value);
2195 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002196 return -1;
2197 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002198 result = PyEval_CallObject(writer, args);
2199 Py_DECREF(args);
2200 Py_DECREF(value);
2201 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002202 if (result == NULL)
2203 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002204 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002205 return 0;
2206}
2207
Guido van Rossum27a60b11997-05-22 22:25:11 +00002208int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002209PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002210{
2211 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002212 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002213 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002214 PyErr_SetString(PyExc_SystemError,
2215 "null file for PyFile_WriteString");
2216 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002217 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002218 else if (PyFile_Check(f)) {
2219 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002220 if (fp == NULL) {
2221 err_closed();
2222 return -1;
2223 }
2224 fputs(s, fp);
2225 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002226 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002227 else if (!PyErr_Occurred()) {
2228 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002229 int err;
2230 if (v == NULL)
2231 return -1;
2232 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2233 Py_DECREF(v);
2234 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002235 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002236 else
2237 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002238}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002239
2240/* Try to get a file-descriptor from a Python object. If the object
2241 is an integer or long integer, its value is returned. If not, the
2242 object's fileno() method is called if it exists; the method must return
2243 an integer or long integer, which is returned as the file descriptor value.
2244 -1 is returned on failure.
2245*/
2246
2247int PyObject_AsFileDescriptor(PyObject *o)
2248{
2249 int fd;
2250 PyObject *meth;
2251
2252 if (PyInt_Check(o)) {
2253 fd = PyInt_AsLong(o);
2254 }
2255 else if (PyLong_Check(o)) {
2256 fd = PyLong_AsLong(o);
2257 }
2258 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2259 {
2260 PyObject *fno = PyEval_CallObject(meth, NULL);
2261 Py_DECREF(meth);
2262 if (fno == NULL)
2263 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002264
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002265 if (PyInt_Check(fno)) {
2266 fd = PyInt_AsLong(fno);
2267 Py_DECREF(fno);
2268 }
2269 else if (PyLong_Check(fno)) {
2270 fd = PyLong_AsLong(fno);
2271 Py_DECREF(fno);
2272 }
2273 else {
2274 PyErr_SetString(PyExc_TypeError,
2275 "fileno() returned a non-integer");
2276 Py_DECREF(fno);
2277 return -1;
2278 }
2279 }
2280 else {
2281 PyErr_SetString(PyExc_TypeError,
2282 "argument must be an int, or have a fileno() method.");
2283 return -1;
2284 }
2285
2286 if (fd < 0) {
2287 PyErr_Format(PyExc_ValueError,
2288 "file descriptor cannot be a negative integer (%i)",
2289 fd);
2290 return -1;
2291 }
2292 return fd;
2293}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002294
Jack Jansen7b8c7542002-04-14 20:12:41 +00002295/* From here on we need access to the real fgets and fread */
2296#undef fgets
2297#undef fread
2298
2299/*
2300** Py_UniversalNewlineFgets is an fgets variation that understands
2301** all of \r, \n and \r\n conventions.
2302** The stream should be opened in binary mode.
2303** If fobj is NULL the routine always does newline conversion, and
2304** it may peek one char ahead to gobble the second char in \r\n.
2305** If fobj is non-NULL it must be a PyFileObject. In this case there
2306** is no readahead but in stead a flag is used to skip a following
2307** \n on the next read. Also, if the file is open in binary mode
2308** the whole conversion is skipped. Finally, the routine keeps track of
2309** the different types of newlines seen.
2310** Note that we need no error handling: fgets() treats error and eof
2311** identically.
2312*/
2313char *
2314Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2315{
2316 char *p = buf;
2317 int c;
2318 int newlinetypes = 0;
2319 int skipnextlf = 0;
2320 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002321
Jack Jansen7b8c7542002-04-14 20:12:41 +00002322 if (fobj) {
2323 if (!PyFile_Check(fobj)) {
2324 errno = ENXIO; /* What can you do... */
2325 return NULL;
2326 }
2327 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2328 if ( !univ_newline )
2329 return fgets(buf, n, stream);
2330 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2331 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2332 }
2333 FLOCKFILE(stream);
2334 c = 'x'; /* Shut up gcc warning */
2335 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2336 if (skipnextlf ) {
2337 skipnextlf = 0;
2338 if (c == '\n') {
2339 /* Seeing a \n here with skipnextlf true
2340 ** means we saw a \r before.
2341 */
2342 newlinetypes |= NEWLINE_CRLF;
2343 c = GETC(stream);
2344 if (c == EOF) break;
2345 } else {
2346 /*
2347 ** Note that c == EOF also brings us here,
2348 ** so we're okay if the last char in the file
2349 ** is a CR.
2350 */
2351 newlinetypes |= NEWLINE_CR;
2352 }
2353 }
2354 if (c == '\r') {
2355 /* A \r is translated into a \n, and we skip
2356 ** an adjacent \n, if any. We don't set the
2357 ** newlinetypes flag until we've seen the next char.
2358 */
2359 skipnextlf = 1;
2360 c = '\n';
2361 } else if ( c == '\n') {
2362 newlinetypes |= NEWLINE_LF;
2363 }
2364 *p++ = c;
2365 if (c == '\n') break;
2366 }
2367 if ( c == EOF && skipnextlf )
2368 newlinetypes |= NEWLINE_CR;
2369 FUNLOCKFILE(stream);
2370 *p = '\0';
2371 if (fobj) {
2372 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2373 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2374 } else if ( skipnextlf ) {
2375 /* If we have no file object we cannot save the
2376 ** skipnextlf flag. We have to readahead, which
2377 ** will cause a pause if we're reading from an
2378 ** interactive stream, but that is very unlikely
2379 ** unless we're doing something silly like
2380 ** execfile("/dev/tty").
2381 */
2382 c = GETC(stream);
2383 if ( c != '\n' )
2384 ungetc(c, stream);
2385 }
2386 if (p == buf)
2387 return NULL;
2388 return buf;
2389}
2390
2391/*
2392** Py_UniversalNewlineFread is an fread variation that understands
2393** all of \r, \n and \r\n conventions.
2394** The stream should be opened in binary mode.
2395** fobj must be a PyFileObject. In this case there
2396** is no readahead but in stead a flag is used to skip a following
2397** \n on the next read. Also, if the file is open in binary mode
2398** the whole conversion is skipped. Finally, the routine keeps track of
2399** the different types of newlines seen.
2400*/
2401size_t
Tim Peters058b1412002-04-21 07:29:14 +00002402Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002403 FILE *stream, PyObject *fobj)
2404{
Tim Peters058b1412002-04-21 07:29:14 +00002405 char *dst = buf;
2406 PyFileObject *f = (PyFileObject *)fobj;
2407 int newlinetypes, skipnextlf;
2408
2409 assert(buf != NULL);
2410 assert(stream != NULL);
2411
Jack Jansen7b8c7542002-04-14 20:12:41 +00002412 if (!fobj || !PyFile_Check(fobj)) {
2413 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002414 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002415 }
Tim Peters058b1412002-04-21 07:29:14 +00002416 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002417 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002418 newlinetypes = f->f_newlinetypes;
2419 skipnextlf = f->f_skipnextlf;
2420 /* Invariant: n is the number of bytes remaining to be filled
2421 * in the buffer.
2422 */
2423 while (n) {
2424 size_t nread;
2425 int shortread;
2426 char *src = dst;
2427
2428 nread = fread(dst, 1, n, stream);
2429 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002430 if (nread == 0)
2431 break;
2432
Tim Peterse1682a82002-04-21 18:15:20 +00002433 n -= nread; /* assuming 1 byte out for each in; will adjust */
2434 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002435 while (nread--) {
2436 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002437 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002438 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002439 *dst++ = '\n';
2440 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002441 }
2442 else if (skipnextlf && c == '\n') {
2443 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002444 skipnextlf = 0;
2445 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002446 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002447 }
2448 else {
2449 /* Normal char to be stored in buffer. Also
2450 * update the newlinetypes flag if either this
2451 * is an LF or the previous char was a CR.
2452 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002453 if (c == '\n')
2454 newlinetypes |= NEWLINE_LF;
2455 else if (skipnextlf)
2456 newlinetypes |= NEWLINE_CR;
2457 *dst++ = c;
2458 skipnextlf = 0;
2459 }
2460 }
Tim Peters058b1412002-04-21 07:29:14 +00002461 if (shortread) {
2462 /* If this is EOF, update type flags. */
2463 if (skipnextlf && feof(stream))
2464 newlinetypes |= NEWLINE_CR;
2465 break;
2466 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002467 }
Tim Peters058b1412002-04-21 07:29:14 +00002468 f->f_newlinetypes = newlinetypes;
2469 f->f_skipnextlf = skipnextlf;
2470 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002471}
Anthony Baxterac6bd462006-04-13 02:06:09 +00002472
2473#ifdef __cplusplus
2474}
2475#endif