blob: 7c8e2b2e01ce69f3e6ae1cba3d300afe9b905d13 [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
Thomas Wouters0e3f5912006-08-11 14:57:12 +00007#ifdef HAVE_SYS_TYPES_H
Guido van Rossum41498431999-01-07 22:09:51 +00008#include <sys/types.h>
Thomas Wouters0e3f5912006-08-11 14:57:12 +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
Thomas Wouters49fd7fa2006-04-21 10:40:58 +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{
Thomas Wouters0e3f5912006-08-11 14:57:12 +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
Thomas Wouters0e3f5912006-08-11 14:57:12 +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;
Tim Peters59c9a642001-09-13 05:38:56 +0000121 f->f_binary = strchr(mode,'b') != NULL;
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000122 f->f_buf = NULL;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000123 f->f_univ_newline = (strchr(mode, 'U') != NULL);
124 f->f_newlinetypes = NEWLINE_UNKNOWN;
125 f->f_skipnextlf = 0;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000126 Py_INCREF(Py_None);
127 f->f_encoding = Py_None;
Tim Petersf1827cf2003-09-07 03:30:18 +0000128
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000129 if (f->f_mode == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000130 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000131 f->f_fp = fp;
Neil Schemenauered19b882002-03-23 02:06:50 +0000132 f = dircheck(f);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000133 return (PyObject *) f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000134}
135
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000136/* check for known incorrect mode strings - problem is, platforms are
137 free to accept any mode characters they like and are supposed to
138 ignore stuff they don't understand... write or append mode with
Thomas Wouters477c8d52006-05-27 19:21:47 +0000139 universal newline support is expressly forbidden by PEP 278.
140 Additionally, remove the 'U' from the mode string as platforms
Guido van Rossumd8faa362007-04-27 19:54:29 +0000141 won't know what it is. Non-zero return signals an exception */
142int
143_PyFile_SanitizeMode(char *mode)
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000144{
Thomas Wouters477c8d52006-05-27 19:21:47 +0000145 char *upos;
Neal Norwitz76dc0812006-01-08 06:13:13 +0000146 size_t len = strlen(mode);
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000147
Thomas Wouters477c8d52006-05-27 19:21:47 +0000148 if (!len) {
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000149 PyErr_SetString(PyExc_ValueError, "empty mode string");
Guido van Rossumd8faa362007-04-27 19:54:29 +0000150 return -1;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000151 }
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000152
Thomas Wouters477c8d52006-05-27 19:21:47 +0000153 upos = strchr(mode, 'U');
154 if (upos) {
155 memmove(upos, upos+1, len-(upos-mode)); /* incl null char */
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000156
Thomas Wouters477c8d52006-05-27 19:21:47 +0000157 if (mode[0] == 'w' || mode[0] == 'a') {
158 PyErr_Format(PyExc_ValueError, "universal newline "
159 "mode can only be used with modes "
160 "starting with 'r'");
Guido van Rossumd8faa362007-04-27 19:54:29 +0000161 return -1;
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000162 }
Thomas Wouters477c8d52006-05-27 19:21:47 +0000163
164 if (mode[0] != 'r') {
165 memmove(mode+1, mode, strlen(mode)+1);
166 mode[0] = 'r';
167 }
168
169 if (!strchr(mode, 'b')) {
170 memmove(mode+2, mode+1, strlen(mode));
171 mode[1] = 'b';
172 }
173 } else if (mode[0] != 'r' && mode[0] != 'w' && mode[0] != 'a') {
174 PyErr_Format(PyExc_ValueError, "mode string must begin with "
175 "one of 'r', 'w', 'a' or 'U', not '%.200s'", mode);
Guido van Rossumd8faa362007-04-27 19:54:29 +0000176 return -1;
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000177 }
178
179 return 0;
180}
181
Tim Peters59c9a642001-09-13 05:38:56 +0000182static PyObject *
183open_the_file(PyFileObject *f, char *name, char *mode)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000184{
Thomas Wouters477c8d52006-05-27 19:21:47 +0000185 char *newmode;
Tim Peters59c9a642001-09-13 05:38:56 +0000186 assert(f != NULL);
187 assert(PyFile_Check(f));
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000188#ifdef MS_WINDOWS
189 /* windows ignores the passed name in order to support Unicode */
190 assert(f->f_name != NULL);
191#else
Tim Peters59c9a642001-09-13 05:38:56 +0000192 assert(name != NULL);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000193#endif
Tim Peters59c9a642001-09-13 05:38:56 +0000194 assert(mode != NULL);
Tim Peters44410012001-09-14 03:26:08 +0000195 assert(f->f_fp == NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000196
Thomas Wouters477c8d52006-05-27 19:21:47 +0000197 /* probably need to replace 'U' by 'rb' */
198 newmode = PyMem_MALLOC(strlen(mode) + 3);
199 if (!newmode) {
200 PyErr_NoMemory();
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000201 return NULL;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000202 }
203 strcpy(newmode, mode);
204
Guido van Rossumd8faa362007-04-27 19:54:29 +0000205 if (_PyFile_SanitizeMode(newmode)) {
Thomas Wouters477c8d52006-05-27 19:21:47 +0000206 f = NULL;
207 goto cleanup;
208 }
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000209
Tim Petersa27a1502001-11-09 20:59:14 +0000210 errno = 0;
Skip Montanaro51ffac62004-06-11 04:49:03 +0000211
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000212#ifdef MS_WINDOWS
Skip Montanaro51ffac62004-06-11 04:49:03 +0000213 if (PyUnicode_Check(f->f_name)) {
214 PyObject *wmode;
Thomas Wouters477c8d52006-05-27 19:21:47 +0000215 wmode = PyUnicode_DecodeASCII(newmode, strlen(newmode), NULL);
Skip Montanaro51ffac62004-06-11 04:49:03 +0000216 if (f->f_name && wmode) {
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000217 Py_BEGIN_ALLOW_THREADS
Skip Montanaro51ffac62004-06-11 04:49:03 +0000218 /* PyUnicode_AS_UNICODE OK without thread
219 lock as it is a simple dereference. */
220 f->f_fp = _wfopen(PyUnicode_AS_UNICODE(f->f_name),
221 PyUnicode_AS_UNICODE(wmode));
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000222 Py_END_ALLOW_THREADS
223 }
Skip Montanaro51ffac62004-06-11 04:49:03 +0000224 Py_XDECREF(wmode);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000225 }
Skip Montanaro51ffac62004-06-11 04:49:03 +0000226#endif
227 if (NULL == f->f_fp && NULL != name) {
228 Py_BEGIN_ALLOW_THREADS
Thomas Wouters477c8d52006-05-27 19:21:47 +0000229 f->f_fp = fopen(name, newmode);
Skip Montanaro51ffac62004-06-11 04:49:03 +0000230 Py_END_ALLOW_THREADS
231 }
232
Guido van Rossuma08095a1991-02-13 23:25:27 +0000233 if (f->f_fp == NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000234#if defined _MSC_VER && (_MSC_VER < 1400 || !defined(__STDC_SECURE_LIB__))
Tim Peters2ea91112002-04-08 04:13:12 +0000235 /* MSVC 6 (Microsoft) leaves errno at 0 for bad mode strings,
236 * across all Windows flavors. When it sets EINVAL varies
237 * across Windows flavors, the exact conditions aren't
238 * documented, and the answer lies in the OS's implementation
239 * of Win32's CreateFile function (whose source is secret).
240 * Seems the best we can do is map EINVAL to ENOENT.
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000241 * Starting with Visual Studio .NET 2005, EINVAL is correctly
242 * set by our CRT error handler (set in exceptions.c.)
Tim Peters2ea91112002-04-08 04:13:12 +0000243 */
244 if (errno == 0) /* bad mode string */
245 errno = EINVAL;
246 else if (errno == EINVAL) /* unknown, but not a mode string */
247 errno = ENOENT;
248#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000249 if (errno == EINVAL)
Tim Peters2ea91112002-04-08 04:13:12 +0000250 PyErr_Format(PyExc_IOError, "invalid mode: %s",
Jeremy Hylton41c83212001-11-09 16:17:24 +0000251 mode);
252 else
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000253 PyErr_SetFromErrnoWithFilenameObject(PyExc_IOError, f->f_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000254 f = NULL;
255 }
Tim Peters2ea91112002-04-08 04:13:12 +0000256 if (f != NULL)
Neil Schemenauered19b882002-03-23 02:06:50 +0000257 f = dircheck(f);
Thomas Wouters477c8d52006-05-27 19:21:47 +0000258
259cleanup:
260 PyMem_FREE(newmode);
261
Tim Peters59c9a642001-09-13 05:38:56 +0000262 return (PyObject *)f;
263}
264
265PyObject *
266PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
267{
Tim Peters44410012001-09-14 03:26:08 +0000268 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
269 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000270 if (f != NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000271 PyObject *o_name = PyString_FromString(name);
272 if (o_name == NULL)
273 return NULL;
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000274 if (fill_file_fields(f, fp, o_name, mode, close) == NULL) {
Tim Peters59c9a642001-09-13 05:38:56 +0000275 Py_DECREF(f);
276 f = NULL;
277 }
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000278 Py_DECREF(o_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000279 }
280 return (PyObject *) f;
281}
282
283PyObject *
284PyFile_FromString(char *name, char *mode)
285{
286 extern int fclose(FILE *);
287 PyFileObject *f;
288
289 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
290 if (f != NULL) {
291 if (open_the_file(f, name, mode) == NULL) {
292 Py_DECREF(f);
293 f = NULL;
294 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000295 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000296 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000297}
298
Guido van Rossumb6775db1994-08-01 11:34:53 +0000299void
Fred Drakefd99de62000-07-09 05:02:18 +0000300PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000301{
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000302 PyFileObject *file = (PyFileObject *)f;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000303 if (bufsize >= 0) {
Guido van Rossumb6775db1994-08-01 11:34:53 +0000304 int type;
305 switch (bufsize) {
306 case 0:
307 type = _IONBF;
308 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000309#ifdef HAVE_SETVBUF
Guido van Rossumb6775db1994-08-01 11:34:53 +0000310 case 1:
311 type = _IOLBF;
312 bufsize = BUFSIZ;
313 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000314#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000315 default:
316 type = _IOFBF;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000317#ifndef HAVE_SETVBUF
318 bufsize = BUFSIZ;
319#endif
320 break;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000321 }
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000322 fflush(file->f_fp);
323 if (type == _IONBF) {
324 PyMem_Free(file->f_setbuf);
325 file->f_setbuf = NULL;
326 } else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000327 file->f_setbuf = (char *)PyMem_Realloc(file->f_setbuf,
328 bufsize);
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000329 }
330#ifdef HAVE_SETVBUF
331 setvbuf(file->f_fp, file->f_setbuf, type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000332#else /* !HAVE_SETVBUF */
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000333 setbuf(file->f_fp, file->f_setbuf);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000334#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000335 }
336}
337
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000338/* Set the encoding used to output Unicode strings.
339 Returh 1 on success, 0 on failure. */
340
341int
342PyFile_SetEncoding(PyObject *f, const char *enc)
343{
344 PyFileObject *file = (PyFileObject*)f;
345 PyObject *str = PyString_FromString(enc);
Thomas Woutersb2137042007-02-01 18:02:27 +0000346
347 assert(PyFile_Check(f));
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000348 if (!str)
349 return 0;
350 Py_DECREF(file->f_encoding);
351 file->f_encoding = str;
352 return 1;
353}
354
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000355static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000356err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000357{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000358 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000359 return NULL;
360}
361
Thomas Woutersc45251a2006-02-12 11:53:32 +0000362/* Refuse regular file I/O if there's data in the iteration-buffer.
363 * Mixing them would cause data to arrive out of order, as the read*
364 * methods don't use the iteration buffer. */
365static PyObject *
366err_iterbuffered(void)
367{
368 PyErr_SetString(PyExc_ValueError,
369 "Mixing iteration and read methods would lose data");
370 return NULL;
371}
372
Neal Norwitzd8b995f2002-08-06 21:50:54 +0000373static void drop_readahead(PyFileObject *);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000374
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000375/* Methods */
376
377static void
Fred Drakefd99de62000-07-09 05:02:18 +0000378file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000379{
Peter Astrandf8e74b12004-11-07 14:15:28 +0000380 int sts = 0;
Raymond Hettingercb87bc82004-05-31 00:35:52 +0000381 if (f->weakreflist != NULL)
382 PyObject_ClearWeakRefs((PyObject *) f);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000383 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000384 Py_BEGIN_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000385 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000386 Py_END_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000387 if (sts == EOF)
388#ifdef HAVE_STRERROR
389 PySys_WriteStderr("close failed: [Errno %d] %s\n", errno, strerror(errno));
390#else
391 PySys_WriteStderr("close failed: [Errno %d]\n", errno);
392#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000393 }
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000394 PyMem_Free(f->f_setbuf);
Tim Peters44410012001-09-14 03:26:08 +0000395 Py_XDECREF(f->f_name);
396 Py_XDECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000397 Py_XDECREF(f->f_encoding);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000398 drop_readahead(f);
Guido van Rossum9475a232001-10-05 20:51:39 +0000399 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000400}
401
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000402static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000403file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000404{
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000405 if (PyUnicode_Check(f->f_name)) {
406 PyObject *ret = NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000407 PyObject *name = PyUnicode_AsUnicodeEscapeString(f->f_name);
408 const char *name_str = name ? PyString_AsString(name) : "?";
Walter Dörwald1ab83302007-05-18 17:15:44 +0000409 ret = PyUnicode_FromFormat("<%s file u'%s', mode '%s' at %p>",
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000410 f->f_fp == NULL ? "closed" : "open",
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000411 name_str,
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000412 PyString_AsString(f->f_mode),
413 f);
414 Py_XDECREF(name);
415 return ret;
416 } else {
Walter Dörwald1ab83302007-05-18 17:15:44 +0000417 return PyUnicode_FromFormat("<%s file '%s', mode '%s' at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000418 f->f_fp == NULL ? "closed" : "open",
419 PyString_AsString(f->f_name),
420 PyString_AsString(f->f_mode),
421 f);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000422 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000423}
424
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000425static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000426file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000427{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000428 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000429 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000430 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000431 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000432 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000433 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000434 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000435 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000436 f->f_fp = NULL;
437 }
Martin v. Löwis7bbcde72003-09-07 20:42:29 +0000438 PyMem_Free(f->f_setbuf);
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000439 f->f_setbuf = NULL;
Guido van Rossumfebd5511992-03-04 16:39:24 +0000440 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000441 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000442 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000443 return PyInt_FromLong((long)sts);
444 Py_INCREF(Py_None);
445 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000446}
447
Trent Mickf29f47b2000-08-11 19:02:59 +0000448
Guido van Rossumb8552162001-09-05 14:58:11 +0000449/* Our very own off_t-like type, 64-bit if possible */
450#if !defined(HAVE_LARGEFILE_SUPPORT)
451typedef off_t Py_off_t;
452#elif SIZEOF_OFF_T >= 8
453typedef off_t Py_off_t;
454#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000455typedef fpos_t Py_off_t;
456#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000457#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000458#endif
459
460
Trent Mickf29f47b2000-08-11 19:02:59 +0000461/* a portable fseek() function
462 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000463static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000464_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000465{
Guido van Rossumb8552162001-09-05 14:58:11 +0000466#if !defined(HAVE_LARGEFILE_SUPPORT)
467 return fseek(fp, offset, whence);
468#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000469 return fseeko(fp, offset, whence);
470#elif defined(HAVE_FSEEK64)
471 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000472#elif defined(__BEOS__)
473 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000474#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000475 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
476 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000477 fpos_t pos;
478 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000479 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000480#ifdef MS_WINDOWS
481 fflush(fp);
482 if (_lseeki64(fileno(fp), 0, 2) == -1)
483 return -1;
484#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000485 if (fseek(fp, 0, SEEK_END) != 0)
486 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000487#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000488 /* fall through */
489 case SEEK_CUR:
490 if (fgetpos(fp, &pos) != 0)
491 return -1;
492 offset += pos;
493 break;
494 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000495 }
496 return fsetpos(fp, &offset);
497#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000498#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000499#endif
500}
501
502
503/* a portable ftell() function
504 Return -1 on failure with errno set appropriately, current file
505 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000506static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000507_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000508{
Guido van Rossumb8552162001-09-05 14:58:11 +0000509#if !defined(HAVE_LARGEFILE_SUPPORT)
510 return ftell(fp);
511#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
512 return ftello(fp);
513#elif defined(HAVE_FTELL64)
514 return ftell64(fp);
515#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000516 fpos_t pos;
517 if (fgetpos(fp, &pos) != 0)
518 return -1;
519 return pos;
520#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000521#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000522#endif
523}
524
525
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000526static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000527file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000528{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000529 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000530 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000531 Py_off_t offset;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000532 PyObject *offobj, *off_index;
Tim Peters86821b22001-01-07 21:19:34 +0000533
Guido van Rossumd7297e61992-07-06 14:19:26 +0000534 if (f->f_fp == NULL)
535 return err_closed();
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000536 drop_readahead(f);
Guido van Rossumd7297e61992-07-06 14:19:26 +0000537 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000538 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000539 return NULL;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000540 off_index = PyNumber_Index(offobj);
541 if (!off_index) {
542 if (!PyFloat_Check(offobj))
543 return NULL;
544 /* Deprecated in 2.6 */
545 PyErr_Clear();
546 if (PyErr_Warn(PyExc_DeprecationWarning,
547 "integer argument expected, got float"))
548 return NULL;
549 off_index = offobj;
550 Py_INCREF(offobj);
551 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000552#if !defined(HAVE_LARGEFILE_SUPPORT)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000553 offset = PyInt_AsLong(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000554#else
Thomas Wouters89f507f2006-12-13 04:49:30 +0000555 offset = PyLong_Check(off_index) ?
556 PyLong_AsLongLong(off_index) : PyInt_AsLong(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000557#endif
Thomas Wouters89f507f2006-12-13 04:49:30 +0000558 Py_DECREF(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000559 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000560 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000561
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000562 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000563 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000564 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000565 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000566
Guido van Rossumff4949e1992-08-05 19:58:53 +0000567 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000568 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000569 clearerr(f->f_fp);
570 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000571 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000572 f->f_skipnextlf = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000573 Py_INCREF(Py_None);
574 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000575}
576
Trent Mickf29f47b2000-08-11 19:02:59 +0000577
Guido van Rossumd7047b31995-01-02 19:07:15 +0000578#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000579static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000580file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000581{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000582 Py_off_t newsize;
Tim Petersf1827cf2003-09-07 03:30:18 +0000583 PyObject *newsizeobj = NULL;
584 Py_off_t initialpos;
585 int ret;
Tim Peters86821b22001-01-07 21:19:34 +0000586
Guido van Rossumd7047b31995-01-02 19:07:15 +0000587 if (f->f_fp == NULL)
588 return err_closed();
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000589 if (!PyArg_UnpackTuple(args, "truncate", 0, 1, &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000590 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000591
Tim Petersf1827cf2003-09-07 03:30:18 +0000592 /* Get current file position. If the file happens to be open for
593 * update and the last operation was an input operation, C doesn't
594 * define what the later fflush() will do, but we promise truncate()
595 * won't change the current position (and fflush() *does* change it
596 * then at least on Windows). The easiest thing is to capture
597 * current pos now and seek back to it at the end.
598 */
599 Py_BEGIN_ALLOW_THREADS
600 errno = 0;
601 initialpos = _portable_ftell(f->f_fp);
602 Py_END_ALLOW_THREADS
603 if (initialpos == -1)
604 goto onioerror;
605
Tim Petersfb05db22002-03-11 00:24:00 +0000606 /* Set newsize to current postion if newsizeobj NULL, else to the
Tim Petersf1827cf2003-09-07 03:30:18 +0000607 * specified value.
608 */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000609 if (newsizeobj != NULL) {
610#if !defined(HAVE_LARGEFILE_SUPPORT)
611 newsize = PyInt_AsLong(newsizeobj);
612#else
613 newsize = PyLong_Check(newsizeobj) ?
614 PyLong_AsLongLong(newsizeobj) :
615 PyInt_AsLong(newsizeobj);
616#endif
617 if (PyErr_Occurred())
618 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000619 }
Tim Petersf1827cf2003-09-07 03:30:18 +0000620 else /* default to current position */
621 newsize = initialpos;
Tim Petersfb05db22002-03-11 00:24:00 +0000622
Tim Petersf1827cf2003-09-07 03:30:18 +0000623 /* Flush the stream. We're mixing stream-level I/O with lower-level
624 * I/O, and a flush may be necessary to synch both platform views
625 * of the current file state.
626 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000627 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000628 errno = 0;
629 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000630 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000631 if (ret != 0)
632 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000633
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000634#ifdef MS_WINDOWS
Tim Petersfb05db22002-03-11 00:24:00 +0000635 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000636 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000637 {
Tim Petersfb05db22002-03-11 00:24:00 +0000638 HANDLE hFile;
Tim Petersfb05db22002-03-11 00:24:00 +0000639
Tim Petersf1827cf2003-09-07 03:30:18 +0000640 /* Have to move current pos to desired endpoint on Windows. */
641 Py_BEGIN_ALLOW_THREADS
642 errno = 0;
643 ret = _portable_fseek(f->f_fp, newsize, SEEK_SET) != 0;
644 Py_END_ALLOW_THREADS
645 if (ret)
646 goto onioerror;
Tim Petersfb05db22002-03-11 00:24:00 +0000647
Tim Peters8f01b682002-03-12 03:04:44 +0000648 /* Truncate. Note that this may grow the file! */
649 Py_BEGIN_ALLOW_THREADS
650 errno = 0;
651 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
Tim Petersf1827cf2003-09-07 03:30:18 +0000652 ret = hFile == (HANDLE)-1;
653 if (ret == 0) {
654 ret = SetEndOfFile(hFile) == 0;
655 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000656 errno = EACCES;
657 }
658 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000659 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000660 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000661 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000662#else
663 Py_BEGIN_ALLOW_THREADS
664 errno = 0;
665 ret = ftruncate(fileno(f->f_fp), newsize);
666 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000667 if (ret != 0)
668 goto onioerror;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000669#endif /* !MS_WINDOWS */
Tim Peters86821b22001-01-07 21:19:34 +0000670
Tim Petersf1827cf2003-09-07 03:30:18 +0000671 /* Restore original file position. */
672 Py_BEGIN_ALLOW_THREADS
673 errno = 0;
674 ret = _portable_fseek(f->f_fp, initialpos, SEEK_SET) != 0;
675 Py_END_ALLOW_THREADS
676 if (ret)
677 goto onioerror;
678
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000679 Py_INCREF(Py_None);
680 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000681
682onioerror:
683 PyErr_SetFromErrno(PyExc_IOError);
684 clearerr(f->f_fp);
685 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000686}
687#endif /* HAVE_FTRUNCATE */
688
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000689static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000690file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000691{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000692 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000693
Guido van Rossumd7297e61992-07-06 14:19:26 +0000694 if (f->f_fp == NULL)
695 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000696 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000697 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000698 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000699 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000700 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000701 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000702 clearerr(f->f_fp);
703 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000704 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000705 if (f->f_skipnextlf) {
706 int c;
707 c = GETC(f->f_fp);
708 if (c == '\n') {
709 pos++;
710 f->f_skipnextlf = 0;
711 } else if (c != EOF) ungetc(c, f->f_fp);
712 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000713#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000714 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000715#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000716 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000717#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000718}
719
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000720static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000721file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000722{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000723 if (f->f_fp == NULL)
724 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000725 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000726}
727
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000728static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000729file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000730{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000731 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000732
Guido van Rossumd7297e61992-07-06 14:19:26 +0000733 if (f->f_fp == NULL)
734 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000735 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000736 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000737 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000738 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000739 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000740 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000741 clearerr(f->f_fp);
742 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000743 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000744 Py_INCREF(Py_None);
745 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000746}
747
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000748static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000749file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000750{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000751 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000752 if (f->f_fp == NULL)
753 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000754 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000755 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000756 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000757 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000758}
759
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000760
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000761#if BUFSIZ < 8192
762#define SMALLCHUNK 8192
763#else
764#define SMALLCHUNK BUFSIZ
765#endif
766
Guido van Rossum3c259041999-01-14 19:00:14 +0000767#if SIZEOF_INT < 4
768#define BIGCHUNK (512 * 32)
769#else
770#define BIGCHUNK (512 * 1024)
771#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000772
773static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000774new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000775{
776#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000777 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000778 struct stat st;
779 if (fstat(fileno(f->f_fp), &st) == 0) {
780 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000781 /* The following is not a bug: we really need to call lseek()
782 *and* ftell(). The reason is that some stdio libraries
783 mistakenly flush their buffer when ftell() is called and
784 the lseek() call it makes fails, thereby throwing away
785 data that cannot be recovered in any way. To avoid this,
786 we first test lseek(), and only call ftell() if lseek()
787 works. We can't use the lseek() value either, because we
788 need to take the amount of buffered data into account.
789 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000790 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000791 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000792 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000793 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000794 if (pos < 0)
795 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000796 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000797 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000798 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000799 }
800#endif
801 if (currentsize > SMALLCHUNK) {
802 /* Keep doubling until we reach BIGCHUNK;
803 then keep adding BIGCHUNK. */
804 if (currentsize <= BIGCHUNK)
805 return currentsize + currentsize;
806 else
807 return currentsize + BIGCHUNK;
808 }
809 return currentsize + SMALLCHUNK;
810}
811
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000812#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
813#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
814#else
815#ifdef EWOULDBLOCK
816#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
817#else
818#ifdef EAGAIN
819#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
820#else
821#define BLOCKED_ERRNO(x) 0
822#endif
823#endif
824#endif
825
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000826static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000827file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000828{
Guido van Rossum789a1611997-05-10 22:33:55 +0000829 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000830 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000831 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000832
Guido van Rossumd7297e61992-07-06 14:19:26 +0000833 if (f->f_fp == NULL)
834 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000835 /* refuse to mix with f.next() */
836 if (f->f_buf != NULL &&
837 (f->f_bufend - f->f_bufptr) > 0 &&
838 f->f_buf[0] != '\0')
839 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000840 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000841 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000842 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000843 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000844 else
845 buffersize = bytesrequested;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000846 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000847 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000848 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000849 return NULL;
850 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000851 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000852 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000853 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000854 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000855 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000856 Py_BEGIN_ALLOW_THREADS
857 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000858 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000859 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000860 Py_END_ALLOW_THREADS
861 if (chunksize == 0) {
862 if (!ferror(f->f_fp))
863 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000864 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000865 /* When in non-blocking mode, data shouldn't
866 * be discarded if a blocking signal was
867 * received. That will also happen if
868 * chunksize != 0, but bytesread < buffersize. */
869 if (bytesread > 0 && BLOCKED_ERRNO(errno))
870 break;
871 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum6263d541997-05-10 22:07:25 +0000872 Py_DECREF(v);
873 return NULL;
874 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000875 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000876 if (bytesread < buffersize) {
877 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000878 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000879 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000880 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000881 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000882 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000883 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000884 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000885 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000886 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000887 }
888 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000889 if (bytesread != buffersize)
890 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000891 return v;
892}
893
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000894static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000895file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000896{
897 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000898 Py_ssize_t ntodo;
899 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000900
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000901 if (f->f_fp == NULL)
902 return err_closed();
Guido van Rossumd624f182006-04-24 13:47:05 +0000903 if (!f->f_binary) {
904 PyErr_SetString(PyExc_TypeError,
905 "readinto() requires binary mode");
906 return NULL;
907 }
Thomas Woutersc45251a2006-02-12 11:53:32 +0000908 /* refuse to mix with f.next() */
909 if (f->f_buf != NULL &&
910 (f->f_bufend - f->f_bufptr) > 0 &&
911 f->f_buf[0] != '\0')
912 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000913 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000914 return NULL;
915 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000916 while (ntodo > 0) {
917 Py_BEGIN_ALLOW_THREADS
918 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000919 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000920 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000921 Py_END_ALLOW_THREADS
922 if (nnow == 0) {
923 if (!ferror(f->f_fp))
924 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000925 PyErr_SetFromErrno(PyExc_IOError);
926 clearerr(f->f_fp);
927 return NULL;
928 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000929 ndone += nnow;
930 ntodo -= nnow;
931 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000932 return PyInt_FromSsize_t(ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000933}
934
Tim Peters86821b22001-01-07 21:19:34 +0000935/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000936Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000937
938Under MSVC 6:
939
Tim Peters1c733232001-01-08 04:02:07 +0000940+ MS threadsafe getc is very slow (multiple layers of function calls before+
941 after each character, to lock+unlock the stream).
942+ The stream-locking functions are MS-internal -- can't access them from user
943 code.
944+ There's nothing Tim could find in the MS C or platform SDK libraries that
945 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000946+ MS fgets locks/unlocks only once per line; it's the only hook we have.
947
948So we use fgets for speed(!), despite that it's painful.
949
950MS realloc is also slow.
951
Tim Petersf29b64d2001-01-15 06:33:19 +0000952Reports from other platforms on this method vs getc_unlocked (which MS doesn't
953have):
954 Linux a wash
955 Solaris a wash
956 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000957
Tim Petersf29b64d2001-01-15 06:33:19 +0000958CAUTION: The C std isn't clear about this: in those cases where fgets
959writes something into the buffer, can it write into any position beyond the
960required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
961known on which it does; and it would be a strange way to code fgets. Still,
962getline_via_fgets may not work correctly if it does. The std test
963test_bufio.py should fail if platform fgets() routinely writes beyond the
964trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000965**************************************************************************/
966
Tim Petersf29b64d2001-01-15 06:33:19 +0000967/* Use this routine if told to, or by default on non-get_unlocked()
968 * platforms unless told not to. Yikes! Let's spell that out:
969 * On a platform with getc_unlocked():
970 * By default, use getc_unlocked().
971 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
972 * On a platform without getc_unlocked():
973 * By default, use fgets().
974 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
975 */
976#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
977#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000978#endif
979
Tim Petersf29b64d2001-01-15 06:33:19 +0000980#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
981#undef USE_FGETS_IN_GETLINE
982#endif
983
984#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000985static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000986getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000987{
Tim Peters15b83852001-01-08 00:53:12 +0000988/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000989 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
990 * to fill this much of the buffer with a known value in order to figure out
991 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
992 * than "most" lines, we waste time filling unused buffer slots. 100 is
993 * surely adequate for most peoples' email archives, chewing over source code,
994 * etc -- "regular old text files".
995 * MAXBUFSIZE is the maximum line length that lets us get away with the less
996 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
997 * cautions about boosting that. 300 was chosen because the worst real-life
998 * text-crunching job reported on Python-Dev was a mail-log crawler where over
999 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +00001000 */
Tim Peters142297a2001-01-15 10:36:56 +00001001#define INITBUFSIZE 100
1002#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +00001003 char* p; /* temp */
1004 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +00001005 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +00001006 char* pvfree; /* address of next free slot */
1007 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +00001008 size_t nfree; /* # of free buffer slots; pvend-pvfree */
1009 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001010 size_t increment; /* amount to increment the buffer */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001011 size_t prev_v_size;
Tim Peters86821b22001-01-07 21:19:34 +00001012
Tim Peters15b83852001-01-08 00:53:12 +00001013 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001014 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001015 */
Tim Peters142297a2001-01-15 10:36:56 +00001016 total_v_size = INITBUFSIZE; /* start small and pray */
1017 pvfree = buf;
1018 for (;;) {
1019 Py_BEGIN_ALLOW_THREADS
1020 pvend = buf + total_v_size;
1021 nfree = pvend - pvfree;
1022 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001023 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1024 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001025 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001026
Tim Peters142297a2001-01-15 10:36:56 +00001027 if (p == NULL) {
1028 clearerr(fp);
1029 if (PyErr_CheckSignals())
1030 return NULL;
1031 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001032 return v;
1033 }
Tim Peters142297a2001-01-15 10:36:56 +00001034 /* fgets read *something* */
1035 p = memchr(pvfree, '\n', nfree);
1036 if (p != NULL) {
1037 /* Did the \n come from fgets or from us?
1038 * Since fgets stops at the first \n, and then writes
1039 * \0, if it's from fgets a \0 must be next. But if
1040 * that's so, it could not have come from us, since
1041 * the \n's we filled the buffer with have only more
1042 * \n's to the right.
1043 */
1044 if (p+1 < pvend && *(p+1) == '\0') {
1045 /* It's from fgets: we win! In particular,
1046 * we haven't done any mallocs yet, and can
1047 * build the final result on the first try.
1048 */
1049 ++p; /* include \n from fgets */
1050 }
1051 else {
1052 /* Must be from us: fgets didn't fill the
1053 * buffer and didn't find a newline, so it
1054 * must be the last and newline-free line of
1055 * the file.
1056 */
1057 assert(p > pvfree && *(p-1) == '\0');
1058 --p; /* don't include \0 from fgets */
1059 }
1060 v = PyString_FromStringAndSize(buf, p - buf);
1061 return v;
1062 }
1063 /* yuck: fgets overwrote all the newlines, i.e. the entire
1064 * buffer. So this line isn't over yet, or maybe it is but
1065 * we're exactly at EOF. If we haven't already, try using the
1066 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001067 */
Tim Peters142297a2001-01-15 10:36:56 +00001068 assert(*(pvend-1) == '\0');
1069 if (pvfree == buf) {
1070 pvfree = pvend - 1; /* overwrite trailing null */
1071 total_v_size = MAXBUFSIZE;
1072 }
1073 else
1074 break;
Tim Peters86821b22001-01-07 21:19:34 +00001075 }
Tim Peters142297a2001-01-15 10:36:56 +00001076
1077 /* The stack buffer isn't big enough; malloc a string object and read
1078 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001079 */
Tim Petersddea2082002-03-23 10:03:50 +00001080 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001081 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001082 if (v == NULL)
1083 return v;
1084 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001085 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1086 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001087
1088 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001089 * after setting p one beyond the end of the line. The code here is
1090 * very much like the code above, except reads into v's buffer; see
1091 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001092 */
1093 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001094 Py_BEGIN_ALLOW_THREADS
1095 pvend = BUF(v) + total_v_size;
1096 nfree = pvend - pvfree;
1097 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001098 assert(nfree < INT_MAX);
1099 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001100 Py_END_ALLOW_THREADS
1101
1102 if (p == NULL) {
1103 clearerr(fp);
1104 if (PyErr_CheckSignals()) {
1105 Py_DECREF(v);
1106 return NULL;
1107 }
1108 p = pvfree;
1109 break;
1110 }
Tim Peters86821b22001-01-07 21:19:34 +00001111 p = memchr(pvfree, '\n', nfree);
1112 if (p != NULL) {
1113 if (p+1 < pvend && *(p+1) == '\0') {
1114 /* \n came from fgets */
1115 ++p;
1116 break;
1117 }
1118 /* \n came from us; last line of file, no newline */
1119 assert(p > pvfree && *(p-1) == '\0');
1120 --p;
1121 break;
1122 }
1123 /* expand buffer and try again */
1124 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001125 increment = total_v_size >> 2; /* mild exponential growth */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001126 prev_v_size = total_v_size;
Tim Petersddea2082002-03-23 10:03:50 +00001127 total_v_size += increment;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001128 /* check for overflow */
1129 if (total_v_size <= prev_v_size ||
1130 total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001131 PyErr_SetString(PyExc_OverflowError,
1132 "line is longer than a Python string can hold");
1133 Py_DECREF(v);
1134 return NULL;
1135 }
1136 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1137 return NULL;
1138 /* overwrite the trailing null byte */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001139 pvfree = BUF(v) + (prev_v_size - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001140 }
1141 if (BUF(v) + total_v_size != p)
1142 _PyString_Resize(&v, p - BUF(v));
1143 return v;
1144#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001145#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001146}
Tim Petersf29b64d2001-01-15 06:33:19 +00001147#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001148
Guido van Rossum0bd24411991-04-04 15:21:57 +00001149/* Internal routine to get a line.
1150 Size argument interpretation:
1151 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001152 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001153*/
1154
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001155static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001156get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001157{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001158 FILE *fp = f->f_fp;
1159 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001160 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001161 size_t total_v_size; /* total # of slots in buffer */
1162 size_t used_v_size; /* # used slots in buffer */
1163 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001164 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001165 int newlinetypes = f->f_newlinetypes;
1166 int skipnextlf = f->f_skipnextlf;
1167 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001168
Jack Jansen7b8c7542002-04-14 20:12:41 +00001169#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001170 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001171 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001172#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001173 total_v_size = n > 0 ? n : 100;
1174 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001175 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001176 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001177 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001178 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001179
Guido van Rossumce5ba841991-03-06 13:06:18 +00001180 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001181 Py_BEGIN_ALLOW_THREADS
1182 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001183 if (univ_newline) {
1184 c = 'x'; /* Shut up gcc warning */
1185 while ( buf != end && (c = GETC(fp)) != EOF ) {
1186 if (skipnextlf ) {
1187 skipnextlf = 0;
1188 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001189 /* Seeing a \n here with
1190 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001191 * saw a \r before.
1192 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001193 newlinetypes |= NEWLINE_CRLF;
1194 c = GETC(fp);
1195 if (c == EOF) break;
1196 } else {
1197 newlinetypes |= NEWLINE_CR;
1198 }
1199 }
1200 if (c == '\r') {
1201 skipnextlf = 1;
1202 c = '\n';
1203 } else if ( c == '\n')
1204 newlinetypes |= NEWLINE_LF;
1205 *buf++ = c;
1206 if (c == '\n') break;
1207 }
1208 if ( c == EOF && skipnextlf )
1209 newlinetypes |= NEWLINE_CR;
1210 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001211 while ((c = GETC(fp)) != EOF &&
1212 (*buf++ = c) != '\n' &&
1213 buf != end)
1214 ;
1215 FUNLOCKFILE(fp);
1216 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001217 f->f_newlinetypes = newlinetypes;
1218 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001219 if (c == '\n')
1220 break;
1221 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001222 if (ferror(fp)) {
1223 PyErr_SetFromErrno(PyExc_IOError);
1224 clearerr(fp);
1225 Py_DECREF(v);
1226 return NULL;
1227 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001228 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001229 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001230 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001231 return NULL;
1232 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001233 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001234 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001235 /* Must be because buf == end */
1236 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001237 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001238 used_v_size = total_v_size;
1239 increment = total_v_size >> 2; /* mild exponential growth */
1240 total_v_size += increment;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001241 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001242 PyErr_SetString(PyExc_OverflowError,
1243 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001244 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001245 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001246 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001247 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001248 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001249 buf = BUF(v) + used_v_size;
1250 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001251 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001252
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001253 used_v_size = buf - BUF(v);
1254 if (used_v_size != total_v_size)
1255 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001256 return v;
1257}
1258
Guido van Rossum0bd24411991-04-04 15:21:57 +00001259/* External C interface */
1260
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001261PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001262PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001263{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001264 PyObject *result;
1265
Guido van Rossum3165fe61992-09-25 21:59:05 +00001266 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001267 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001268 return NULL;
1269 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001270
1271 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001272 PyFileObject *fo = (PyFileObject *)f;
1273 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001274 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001275 /* refuse to mix with f.next() */
1276 if (fo->f_buf != NULL &&
1277 (fo->f_bufend - fo->f_bufptr) > 0 &&
1278 fo->f_buf[0] != '\0')
1279 return err_iterbuffered();
1280 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001281 }
1282 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001283 PyObject *reader;
1284 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001285
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001286 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001287 if (reader == NULL)
1288 return NULL;
1289 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001290 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001291 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001292 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001293 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001294 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001295 return NULL;
1296 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001297 result = PyEval_CallObject(reader, args);
1298 Py_DECREF(reader);
1299 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001300 if (result != NULL && !PyString_Check(result) &&
1301 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001302 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001303 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001304 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001305 "object.readline() returned non-string");
1306 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001307 }
1308
1309 if (n < 0 && result != NULL && PyString_Check(result)) {
1310 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001311 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001312 if (len == 0) {
1313 Py_DECREF(result);
1314 result = NULL;
1315 PyErr_SetString(PyExc_EOFError,
1316 "EOF when reading a line");
1317 }
1318 else if (s[len-1] == '\n') {
1319 if (result->ob_refcnt == 1)
1320 _PyString_Resize(&result, len-1);
1321 else {
1322 PyObject *v;
1323 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001324 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001325 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001326 }
1327 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001328 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001329 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1330 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001331 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001332 if (len == 0) {
1333 Py_DECREF(result);
1334 result = NULL;
1335 PyErr_SetString(PyExc_EOFError,
1336 "EOF when reading a line");
1337 }
1338 else if (s[len-1] == '\n') {
1339 if (result->ob_refcnt == 1)
1340 PyUnicode_Resize(&result, len-1);
1341 else {
1342 PyObject *v;
1343 v = PyUnicode_FromUnicode(s, len-1);
1344 Py_DECREF(result);
1345 result = v;
1346 }
1347 }
1348 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001349 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001350}
1351
1352/* Python method */
1353
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001354static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001355file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001356{
Guido van Rossum789a1611997-05-10 22:33:55 +00001357 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001358
Guido van Rossumd7297e61992-07-06 14:19:26 +00001359 if (f->f_fp == NULL)
1360 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001361 /* refuse to mix with f.next() */
1362 if (f->f_buf != NULL &&
1363 (f->f_bufend - f->f_bufptr) > 0 &&
1364 f->f_buf[0] != '\0')
1365 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001366 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001367 return NULL;
1368 if (n == 0)
1369 return PyString_FromString("");
1370 if (n < 0)
1371 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001372 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001373}
1374
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001375static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001376file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001377{
Guido van Rossum789a1611997-05-10 22:33:55 +00001378 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001379 PyObject *list;
1380 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001381 char small_buffer[SMALLCHUNK];
1382 char *buffer = small_buffer;
1383 size_t buffersize = SMALLCHUNK;
1384 PyObject *big_buffer = NULL;
1385 size_t nfilled = 0;
1386 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001387 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001388 char *p, *q, *end;
1389 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001390 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001391
Guido van Rossumd7297e61992-07-06 14:19:26 +00001392 if (f->f_fp == NULL)
1393 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001394 /* refuse to mix with f.next() */
1395 if (f->f_buf != NULL &&
1396 (f->f_bufend - f->f_bufptr) > 0 &&
1397 f->f_buf[0] != '\0')
1398 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001399 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001400 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001401 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001402 return NULL;
1403 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001404 if (shortread)
1405 nread = 0;
1406 else {
1407 Py_BEGIN_ALLOW_THREADS
1408 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001409 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001410 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001411 Py_END_ALLOW_THREADS
1412 shortread = (nread < buffersize-nfilled);
1413 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001414 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001415 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001416 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001417 break;
1418 PyErr_SetFromErrno(PyExc_IOError);
1419 clearerr(f->f_fp);
1420 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001421 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001422 list = NULL;
1423 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001424 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001425 totalread += nread;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001426 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001427 if (p == NULL) {
1428 /* Need a larger buffer to fit this line */
1429 nfilled += nread;
1430 buffersize *= 2;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001431 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001432 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001433 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001434 goto error;
1435 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001436 if (big_buffer == NULL) {
1437 /* Create the big buffer */
1438 big_buffer = PyString_FromStringAndSize(
1439 NULL, buffersize);
1440 if (big_buffer == NULL)
1441 goto error;
1442 buffer = PyString_AS_STRING(big_buffer);
1443 memcpy(buffer, small_buffer, nfilled);
1444 }
1445 else {
1446 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001447 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1448 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001449 buffer = PyString_AS_STRING(big_buffer);
1450 }
1451 continue;
1452 }
1453 end = buffer+nfilled+nread;
1454 q = buffer;
1455 do {
1456 /* Process complete lines */
1457 p++;
1458 line = PyString_FromStringAndSize(q, p-q);
1459 if (line == NULL)
1460 goto error;
1461 err = PyList_Append(list, line);
1462 Py_DECREF(line);
1463 if (err != 0)
1464 goto error;
1465 q = p;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001466 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001467 } while (p != NULL);
1468 /* Move the remaining incomplete line to the start */
1469 nfilled = end-q;
1470 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001471 if (sizehint > 0)
1472 if (totalread >= (size_t)sizehint)
1473 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001474 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001475 if (nfilled != 0) {
1476 /* Partial last line */
1477 line = PyString_FromStringAndSize(buffer, nfilled);
1478 if (line == NULL)
1479 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001480 if (sizehint > 0) {
1481 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001482 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001483 if (rest == NULL) {
1484 Py_DECREF(line);
1485 goto error;
1486 }
1487 PyString_Concat(&line, rest);
1488 Py_DECREF(rest);
1489 if (line == NULL)
1490 goto error;
1491 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001492 err = PyList_Append(list, line);
1493 Py_DECREF(line);
1494 if (err != 0)
1495 goto error;
1496 }
1497 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001498 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001499 return list;
1500}
1501
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001502static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001503file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001504{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001505 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001506 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001507 if (f->f_fp == NULL)
1508 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001509 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001510 return NULL;
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
Guido van Rossumee70ad12000-03-13 16:27:06 +00001613 errno = 0;
1614 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001615 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001616 len = PyString_GET_SIZE(line);
1617 nwritten = fwrite(PyString_AS_STRING(line),
1618 1, len, f->f_fp);
1619 if (nwritten != len) {
1620 Py_BLOCK_THREADS
1621 PyErr_SetFromErrno(PyExc_IOError);
1622 clearerr(f->f_fp);
1623 goto error;
1624 }
1625 }
1626 Py_END_ALLOW_THREADS
1627
1628 if (j < CHUNKSIZE)
1629 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001630 }
1631
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001632 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001633 result = Py_None;
1634 error:
1635 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001636 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001637 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001638#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001639}
1640
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001641static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001642file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001643{
1644 if (f->f_fp == NULL)
1645 return err_closed();
1646 Py_INCREF(f);
1647 return (PyObject *)f;
1648}
1649
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001650static PyObject *
1651file_exit(PyFileObject *f, PyObject *args)
1652{
1653 PyObject *ret = file_close(f);
1654 if (!ret)
1655 /* If error occurred, pass through */
1656 return NULL;
1657 Py_DECREF(ret);
1658 /* We cannot return the result of close since a true
1659 * value will be interpreted as "yes, swallow the
1660 * exception if one was raised inside the with block". */
1661 Py_RETURN_NONE;
1662}
1663
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001664PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001665"readline([size]) -> next line from the file, as a string.\n"
1666"\n"
1667"Retain newline. A non-negative size argument limits the maximum\n"
1668"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001669"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001670
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001671PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001672"read([size]) -> read at most size bytes, returned as a string.\n"
1673"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001674"If the size argument is negative or omitted, read until EOF is reached.\n"
1675"Notice that when in non-blocking mode, less data than what was requested\n"
1676"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001677
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001678PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001679"write(str) -> None. Write string str to file.\n"
1680"\n"
1681"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001682"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001683
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001684PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001685"fileno() -> integer \"file descriptor\".\n"
1686"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001687"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001688
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001689PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001690"seek(offset[, whence]) -> None. Move to new file position.\n"
1691"\n"
1692"Argument offset is a byte count. Optional argument whence defaults to\n"
1693"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1694"(move relative to current position, positive or negative), and 2 (move\n"
1695"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001696"seeking beyond the end of a file). If the file is opened in text mode,\n"
1697"only offsets returned by tell() are legal. Use of other offsets causes\n"
1698"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001699"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001700"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001701
Guido van Rossumd7047b31995-01-02 19:07:15 +00001702#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001703PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001704"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1705"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001706"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001707#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001708
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001709PyDoc_STRVAR(tell_doc,
1710"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001711
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001712PyDoc_STRVAR(readinto_doc,
1713"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001714
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001715PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001716"readlines([size]) -> list of strings, each a line from the file.\n"
1717"\n"
1718"Call readline() repeatedly and return a list of the lines so read.\n"
1719"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001720"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001721
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001722PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001723"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001724"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001725"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001726"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001727
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001728PyDoc_STRVAR(flush_doc,
1729"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001730
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001731PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001732"close() -> None or (perhaps) an integer. Close the file.\n"
1733"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001734"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001735"further I/O operations. close() may be called more than once without\n"
1736"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001737"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001738
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001739PyDoc_STRVAR(isatty_doc,
1740"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001741
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001742PyDoc_STRVAR(enter_doc,
1743 "__enter__() -> self.");
1744
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001745PyDoc_STRVAR(exit_doc,
1746 "__exit__(*excinfo) -> None. Closes the file.");
1747
Tim Petersefc3a3a2001-09-20 07:55:22 +00001748static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001749 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1750 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1751 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1752 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1753 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001754#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001755 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001756#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001757 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1758 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1759 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001760 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1761 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1762 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1763 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001764 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001765 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001766 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001767};
1768
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001769#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001770
Guido van Rossum6f799372001-09-20 20:46:19 +00001771static PyMemberDef file_memberlist[] = {
Guido van Rossum6f799372001-09-20 20:46:19 +00001772 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001773 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001774 {"name", T_OBJECT, OFF(f_name), RO,
1775 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001776 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1777 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001778 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001779 {NULL} /* Sentinel */
1780};
1781
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001782static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001783get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001784{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001785 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001786}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001787static PyObject *
1788get_newlines(PyFileObject *f, void *closure)
1789{
1790 switch (f->f_newlinetypes) {
1791 case NEWLINE_UNKNOWN:
1792 Py_INCREF(Py_None);
1793 return Py_None;
1794 case NEWLINE_CR:
1795 return PyString_FromString("\r");
1796 case NEWLINE_LF:
1797 return PyString_FromString("\n");
1798 case NEWLINE_CR|NEWLINE_LF:
1799 return Py_BuildValue("(ss)", "\r", "\n");
1800 case NEWLINE_CRLF:
1801 return PyString_FromString("\r\n");
1802 case NEWLINE_CR|NEWLINE_CRLF:
1803 return Py_BuildValue("(ss)", "\r", "\r\n");
1804 case NEWLINE_LF|NEWLINE_CRLF:
1805 return Py_BuildValue("(ss)", "\n", "\r\n");
1806 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1807 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1808 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001809 PyErr_Format(PyExc_SystemError,
1810 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001811 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001812 return NULL;
1813 }
1814}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001815
Guido van Rossum32d34c82001-09-20 21:45:26 +00001816static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001817 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001818 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001819 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001820 {0},
1821};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001822
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001823static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001824drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001825{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001826 if (f->f_buf != NULL) {
1827 PyMem_Free(f->f_buf);
1828 f->f_buf = NULL;
1829 }
Guido van Rossum65967252001-04-21 13:20:18 +00001830}
1831
Tim Petersf1827cf2003-09-07 03:30:18 +00001832/* Make sure that file has a readahead buffer with at least one byte
1833 (unless at EOF) and no more than bufsize. Returns negative value on
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001834 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001835static int
1836readahead(PyFileObject *f, int bufsize)
1837{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001838 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001839
1840 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001841 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001842 return 0;
1843 else
1844 drop_readahead(f);
1845 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001846 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
1847 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001848 return -1;
1849 }
1850 Py_BEGIN_ALLOW_THREADS
1851 errno = 0;
1852 chunksize = Py_UniversalNewlineFread(
1853 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1854 Py_END_ALLOW_THREADS
1855 if (chunksize == 0) {
1856 if (ferror(f->f_fp)) {
1857 PyErr_SetFromErrno(PyExc_IOError);
1858 clearerr(f->f_fp);
1859 drop_readahead(f);
1860 return -1;
1861 }
1862 }
1863 f->f_bufptr = f->f_buf;
1864 f->f_bufend = f->f_buf + chunksize;
1865 return 0;
1866}
1867
1868/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001869 uninitialized bytes followed by the remainder of the line. Don't be
1870 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001871 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1872
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001873static PyStringObject *
1874readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1875{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001876 PyStringObject* s;
1877 char *bufptr;
1878 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001879 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001880
1881 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001882 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001883 return NULL;
1884
1885 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001886 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001887 return (PyStringObject *)
1888 PyString_FromStringAndSize(NULL, skip);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001889 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001890 if (bufptr != NULL) {
1891 bufptr++; /* Count the '\n' */
1892 len = bufptr - f->f_bufptr;
1893 s = (PyStringObject *)
1894 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001895 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001896 return NULL;
1897 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1898 f->f_bufptr = bufptr;
1899 if (bufptr == f->f_bufend)
1900 drop_readahead(f);
1901 } else {
1902 bufptr = f->f_bufptr;
1903 buf = f->f_buf;
1904 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001905 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001906 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001907 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001908 if (s == NULL) {
1909 PyMem_Free(buf);
1910 return NULL;
1911 }
1912 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1913 PyMem_Free(buf);
1914 }
1915 return s;
1916}
1917
1918/* A larger buffer size may actually decrease performance. */
1919#define READAHEAD_BUFSIZE 8192
1920
1921static PyObject *
1922file_iternext(PyFileObject *f)
1923{
1924 PyStringObject* l;
1925
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001926 if (f->f_fp == NULL)
1927 return err_closed();
1928
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001929 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1930 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1931 Py_XDECREF(l);
1932 return NULL;
1933 }
1934 return (PyObject *)l;
1935}
1936
1937
Tim Peters59c9a642001-09-13 05:38:56 +00001938static PyObject *
1939file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1940{
Tim Peters44410012001-09-14 03:26:08 +00001941 PyObject *self;
1942 static PyObject *not_yet_string;
1943
1944 assert(type != NULL && type->tp_alloc != NULL);
1945
1946 if (not_yet_string == NULL) {
1947 not_yet_string = PyString_FromString("<uninitialized file>");
1948 if (not_yet_string == NULL)
1949 return NULL;
1950 }
1951
1952 self = type->tp_alloc(type, 0);
1953 if (self != NULL) {
1954 /* Always fill in the name and mode, so that nobody else
1955 needs to special-case NULLs there. */
1956 Py_INCREF(not_yet_string);
1957 ((PyFileObject *)self)->f_name = not_yet_string;
1958 Py_INCREF(not_yet_string);
1959 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001960 Py_INCREF(Py_None);
1961 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001962 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001963 }
1964 return self;
1965}
1966
1967static int
1968file_init(PyObject *self, PyObject *args, PyObject *kwds)
1969{
1970 PyFileObject *foself = (PyFileObject *)self;
1971 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001972 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001973 char *name = NULL;
1974 char *mode = "r";
1975 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001976 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001977
1978 assert(PyFile_Check(self));
1979 if (foself->f_fp != NULL) {
1980 /* Have to close the existing file first. */
1981 PyObject *closeresult = file_close(foself);
1982 if (closeresult == NULL)
1983 return -1;
1984 Py_DECREF(closeresult);
1985 }
Tim Peters59c9a642001-09-13 05:38:56 +00001986
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001987#ifdef Py_WIN_WIDE_FILENAMES
1988 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
1989 PyObject *po;
1990 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
1991 kwlist, &po, &mode, &bufsize)) {
1992 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00001993 if (fill_file_fields(foself, NULL, po, mode,
1994 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001995 goto Error;
1996 } else {
1997 /* Drop the argument parsing error as narrow
1998 strings are also valid. */
1999 PyErr_Clear();
2000 }
2001 }
2002#endif
2003
2004 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002005 PyObject *o_name;
2006
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002007 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2008 Py_FileSystemDefaultEncoding,
2009 &name,
2010 &mode, &bufsize))
2011 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002012
2013 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002014 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2015 kwlist, &o_name, &mode,
2016 &bufsize))
Thomas Wouters89f507f2006-12-13 04:49:30 +00002017 goto Error;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002018
2019 if (fill_file_fields(foself, NULL, o_name, mode,
2020 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002021 goto Error;
2022 }
Tim Peters44410012001-09-14 03:26:08 +00002023 if (open_the_file(foself, name, mode) == NULL)
2024 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002025 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002026 PyFile_SetBufSize(self, bufsize);
2027 goto Done;
2028
2029Error:
2030 ret = -1;
2031 /* fall through */
2032Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002033 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002034 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002035}
2036
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002037PyDoc_VAR(file_doc) =
2038PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002039"file(name[, mode[, buffering]]) -> file object\n"
2040"\n"
2041"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2042"writing or appending. The file will be created if it doesn't exist\n"
2043"when opened for writing or appending; it will be truncated when\n"
2044"opened for writing. Add a 'b' to the mode for binary files.\n"
2045"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2046"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002047"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002048)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002049PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002050"Add a 'U' to mode to open the file for input with universal newline\n"
2051"support. Any line ending in the input file will be seen as a '\\n'\n"
2052"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2053"the value for this attribute is one of None (no newline read yet),\n"
2054"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2055"\n"
2056"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002057);
Tim Peters59c9a642001-09-13 05:38:56 +00002058
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002059PyTypeObject PyFile_Type = {
2060 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002061 0,
2062 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002063 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002064 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002065 (destructor)file_dealloc, /* tp_dealloc */
2066 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002067 0, /* tp_getattr */
2068 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002069 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002070 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002071 0, /* tp_as_number */
2072 0, /* tp_as_sequence */
2073 0, /* tp_as_mapping */
2074 0, /* tp_hash */
2075 0, /* tp_call */
2076 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002077 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum79139b22007-02-09 23:20:19 +00002078 0, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002079 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002080 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002081 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002082 0, /* tp_traverse */
2083 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002084 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002085 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002086 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002087 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002088 file_methods, /* tp_methods */
2089 file_memberlist, /* tp_members */
2090 file_getsetlist, /* tp_getset */
2091 0, /* tp_base */
2092 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002093 0, /* tp_descr_get */
2094 0, /* tp_descr_set */
2095 0, /* tp_dictoffset */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002096 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002097 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002098 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002099 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002100};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002101
Guido van Rossum3165fe61992-09-25 21:59:05 +00002102/* Interfaces to write objects/strings to file-like objects */
2103
2104int
Fred Drakefd99de62000-07-09 05:02:18 +00002105PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002106{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002107 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002108 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002109 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002110 return -1;
2111 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002112 else if (PyFile_Check(f)) {
2113 FILE *fp = PyFile_AsFile(f);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002114 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2115 int result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002116 if (fp == NULL) {
2117 err_closed();
2118 return -1;
2119 }
Tim Petersf1827cf2003-09-07 03:30:18 +00002120 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002121 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002122 char *cenc = PyString_AS_STRING(enc);
2123 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2124 if (value == NULL)
2125 return -1;
2126 } else {
2127 value = v;
2128 Py_INCREF(value);
2129 }
2130 result = PyObject_Print(value, fp, flags);
2131 Py_DECREF(value);
2132 return result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002133 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002134 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002135 if (writer == NULL)
2136 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002137 if (flags & Py_PRINT_RAW) {
2138 if (PyUnicode_Check(v)) {
2139 value = v;
2140 Py_INCREF(value);
2141 } else
2142 value = PyObject_Str(v);
2143 }
2144 else
Walter Dörwald1ab83302007-05-18 17:15:44 +00002145 value = PyObject_ReprStr8(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002146 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002147 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002148 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002149 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002150 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002151 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002152 Py_DECREF(value);
2153 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002154 return -1;
2155 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002156 result = PyEval_CallObject(writer, args);
2157 Py_DECREF(args);
2158 Py_DECREF(value);
2159 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002160 if (result == NULL)
2161 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002162 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002163 return 0;
2164}
2165
Guido van Rossum27a60b11997-05-22 22:25:11 +00002166int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002167PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002168{
2169 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002170 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002171 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002172 PyErr_SetString(PyExc_SystemError,
2173 "null file for PyFile_WriteString");
2174 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002175 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002176 else if (PyFile_Check(f)) {
2177 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002178 if (fp == NULL) {
2179 err_closed();
2180 return -1;
2181 }
2182 fputs(s, fp);
2183 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002184 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002185 else if (!PyErr_Occurred()) {
2186 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002187 int err;
2188 if (v == NULL)
2189 return -1;
2190 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2191 Py_DECREF(v);
2192 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002193 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002194 else
2195 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002196}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002197
2198/* Try to get a file-descriptor from a Python object. If the object
2199 is an integer or long integer, its value is returned. If not, the
2200 object's fileno() method is called if it exists; the method must return
2201 an integer or long integer, which is returned as the file descriptor value.
2202 -1 is returned on failure.
2203*/
2204
2205int PyObject_AsFileDescriptor(PyObject *o)
2206{
2207 int fd;
2208 PyObject *meth;
2209
2210 if (PyInt_Check(o)) {
2211 fd = PyInt_AsLong(o);
2212 }
2213 else if (PyLong_Check(o)) {
2214 fd = PyLong_AsLong(o);
2215 }
2216 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2217 {
2218 PyObject *fno = PyEval_CallObject(meth, NULL);
2219 Py_DECREF(meth);
2220 if (fno == NULL)
2221 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002222
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002223 if (PyInt_Check(fno)) {
2224 fd = PyInt_AsLong(fno);
2225 Py_DECREF(fno);
2226 }
2227 else if (PyLong_Check(fno)) {
2228 fd = PyLong_AsLong(fno);
2229 Py_DECREF(fno);
2230 }
2231 else {
2232 PyErr_SetString(PyExc_TypeError,
2233 "fileno() returned a non-integer");
2234 Py_DECREF(fno);
2235 return -1;
2236 }
2237 }
2238 else {
2239 PyErr_SetString(PyExc_TypeError,
2240 "argument must be an int, or have a fileno() method.");
2241 return -1;
2242 }
2243
Guido van Rossumddefaf32007-01-14 03:31:43 +00002244 if (fd == -1 && PyErr_Occurred())
2245 return -1;
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002246 if (fd < 0) {
2247 PyErr_Format(PyExc_ValueError,
2248 "file descriptor cannot be a negative integer (%i)",
2249 fd);
2250 return -1;
2251 }
2252 return fd;
2253}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002254
Jack Jansen7b8c7542002-04-14 20:12:41 +00002255/* From here on we need access to the real fgets and fread */
2256#undef fgets
2257#undef fread
2258
2259/*
2260** Py_UniversalNewlineFgets is an fgets variation that understands
2261** all of \r, \n and \r\n conventions.
2262** The stream should be opened in binary mode.
2263** If fobj is NULL the routine always does newline conversion, and
2264** it may peek one char ahead to gobble the second char in \r\n.
2265** If fobj is non-NULL it must be a PyFileObject. In this case there
2266** is no readahead but in stead a flag is used to skip a following
2267** \n on the next read. Also, if the file is open in binary mode
2268** the whole conversion is skipped. Finally, the routine keeps track of
2269** the different types of newlines seen.
2270** Note that we need no error handling: fgets() treats error and eof
2271** identically.
2272*/
2273char *
2274Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2275{
2276 char *p = buf;
2277 int c;
2278 int newlinetypes = 0;
2279 int skipnextlf = 0;
2280 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002281
Jack Jansen7b8c7542002-04-14 20:12:41 +00002282 if (fobj) {
2283 if (!PyFile_Check(fobj)) {
2284 errno = ENXIO; /* What can you do... */
2285 return NULL;
2286 }
2287 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2288 if ( !univ_newline )
2289 return fgets(buf, n, stream);
2290 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2291 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2292 }
2293 FLOCKFILE(stream);
2294 c = 'x'; /* Shut up gcc warning */
2295 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2296 if (skipnextlf ) {
2297 skipnextlf = 0;
2298 if (c == '\n') {
2299 /* Seeing a \n here with skipnextlf true
2300 ** means we saw a \r before.
2301 */
2302 newlinetypes |= NEWLINE_CRLF;
2303 c = GETC(stream);
2304 if (c == EOF) break;
2305 } else {
2306 /*
2307 ** Note that c == EOF also brings us here,
2308 ** so we're okay if the last char in the file
2309 ** is a CR.
2310 */
2311 newlinetypes |= NEWLINE_CR;
2312 }
2313 }
2314 if (c == '\r') {
2315 /* A \r is translated into a \n, and we skip
2316 ** an adjacent \n, if any. We don't set the
2317 ** newlinetypes flag until we've seen the next char.
2318 */
2319 skipnextlf = 1;
2320 c = '\n';
2321 } else if ( c == '\n') {
2322 newlinetypes |= NEWLINE_LF;
2323 }
2324 *p++ = c;
2325 if (c == '\n') break;
2326 }
2327 if ( c == EOF && skipnextlf )
2328 newlinetypes |= NEWLINE_CR;
2329 FUNLOCKFILE(stream);
2330 *p = '\0';
2331 if (fobj) {
2332 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2333 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2334 } else if ( skipnextlf ) {
2335 /* If we have no file object we cannot save the
2336 ** skipnextlf flag. We have to readahead, which
2337 ** will cause a pause if we're reading from an
2338 ** interactive stream, but that is very unlikely
2339 ** unless we're doing something silly like
2340 ** execfile("/dev/tty").
2341 */
2342 c = GETC(stream);
2343 if ( c != '\n' )
2344 ungetc(c, stream);
2345 }
2346 if (p == buf)
2347 return NULL;
2348 return buf;
2349}
2350
2351/*
2352** Py_UniversalNewlineFread is an fread variation that understands
2353** all of \r, \n and \r\n conventions.
2354** The stream should be opened in binary mode.
2355** fobj must be a PyFileObject. In this case there
2356** is no readahead but in stead a flag is used to skip a following
2357** \n on the next read. Also, if the file is open in binary mode
2358** the whole conversion is skipped. Finally, the routine keeps track of
2359** the different types of newlines seen.
2360*/
2361size_t
Tim Peters058b1412002-04-21 07:29:14 +00002362Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002363 FILE *stream, PyObject *fobj)
2364{
Tim Peters058b1412002-04-21 07:29:14 +00002365 char *dst = buf;
2366 PyFileObject *f = (PyFileObject *)fobj;
2367 int newlinetypes, skipnextlf;
2368
2369 assert(buf != NULL);
2370 assert(stream != NULL);
2371
Jack Jansen7b8c7542002-04-14 20:12:41 +00002372 if (!fobj || !PyFile_Check(fobj)) {
2373 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002374 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002375 }
Tim Peters058b1412002-04-21 07:29:14 +00002376 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002377 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002378 newlinetypes = f->f_newlinetypes;
2379 skipnextlf = f->f_skipnextlf;
2380 /* Invariant: n is the number of bytes remaining to be filled
2381 * in the buffer.
2382 */
2383 while (n) {
2384 size_t nread;
2385 int shortread;
2386 char *src = dst;
2387
2388 nread = fread(dst, 1, n, stream);
2389 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002390 if (nread == 0)
2391 break;
2392
Tim Peterse1682a82002-04-21 18:15:20 +00002393 n -= nread; /* assuming 1 byte out for each in; will adjust */
2394 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002395 while (nread--) {
2396 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002397 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002398 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002399 *dst++ = '\n';
2400 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002401 }
2402 else if (skipnextlf && c == '\n') {
2403 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002404 skipnextlf = 0;
2405 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002406 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002407 }
2408 else {
2409 /* Normal char to be stored in buffer. Also
2410 * update the newlinetypes flag if either this
2411 * is an LF or the previous char was a CR.
2412 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002413 if (c == '\n')
2414 newlinetypes |= NEWLINE_LF;
2415 else if (skipnextlf)
2416 newlinetypes |= NEWLINE_CR;
2417 *dst++ = c;
2418 skipnextlf = 0;
2419 }
2420 }
Tim Peters058b1412002-04-21 07:29:14 +00002421 if (shortread) {
2422 /* If this is EOF, update type flags. */
2423 if (skipnextlf && feof(stream))
2424 newlinetypes |= NEWLINE_CR;
2425 break;
2426 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002427 }
Tim Peters058b1412002-04-21 07:29:14 +00002428 f->f_newlinetypes = newlinetypes;
2429 f->f_skipnextlf = skipnextlf;
2430 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002431}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002432
2433#ifdef __cplusplus
2434}
2435#endif