blob: 5b76b0d0cc6673333cc4be5937ba71af791f870f [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
Gregory P. Smith9e6649f2008-05-03 07:12:23 +0000259 /* EINVAL is returned when an invalid filename or
260 * an invalid mode is supplied. */
Jeremy Hylton41c83212001-11-09 16:17:24 +0000261 if (errno == EINVAL)
Gregory P. Smith9e6649f2008-05-03 07:12:23 +0000262 PyErr_Format(PyExc_IOError,
263 "invalid filename: %s or mode: %s",
264 name, mode);
Jeremy Hylton41c83212001-11-09 16:17:24 +0000265 else
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000266 PyErr_SetFromErrnoWithFilenameObject(PyExc_IOError, f->f_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000267 f = NULL;
268 }
Tim Peters2ea91112002-04-08 04:13:12 +0000269 if (f != NULL)
Neil Schemenauered19b882002-03-23 02:06:50 +0000270 f = dircheck(f);
Georg Brandl7b90e162006-05-18 07:01:27 +0000271
272cleanup:
273 PyMem_FREE(newmode);
274
Tim Peters59c9a642001-09-13 05:38:56 +0000275 return (PyObject *)f;
276}
277
278PyObject *
279PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
280{
Tim Peters44410012001-09-14 03:26:08 +0000281 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
282 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000283 if (f != NULL) {
Neal Norwitzb337bb52006-07-17 00:55:45 +0000284 PyObject *o_name = PyString_FromString(name);
285 if (o_name == NULL)
286 return NULL;
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000287 if (fill_file_fields(f, fp, o_name, mode, close) == NULL) {
Tim Peters59c9a642001-09-13 05:38:56 +0000288 Py_DECREF(f);
289 f = NULL;
290 }
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000291 Py_DECREF(o_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000292 }
293 return (PyObject *) f;
294}
295
296PyObject *
297PyFile_FromString(char *name, char *mode)
298{
299 extern int fclose(FILE *);
300 PyFileObject *f;
301
302 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
303 if (f != NULL) {
304 if (open_the_file(f, name, mode) == NULL) {
305 Py_DECREF(f);
306 f = NULL;
307 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000308 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000309 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000310}
311
Guido van Rossumb6775db1994-08-01 11:34:53 +0000312void
Fred Drakefd99de62000-07-09 05:02:18 +0000313PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000314{
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000315 PyFileObject *file = (PyFileObject *)f;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000316 if (bufsize >= 0) {
Guido van Rossumb6775db1994-08-01 11:34:53 +0000317 int type;
318 switch (bufsize) {
319 case 0:
320 type = _IONBF;
321 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000322#ifdef HAVE_SETVBUF
Guido van Rossumb6775db1994-08-01 11:34:53 +0000323 case 1:
324 type = _IOLBF;
325 bufsize = BUFSIZ;
326 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000327#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000328 default:
329 type = _IOFBF;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000330#ifndef HAVE_SETVBUF
331 bufsize = BUFSIZ;
332#endif
333 break;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000334 }
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000335 fflush(file->f_fp);
336 if (type == _IONBF) {
337 PyMem_Free(file->f_setbuf);
338 file->f_setbuf = NULL;
339 } else {
Anthony Baxter377be112006-04-11 06:54:30 +0000340 file->f_setbuf = (char *)PyMem_Realloc(file->f_setbuf,
341 bufsize);
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000342 }
343#ifdef HAVE_SETVBUF
344 setvbuf(file->f_fp, file->f_setbuf, type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000345#else /* !HAVE_SETVBUF */
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000346 setbuf(file->f_fp, file->f_setbuf);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000347#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000348 }
349}
350
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000351/* Set the encoding used to output Unicode strings.
352 Returh 1 on success, 0 on failure. */
353
354int
355PyFile_SetEncoding(PyObject *f, const char *enc)
356{
357 PyFileObject *file = (PyFileObject*)f;
358 PyObject *str = PyString_FromString(enc);
Thomas Wouterse4713172007-01-23 13:54:30 +0000359
360 assert(PyFile_Check(f));
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000361 if (!str)
362 return 0;
363 Py_DECREF(file->f_encoding);
364 file->f_encoding = str;
365 return 1;
366}
367
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000368static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000369err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000370{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000371 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000372 return NULL;
373}
374
Thomas Woutersc45251a2006-02-12 11:53:32 +0000375/* Refuse regular file I/O if there's data in the iteration-buffer.
376 * Mixing them would cause data to arrive out of order, as the read*
377 * methods don't use the iteration buffer. */
378static PyObject *
379err_iterbuffered(void)
380{
381 PyErr_SetString(PyExc_ValueError,
382 "Mixing iteration and read methods would lose data");
383 return NULL;
384}
385
Neal Norwitzd8b995f2002-08-06 21:50:54 +0000386static void drop_readahead(PyFileObject *);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000387
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000388/* Methods */
389
390static void
Fred Drakefd99de62000-07-09 05:02:18 +0000391file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000392{
Peter Astrandf8e74b12004-11-07 14:15:28 +0000393 int sts = 0;
Raymond Hettingercb87bc82004-05-31 00:35:52 +0000394 if (f->weakreflist != NULL)
395 PyObject_ClearWeakRefs((PyObject *) f);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000396 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000397 Py_BEGIN_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000398 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000399 Py_END_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000400 if (sts == EOF)
401#ifdef HAVE_STRERROR
402 PySys_WriteStderr("close failed: [Errno %d] %s\n", errno, strerror(errno));
403#else
404 PySys_WriteStderr("close failed: [Errno %d]\n", errno);
405#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000406 }
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000407 PyMem_Free(f->f_setbuf);
Tim Peters44410012001-09-14 03:26:08 +0000408 Py_XDECREF(f->f_name);
409 Py_XDECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000410 Py_XDECREF(f->f_encoding);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000411 drop_readahead(f);
Guido van Rossum9475a232001-10-05 20:51:39 +0000412 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000413}
414
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000415static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000416file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000417{
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000418 if (PyUnicode_Check(f->f_name)) {
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000419#ifdef Py_USING_UNICODE
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000420 PyObject *ret = NULL;
Neal Norwitzfc28e0d2006-07-16 02:32:03 +0000421 PyObject *name = PyUnicode_AsUnicodeEscapeString(f->f_name);
422 const char *name_str = name ? PyString_AsString(name) : "?";
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000423 ret = PyString_FromFormat("<%s file u'%s', mode '%s' at %p>",
424 f->f_fp == NULL ? "closed" : "open",
Neal Norwitzfc28e0d2006-07-16 02:32:03 +0000425 name_str,
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000426 PyString_AsString(f->f_mode),
427 f);
428 Py_XDECREF(name);
429 return ret;
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000430#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000431 } else {
432 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000433 f->f_fp == NULL ? "closed" : "open",
434 PyString_AsString(f->f_name),
435 PyString_AsString(f->f_mode),
436 f);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000437 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000438}
439
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000440static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000441file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000442{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000443 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000444 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000445 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000446 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000447 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000448 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000449 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000450 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000451 f->f_fp = NULL;
452 }
Martin v. Löwis7bbcde72003-09-07 20:42:29 +0000453 PyMem_Free(f->f_setbuf);
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000454 f->f_setbuf = NULL;
Guido van Rossumfebd5511992-03-04 16:39:24 +0000455 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000456 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000457 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000458 return PyInt_FromLong((long)sts);
459 Py_INCREF(Py_None);
460 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000461}
462
Trent Mickf29f47b2000-08-11 19:02:59 +0000463
Guido van Rossumb8552162001-09-05 14:58:11 +0000464/* Our very own off_t-like type, 64-bit if possible */
465#if !defined(HAVE_LARGEFILE_SUPPORT)
466typedef off_t Py_off_t;
467#elif SIZEOF_OFF_T >= 8
468typedef off_t Py_off_t;
469#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000470typedef fpos_t Py_off_t;
471#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000472#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000473#endif
474
475
Trent Mickf29f47b2000-08-11 19:02:59 +0000476/* a portable fseek() function
477 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000478static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000479_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000480{
Guido van Rossumb8552162001-09-05 14:58:11 +0000481#if !defined(HAVE_LARGEFILE_SUPPORT)
482 return fseek(fp, offset, whence);
483#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000484 return fseeko(fp, offset, whence);
485#elif defined(HAVE_FSEEK64)
486 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000487#elif defined(__BEOS__)
488 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000489#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000490 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
491 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000492 fpos_t pos;
493 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000494 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000495#ifdef MS_WINDOWS
496 fflush(fp);
497 if (_lseeki64(fileno(fp), 0, 2) == -1)
498 return -1;
499#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000500 if (fseek(fp, 0, SEEK_END) != 0)
501 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000502#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000503 /* fall through */
504 case SEEK_CUR:
505 if (fgetpos(fp, &pos) != 0)
506 return -1;
507 offset += pos;
508 break;
509 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000510 }
511 return fsetpos(fp, &offset);
512#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000513#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000514#endif
515}
516
517
518/* a portable ftell() function
519 Return -1 on failure with errno set appropriately, current file
520 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000521static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000522_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000523{
Guido van Rossumb8552162001-09-05 14:58:11 +0000524#if !defined(HAVE_LARGEFILE_SUPPORT)
525 return ftell(fp);
526#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
527 return ftello(fp);
528#elif defined(HAVE_FTELL64)
529 return ftell64(fp);
530#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000531 fpos_t pos;
532 if (fgetpos(fp, &pos) != 0)
533 return -1;
534 return pos;
535#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000536#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000537#endif
538}
539
540
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000541static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000542file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000543{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000544 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000545 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000546 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000547 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000548
Guido van Rossumd7297e61992-07-06 14:19:26 +0000549 if (f->f_fp == NULL)
550 return err_closed();
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000551 drop_readahead(f);
Guido van Rossumd7297e61992-07-06 14:19:26 +0000552 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000553 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000554 return NULL;
555#if !defined(HAVE_LARGEFILE_SUPPORT)
556 offset = PyInt_AsLong(offobj);
557#else
558 offset = PyLong_Check(offobj) ?
559 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
560#endif
561 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000562 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000563
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000564 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000565 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000566 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000567 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000568
Guido van Rossumff4949e1992-08-05 19:58:53 +0000569 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000570 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000571 clearerr(f->f_fp);
572 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000573 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000574 f->f_skipnextlf = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000575 Py_INCREF(Py_None);
576 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000577}
578
Trent Mickf29f47b2000-08-11 19:02:59 +0000579
Guido van Rossumd7047b31995-01-02 19:07:15 +0000580#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000581static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000582file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000583{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000584 Py_off_t newsize;
Tim Petersf1827cf2003-09-07 03:30:18 +0000585 PyObject *newsizeobj = NULL;
586 Py_off_t initialpos;
587 int ret;
Tim Peters86821b22001-01-07 21:19:34 +0000588
Guido van Rossumd7047b31995-01-02 19:07:15 +0000589 if (f->f_fp == NULL)
590 return err_closed();
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000591 if (!PyArg_UnpackTuple(args, "truncate", 0, 1, &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000592 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000593
Tim Petersf1827cf2003-09-07 03:30:18 +0000594 /* Get current file position. If the file happens to be open for
595 * update and the last operation was an input operation, C doesn't
596 * define what the later fflush() will do, but we promise truncate()
597 * won't change the current position (and fflush() *does* change it
598 * then at least on Windows). The easiest thing is to capture
599 * current pos now and seek back to it at the end.
600 */
601 Py_BEGIN_ALLOW_THREADS
602 errno = 0;
603 initialpos = _portable_ftell(f->f_fp);
604 Py_END_ALLOW_THREADS
605 if (initialpos == -1)
606 goto onioerror;
607
Tim Petersfb05db22002-03-11 00:24:00 +0000608 /* Set newsize to current postion if newsizeobj NULL, else to the
Tim Petersf1827cf2003-09-07 03:30:18 +0000609 * specified value.
610 */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000611 if (newsizeobj != NULL) {
612#if !defined(HAVE_LARGEFILE_SUPPORT)
613 newsize = PyInt_AsLong(newsizeobj);
614#else
615 newsize = PyLong_Check(newsizeobj) ?
616 PyLong_AsLongLong(newsizeobj) :
617 PyInt_AsLong(newsizeobj);
618#endif
619 if (PyErr_Occurred())
620 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000621 }
Tim Petersf1827cf2003-09-07 03:30:18 +0000622 else /* default to current position */
623 newsize = initialpos;
Tim Petersfb05db22002-03-11 00:24:00 +0000624
Tim Petersf1827cf2003-09-07 03:30:18 +0000625 /* Flush the stream. We're mixing stream-level I/O with lower-level
626 * I/O, and a flush may be necessary to synch both platform views
627 * of the current file state.
628 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000629 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000630 errno = 0;
631 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000632 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000633 if (ret != 0)
634 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000635
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000636#ifdef MS_WINDOWS
Tim Petersfb05db22002-03-11 00:24:00 +0000637 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000638 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000639 {
Tim Petersfb05db22002-03-11 00:24:00 +0000640 HANDLE hFile;
Tim Petersfb05db22002-03-11 00:24:00 +0000641
Tim Petersf1827cf2003-09-07 03:30:18 +0000642 /* Have to move current pos to desired endpoint on Windows. */
643 Py_BEGIN_ALLOW_THREADS
644 errno = 0;
645 ret = _portable_fseek(f->f_fp, newsize, SEEK_SET) != 0;
646 Py_END_ALLOW_THREADS
647 if (ret)
648 goto onioerror;
Tim Petersfb05db22002-03-11 00:24:00 +0000649
Tim Peters8f01b682002-03-12 03:04:44 +0000650 /* Truncate. Note that this may grow the file! */
651 Py_BEGIN_ALLOW_THREADS
652 errno = 0;
653 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
Tim Petersf1827cf2003-09-07 03:30:18 +0000654 ret = hFile == (HANDLE)-1;
655 if (ret == 0) {
656 ret = SetEndOfFile(hFile) == 0;
657 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000658 errno = EACCES;
659 }
660 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000661 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000662 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000663 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000664#else
665 Py_BEGIN_ALLOW_THREADS
666 errno = 0;
667 ret = ftruncate(fileno(f->f_fp), newsize);
668 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000669 if (ret != 0)
670 goto onioerror;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000671#endif /* !MS_WINDOWS */
Tim Peters86821b22001-01-07 21:19:34 +0000672
Tim Petersf1827cf2003-09-07 03:30:18 +0000673 /* Restore original file position. */
674 Py_BEGIN_ALLOW_THREADS
675 errno = 0;
676 ret = _portable_fseek(f->f_fp, initialpos, SEEK_SET) != 0;
677 Py_END_ALLOW_THREADS
678 if (ret)
679 goto onioerror;
680
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000681 Py_INCREF(Py_None);
682 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000683
684onioerror:
685 PyErr_SetFromErrno(PyExc_IOError);
686 clearerr(f->f_fp);
687 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000688}
689#endif /* HAVE_FTRUNCATE */
690
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000691static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000692file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000693{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000694 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000695
Guido van Rossumd7297e61992-07-06 14:19:26 +0000696 if (f->f_fp == NULL)
697 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000698 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000699 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000700 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000701 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000702 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000703 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000704 clearerr(f->f_fp);
705 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000706 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000707 if (f->f_skipnextlf) {
708 int c;
709 c = GETC(f->f_fp);
710 if (c == '\n') {
711 pos++;
712 f->f_skipnextlf = 0;
713 } else if (c != EOF) ungetc(c, f->f_fp);
714 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000715#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000716 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000717#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000718 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000719#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000720}
721
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000722static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000723file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000724{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000725 if (f->f_fp == NULL)
726 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000727 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000728}
729
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000730static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000731file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000732{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000733 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000734
Guido van Rossumd7297e61992-07-06 14:19:26 +0000735 if (f->f_fp == NULL)
736 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000737 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000738 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000739 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000740 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000741 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000742 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000743 clearerr(f->f_fp);
744 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000745 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000746 Py_INCREF(Py_None);
747 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000748}
749
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000750static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000751file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000752{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000753 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000754 if (f->f_fp == NULL)
755 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000756 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000757 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000758 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000759 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000760}
761
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000762
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000763#if BUFSIZ < 8192
764#define SMALLCHUNK 8192
765#else
766#define SMALLCHUNK BUFSIZ
767#endif
768
Guido van Rossum3c259041999-01-14 19:00:14 +0000769#if SIZEOF_INT < 4
770#define BIGCHUNK (512 * 32)
771#else
772#define BIGCHUNK (512 * 1024)
773#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000774
775static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000776new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000777{
778#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000779 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000780 struct stat st;
781 if (fstat(fileno(f->f_fp), &st) == 0) {
782 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000783 /* The following is not a bug: we really need to call lseek()
784 *and* ftell(). The reason is that some stdio libraries
785 mistakenly flush their buffer when ftell() is called and
786 the lseek() call it makes fails, thereby throwing away
787 data that cannot be recovered in any way. To avoid this,
788 we first test lseek(), and only call ftell() if lseek()
789 works. We can't use the lseek() value either, because we
790 need to take the amount of buffered data into account.
791 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000792 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000793 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000794 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000795 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000796 if (pos < 0)
797 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000798 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000799 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000800 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000801 }
802#endif
803 if (currentsize > SMALLCHUNK) {
804 /* Keep doubling until we reach BIGCHUNK;
805 then keep adding BIGCHUNK. */
806 if (currentsize <= BIGCHUNK)
807 return currentsize + currentsize;
808 else
809 return currentsize + BIGCHUNK;
810 }
811 return currentsize + SMALLCHUNK;
812}
813
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000814#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
815#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
816#else
817#ifdef EWOULDBLOCK
818#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
819#else
820#ifdef EAGAIN
821#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
822#else
823#define BLOCKED_ERRNO(x) 0
824#endif
825#endif
826#endif
827
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000828static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000829file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000830{
Guido van Rossum789a1611997-05-10 22:33:55 +0000831 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000832 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000833 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000834
Guido van Rossumd7297e61992-07-06 14:19:26 +0000835 if (f->f_fp == NULL)
836 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000837 /* refuse to mix with f.next() */
838 if (f->f_buf != NULL &&
839 (f->f_bufend - f->f_bufptr) > 0 &&
840 f->f_buf[0] != '\0')
841 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000842 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000843 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000844 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000845 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000846 else
847 buffersize = bytesrequested;
Martin v. Löwis2a190742006-04-13 07:37:25 +0000848 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000849 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000850 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000851 return NULL;
852 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000853 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000854 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000855 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000856 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000857 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000858 Py_BEGIN_ALLOW_THREADS
859 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000860 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000861 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000862 Py_END_ALLOW_THREADS
863 if (chunksize == 0) {
Martin v. Löwis084486b2008-12-13 15:36:49 +0000864 if (!PyErr_ExceptionMatches(PyExc_IOError))
Guido van Rossum6263d541997-05-10 22:07:25 +0000865 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000866 /* When in non-blocking mode, data shouldn't
867 * be discarded if a blocking signal was
868 * received. That will also happen if
869 * chunksize != 0, but bytesread < buffersize. */
Martin v. Löwis084486b2008-12-13 15:36:49 +0000870 if (bytesread > 0 && BLOCKED_ERRNO(errno)) {
871 PyErr_Clear();
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000872 break;
Martin v. Löwis084486b2008-12-13 15:36:49 +0000873 }
Guido van Rossum6263d541997-05-10 22:07:25 +0000874 Py_DECREF(v);
875 return NULL;
876 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000877 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000878 if (bytesread < buffersize) {
879 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000880 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000881 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000882 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000883 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000884 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000885 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000886 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000887 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000888 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000889 }
890 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000891 if (bytesread != buffersize)
892 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000893 return v;
894}
895
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000896static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000897file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000898{
899 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000900 Py_ssize_t ntodo;
901 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000902
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000903 if (f->f_fp == NULL)
904 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000905 /* refuse to mix with f.next() */
906 if (f->f_buf != NULL &&
907 (f->f_bufend - f->f_bufptr) > 0 &&
908 f->f_buf[0] != '\0')
909 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000910 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000911 return NULL;
912 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000913 while (ntodo > 0) {
914 Py_BEGIN_ALLOW_THREADS
915 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000916 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000917 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000918 Py_END_ALLOW_THREADS
919 if (nnow == 0) {
Martin v. Löwis084486b2008-12-13 15:36:49 +0000920 if (!PyErr_ExceptionMatches(PyExc_IOError))
Guido van Rossum6263d541997-05-10 22:07:25 +0000921 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000922 return NULL;
923 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000924 ndone += nnow;
925 ntodo -= nnow;
926 }
Neal Norwitz47f0ffa2006-08-21 18:44:09 +0000927 return PyInt_FromSsize_t(ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000928}
929
Tim Peters86821b22001-01-07 21:19:34 +0000930/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000931Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000932
933Under MSVC 6:
934
Tim Peters1c733232001-01-08 04:02:07 +0000935+ MS threadsafe getc is very slow (multiple layers of function calls before+
936 after each character, to lock+unlock the stream).
937+ The stream-locking functions are MS-internal -- can't access them from user
938 code.
939+ There's nothing Tim could find in the MS C or platform SDK libraries that
940 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000941+ MS fgets locks/unlocks only once per line; it's the only hook we have.
942
943So we use fgets for speed(!), despite that it's painful.
944
945MS realloc is also slow.
946
Tim Petersf29b64d2001-01-15 06:33:19 +0000947Reports from other platforms on this method vs getc_unlocked (which MS doesn't
948have):
949 Linux a wash
950 Solaris a wash
951 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000952
Tim Petersf29b64d2001-01-15 06:33:19 +0000953CAUTION: The C std isn't clear about this: in those cases where fgets
954writes something into the buffer, can it write into any position beyond the
955required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
956known on which it does; and it would be a strange way to code fgets. Still,
957getline_via_fgets may not work correctly if it does. The std test
958test_bufio.py should fail if platform fgets() routinely writes beyond the
959trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000960**************************************************************************/
961
Tim Petersf29b64d2001-01-15 06:33:19 +0000962/* Use this routine if told to, or by default on non-get_unlocked()
963 * platforms unless told not to. Yikes! Let's spell that out:
964 * On a platform with getc_unlocked():
965 * By default, use getc_unlocked().
966 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
967 * On a platform without getc_unlocked():
968 * By default, use fgets().
969 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
970 */
971#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
972#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000973#endif
974
Tim Petersf29b64d2001-01-15 06:33:19 +0000975#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
976#undef USE_FGETS_IN_GETLINE
977#endif
978
979#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000980static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000981getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000982{
Tim Peters15b83852001-01-08 00:53:12 +0000983/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000984 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
985 * to fill this much of the buffer with a known value in order to figure out
986 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
987 * than "most" lines, we waste time filling unused buffer slots. 100 is
988 * surely adequate for most peoples' email archives, chewing over source code,
989 * etc -- "regular old text files".
990 * MAXBUFSIZE is the maximum line length that lets us get away with the less
991 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
992 * cautions about boosting that. 300 was chosen because the worst real-life
993 * text-crunching job reported on Python-Dev was a mail-log crawler where over
994 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +0000995 */
Tim Peters142297a2001-01-15 10:36:56 +0000996#define INITBUFSIZE 100
997#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +0000998 char* p; /* temp */
999 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +00001000 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +00001001 char* pvfree; /* address of next free slot */
1002 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +00001003 size_t nfree; /* # of free buffer slots; pvend-pvfree */
1004 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001005 size_t increment; /* amount to increment the buffer */
Armin Rigo4b63c212006-10-04 11:44:06 +00001006 size_t prev_v_size;
Tim Peters86821b22001-01-07 21:19:34 +00001007
Tim Peters15b83852001-01-08 00:53:12 +00001008 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001009 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001010 */
Tim Peters142297a2001-01-15 10:36:56 +00001011 total_v_size = INITBUFSIZE; /* start small and pray */
1012 pvfree = buf;
1013 for (;;) {
1014 Py_BEGIN_ALLOW_THREADS
1015 pvend = buf + total_v_size;
1016 nfree = pvend - pvfree;
1017 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001018 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1019 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001020 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001021
Tim Peters142297a2001-01-15 10:36:56 +00001022 if (p == NULL) {
1023 clearerr(fp);
1024 if (PyErr_CheckSignals())
1025 return NULL;
1026 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001027 return v;
1028 }
Tim Peters142297a2001-01-15 10:36:56 +00001029 /* fgets read *something* */
1030 p = memchr(pvfree, '\n', nfree);
1031 if (p != NULL) {
1032 /* Did the \n come from fgets or from us?
1033 * Since fgets stops at the first \n, and then writes
1034 * \0, if it's from fgets a \0 must be next. But if
1035 * that's so, it could not have come from us, since
1036 * the \n's we filled the buffer with have only more
1037 * \n's to the right.
1038 */
1039 if (p+1 < pvend && *(p+1) == '\0') {
1040 /* It's from fgets: we win! In particular,
1041 * we haven't done any mallocs yet, and can
1042 * build the final result on the first try.
1043 */
1044 ++p; /* include \n from fgets */
1045 }
1046 else {
1047 /* Must be from us: fgets didn't fill the
1048 * buffer and didn't find a newline, so it
1049 * must be the last and newline-free line of
1050 * the file.
1051 */
1052 assert(p > pvfree && *(p-1) == '\0');
1053 --p; /* don't include \0 from fgets */
1054 }
1055 v = PyString_FromStringAndSize(buf, p - buf);
1056 return v;
1057 }
1058 /* yuck: fgets overwrote all the newlines, i.e. the entire
1059 * buffer. So this line isn't over yet, or maybe it is but
1060 * we're exactly at EOF. If we haven't already, try using the
1061 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001062 */
Tim Peters142297a2001-01-15 10:36:56 +00001063 assert(*(pvend-1) == '\0');
1064 if (pvfree == buf) {
1065 pvfree = pvend - 1; /* overwrite trailing null */
1066 total_v_size = MAXBUFSIZE;
1067 }
1068 else
1069 break;
Tim Peters86821b22001-01-07 21:19:34 +00001070 }
Tim Peters142297a2001-01-15 10:36:56 +00001071
1072 /* The stack buffer isn't big enough; malloc a string object and read
1073 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001074 */
Tim Petersddea2082002-03-23 10:03:50 +00001075 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001076 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001077 if (v == NULL)
1078 return v;
1079 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001080 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1081 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001082
1083 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001084 * after setting p one beyond the end of the line. The code here is
1085 * very much like the code above, except reads into v's buffer; see
1086 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001087 */
1088 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001089 Py_BEGIN_ALLOW_THREADS
1090 pvend = BUF(v) + total_v_size;
1091 nfree = pvend - pvfree;
1092 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001093 assert(nfree < INT_MAX);
1094 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001095 Py_END_ALLOW_THREADS
1096
1097 if (p == NULL) {
1098 clearerr(fp);
1099 if (PyErr_CheckSignals()) {
1100 Py_DECREF(v);
1101 return NULL;
1102 }
1103 p = pvfree;
1104 break;
1105 }
Tim Peters86821b22001-01-07 21:19:34 +00001106 p = memchr(pvfree, '\n', nfree);
1107 if (p != NULL) {
1108 if (p+1 < pvend && *(p+1) == '\0') {
1109 /* \n came from fgets */
1110 ++p;
1111 break;
1112 }
1113 /* \n came from us; last line of file, no newline */
1114 assert(p > pvfree && *(p-1) == '\0');
1115 --p;
1116 break;
1117 }
1118 /* expand buffer and try again */
1119 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001120 increment = total_v_size >> 2; /* mild exponential growth */
Armin Rigo4b63c212006-10-04 11:44:06 +00001121 prev_v_size = total_v_size;
Tim Petersddea2082002-03-23 10:03:50 +00001122 total_v_size += increment;
Armin Rigo4b63c212006-10-04 11:44:06 +00001123 /* check for overflow */
1124 if (total_v_size <= prev_v_size ||
1125 total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001126 PyErr_SetString(PyExc_OverflowError,
1127 "line is longer than a Python string can hold");
1128 Py_DECREF(v);
1129 return NULL;
1130 }
1131 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1132 return NULL;
1133 /* overwrite the trailing null byte */
Armin Rigo4b63c212006-10-04 11:44:06 +00001134 pvfree = BUF(v) + (prev_v_size - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001135 }
1136 if (BUF(v) + total_v_size != p)
1137 _PyString_Resize(&v, p - BUF(v));
1138 return v;
1139#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001140#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001141}
Tim Petersf29b64d2001-01-15 06:33:19 +00001142#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001143
Guido van Rossum0bd24411991-04-04 15:21:57 +00001144/* Internal routine to get a line.
1145 Size argument interpretation:
1146 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001147 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001148*/
1149
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001150static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001151get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001152{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001153 FILE *fp = f->f_fp;
1154 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001155 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001156 size_t total_v_size; /* total # of slots in buffer */
1157 size_t used_v_size; /* # used slots in buffer */
1158 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001159 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001160 int newlinetypes = f->f_newlinetypes;
1161 int skipnextlf = f->f_skipnextlf;
1162 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001163
Jack Jansen7b8c7542002-04-14 20:12:41 +00001164#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001165 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001166 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001167#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001168 total_v_size = n > 0 ? n : 100;
1169 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001170 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001171 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001172 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001173 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001174
Guido van Rossumce5ba841991-03-06 13:06:18 +00001175 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001176 Py_BEGIN_ALLOW_THREADS
1177 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001178 if (univ_newline) {
1179 c = 'x'; /* Shut up gcc warning */
1180 while ( buf != end && (c = GETC(fp)) != EOF ) {
1181 if (skipnextlf ) {
1182 skipnextlf = 0;
1183 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001184 /* Seeing a \n here with
1185 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001186 * saw a \r before.
1187 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001188 newlinetypes |= NEWLINE_CRLF;
1189 c = GETC(fp);
1190 if (c == EOF) break;
1191 } else {
1192 newlinetypes |= NEWLINE_CR;
1193 }
1194 }
1195 if (c == '\r') {
1196 skipnextlf = 1;
1197 c = '\n';
1198 } else if ( c == '\n')
1199 newlinetypes |= NEWLINE_LF;
1200 *buf++ = c;
1201 if (c == '\n') break;
1202 }
1203 if ( c == EOF && skipnextlf )
1204 newlinetypes |= NEWLINE_CR;
1205 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001206 while ((c = GETC(fp)) != EOF &&
1207 (*buf++ = c) != '\n' &&
1208 buf != end)
1209 ;
1210 FUNLOCKFILE(fp);
1211 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001212 f->f_newlinetypes = newlinetypes;
1213 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001214 if (c == '\n')
1215 break;
1216 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001217 if (ferror(fp)) {
1218 PyErr_SetFromErrno(PyExc_IOError);
1219 clearerr(fp);
1220 Py_DECREF(v);
1221 return NULL;
1222 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001223 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001224 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001225 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001226 return NULL;
1227 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001228 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001229 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001230 /* Must be because buf == end */
1231 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001232 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001233 used_v_size = total_v_size;
1234 increment = total_v_size >> 2; /* mild exponential growth */
1235 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001236 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001237 PyErr_SetString(PyExc_OverflowError,
1238 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001239 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001240 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001241 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001242 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001243 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001244 buf = BUF(v) + used_v_size;
1245 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001246 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001247
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001248 used_v_size = buf - BUF(v);
1249 if (used_v_size != total_v_size)
1250 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001251 return v;
1252}
1253
Guido van Rossum0bd24411991-04-04 15:21:57 +00001254/* External C interface */
1255
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001256PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001257PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001258{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001259 PyObject *result;
1260
Guido van Rossum3165fe61992-09-25 21:59:05 +00001261 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001262 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001263 return NULL;
1264 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001265
1266 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001267 PyFileObject *fo = (PyFileObject *)f;
1268 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001269 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001270 /* refuse to mix with f.next() */
1271 if (fo->f_buf != NULL &&
1272 (fo->f_bufend - fo->f_bufptr) > 0 &&
1273 fo->f_buf[0] != '\0')
1274 return err_iterbuffered();
1275 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001276 }
1277 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001278 PyObject *reader;
1279 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001280
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001281 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001282 if (reader == NULL)
1283 return NULL;
1284 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001285 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001286 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001287 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001288 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001289 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001290 return NULL;
1291 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001292 result = PyEval_CallObject(reader, args);
1293 Py_DECREF(reader);
1294 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001295 if (result != NULL && !PyString_Check(result) &&
1296 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001297 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001298 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001299 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001300 "object.readline() returned non-string");
1301 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001302 }
1303
1304 if (n < 0 && result != NULL && PyString_Check(result)) {
1305 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001306 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001307 if (len == 0) {
1308 Py_DECREF(result);
1309 result = NULL;
1310 PyErr_SetString(PyExc_EOFError,
1311 "EOF when reading a line");
1312 }
1313 else if (s[len-1] == '\n') {
1314 if (result->ob_refcnt == 1)
1315 _PyString_Resize(&result, len-1);
1316 else {
1317 PyObject *v;
1318 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001319 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001320 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001321 }
1322 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001323 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001324#ifdef Py_USING_UNICODE
1325 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1326 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001327 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001328 if (len == 0) {
1329 Py_DECREF(result);
1330 result = NULL;
1331 PyErr_SetString(PyExc_EOFError,
1332 "EOF when reading a line");
1333 }
1334 else if (s[len-1] == '\n') {
1335 if (result->ob_refcnt == 1)
1336 PyUnicode_Resize(&result, len-1);
1337 else {
1338 PyObject *v;
1339 v = PyUnicode_FromUnicode(s, len-1);
1340 Py_DECREF(result);
1341 result = v;
1342 }
1343 }
1344 }
1345#endif
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001346 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001347}
1348
1349/* Python method */
1350
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001351static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001352file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001353{
Guido van Rossum789a1611997-05-10 22:33:55 +00001354 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001355
Guido van Rossumd7297e61992-07-06 14:19:26 +00001356 if (f->f_fp == NULL)
1357 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001358 /* refuse to mix with f.next() */
1359 if (f->f_buf != NULL &&
1360 (f->f_bufend - f->f_bufptr) > 0 &&
1361 f->f_buf[0] != '\0')
1362 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001363 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001364 return NULL;
1365 if (n == 0)
1366 return PyString_FromString("");
1367 if (n < 0)
1368 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001369 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001370}
1371
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001372static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001373file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001374{
Guido van Rossum789a1611997-05-10 22:33:55 +00001375 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001376 PyObject *list;
1377 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001378 char small_buffer[SMALLCHUNK];
1379 char *buffer = small_buffer;
1380 size_t buffersize = SMALLCHUNK;
1381 PyObject *big_buffer = NULL;
1382 size_t nfilled = 0;
1383 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001384 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001385 char *p, *q, *end;
1386 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001387 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001388
Guido van Rossumd7297e61992-07-06 14:19:26 +00001389 if (f->f_fp == NULL)
1390 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001391 /* refuse to mix with f.next() */
1392 if (f->f_buf != NULL &&
1393 (f->f_bufend - f->f_bufptr) > 0 &&
1394 f->f_buf[0] != '\0')
1395 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001396 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001397 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001398 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001399 return NULL;
1400 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001401 if (shortread)
1402 nread = 0;
1403 else {
1404 Py_BEGIN_ALLOW_THREADS
1405 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001406 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001407 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001408 Py_END_ALLOW_THREADS
1409 shortread = (nread < buffersize-nfilled);
1410 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001411 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001412 sizehint = 0;
Martin v. Löwis084486b2008-12-13 15:36:49 +00001413 if (!PyErr_ExceptionMatches(PyExc_IOError))
Guido van Rossum6263d541997-05-10 22:07:25 +00001414 break;
Guido van Rossum6263d541997-05-10 22:07:25 +00001415 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001416 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001417 list = NULL;
1418 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001419 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001420 totalread += nread;
Anthony Baxter377be112006-04-11 06:54:30 +00001421 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001422 if (p == NULL) {
1423 /* Need a larger buffer to fit this line */
1424 nfilled += nread;
1425 buffersize *= 2;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001426 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001427 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001428 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001429 goto error;
1430 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001431 if (big_buffer == NULL) {
1432 /* Create the big buffer */
1433 big_buffer = PyString_FromStringAndSize(
1434 NULL, buffersize);
1435 if (big_buffer == NULL)
1436 goto error;
1437 buffer = PyString_AS_STRING(big_buffer);
1438 memcpy(buffer, small_buffer, nfilled);
1439 }
1440 else {
1441 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001442 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1443 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001444 buffer = PyString_AS_STRING(big_buffer);
1445 }
1446 continue;
1447 }
1448 end = buffer+nfilled+nread;
1449 q = buffer;
1450 do {
1451 /* Process complete lines */
1452 p++;
1453 line = PyString_FromStringAndSize(q, p-q);
1454 if (line == NULL)
1455 goto error;
1456 err = PyList_Append(list, line);
1457 Py_DECREF(line);
1458 if (err != 0)
1459 goto error;
1460 q = p;
Anthony Baxter377be112006-04-11 06:54:30 +00001461 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001462 } while (p != NULL);
1463 /* Move the remaining incomplete line to the start */
1464 nfilled = end-q;
1465 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001466 if (sizehint > 0)
1467 if (totalread >= (size_t)sizehint)
1468 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001469 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001470 if (nfilled != 0) {
1471 /* Partial last line */
1472 line = PyString_FromStringAndSize(buffer, nfilled);
1473 if (line == NULL)
1474 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001475 if (sizehint > 0) {
1476 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001477 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001478 if (rest == NULL) {
1479 Py_DECREF(line);
1480 goto error;
1481 }
1482 PyString_Concat(&line, rest);
1483 Py_DECREF(rest);
1484 if (line == NULL)
1485 goto error;
1486 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001487 err = PyList_Append(list, line);
1488 Py_DECREF(line);
1489 if (err != 0)
1490 goto error;
1491 }
1492 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001493 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001494 return list;
1495}
1496
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001497static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001498file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001499{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001500 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001501 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001502 if (f->f_fp == NULL)
1503 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001504 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001505 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001506 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001507 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001508 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001509 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001510 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001511 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001512 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001513 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001514 return NULL;
1515 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001516 Py_INCREF(Py_None);
1517 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001518}
1519
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001520static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001521file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001522{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001523#define CHUNKSIZE 1000
1524 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001525 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001526 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001527 int index, islist;
1528 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001529
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001530 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001531 if (f->f_fp == NULL)
1532 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001533
1534 result = NULL;
1535 list = NULL;
1536 islist = PyList_Check(seq);
1537 if (islist)
1538 it = NULL;
1539 else {
1540 it = PyObject_GetIter(seq);
1541 if (it == NULL) {
1542 PyErr_SetString(PyExc_TypeError,
1543 "writelines() requires an iterable argument");
1544 return NULL;
1545 }
1546 /* From here on, fail by going to error, to reclaim "it". */
1547 list = PyList_New(CHUNKSIZE);
1548 if (list == NULL)
1549 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001550 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001551
1552 /* Strategy: slurp CHUNKSIZE lines into a private list,
1553 checking that they are all strings, then write that list
1554 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001555 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001556 if (islist) {
1557 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001558 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001559 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001560 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001561 j = PyList_GET_SIZE(list);
1562 }
1563 else {
1564 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001565 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001566 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001567 if (PyErr_Occurred())
1568 goto error;
1569 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001570 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001571 PyList_SetItem(list, j, line);
1572 }
1573 }
1574 if (j == 0)
1575 break;
1576
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001577 /* Check that all entries are indeed strings. If not,
1578 apply the same rules as for file.write() and
1579 convert the results to strings. This is slow, but
1580 seems to be the only way since all conversion APIs
1581 could potentially execute Python code. */
1582 for (i = 0; i < j; i++) {
1583 PyObject *v = PyList_GET_ITEM(list, i);
1584 if (!PyString_Check(v)) {
1585 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001586 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001587 PyObject_AsReadBuffer(v,
1588 (const void**)&buffer,
1589 &len)) ||
1590 PyObject_AsCharBuffer(v,
1591 &buffer,
1592 &len))) {
1593 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001594 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001595 goto error;
1596 }
1597 line = PyString_FromStringAndSize(buffer,
1598 len);
1599 if (line == NULL)
1600 goto error;
1601 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001602 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001603 }
1604 }
1605
1606 /* Since we are releasing the global lock, the
1607 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001608 Py_BEGIN_ALLOW_THREADS
1609 f->f_softspace = 0;
1610 errno = 0;
1611 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001612 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001613 len = PyString_GET_SIZE(line);
1614 nwritten = fwrite(PyString_AS_STRING(line),
1615 1, len, f->f_fp);
1616 if (nwritten != len) {
1617 Py_BLOCK_THREADS
1618 PyErr_SetFromErrno(PyExc_IOError);
1619 clearerr(f->f_fp);
1620 goto error;
1621 }
1622 }
1623 Py_END_ALLOW_THREADS
1624
1625 if (j < CHUNKSIZE)
1626 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001627 }
1628
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001629 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001630 result = Py_None;
1631 error:
1632 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001633 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001634 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001635#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001636}
1637
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001638static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001639file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001640{
1641 if (f->f_fp == NULL)
1642 return err_closed();
1643 Py_INCREF(f);
1644 return (PyObject *)f;
1645}
1646
Georg Brandl98b40ad2006-06-08 14:50:21 +00001647static PyObject *
1648file_exit(PyFileObject *f, PyObject *args)
1649{
1650 PyObject *ret = file_close(f);
1651 if (!ret)
1652 /* If error occurred, pass through */
1653 return NULL;
1654 Py_DECREF(ret);
1655 /* We cannot return the result of close since a true
1656 * value will be interpreted as "yes, swallow the
1657 * exception if one was raised inside the with block". */
1658 Py_RETURN_NONE;
1659}
1660
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001661PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001662"readline([size]) -> next line from the file, as a string.\n"
1663"\n"
1664"Retain newline. A non-negative size argument limits the maximum\n"
1665"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001666"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001667
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001668PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001669"read([size]) -> read at most size bytes, returned as a string.\n"
1670"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001671"If the size argument is negative or omitted, read until EOF is reached.\n"
1672"Notice that when in non-blocking mode, less data than what was requested\n"
1673"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001674
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001675PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001676"write(str) -> None. Write string str to file.\n"
1677"\n"
1678"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001679"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001680
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001681PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001682"fileno() -> integer \"file descriptor\".\n"
1683"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001684"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001685
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001686PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001687"seek(offset[, whence]) -> None. Move to new file position.\n"
1688"\n"
1689"Argument offset is a byte count. Optional argument whence defaults to\n"
1690"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1691"(move relative to current position, positive or negative), and 2 (move\n"
1692"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001693"seeking beyond the end of a file). If the file is opened in text mode,\n"
1694"only offsets returned by tell() are legal. Use of other offsets causes\n"
1695"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001696"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001697"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001698
Guido van Rossumd7047b31995-01-02 19:07:15 +00001699#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001700PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001701"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1702"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001703"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001704#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001705
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001706PyDoc_STRVAR(tell_doc,
1707"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001708
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001709PyDoc_STRVAR(readinto_doc,
1710"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001711
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001712PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001713"readlines([size]) -> list of strings, each a line from the file.\n"
1714"\n"
1715"Call readline() repeatedly and return a list of the lines so read.\n"
1716"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001717"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001718
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001719PyDoc_STRVAR(xreadlines_doc,
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001720"xreadlines() -> returns self.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001721"\n"
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001722"For backward compatibility. File objects now include the performance\n"
1723"optimizations previously implemented in the xreadlines module.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001724
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001725PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001726"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001727"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001728"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001729"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001730
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001731PyDoc_STRVAR(flush_doc,
1732"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001733
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001734PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001735"close() -> None or (perhaps) an integer. Close the file.\n"
1736"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001737"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001738"further I/O operations. close() may be called more than once without\n"
1739"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001740"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001741
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001742PyDoc_STRVAR(isatty_doc,
1743"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001744
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001745PyDoc_STRVAR(enter_doc,
1746 "__enter__() -> self.");
1747
Georg Brandl98b40ad2006-06-08 14:50:21 +00001748PyDoc_STRVAR(exit_doc,
1749 "__exit__(*excinfo) -> None. Closes the file.");
1750
Tim Petersefc3a3a2001-09-20 07:55:22 +00001751static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001752 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1753 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1754 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1755 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1756 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001757#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001758 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001759#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001760 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1761 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1762 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001763 {"xreadlines",(PyCFunction)file_self, METH_NOARGS, xreadlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001764 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1765 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1766 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1767 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001768 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Georg Brandl98b40ad2006-06-08 14:50:21 +00001769 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001770 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001771};
1772
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001773#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001774
Guido van Rossum6f799372001-09-20 20:46:19 +00001775static PyMemberDef file_memberlist[] = {
1776 {"softspace", T_INT, OFF(f_softspace), 0,
1777 "flag indicating that a space needs to be printed; used by print"},
1778 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001779 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001780 {"name", T_OBJECT, OFF(f_name), RO,
1781 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001782 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1783 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001784 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001785 {NULL} /* Sentinel */
1786};
1787
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001788static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001789get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001790{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001791 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001792}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001793static PyObject *
1794get_newlines(PyFileObject *f, void *closure)
1795{
1796 switch (f->f_newlinetypes) {
1797 case NEWLINE_UNKNOWN:
1798 Py_INCREF(Py_None);
1799 return Py_None;
1800 case NEWLINE_CR:
1801 return PyString_FromString("\r");
1802 case NEWLINE_LF:
1803 return PyString_FromString("\n");
1804 case NEWLINE_CR|NEWLINE_LF:
1805 return Py_BuildValue("(ss)", "\r", "\n");
1806 case NEWLINE_CRLF:
1807 return PyString_FromString("\r\n");
1808 case NEWLINE_CR|NEWLINE_CRLF:
1809 return Py_BuildValue("(ss)", "\r", "\r\n");
1810 case NEWLINE_LF|NEWLINE_CRLF:
1811 return Py_BuildValue("(ss)", "\n", "\r\n");
1812 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1813 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1814 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001815 PyErr_Format(PyExc_SystemError,
1816 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001817 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001818 return NULL;
1819 }
1820}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001821
Guido van Rossum32d34c82001-09-20 21:45:26 +00001822static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001823 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001824 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001825 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001826 {0},
1827};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001828
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001829static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001830drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001831{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001832 if (f->f_buf != NULL) {
1833 PyMem_Free(f->f_buf);
1834 f->f_buf = NULL;
1835 }
Guido van Rossum65967252001-04-21 13:20:18 +00001836}
1837
Tim Petersf1827cf2003-09-07 03:30:18 +00001838/* Make sure that file has a readahead buffer with at least one byte
1839 (unless at EOF) and no more than bufsize. Returns negative value on
Georg Brandled02eb62006-03-31 20:31:02 +00001840 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001841static int
1842readahead(PyFileObject *f, int bufsize)
1843{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001844 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001845
1846 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001847 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001848 return 0;
1849 else
1850 drop_readahead(f);
1851 }
Anthony Baxter377be112006-04-11 06:54:30 +00001852 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
Georg Brandled02eb62006-03-31 20:31:02 +00001853 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001854 return -1;
1855 }
1856 Py_BEGIN_ALLOW_THREADS
1857 errno = 0;
1858 chunksize = Py_UniversalNewlineFread(
1859 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1860 Py_END_ALLOW_THREADS
1861 if (chunksize == 0) {
Martin v. Löwis084486b2008-12-13 15:36:49 +00001862 if (PyErr_ExceptionMatches(PyExc_IOError)) {
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001863 drop_readahead(f);
1864 return -1;
1865 }
1866 }
1867 f->f_bufptr = f->f_buf;
1868 f->f_bufend = f->f_buf + chunksize;
1869 return 0;
1870}
1871
1872/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001873 uninitialized bytes followed by the remainder of the line. Don't be
1874 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001875 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1876
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001877static PyStringObject *
1878readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1879{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001880 PyStringObject* s;
1881 char *bufptr;
1882 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001883 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001884
1885 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001886 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001887 return NULL;
1888
1889 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001890 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001891 return (PyStringObject *)
1892 PyString_FromStringAndSize(NULL, skip);
Anthony Baxter377be112006-04-11 06:54:30 +00001893 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001894 if (bufptr != NULL) {
1895 bufptr++; /* Count the '\n' */
1896 len = bufptr - f->f_bufptr;
1897 s = (PyStringObject *)
1898 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001899 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001900 return NULL;
1901 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1902 f->f_bufptr = bufptr;
1903 if (bufptr == f->f_bufend)
1904 drop_readahead(f);
1905 } else {
1906 bufptr = f->f_bufptr;
1907 buf = f->f_buf;
1908 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001909 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001910 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001911 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001912 if (s == NULL) {
1913 PyMem_Free(buf);
1914 return NULL;
1915 }
1916 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1917 PyMem_Free(buf);
1918 }
1919 return s;
1920}
1921
1922/* A larger buffer size may actually decrease performance. */
1923#define READAHEAD_BUFSIZE 8192
1924
1925static PyObject *
1926file_iternext(PyFileObject *f)
1927{
1928 PyStringObject* l;
1929
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001930 if (f->f_fp == NULL)
1931 return err_closed();
1932
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001933 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1934 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1935 Py_XDECREF(l);
1936 return NULL;
1937 }
1938 return (PyObject *)l;
1939}
1940
1941
Tim Peters59c9a642001-09-13 05:38:56 +00001942static PyObject *
1943file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1944{
Tim Peters44410012001-09-14 03:26:08 +00001945 PyObject *self;
1946 static PyObject *not_yet_string;
1947
1948 assert(type != NULL && type->tp_alloc != NULL);
1949
1950 if (not_yet_string == NULL) {
1951 not_yet_string = PyString_FromString("<uninitialized file>");
1952 if (not_yet_string == NULL)
1953 return NULL;
1954 }
1955
1956 self = type->tp_alloc(type, 0);
1957 if (self != NULL) {
1958 /* Always fill in the name and mode, so that nobody else
1959 needs to special-case NULLs there. */
1960 Py_INCREF(not_yet_string);
1961 ((PyFileObject *)self)->f_name = not_yet_string;
1962 Py_INCREF(not_yet_string);
1963 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001964 Py_INCREF(Py_None);
1965 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001966 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001967 }
1968 return self;
1969}
1970
1971static int
1972file_init(PyObject *self, PyObject *args, PyObject *kwds)
1973{
1974 PyFileObject *foself = (PyFileObject *)self;
1975 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001976 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001977 char *name = NULL;
1978 char *mode = "r";
1979 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001980 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001981
1982 assert(PyFile_Check(self));
1983 if (foself->f_fp != NULL) {
1984 /* Have to close the existing file first. */
1985 PyObject *closeresult = file_close(foself);
1986 if (closeresult == NULL)
1987 return -1;
1988 Py_DECREF(closeresult);
1989 }
Tim Peters59c9a642001-09-13 05:38:56 +00001990
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001991#ifdef Py_WIN_WIDE_FILENAMES
1992 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
1993 PyObject *po;
1994 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
1995 kwlist, &po, &mode, &bufsize)) {
1996 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00001997 if (fill_file_fields(foself, NULL, po, mode,
1998 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001999 goto Error;
2000 } else {
2001 /* Drop the argument parsing error as narrow
2002 strings are also valid. */
2003 PyErr_Clear();
2004 }
2005 }
2006#endif
2007
2008 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002009 PyObject *o_name;
2010
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002011 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2012 Py_FileSystemDefaultEncoding,
2013 &name,
2014 &mode, &bufsize))
2015 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002016
2017 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002018 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2019 kwlist, &o_name, &mode,
2020 &bufsize))
Neal Norwitzfe50f8e2006-09-05 04:32:06 +00002021 goto Error;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002022
2023 if (fill_file_fields(foself, NULL, o_name, mode,
2024 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002025 goto Error;
2026 }
Tim Peters44410012001-09-14 03:26:08 +00002027 if (open_the_file(foself, name, mode) == NULL)
2028 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002029 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002030 PyFile_SetBufSize(self, bufsize);
2031 goto Done;
2032
2033Error:
2034 ret = -1;
2035 /* fall through */
2036Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002037 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002038 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002039}
2040
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002041PyDoc_VAR(file_doc) =
2042PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002043"file(name[, mode[, buffering]]) -> file object\n"
2044"\n"
2045"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2046"writing or appending. The file will be created if it doesn't exist\n"
2047"when opened for writing or appending; it will be truncated when\n"
2048"opened for writing. Add a 'b' to the mode for binary files.\n"
2049"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2050"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002051"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002052)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002053PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002054"Add a 'U' to mode to open the file for input with universal newline\n"
2055"support. Any line ending in the input file will be seen as a '\\n'\n"
2056"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2057"the value for this attribute is one of None (no newline read yet),\n"
2058"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2059"\n"
2060"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002061);
Tim Peters59c9a642001-09-13 05:38:56 +00002062
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002063PyTypeObject PyFile_Type = {
2064 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002065 0,
2066 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002067 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002068 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002069 (destructor)file_dealloc, /* tp_dealloc */
2070 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002071 0, /* tp_getattr */
2072 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002073 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002074 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002075 0, /* tp_as_number */
2076 0, /* tp_as_sequence */
2077 0, /* tp_as_mapping */
2078 0, /* tp_hash */
2079 0, /* tp_call */
2080 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002081 PyObject_GenericGetAttr, /* tp_getattro */
Tim Peters015dd822003-05-04 04:16:52 +00002082 /* softspace is writable: we must supply tp_setattro */
2083 PyObject_GenericSetAttr, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002084 0, /* tp_as_buffer */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002085 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002086 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002087 0, /* tp_traverse */
2088 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002089 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002090 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002091 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002092 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002093 file_methods, /* tp_methods */
2094 file_memberlist, /* tp_members */
2095 file_getsetlist, /* tp_getset */
2096 0, /* tp_base */
2097 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002098 0, /* tp_descr_get */
2099 0, /* tp_descr_set */
2100 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002101 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002102 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002103 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002104 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002105};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002106
2107/* Interface for the 'soft space' between print items. */
2108
2109int
Fred Drakefd99de62000-07-09 05:02:18 +00002110PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00002111{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002112 long oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002113 if (f == NULL) {
2114 /* Do nothing */
2115 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002116 else if (PyFile_Check(f)) {
2117 oldflag = ((PyFileObject *)f)->f_softspace;
2118 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002119 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00002120 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002121 PyObject *v;
2122 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002123 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002124 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002125 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002126 if (PyInt_Check(v))
2127 oldflag = PyInt_AsLong(v);
Martin v. Löwis18e16552006-02-15 17:27:45 +00002128 assert(oldflag < INT_MAX);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002129 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002130 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002131 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002132 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002133 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002134 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002135 if (PyObject_SetAttrString(f, "softspace", v) != 0)
2136 PyErr_Clear();
2137 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002138 }
2139 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002140 return (int)oldflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002141}
Guido van Rossum3165fe61992-09-25 21:59:05 +00002142
2143/* Interfaces to write objects/strings to file-like objects */
2144
2145int
Fred Drakefd99de62000-07-09 05:02:18 +00002146PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002147{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002148 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002149 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002150 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002151 return -1;
2152 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002153 else if (PyFile_Check(f)) {
2154 FILE *fp = PyFile_AsFile(f);
Fred Drake086a0f72004-03-19 15:22:36 +00002155#ifdef Py_USING_UNICODE
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002156 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2157 int result;
Fred Drake086a0f72004-03-19 15:22:36 +00002158#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002159 if (fp == NULL) {
2160 err_closed();
2161 return -1;
2162 }
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002163#ifdef Py_USING_UNICODE
Tim Petersf1827cf2003-09-07 03:30:18 +00002164 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002165 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002166 char *cenc = PyString_AS_STRING(enc);
2167 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2168 if (value == NULL)
2169 return -1;
2170 } else {
2171 value = v;
2172 Py_INCREF(value);
2173 }
2174 result = PyObject_Print(value, fp, flags);
2175 Py_DECREF(value);
2176 return result;
2177#else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002178 return PyObject_Print(v, fp, flags);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002179#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002180 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002181 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002182 if (writer == NULL)
2183 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002184 if (flags & Py_PRINT_RAW) {
2185 if (PyUnicode_Check(v)) {
2186 value = v;
2187 Py_INCREF(value);
2188 } else
2189 value = PyObject_Str(v);
2190 }
2191 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002192 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002193 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002194 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002195 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002196 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002197 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002198 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002199 Py_DECREF(value);
2200 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002201 return -1;
2202 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002203 result = PyEval_CallObject(writer, args);
2204 Py_DECREF(args);
2205 Py_DECREF(value);
2206 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002207 if (result == NULL)
2208 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002209 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002210 return 0;
2211}
2212
Guido van Rossum27a60b11997-05-22 22:25:11 +00002213int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002214PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002215{
2216 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002217 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002218 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002219 PyErr_SetString(PyExc_SystemError,
2220 "null file for PyFile_WriteString");
2221 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002222 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002223 else if (PyFile_Check(f)) {
2224 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002225 if (fp == NULL) {
2226 err_closed();
2227 return -1;
2228 }
2229 fputs(s, fp);
2230 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002231 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002232 else if (!PyErr_Occurred()) {
2233 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002234 int err;
2235 if (v == NULL)
2236 return -1;
2237 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2238 Py_DECREF(v);
2239 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002240 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002241 else
2242 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002243}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002244
2245/* Try to get a file-descriptor from a Python object. If the object
2246 is an integer or long integer, its value is returned. If not, the
2247 object's fileno() method is called if it exists; the method must return
2248 an integer or long integer, which is returned as the file descriptor value.
2249 -1 is returned on failure.
2250*/
2251
2252int PyObject_AsFileDescriptor(PyObject *o)
2253{
2254 int fd;
2255 PyObject *meth;
2256
2257 if (PyInt_Check(o)) {
2258 fd = PyInt_AsLong(o);
2259 }
2260 else if (PyLong_Check(o)) {
2261 fd = PyLong_AsLong(o);
2262 }
2263 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2264 {
2265 PyObject *fno = PyEval_CallObject(meth, NULL);
2266 Py_DECREF(meth);
2267 if (fno == NULL)
2268 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002269
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002270 if (PyInt_Check(fno)) {
2271 fd = PyInt_AsLong(fno);
2272 Py_DECREF(fno);
2273 }
2274 else if (PyLong_Check(fno)) {
2275 fd = PyLong_AsLong(fno);
2276 Py_DECREF(fno);
2277 }
2278 else {
2279 PyErr_SetString(PyExc_TypeError,
2280 "fileno() returned a non-integer");
2281 Py_DECREF(fno);
2282 return -1;
2283 }
2284 }
2285 else {
2286 PyErr_SetString(PyExc_TypeError,
2287 "argument must be an int, or have a fileno() method.");
2288 return -1;
2289 }
2290
2291 if (fd < 0) {
2292 PyErr_Format(PyExc_ValueError,
2293 "file descriptor cannot be a negative integer (%i)",
2294 fd);
2295 return -1;
2296 }
2297 return fd;
2298}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002299
Jack Jansen7b8c7542002-04-14 20:12:41 +00002300/* From here on we need access to the real fgets and fread */
2301#undef fgets
2302#undef fread
2303
2304/*
2305** Py_UniversalNewlineFgets is an fgets variation that understands
2306** all of \r, \n and \r\n conventions.
2307** The stream should be opened in binary mode.
2308** If fobj is NULL the routine always does newline conversion, and
2309** it may peek one char ahead to gobble the second char in \r\n.
2310** If fobj is non-NULL it must be a PyFileObject. In this case there
2311** is no readahead but in stead a flag is used to skip a following
2312** \n on the next read. Also, if the file is open in binary mode
2313** the whole conversion is skipped. Finally, the routine keeps track of
2314** the different types of newlines seen.
2315** Note that we need no error handling: fgets() treats error and eof
2316** identically.
2317*/
2318char *
2319Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2320{
2321 char *p = buf;
2322 int c;
2323 int newlinetypes = 0;
2324 int skipnextlf = 0;
2325 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002326
Jack Jansen7b8c7542002-04-14 20:12:41 +00002327 if (fobj) {
2328 if (!PyFile_Check(fobj)) {
2329 errno = ENXIO; /* What can you do... */
2330 return NULL;
2331 }
2332 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2333 if ( !univ_newline )
2334 return fgets(buf, n, stream);
2335 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2336 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2337 }
2338 FLOCKFILE(stream);
2339 c = 'x'; /* Shut up gcc warning */
2340 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2341 if (skipnextlf ) {
2342 skipnextlf = 0;
2343 if (c == '\n') {
2344 /* Seeing a \n here with skipnextlf true
2345 ** means we saw a \r before.
2346 */
2347 newlinetypes |= NEWLINE_CRLF;
2348 c = GETC(stream);
2349 if (c == EOF) break;
2350 } else {
2351 /*
2352 ** Note that c == EOF also brings us here,
2353 ** so we're okay if the last char in the file
2354 ** is a CR.
2355 */
2356 newlinetypes |= NEWLINE_CR;
2357 }
2358 }
2359 if (c == '\r') {
2360 /* A \r is translated into a \n, and we skip
2361 ** an adjacent \n, if any. We don't set the
2362 ** newlinetypes flag until we've seen the next char.
2363 */
2364 skipnextlf = 1;
2365 c = '\n';
2366 } else if ( c == '\n') {
2367 newlinetypes |= NEWLINE_LF;
2368 }
2369 *p++ = c;
2370 if (c == '\n') break;
2371 }
2372 if ( c == EOF && skipnextlf )
2373 newlinetypes |= NEWLINE_CR;
2374 FUNLOCKFILE(stream);
2375 *p = '\0';
2376 if (fobj) {
2377 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2378 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2379 } else if ( skipnextlf ) {
2380 /* If we have no file object we cannot save the
2381 ** skipnextlf flag. We have to readahead, which
2382 ** will cause a pause if we're reading from an
2383 ** interactive stream, but that is very unlikely
2384 ** unless we're doing something silly like
2385 ** execfile("/dev/tty").
2386 */
2387 c = GETC(stream);
2388 if ( c != '\n' )
2389 ungetc(c, stream);
2390 }
2391 if (p == buf)
2392 return NULL;
2393 return buf;
2394}
2395
2396/*
2397** Py_UniversalNewlineFread is an fread variation that understands
2398** all of \r, \n and \r\n conventions.
2399** The stream should be opened in binary mode.
2400** fobj must be a PyFileObject. In this case there
2401** is no readahead but in stead a flag is used to skip a following
2402** \n on the next read. Also, if the file is open in binary mode
2403** the whole conversion is skipped. Finally, the routine keeps track of
2404** the different types of newlines seen.
2405*/
2406size_t
Tim Peters058b1412002-04-21 07:29:14 +00002407Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002408 FILE *stream, PyObject *fobj)
2409{
Tim Peters058b1412002-04-21 07:29:14 +00002410 char *dst = buf;
2411 PyFileObject *f = (PyFileObject *)fobj;
2412 int newlinetypes, skipnextlf;
Martin v. Löwis084486b2008-12-13 15:36:49 +00002413 size_t nread;
Tim Peters058b1412002-04-21 07:29:14 +00002414
2415 assert(buf != NULL);
2416 assert(stream != NULL);
2417
Jack Jansen7b8c7542002-04-14 20:12:41 +00002418 if (!fobj || !PyFile_Check(fobj)) {
2419 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002420 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002421 }
Martin v. Löwis084486b2008-12-13 15:36:49 +00002422 if (!f->f_univ_newline) {
2423 nread = fread(buf, 1, n, stream);
2424 if (nread == 0) {
2425 if (ferror(stream))
2426 PyErr_SetFromErrno(PyExc_IOError);
2427 clearerr(stream);
2428 }
2429 return nread;
2430 }
Tim Peters058b1412002-04-21 07:29:14 +00002431 newlinetypes = f->f_newlinetypes;
2432 skipnextlf = f->f_skipnextlf;
2433 /* Invariant: n is the number of bytes remaining to be filled
2434 * in the buffer.
2435 */
2436 while (n) {
Tim Peters058b1412002-04-21 07:29:14 +00002437 int shortread;
2438 char *src = dst;
2439
2440 nread = fread(dst, 1, n, stream);
2441 assert(nread <= n);
Martin v. Löwis084486b2008-12-13 15:36:49 +00002442 if (nread == 0) {
2443 if (ferror(stream)) {
2444 clearerr(stream);
2445 PyErr_SetFromErrno(PyExc_IOError);
2446 return 0;
2447 }
2448 clearerr(stream);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002449 break;
Martin v. Löwis084486b2008-12-13 15:36:49 +00002450 }
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002451
Tim Peterse1682a82002-04-21 18:15:20 +00002452 n -= nread; /* assuming 1 byte out for each in; will adjust */
2453 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002454 while (nread--) {
2455 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002456 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002457 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002458 *dst++ = '\n';
2459 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002460 }
2461 else if (skipnextlf && c == '\n') {
2462 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002463 skipnextlf = 0;
2464 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002465 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002466 }
2467 else {
2468 /* Normal char to be stored in buffer. Also
2469 * update the newlinetypes flag if either this
2470 * is an LF or the previous char was a CR.
2471 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002472 if (c == '\n')
2473 newlinetypes |= NEWLINE_LF;
2474 else if (skipnextlf)
2475 newlinetypes |= NEWLINE_CR;
2476 *dst++ = c;
2477 skipnextlf = 0;
2478 }
2479 }
Tim Peters058b1412002-04-21 07:29:14 +00002480 if (shortread) {
2481 /* If this is EOF, update type flags. */
2482 if (skipnextlf && feof(stream))
2483 newlinetypes |= NEWLINE_CR;
2484 break;
2485 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002486 }
Tim Peters058b1412002-04-21 07:29:14 +00002487 f->f_newlinetypes = newlinetypes;
2488 f->f_skipnextlf = skipnextlf;
2489 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002490}
Anthony Baxterac6bd462006-04-13 02:06:09 +00002491
2492#ifdef __cplusplus
2493}
2494#endif