blob: 2b37e7442f1c8b1bf48134e01feed4c5757bb457 [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) {
Tim Peters2ea91112002-04-08 04:13:12 +0000244#ifdef _MSC_VER
245 /* 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.
251 */
252 if (errno == 0) /* bad mode string */
253 errno = EINVAL;
254 else if (errno == EINVAL) /* unknown, but not a mode string */
255 errno = ENOENT;
256#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000257 if (errno == EINVAL)
Tim Peters2ea91112002-04-08 04:13:12 +0000258 PyErr_Format(PyExc_IOError, "invalid mode: %s",
Jeremy Hylton41c83212001-11-09 16:17:24 +0000259 mode);
260 else
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000261 PyErr_SetFromErrnoWithFilenameObject(PyExc_IOError, f->f_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000262 f = NULL;
263 }
Tim Peters2ea91112002-04-08 04:13:12 +0000264 if (f != NULL)
Neil Schemenauered19b882002-03-23 02:06:50 +0000265 f = dircheck(f);
Georg Brandl7b90e162006-05-18 07:01:27 +0000266
267cleanup:
268 PyMem_FREE(newmode);
269
Tim Peters59c9a642001-09-13 05:38:56 +0000270 return (PyObject *)f;
271}
272
273PyObject *
274PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
275{
Tim Peters44410012001-09-14 03:26:08 +0000276 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
277 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000278 if (f != NULL) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000279 PyObject *o_name = PyString_FromString(name);
280 if (fill_file_fields(f, fp, o_name, mode, close) == NULL) {
Tim Peters59c9a642001-09-13 05:38:56 +0000281 Py_DECREF(f);
282 f = NULL;
283 }
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000284 Py_DECREF(o_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000285 }
286 return (PyObject *) f;
287}
288
289PyObject *
290PyFile_FromString(char *name, char *mode)
291{
292 extern int fclose(FILE *);
293 PyFileObject *f;
294
295 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
296 if (f != NULL) {
297 if (open_the_file(f, name, mode) == NULL) {
298 Py_DECREF(f);
299 f = NULL;
300 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000301 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000302 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000303}
304
Guido van Rossumb6775db1994-08-01 11:34:53 +0000305void
Fred Drakefd99de62000-07-09 05:02:18 +0000306PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000307{
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000308 PyFileObject *file = (PyFileObject *)f;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000309 if (bufsize >= 0) {
Guido van Rossumb6775db1994-08-01 11:34:53 +0000310 int type;
311 switch (bufsize) {
312 case 0:
313 type = _IONBF;
314 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000315#ifdef HAVE_SETVBUF
Guido van Rossumb6775db1994-08-01 11:34:53 +0000316 case 1:
317 type = _IOLBF;
318 bufsize = BUFSIZ;
319 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000320#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000321 default:
322 type = _IOFBF;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000323#ifndef HAVE_SETVBUF
324 bufsize = BUFSIZ;
325#endif
326 break;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000327 }
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000328 fflush(file->f_fp);
329 if (type == _IONBF) {
330 PyMem_Free(file->f_setbuf);
331 file->f_setbuf = NULL;
332 } else {
Anthony Baxter377be112006-04-11 06:54:30 +0000333 file->f_setbuf = (char *)PyMem_Realloc(file->f_setbuf,
334 bufsize);
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000335 }
336#ifdef HAVE_SETVBUF
337 setvbuf(file->f_fp, file->f_setbuf, type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000338#else /* !HAVE_SETVBUF */
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000339 setbuf(file->f_fp, file->f_setbuf);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000340#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000341 }
342}
343
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000344/* Set the encoding used to output Unicode strings.
345 Returh 1 on success, 0 on failure. */
346
347int
348PyFile_SetEncoding(PyObject *f, const char *enc)
349{
350 PyFileObject *file = (PyFileObject*)f;
351 PyObject *str = PyString_FromString(enc);
352 if (!str)
353 return 0;
354 Py_DECREF(file->f_encoding);
355 file->f_encoding = str;
356 return 1;
357}
358
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000359static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000360err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000361{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000362 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000363 return NULL;
364}
365
Thomas Woutersc45251a2006-02-12 11:53:32 +0000366/* Refuse regular file I/O if there's data in the iteration-buffer.
367 * Mixing them would cause data to arrive out of order, as the read*
368 * methods don't use the iteration buffer. */
369static PyObject *
370err_iterbuffered(void)
371{
372 PyErr_SetString(PyExc_ValueError,
373 "Mixing iteration and read methods would lose data");
374 return NULL;
375}
376
Neal Norwitzd8b995f2002-08-06 21:50:54 +0000377static void drop_readahead(PyFileObject *);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000378
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000379/* Methods */
380
381static void
Fred Drakefd99de62000-07-09 05:02:18 +0000382file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000383{
Peter Astrandf8e74b12004-11-07 14:15:28 +0000384 int sts = 0;
Raymond Hettingercb87bc82004-05-31 00:35:52 +0000385 if (f->weakreflist != NULL)
386 PyObject_ClearWeakRefs((PyObject *) f);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000387 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000388 Py_BEGIN_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000389 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000390 Py_END_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000391 if (sts == EOF)
392#ifdef HAVE_STRERROR
393 PySys_WriteStderr("close failed: [Errno %d] %s\n", errno, strerror(errno));
394#else
395 PySys_WriteStderr("close failed: [Errno %d]\n", errno);
396#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000397 }
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000398 PyMem_Free(f->f_setbuf);
Tim Peters44410012001-09-14 03:26:08 +0000399 Py_XDECREF(f->f_name);
400 Py_XDECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000401 Py_XDECREF(f->f_encoding);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000402 drop_readahead(f);
Guido van Rossum9475a232001-10-05 20:51:39 +0000403 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000404}
405
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000406static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000407file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000408{
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000409 if (PyUnicode_Check(f->f_name)) {
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000410#ifdef Py_USING_UNICODE
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000411 PyObject *ret = NULL;
412 PyObject *name;
413 name = PyUnicode_AsUnicodeEscapeString(f->f_name);
414 ret = PyString_FromFormat("<%s file u'%s', mode '%s' at %p>",
415 f->f_fp == NULL ? "closed" : "open",
416 PyString_AsString(name),
417 PyString_AsString(f->f_mode),
418 f);
419 Py_XDECREF(name);
420 return ret;
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000421#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000422 } else {
423 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000424 f->f_fp == NULL ? "closed" : "open",
425 PyString_AsString(f->f_name),
426 PyString_AsString(f->f_mode),
427 f);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000428 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000429}
430
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000431static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000432file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000433{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000434 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000435 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000436 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000437 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000438 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000439 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000440 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000441 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000442 f->f_fp = NULL;
443 }
Martin v. Löwis7bbcde72003-09-07 20:42:29 +0000444 PyMem_Free(f->f_setbuf);
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000445 f->f_setbuf = NULL;
Guido van Rossumfebd5511992-03-04 16:39:24 +0000446 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000447 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000448 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000449 return PyInt_FromLong((long)sts);
450 Py_INCREF(Py_None);
451 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000452}
453
Trent Mickf29f47b2000-08-11 19:02:59 +0000454
Guido van Rossumb8552162001-09-05 14:58:11 +0000455/* Our very own off_t-like type, 64-bit if possible */
456#if !defined(HAVE_LARGEFILE_SUPPORT)
457typedef off_t Py_off_t;
458#elif SIZEOF_OFF_T >= 8
459typedef off_t Py_off_t;
460#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000461typedef fpos_t Py_off_t;
462#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000463#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000464#endif
465
466
Trent Mickf29f47b2000-08-11 19:02:59 +0000467/* a portable fseek() function
468 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000469static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000470_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000471{
Guido van Rossumb8552162001-09-05 14:58:11 +0000472#if !defined(HAVE_LARGEFILE_SUPPORT)
473 return fseek(fp, offset, whence);
474#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000475 return fseeko(fp, offset, whence);
476#elif defined(HAVE_FSEEK64)
477 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000478#elif defined(__BEOS__)
479 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000480#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000481 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
482 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000483 fpos_t pos;
484 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000485 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000486#ifdef MS_WINDOWS
487 fflush(fp);
488 if (_lseeki64(fileno(fp), 0, 2) == -1)
489 return -1;
490#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000491 if (fseek(fp, 0, SEEK_END) != 0)
492 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000493#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000494 /* fall through */
495 case SEEK_CUR:
496 if (fgetpos(fp, &pos) != 0)
497 return -1;
498 offset += pos;
499 break;
500 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000501 }
502 return fsetpos(fp, &offset);
503#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000504#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000505#endif
506}
507
508
509/* a portable ftell() function
510 Return -1 on failure with errno set appropriately, current file
511 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000512static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000513_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000514{
Guido van Rossumb8552162001-09-05 14:58:11 +0000515#if !defined(HAVE_LARGEFILE_SUPPORT)
516 return ftell(fp);
517#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
518 return ftello(fp);
519#elif defined(HAVE_FTELL64)
520 return ftell64(fp);
521#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000522 fpos_t pos;
523 if (fgetpos(fp, &pos) != 0)
524 return -1;
525 return pos;
526#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000527#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000528#endif
529}
530
531
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000532static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000533file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000534{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000535 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000536 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000537 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000538 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000539
Guido van Rossumd7297e61992-07-06 14:19:26 +0000540 if (f->f_fp == NULL)
541 return err_closed();
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000542 drop_readahead(f);
Guido van Rossumd7297e61992-07-06 14:19:26 +0000543 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000544 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000545 return NULL;
546#if !defined(HAVE_LARGEFILE_SUPPORT)
547 offset = PyInt_AsLong(offobj);
548#else
549 offset = PyLong_Check(offobj) ?
550 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
551#endif
552 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000553 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000554
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000555 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000556 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000557 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000558 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000559
Guido van Rossumff4949e1992-08-05 19:58:53 +0000560 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000561 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000562 clearerr(f->f_fp);
563 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000564 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000565 f->f_skipnextlf = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000566 Py_INCREF(Py_None);
567 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000568}
569
Trent Mickf29f47b2000-08-11 19:02:59 +0000570
Guido van Rossumd7047b31995-01-02 19:07:15 +0000571#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000572static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000573file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000574{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000575 Py_off_t newsize;
Tim Petersf1827cf2003-09-07 03:30:18 +0000576 PyObject *newsizeobj = NULL;
577 Py_off_t initialpos;
578 int ret;
Tim Peters86821b22001-01-07 21:19:34 +0000579
Guido van Rossumd7047b31995-01-02 19:07:15 +0000580 if (f->f_fp == NULL)
581 return err_closed();
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000582 if (!PyArg_UnpackTuple(args, "truncate", 0, 1, &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000583 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000584
Tim Petersf1827cf2003-09-07 03:30:18 +0000585 /* Get current file position. If the file happens to be open for
586 * update and the last operation was an input operation, C doesn't
587 * define what the later fflush() will do, but we promise truncate()
588 * won't change the current position (and fflush() *does* change it
589 * then at least on Windows). The easiest thing is to capture
590 * current pos now and seek back to it at the end.
591 */
592 Py_BEGIN_ALLOW_THREADS
593 errno = 0;
594 initialpos = _portable_ftell(f->f_fp);
595 Py_END_ALLOW_THREADS
596 if (initialpos == -1)
597 goto onioerror;
598
Tim Petersfb05db22002-03-11 00:24:00 +0000599 /* Set newsize to current postion if newsizeobj NULL, else to the
Tim Petersf1827cf2003-09-07 03:30:18 +0000600 * specified value.
601 */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000602 if (newsizeobj != NULL) {
603#if !defined(HAVE_LARGEFILE_SUPPORT)
604 newsize = PyInt_AsLong(newsizeobj);
605#else
606 newsize = PyLong_Check(newsizeobj) ?
607 PyLong_AsLongLong(newsizeobj) :
608 PyInt_AsLong(newsizeobj);
609#endif
610 if (PyErr_Occurred())
611 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000612 }
Tim Petersf1827cf2003-09-07 03:30:18 +0000613 else /* default to current position */
614 newsize = initialpos;
Tim Petersfb05db22002-03-11 00:24:00 +0000615
Tim Petersf1827cf2003-09-07 03:30:18 +0000616 /* Flush the stream. We're mixing stream-level I/O with lower-level
617 * I/O, and a flush may be necessary to synch both platform views
618 * of the current file state.
619 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000620 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000621 errno = 0;
622 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000623 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000624 if (ret != 0)
625 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000626
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000627#ifdef MS_WINDOWS
Tim Petersfb05db22002-03-11 00:24:00 +0000628 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000629 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000630 {
Tim Petersfb05db22002-03-11 00:24:00 +0000631 HANDLE hFile;
Tim Petersfb05db22002-03-11 00:24:00 +0000632
Tim Petersf1827cf2003-09-07 03:30:18 +0000633 /* Have to move current pos to desired endpoint on Windows. */
634 Py_BEGIN_ALLOW_THREADS
635 errno = 0;
636 ret = _portable_fseek(f->f_fp, newsize, SEEK_SET) != 0;
637 Py_END_ALLOW_THREADS
638 if (ret)
639 goto onioerror;
Tim Petersfb05db22002-03-11 00:24:00 +0000640
Tim Peters8f01b682002-03-12 03:04:44 +0000641 /* Truncate. Note that this may grow the file! */
642 Py_BEGIN_ALLOW_THREADS
643 errno = 0;
644 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
Tim Petersf1827cf2003-09-07 03:30:18 +0000645 ret = hFile == (HANDLE)-1;
646 if (ret == 0) {
647 ret = SetEndOfFile(hFile) == 0;
648 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000649 errno = EACCES;
650 }
651 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000652 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000653 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000654 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000655#else
656 Py_BEGIN_ALLOW_THREADS
657 errno = 0;
658 ret = ftruncate(fileno(f->f_fp), newsize);
659 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000660 if (ret != 0)
661 goto onioerror;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000662#endif /* !MS_WINDOWS */
Tim Peters86821b22001-01-07 21:19:34 +0000663
Tim Petersf1827cf2003-09-07 03:30:18 +0000664 /* Restore original file position. */
665 Py_BEGIN_ALLOW_THREADS
666 errno = 0;
667 ret = _portable_fseek(f->f_fp, initialpos, SEEK_SET) != 0;
668 Py_END_ALLOW_THREADS
669 if (ret)
670 goto onioerror;
671
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000672 Py_INCREF(Py_None);
673 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000674
675onioerror:
676 PyErr_SetFromErrno(PyExc_IOError);
677 clearerr(f->f_fp);
678 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000679}
680#endif /* HAVE_FTRUNCATE */
681
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000682static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000683file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000684{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000685 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000686
Guido van Rossumd7297e61992-07-06 14:19:26 +0000687 if (f->f_fp == NULL)
688 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000689 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000690 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000691 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000692 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000693 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000694 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000695 clearerr(f->f_fp);
696 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000697 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000698 if (f->f_skipnextlf) {
699 int c;
700 c = GETC(f->f_fp);
701 if (c == '\n') {
702 pos++;
703 f->f_skipnextlf = 0;
704 } else if (c != EOF) ungetc(c, f->f_fp);
705 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000706#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000707 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000708#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000709 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000710#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000711}
712
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000713static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000714file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000715{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000716 if (f->f_fp == NULL)
717 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000718 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000719}
720
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000721static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000722file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000723{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000724 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000725
Guido van Rossumd7297e61992-07-06 14:19:26 +0000726 if (f->f_fp == NULL)
727 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000728 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000729 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000730 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000731 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000732 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000733 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000734 clearerr(f->f_fp);
735 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000736 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000737 Py_INCREF(Py_None);
738 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000739}
740
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000741static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000742file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000743{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000744 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000745 if (f->f_fp == NULL)
746 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000747 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000748 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000749 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000750 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000751}
752
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000753
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000754#if BUFSIZ < 8192
755#define SMALLCHUNK 8192
756#else
757#define SMALLCHUNK BUFSIZ
758#endif
759
Guido van Rossum3c259041999-01-14 19:00:14 +0000760#if SIZEOF_INT < 4
761#define BIGCHUNK (512 * 32)
762#else
763#define BIGCHUNK (512 * 1024)
764#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000765
766static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000767new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000768{
769#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000770 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000771 struct stat st;
772 if (fstat(fileno(f->f_fp), &st) == 0) {
773 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000774 /* The following is not a bug: we really need to call lseek()
775 *and* ftell(). The reason is that some stdio libraries
776 mistakenly flush their buffer when ftell() is called and
777 the lseek() call it makes fails, thereby throwing away
778 data that cannot be recovered in any way. To avoid this,
779 we first test lseek(), and only call ftell() if lseek()
780 works. We can't use the lseek() value either, because we
781 need to take the amount of buffered data into account.
782 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000783 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000784 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000785 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000786 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000787 if (pos < 0)
788 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000789 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000790 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000791 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000792 }
793#endif
794 if (currentsize > SMALLCHUNK) {
795 /* Keep doubling until we reach BIGCHUNK;
796 then keep adding BIGCHUNK. */
797 if (currentsize <= BIGCHUNK)
798 return currentsize + currentsize;
799 else
800 return currentsize + BIGCHUNK;
801 }
802 return currentsize + SMALLCHUNK;
803}
804
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000805#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
806#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
807#else
808#ifdef EWOULDBLOCK
809#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
810#else
811#ifdef EAGAIN
812#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
813#else
814#define BLOCKED_ERRNO(x) 0
815#endif
816#endif
817#endif
818
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000819static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000820file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000821{
Guido van Rossum789a1611997-05-10 22:33:55 +0000822 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000823 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000824 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000825
Guido van Rossumd7297e61992-07-06 14:19:26 +0000826 if (f->f_fp == NULL)
827 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000828 /* refuse to mix with f.next() */
829 if (f->f_buf != NULL &&
830 (f->f_bufend - f->f_bufptr) > 0 &&
831 f->f_buf[0] != '\0')
832 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000833 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000834 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000835 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000836 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000837 else
838 buffersize = bytesrequested;
Martin v. Löwis2a190742006-04-13 07:37:25 +0000839 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000840 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000841 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000842 return NULL;
843 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000844 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000845 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000846 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000847 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000848 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000849 Py_BEGIN_ALLOW_THREADS
850 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000851 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000852 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000853 Py_END_ALLOW_THREADS
854 if (chunksize == 0) {
855 if (!ferror(f->f_fp))
856 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000857 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000858 /* When in non-blocking mode, data shouldn't
859 * be discarded if a blocking signal was
860 * received. That will also happen if
861 * chunksize != 0, but bytesread < buffersize. */
862 if (bytesread > 0 && BLOCKED_ERRNO(errno))
863 break;
864 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum6263d541997-05-10 22:07:25 +0000865 Py_DECREF(v);
866 return NULL;
867 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000868 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000869 if (bytesread < buffersize) {
870 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000871 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000872 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000873 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000874 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000875 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000876 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000877 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000878 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000879 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000880 }
881 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000882 if (bytesread != buffersize)
883 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000884 return v;
885}
886
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000887static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000888file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000889{
890 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000891 Py_ssize_t ntodo;
892 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000893
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000894 if (f->f_fp == NULL)
895 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000896 /* refuse to mix with f.next() */
897 if (f->f_buf != NULL &&
898 (f->f_bufend - f->f_bufptr) > 0 &&
899 f->f_buf[0] != '\0')
900 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000901 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000902 return NULL;
903 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000904 while (ntodo > 0) {
905 Py_BEGIN_ALLOW_THREADS
906 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000907 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000908 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000909 Py_END_ALLOW_THREADS
910 if (nnow == 0) {
911 if (!ferror(f->f_fp))
912 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000913 PyErr_SetFromErrno(PyExc_IOError);
914 clearerr(f->f_fp);
915 return NULL;
916 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000917 ndone += nnow;
918 ntodo -= nnow;
919 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000920 return PyInt_FromLong((long)ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000921}
922
Tim Peters86821b22001-01-07 21:19:34 +0000923/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000924Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000925
926Under MSVC 6:
927
Tim Peters1c733232001-01-08 04:02:07 +0000928+ MS threadsafe getc is very slow (multiple layers of function calls before+
929 after each character, to lock+unlock the stream).
930+ The stream-locking functions are MS-internal -- can't access them from user
931 code.
932+ There's nothing Tim could find in the MS C or platform SDK libraries that
933 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000934+ MS fgets locks/unlocks only once per line; it's the only hook we have.
935
936So we use fgets for speed(!), despite that it's painful.
937
938MS realloc is also slow.
939
Tim Petersf29b64d2001-01-15 06:33:19 +0000940Reports from other platforms on this method vs getc_unlocked (which MS doesn't
941have):
942 Linux a wash
943 Solaris a wash
944 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000945
Tim Petersf29b64d2001-01-15 06:33:19 +0000946CAUTION: The C std isn't clear about this: in those cases where fgets
947writes something into the buffer, can it write into any position beyond the
948required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
949known on which it does; and it would be a strange way to code fgets. Still,
950getline_via_fgets may not work correctly if it does. The std test
951test_bufio.py should fail if platform fgets() routinely writes beyond the
952trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000953**************************************************************************/
954
Tim Petersf29b64d2001-01-15 06:33:19 +0000955/* Use this routine if told to, or by default on non-get_unlocked()
956 * platforms unless told not to. Yikes! Let's spell that out:
957 * On a platform with getc_unlocked():
958 * By default, use getc_unlocked().
959 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
960 * On a platform without getc_unlocked():
961 * By default, use fgets().
962 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
963 */
964#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
965#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000966#endif
967
Tim Petersf29b64d2001-01-15 06:33:19 +0000968#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
969#undef USE_FGETS_IN_GETLINE
970#endif
971
972#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000973static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000974getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000975{
Tim Peters15b83852001-01-08 00:53:12 +0000976/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000977 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
978 * to fill this much of the buffer with a known value in order to figure out
979 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
980 * than "most" lines, we waste time filling unused buffer slots. 100 is
981 * surely adequate for most peoples' email archives, chewing over source code,
982 * etc -- "regular old text files".
983 * MAXBUFSIZE is the maximum line length that lets us get away with the less
984 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
985 * cautions about boosting that. 300 was chosen because the worst real-life
986 * text-crunching job reported on Python-Dev was a mail-log crawler where over
987 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +0000988 */
Tim Peters142297a2001-01-15 10:36:56 +0000989#define INITBUFSIZE 100
990#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +0000991 char* p; /* temp */
992 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000993 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +0000994 char* pvfree; /* address of next free slot */
995 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +0000996 size_t nfree; /* # of free buffer slots; pvend-pvfree */
997 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +0000998 size_t increment; /* amount to increment the buffer */
Tim Peters86821b22001-01-07 21:19:34 +0000999
Tim Peters15b83852001-01-08 00:53:12 +00001000 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001001 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001002 */
Tim Peters142297a2001-01-15 10:36:56 +00001003 total_v_size = INITBUFSIZE; /* start small and pray */
1004 pvfree = buf;
1005 for (;;) {
1006 Py_BEGIN_ALLOW_THREADS
1007 pvend = buf + total_v_size;
1008 nfree = pvend - pvfree;
1009 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001010 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1011 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001012 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001013
Tim Peters142297a2001-01-15 10:36:56 +00001014 if (p == NULL) {
1015 clearerr(fp);
1016 if (PyErr_CheckSignals())
1017 return NULL;
1018 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001019 return v;
1020 }
Tim Peters142297a2001-01-15 10:36:56 +00001021 /* fgets read *something* */
1022 p = memchr(pvfree, '\n', nfree);
1023 if (p != NULL) {
1024 /* Did the \n come from fgets or from us?
1025 * Since fgets stops at the first \n, and then writes
1026 * \0, if it's from fgets a \0 must be next. But if
1027 * that's so, it could not have come from us, since
1028 * the \n's we filled the buffer with have only more
1029 * \n's to the right.
1030 */
1031 if (p+1 < pvend && *(p+1) == '\0') {
1032 /* It's from fgets: we win! In particular,
1033 * we haven't done any mallocs yet, and can
1034 * build the final result on the first try.
1035 */
1036 ++p; /* include \n from fgets */
1037 }
1038 else {
1039 /* Must be from us: fgets didn't fill the
1040 * buffer and didn't find a newline, so it
1041 * must be the last and newline-free line of
1042 * the file.
1043 */
1044 assert(p > pvfree && *(p-1) == '\0');
1045 --p; /* don't include \0 from fgets */
1046 }
1047 v = PyString_FromStringAndSize(buf, p - buf);
1048 return v;
1049 }
1050 /* yuck: fgets overwrote all the newlines, i.e. the entire
1051 * buffer. So this line isn't over yet, or maybe it is but
1052 * we're exactly at EOF. If we haven't already, try using the
1053 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001054 */
Tim Peters142297a2001-01-15 10:36:56 +00001055 assert(*(pvend-1) == '\0');
1056 if (pvfree == buf) {
1057 pvfree = pvend - 1; /* overwrite trailing null */
1058 total_v_size = MAXBUFSIZE;
1059 }
1060 else
1061 break;
Tim Peters86821b22001-01-07 21:19:34 +00001062 }
Tim Peters142297a2001-01-15 10:36:56 +00001063
1064 /* The stack buffer isn't big enough; malloc a string object and read
1065 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001066 */
Tim Petersddea2082002-03-23 10:03:50 +00001067 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001068 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001069 if (v == NULL)
1070 return v;
1071 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001072 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1073 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001074
1075 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001076 * after setting p one beyond the end of the line. The code here is
1077 * very much like the code above, except reads into v's buffer; see
1078 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001079 */
1080 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001081 Py_BEGIN_ALLOW_THREADS
1082 pvend = BUF(v) + total_v_size;
1083 nfree = pvend - pvfree;
1084 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001085 assert(nfree < INT_MAX);
1086 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001087 Py_END_ALLOW_THREADS
1088
1089 if (p == NULL) {
1090 clearerr(fp);
1091 if (PyErr_CheckSignals()) {
1092 Py_DECREF(v);
1093 return NULL;
1094 }
1095 p = pvfree;
1096 break;
1097 }
Tim Peters86821b22001-01-07 21:19:34 +00001098 p = memchr(pvfree, '\n', nfree);
1099 if (p != NULL) {
1100 if (p+1 < pvend && *(p+1) == '\0') {
1101 /* \n came from fgets */
1102 ++p;
1103 break;
1104 }
1105 /* \n came from us; last line of file, no newline */
1106 assert(p > pvfree && *(p-1) == '\0');
1107 --p;
1108 break;
1109 }
1110 /* expand buffer and try again */
1111 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001112 increment = total_v_size >> 2; /* mild exponential growth */
1113 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001114 if (total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001115 PyErr_SetString(PyExc_OverflowError,
1116 "line is longer than a Python string can hold");
1117 Py_DECREF(v);
1118 return NULL;
1119 }
1120 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1121 return NULL;
1122 /* overwrite the trailing null byte */
Tim Petersddea2082002-03-23 10:03:50 +00001123 pvfree = BUF(v) + (total_v_size - increment - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001124 }
1125 if (BUF(v) + total_v_size != p)
1126 _PyString_Resize(&v, p - BUF(v));
1127 return v;
1128#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001129#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001130}
Tim Petersf29b64d2001-01-15 06:33:19 +00001131#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001132
Guido van Rossum0bd24411991-04-04 15:21:57 +00001133/* Internal routine to get a line.
1134 Size argument interpretation:
1135 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001136 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001137*/
1138
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001139static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001140get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001141{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001142 FILE *fp = f->f_fp;
1143 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001144 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001145 size_t total_v_size; /* total # of slots in buffer */
1146 size_t used_v_size; /* # used slots in buffer */
1147 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001148 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001149 int newlinetypes = f->f_newlinetypes;
1150 int skipnextlf = f->f_skipnextlf;
1151 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001152
Jack Jansen7b8c7542002-04-14 20:12:41 +00001153#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001154 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001155 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001156#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001157 total_v_size = n > 0 ? n : 100;
1158 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001159 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001160 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001161 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001162 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001163
Guido van Rossumce5ba841991-03-06 13:06:18 +00001164 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001165 Py_BEGIN_ALLOW_THREADS
1166 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001167 if (univ_newline) {
1168 c = 'x'; /* Shut up gcc warning */
1169 while ( buf != end && (c = GETC(fp)) != EOF ) {
1170 if (skipnextlf ) {
1171 skipnextlf = 0;
1172 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001173 /* Seeing a \n here with
1174 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001175 * saw a \r before.
1176 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001177 newlinetypes |= NEWLINE_CRLF;
1178 c = GETC(fp);
1179 if (c == EOF) break;
1180 } else {
1181 newlinetypes |= NEWLINE_CR;
1182 }
1183 }
1184 if (c == '\r') {
1185 skipnextlf = 1;
1186 c = '\n';
1187 } else if ( c == '\n')
1188 newlinetypes |= NEWLINE_LF;
1189 *buf++ = c;
1190 if (c == '\n') break;
1191 }
1192 if ( c == EOF && skipnextlf )
1193 newlinetypes |= NEWLINE_CR;
1194 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001195 while ((c = GETC(fp)) != EOF &&
1196 (*buf++ = c) != '\n' &&
1197 buf != end)
1198 ;
1199 FUNLOCKFILE(fp);
1200 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001201 f->f_newlinetypes = newlinetypes;
1202 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001203 if (c == '\n')
1204 break;
1205 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001206 if (ferror(fp)) {
1207 PyErr_SetFromErrno(PyExc_IOError);
1208 clearerr(fp);
1209 Py_DECREF(v);
1210 return NULL;
1211 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001212 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001213 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001214 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001215 return NULL;
1216 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001217 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001218 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001219 /* Must be because buf == end */
1220 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001221 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001222 used_v_size = total_v_size;
1223 increment = total_v_size >> 2; /* mild exponential growth */
1224 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001225 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001226 PyErr_SetString(PyExc_OverflowError,
1227 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001228 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001229 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001230 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001231 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001232 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001233 buf = BUF(v) + used_v_size;
1234 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001235 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001236
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001237 used_v_size = buf - BUF(v);
1238 if (used_v_size != total_v_size)
1239 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001240 return v;
1241}
1242
Guido van Rossum0bd24411991-04-04 15:21:57 +00001243/* External C interface */
1244
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001245PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001246PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001247{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001248 PyObject *result;
1249
Guido van Rossum3165fe61992-09-25 21:59:05 +00001250 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001251 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001252 return NULL;
1253 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001254
1255 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001256 PyFileObject *fo = (PyFileObject *)f;
1257 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001258 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001259 /* refuse to mix with f.next() */
1260 if (fo->f_buf != NULL &&
1261 (fo->f_bufend - fo->f_bufptr) > 0 &&
1262 fo->f_buf[0] != '\0')
1263 return err_iterbuffered();
1264 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001265 }
1266 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001267 PyObject *reader;
1268 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001269
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001270 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001271 if (reader == NULL)
1272 return NULL;
1273 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001274 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001275 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001276 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001277 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001278 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001279 return NULL;
1280 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001281 result = PyEval_CallObject(reader, args);
1282 Py_DECREF(reader);
1283 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001284 if (result != NULL && !PyString_Check(result) &&
1285 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001286 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001287 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001288 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001289 "object.readline() returned non-string");
1290 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001291 }
1292
1293 if (n < 0 && result != NULL && PyString_Check(result)) {
1294 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001295 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001296 if (len == 0) {
1297 Py_DECREF(result);
1298 result = NULL;
1299 PyErr_SetString(PyExc_EOFError,
1300 "EOF when reading a line");
1301 }
1302 else if (s[len-1] == '\n') {
1303 if (result->ob_refcnt == 1)
1304 _PyString_Resize(&result, len-1);
1305 else {
1306 PyObject *v;
1307 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001308 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001309 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001310 }
1311 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001312 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001313#ifdef Py_USING_UNICODE
1314 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1315 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001316 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001317 if (len == 0) {
1318 Py_DECREF(result);
1319 result = NULL;
1320 PyErr_SetString(PyExc_EOFError,
1321 "EOF when reading a line");
1322 }
1323 else if (s[len-1] == '\n') {
1324 if (result->ob_refcnt == 1)
1325 PyUnicode_Resize(&result, len-1);
1326 else {
1327 PyObject *v;
1328 v = PyUnicode_FromUnicode(s, len-1);
1329 Py_DECREF(result);
1330 result = v;
1331 }
1332 }
1333 }
1334#endif
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001335 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001336}
1337
1338/* Python method */
1339
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001340static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001341file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001342{
Guido van Rossum789a1611997-05-10 22:33:55 +00001343 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001344
Guido van Rossumd7297e61992-07-06 14:19:26 +00001345 if (f->f_fp == NULL)
1346 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001347 /* refuse to mix with f.next() */
1348 if (f->f_buf != NULL &&
1349 (f->f_bufend - f->f_bufptr) > 0 &&
1350 f->f_buf[0] != '\0')
1351 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001352 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001353 return NULL;
1354 if (n == 0)
1355 return PyString_FromString("");
1356 if (n < 0)
1357 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001358 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001359}
1360
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001361static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001362file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001363{
Guido van Rossum789a1611997-05-10 22:33:55 +00001364 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001365 PyObject *list;
1366 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001367 char small_buffer[SMALLCHUNK];
1368 char *buffer = small_buffer;
1369 size_t buffersize = SMALLCHUNK;
1370 PyObject *big_buffer = NULL;
1371 size_t nfilled = 0;
1372 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001373 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001374 char *p, *q, *end;
1375 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001376 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001377
Guido van Rossumd7297e61992-07-06 14:19:26 +00001378 if (f->f_fp == NULL)
1379 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001380 /* refuse to mix with f.next() */
1381 if (f->f_buf != NULL &&
1382 (f->f_bufend - f->f_bufptr) > 0 &&
1383 f->f_buf[0] != '\0')
1384 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001385 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001386 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001387 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001388 return NULL;
1389 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001390 if (shortread)
1391 nread = 0;
1392 else {
1393 Py_BEGIN_ALLOW_THREADS
1394 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001395 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001396 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001397 Py_END_ALLOW_THREADS
1398 shortread = (nread < buffersize-nfilled);
1399 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001400 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001401 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001402 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001403 break;
1404 PyErr_SetFromErrno(PyExc_IOError);
1405 clearerr(f->f_fp);
1406 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001407 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001408 list = NULL;
1409 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001410 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001411 totalread += nread;
Anthony Baxter377be112006-04-11 06:54:30 +00001412 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001413 if (p == NULL) {
1414 /* Need a larger buffer to fit this line */
1415 nfilled += nread;
1416 buffersize *= 2;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001417 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001418 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001419 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001420 goto error;
1421 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001422 if (big_buffer == NULL) {
1423 /* Create the big buffer */
1424 big_buffer = PyString_FromStringAndSize(
1425 NULL, buffersize);
1426 if (big_buffer == NULL)
1427 goto error;
1428 buffer = PyString_AS_STRING(big_buffer);
1429 memcpy(buffer, small_buffer, nfilled);
1430 }
1431 else {
1432 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001433 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1434 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001435 buffer = PyString_AS_STRING(big_buffer);
1436 }
1437 continue;
1438 }
1439 end = buffer+nfilled+nread;
1440 q = buffer;
1441 do {
1442 /* Process complete lines */
1443 p++;
1444 line = PyString_FromStringAndSize(q, p-q);
1445 if (line == NULL)
1446 goto error;
1447 err = PyList_Append(list, line);
1448 Py_DECREF(line);
1449 if (err != 0)
1450 goto error;
1451 q = p;
Anthony Baxter377be112006-04-11 06:54:30 +00001452 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001453 } while (p != NULL);
1454 /* Move the remaining incomplete line to the start */
1455 nfilled = end-q;
1456 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001457 if (sizehint > 0)
1458 if (totalread >= (size_t)sizehint)
1459 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001460 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001461 if (nfilled != 0) {
1462 /* Partial last line */
1463 line = PyString_FromStringAndSize(buffer, nfilled);
1464 if (line == NULL)
1465 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001466 if (sizehint > 0) {
1467 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001468 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001469 if (rest == NULL) {
1470 Py_DECREF(line);
1471 goto error;
1472 }
1473 PyString_Concat(&line, rest);
1474 Py_DECREF(rest);
1475 if (line == NULL)
1476 goto error;
1477 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001478 err = PyList_Append(list, line);
1479 Py_DECREF(line);
1480 if (err != 0)
1481 goto error;
1482 }
1483 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001484 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001485 return list;
1486}
1487
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001488static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001489file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001490{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001491 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001492 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001493 if (f->f_fp == NULL)
1494 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001495 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001496 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001497 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001498 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001499 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001500 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001501 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001502 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001503 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001504 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001505 return NULL;
1506 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001507 Py_INCREF(Py_None);
1508 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001509}
1510
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001511static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001512file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001513{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001514#define CHUNKSIZE 1000
1515 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001516 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001517 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001518 int index, islist;
1519 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001520
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001521 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001522 if (f->f_fp == NULL)
1523 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001524
1525 result = NULL;
1526 list = NULL;
1527 islist = PyList_Check(seq);
1528 if (islist)
1529 it = NULL;
1530 else {
1531 it = PyObject_GetIter(seq);
1532 if (it == NULL) {
1533 PyErr_SetString(PyExc_TypeError,
1534 "writelines() requires an iterable argument");
1535 return NULL;
1536 }
1537 /* From here on, fail by going to error, to reclaim "it". */
1538 list = PyList_New(CHUNKSIZE);
1539 if (list == NULL)
1540 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001541 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001542
1543 /* Strategy: slurp CHUNKSIZE lines into a private list,
1544 checking that they are all strings, then write that list
1545 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001546 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001547 if (islist) {
1548 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001549 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001550 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001551 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001552 j = PyList_GET_SIZE(list);
1553 }
1554 else {
1555 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001556 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001557 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001558 if (PyErr_Occurred())
1559 goto error;
1560 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001561 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001562 PyList_SetItem(list, j, line);
1563 }
1564 }
1565 if (j == 0)
1566 break;
1567
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001568 /* Check that all entries are indeed strings. If not,
1569 apply the same rules as for file.write() and
1570 convert the results to strings. This is slow, but
1571 seems to be the only way since all conversion APIs
1572 could potentially execute Python code. */
1573 for (i = 0; i < j; i++) {
1574 PyObject *v = PyList_GET_ITEM(list, i);
1575 if (!PyString_Check(v)) {
1576 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001577 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001578 PyObject_AsReadBuffer(v,
1579 (const void**)&buffer,
1580 &len)) ||
1581 PyObject_AsCharBuffer(v,
1582 &buffer,
1583 &len))) {
1584 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001585 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001586 goto error;
1587 }
1588 line = PyString_FromStringAndSize(buffer,
1589 len);
1590 if (line == NULL)
1591 goto error;
1592 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001593 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001594 }
1595 }
1596
1597 /* Since we are releasing the global lock, the
1598 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001599 Py_BEGIN_ALLOW_THREADS
1600 f->f_softspace = 0;
1601 errno = 0;
1602 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001603 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001604 len = PyString_GET_SIZE(line);
1605 nwritten = fwrite(PyString_AS_STRING(line),
1606 1, len, f->f_fp);
1607 if (nwritten != len) {
1608 Py_BLOCK_THREADS
1609 PyErr_SetFromErrno(PyExc_IOError);
1610 clearerr(f->f_fp);
1611 goto error;
1612 }
1613 }
1614 Py_END_ALLOW_THREADS
1615
1616 if (j < CHUNKSIZE)
1617 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001618 }
1619
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001620 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001621 result = Py_None;
1622 error:
1623 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001624 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001625 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001626#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001627}
1628
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001629static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001630file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001631{
1632 if (f->f_fp == NULL)
1633 return err_closed();
1634 Py_INCREF(f);
1635 return (PyObject *)f;
1636}
1637
Georg Brandl98b40ad2006-06-08 14:50:21 +00001638static PyObject *
1639file_exit(PyFileObject *f, PyObject *args)
1640{
1641 PyObject *ret = file_close(f);
1642 if (!ret)
1643 /* If error occurred, pass through */
1644 return NULL;
1645 Py_DECREF(ret);
1646 /* We cannot return the result of close since a true
1647 * value will be interpreted as "yes, swallow the
1648 * exception if one was raised inside the with block". */
1649 Py_RETURN_NONE;
1650}
1651
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001652PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001653"readline([size]) -> next line from the file, as a string.\n"
1654"\n"
1655"Retain newline. A non-negative size argument limits the maximum\n"
1656"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001657"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001658
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001659PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001660"read([size]) -> read at most size bytes, returned as a string.\n"
1661"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001662"If the size argument is negative or omitted, read until EOF is reached.\n"
1663"Notice that when in non-blocking mode, less data than what was requested\n"
1664"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001665
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001666PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001667"write(str) -> None. Write string str to file.\n"
1668"\n"
1669"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001670"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001671
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001672PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001673"fileno() -> integer \"file descriptor\".\n"
1674"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001675"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001676
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001677PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001678"seek(offset[, whence]) -> None. Move to new file position.\n"
1679"\n"
1680"Argument offset is a byte count. Optional argument whence defaults to\n"
1681"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1682"(move relative to current position, positive or negative), and 2 (move\n"
1683"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001684"seeking beyond the end of a file). If the file is opened in text mode,\n"
1685"only offsets returned by tell() are legal. Use of other offsets causes\n"
1686"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001687"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001688"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001689
Guido van Rossumd7047b31995-01-02 19:07:15 +00001690#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001691PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001692"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1693"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001694"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001695#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001696
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001697PyDoc_STRVAR(tell_doc,
1698"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001699
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001700PyDoc_STRVAR(readinto_doc,
1701"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001702
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001703PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001704"readlines([size]) -> list of strings, each a line from the file.\n"
1705"\n"
1706"Call readline() repeatedly and return a list of the lines so read.\n"
1707"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001708"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001709
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001710PyDoc_STRVAR(xreadlines_doc,
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001711"xreadlines() -> returns self.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001712"\n"
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001713"For backward compatibility. File objects now include the performance\n"
1714"optimizations previously implemented in the xreadlines module.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001715
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001716PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001717"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001718"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001719"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001720"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001721
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001722PyDoc_STRVAR(flush_doc,
1723"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001724
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001725PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001726"close() -> None or (perhaps) an integer. Close the file.\n"
1727"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001728"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001729"further I/O operations. close() may be called more than once without\n"
1730"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001731"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001732
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001733PyDoc_STRVAR(isatty_doc,
1734"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001735
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001736PyDoc_STRVAR(enter_doc,
1737 "__enter__() -> self.");
1738
Georg Brandl98b40ad2006-06-08 14:50:21 +00001739PyDoc_STRVAR(exit_doc,
1740 "__exit__(*excinfo) -> None. Closes the file.");
1741
Tim Petersefc3a3a2001-09-20 07:55:22 +00001742static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001743 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1744 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1745 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1746 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1747 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001748#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001749 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001750#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001751 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1752 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1753 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001754 {"xreadlines",(PyCFunction)file_self, METH_NOARGS, xreadlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001755 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1756 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1757 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1758 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001759 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Georg Brandl98b40ad2006-06-08 14:50:21 +00001760 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001761 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001762};
1763
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001764#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001765
Guido van Rossum6f799372001-09-20 20:46:19 +00001766static PyMemberDef file_memberlist[] = {
1767 {"softspace", T_INT, OFF(f_softspace), 0,
1768 "flag indicating that a space needs to be printed; used by print"},
1769 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001770 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001771 {"name", T_OBJECT, OFF(f_name), RO,
1772 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001773 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1774 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001775 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001776 {NULL} /* Sentinel */
1777};
1778
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001779static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001780get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001781{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001782 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001783}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001784static PyObject *
1785get_newlines(PyFileObject *f, void *closure)
1786{
1787 switch (f->f_newlinetypes) {
1788 case NEWLINE_UNKNOWN:
1789 Py_INCREF(Py_None);
1790 return Py_None;
1791 case NEWLINE_CR:
1792 return PyString_FromString("\r");
1793 case NEWLINE_LF:
1794 return PyString_FromString("\n");
1795 case NEWLINE_CR|NEWLINE_LF:
1796 return Py_BuildValue("(ss)", "\r", "\n");
1797 case NEWLINE_CRLF:
1798 return PyString_FromString("\r\n");
1799 case NEWLINE_CR|NEWLINE_CRLF:
1800 return Py_BuildValue("(ss)", "\r", "\r\n");
1801 case NEWLINE_LF|NEWLINE_CRLF:
1802 return Py_BuildValue("(ss)", "\n", "\r\n");
1803 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1804 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1805 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001806 PyErr_Format(PyExc_SystemError,
1807 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001808 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001809 return NULL;
1810 }
1811}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001812
Guido van Rossum32d34c82001-09-20 21:45:26 +00001813static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001814 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001815 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001816 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001817 {0},
1818};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001819
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001820static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001821drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001822{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001823 if (f->f_buf != NULL) {
1824 PyMem_Free(f->f_buf);
1825 f->f_buf = NULL;
1826 }
Guido van Rossum65967252001-04-21 13:20:18 +00001827}
1828
Tim Petersf1827cf2003-09-07 03:30:18 +00001829/* Make sure that file has a readahead buffer with at least one byte
1830 (unless at EOF) and no more than bufsize. Returns negative value on
Georg Brandled02eb62006-03-31 20:31:02 +00001831 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001832static int
1833readahead(PyFileObject *f, int bufsize)
1834{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001835 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001836
1837 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001838 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001839 return 0;
1840 else
1841 drop_readahead(f);
1842 }
Anthony Baxter377be112006-04-11 06:54:30 +00001843 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
Georg Brandled02eb62006-03-31 20:31:02 +00001844 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001845 return -1;
1846 }
1847 Py_BEGIN_ALLOW_THREADS
1848 errno = 0;
1849 chunksize = Py_UniversalNewlineFread(
1850 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1851 Py_END_ALLOW_THREADS
1852 if (chunksize == 0) {
1853 if (ferror(f->f_fp)) {
1854 PyErr_SetFromErrno(PyExc_IOError);
1855 clearerr(f->f_fp);
1856 drop_readahead(f);
1857 return -1;
1858 }
1859 }
1860 f->f_bufptr = f->f_buf;
1861 f->f_bufend = f->f_buf + chunksize;
1862 return 0;
1863}
1864
1865/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001866 uninitialized bytes followed by the remainder of the line. Don't be
1867 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001868 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1869
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001870static PyStringObject *
1871readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1872{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001873 PyStringObject* s;
1874 char *bufptr;
1875 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001876 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001877
1878 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001879 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001880 return NULL;
1881
1882 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001883 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001884 return (PyStringObject *)
1885 PyString_FromStringAndSize(NULL, skip);
Anthony Baxter377be112006-04-11 06:54:30 +00001886 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001887 if (bufptr != NULL) {
1888 bufptr++; /* Count the '\n' */
1889 len = bufptr - f->f_bufptr;
1890 s = (PyStringObject *)
1891 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001892 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001893 return NULL;
1894 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1895 f->f_bufptr = bufptr;
1896 if (bufptr == f->f_bufend)
1897 drop_readahead(f);
1898 } else {
1899 bufptr = f->f_bufptr;
1900 buf = f->f_buf;
1901 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001902 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001903 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001904 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001905 if (s == NULL) {
1906 PyMem_Free(buf);
1907 return NULL;
1908 }
1909 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1910 PyMem_Free(buf);
1911 }
1912 return s;
1913}
1914
1915/* A larger buffer size may actually decrease performance. */
1916#define READAHEAD_BUFSIZE 8192
1917
1918static PyObject *
1919file_iternext(PyFileObject *f)
1920{
1921 PyStringObject* l;
1922
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001923 if (f->f_fp == NULL)
1924 return err_closed();
1925
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001926 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1927 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1928 Py_XDECREF(l);
1929 return NULL;
1930 }
1931 return (PyObject *)l;
1932}
1933
1934
Tim Peters59c9a642001-09-13 05:38:56 +00001935static PyObject *
1936file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1937{
Tim Peters44410012001-09-14 03:26:08 +00001938 PyObject *self;
1939 static PyObject *not_yet_string;
1940
1941 assert(type != NULL && type->tp_alloc != NULL);
1942
1943 if (not_yet_string == NULL) {
1944 not_yet_string = PyString_FromString("<uninitialized file>");
1945 if (not_yet_string == NULL)
1946 return NULL;
1947 }
1948
1949 self = type->tp_alloc(type, 0);
1950 if (self != NULL) {
1951 /* Always fill in the name and mode, so that nobody else
1952 needs to special-case NULLs there. */
1953 Py_INCREF(not_yet_string);
1954 ((PyFileObject *)self)->f_name = not_yet_string;
1955 Py_INCREF(not_yet_string);
1956 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001957 Py_INCREF(Py_None);
1958 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001959 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001960 }
1961 return self;
1962}
1963
1964static int
1965file_init(PyObject *self, PyObject *args, PyObject *kwds)
1966{
1967 PyFileObject *foself = (PyFileObject *)self;
1968 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001969 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001970 char *name = NULL;
1971 char *mode = "r";
1972 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001973 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001974
1975 assert(PyFile_Check(self));
1976 if (foself->f_fp != NULL) {
1977 /* Have to close the existing file first. */
1978 PyObject *closeresult = file_close(foself);
1979 if (closeresult == NULL)
1980 return -1;
1981 Py_DECREF(closeresult);
1982 }
Tim Peters59c9a642001-09-13 05:38:56 +00001983
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001984#ifdef Py_WIN_WIDE_FILENAMES
1985 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
1986 PyObject *po;
1987 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
1988 kwlist, &po, &mode, &bufsize)) {
1989 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00001990 if (fill_file_fields(foself, NULL, po, mode,
1991 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001992 goto Error;
1993 } else {
1994 /* Drop the argument parsing error as narrow
1995 strings are also valid. */
1996 PyErr_Clear();
1997 }
1998 }
1999#endif
2000
2001 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002002 PyObject *o_name;
2003
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002004 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2005 Py_FileSystemDefaultEncoding,
2006 &name,
2007 &mode, &bufsize))
2008 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002009
2010 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002011 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2012 kwlist, &o_name, &mode,
2013 &bufsize))
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002014 return -1;
2015
2016 if (fill_file_fields(foself, NULL, o_name, mode,
2017 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002018 goto Error;
2019 }
Tim Peters44410012001-09-14 03:26:08 +00002020 if (open_the_file(foself, name, mode) == NULL)
2021 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002022 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002023 PyFile_SetBufSize(self, bufsize);
2024 goto Done;
2025
2026Error:
2027 ret = -1;
2028 /* fall through */
2029Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002030 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002031 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002032}
2033
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002034PyDoc_VAR(file_doc) =
2035PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002036"file(name[, mode[, buffering]]) -> file object\n"
2037"\n"
2038"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2039"writing or appending. The file will be created if it doesn't exist\n"
2040"when opened for writing or appending; it will be truncated when\n"
2041"opened for writing. Add a 'b' to the mode for binary files.\n"
2042"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2043"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002044"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002045)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002046PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002047"Add a 'U' to mode to open the file for input with universal newline\n"
2048"support. Any line ending in the input file will be seen as a '\\n'\n"
2049"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2050"the value for this attribute is one of None (no newline read yet),\n"
2051"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2052"\n"
2053"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002054);
Tim Peters59c9a642001-09-13 05:38:56 +00002055
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002056PyTypeObject PyFile_Type = {
2057 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002058 0,
2059 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002060 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002061 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002062 (destructor)file_dealloc, /* tp_dealloc */
2063 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002064 0, /* tp_getattr */
2065 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002066 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002067 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002068 0, /* tp_as_number */
2069 0, /* tp_as_sequence */
2070 0, /* tp_as_mapping */
2071 0, /* tp_hash */
2072 0, /* tp_call */
2073 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002074 PyObject_GenericGetAttr, /* tp_getattro */
Tim Peters015dd822003-05-04 04:16:52 +00002075 /* softspace is writable: we must supply tp_setattro */
2076 PyObject_GenericSetAttr, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002077 0, /* tp_as_buffer */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002078 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002079 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002080 0, /* tp_traverse */
2081 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002082 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002083 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002084 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002085 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002086 file_methods, /* tp_methods */
2087 file_memberlist, /* tp_members */
2088 file_getsetlist, /* tp_getset */
2089 0, /* tp_base */
2090 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002091 0, /* tp_descr_get */
2092 0, /* tp_descr_set */
2093 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002094 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002095 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002096 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002097 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002098};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002099
2100/* Interface for the 'soft space' between print items. */
2101
2102int
Fred Drakefd99de62000-07-09 05:02:18 +00002103PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00002104{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002105 long oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002106 if (f == NULL) {
2107 /* Do nothing */
2108 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002109 else if (PyFile_Check(f)) {
2110 oldflag = ((PyFileObject *)f)->f_softspace;
2111 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002112 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00002113 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002114 PyObject *v;
2115 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002116 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002117 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002118 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002119 if (PyInt_Check(v))
2120 oldflag = PyInt_AsLong(v);
Martin v. Löwis18e16552006-02-15 17:27:45 +00002121 assert(oldflag < INT_MAX);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002122 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002123 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002124 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002125 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002126 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002127 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002128 if (PyObject_SetAttrString(f, "softspace", v) != 0)
2129 PyErr_Clear();
2130 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002131 }
2132 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002133 return (int)oldflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002134}
Guido van Rossum3165fe61992-09-25 21:59:05 +00002135
2136/* Interfaces to write objects/strings to file-like objects */
2137
2138int
Fred Drakefd99de62000-07-09 05:02:18 +00002139PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002140{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002141 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002142 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002143 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002144 return -1;
2145 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002146 else if (PyFile_Check(f)) {
2147 FILE *fp = PyFile_AsFile(f);
Fred Drake086a0f72004-03-19 15:22:36 +00002148#ifdef Py_USING_UNICODE
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002149 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2150 int result;
Fred Drake086a0f72004-03-19 15:22:36 +00002151#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002152 if (fp == NULL) {
2153 err_closed();
2154 return -1;
2155 }
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002156#ifdef Py_USING_UNICODE
Tim Petersf1827cf2003-09-07 03:30:18 +00002157 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002158 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002159 char *cenc = PyString_AS_STRING(enc);
2160 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2161 if (value == NULL)
2162 return -1;
2163 } else {
2164 value = v;
2165 Py_INCREF(value);
2166 }
2167 result = PyObject_Print(value, fp, flags);
2168 Py_DECREF(value);
2169 return result;
2170#else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002171 return PyObject_Print(v, fp, flags);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002172#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002173 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002174 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002175 if (writer == NULL)
2176 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002177 if (flags & Py_PRINT_RAW) {
2178 if (PyUnicode_Check(v)) {
2179 value = v;
2180 Py_INCREF(value);
2181 } else
2182 value = PyObject_Str(v);
2183 }
2184 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002185 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002186 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002187 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002188 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002189 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002190 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002191 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002192 Py_DECREF(value);
2193 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002194 return -1;
2195 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002196 result = PyEval_CallObject(writer, args);
2197 Py_DECREF(args);
2198 Py_DECREF(value);
2199 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002200 if (result == NULL)
2201 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002202 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002203 return 0;
2204}
2205
Guido van Rossum27a60b11997-05-22 22:25:11 +00002206int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002207PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002208{
2209 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002210 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002211 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002212 PyErr_SetString(PyExc_SystemError,
2213 "null file for PyFile_WriteString");
2214 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002215 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002216 else if (PyFile_Check(f)) {
2217 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002218 if (fp == NULL) {
2219 err_closed();
2220 return -1;
2221 }
2222 fputs(s, fp);
2223 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002224 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002225 else if (!PyErr_Occurred()) {
2226 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002227 int err;
2228 if (v == NULL)
2229 return -1;
2230 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2231 Py_DECREF(v);
2232 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002233 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002234 else
2235 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002236}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002237
2238/* Try to get a file-descriptor from a Python object. If the object
2239 is an integer or long integer, its value is returned. If not, the
2240 object's fileno() method is called if it exists; the method must return
2241 an integer or long integer, which is returned as the file descriptor value.
2242 -1 is returned on failure.
2243*/
2244
2245int PyObject_AsFileDescriptor(PyObject *o)
2246{
2247 int fd;
2248 PyObject *meth;
2249
2250 if (PyInt_Check(o)) {
2251 fd = PyInt_AsLong(o);
2252 }
2253 else if (PyLong_Check(o)) {
2254 fd = PyLong_AsLong(o);
2255 }
2256 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2257 {
2258 PyObject *fno = PyEval_CallObject(meth, NULL);
2259 Py_DECREF(meth);
2260 if (fno == NULL)
2261 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002262
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002263 if (PyInt_Check(fno)) {
2264 fd = PyInt_AsLong(fno);
2265 Py_DECREF(fno);
2266 }
2267 else if (PyLong_Check(fno)) {
2268 fd = PyLong_AsLong(fno);
2269 Py_DECREF(fno);
2270 }
2271 else {
2272 PyErr_SetString(PyExc_TypeError,
2273 "fileno() returned a non-integer");
2274 Py_DECREF(fno);
2275 return -1;
2276 }
2277 }
2278 else {
2279 PyErr_SetString(PyExc_TypeError,
2280 "argument must be an int, or have a fileno() method.");
2281 return -1;
2282 }
2283
2284 if (fd < 0) {
2285 PyErr_Format(PyExc_ValueError,
2286 "file descriptor cannot be a negative integer (%i)",
2287 fd);
2288 return -1;
2289 }
2290 return fd;
2291}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002292
Jack Jansen7b8c7542002-04-14 20:12:41 +00002293/* From here on we need access to the real fgets and fread */
2294#undef fgets
2295#undef fread
2296
2297/*
2298** Py_UniversalNewlineFgets is an fgets variation that understands
2299** all of \r, \n and \r\n conventions.
2300** The stream should be opened in binary mode.
2301** If fobj is NULL the routine always does newline conversion, and
2302** it may peek one char ahead to gobble the second char in \r\n.
2303** If fobj is non-NULL it must be a PyFileObject. In this case there
2304** is no readahead but in stead a flag is used to skip a following
2305** \n on the next read. Also, if the file is open in binary mode
2306** the whole conversion is skipped. Finally, the routine keeps track of
2307** the different types of newlines seen.
2308** Note that we need no error handling: fgets() treats error and eof
2309** identically.
2310*/
2311char *
2312Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2313{
2314 char *p = buf;
2315 int c;
2316 int newlinetypes = 0;
2317 int skipnextlf = 0;
2318 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002319
Jack Jansen7b8c7542002-04-14 20:12:41 +00002320 if (fobj) {
2321 if (!PyFile_Check(fobj)) {
2322 errno = ENXIO; /* What can you do... */
2323 return NULL;
2324 }
2325 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2326 if ( !univ_newline )
2327 return fgets(buf, n, stream);
2328 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2329 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2330 }
2331 FLOCKFILE(stream);
2332 c = 'x'; /* Shut up gcc warning */
2333 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2334 if (skipnextlf ) {
2335 skipnextlf = 0;
2336 if (c == '\n') {
2337 /* Seeing a \n here with skipnextlf true
2338 ** means we saw a \r before.
2339 */
2340 newlinetypes |= NEWLINE_CRLF;
2341 c = GETC(stream);
2342 if (c == EOF) break;
2343 } else {
2344 /*
2345 ** Note that c == EOF also brings us here,
2346 ** so we're okay if the last char in the file
2347 ** is a CR.
2348 */
2349 newlinetypes |= NEWLINE_CR;
2350 }
2351 }
2352 if (c == '\r') {
2353 /* A \r is translated into a \n, and we skip
2354 ** an adjacent \n, if any. We don't set the
2355 ** newlinetypes flag until we've seen the next char.
2356 */
2357 skipnextlf = 1;
2358 c = '\n';
2359 } else if ( c == '\n') {
2360 newlinetypes |= NEWLINE_LF;
2361 }
2362 *p++ = c;
2363 if (c == '\n') break;
2364 }
2365 if ( c == EOF && skipnextlf )
2366 newlinetypes |= NEWLINE_CR;
2367 FUNLOCKFILE(stream);
2368 *p = '\0';
2369 if (fobj) {
2370 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2371 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2372 } else if ( skipnextlf ) {
2373 /* If we have no file object we cannot save the
2374 ** skipnextlf flag. We have to readahead, which
2375 ** will cause a pause if we're reading from an
2376 ** interactive stream, but that is very unlikely
2377 ** unless we're doing something silly like
2378 ** execfile("/dev/tty").
2379 */
2380 c = GETC(stream);
2381 if ( c != '\n' )
2382 ungetc(c, stream);
2383 }
2384 if (p == buf)
2385 return NULL;
2386 return buf;
2387}
2388
2389/*
2390** Py_UniversalNewlineFread is an fread variation that understands
2391** all of \r, \n and \r\n conventions.
2392** The stream should be opened in binary mode.
2393** fobj must be a PyFileObject. In this case there
2394** is no readahead but in stead a flag is used to skip a following
2395** \n on the next read. Also, if the file is open in binary mode
2396** the whole conversion is skipped. Finally, the routine keeps track of
2397** the different types of newlines seen.
2398*/
2399size_t
Tim Peters058b1412002-04-21 07:29:14 +00002400Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002401 FILE *stream, PyObject *fobj)
2402{
Tim Peters058b1412002-04-21 07:29:14 +00002403 char *dst = buf;
2404 PyFileObject *f = (PyFileObject *)fobj;
2405 int newlinetypes, skipnextlf;
2406
2407 assert(buf != NULL);
2408 assert(stream != NULL);
2409
Jack Jansen7b8c7542002-04-14 20:12:41 +00002410 if (!fobj || !PyFile_Check(fobj)) {
2411 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002412 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002413 }
Tim Peters058b1412002-04-21 07:29:14 +00002414 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002415 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002416 newlinetypes = f->f_newlinetypes;
2417 skipnextlf = f->f_skipnextlf;
2418 /* Invariant: n is the number of bytes remaining to be filled
2419 * in the buffer.
2420 */
2421 while (n) {
2422 size_t nread;
2423 int shortread;
2424 char *src = dst;
2425
2426 nread = fread(dst, 1, n, stream);
2427 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002428 if (nread == 0)
2429 break;
2430
Tim Peterse1682a82002-04-21 18:15:20 +00002431 n -= nread; /* assuming 1 byte out for each in; will adjust */
2432 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002433 while (nread--) {
2434 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002435 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002436 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002437 *dst++ = '\n';
2438 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002439 }
2440 else if (skipnextlf && c == '\n') {
2441 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002442 skipnextlf = 0;
2443 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002444 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002445 }
2446 else {
2447 /* Normal char to be stored in buffer. Also
2448 * update the newlinetypes flag if either this
2449 * is an LF or the previous char was a CR.
2450 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002451 if (c == '\n')
2452 newlinetypes |= NEWLINE_LF;
2453 else if (skipnextlf)
2454 newlinetypes |= NEWLINE_CR;
2455 *dst++ = c;
2456 skipnextlf = 0;
2457 }
2458 }
Tim Peters058b1412002-04-21 07:29:14 +00002459 if (shortread) {
2460 /* If this is EOF, update type flags. */
2461 if (skipnextlf && feof(stream))
2462 newlinetypes |= NEWLINE_CR;
2463 break;
2464 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002465 }
Tim Peters058b1412002-04-21 07:29:14 +00002466 f->f_newlinetypes = newlinetypes;
2467 f->f_skipnextlf = skipnextlf;
2468 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002469}
Anthony Baxterac6bd462006-04-13 02:06:09 +00002470
2471#ifdef __cplusplus
2472}
2473#endif