blob: f954e36fa596e1f559ba24229654fbb426dea6d1 [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{
Neal Norwitzb337bb52006-07-17 00:55:45 +0000106 assert(name != NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000107 assert(f != NULL);
108 assert(PyFile_Check(f));
Tim Peters44410012001-09-14 03:26:08 +0000109 assert(f->f_fp == NULL);
110
111 Py_DECREF(f->f_name);
112 Py_DECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000113 Py_DECREF(f->f_encoding);
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000114
Neal Norwitzb337bb52006-07-17 00:55:45 +0000115 Py_INCREF(name);
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000116 f->f_name = name;
117
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000118 f->f_mode = PyString_FromString(mode);
Tim Peters44410012001-09-14 03:26:08 +0000119
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000120 f->f_close = close;
Guido van Rossumeb183da1991-04-04 10:44:06 +0000121 f->f_softspace = 0;
Tim Peters59c9a642001-09-13 05:38:56 +0000122 f->f_binary = strchr(mode,'b') != NULL;
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000123 f->f_buf = NULL;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000124 f->f_univ_newline = (strchr(mode, 'U') != NULL);
125 f->f_newlinetypes = NEWLINE_UNKNOWN;
126 f->f_skipnextlf = 0;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000127 Py_INCREF(Py_None);
128 f->f_encoding = Py_None;
Tim Petersf1827cf2003-09-07 03:30:18 +0000129
Neal Norwitzb337bb52006-07-17 00:55:45 +0000130 if (f->f_mode == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000131 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000132 f->f_fp = fp;
Neil Schemenauered19b882002-03-23 02:06:50 +0000133 f = dircheck(f);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000134 return (PyObject *) f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000135}
136
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000137/* check for known incorrect mode strings - problem is, platforms are
138 free to accept any mode characters they like and are supposed to
139 ignore stuff they don't understand... write or append mode with
Georg Brandl7b90e162006-05-18 07:01:27 +0000140 universal newline support is expressly forbidden by PEP 278.
141 Additionally, remove the 'U' from the mode string as platforms
Kristján Valur Jónssona1392d52007-05-07 19:25:38 +0000142 won't know what it is. Non-zero return signals an exception */
143int
144_PyFile_SanitizeMode(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");
Kristján Valur Jónssona1392d52007-05-07 19:25:38 +0000151 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'");
Kristján Valur Jónssona1392d52007-05-07 19:25:38 +0000162 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);
Kristján Valur Jónssona1392d52007-05-07 19:25:38 +0000177 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
Kristján Valur Jónssona1392d52007-05-07 19:25:38 +0000206 if (_PyFile_SanitizeMode(newmode)) {
Georg Brandl7b90e162006-05-18 07:01:27 +0000207 f = NULL;
208 goto cleanup;
209 }
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000210
Tim Peters8fa45672001-09-13 21:01:29 +0000211 /* rexec.py can't stop a user from getting the file() constructor --
212 all they have to do is get *any* file object f, and then do
213 type(f). Here we prevent them from doing damage with it. */
214 if (PyEval_GetRestricted()) {
215 PyErr_SetString(PyExc_IOError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000216 "file() constructor not accessible in restricted mode");
Georg Brandl7b90e162006-05-18 07:01:27 +0000217 f = NULL;
218 goto cleanup;
Tim Peters8fa45672001-09-13 21:01:29 +0000219 }
Tim Petersa27a1502001-11-09 20:59:14 +0000220 errno = 0;
Skip Montanaro51ffac62004-06-11 04:49:03 +0000221
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000222#ifdef MS_WINDOWS
Skip Montanaro51ffac62004-06-11 04:49:03 +0000223 if (PyUnicode_Check(f->f_name)) {
224 PyObject *wmode;
Georg Brandl7b90e162006-05-18 07:01:27 +0000225 wmode = PyUnicode_DecodeASCII(newmode, strlen(newmode), NULL);
Skip Montanaro51ffac62004-06-11 04:49:03 +0000226 if (f->f_name && wmode) {
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000227 Py_BEGIN_ALLOW_THREADS
Skip Montanaro51ffac62004-06-11 04:49:03 +0000228 /* PyUnicode_AS_UNICODE OK without thread
229 lock as it is a simple dereference. */
230 f->f_fp = _wfopen(PyUnicode_AS_UNICODE(f->f_name),
231 PyUnicode_AS_UNICODE(wmode));
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000232 Py_END_ALLOW_THREADS
233 }
Skip Montanaro51ffac62004-06-11 04:49:03 +0000234 Py_XDECREF(wmode);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000235 }
Skip Montanaro51ffac62004-06-11 04:49:03 +0000236#endif
237 if (NULL == f->f_fp && NULL != name) {
238 Py_BEGIN_ALLOW_THREADS
Georg Brandl7b90e162006-05-18 07:01:27 +0000239 f->f_fp = fopen(name, newmode);
Skip Montanaro51ffac62004-06-11 04:49:03 +0000240 Py_END_ALLOW_THREADS
241 }
242
Guido van Rossuma08095a1991-02-13 23:25:27 +0000243 if (f->f_fp == NULL) {
Kristján Valur Jónsson74c3ea02006-07-03 14:59:05 +0000244#if defined _MSC_VER && (_MSC_VER < 1400 || !defined(__STDC_SECURE_LIB__))
Tim Peters2ea91112002-04-08 04:13:12 +0000245 /* MSVC 6 (Microsoft) leaves errno at 0 for bad mode strings,
246 * across all Windows flavors. When it sets EINVAL varies
247 * across Windows flavors, the exact conditions aren't
248 * documented, and the answer lies in the OS's implementation
249 * of Win32's CreateFile function (whose source is secret).
250 * Seems the best we can do is map EINVAL to ENOENT.
Kristján Valur Jónssonf6083172006-06-12 15:45:12 +0000251 * Starting with Visual Studio .NET 2005, EINVAL is correctly
252 * set by our CRT error handler (set in exceptions.c.)
Tim Peters2ea91112002-04-08 04:13:12 +0000253 */
254 if (errno == 0) /* bad mode string */
255 errno = EINVAL;
256 else if (errno == EINVAL) /* unknown, but not a mode string */
257 errno = ENOENT;
258#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000259 if (errno == EINVAL)
Tim Peters2ea91112002-04-08 04:13:12 +0000260 PyErr_Format(PyExc_IOError, "invalid mode: %s",
Jeremy Hylton41c83212001-11-09 16:17:24 +0000261 mode);
262 else
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000263 PyErr_SetFromErrnoWithFilenameObject(PyExc_IOError, f->f_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000264 f = NULL;
265 }
Tim Peters2ea91112002-04-08 04:13:12 +0000266 if (f != NULL)
Neil Schemenauered19b882002-03-23 02:06:50 +0000267 f = dircheck(f);
Georg Brandl7b90e162006-05-18 07:01:27 +0000268
269cleanup:
270 PyMem_FREE(newmode);
271
Tim Peters59c9a642001-09-13 05:38:56 +0000272 return (PyObject *)f;
273}
274
275PyObject *
276PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
277{
Tim Peters44410012001-09-14 03:26:08 +0000278 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
279 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000280 if (f != NULL) {
Neal Norwitzb337bb52006-07-17 00:55:45 +0000281 PyObject *o_name = PyString_FromString(name);
282 if (o_name == NULL)
283 return NULL;
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000284 if (fill_file_fields(f, fp, o_name, mode, close) == NULL) {
Tim Peters59c9a642001-09-13 05:38:56 +0000285 Py_DECREF(f);
286 f = NULL;
287 }
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000288 Py_DECREF(o_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000289 }
290 return (PyObject *) f;
291}
292
293PyObject *
294PyFile_FromString(char *name, char *mode)
295{
296 extern int fclose(FILE *);
297 PyFileObject *f;
298
299 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
300 if (f != NULL) {
301 if (open_the_file(f, name, mode) == NULL) {
302 Py_DECREF(f);
303 f = NULL;
304 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000305 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000306 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000307}
308
Guido van Rossumb6775db1994-08-01 11:34:53 +0000309void
Fred Drakefd99de62000-07-09 05:02:18 +0000310PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000311{
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000312 PyFileObject *file = (PyFileObject *)f;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000313 if (bufsize >= 0) {
Guido van Rossumb6775db1994-08-01 11:34:53 +0000314 int type;
315 switch (bufsize) {
316 case 0:
317 type = _IONBF;
318 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000319#ifdef HAVE_SETVBUF
Guido van Rossumb6775db1994-08-01 11:34:53 +0000320 case 1:
321 type = _IOLBF;
322 bufsize = BUFSIZ;
323 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000324#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000325 default:
326 type = _IOFBF;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000327#ifndef HAVE_SETVBUF
328 bufsize = BUFSIZ;
329#endif
330 break;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000331 }
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000332 fflush(file->f_fp);
333 if (type == _IONBF) {
334 PyMem_Free(file->f_setbuf);
335 file->f_setbuf = NULL;
336 } else {
Anthony Baxter377be112006-04-11 06:54:30 +0000337 file->f_setbuf = (char *)PyMem_Realloc(file->f_setbuf,
338 bufsize);
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000339 }
340#ifdef HAVE_SETVBUF
341 setvbuf(file->f_fp, file->f_setbuf, type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000342#else /* !HAVE_SETVBUF */
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000343 setbuf(file->f_fp, file->f_setbuf);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000344#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000345 }
346}
347
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000348/* Set the encoding used to output Unicode strings.
349 Returh 1 on success, 0 on failure. */
350
351int
352PyFile_SetEncoding(PyObject *f, const char *enc)
353{
354 PyFileObject *file = (PyFileObject*)f;
355 PyObject *str = PyString_FromString(enc);
Thomas Wouterse4713172007-01-23 13:54:30 +0000356
357 assert(PyFile_Check(f));
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000358 if (!str)
359 return 0;
360 Py_DECREF(file->f_encoding);
361 file->f_encoding = str;
362 return 1;
363}
364
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000365static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000366err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000367{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000368 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000369 return NULL;
370}
371
Thomas Woutersc45251a2006-02-12 11:53:32 +0000372/* Refuse regular file I/O if there's data in the iteration-buffer.
373 * Mixing them would cause data to arrive out of order, as the read*
374 * methods don't use the iteration buffer. */
375static PyObject *
376err_iterbuffered(void)
377{
378 PyErr_SetString(PyExc_ValueError,
379 "Mixing iteration and read methods would lose data");
380 return NULL;
381}
382
Neal Norwitzd8b995f2002-08-06 21:50:54 +0000383static void drop_readahead(PyFileObject *);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000384
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000385/* Methods */
386
387static void
Fred Drakefd99de62000-07-09 05:02:18 +0000388file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000389{
Peter Astrandf8e74b12004-11-07 14:15:28 +0000390 int sts = 0;
Raymond Hettingercb87bc82004-05-31 00:35:52 +0000391 if (f->weakreflist != NULL)
392 PyObject_ClearWeakRefs((PyObject *) f);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000393 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000394 Py_BEGIN_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000395 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000396 Py_END_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000397 if (sts == EOF)
398#ifdef HAVE_STRERROR
399 PySys_WriteStderr("close failed: [Errno %d] %s\n", errno, strerror(errno));
400#else
401 PySys_WriteStderr("close failed: [Errno %d]\n", errno);
402#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000403 }
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000404 PyMem_Free(f->f_setbuf);
Tim Peters44410012001-09-14 03:26:08 +0000405 Py_XDECREF(f->f_name);
406 Py_XDECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000407 Py_XDECREF(f->f_encoding);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000408 drop_readahead(f);
Guido van Rossum9475a232001-10-05 20:51:39 +0000409 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000410}
411
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000412static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000413file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000414{
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000415 if (PyUnicode_Check(f->f_name)) {
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000416#ifdef Py_USING_UNICODE
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000417 PyObject *ret = NULL;
Neal Norwitzfc28e0d2006-07-16 02:32:03 +0000418 PyObject *name = PyUnicode_AsUnicodeEscapeString(f->f_name);
419 const char *name_str = name ? PyString_AsString(name) : "?";
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000420 ret = PyString_FromFormat("<%s file u'%s', mode '%s' at %p>",
421 f->f_fp == NULL ? "closed" : "open",
Neal Norwitzfc28e0d2006-07-16 02:32:03 +0000422 name_str,
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000423 PyString_AsString(f->f_mode),
424 f);
425 Py_XDECREF(name);
426 return ret;
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000427#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000428 } else {
429 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000430 f->f_fp == NULL ? "closed" : "open",
431 PyString_AsString(f->f_name),
432 PyString_AsString(f->f_mode),
433 f);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000434 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000435}
436
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000437static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000438file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000439{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000440 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000441 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000442 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000443 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000444 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000445 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000446 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000447 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000448 f->f_fp = NULL;
449 }
Martin v. Löwis7bbcde72003-09-07 20:42:29 +0000450 PyMem_Free(f->f_setbuf);
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000451 f->f_setbuf = NULL;
Guido van Rossumfebd5511992-03-04 16:39:24 +0000452 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000453 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000454 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000455 return PyInt_FromLong((long)sts);
456 Py_INCREF(Py_None);
457 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000458}
459
Trent Mickf29f47b2000-08-11 19:02:59 +0000460
Guido van Rossumb8552162001-09-05 14:58:11 +0000461/* Our very own off_t-like type, 64-bit if possible */
462#if !defined(HAVE_LARGEFILE_SUPPORT)
463typedef off_t Py_off_t;
464#elif SIZEOF_OFF_T >= 8
465typedef off_t Py_off_t;
466#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000467typedef fpos_t Py_off_t;
468#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000469#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000470#endif
471
472
Trent Mickf29f47b2000-08-11 19:02:59 +0000473/* a portable fseek() function
474 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000475static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000476_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000477{
Guido van Rossumb8552162001-09-05 14:58:11 +0000478#if !defined(HAVE_LARGEFILE_SUPPORT)
479 return fseek(fp, offset, whence);
480#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000481 return fseeko(fp, offset, whence);
482#elif defined(HAVE_FSEEK64)
483 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000484#elif defined(__BEOS__)
485 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000486#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000487 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
488 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000489 fpos_t pos;
490 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000491 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000492#ifdef MS_WINDOWS
493 fflush(fp);
494 if (_lseeki64(fileno(fp), 0, 2) == -1)
495 return -1;
496#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000497 if (fseek(fp, 0, SEEK_END) != 0)
498 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000499#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000500 /* fall through */
501 case SEEK_CUR:
502 if (fgetpos(fp, &pos) != 0)
503 return -1;
504 offset += pos;
505 break;
506 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000507 }
508 return fsetpos(fp, &offset);
509#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000510#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000511#endif
512}
513
514
515/* a portable ftell() function
516 Return -1 on failure with errno set appropriately, current file
517 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000518static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000519_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000520{
Guido van Rossumb8552162001-09-05 14:58:11 +0000521#if !defined(HAVE_LARGEFILE_SUPPORT)
522 return ftell(fp);
523#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
524 return ftello(fp);
525#elif defined(HAVE_FTELL64)
526 return ftell64(fp);
527#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000528 fpos_t pos;
529 if (fgetpos(fp, &pos) != 0)
530 return -1;
531 return pos;
532#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000533#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000534#endif
535}
536
537
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000538static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000539file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000540{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000541 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000542 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000543 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000544 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000545
Guido van Rossumd7297e61992-07-06 14:19:26 +0000546 if (f->f_fp == NULL)
547 return err_closed();
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000548 drop_readahead(f);
Guido van Rossumd7297e61992-07-06 14:19:26 +0000549 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000550 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000551 return NULL;
552#if !defined(HAVE_LARGEFILE_SUPPORT)
553 offset = PyInt_AsLong(offobj);
554#else
555 offset = PyLong_Check(offobj) ?
556 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
557#endif
558 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000559 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000560
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000561 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000562 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000563 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000564 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000565
Guido van Rossumff4949e1992-08-05 19:58:53 +0000566 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000567 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000568 clearerr(f->f_fp);
569 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000570 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000571 f->f_skipnextlf = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000572 Py_INCREF(Py_None);
573 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000574}
575
Trent Mickf29f47b2000-08-11 19:02:59 +0000576
Guido van Rossumd7047b31995-01-02 19:07:15 +0000577#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000578static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000579file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000580{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000581 Py_off_t newsize;
Tim Petersf1827cf2003-09-07 03:30:18 +0000582 PyObject *newsizeobj = NULL;
583 Py_off_t initialpos;
584 int ret;
Tim Peters86821b22001-01-07 21:19:34 +0000585
Guido van Rossumd7047b31995-01-02 19:07:15 +0000586 if (f->f_fp == NULL)
587 return err_closed();
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000588 if (!PyArg_UnpackTuple(args, "truncate", 0, 1, &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000589 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000590
Tim Petersf1827cf2003-09-07 03:30:18 +0000591 /* Get current file position. If the file happens to be open for
592 * update and the last operation was an input operation, C doesn't
593 * define what the later fflush() will do, but we promise truncate()
594 * won't change the current position (and fflush() *does* change it
595 * then at least on Windows). The easiest thing is to capture
596 * current pos now and seek back to it at the end.
597 */
598 Py_BEGIN_ALLOW_THREADS
599 errno = 0;
600 initialpos = _portable_ftell(f->f_fp);
601 Py_END_ALLOW_THREADS
602 if (initialpos == -1)
603 goto onioerror;
604
Tim Petersfb05db22002-03-11 00:24:00 +0000605 /* Set newsize to current postion if newsizeobj NULL, else to the
Tim Petersf1827cf2003-09-07 03:30:18 +0000606 * specified value.
607 */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000608 if (newsizeobj != NULL) {
609#if !defined(HAVE_LARGEFILE_SUPPORT)
610 newsize = PyInt_AsLong(newsizeobj);
611#else
612 newsize = PyLong_Check(newsizeobj) ?
613 PyLong_AsLongLong(newsizeobj) :
614 PyInt_AsLong(newsizeobj);
615#endif
616 if (PyErr_Occurred())
617 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000618 }
Tim Petersf1827cf2003-09-07 03:30:18 +0000619 else /* default to current position */
620 newsize = initialpos;
Tim Petersfb05db22002-03-11 00:24:00 +0000621
Tim Petersf1827cf2003-09-07 03:30:18 +0000622 /* Flush the stream. We're mixing stream-level I/O with lower-level
623 * I/O, and a flush may be necessary to synch both platform views
624 * of the current file state.
625 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000626 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000627 errno = 0;
628 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000629 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000630 if (ret != 0)
631 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000632
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000633#ifdef MS_WINDOWS
Tim Petersfb05db22002-03-11 00:24:00 +0000634 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000635 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000636 {
Tim Petersfb05db22002-03-11 00:24:00 +0000637 HANDLE hFile;
Tim Petersfb05db22002-03-11 00:24:00 +0000638
Tim Petersf1827cf2003-09-07 03:30:18 +0000639 /* Have to move current pos to desired endpoint on Windows. */
640 Py_BEGIN_ALLOW_THREADS
641 errno = 0;
642 ret = _portable_fseek(f->f_fp, newsize, SEEK_SET) != 0;
643 Py_END_ALLOW_THREADS
644 if (ret)
645 goto onioerror;
Tim Petersfb05db22002-03-11 00:24:00 +0000646
Tim Peters8f01b682002-03-12 03:04:44 +0000647 /* Truncate. Note that this may grow the file! */
648 Py_BEGIN_ALLOW_THREADS
649 errno = 0;
650 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
Tim Petersf1827cf2003-09-07 03:30:18 +0000651 ret = hFile == (HANDLE)-1;
652 if (ret == 0) {
653 ret = SetEndOfFile(hFile) == 0;
654 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000655 errno = EACCES;
656 }
657 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000658 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000659 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000660 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000661#else
662 Py_BEGIN_ALLOW_THREADS
663 errno = 0;
664 ret = ftruncate(fileno(f->f_fp), newsize);
665 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000666 if (ret != 0)
667 goto onioerror;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000668#endif /* !MS_WINDOWS */
Tim Peters86821b22001-01-07 21:19:34 +0000669
Tim Petersf1827cf2003-09-07 03:30:18 +0000670 /* Restore original file position. */
671 Py_BEGIN_ALLOW_THREADS
672 errno = 0;
673 ret = _portable_fseek(f->f_fp, initialpos, SEEK_SET) != 0;
674 Py_END_ALLOW_THREADS
675 if (ret)
676 goto onioerror;
677
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000678 Py_INCREF(Py_None);
679 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000680
681onioerror:
682 PyErr_SetFromErrno(PyExc_IOError);
683 clearerr(f->f_fp);
684 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000685}
686#endif /* HAVE_FTRUNCATE */
687
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000688static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000689file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000690{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000691 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000692
Guido van Rossumd7297e61992-07-06 14:19:26 +0000693 if (f->f_fp == NULL)
694 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000695 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000696 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000697 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000698 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000699 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000700 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000701 clearerr(f->f_fp);
702 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000703 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000704 if (f->f_skipnextlf) {
705 int c;
706 c = GETC(f->f_fp);
707 if (c == '\n') {
708 pos++;
709 f->f_skipnextlf = 0;
710 } else if (c != EOF) ungetc(c, f->f_fp);
711 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000712#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000713 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000714#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000715 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000716#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000717}
718
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000719static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000720file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000721{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000722 if (f->f_fp == NULL)
723 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000724 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000725}
726
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000727static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000728file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000729{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000730 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000731
Guido van Rossumd7297e61992-07-06 14:19:26 +0000732 if (f->f_fp == NULL)
733 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000734 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000735 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000736 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000737 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000738 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000739 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000740 clearerr(f->f_fp);
741 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000742 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000743 Py_INCREF(Py_None);
744 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000745}
746
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000747static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000748file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000749{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000750 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000751 if (f->f_fp == NULL)
752 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000753 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000754 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000755 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000756 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000757}
758
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000759
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000760#if BUFSIZ < 8192
761#define SMALLCHUNK 8192
762#else
763#define SMALLCHUNK BUFSIZ
764#endif
765
Guido van Rossum3c259041999-01-14 19:00:14 +0000766#if SIZEOF_INT < 4
767#define BIGCHUNK (512 * 32)
768#else
769#define BIGCHUNK (512 * 1024)
770#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000771
772static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000773new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000774{
775#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000776 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000777 struct stat st;
778 if (fstat(fileno(f->f_fp), &st) == 0) {
779 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000780 /* The following is not a bug: we really need to call lseek()
781 *and* ftell(). The reason is that some stdio libraries
782 mistakenly flush their buffer when ftell() is called and
783 the lseek() call it makes fails, thereby throwing away
784 data that cannot be recovered in any way. To avoid this,
785 we first test lseek(), and only call ftell() if lseek()
786 works. We can't use the lseek() value either, because we
787 need to take the amount of buffered data into account.
788 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000789 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000790 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000791 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000792 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000793 if (pos < 0)
794 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000795 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000796 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000797 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000798 }
799#endif
800 if (currentsize > SMALLCHUNK) {
801 /* Keep doubling until we reach BIGCHUNK;
802 then keep adding BIGCHUNK. */
803 if (currentsize <= BIGCHUNK)
804 return currentsize + currentsize;
805 else
806 return currentsize + BIGCHUNK;
807 }
808 return currentsize + SMALLCHUNK;
809}
810
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000811#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
812#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
813#else
814#ifdef EWOULDBLOCK
815#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
816#else
817#ifdef EAGAIN
818#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
819#else
820#define BLOCKED_ERRNO(x) 0
821#endif
822#endif
823#endif
824
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000825static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000826file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000827{
Guido van Rossum789a1611997-05-10 22:33:55 +0000828 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000829 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000830 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000831
Guido van Rossumd7297e61992-07-06 14:19:26 +0000832 if (f->f_fp == NULL)
833 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000834 /* refuse to mix with f.next() */
835 if (f->f_buf != NULL &&
836 (f->f_bufend - f->f_bufptr) > 0 &&
837 f->f_buf[0] != '\0')
838 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000839 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000840 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000841 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000842 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000843 else
844 buffersize = bytesrequested;
Martin v. Löwis2a190742006-04-13 07:37:25 +0000845 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000846 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000847 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000848 return NULL;
849 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000850 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000851 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000852 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000853 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000854 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000855 Py_BEGIN_ALLOW_THREADS
856 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000857 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000858 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000859 Py_END_ALLOW_THREADS
860 if (chunksize == 0) {
861 if (!ferror(f->f_fp))
862 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000863 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000864 /* When in non-blocking mode, data shouldn't
865 * be discarded if a blocking signal was
866 * received. That will also happen if
867 * chunksize != 0, but bytesread < buffersize. */
868 if (bytesread > 0 && BLOCKED_ERRNO(errno))
869 break;
870 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum6263d541997-05-10 22:07:25 +0000871 Py_DECREF(v);
872 return NULL;
873 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000874 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000875 if (bytesread < buffersize) {
876 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000877 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000878 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000879 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000880 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000881 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000882 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000883 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000884 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000885 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000886 }
887 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000888 if (bytesread != buffersize)
889 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000890 return v;
891}
892
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000893static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000894file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000895{
896 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000897 Py_ssize_t ntodo;
898 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000899
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000900 if (f->f_fp == NULL)
901 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000902 /* refuse to mix with f.next() */
903 if (f->f_buf != NULL &&
904 (f->f_bufend - f->f_bufptr) > 0 &&
905 f->f_buf[0] != '\0')
906 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000907 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000908 return NULL;
909 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000910 while (ntodo > 0) {
911 Py_BEGIN_ALLOW_THREADS
912 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000913 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000914 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000915 Py_END_ALLOW_THREADS
916 if (nnow == 0) {
917 if (!ferror(f->f_fp))
918 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000919 PyErr_SetFromErrno(PyExc_IOError);
920 clearerr(f->f_fp);
921 return NULL;
922 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000923 ndone += nnow;
924 ntodo -= nnow;
925 }
Neal Norwitz47f0ffa2006-08-21 18:44:09 +0000926 return PyInt_FromSsize_t(ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000927}
928
Tim Peters86821b22001-01-07 21:19:34 +0000929/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000930Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000931
932Under MSVC 6:
933
Tim Peters1c733232001-01-08 04:02:07 +0000934+ MS threadsafe getc is very slow (multiple layers of function calls before+
935 after each character, to lock+unlock the stream).
936+ The stream-locking functions are MS-internal -- can't access them from user
937 code.
938+ There's nothing Tim could find in the MS C or platform SDK libraries that
939 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000940+ MS fgets locks/unlocks only once per line; it's the only hook we have.
941
942So we use fgets for speed(!), despite that it's painful.
943
944MS realloc is also slow.
945
Tim Petersf29b64d2001-01-15 06:33:19 +0000946Reports from other platforms on this method vs getc_unlocked (which MS doesn't
947have):
948 Linux a wash
949 Solaris a wash
950 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000951
Tim Petersf29b64d2001-01-15 06:33:19 +0000952CAUTION: The C std isn't clear about this: in those cases where fgets
953writes something into the buffer, can it write into any position beyond the
954required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
955known on which it does; and it would be a strange way to code fgets. Still,
956getline_via_fgets may not work correctly if it does. The std test
957test_bufio.py should fail if platform fgets() routinely writes beyond the
958trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000959**************************************************************************/
960
Tim Petersf29b64d2001-01-15 06:33:19 +0000961/* Use this routine if told to, or by default on non-get_unlocked()
962 * platforms unless told not to. Yikes! Let's spell that out:
963 * On a platform with getc_unlocked():
964 * By default, use getc_unlocked().
965 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
966 * On a platform without getc_unlocked():
967 * By default, use fgets().
968 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
969 */
970#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
971#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000972#endif
973
Tim Petersf29b64d2001-01-15 06:33:19 +0000974#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
975#undef USE_FGETS_IN_GETLINE
976#endif
977
978#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000979static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000980getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000981{
Tim Peters15b83852001-01-08 00:53:12 +0000982/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000983 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
984 * to fill this much of the buffer with a known value in order to figure out
985 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
986 * than "most" lines, we waste time filling unused buffer slots. 100 is
987 * surely adequate for most peoples' email archives, chewing over source code,
988 * etc -- "regular old text files".
989 * MAXBUFSIZE is the maximum line length that lets us get away with the less
990 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
991 * cautions about boosting that. 300 was chosen because the worst real-life
992 * text-crunching job reported on Python-Dev was a mail-log crawler where over
993 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +0000994 */
Tim Peters142297a2001-01-15 10:36:56 +0000995#define INITBUFSIZE 100
996#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +0000997 char* p; /* temp */
998 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000999 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +00001000 char* pvfree; /* address of next free slot */
1001 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +00001002 size_t nfree; /* # of free buffer slots; pvend-pvfree */
1003 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001004 size_t increment; /* amount to increment the buffer */
Armin Rigo4b63c212006-10-04 11:44:06 +00001005 size_t prev_v_size;
Tim Peters86821b22001-01-07 21:19:34 +00001006
Tim Peters15b83852001-01-08 00:53:12 +00001007 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001008 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001009 */
Tim Peters142297a2001-01-15 10:36:56 +00001010 total_v_size = INITBUFSIZE; /* start small and pray */
1011 pvfree = buf;
1012 for (;;) {
1013 Py_BEGIN_ALLOW_THREADS
1014 pvend = buf + total_v_size;
1015 nfree = pvend - pvfree;
1016 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001017 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1018 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001019 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001020
Tim Peters142297a2001-01-15 10:36:56 +00001021 if (p == NULL) {
1022 clearerr(fp);
1023 if (PyErr_CheckSignals())
1024 return NULL;
1025 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001026 return v;
1027 }
Tim Peters142297a2001-01-15 10:36:56 +00001028 /* fgets read *something* */
1029 p = memchr(pvfree, '\n', nfree);
1030 if (p != NULL) {
1031 /* Did the \n come from fgets or from us?
1032 * Since fgets stops at the first \n, and then writes
1033 * \0, if it's from fgets a \0 must be next. But if
1034 * that's so, it could not have come from us, since
1035 * the \n's we filled the buffer with have only more
1036 * \n's to the right.
1037 */
1038 if (p+1 < pvend && *(p+1) == '\0') {
1039 /* It's from fgets: we win! In particular,
1040 * we haven't done any mallocs yet, and can
1041 * build the final result on the first try.
1042 */
1043 ++p; /* include \n from fgets */
1044 }
1045 else {
1046 /* Must be from us: fgets didn't fill the
1047 * buffer and didn't find a newline, so it
1048 * must be the last and newline-free line of
1049 * the file.
1050 */
1051 assert(p > pvfree && *(p-1) == '\0');
1052 --p; /* don't include \0 from fgets */
1053 }
1054 v = PyString_FromStringAndSize(buf, p - buf);
1055 return v;
1056 }
1057 /* yuck: fgets overwrote all the newlines, i.e. the entire
1058 * buffer. So this line isn't over yet, or maybe it is but
1059 * we're exactly at EOF. If we haven't already, try using the
1060 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001061 */
Tim Peters142297a2001-01-15 10:36:56 +00001062 assert(*(pvend-1) == '\0');
1063 if (pvfree == buf) {
1064 pvfree = pvend - 1; /* overwrite trailing null */
1065 total_v_size = MAXBUFSIZE;
1066 }
1067 else
1068 break;
Tim Peters86821b22001-01-07 21:19:34 +00001069 }
Tim Peters142297a2001-01-15 10:36:56 +00001070
1071 /* The stack buffer isn't big enough; malloc a string object and read
1072 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001073 */
Tim Petersddea2082002-03-23 10:03:50 +00001074 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001075 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001076 if (v == NULL)
1077 return v;
1078 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001079 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1080 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001081
1082 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001083 * after setting p one beyond the end of the line. The code here is
1084 * very much like the code above, except reads into v's buffer; see
1085 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001086 */
1087 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001088 Py_BEGIN_ALLOW_THREADS
1089 pvend = BUF(v) + total_v_size;
1090 nfree = pvend - pvfree;
1091 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001092 assert(nfree < INT_MAX);
1093 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001094 Py_END_ALLOW_THREADS
1095
1096 if (p == NULL) {
1097 clearerr(fp);
1098 if (PyErr_CheckSignals()) {
1099 Py_DECREF(v);
1100 return NULL;
1101 }
1102 p = pvfree;
1103 break;
1104 }
Tim Peters86821b22001-01-07 21:19:34 +00001105 p = memchr(pvfree, '\n', nfree);
1106 if (p != NULL) {
1107 if (p+1 < pvend && *(p+1) == '\0') {
1108 /* \n came from fgets */
1109 ++p;
1110 break;
1111 }
1112 /* \n came from us; last line of file, no newline */
1113 assert(p > pvfree && *(p-1) == '\0');
1114 --p;
1115 break;
1116 }
1117 /* expand buffer and try again */
1118 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001119 increment = total_v_size >> 2; /* mild exponential growth */
Armin Rigo4b63c212006-10-04 11:44:06 +00001120 prev_v_size = total_v_size;
Tim Petersddea2082002-03-23 10:03:50 +00001121 total_v_size += increment;
Armin Rigo4b63c212006-10-04 11:44:06 +00001122 /* check for overflow */
1123 if (total_v_size <= prev_v_size ||
1124 total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001125 PyErr_SetString(PyExc_OverflowError,
1126 "line is longer than a Python string can hold");
1127 Py_DECREF(v);
1128 return NULL;
1129 }
1130 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1131 return NULL;
1132 /* overwrite the trailing null byte */
Armin Rigo4b63c212006-10-04 11:44:06 +00001133 pvfree = BUF(v) + (prev_v_size - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001134 }
1135 if (BUF(v) + total_v_size != p)
1136 _PyString_Resize(&v, p - BUF(v));
1137 return v;
1138#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001139#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001140}
Tim Petersf29b64d2001-01-15 06:33:19 +00001141#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001142
Guido van Rossum0bd24411991-04-04 15:21:57 +00001143/* Internal routine to get a line.
1144 Size argument interpretation:
1145 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001146 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001147*/
1148
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001149static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001150get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001151{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001152 FILE *fp = f->f_fp;
1153 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001154 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001155 size_t total_v_size; /* total # of slots in buffer */
1156 size_t used_v_size; /* # used slots in buffer */
1157 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001158 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001159 int newlinetypes = f->f_newlinetypes;
1160 int skipnextlf = f->f_skipnextlf;
1161 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001162
Jack Jansen7b8c7542002-04-14 20:12:41 +00001163#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001164 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001165 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001166#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001167 total_v_size = n > 0 ? n : 100;
1168 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001169 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001170 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001171 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001172 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001173
Guido van Rossumce5ba841991-03-06 13:06:18 +00001174 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001175 Py_BEGIN_ALLOW_THREADS
1176 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001177 if (univ_newline) {
1178 c = 'x'; /* Shut up gcc warning */
1179 while ( buf != end && (c = GETC(fp)) != EOF ) {
1180 if (skipnextlf ) {
1181 skipnextlf = 0;
1182 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001183 /* Seeing a \n here with
1184 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001185 * saw a \r before.
1186 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001187 newlinetypes |= NEWLINE_CRLF;
1188 c = GETC(fp);
1189 if (c == EOF) break;
1190 } else {
1191 newlinetypes |= NEWLINE_CR;
1192 }
1193 }
1194 if (c == '\r') {
1195 skipnextlf = 1;
1196 c = '\n';
1197 } else if ( c == '\n')
1198 newlinetypes |= NEWLINE_LF;
1199 *buf++ = c;
1200 if (c == '\n') break;
1201 }
1202 if ( c == EOF && skipnextlf )
1203 newlinetypes |= NEWLINE_CR;
1204 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001205 while ((c = GETC(fp)) != EOF &&
1206 (*buf++ = c) != '\n' &&
1207 buf != end)
1208 ;
1209 FUNLOCKFILE(fp);
1210 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001211 f->f_newlinetypes = newlinetypes;
1212 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001213 if (c == '\n')
1214 break;
1215 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001216 if (ferror(fp)) {
1217 PyErr_SetFromErrno(PyExc_IOError);
1218 clearerr(fp);
1219 Py_DECREF(v);
1220 return NULL;
1221 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001222 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001223 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001224 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001225 return NULL;
1226 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001227 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001228 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001229 /* Must be because buf == end */
1230 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001231 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001232 used_v_size = total_v_size;
1233 increment = total_v_size >> 2; /* mild exponential growth */
1234 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001235 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001236 PyErr_SetString(PyExc_OverflowError,
1237 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001238 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001239 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001240 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001241 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001242 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001243 buf = BUF(v) + used_v_size;
1244 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001245 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001246
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001247 used_v_size = buf - BUF(v);
1248 if (used_v_size != total_v_size)
1249 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001250 return v;
1251}
1252
Guido van Rossum0bd24411991-04-04 15:21:57 +00001253/* External C interface */
1254
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001255PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001256PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001257{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001258 PyObject *result;
1259
Guido van Rossum3165fe61992-09-25 21:59:05 +00001260 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001261 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001262 return NULL;
1263 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001264
1265 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001266 PyFileObject *fo = (PyFileObject *)f;
1267 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001268 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001269 /* refuse to mix with f.next() */
1270 if (fo->f_buf != NULL &&
1271 (fo->f_bufend - fo->f_bufptr) > 0 &&
1272 fo->f_buf[0] != '\0')
1273 return err_iterbuffered();
1274 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001275 }
1276 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001277 PyObject *reader;
1278 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001279
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001280 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001281 if (reader == NULL)
1282 return NULL;
1283 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001284 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001285 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001286 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001287 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001288 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001289 return NULL;
1290 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001291 result = PyEval_CallObject(reader, args);
1292 Py_DECREF(reader);
1293 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001294 if (result != NULL && !PyString_Check(result) &&
1295 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001296 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001297 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001298 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001299 "object.readline() returned non-string");
1300 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001301 }
1302
1303 if (n < 0 && result != NULL && PyString_Check(result)) {
1304 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001305 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001306 if (len == 0) {
1307 Py_DECREF(result);
1308 result = NULL;
1309 PyErr_SetString(PyExc_EOFError,
1310 "EOF when reading a line");
1311 }
1312 else if (s[len-1] == '\n') {
1313 if (result->ob_refcnt == 1)
1314 _PyString_Resize(&result, len-1);
1315 else {
1316 PyObject *v;
1317 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001318 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001319 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001320 }
1321 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001322 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001323#ifdef Py_USING_UNICODE
1324 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1325 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001326 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001327 if (len == 0) {
1328 Py_DECREF(result);
1329 result = NULL;
1330 PyErr_SetString(PyExc_EOFError,
1331 "EOF when reading a line");
1332 }
1333 else if (s[len-1] == '\n') {
1334 if (result->ob_refcnt == 1)
1335 PyUnicode_Resize(&result, len-1);
1336 else {
1337 PyObject *v;
1338 v = PyUnicode_FromUnicode(s, len-1);
1339 Py_DECREF(result);
1340 result = v;
1341 }
1342 }
1343 }
1344#endif
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001345 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001346}
1347
1348/* Python method */
1349
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001350static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001351file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001352{
Guido van Rossum789a1611997-05-10 22:33:55 +00001353 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001354
Guido van Rossumd7297e61992-07-06 14:19:26 +00001355 if (f->f_fp == NULL)
1356 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001357 /* refuse to mix with f.next() */
1358 if (f->f_buf != NULL &&
1359 (f->f_bufend - f->f_bufptr) > 0 &&
1360 f->f_buf[0] != '\0')
1361 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001362 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001363 return NULL;
1364 if (n == 0)
1365 return PyString_FromString("");
1366 if (n < 0)
1367 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001368 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001369}
1370
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001371static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001372file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001373{
Guido van Rossum789a1611997-05-10 22:33:55 +00001374 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001375 PyObject *list;
1376 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001377 char small_buffer[SMALLCHUNK];
1378 char *buffer = small_buffer;
1379 size_t buffersize = SMALLCHUNK;
1380 PyObject *big_buffer = NULL;
1381 size_t nfilled = 0;
1382 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001383 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001384 char *p, *q, *end;
1385 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001386 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001387
Guido van Rossumd7297e61992-07-06 14:19:26 +00001388 if (f->f_fp == NULL)
1389 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001390 /* refuse to mix with f.next() */
1391 if (f->f_buf != NULL &&
1392 (f->f_bufend - f->f_bufptr) > 0 &&
1393 f->f_buf[0] != '\0')
1394 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001395 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001396 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001397 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001398 return NULL;
1399 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001400 if (shortread)
1401 nread = 0;
1402 else {
1403 Py_BEGIN_ALLOW_THREADS
1404 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001405 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001406 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001407 Py_END_ALLOW_THREADS
1408 shortread = (nread < buffersize-nfilled);
1409 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001410 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001411 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001412 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001413 break;
1414 PyErr_SetFromErrno(PyExc_IOError);
1415 clearerr(f->f_fp);
1416 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001417 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001418 list = NULL;
1419 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001420 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001421 totalread += nread;
Anthony Baxter377be112006-04-11 06:54:30 +00001422 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001423 if (p == NULL) {
1424 /* Need a larger buffer to fit this line */
1425 nfilled += nread;
1426 buffersize *= 2;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001427 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001428 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001429 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001430 goto error;
1431 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001432 if (big_buffer == NULL) {
1433 /* Create the big buffer */
1434 big_buffer = PyString_FromStringAndSize(
1435 NULL, buffersize);
1436 if (big_buffer == NULL)
1437 goto error;
1438 buffer = PyString_AS_STRING(big_buffer);
1439 memcpy(buffer, small_buffer, nfilled);
1440 }
1441 else {
1442 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001443 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1444 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001445 buffer = PyString_AS_STRING(big_buffer);
1446 }
1447 continue;
1448 }
1449 end = buffer+nfilled+nread;
1450 q = buffer;
1451 do {
1452 /* Process complete lines */
1453 p++;
1454 line = PyString_FromStringAndSize(q, p-q);
1455 if (line == NULL)
1456 goto error;
1457 err = PyList_Append(list, line);
1458 Py_DECREF(line);
1459 if (err != 0)
1460 goto error;
1461 q = p;
Anthony Baxter377be112006-04-11 06:54:30 +00001462 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001463 } while (p != NULL);
1464 /* Move the remaining incomplete line to the start */
1465 nfilled = end-q;
1466 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001467 if (sizehint > 0)
1468 if (totalread >= (size_t)sizehint)
1469 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001470 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001471 if (nfilled != 0) {
1472 /* Partial last line */
1473 line = PyString_FromStringAndSize(buffer, nfilled);
1474 if (line == NULL)
1475 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001476 if (sizehint > 0) {
1477 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001478 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001479 if (rest == NULL) {
1480 Py_DECREF(line);
1481 goto error;
1482 }
1483 PyString_Concat(&line, rest);
1484 Py_DECREF(rest);
1485 if (line == NULL)
1486 goto error;
1487 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001488 err = PyList_Append(list, line);
1489 Py_DECREF(line);
1490 if (err != 0)
1491 goto error;
1492 }
1493 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001494 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001495 return list;
1496}
1497
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001498static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001499file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001500{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001501 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001502 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001503 if (f->f_fp == NULL)
1504 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001505 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001506 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001507 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001508 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001509 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001510 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001511 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001512 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001513 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001514 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001515 return NULL;
1516 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001517 Py_INCREF(Py_None);
1518 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001519}
1520
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001521static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001522file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001523{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001524#define CHUNKSIZE 1000
1525 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001526 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001527 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001528 int index, islist;
1529 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001530
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001531 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001532 if (f->f_fp == NULL)
1533 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001534
1535 result = NULL;
1536 list = NULL;
1537 islist = PyList_Check(seq);
1538 if (islist)
1539 it = NULL;
1540 else {
1541 it = PyObject_GetIter(seq);
1542 if (it == NULL) {
1543 PyErr_SetString(PyExc_TypeError,
1544 "writelines() requires an iterable argument");
1545 return NULL;
1546 }
1547 /* From here on, fail by going to error, to reclaim "it". */
1548 list = PyList_New(CHUNKSIZE);
1549 if (list == NULL)
1550 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001551 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001552
1553 /* Strategy: slurp CHUNKSIZE lines into a private list,
1554 checking that they are all strings, then write that list
1555 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001556 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001557 if (islist) {
1558 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001559 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001560 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001561 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001562 j = PyList_GET_SIZE(list);
1563 }
1564 else {
1565 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001566 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001567 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001568 if (PyErr_Occurred())
1569 goto error;
1570 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001571 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001572 PyList_SetItem(list, j, line);
1573 }
1574 }
1575 if (j == 0)
1576 break;
1577
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001578 /* Check that all entries are indeed strings. If not,
1579 apply the same rules as for file.write() and
1580 convert the results to strings. This is slow, but
1581 seems to be the only way since all conversion APIs
1582 could potentially execute Python code. */
1583 for (i = 0; i < j; i++) {
1584 PyObject *v = PyList_GET_ITEM(list, i);
1585 if (!PyString_Check(v)) {
1586 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001587 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001588 PyObject_AsReadBuffer(v,
1589 (const void**)&buffer,
1590 &len)) ||
1591 PyObject_AsCharBuffer(v,
1592 &buffer,
1593 &len))) {
1594 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001595 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001596 goto error;
1597 }
1598 line = PyString_FromStringAndSize(buffer,
1599 len);
1600 if (line == NULL)
1601 goto error;
1602 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001603 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001604 }
1605 }
1606
1607 /* Since we are releasing the global lock, the
1608 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001609 Py_BEGIN_ALLOW_THREADS
1610 f->f_softspace = 0;
1611 errno = 0;
1612 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001613 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001614 len = PyString_GET_SIZE(line);
1615 nwritten = fwrite(PyString_AS_STRING(line),
1616 1, len, f->f_fp);
1617 if (nwritten != len) {
1618 Py_BLOCK_THREADS
1619 PyErr_SetFromErrno(PyExc_IOError);
1620 clearerr(f->f_fp);
1621 goto error;
1622 }
1623 }
1624 Py_END_ALLOW_THREADS
1625
1626 if (j < CHUNKSIZE)
1627 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001628 }
1629
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001630 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001631 result = Py_None;
1632 error:
1633 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001634 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001635 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001636#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001637}
1638
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001639static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001640file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001641{
1642 if (f->f_fp == NULL)
1643 return err_closed();
1644 Py_INCREF(f);
1645 return (PyObject *)f;
1646}
1647
Georg Brandl98b40ad2006-06-08 14:50:21 +00001648static PyObject *
1649file_exit(PyFileObject *f, PyObject *args)
1650{
1651 PyObject *ret = file_close(f);
1652 if (!ret)
1653 /* If error occurred, pass through */
1654 return NULL;
1655 Py_DECREF(ret);
1656 /* We cannot return the result of close since a true
1657 * value will be interpreted as "yes, swallow the
1658 * exception if one was raised inside the with block". */
1659 Py_RETURN_NONE;
1660}
1661
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001662PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001663"readline([size]) -> next line from the file, as a string.\n"
1664"\n"
1665"Retain newline. A non-negative size argument limits the maximum\n"
1666"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001667"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001668
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001669PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001670"read([size]) -> read at most size bytes, returned as a string.\n"
1671"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001672"If the size argument is negative or omitted, read until EOF is reached.\n"
1673"Notice that when in non-blocking mode, less data than what was requested\n"
1674"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001675
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001676PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001677"write(str) -> None. Write string str to file.\n"
1678"\n"
1679"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001680"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001681
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001682PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001683"fileno() -> integer \"file descriptor\".\n"
1684"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001685"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001686
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001687PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001688"seek(offset[, whence]) -> None. Move to new file position.\n"
1689"\n"
1690"Argument offset is a byte count. Optional argument whence defaults to\n"
1691"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1692"(move relative to current position, positive or negative), and 2 (move\n"
1693"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001694"seeking beyond the end of a file). If the file is opened in text mode,\n"
1695"only offsets returned by tell() are legal. Use of other offsets causes\n"
1696"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001697"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001698"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001699
Guido van Rossumd7047b31995-01-02 19:07:15 +00001700#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001701PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001702"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1703"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001704"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001705#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001706
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001707PyDoc_STRVAR(tell_doc,
1708"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001709
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001710PyDoc_STRVAR(readinto_doc,
1711"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001712
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001713PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001714"readlines([size]) -> list of strings, each a line from the file.\n"
1715"\n"
1716"Call readline() repeatedly and return a list of the lines so read.\n"
1717"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001718"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001719
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001720PyDoc_STRVAR(xreadlines_doc,
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001721"xreadlines() -> returns self.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001722"\n"
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001723"For backward compatibility. File objects now include the performance\n"
1724"optimizations previously implemented in the xreadlines module.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001725
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001726PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001727"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001728"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001729"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001730"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001731
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001732PyDoc_STRVAR(flush_doc,
1733"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001734
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001735PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001736"close() -> None or (perhaps) an integer. Close the file.\n"
1737"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001738"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001739"further I/O operations. close() may be called more than once without\n"
1740"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001741"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001742
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001743PyDoc_STRVAR(isatty_doc,
1744"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001745
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001746PyDoc_STRVAR(enter_doc,
1747 "__enter__() -> self.");
1748
Georg Brandl98b40ad2006-06-08 14:50:21 +00001749PyDoc_STRVAR(exit_doc,
1750 "__exit__(*excinfo) -> None. Closes the file.");
1751
Tim Petersefc3a3a2001-09-20 07:55:22 +00001752static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001753 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1754 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1755 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1756 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1757 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001758#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001759 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001760#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001761 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1762 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1763 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001764 {"xreadlines",(PyCFunction)file_self, METH_NOARGS, xreadlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001765 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1766 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1767 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1768 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001769 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Georg Brandl98b40ad2006-06-08 14:50:21 +00001770 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001771 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001772};
1773
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001774#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001775
Guido van Rossum6f799372001-09-20 20:46:19 +00001776static PyMemberDef file_memberlist[] = {
1777 {"softspace", T_INT, OFF(f_softspace), 0,
1778 "flag indicating that a space needs to be printed; used by print"},
1779 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001780 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001781 {"name", T_OBJECT, OFF(f_name), RO,
1782 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001783 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1784 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001785 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001786 {NULL} /* Sentinel */
1787};
1788
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001789static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001790get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001791{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001792 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001793}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001794static PyObject *
1795get_newlines(PyFileObject *f, void *closure)
1796{
1797 switch (f->f_newlinetypes) {
1798 case NEWLINE_UNKNOWN:
1799 Py_INCREF(Py_None);
1800 return Py_None;
1801 case NEWLINE_CR:
1802 return PyString_FromString("\r");
1803 case NEWLINE_LF:
1804 return PyString_FromString("\n");
1805 case NEWLINE_CR|NEWLINE_LF:
1806 return Py_BuildValue("(ss)", "\r", "\n");
1807 case NEWLINE_CRLF:
1808 return PyString_FromString("\r\n");
1809 case NEWLINE_CR|NEWLINE_CRLF:
1810 return Py_BuildValue("(ss)", "\r", "\r\n");
1811 case NEWLINE_LF|NEWLINE_CRLF:
1812 return Py_BuildValue("(ss)", "\n", "\r\n");
1813 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1814 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1815 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001816 PyErr_Format(PyExc_SystemError,
1817 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001818 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001819 return NULL;
1820 }
1821}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001822
Guido van Rossum32d34c82001-09-20 21:45:26 +00001823static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001824 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001825 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001826 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001827 {0},
1828};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001829
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001830static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001831drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001832{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001833 if (f->f_buf != NULL) {
1834 PyMem_Free(f->f_buf);
1835 f->f_buf = NULL;
1836 }
Guido van Rossum65967252001-04-21 13:20:18 +00001837}
1838
Tim Petersf1827cf2003-09-07 03:30:18 +00001839/* Make sure that file has a readahead buffer with at least one byte
1840 (unless at EOF) and no more than bufsize. Returns negative value on
Georg Brandled02eb62006-03-31 20:31:02 +00001841 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001842static int
1843readahead(PyFileObject *f, int bufsize)
1844{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001845 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001846
1847 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001848 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001849 return 0;
1850 else
1851 drop_readahead(f);
1852 }
Anthony Baxter377be112006-04-11 06:54:30 +00001853 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
Georg Brandled02eb62006-03-31 20:31:02 +00001854 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001855 return -1;
1856 }
1857 Py_BEGIN_ALLOW_THREADS
1858 errno = 0;
1859 chunksize = Py_UniversalNewlineFread(
1860 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1861 Py_END_ALLOW_THREADS
1862 if (chunksize == 0) {
1863 if (ferror(f->f_fp)) {
1864 PyErr_SetFromErrno(PyExc_IOError);
1865 clearerr(f->f_fp);
1866 drop_readahead(f);
1867 return -1;
1868 }
1869 }
1870 f->f_bufptr = f->f_buf;
1871 f->f_bufend = f->f_buf + chunksize;
1872 return 0;
1873}
1874
1875/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001876 uninitialized bytes followed by the remainder of the line. Don't be
1877 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001878 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1879
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001880static PyStringObject *
1881readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1882{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001883 PyStringObject* s;
1884 char *bufptr;
1885 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001886 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001887
1888 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001889 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001890 return NULL;
1891
1892 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001893 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001894 return (PyStringObject *)
1895 PyString_FromStringAndSize(NULL, skip);
Anthony Baxter377be112006-04-11 06:54:30 +00001896 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001897 if (bufptr != NULL) {
1898 bufptr++; /* Count the '\n' */
1899 len = bufptr - f->f_bufptr;
1900 s = (PyStringObject *)
1901 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001902 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001903 return NULL;
1904 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1905 f->f_bufptr = bufptr;
1906 if (bufptr == f->f_bufend)
1907 drop_readahead(f);
1908 } else {
1909 bufptr = f->f_bufptr;
1910 buf = f->f_buf;
1911 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001912 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001913 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001914 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001915 if (s == NULL) {
1916 PyMem_Free(buf);
1917 return NULL;
1918 }
1919 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1920 PyMem_Free(buf);
1921 }
1922 return s;
1923}
1924
1925/* A larger buffer size may actually decrease performance. */
1926#define READAHEAD_BUFSIZE 8192
1927
1928static PyObject *
1929file_iternext(PyFileObject *f)
1930{
1931 PyStringObject* l;
1932
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001933 if (f->f_fp == NULL)
1934 return err_closed();
1935
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001936 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1937 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1938 Py_XDECREF(l);
1939 return NULL;
1940 }
1941 return (PyObject *)l;
1942}
1943
1944
Tim Peters59c9a642001-09-13 05:38:56 +00001945static PyObject *
1946file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1947{
Tim Peters44410012001-09-14 03:26:08 +00001948 PyObject *self;
1949 static PyObject *not_yet_string;
1950
1951 assert(type != NULL && type->tp_alloc != NULL);
1952
1953 if (not_yet_string == NULL) {
1954 not_yet_string = PyString_FromString("<uninitialized file>");
1955 if (not_yet_string == NULL)
1956 return NULL;
1957 }
1958
1959 self = type->tp_alloc(type, 0);
1960 if (self != NULL) {
1961 /* Always fill in the name and mode, so that nobody else
1962 needs to special-case NULLs there. */
1963 Py_INCREF(not_yet_string);
1964 ((PyFileObject *)self)->f_name = not_yet_string;
1965 Py_INCREF(not_yet_string);
1966 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001967 Py_INCREF(Py_None);
1968 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001969 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001970 }
1971 return self;
1972}
1973
1974static int
1975file_init(PyObject *self, PyObject *args, PyObject *kwds)
1976{
1977 PyFileObject *foself = (PyFileObject *)self;
1978 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001979 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001980 char *name = NULL;
1981 char *mode = "r";
1982 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001983 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001984
1985 assert(PyFile_Check(self));
1986 if (foself->f_fp != NULL) {
1987 /* Have to close the existing file first. */
1988 PyObject *closeresult = file_close(foself);
1989 if (closeresult == NULL)
1990 return -1;
1991 Py_DECREF(closeresult);
1992 }
Tim Peters59c9a642001-09-13 05:38:56 +00001993
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001994#ifdef Py_WIN_WIDE_FILENAMES
1995 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
1996 PyObject *po;
1997 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
1998 kwlist, &po, &mode, &bufsize)) {
1999 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002000 if (fill_file_fields(foself, NULL, po, mode,
2001 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002002 goto Error;
2003 } else {
2004 /* Drop the argument parsing error as narrow
2005 strings are also valid. */
2006 PyErr_Clear();
2007 }
2008 }
2009#endif
2010
2011 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002012 PyObject *o_name;
2013
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002014 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2015 Py_FileSystemDefaultEncoding,
2016 &name,
2017 &mode, &bufsize))
2018 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002019
2020 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002021 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2022 kwlist, &o_name, &mode,
2023 &bufsize))
Neal Norwitzfe50f8e2006-09-05 04:32:06 +00002024 goto Error;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002025
2026 if (fill_file_fields(foself, NULL, o_name, mode,
2027 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002028 goto Error;
2029 }
Tim Peters44410012001-09-14 03:26:08 +00002030 if (open_the_file(foself, name, mode) == NULL)
2031 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002032 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002033 PyFile_SetBufSize(self, bufsize);
2034 goto Done;
2035
2036Error:
2037 ret = -1;
2038 /* fall through */
2039Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002040 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002041 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002042}
2043
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002044PyDoc_VAR(file_doc) =
2045PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002046"file(name[, mode[, buffering]]) -> file object\n"
2047"\n"
2048"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2049"writing or appending. The file will be created if it doesn't exist\n"
2050"when opened for writing or appending; it will be truncated when\n"
2051"opened for writing. Add a 'b' to the mode for binary files.\n"
2052"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2053"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002054"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002055)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002056PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002057"Add a 'U' to mode to open the file for input with universal newline\n"
2058"support. Any line ending in the input file will be seen as a '\\n'\n"
2059"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2060"the value for this attribute is one of None (no newline read yet),\n"
2061"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2062"\n"
2063"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002064);
Tim Peters59c9a642001-09-13 05:38:56 +00002065
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002066PyTypeObject PyFile_Type = {
2067 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002068 0,
2069 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002070 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002071 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002072 (destructor)file_dealloc, /* tp_dealloc */
2073 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002074 0, /* tp_getattr */
2075 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002076 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002077 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002078 0, /* tp_as_number */
2079 0, /* tp_as_sequence */
2080 0, /* tp_as_mapping */
2081 0, /* tp_hash */
2082 0, /* tp_call */
2083 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002084 PyObject_GenericGetAttr, /* tp_getattro */
Tim Peters015dd822003-05-04 04:16:52 +00002085 /* softspace is writable: we must supply tp_setattro */
2086 PyObject_GenericSetAttr, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002087 0, /* tp_as_buffer */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002088 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002089 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002090 0, /* tp_traverse */
2091 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002092 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002093 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002094 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002095 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002096 file_methods, /* tp_methods */
2097 file_memberlist, /* tp_members */
2098 file_getsetlist, /* tp_getset */
2099 0, /* tp_base */
2100 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002101 0, /* tp_descr_get */
2102 0, /* tp_descr_set */
2103 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002104 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002105 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002106 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002107 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002108};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002109
2110/* Interface for the 'soft space' between print items. */
2111
2112int
Fred Drakefd99de62000-07-09 05:02:18 +00002113PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00002114{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002115 long oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002116 if (f == NULL) {
2117 /* Do nothing */
2118 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002119 else if (PyFile_Check(f)) {
2120 oldflag = ((PyFileObject *)f)->f_softspace;
2121 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002122 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00002123 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002124 PyObject *v;
2125 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002126 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002127 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002128 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002129 if (PyInt_Check(v))
2130 oldflag = PyInt_AsLong(v);
Martin v. Löwis18e16552006-02-15 17:27:45 +00002131 assert(oldflag < INT_MAX);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002132 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002133 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002134 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002135 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002136 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002137 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002138 if (PyObject_SetAttrString(f, "softspace", v) != 0)
2139 PyErr_Clear();
2140 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002141 }
2142 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002143 return (int)oldflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002144}
Guido van Rossum3165fe61992-09-25 21:59:05 +00002145
2146/* Interfaces to write objects/strings to file-like objects */
2147
2148int
Fred Drakefd99de62000-07-09 05:02:18 +00002149PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002150{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002151 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002152 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002153 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002154 return -1;
2155 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002156 else if (PyFile_Check(f)) {
2157 FILE *fp = PyFile_AsFile(f);
Fred Drake086a0f72004-03-19 15:22:36 +00002158#ifdef Py_USING_UNICODE
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002159 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2160 int result;
Fred Drake086a0f72004-03-19 15:22:36 +00002161#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002162 if (fp == NULL) {
2163 err_closed();
2164 return -1;
2165 }
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002166#ifdef Py_USING_UNICODE
Tim Petersf1827cf2003-09-07 03:30:18 +00002167 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002168 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002169 char *cenc = PyString_AS_STRING(enc);
2170 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2171 if (value == NULL)
2172 return -1;
2173 } else {
2174 value = v;
2175 Py_INCREF(value);
2176 }
2177 result = PyObject_Print(value, fp, flags);
2178 Py_DECREF(value);
2179 return result;
2180#else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002181 return PyObject_Print(v, fp, flags);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002182#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002183 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002184 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002185 if (writer == NULL)
2186 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002187 if (flags & Py_PRINT_RAW) {
2188 if (PyUnicode_Check(v)) {
2189 value = v;
2190 Py_INCREF(value);
2191 } else
2192 value = PyObject_Str(v);
2193 }
2194 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002195 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002196 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002197 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002198 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002199 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002200 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002201 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002202 Py_DECREF(value);
2203 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002204 return -1;
2205 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002206 result = PyEval_CallObject(writer, args);
2207 Py_DECREF(args);
2208 Py_DECREF(value);
2209 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002210 if (result == NULL)
2211 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002212 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002213 return 0;
2214}
2215
Guido van Rossum27a60b11997-05-22 22:25:11 +00002216int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002217PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002218{
2219 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002220 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002221 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002222 PyErr_SetString(PyExc_SystemError,
2223 "null file for PyFile_WriteString");
2224 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002225 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002226 else if (PyFile_Check(f)) {
2227 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002228 if (fp == NULL) {
2229 err_closed();
2230 return -1;
2231 }
2232 fputs(s, fp);
2233 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002234 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002235 else if (!PyErr_Occurred()) {
2236 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002237 int err;
2238 if (v == NULL)
2239 return -1;
2240 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2241 Py_DECREF(v);
2242 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002243 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002244 else
2245 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002246}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002247
2248/* Try to get a file-descriptor from a Python object. If the object
2249 is an integer or long integer, its value is returned. If not, the
2250 object's fileno() method is called if it exists; the method must return
2251 an integer or long integer, which is returned as the file descriptor value.
2252 -1 is returned on failure.
2253*/
2254
2255int PyObject_AsFileDescriptor(PyObject *o)
2256{
2257 int fd;
2258 PyObject *meth;
2259
2260 if (PyInt_Check(o)) {
2261 fd = PyInt_AsLong(o);
2262 }
2263 else if (PyLong_Check(o)) {
2264 fd = PyLong_AsLong(o);
2265 }
2266 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2267 {
2268 PyObject *fno = PyEval_CallObject(meth, NULL);
2269 Py_DECREF(meth);
2270 if (fno == NULL)
2271 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002272
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002273 if (PyInt_Check(fno)) {
2274 fd = PyInt_AsLong(fno);
2275 Py_DECREF(fno);
2276 }
2277 else if (PyLong_Check(fno)) {
2278 fd = PyLong_AsLong(fno);
2279 Py_DECREF(fno);
2280 }
2281 else {
2282 PyErr_SetString(PyExc_TypeError,
2283 "fileno() returned a non-integer");
2284 Py_DECREF(fno);
2285 return -1;
2286 }
2287 }
2288 else {
2289 PyErr_SetString(PyExc_TypeError,
2290 "argument must be an int, or have a fileno() method.");
2291 return -1;
2292 }
2293
2294 if (fd < 0) {
2295 PyErr_Format(PyExc_ValueError,
2296 "file descriptor cannot be a negative integer (%i)",
2297 fd);
2298 return -1;
2299 }
2300 return fd;
2301}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002302
Jack Jansen7b8c7542002-04-14 20:12:41 +00002303/* From here on we need access to the real fgets and fread */
2304#undef fgets
2305#undef fread
2306
2307/*
2308** Py_UniversalNewlineFgets is an fgets variation that understands
2309** all of \r, \n and \r\n conventions.
2310** The stream should be opened in binary mode.
2311** If fobj is NULL the routine always does newline conversion, and
2312** it may peek one char ahead to gobble the second char in \r\n.
2313** If fobj is non-NULL it must be a PyFileObject. In this case there
2314** is no readahead but in stead a flag is used to skip a following
2315** \n on the next read. Also, if the file is open in binary mode
2316** the whole conversion is skipped. Finally, the routine keeps track of
2317** the different types of newlines seen.
2318** Note that we need no error handling: fgets() treats error and eof
2319** identically.
2320*/
2321char *
2322Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2323{
2324 char *p = buf;
2325 int c;
2326 int newlinetypes = 0;
2327 int skipnextlf = 0;
2328 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002329
Jack Jansen7b8c7542002-04-14 20:12:41 +00002330 if (fobj) {
2331 if (!PyFile_Check(fobj)) {
2332 errno = ENXIO; /* What can you do... */
2333 return NULL;
2334 }
2335 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2336 if ( !univ_newline )
2337 return fgets(buf, n, stream);
2338 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2339 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2340 }
2341 FLOCKFILE(stream);
2342 c = 'x'; /* Shut up gcc warning */
2343 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2344 if (skipnextlf ) {
2345 skipnextlf = 0;
2346 if (c == '\n') {
2347 /* Seeing a \n here with skipnextlf true
2348 ** means we saw a \r before.
2349 */
2350 newlinetypes |= NEWLINE_CRLF;
2351 c = GETC(stream);
2352 if (c == EOF) break;
2353 } else {
2354 /*
2355 ** Note that c == EOF also brings us here,
2356 ** so we're okay if the last char in the file
2357 ** is a CR.
2358 */
2359 newlinetypes |= NEWLINE_CR;
2360 }
2361 }
2362 if (c == '\r') {
2363 /* A \r is translated into a \n, and we skip
2364 ** an adjacent \n, if any. We don't set the
2365 ** newlinetypes flag until we've seen the next char.
2366 */
2367 skipnextlf = 1;
2368 c = '\n';
2369 } else if ( c == '\n') {
2370 newlinetypes |= NEWLINE_LF;
2371 }
2372 *p++ = c;
2373 if (c == '\n') break;
2374 }
2375 if ( c == EOF && skipnextlf )
2376 newlinetypes |= NEWLINE_CR;
2377 FUNLOCKFILE(stream);
2378 *p = '\0';
2379 if (fobj) {
2380 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2381 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2382 } else if ( skipnextlf ) {
2383 /* If we have no file object we cannot save the
2384 ** skipnextlf flag. We have to readahead, which
2385 ** will cause a pause if we're reading from an
2386 ** interactive stream, but that is very unlikely
2387 ** unless we're doing something silly like
2388 ** execfile("/dev/tty").
2389 */
2390 c = GETC(stream);
2391 if ( c != '\n' )
2392 ungetc(c, stream);
2393 }
2394 if (p == buf)
2395 return NULL;
2396 return buf;
2397}
2398
2399/*
2400** Py_UniversalNewlineFread is an fread variation that understands
2401** all of \r, \n and \r\n conventions.
2402** The stream should be opened in binary mode.
2403** fobj must be a PyFileObject. In this case there
2404** is no readahead but in stead a flag is used to skip a following
2405** \n on the next read. Also, if the file is open in binary mode
2406** the whole conversion is skipped. Finally, the routine keeps track of
2407** the different types of newlines seen.
2408*/
2409size_t
Tim Peters058b1412002-04-21 07:29:14 +00002410Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002411 FILE *stream, PyObject *fobj)
2412{
Tim Peters058b1412002-04-21 07:29:14 +00002413 char *dst = buf;
2414 PyFileObject *f = (PyFileObject *)fobj;
2415 int newlinetypes, skipnextlf;
2416
2417 assert(buf != NULL);
2418 assert(stream != NULL);
2419
Jack Jansen7b8c7542002-04-14 20:12:41 +00002420 if (!fobj || !PyFile_Check(fobj)) {
2421 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002422 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002423 }
Tim Peters058b1412002-04-21 07:29:14 +00002424 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002425 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002426 newlinetypes = f->f_newlinetypes;
2427 skipnextlf = f->f_skipnextlf;
2428 /* Invariant: n is the number of bytes remaining to be filled
2429 * in the buffer.
2430 */
2431 while (n) {
2432 size_t nread;
2433 int shortread;
2434 char *src = dst;
2435
2436 nread = fread(dst, 1, n, stream);
2437 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002438 if (nread == 0)
2439 break;
2440
Tim Peterse1682a82002-04-21 18:15:20 +00002441 n -= nread; /* assuming 1 byte out for each in; will adjust */
2442 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002443 while (nread--) {
2444 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002445 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002446 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002447 *dst++ = '\n';
2448 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002449 }
2450 else if (skipnextlf && c == '\n') {
2451 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002452 skipnextlf = 0;
2453 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002454 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002455 }
2456 else {
2457 /* Normal char to be stored in buffer. Also
2458 * update the newlinetypes flag if either this
2459 * is an LF or the previous char was a CR.
2460 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002461 if (c == '\n')
2462 newlinetypes |= NEWLINE_LF;
2463 else if (skipnextlf)
2464 newlinetypes |= NEWLINE_CR;
2465 *dst++ = c;
2466 skipnextlf = 0;
2467 }
2468 }
Tim Peters058b1412002-04-21 07:29:14 +00002469 if (shortread) {
2470 /* If this is EOF, update type flags. */
2471 if (skipnextlf && feof(stream))
2472 newlinetypes |= NEWLINE_CR;
2473 break;
2474 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002475 }
Tim Peters058b1412002-04-21 07:29:14 +00002476 f->f_newlinetypes = newlinetypes;
2477 f->f_skipnextlf = skipnextlf;
2478 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002479}
Anthony Baxterac6bd462006-04-13 02:06:09 +00002480
2481#ifdef __cplusplus
2482}
2483#endif