blob: 565bf5ca2f78c23f3adc256d9cb2f935a47aa941 [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) {
864 if (!ferror(f->f_fp))
865 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000866 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000867 /* When in non-blocking mode, data shouldn't
868 * be discarded if a blocking signal was
869 * received. That will also happen if
870 * chunksize != 0, but bytesread < buffersize. */
871 if (bytesread > 0 && BLOCKED_ERRNO(errno))
872 break;
873 PyErr_SetFromErrno(PyExc_IOError);
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) {
920 if (!ferror(f->f_fp))
921 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000922 PyErr_SetFromErrno(PyExc_IOError);
923 clearerr(f->f_fp);
924 return NULL;
925 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000926 ndone += nnow;
927 ntodo -= nnow;
928 }
Neal Norwitz47f0ffa2006-08-21 18:44:09 +0000929 return PyInt_FromSsize_t(ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000930}
931
Tim Peters86821b22001-01-07 21:19:34 +0000932/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000933Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000934
935Under MSVC 6:
936
Tim Peters1c733232001-01-08 04:02:07 +0000937+ MS threadsafe getc is very slow (multiple layers of function calls before+
938 after each character, to lock+unlock the stream).
939+ The stream-locking functions are MS-internal -- can't access them from user
940 code.
941+ There's nothing Tim could find in the MS C or platform SDK libraries that
942 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000943+ MS fgets locks/unlocks only once per line; it's the only hook we have.
944
945So we use fgets for speed(!), despite that it's painful.
946
947MS realloc is also slow.
948
Tim Petersf29b64d2001-01-15 06:33:19 +0000949Reports from other platforms on this method vs getc_unlocked (which MS doesn't
950have):
951 Linux a wash
952 Solaris a wash
953 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000954
Tim Petersf29b64d2001-01-15 06:33:19 +0000955CAUTION: The C std isn't clear about this: in those cases where fgets
956writes something into the buffer, can it write into any position beyond the
957required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
958known on which it does; and it would be a strange way to code fgets. Still,
959getline_via_fgets may not work correctly if it does. The std test
960test_bufio.py should fail if platform fgets() routinely writes beyond the
961trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000962**************************************************************************/
963
Tim Petersf29b64d2001-01-15 06:33:19 +0000964/* Use this routine if told to, or by default on non-get_unlocked()
965 * platforms unless told not to. Yikes! Let's spell that out:
966 * On a platform with getc_unlocked():
967 * By default, use getc_unlocked().
968 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
969 * On a platform without getc_unlocked():
970 * By default, use fgets().
971 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
972 */
973#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
974#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000975#endif
976
Tim Petersf29b64d2001-01-15 06:33:19 +0000977#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
978#undef USE_FGETS_IN_GETLINE
979#endif
980
981#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000982static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000983getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000984{
Tim Peters15b83852001-01-08 00:53:12 +0000985/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000986 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
987 * to fill this much of the buffer with a known value in order to figure out
988 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
989 * than "most" lines, we waste time filling unused buffer slots. 100 is
990 * surely adequate for most peoples' email archives, chewing over source code,
991 * etc -- "regular old text files".
992 * MAXBUFSIZE is the maximum line length that lets us get away with the less
993 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
994 * cautions about boosting that. 300 was chosen because the worst real-life
995 * text-crunching job reported on Python-Dev was a mail-log crawler where over
996 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +0000997 */
Tim Peters142297a2001-01-15 10:36:56 +0000998#define INITBUFSIZE 100
999#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +00001000 char* p; /* temp */
1001 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +00001002 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +00001003 char* pvfree; /* address of next free slot */
1004 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +00001005 size_t nfree; /* # of free buffer slots; pvend-pvfree */
1006 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001007 size_t increment; /* amount to increment the buffer */
Armin Rigo4b63c212006-10-04 11:44:06 +00001008 size_t prev_v_size;
Tim Peters86821b22001-01-07 21:19:34 +00001009
Tim Peters15b83852001-01-08 00:53:12 +00001010 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001011 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001012 */
Tim Peters142297a2001-01-15 10:36:56 +00001013 total_v_size = INITBUFSIZE; /* start small and pray */
1014 pvfree = buf;
1015 for (;;) {
1016 Py_BEGIN_ALLOW_THREADS
1017 pvend = buf + total_v_size;
1018 nfree = pvend - pvfree;
1019 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001020 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1021 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001022 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001023
Tim Peters142297a2001-01-15 10:36:56 +00001024 if (p == NULL) {
1025 clearerr(fp);
1026 if (PyErr_CheckSignals())
1027 return NULL;
1028 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001029 return v;
1030 }
Tim Peters142297a2001-01-15 10:36:56 +00001031 /* fgets read *something* */
1032 p = memchr(pvfree, '\n', nfree);
1033 if (p != NULL) {
1034 /* Did the \n come from fgets or from us?
1035 * Since fgets stops at the first \n, and then writes
1036 * \0, if it's from fgets a \0 must be next. But if
1037 * that's so, it could not have come from us, since
1038 * the \n's we filled the buffer with have only more
1039 * \n's to the right.
1040 */
1041 if (p+1 < pvend && *(p+1) == '\0') {
1042 /* It's from fgets: we win! In particular,
1043 * we haven't done any mallocs yet, and can
1044 * build the final result on the first try.
1045 */
1046 ++p; /* include \n from fgets */
1047 }
1048 else {
1049 /* Must be from us: fgets didn't fill the
1050 * buffer and didn't find a newline, so it
1051 * must be the last and newline-free line of
1052 * the file.
1053 */
1054 assert(p > pvfree && *(p-1) == '\0');
1055 --p; /* don't include \0 from fgets */
1056 }
1057 v = PyString_FromStringAndSize(buf, p - buf);
1058 return v;
1059 }
1060 /* yuck: fgets overwrote all the newlines, i.e. the entire
1061 * buffer. So this line isn't over yet, or maybe it is but
1062 * we're exactly at EOF. If we haven't already, try using the
1063 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001064 */
Tim Peters142297a2001-01-15 10:36:56 +00001065 assert(*(pvend-1) == '\0');
1066 if (pvfree == buf) {
1067 pvfree = pvend - 1; /* overwrite trailing null */
1068 total_v_size = MAXBUFSIZE;
1069 }
1070 else
1071 break;
Tim Peters86821b22001-01-07 21:19:34 +00001072 }
Tim Peters142297a2001-01-15 10:36:56 +00001073
1074 /* The stack buffer isn't big enough; malloc a string object and read
1075 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001076 */
Tim Petersddea2082002-03-23 10:03:50 +00001077 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001078 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001079 if (v == NULL)
1080 return v;
1081 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001082 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1083 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001084
1085 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001086 * after setting p one beyond the end of the line. The code here is
1087 * very much like the code above, except reads into v's buffer; see
1088 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001089 */
1090 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001091 Py_BEGIN_ALLOW_THREADS
1092 pvend = BUF(v) + total_v_size;
1093 nfree = pvend - pvfree;
1094 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001095 assert(nfree < INT_MAX);
1096 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001097 Py_END_ALLOW_THREADS
1098
1099 if (p == NULL) {
1100 clearerr(fp);
1101 if (PyErr_CheckSignals()) {
1102 Py_DECREF(v);
1103 return NULL;
1104 }
1105 p = pvfree;
1106 break;
1107 }
Tim Peters86821b22001-01-07 21:19:34 +00001108 p = memchr(pvfree, '\n', nfree);
1109 if (p != NULL) {
1110 if (p+1 < pvend && *(p+1) == '\0') {
1111 /* \n came from fgets */
1112 ++p;
1113 break;
1114 }
1115 /* \n came from us; last line of file, no newline */
1116 assert(p > pvfree && *(p-1) == '\0');
1117 --p;
1118 break;
1119 }
1120 /* expand buffer and try again */
1121 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001122 increment = total_v_size >> 2; /* mild exponential growth */
Armin Rigo4b63c212006-10-04 11:44:06 +00001123 prev_v_size = total_v_size;
Tim Petersddea2082002-03-23 10:03:50 +00001124 total_v_size += increment;
Armin Rigo4b63c212006-10-04 11:44:06 +00001125 /* check for overflow */
1126 if (total_v_size <= prev_v_size ||
1127 total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001128 PyErr_SetString(PyExc_OverflowError,
1129 "line is longer than a Python string can hold");
1130 Py_DECREF(v);
1131 return NULL;
1132 }
1133 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1134 return NULL;
1135 /* overwrite the trailing null byte */
Armin Rigo4b63c212006-10-04 11:44:06 +00001136 pvfree = BUF(v) + (prev_v_size - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001137 }
1138 if (BUF(v) + total_v_size != p)
1139 _PyString_Resize(&v, p - BUF(v));
1140 return v;
1141#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001142#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001143}
Tim Petersf29b64d2001-01-15 06:33:19 +00001144#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001145
Guido van Rossum0bd24411991-04-04 15:21:57 +00001146/* Internal routine to get a line.
1147 Size argument interpretation:
1148 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001149 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001150*/
1151
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001152static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001153get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001154{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001155 FILE *fp = f->f_fp;
1156 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001157 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001158 size_t total_v_size; /* total # of slots in buffer */
1159 size_t used_v_size; /* # used slots in buffer */
1160 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001161 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001162 int newlinetypes = f->f_newlinetypes;
1163 int skipnextlf = f->f_skipnextlf;
1164 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001165
Jack Jansen7b8c7542002-04-14 20:12:41 +00001166#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001167 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001168 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001169#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001170 total_v_size = n > 0 ? n : 100;
1171 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001172 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001173 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001174 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001175 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001176
Guido van Rossumce5ba841991-03-06 13:06:18 +00001177 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001178 Py_BEGIN_ALLOW_THREADS
1179 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001180 if (univ_newline) {
1181 c = 'x'; /* Shut up gcc warning */
1182 while ( buf != end && (c = GETC(fp)) != EOF ) {
1183 if (skipnextlf ) {
1184 skipnextlf = 0;
1185 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001186 /* Seeing a \n here with
1187 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001188 * saw a \r before.
1189 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001190 newlinetypes |= NEWLINE_CRLF;
1191 c = GETC(fp);
1192 if (c == EOF) break;
1193 } else {
1194 newlinetypes |= NEWLINE_CR;
1195 }
1196 }
1197 if (c == '\r') {
1198 skipnextlf = 1;
1199 c = '\n';
1200 } else if ( c == '\n')
1201 newlinetypes |= NEWLINE_LF;
1202 *buf++ = c;
1203 if (c == '\n') break;
1204 }
1205 if ( c == EOF && skipnextlf )
1206 newlinetypes |= NEWLINE_CR;
1207 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001208 while ((c = GETC(fp)) != EOF &&
1209 (*buf++ = c) != '\n' &&
1210 buf != end)
1211 ;
1212 FUNLOCKFILE(fp);
1213 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001214 f->f_newlinetypes = newlinetypes;
1215 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001216 if (c == '\n')
1217 break;
1218 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001219 if (ferror(fp)) {
1220 PyErr_SetFromErrno(PyExc_IOError);
1221 clearerr(fp);
1222 Py_DECREF(v);
1223 return NULL;
1224 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001225 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001226 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001227 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001228 return NULL;
1229 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001230 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001231 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001232 /* Must be because buf == end */
1233 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001234 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001235 used_v_size = total_v_size;
1236 increment = total_v_size >> 2; /* mild exponential growth */
1237 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001238 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001239 PyErr_SetString(PyExc_OverflowError,
1240 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001241 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001242 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001243 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001244 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001245 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001246 buf = BUF(v) + used_v_size;
1247 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001248 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001249
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001250 used_v_size = buf - BUF(v);
1251 if (used_v_size != total_v_size)
1252 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001253 return v;
1254}
1255
Guido van Rossum0bd24411991-04-04 15:21:57 +00001256/* External C interface */
1257
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001258PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001259PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001260{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001261 PyObject *result;
1262
Guido van Rossum3165fe61992-09-25 21:59:05 +00001263 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001264 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001265 return NULL;
1266 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001267
1268 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001269 PyFileObject *fo = (PyFileObject *)f;
1270 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001271 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001272 /* refuse to mix with f.next() */
1273 if (fo->f_buf != NULL &&
1274 (fo->f_bufend - fo->f_bufptr) > 0 &&
1275 fo->f_buf[0] != '\0')
1276 return err_iterbuffered();
1277 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001278 }
1279 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001280 PyObject *reader;
1281 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001282
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001283 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001284 if (reader == NULL)
1285 return NULL;
1286 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001287 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001288 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001289 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001290 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001291 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001292 return NULL;
1293 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001294 result = PyEval_CallObject(reader, args);
1295 Py_DECREF(reader);
1296 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001297 if (result != NULL && !PyString_Check(result) &&
1298 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001299 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001300 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001301 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001302 "object.readline() returned non-string");
1303 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001304 }
1305
1306 if (n < 0 && result != NULL && PyString_Check(result)) {
1307 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001308 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001309 if (len == 0) {
1310 Py_DECREF(result);
1311 result = NULL;
1312 PyErr_SetString(PyExc_EOFError,
1313 "EOF when reading a line");
1314 }
1315 else if (s[len-1] == '\n') {
1316 if (result->ob_refcnt == 1)
1317 _PyString_Resize(&result, len-1);
1318 else {
1319 PyObject *v;
1320 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001321 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001322 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001323 }
1324 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001325 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001326#ifdef Py_USING_UNICODE
1327 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1328 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001329 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001330 if (len == 0) {
1331 Py_DECREF(result);
1332 result = NULL;
1333 PyErr_SetString(PyExc_EOFError,
1334 "EOF when reading a line");
1335 }
1336 else if (s[len-1] == '\n') {
1337 if (result->ob_refcnt == 1)
1338 PyUnicode_Resize(&result, len-1);
1339 else {
1340 PyObject *v;
1341 v = PyUnicode_FromUnicode(s, len-1);
1342 Py_DECREF(result);
1343 result = v;
1344 }
1345 }
1346 }
1347#endif
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001348 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001349}
1350
1351/* Python method */
1352
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001353static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001354file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001355{
Guido van Rossum789a1611997-05-10 22:33:55 +00001356 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001357
Guido van Rossumd7297e61992-07-06 14:19:26 +00001358 if (f->f_fp == NULL)
1359 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001360 /* refuse to mix with f.next() */
1361 if (f->f_buf != NULL &&
1362 (f->f_bufend - f->f_bufptr) > 0 &&
1363 f->f_buf[0] != '\0')
1364 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001365 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001366 return NULL;
1367 if (n == 0)
1368 return PyString_FromString("");
1369 if (n < 0)
1370 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001371 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001372}
1373
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001374static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001375file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001376{
Guido van Rossum789a1611997-05-10 22:33:55 +00001377 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001378 PyObject *list;
1379 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001380 char small_buffer[SMALLCHUNK];
1381 char *buffer = small_buffer;
1382 size_t buffersize = SMALLCHUNK;
1383 PyObject *big_buffer = NULL;
1384 size_t nfilled = 0;
1385 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001386 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001387 char *p, *q, *end;
1388 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001389 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001390
Guido van Rossumd7297e61992-07-06 14:19:26 +00001391 if (f->f_fp == NULL)
1392 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001393 /* refuse to mix with f.next() */
1394 if (f->f_buf != NULL &&
1395 (f->f_bufend - f->f_bufptr) > 0 &&
1396 f->f_buf[0] != '\0')
1397 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001398 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001399 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001400 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001401 return NULL;
1402 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001403 if (shortread)
1404 nread = 0;
1405 else {
1406 Py_BEGIN_ALLOW_THREADS
1407 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001408 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001409 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001410 Py_END_ALLOW_THREADS
1411 shortread = (nread < buffersize-nfilled);
1412 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001413 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001414 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001415 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001416 break;
1417 PyErr_SetFromErrno(PyExc_IOError);
1418 clearerr(f->f_fp);
1419 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001420 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001421 list = NULL;
1422 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001423 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001424 totalread += nread;
Anthony Baxter377be112006-04-11 06:54:30 +00001425 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001426 if (p == NULL) {
1427 /* Need a larger buffer to fit this line */
1428 nfilled += nread;
1429 buffersize *= 2;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001430 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001431 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001432 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001433 goto error;
1434 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001435 if (big_buffer == NULL) {
1436 /* Create the big buffer */
1437 big_buffer = PyString_FromStringAndSize(
1438 NULL, buffersize);
1439 if (big_buffer == NULL)
1440 goto error;
1441 buffer = PyString_AS_STRING(big_buffer);
1442 memcpy(buffer, small_buffer, nfilled);
1443 }
1444 else {
1445 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001446 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1447 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001448 buffer = PyString_AS_STRING(big_buffer);
1449 }
1450 continue;
1451 }
1452 end = buffer+nfilled+nread;
1453 q = buffer;
1454 do {
1455 /* Process complete lines */
1456 p++;
1457 line = PyString_FromStringAndSize(q, p-q);
1458 if (line == NULL)
1459 goto error;
1460 err = PyList_Append(list, line);
1461 Py_DECREF(line);
1462 if (err != 0)
1463 goto error;
1464 q = p;
Anthony Baxter377be112006-04-11 06:54:30 +00001465 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001466 } while (p != NULL);
1467 /* Move the remaining incomplete line to the start */
1468 nfilled = end-q;
1469 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001470 if (sizehint > 0)
1471 if (totalread >= (size_t)sizehint)
1472 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001473 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001474 if (nfilled != 0) {
1475 /* Partial last line */
1476 line = PyString_FromStringAndSize(buffer, nfilled);
1477 if (line == NULL)
1478 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001479 if (sizehint > 0) {
1480 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001481 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001482 if (rest == NULL) {
1483 Py_DECREF(line);
1484 goto error;
1485 }
1486 PyString_Concat(&line, rest);
1487 Py_DECREF(rest);
1488 if (line == NULL)
1489 goto error;
1490 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001491 err = PyList_Append(list, line);
1492 Py_DECREF(line);
1493 if (err != 0)
1494 goto error;
1495 }
1496 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001497 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001498 return list;
1499}
1500
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001501static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001502file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001503{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001504 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001505 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001506 if (f->f_fp == NULL)
1507 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001508 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001509 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001510 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001511 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001512 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001513 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001514 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001515 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001516 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001517 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001518 return NULL;
1519 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001520 Py_INCREF(Py_None);
1521 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001522}
1523
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001524static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001525file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001526{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001527#define CHUNKSIZE 1000
1528 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001529 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001530 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001531 int index, islist;
1532 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001533
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001534 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001535 if (f->f_fp == NULL)
1536 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001537
1538 result = NULL;
1539 list = NULL;
1540 islist = PyList_Check(seq);
1541 if (islist)
1542 it = NULL;
1543 else {
1544 it = PyObject_GetIter(seq);
1545 if (it == NULL) {
1546 PyErr_SetString(PyExc_TypeError,
1547 "writelines() requires an iterable argument");
1548 return NULL;
1549 }
1550 /* From here on, fail by going to error, to reclaim "it". */
1551 list = PyList_New(CHUNKSIZE);
1552 if (list == NULL)
1553 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001554 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001555
1556 /* Strategy: slurp CHUNKSIZE lines into a private list,
1557 checking that they are all strings, then write that list
1558 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001559 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001560 if (islist) {
1561 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001562 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001563 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001564 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001565 j = PyList_GET_SIZE(list);
1566 }
1567 else {
1568 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001569 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001570 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001571 if (PyErr_Occurred())
1572 goto error;
1573 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001574 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001575 PyList_SetItem(list, j, line);
1576 }
1577 }
1578 if (j == 0)
1579 break;
1580
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001581 /* Check that all entries are indeed strings. If not,
1582 apply the same rules as for file.write() and
1583 convert the results to strings. This is slow, but
1584 seems to be the only way since all conversion APIs
1585 could potentially execute Python code. */
1586 for (i = 0; i < j; i++) {
1587 PyObject *v = PyList_GET_ITEM(list, i);
1588 if (!PyString_Check(v)) {
1589 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001590 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001591 PyObject_AsReadBuffer(v,
1592 (const void**)&buffer,
1593 &len)) ||
1594 PyObject_AsCharBuffer(v,
1595 &buffer,
1596 &len))) {
1597 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001598 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001599 goto error;
1600 }
1601 line = PyString_FromStringAndSize(buffer,
1602 len);
1603 if (line == NULL)
1604 goto error;
1605 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001606 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001607 }
1608 }
1609
1610 /* Since we are releasing the global lock, the
1611 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001612 Py_BEGIN_ALLOW_THREADS
1613 f->f_softspace = 0;
1614 errno = 0;
1615 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001616 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001617 len = PyString_GET_SIZE(line);
1618 nwritten = fwrite(PyString_AS_STRING(line),
1619 1, len, f->f_fp);
1620 if (nwritten != len) {
1621 Py_BLOCK_THREADS
1622 PyErr_SetFromErrno(PyExc_IOError);
1623 clearerr(f->f_fp);
1624 goto error;
1625 }
1626 }
1627 Py_END_ALLOW_THREADS
1628
1629 if (j < CHUNKSIZE)
1630 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001631 }
1632
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001633 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001634 result = Py_None;
1635 error:
1636 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001637 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001638 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001639#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001640}
1641
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001642static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001643file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001644{
1645 if (f->f_fp == NULL)
1646 return err_closed();
1647 Py_INCREF(f);
1648 return (PyObject *)f;
1649}
1650
Georg Brandl98b40ad2006-06-08 14:50:21 +00001651static PyObject *
1652file_exit(PyFileObject *f, PyObject *args)
1653{
1654 PyObject *ret = file_close(f);
1655 if (!ret)
1656 /* If error occurred, pass through */
1657 return NULL;
1658 Py_DECREF(ret);
1659 /* We cannot return the result of close since a true
1660 * value will be interpreted as "yes, swallow the
1661 * exception if one was raised inside the with block". */
1662 Py_RETURN_NONE;
1663}
1664
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001665PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001666"readline([size]) -> next line from the file, as a string.\n"
1667"\n"
1668"Retain newline. A non-negative size argument limits the maximum\n"
1669"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001670"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001671
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001672PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001673"read([size]) -> read at most size bytes, returned as a string.\n"
1674"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001675"If the size argument is negative or omitted, read until EOF is reached.\n"
1676"Notice that when in non-blocking mode, less data than what was requested\n"
1677"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001678
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001679PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001680"write(str) -> None. Write string str to file.\n"
1681"\n"
1682"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001683"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001684
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001685PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001686"fileno() -> integer \"file descriptor\".\n"
1687"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001688"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001689
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001690PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001691"seek(offset[, whence]) -> None. Move to new file position.\n"
1692"\n"
1693"Argument offset is a byte count. Optional argument whence defaults to\n"
1694"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1695"(move relative to current position, positive or negative), and 2 (move\n"
1696"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001697"seeking beyond the end of a file). If the file is opened in text mode,\n"
1698"only offsets returned by tell() are legal. Use of other offsets causes\n"
1699"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001700"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001701"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001702
Guido van Rossumd7047b31995-01-02 19:07:15 +00001703#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001704PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001705"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1706"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001707"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001708#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001709
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001710PyDoc_STRVAR(tell_doc,
1711"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001712
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001713PyDoc_STRVAR(readinto_doc,
1714"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001715
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001716PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001717"readlines([size]) -> list of strings, each a line from the file.\n"
1718"\n"
1719"Call readline() repeatedly and return a list of the lines so read.\n"
1720"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001721"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001722
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001723PyDoc_STRVAR(xreadlines_doc,
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001724"xreadlines() -> returns self.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001725"\n"
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001726"For backward compatibility. File objects now include the performance\n"
1727"optimizations previously implemented in the xreadlines module.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001728
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001729PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001730"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001731"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001732"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001733"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001734
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001735PyDoc_STRVAR(flush_doc,
1736"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001737
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001738PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001739"close() -> None or (perhaps) an integer. Close the file.\n"
1740"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001741"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001742"further I/O operations. close() may be called more than once without\n"
1743"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001744"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001745
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001746PyDoc_STRVAR(isatty_doc,
1747"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001748
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001749PyDoc_STRVAR(enter_doc,
1750 "__enter__() -> self.");
1751
Georg Brandl98b40ad2006-06-08 14:50:21 +00001752PyDoc_STRVAR(exit_doc,
1753 "__exit__(*excinfo) -> None. Closes the file.");
1754
Tim Petersefc3a3a2001-09-20 07:55:22 +00001755static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001756 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1757 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1758 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1759 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1760 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001761#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001762 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001763#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001764 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1765 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1766 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001767 {"xreadlines",(PyCFunction)file_self, METH_NOARGS, xreadlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001768 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1769 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1770 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1771 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001772 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Georg Brandl98b40ad2006-06-08 14:50:21 +00001773 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001774 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001775};
1776
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001777#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001778
Guido van Rossum6f799372001-09-20 20:46:19 +00001779static PyMemberDef file_memberlist[] = {
1780 {"softspace", T_INT, OFF(f_softspace), 0,
1781 "flag indicating that a space needs to be printed; used by print"},
1782 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001783 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001784 {"name", T_OBJECT, OFF(f_name), RO,
1785 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001786 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1787 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001788 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001789 {NULL} /* Sentinel */
1790};
1791
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001792static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001793get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001794{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001795 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001796}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001797static PyObject *
1798get_newlines(PyFileObject *f, void *closure)
1799{
1800 switch (f->f_newlinetypes) {
1801 case NEWLINE_UNKNOWN:
1802 Py_INCREF(Py_None);
1803 return Py_None;
1804 case NEWLINE_CR:
1805 return PyString_FromString("\r");
1806 case NEWLINE_LF:
1807 return PyString_FromString("\n");
1808 case NEWLINE_CR|NEWLINE_LF:
1809 return Py_BuildValue("(ss)", "\r", "\n");
1810 case NEWLINE_CRLF:
1811 return PyString_FromString("\r\n");
1812 case NEWLINE_CR|NEWLINE_CRLF:
1813 return Py_BuildValue("(ss)", "\r", "\r\n");
1814 case NEWLINE_LF|NEWLINE_CRLF:
1815 return Py_BuildValue("(ss)", "\n", "\r\n");
1816 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1817 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1818 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001819 PyErr_Format(PyExc_SystemError,
1820 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001821 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001822 return NULL;
1823 }
1824}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001825
Guido van Rossum32d34c82001-09-20 21:45:26 +00001826static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001827 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001828 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001829 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001830 {0},
1831};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001832
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001833static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001834drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001835{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001836 if (f->f_buf != NULL) {
1837 PyMem_Free(f->f_buf);
1838 f->f_buf = NULL;
1839 }
Guido van Rossum65967252001-04-21 13:20:18 +00001840}
1841
Tim Petersf1827cf2003-09-07 03:30:18 +00001842/* Make sure that file has a readahead buffer with at least one byte
1843 (unless at EOF) and no more than bufsize. Returns negative value on
Georg Brandled02eb62006-03-31 20:31:02 +00001844 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001845static int
1846readahead(PyFileObject *f, int bufsize)
1847{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001848 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001849
1850 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001851 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001852 return 0;
1853 else
1854 drop_readahead(f);
1855 }
Anthony Baxter377be112006-04-11 06:54:30 +00001856 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
Georg Brandled02eb62006-03-31 20:31:02 +00001857 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001858 return -1;
1859 }
1860 Py_BEGIN_ALLOW_THREADS
1861 errno = 0;
1862 chunksize = Py_UniversalNewlineFread(
1863 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1864 Py_END_ALLOW_THREADS
1865 if (chunksize == 0) {
1866 if (ferror(f->f_fp)) {
1867 PyErr_SetFromErrno(PyExc_IOError);
1868 clearerr(f->f_fp);
1869 drop_readahead(f);
1870 return -1;
1871 }
1872 }
1873 f->f_bufptr = f->f_buf;
1874 f->f_bufend = f->f_buf + chunksize;
1875 return 0;
1876}
1877
1878/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001879 uninitialized bytes followed by the remainder of the line. Don't be
1880 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001881 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1882
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001883static PyStringObject *
1884readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1885{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001886 PyStringObject* s;
1887 char *bufptr;
1888 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001889 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001890
1891 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001892 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001893 return NULL;
1894
1895 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001896 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001897 return (PyStringObject *)
1898 PyString_FromStringAndSize(NULL, skip);
Anthony Baxter377be112006-04-11 06:54:30 +00001899 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001900 if (bufptr != NULL) {
1901 bufptr++; /* Count the '\n' */
1902 len = bufptr - f->f_bufptr;
1903 s = (PyStringObject *)
1904 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001905 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001906 return NULL;
1907 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1908 f->f_bufptr = bufptr;
1909 if (bufptr == f->f_bufend)
1910 drop_readahead(f);
1911 } else {
1912 bufptr = f->f_bufptr;
1913 buf = f->f_buf;
1914 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001915 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001916 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001917 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001918 if (s == NULL) {
1919 PyMem_Free(buf);
1920 return NULL;
1921 }
1922 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1923 PyMem_Free(buf);
1924 }
1925 return s;
1926}
1927
1928/* A larger buffer size may actually decrease performance. */
1929#define READAHEAD_BUFSIZE 8192
1930
1931static PyObject *
1932file_iternext(PyFileObject *f)
1933{
1934 PyStringObject* l;
1935
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001936 if (f->f_fp == NULL)
1937 return err_closed();
1938
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001939 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1940 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1941 Py_XDECREF(l);
1942 return NULL;
1943 }
1944 return (PyObject *)l;
1945}
1946
1947
Tim Peters59c9a642001-09-13 05:38:56 +00001948static PyObject *
1949file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1950{
Tim Peters44410012001-09-14 03:26:08 +00001951 PyObject *self;
1952 static PyObject *not_yet_string;
1953
1954 assert(type != NULL && type->tp_alloc != NULL);
1955
1956 if (not_yet_string == NULL) {
1957 not_yet_string = PyString_FromString("<uninitialized file>");
1958 if (not_yet_string == NULL)
1959 return NULL;
1960 }
1961
1962 self = type->tp_alloc(type, 0);
1963 if (self != NULL) {
1964 /* Always fill in the name and mode, so that nobody else
1965 needs to special-case NULLs there. */
1966 Py_INCREF(not_yet_string);
1967 ((PyFileObject *)self)->f_name = not_yet_string;
1968 Py_INCREF(not_yet_string);
1969 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001970 Py_INCREF(Py_None);
1971 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001972 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001973 }
1974 return self;
1975}
1976
1977static int
1978file_init(PyObject *self, PyObject *args, PyObject *kwds)
1979{
1980 PyFileObject *foself = (PyFileObject *)self;
1981 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001982 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001983 char *name = NULL;
1984 char *mode = "r";
1985 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001986 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001987
1988 assert(PyFile_Check(self));
1989 if (foself->f_fp != NULL) {
1990 /* Have to close the existing file first. */
1991 PyObject *closeresult = file_close(foself);
1992 if (closeresult == NULL)
1993 return -1;
1994 Py_DECREF(closeresult);
1995 }
Tim Peters59c9a642001-09-13 05:38:56 +00001996
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001997#ifdef Py_WIN_WIDE_FILENAMES
1998 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
1999 PyObject *po;
2000 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
2001 kwlist, &po, &mode, &bufsize)) {
2002 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002003 if (fill_file_fields(foself, NULL, po, mode,
2004 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002005 goto Error;
2006 } else {
2007 /* Drop the argument parsing error as narrow
2008 strings are also valid. */
2009 PyErr_Clear();
2010 }
2011 }
2012#endif
2013
2014 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002015 PyObject *o_name;
2016
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002017 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2018 Py_FileSystemDefaultEncoding,
2019 &name,
2020 &mode, &bufsize))
2021 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002022
2023 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002024 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2025 kwlist, &o_name, &mode,
2026 &bufsize))
Neal Norwitzfe50f8e2006-09-05 04:32:06 +00002027 goto Error;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002028
2029 if (fill_file_fields(foself, NULL, o_name, mode,
2030 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002031 goto Error;
2032 }
Tim Peters44410012001-09-14 03:26:08 +00002033 if (open_the_file(foself, name, mode) == NULL)
2034 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002035 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002036 PyFile_SetBufSize(self, bufsize);
2037 goto Done;
2038
2039Error:
2040 ret = -1;
2041 /* fall through */
2042Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002043 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002044 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002045}
2046
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002047PyDoc_VAR(file_doc) =
2048PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002049"file(name[, mode[, buffering]]) -> file object\n"
2050"\n"
2051"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2052"writing or appending. The file will be created if it doesn't exist\n"
2053"when opened for writing or appending; it will be truncated when\n"
2054"opened for writing. Add a 'b' to the mode for binary files.\n"
2055"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2056"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002057"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002058)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002059PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002060"Add a 'U' to mode to open the file for input with universal newline\n"
2061"support. Any line ending in the input file will be seen as a '\\n'\n"
2062"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2063"the value for this attribute is one of None (no newline read yet),\n"
2064"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2065"\n"
2066"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002067);
Tim Peters59c9a642001-09-13 05:38:56 +00002068
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002069PyTypeObject PyFile_Type = {
2070 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002071 0,
2072 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002073 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002074 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002075 (destructor)file_dealloc, /* tp_dealloc */
2076 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002077 0, /* tp_getattr */
2078 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002079 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002080 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002081 0, /* tp_as_number */
2082 0, /* tp_as_sequence */
2083 0, /* tp_as_mapping */
2084 0, /* tp_hash */
2085 0, /* tp_call */
2086 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002087 PyObject_GenericGetAttr, /* tp_getattro */
Tim Peters015dd822003-05-04 04:16:52 +00002088 /* softspace is writable: we must supply tp_setattro */
2089 PyObject_GenericSetAttr, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002090 0, /* tp_as_buffer */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002091 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002092 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002093 0, /* tp_traverse */
2094 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002095 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002096 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002097 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002098 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002099 file_methods, /* tp_methods */
2100 file_memberlist, /* tp_members */
2101 file_getsetlist, /* tp_getset */
2102 0, /* tp_base */
2103 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002104 0, /* tp_descr_get */
2105 0, /* tp_descr_set */
2106 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002107 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002108 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002109 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002110 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002111};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002112
2113/* Interface for the 'soft space' between print items. */
2114
2115int
Fred Drakefd99de62000-07-09 05:02:18 +00002116PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00002117{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002118 long oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002119 if (f == NULL) {
2120 /* Do nothing */
2121 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002122 else if (PyFile_Check(f)) {
2123 oldflag = ((PyFileObject *)f)->f_softspace;
2124 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002125 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00002126 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002127 PyObject *v;
2128 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002129 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002130 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002131 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002132 if (PyInt_Check(v))
2133 oldflag = PyInt_AsLong(v);
Martin v. Löwis18e16552006-02-15 17:27:45 +00002134 assert(oldflag < INT_MAX);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002135 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002136 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002137 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002138 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002139 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002140 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002141 if (PyObject_SetAttrString(f, "softspace", v) != 0)
2142 PyErr_Clear();
2143 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002144 }
2145 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002146 return (int)oldflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002147}
Guido van Rossum3165fe61992-09-25 21:59:05 +00002148
2149/* Interfaces to write objects/strings to file-like objects */
2150
2151int
Fred Drakefd99de62000-07-09 05:02:18 +00002152PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002153{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002154 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002155 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002156 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002157 return -1;
2158 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002159 else if (PyFile_Check(f)) {
2160 FILE *fp = PyFile_AsFile(f);
Fred Drake086a0f72004-03-19 15:22:36 +00002161#ifdef Py_USING_UNICODE
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002162 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2163 int result;
Fred Drake086a0f72004-03-19 15:22:36 +00002164#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002165 if (fp == NULL) {
2166 err_closed();
2167 return -1;
2168 }
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002169#ifdef Py_USING_UNICODE
Tim Petersf1827cf2003-09-07 03:30:18 +00002170 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002171 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002172 char *cenc = PyString_AS_STRING(enc);
2173 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2174 if (value == NULL)
2175 return -1;
2176 } else {
2177 value = v;
2178 Py_INCREF(value);
2179 }
2180 result = PyObject_Print(value, fp, flags);
2181 Py_DECREF(value);
2182 return result;
2183#else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002184 return PyObject_Print(v, fp, flags);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002185#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002186 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002187 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002188 if (writer == NULL)
2189 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002190 if (flags & Py_PRINT_RAW) {
2191 if (PyUnicode_Check(v)) {
2192 value = v;
2193 Py_INCREF(value);
2194 } else
2195 value = PyObject_Str(v);
2196 }
2197 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002198 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002199 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002200 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002201 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002202 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002203 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002204 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002205 Py_DECREF(value);
2206 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002207 return -1;
2208 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002209 result = PyEval_CallObject(writer, args);
2210 Py_DECREF(args);
2211 Py_DECREF(value);
2212 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002213 if (result == NULL)
2214 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002215 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002216 return 0;
2217}
2218
Guido van Rossum27a60b11997-05-22 22:25:11 +00002219int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002220PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002221{
2222 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002223 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002224 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002225 PyErr_SetString(PyExc_SystemError,
2226 "null file for PyFile_WriteString");
2227 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002228 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002229 else if (PyFile_Check(f)) {
2230 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002231 if (fp == NULL) {
2232 err_closed();
2233 return -1;
2234 }
2235 fputs(s, fp);
2236 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002237 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002238 else if (!PyErr_Occurred()) {
2239 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002240 int err;
2241 if (v == NULL)
2242 return -1;
2243 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2244 Py_DECREF(v);
2245 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002246 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002247 else
2248 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002249}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002250
2251/* Try to get a file-descriptor from a Python object. If the object
2252 is an integer or long integer, its value is returned. If not, the
2253 object's fileno() method is called if it exists; the method must return
2254 an integer or long integer, which is returned as the file descriptor value.
2255 -1 is returned on failure.
2256*/
2257
2258int PyObject_AsFileDescriptor(PyObject *o)
2259{
2260 int fd;
2261 PyObject *meth;
2262
2263 if (PyInt_Check(o)) {
2264 fd = PyInt_AsLong(o);
2265 }
2266 else if (PyLong_Check(o)) {
2267 fd = PyLong_AsLong(o);
2268 }
2269 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2270 {
2271 PyObject *fno = PyEval_CallObject(meth, NULL);
2272 Py_DECREF(meth);
2273 if (fno == NULL)
2274 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002275
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002276 if (PyInt_Check(fno)) {
2277 fd = PyInt_AsLong(fno);
2278 Py_DECREF(fno);
2279 }
2280 else if (PyLong_Check(fno)) {
2281 fd = PyLong_AsLong(fno);
2282 Py_DECREF(fno);
2283 }
2284 else {
2285 PyErr_SetString(PyExc_TypeError,
2286 "fileno() returned a non-integer");
2287 Py_DECREF(fno);
2288 return -1;
2289 }
2290 }
2291 else {
2292 PyErr_SetString(PyExc_TypeError,
2293 "argument must be an int, or have a fileno() method.");
2294 return -1;
2295 }
2296
2297 if (fd < 0) {
2298 PyErr_Format(PyExc_ValueError,
2299 "file descriptor cannot be a negative integer (%i)",
2300 fd);
2301 return -1;
2302 }
2303 return fd;
2304}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002305
Jack Jansen7b8c7542002-04-14 20:12:41 +00002306/* From here on we need access to the real fgets and fread */
2307#undef fgets
2308#undef fread
2309
2310/*
2311** Py_UniversalNewlineFgets is an fgets variation that understands
2312** all of \r, \n and \r\n conventions.
2313** The stream should be opened in binary mode.
2314** If fobj is NULL the routine always does newline conversion, and
2315** it may peek one char ahead to gobble the second char in \r\n.
2316** If fobj is non-NULL it must be a PyFileObject. In this case there
2317** is no readahead but in stead a flag is used to skip a following
2318** \n on the next read. Also, if the file is open in binary mode
2319** the whole conversion is skipped. Finally, the routine keeps track of
2320** the different types of newlines seen.
2321** Note that we need no error handling: fgets() treats error and eof
2322** identically.
2323*/
2324char *
2325Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2326{
2327 char *p = buf;
2328 int c;
2329 int newlinetypes = 0;
2330 int skipnextlf = 0;
2331 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002332
Jack Jansen7b8c7542002-04-14 20:12:41 +00002333 if (fobj) {
2334 if (!PyFile_Check(fobj)) {
2335 errno = ENXIO; /* What can you do... */
2336 return NULL;
2337 }
2338 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2339 if ( !univ_newline )
2340 return fgets(buf, n, stream);
2341 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2342 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2343 }
2344 FLOCKFILE(stream);
2345 c = 'x'; /* Shut up gcc warning */
2346 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2347 if (skipnextlf ) {
2348 skipnextlf = 0;
2349 if (c == '\n') {
2350 /* Seeing a \n here with skipnextlf true
2351 ** means we saw a \r before.
2352 */
2353 newlinetypes |= NEWLINE_CRLF;
2354 c = GETC(stream);
2355 if (c == EOF) break;
2356 } else {
2357 /*
2358 ** Note that c == EOF also brings us here,
2359 ** so we're okay if the last char in the file
2360 ** is a CR.
2361 */
2362 newlinetypes |= NEWLINE_CR;
2363 }
2364 }
2365 if (c == '\r') {
2366 /* A \r is translated into a \n, and we skip
2367 ** an adjacent \n, if any. We don't set the
2368 ** newlinetypes flag until we've seen the next char.
2369 */
2370 skipnextlf = 1;
2371 c = '\n';
2372 } else if ( c == '\n') {
2373 newlinetypes |= NEWLINE_LF;
2374 }
2375 *p++ = c;
2376 if (c == '\n') break;
2377 }
2378 if ( c == EOF && skipnextlf )
2379 newlinetypes |= NEWLINE_CR;
2380 FUNLOCKFILE(stream);
2381 *p = '\0';
2382 if (fobj) {
2383 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2384 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2385 } else if ( skipnextlf ) {
2386 /* If we have no file object we cannot save the
2387 ** skipnextlf flag. We have to readahead, which
2388 ** will cause a pause if we're reading from an
2389 ** interactive stream, but that is very unlikely
2390 ** unless we're doing something silly like
2391 ** execfile("/dev/tty").
2392 */
2393 c = GETC(stream);
2394 if ( c != '\n' )
2395 ungetc(c, stream);
2396 }
2397 if (p == buf)
2398 return NULL;
2399 return buf;
2400}
2401
2402/*
2403** Py_UniversalNewlineFread is an fread variation that understands
2404** all of \r, \n and \r\n conventions.
2405** The stream should be opened in binary mode.
2406** fobj must be a PyFileObject. In this case there
2407** is no readahead but in stead a flag is used to skip a following
2408** \n on the next read. Also, if the file is open in binary mode
2409** the whole conversion is skipped. Finally, the routine keeps track of
2410** the different types of newlines seen.
2411*/
2412size_t
Tim Peters058b1412002-04-21 07:29:14 +00002413Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002414 FILE *stream, PyObject *fobj)
2415{
Tim Peters058b1412002-04-21 07:29:14 +00002416 char *dst = buf;
2417 PyFileObject *f = (PyFileObject *)fobj;
2418 int newlinetypes, skipnextlf;
2419
2420 assert(buf != NULL);
2421 assert(stream != NULL);
2422
Jack Jansen7b8c7542002-04-14 20:12:41 +00002423 if (!fobj || !PyFile_Check(fobj)) {
2424 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002425 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002426 }
Tim Peters058b1412002-04-21 07:29:14 +00002427 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002428 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002429 newlinetypes = f->f_newlinetypes;
2430 skipnextlf = f->f_skipnextlf;
2431 /* Invariant: n is the number of bytes remaining to be filled
2432 * in the buffer.
2433 */
2434 while (n) {
2435 size_t nread;
2436 int shortread;
2437 char *src = dst;
2438
2439 nread = fread(dst, 1, n, stream);
2440 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002441 if (nread == 0)
2442 break;
2443
Tim Peterse1682a82002-04-21 18:15:20 +00002444 n -= nread; /* assuming 1 byte out for each in; will adjust */
2445 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002446 while (nread--) {
2447 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002448 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002449 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002450 *dst++ = '\n';
2451 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002452 }
2453 else if (skipnextlf && c == '\n') {
2454 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002455 skipnextlf = 0;
2456 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002457 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002458 }
2459 else {
2460 /* Normal char to be stored in buffer. Also
2461 * update the newlinetypes flag if either this
2462 * is an LF or the previous char was a CR.
2463 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002464 if (c == '\n')
2465 newlinetypes |= NEWLINE_LF;
2466 else if (skipnextlf)
2467 newlinetypes |= NEWLINE_CR;
2468 *dst++ = c;
2469 skipnextlf = 0;
2470 }
2471 }
Tim Peters058b1412002-04-21 07:29:14 +00002472 if (shortread) {
2473 /* If this is EOF, update type flags. */
2474 if (skipnextlf && feof(stream))
2475 newlinetypes |= NEWLINE_CR;
2476 break;
2477 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002478 }
Tim Peters058b1412002-04-21 07:29:14 +00002479 f->f_newlinetypes = newlinetypes;
2480 f->f_skipnextlf = skipnextlf;
2481 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002482}
Anthony Baxterac6bd462006-04-13 02:06:09 +00002483
2484#ifdef __cplusplus
2485}
2486#endif