blob: 469eacd2f213527d8deef958f3c2f1e1a643b165 [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{
Guido van Rossum6f376c42007-05-24 14:31:33 +0000268 PyErr_SetString(PyExc_SystemError,
269 "attempt to create old file from FILE *");
270 return NULL;
271#if 0
Tim Peters44410012001-09-14 03:26:08 +0000272 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
273 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000274 if (f != NULL) {
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000275 PyObject *o_name = PyString_FromString(name);
276 if (o_name == NULL)
277 return NULL;
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000278 if (fill_file_fields(f, fp, o_name, mode, close) == NULL) {
Tim Peters59c9a642001-09-13 05:38:56 +0000279 Py_DECREF(f);
280 f = NULL;
281 }
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000282 Py_DECREF(o_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000283 }
284 return (PyObject *) f;
Guido van Rossum6f376c42007-05-24 14:31:33 +0000285#endif
Tim Peters59c9a642001-09-13 05:38:56 +0000286}
287
288PyObject *
289PyFile_FromString(char *name, char *mode)
290{
291 extern int fclose(FILE *);
292 PyFileObject *f;
293
294 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
295 if (f != NULL) {
296 if (open_the_file(f, name, mode) == NULL) {
297 Py_DECREF(f);
298 f = NULL;
299 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000300 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000301 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000302}
303
Guido van Rossumb6775db1994-08-01 11:34:53 +0000304void
Fred Drakefd99de62000-07-09 05:02:18 +0000305PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000306{
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000307 PyFileObject *file = (PyFileObject *)f;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000308 if (bufsize >= 0) {
Guido van Rossumb6775db1994-08-01 11:34:53 +0000309 int type;
310 switch (bufsize) {
311 case 0:
312 type = _IONBF;
313 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000314#ifdef HAVE_SETVBUF
Guido van Rossumb6775db1994-08-01 11:34:53 +0000315 case 1:
316 type = _IOLBF;
317 bufsize = BUFSIZ;
318 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000319#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000320 default:
321 type = _IOFBF;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000322#ifndef HAVE_SETVBUF
323 bufsize = BUFSIZ;
324#endif
325 break;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000326 }
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000327 fflush(file->f_fp);
328 if (type == _IONBF) {
329 PyMem_Free(file->f_setbuf);
330 file->f_setbuf = NULL;
331 } else {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000332 file->f_setbuf = (char *)PyMem_Realloc(file->f_setbuf,
333 bufsize);
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000334 }
335#ifdef HAVE_SETVBUF
336 setvbuf(file->f_fp, file->f_setbuf, type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000337#else /* !HAVE_SETVBUF */
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000338 setbuf(file->f_fp, file->f_setbuf);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000339#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000340 }
341}
342
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000343/* Set the encoding used to output Unicode strings.
344 Returh 1 on success, 0 on failure. */
345
346int
347PyFile_SetEncoding(PyObject *f, const char *enc)
348{
349 PyFileObject *file = (PyFileObject*)f;
350 PyObject *str = PyString_FromString(enc);
Thomas Woutersb2137042007-02-01 18:02:27 +0000351
352 assert(PyFile_Check(f));
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000353 if (!str)
354 return 0;
355 Py_DECREF(file->f_encoding);
356 file->f_encoding = str;
357 return 1;
358}
359
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000360static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000361err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000362{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000363 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000364 return NULL;
365}
366
Thomas Woutersc45251a2006-02-12 11:53:32 +0000367/* Refuse regular file I/O if there's data in the iteration-buffer.
368 * Mixing them would cause data to arrive out of order, as the read*
369 * methods don't use the iteration buffer. */
370static PyObject *
371err_iterbuffered(void)
372{
373 PyErr_SetString(PyExc_ValueError,
374 "Mixing iteration and read methods would lose data");
375 return NULL;
376}
377
Neal Norwitzd8b995f2002-08-06 21:50:54 +0000378static void drop_readahead(PyFileObject *);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000379
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000380/* Methods */
381
382static void
Fred Drakefd99de62000-07-09 05:02:18 +0000383file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000384{
Peter Astrandf8e74b12004-11-07 14:15:28 +0000385 int sts = 0;
Raymond Hettingercb87bc82004-05-31 00:35:52 +0000386 if (f->weakreflist != NULL)
387 PyObject_ClearWeakRefs((PyObject *) f);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000388 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000389 Py_BEGIN_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000390 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000391 Py_END_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000392 if (sts == EOF)
393#ifdef HAVE_STRERROR
394 PySys_WriteStderr("close failed: [Errno %d] %s\n", errno, strerror(errno));
395#else
396 PySys_WriteStderr("close failed: [Errno %d]\n", errno);
397#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000398 }
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000399 PyMem_Free(f->f_setbuf);
Tim Peters44410012001-09-14 03:26:08 +0000400 Py_XDECREF(f->f_name);
401 Py_XDECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000402 Py_XDECREF(f->f_encoding);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000403 drop_readahead(f);
Guido van Rossum9475a232001-10-05 20:51:39 +0000404 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000405}
406
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000407static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000408file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000409{
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000410 if (PyUnicode_Check(f->f_name)) {
411 PyObject *ret = NULL;
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000412 PyObject *name = PyUnicode_AsUnicodeEscapeString(f->f_name);
413 const char *name_str = name ? PyString_AsString(name) : "?";
Walter Dörwald1ab83302007-05-18 17:15:44 +0000414 ret = PyUnicode_FromFormat("<%s file u'%s', mode '%s' at %p>",
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000415 f->f_fp == NULL ? "closed" : "open",
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000416 name_str,
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000417 PyString_AsString(f->f_mode),
418 f);
419 Py_XDECREF(name);
420 return ret;
421 } else {
Walter Dörwald1ab83302007-05-18 17:15:44 +0000422 return PyUnicode_FromFormat("<%s file '%s', mode '%s' at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000423 f->f_fp == NULL ? "closed" : "open",
424 PyString_AsString(f->f_name),
425 PyString_AsString(f->f_mode),
426 f);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000427 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000428}
429
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000430static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000431file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000432{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000433 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000434 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000435 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000436 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000437 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000438 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000439 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000440 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000441 f->f_fp = NULL;
442 }
Martin v. Löwis7bbcde72003-09-07 20:42:29 +0000443 PyMem_Free(f->f_setbuf);
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000444 f->f_setbuf = NULL;
Guido van Rossumfebd5511992-03-04 16:39:24 +0000445 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000446 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000447 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000448 return PyInt_FromLong((long)sts);
449 Py_INCREF(Py_None);
450 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000451}
452
Trent Mickf29f47b2000-08-11 19:02:59 +0000453
Guido van Rossumb8552162001-09-05 14:58:11 +0000454/* Our very own off_t-like type, 64-bit if possible */
455#if !defined(HAVE_LARGEFILE_SUPPORT)
456typedef off_t Py_off_t;
457#elif SIZEOF_OFF_T >= 8
458typedef off_t Py_off_t;
459#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000460typedef fpos_t Py_off_t;
461#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000462#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000463#endif
464
465
Trent Mickf29f47b2000-08-11 19:02:59 +0000466/* a portable fseek() function
467 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000468static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000469_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000470{
Guido van Rossumb8552162001-09-05 14:58:11 +0000471#if !defined(HAVE_LARGEFILE_SUPPORT)
472 return fseek(fp, offset, whence);
473#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000474 return fseeko(fp, offset, whence);
475#elif defined(HAVE_FSEEK64)
476 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000477#elif defined(__BEOS__)
478 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000479#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000480 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
481 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000482 fpos_t pos;
483 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000484 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000485#ifdef MS_WINDOWS
486 fflush(fp);
487 if (_lseeki64(fileno(fp), 0, 2) == -1)
488 return -1;
489#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000490 if (fseek(fp, 0, SEEK_END) != 0)
491 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000492#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000493 /* fall through */
494 case SEEK_CUR:
495 if (fgetpos(fp, &pos) != 0)
496 return -1;
497 offset += pos;
498 break;
499 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000500 }
501 return fsetpos(fp, &offset);
502#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000503#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000504#endif
505}
506
507
508/* a portable ftell() function
509 Return -1 on failure with errno set appropriately, current file
510 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000511static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000512_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000513{
Guido van Rossumb8552162001-09-05 14:58:11 +0000514#if !defined(HAVE_LARGEFILE_SUPPORT)
515 return ftell(fp);
516#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
517 return ftello(fp);
518#elif defined(HAVE_FTELL64)
519 return ftell64(fp);
520#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000521 fpos_t pos;
522 if (fgetpos(fp, &pos) != 0)
523 return -1;
524 return pos;
525#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000526#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000527#endif
528}
529
530
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000531static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000532file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000533{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000534 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000535 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000536 Py_off_t offset;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000537 PyObject *offobj, *off_index;
Tim Peters86821b22001-01-07 21:19:34 +0000538
Guido van Rossumd7297e61992-07-06 14:19:26 +0000539 if (f->f_fp == NULL)
540 return err_closed();
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000541 drop_readahead(f);
Guido van Rossumd7297e61992-07-06 14:19:26 +0000542 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000543 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000544 return NULL;
Thomas Wouters89f507f2006-12-13 04:49:30 +0000545 off_index = PyNumber_Index(offobj);
546 if (!off_index) {
547 if (!PyFloat_Check(offobj))
548 return NULL;
549 /* Deprecated in 2.6 */
550 PyErr_Clear();
551 if (PyErr_Warn(PyExc_DeprecationWarning,
552 "integer argument expected, got float"))
553 return NULL;
554 off_index = offobj;
555 Py_INCREF(offobj);
556 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000557#if !defined(HAVE_LARGEFILE_SUPPORT)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000558 offset = PyInt_AsLong(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000559#else
Thomas Wouters89f507f2006-12-13 04:49:30 +0000560 offset = PyLong_Check(off_index) ?
561 PyLong_AsLongLong(off_index) : PyInt_AsLong(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000562#endif
Thomas Wouters89f507f2006-12-13 04:49:30 +0000563 Py_DECREF(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000564 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000565 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000566
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000567 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000568 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000569 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000570 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000571
Guido van Rossumff4949e1992-08-05 19:58:53 +0000572 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000573 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000574 clearerr(f->f_fp);
575 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000576 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000577 f->f_skipnextlf = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000578 Py_INCREF(Py_None);
579 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000580}
581
Trent Mickf29f47b2000-08-11 19:02:59 +0000582
Guido van Rossumd7047b31995-01-02 19:07:15 +0000583#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000584static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000585file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000586{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000587 Py_off_t newsize;
Tim Petersf1827cf2003-09-07 03:30:18 +0000588 PyObject *newsizeobj = NULL;
589 Py_off_t initialpos;
590 int ret;
Tim Peters86821b22001-01-07 21:19:34 +0000591
Guido van Rossumd7047b31995-01-02 19:07:15 +0000592 if (f->f_fp == NULL)
593 return err_closed();
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000594 if (!PyArg_UnpackTuple(args, "truncate", 0, 1, &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000595 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000596
Tim Petersf1827cf2003-09-07 03:30:18 +0000597 /* Get current file position. If the file happens to be open for
598 * update and the last operation was an input operation, C doesn't
599 * define what the later fflush() will do, but we promise truncate()
600 * won't change the current position (and fflush() *does* change it
601 * then at least on Windows). The easiest thing is to capture
602 * current pos now and seek back to it at the end.
603 */
604 Py_BEGIN_ALLOW_THREADS
605 errno = 0;
606 initialpos = _portable_ftell(f->f_fp);
607 Py_END_ALLOW_THREADS
608 if (initialpos == -1)
609 goto onioerror;
610
Tim Petersfb05db22002-03-11 00:24:00 +0000611 /* Set newsize to current postion if newsizeobj NULL, else to the
Tim Petersf1827cf2003-09-07 03:30:18 +0000612 * specified value.
613 */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000614 if (newsizeobj != NULL) {
615#if !defined(HAVE_LARGEFILE_SUPPORT)
616 newsize = PyInt_AsLong(newsizeobj);
617#else
618 newsize = PyLong_Check(newsizeobj) ?
619 PyLong_AsLongLong(newsizeobj) :
620 PyInt_AsLong(newsizeobj);
621#endif
622 if (PyErr_Occurred())
623 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000624 }
Tim Petersf1827cf2003-09-07 03:30:18 +0000625 else /* default to current position */
626 newsize = initialpos;
Tim Petersfb05db22002-03-11 00:24:00 +0000627
Tim Petersf1827cf2003-09-07 03:30:18 +0000628 /* Flush the stream. We're mixing stream-level I/O with lower-level
629 * I/O, and a flush may be necessary to synch both platform views
630 * of the current file state.
631 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000632 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000633 errno = 0;
634 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000635 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000636 if (ret != 0)
637 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000638
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000639#ifdef MS_WINDOWS
Tim Petersfb05db22002-03-11 00:24:00 +0000640 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000641 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000642 {
Tim Petersfb05db22002-03-11 00:24:00 +0000643 HANDLE hFile;
Tim Petersfb05db22002-03-11 00:24:00 +0000644
Tim Petersf1827cf2003-09-07 03:30:18 +0000645 /* Have to move current pos to desired endpoint on Windows. */
646 Py_BEGIN_ALLOW_THREADS
647 errno = 0;
648 ret = _portable_fseek(f->f_fp, newsize, SEEK_SET) != 0;
649 Py_END_ALLOW_THREADS
650 if (ret)
651 goto onioerror;
Tim Petersfb05db22002-03-11 00:24:00 +0000652
Tim Peters8f01b682002-03-12 03:04:44 +0000653 /* Truncate. Note that this may grow the file! */
654 Py_BEGIN_ALLOW_THREADS
655 errno = 0;
656 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
Tim Petersf1827cf2003-09-07 03:30:18 +0000657 ret = hFile == (HANDLE)-1;
658 if (ret == 0) {
659 ret = SetEndOfFile(hFile) == 0;
660 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000661 errno = EACCES;
662 }
663 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000664 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000665 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000666 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000667#else
668 Py_BEGIN_ALLOW_THREADS
669 errno = 0;
670 ret = ftruncate(fileno(f->f_fp), newsize);
671 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000672 if (ret != 0)
673 goto onioerror;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000674#endif /* !MS_WINDOWS */
Tim Peters86821b22001-01-07 21:19:34 +0000675
Tim Petersf1827cf2003-09-07 03:30:18 +0000676 /* Restore original file position. */
677 Py_BEGIN_ALLOW_THREADS
678 errno = 0;
679 ret = _portable_fseek(f->f_fp, initialpos, SEEK_SET) != 0;
680 Py_END_ALLOW_THREADS
681 if (ret)
682 goto onioerror;
683
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000684 Py_INCREF(Py_None);
685 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000686
687onioerror:
688 PyErr_SetFromErrno(PyExc_IOError);
689 clearerr(f->f_fp);
690 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000691}
692#endif /* HAVE_FTRUNCATE */
693
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000694static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000695file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000696{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000697 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000698
Guido van Rossumd7297e61992-07-06 14:19:26 +0000699 if (f->f_fp == NULL)
700 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000701 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000702 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000703 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000704 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000705 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000706 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000707 clearerr(f->f_fp);
708 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000709 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000710 if (f->f_skipnextlf) {
711 int c;
712 c = GETC(f->f_fp);
713 if (c == '\n') {
714 pos++;
715 f->f_skipnextlf = 0;
716 } else if (c != EOF) ungetc(c, f->f_fp);
717 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000718#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000719 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000720#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000721 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000722#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000723}
724
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000725static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000726file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000727{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000728 if (f->f_fp == NULL)
729 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000730 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000731}
732
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000733static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000734file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000735{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000736 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000737
Guido van Rossumd7297e61992-07-06 14:19:26 +0000738 if (f->f_fp == NULL)
739 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000740 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000741 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000742 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000743 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000744 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000745 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000746 clearerr(f->f_fp);
747 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000748 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000749 Py_INCREF(Py_None);
750 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000751}
752
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000753static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000754file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000755{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000756 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000757 if (f->f_fp == NULL)
758 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000759 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000760 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000761 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000762 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000763}
764
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000765
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000766#if BUFSIZ < 8192
767#define SMALLCHUNK 8192
768#else
769#define SMALLCHUNK BUFSIZ
770#endif
771
Guido van Rossum3c259041999-01-14 19:00:14 +0000772#if SIZEOF_INT < 4
773#define BIGCHUNK (512 * 32)
774#else
775#define BIGCHUNK (512 * 1024)
776#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000777
778static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000779new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000780{
781#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000782 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000783 struct stat st;
784 if (fstat(fileno(f->f_fp), &st) == 0) {
785 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000786 /* The following is not a bug: we really need to call lseek()
787 *and* ftell(). The reason is that some stdio libraries
788 mistakenly flush their buffer when ftell() is called and
789 the lseek() call it makes fails, thereby throwing away
790 data that cannot be recovered in any way. To avoid this,
791 we first test lseek(), and only call ftell() if lseek()
792 works. We can't use the lseek() value either, because we
793 need to take the amount of buffered data into account.
794 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000795 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000796 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000797 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000798 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000799 if (pos < 0)
800 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000801 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000802 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000803 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000804 }
805#endif
806 if (currentsize > SMALLCHUNK) {
807 /* Keep doubling until we reach BIGCHUNK;
808 then keep adding BIGCHUNK. */
809 if (currentsize <= BIGCHUNK)
810 return currentsize + currentsize;
811 else
812 return currentsize + BIGCHUNK;
813 }
814 return currentsize + SMALLCHUNK;
815}
816
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000817#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
818#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
819#else
820#ifdef EWOULDBLOCK
821#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
822#else
823#ifdef EAGAIN
824#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
825#else
826#define BLOCKED_ERRNO(x) 0
827#endif
828#endif
829#endif
830
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000831static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000832file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000833{
Guido van Rossum789a1611997-05-10 22:33:55 +0000834 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000835 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000836 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000837
Guido van Rossumd7297e61992-07-06 14:19:26 +0000838 if (f->f_fp == NULL)
839 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000840 /* refuse to mix with f.next() */
841 if (f->f_buf != NULL &&
842 (f->f_bufend - f->f_bufptr) > 0 &&
843 f->f_buf[0] != '\0')
844 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000845 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000846 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000847 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000848 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000849 else
850 buffersize = bytesrequested;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000851 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000852 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000853 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000854 return NULL;
855 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000856 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000857 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000858 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000859 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000860 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000861 Py_BEGIN_ALLOW_THREADS
862 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000863 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000864 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000865 Py_END_ALLOW_THREADS
866 if (chunksize == 0) {
867 if (!ferror(f->f_fp))
868 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000869 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000870 /* When in non-blocking mode, data shouldn't
871 * be discarded if a blocking signal was
872 * received. That will also happen if
873 * chunksize != 0, but bytesread < buffersize. */
874 if (bytesread > 0 && BLOCKED_ERRNO(errno))
875 break;
876 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum6263d541997-05-10 22:07:25 +0000877 Py_DECREF(v);
878 return NULL;
879 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000880 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000881 if (bytesread < buffersize) {
882 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000883 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000884 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000885 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000886 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000887 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000888 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000889 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000890 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000891 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000892 }
893 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000894 if (bytesread != buffersize)
895 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000896 return v;
897}
898
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000899static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000900file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000901{
902 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000903 Py_ssize_t ntodo;
904 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000905
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000906 if (f->f_fp == NULL)
907 return err_closed();
Guido van Rossumd624f182006-04-24 13:47:05 +0000908 if (!f->f_binary) {
909 PyErr_SetString(PyExc_TypeError,
910 "readinto() requires binary mode");
911 return NULL;
912 }
Thomas Woutersc45251a2006-02-12 11:53:32 +0000913 /* refuse to mix with f.next() */
914 if (f->f_buf != NULL &&
915 (f->f_bufend - f->f_bufptr) > 0 &&
916 f->f_buf[0] != '\0')
917 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000918 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000919 return NULL;
920 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000921 while (ntodo > 0) {
922 Py_BEGIN_ALLOW_THREADS
923 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000924 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000925 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000926 Py_END_ALLOW_THREADS
927 if (nnow == 0) {
928 if (!ferror(f->f_fp))
929 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000930 PyErr_SetFromErrno(PyExc_IOError);
931 clearerr(f->f_fp);
932 return NULL;
933 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000934 ndone += nnow;
935 ntodo -= nnow;
936 }
Thomas Wouters89f507f2006-12-13 04:49:30 +0000937 return PyInt_FromSsize_t(ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000938}
939
Tim Peters86821b22001-01-07 21:19:34 +0000940/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000941Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000942
943Under MSVC 6:
944
Tim Peters1c733232001-01-08 04:02:07 +0000945+ MS threadsafe getc is very slow (multiple layers of function calls before+
946 after each character, to lock+unlock the stream).
947+ The stream-locking functions are MS-internal -- can't access them from user
948 code.
949+ There's nothing Tim could find in the MS C or platform SDK libraries that
950 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000951+ MS fgets locks/unlocks only once per line; it's the only hook we have.
952
953So we use fgets for speed(!), despite that it's painful.
954
955MS realloc is also slow.
956
Tim Petersf29b64d2001-01-15 06:33:19 +0000957Reports from other platforms on this method vs getc_unlocked (which MS doesn't
958have):
959 Linux a wash
960 Solaris a wash
961 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000962
Tim Petersf29b64d2001-01-15 06:33:19 +0000963CAUTION: The C std isn't clear about this: in those cases where fgets
964writes something into the buffer, can it write into any position beyond the
965required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
966known on which it does; and it would be a strange way to code fgets. Still,
967getline_via_fgets may not work correctly if it does. The std test
968test_bufio.py should fail if platform fgets() routinely writes beyond the
969trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000970**************************************************************************/
971
Tim Petersf29b64d2001-01-15 06:33:19 +0000972/* Use this routine if told to, or by default on non-get_unlocked()
973 * platforms unless told not to. Yikes! Let's spell that out:
974 * On a platform with getc_unlocked():
975 * By default, use getc_unlocked().
976 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
977 * On a platform without getc_unlocked():
978 * By default, use fgets().
979 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
980 */
981#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
982#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000983#endif
984
Tim Petersf29b64d2001-01-15 06:33:19 +0000985#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
986#undef USE_FGETS_IN_GETLINE
987#endif
988
989#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000990static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000991getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000992{
Tim Peters15b83852001-01-08 00:53:12 +0000993/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000994 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
995 * to fill this much of the buffer with a known value in order to figure out
996 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
997 * than "most" lines, we waste time filling unused buffer slots. 100 is
998 * surely adequate for most peoples' email archives, chewing over source code,
999 * etc -- "regular old text files".
1000 * MAXBUFSIZE is the maximum line length that lets us get away with the less
1001 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
1002 * cautions about boosting that. 300 was chosen because the worst real-life
1003 * text-crunching job reported on Python-Dev was a mail-log crawler where over
1004 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +00001005 */
Tim Peters142297a2001-01-15 10:36:56 +00001006#define INITBUFSIZE 100
1007#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +00001008 char* p; /* temp */
1009 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +00001010 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +00001011 char* pvfree; /* address of next free slot */
1012 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +00001013 size_t nfree; /* # of free buffer slots; pvend-pvfree */
1014 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001015 size_t increment; /* amount to increment the buffer */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001016 size_t prev_v_size;
Tim Peters86821b22001-01-07 21:19:34 +00001017
Tim Peters15b83852001-01-08 00:53:12 +00001018 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001019 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001020 */
Tim Peters142297a2001-01-15 10:36:56 +00001021 total_v_size = INITBUFSIZE; /* start small and pray */
1022 pvfree = buf;
1023 for (;;) {
1024 Py_BEGIN_ALLOW_THREADS
1025 pvend = buf + total_v_size;
1026 nfree = pvend - pvfree;
1027 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001028 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1029 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001030 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001031
Tim Peters142297a2001-01-15 10:36:56 +00001032 if (p == NULL) {
1033 clearerr(fp);
1034 if (PyErr_CheckSignals())
1035 return NULL;
1036 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001037 return v;
1038 }
Tim Peters142297a2001-01-15 10:36:56 +00001039 /* fgets read *something* */
1040 p = memchr(pvfree, '\n', nfree);
1041 if (p != NULL) {
1042 /* Did the \n come from fgets or from us?
1043 * Since fgets stops at the first \n, and then writes
1044 * \0, if it's from fgets a \0 must be next. But if
1045 * that's so, it could not have come from us, since
1046 * the \n's we filled the buffer with have only more
1047 * \n's to the right.
1048 */
1049 if (p+1 < pvend && *(p+1) == '\0') {
1050 /* It's from fgets: we win! In particular,
1051 * we haven't done any mallocs yet, and can
1052 * build the final result on the first try.
1053 */
1054 ++p; /* include \n from fgets */
1055 }
1056 else {
1057 /* Must be from us: fgets didn't fill the
1058 * buffer and didn't find a newline, so it
1059 * must be the last and newline-free line of
1060 * the file.
1061 */
1062 assert(p > pvfree && *(p-1) == '\0');
1063 --p; /* don't include \0 from fgets */
1064 }
1065 v = PyString_FromStringAndSize(buf, p - buf);
1066 return v;
1067 }
1068 /* yuck: fgets overwrote all the newlines, i.e. the entire
1069 * buffer. So this line isn't over yet, or maybe it is but
1070 * we're exactly at EOF. If we haven't already, try using the
1071 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001072 */
Tim Peters142297a2001-01-15 10:36:56 +00001073 assert(*(pvend-1) == '\0');
1074 if (pvfree == buf) {
1075 pvfree = pvend - 1; /* overwrite trailing null */
1076 total_v_size = MAXBUFSIZE;
1077 }
1078 else
1079 break;
Tim Peters86821b22001-01-07 21:19:34 +00001080 }
Tim Peters142297a2001-01-15 10:36:56 +00001081
1082 /* The stack buffer isn't big enough; malloc a string object and read
1083 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001084 */
Tim Petersddea2082002-03-23 10:03:50 +00001085 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001086 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001087 if (v == NULL)
1088 return v;
1089 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001090 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1091 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001092
1093 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001094 * after setting p one beyond the end of the line. The code here is
1095 * very much like the code above, except reads into v's buffer; see
1096 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001097 */
1098 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001099 Py_BEGIN_ALLOW_THREADS
1100 pvend = BUF(v) + total_v_size;
1101 nfree = pvend - pvfree;
1102 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001103 assert(nfree < INT_MAX);
1104 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001105 Py_END_ALLOW_THREADS
1106
1107 if (p == NULL) {
1108 clearerr(fp);
1109 if (PyErr_CheckSignals()) {
1110 Py_DECREF(v);
1111 return NULL;
1112 }
1113 p = pvfree;
1114 break;
1115 }
Tim Peters86821b22001-01-07 21:19:34 +00001116 p = memchr(pvfree, '\n', nfree);
1117 if (p != NULL) {
1118 if (p+1 < pvend && *(p+1) == '\0') {
1119 /* \n came from fgets */
1120 ++p;
1121 break;
1122 }
1123 /* \n came from us; last line of file, no newline */
1124 assert(p > pvfree && *(p-1) == '\0');
1125 --p;
1126 break;
1127 }
1128 /* expand buffer and try again */
1129 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001130 increment = total_v_size >> 2; /* mild exponential growth */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001131 prev_v_size = total_v_size;
Tim Petersddea2082002-03-23 10:03:50 +00001132 total_v_size += increment;
Thomas Wouters89f507f2006-12-13 04:49:30 +00001133 /* check for overflow */
1134 if (total_v_size <= prev_v_size ||
1135 total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001136 PyErr_SetString(PyExc_OverflowError,
1137 "line is longer than a Python string can hold");
1138 Py_DECREF(v);
1139 return NULL;
1140 }
1141 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1142 return NULL;
1143 /* overwrite the trailing null byte */
Thomas Wouters89f507f2006-12-13 04:49:30 +00001144 pvfree = BUF(v) + (prev_v_size - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001145 }
1146 if (BUF(v) + total_v_size != p)
1147 _PyString_Resize(&v, p - BUF(v));
1148 return v;
1149#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001150#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001151}
Tim Petersf29b64d2001-01-15 06:33:19 +00001152#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001153
Guido van Rossum0bd24411991-04-04 15:21:57 +00001154/* Internal routine to get a line.
1155 Size argument interpretation:
1156 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001157 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001158*/
1159
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001160static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001161get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001162{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001163 FILE *fp = f->f_fp;
1164 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001165 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001166 size_t total_v_size; /* total # of slots in buffer */
1167 size_t used_v_size; /* # used slots in buffer */
1168 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001169 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001170 int newlinetypes = f->f_newlinetypes;
1171 int skipnextlf = f->f_skipnextlf;
1172 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001173
Jack Jansen7b8c7542002-04-14 20:12:41 +00001174#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001175 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001176 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001177#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001178 total_v_size = n > 0 ? n : 100;
1179 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001180 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001181 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001182 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001183 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001184
Guido van Rossumce5ba841991-03-06 13:06:18 +00001185 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001186 Py_BEGIN_ALLOW_THREADS
1187 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001188 if (univ_newline) {
1189 c = 'x'; /* Shut up gcc warning */
1190 while ( buf != end && (c = GETC(fp)) != EOF ) {
1191 if (skipnextlf ) {
1192 skipnextlf = 0;
1193 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001194 /* Seeing a \n here with
1195 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001196 * saw a \r before.
1197 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001198 newlinetypes |= NEWLINE_CRLF;
1199 c = GETC(fp);
1200 if (c == EOF) break;
1201 } else {
1202 newlinetypes |= NEWLINE_CR;
1203 }
1204 }
1205 if (c == '\r') {
1206 skipnextlf = 1;
1207 c = '\n';
1208 } else if ( c == '\n')
1209 newlinetypes |= NEWLINE_LF;
1210 *buf++ = c;
1211 if (c == '\n') break;
1212 }
1213 if ( c == EOF && skipnextlf )
1214 newlinetypes |= NEWLINE_CR;
1215 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001216 while ((c = GETC(fp)) != EOF &&
1217 (*buf++ = c) != '\n' &&
1218 buf != end)
1219 ;
1220 FUNLOCKFILE(fp);
1221 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001222 f->f_newlinetypes = newlinetypes;
1223 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001224 if (c == '\n')
1225 break;
1226 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001227 if (ferror(fp)) {
1228 PyErr_SetFromErrno(PyExc_IOError);
1229 clearerr(fp);
1230 Py_DECREF(v);
1231 return NULL;
1232 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001233 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001234 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001235 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001236 return NULL;
1237 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001238 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001239 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001240 /* Must be because buf == end */
1241 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001242 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001243 used_v_size = total_v_size;
1244 increment = total_v_size >> 2; /* mild exponential growth */
1245 total_v_size += increment;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001246 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001247 PyErr_SetString(PyExc_OverflowError,
1248 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001249 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001250 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001251 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001252 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001253 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001254 buf = BUF(v) + used_v_size;
1255 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001256 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001257
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001258 used_v_size = buf - BUF(v);
1259 if (used_v_size != total_v_size)
1260 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001261 return v;
1262}
1263
Guido van Rossum0bd24411991-04-04 15:21:57 +00001264/* External C interface */
1265
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001266PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001267PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001268{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001269 PyObject *result;
1270
Guido van Rossum3165fe61992-09-25 21:59:05 +00001271 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001272 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001273 return NULL;
1274 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001275
1276 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001277 PyFileObject *fo = (PyFileObject *)f;
1278 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001279 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001280 /* refuse to mix with f.next() */
1281 if (fo->f_buf != NULL &&
1282 (fo->f_bufend - fo->f_bufptr) > 0 &&
1283 fo->f_buf[0] != '\0')
1284 return err_iterbuffered();
1285 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001286 }
1287 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001288 PyObject *reader;
1289 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001290
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001291 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001292 if (reader == NULL)
1293 return NULL;
1294 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001295 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001296 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001297 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001298 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001299 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001300 return NULL;
1301 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001302 result = PyEval_CallObject(reader, args);
1303 Py_DECREF(reader);
1304 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001305 if (result != NULL && !PyString_Check(result) &&
1306 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001307 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001308 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001309 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001310 "object.readline() returned non-string");
1311 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001312 }
1313
1314 if (n < 0 && result != NULL && PyString_Check(result)) {
1315 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001316 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001317 if (len == 0) {
1318 Py_DECREF(result);
1319 result = NULL;
1320 PyErr_SetString(PyExc_EOFError,
1321 "EOF when reading a line");
1322 }
1323 else if (s[len-1] == '\n') {
1324 if (result->ob_refcnt == 1)
1325 _PyString_Resize(&result, len-1);
1326 else {
1327 PyObject *v;
1328 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001329 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001330 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001331 }
1332 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001333 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001334 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1335 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001336 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001337 if (len == 0) {
1338 Py_DECREF(result);
1339 result = NULL;
1340 PyErr_SetString(PyExc_EOFError,
1341 "EOF when reading a line");
1342 }
1343 else if (s[len-1] == '\n') {
1344 if (result->ob_refcnt == 1)
1345 PyUnicode_Resize(&result, len-1);
1346 else {
1347 PyObject *v;
1348 v = PyUnicode_FromUnicode(s, len-1);
1349 Py_DECREF(result);
1350 result = v;
1351 }
1352 }
1353 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001354 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001355}
1356
1357/* Python method */
1358
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001359static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001360file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001361{
Guido van Rossum789a1611997-05-10 22:33:55 +00001362 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001363
Guido van Rossumd7297e61992-07-06 14:19:26 +00001364 if (f->f_fp == NULL)
1365 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001366 /* refuse to mix with f.next() */
1367 if (f->f_buf != NULL &&
1368 (f->f_bufend - f->f_bufptr) > 0 &&
1369 f->f_buf[0] != '\0')
1370 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001371 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001372 return NULL;
1373 if (n == 0)
1374 return PyString_FromString("");
1375 if (n < 0)
1376 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001377 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001378}
1379
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001380static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001381file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001382{
Guido van Rossum789a1611997-05-10 22:33:55 +00001383 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001384 PyObject *list;
1385 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001386 char small_buffer[SMALLCHUNK];
1387 char *buffer = small_buffer;
1388 size_t buffersize = SMALLCHUNK;
1389 PyObject *big_buffer = NULL;
1390 size_t nfilled = 0;
1391 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001392 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001393 char *p, *q, *end;
1394 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001395 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001396
Guido van Rossumd7297e61992-07-06 14:19:26 +00001397 if (f->f_fp == NULL)
1398 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001399 /* refuse to mix with f.next() */
1400 if (f->f_buf != NULL &&
1401 (f->f_bufend - f->f_bufptr) > 0 &&
1402 f->f_buf[0] != '\0')
1403 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001404 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001405 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001406 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001407 return NULL;
1408 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001409 if (shortread)
1410 nread = 0;
1411 else {
1412 Py_BEGIN_ALLOW_THREADS
1413 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001414 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001415 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001416 Py_END_ALLOW_THREADS
1417 shortread = (nread < buffersize-nfilled);
1418 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001419 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001420 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001421 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001422 break;
1423 PyErr_SetFromErrno(PyExc_IOError);
1424 clearerr(f->f_fp);
1425 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001426 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001427 list = NULL;
1428 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001429 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001430 totalread += nread;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001431 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001432 if (p == NULL) {
1433 /* Need a larger buffer to fit this line */
1434 nfilled += nread;
1435 buffersize *= 2;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001436 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001437 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001438 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001439 goto error;
1440 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001441 if (big_buffer == NULL) {
1442 /* Create the big buffer */
1443 big_buffer = PyString_FromStringAndSize(
1444 NULL, buffersize);
1445 if (big_buffer == NULL)
1446 goto error;
1447 buffer = PyString_AS_STRING(big_buffer);
1448 memcpy(buffer, small_buffer, nfilled);
1449 }
1450 else {
1451 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001452 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1453 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001454 buffer = PyString_AS_STRING(big_buffer);
1455 }
1456 continue;
1457 }
1458 end = buffer+nfilled+nread;
1459 q = buffer;
1460 do {
1461 /* Process complete lines */
1462 p++;
1463 line = PyString_FromStringAndSize(q, p-q);
1464 if (line == NULL)
1465 goto error;
1466 err = PyList_Append(list, line);
1467 Py_DECREF(line);
1468 if (err != 0)
1469 goto error;
1470 q = p;
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001471 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001472 } while (p != NULL);
1473 /* Move the remaining incomplete line to the start */
1474 nfilled = end-q;
1475 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001476 if (sizehint > 0)
1477 if (totalread >= (size_t)sizehint)
1478 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001479 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001480 if (nfilled != 0) {
1481 /* Partial last line */
1482 line = PyString_FromStringAndSize(buffer, nfilled);
1483 if (line == NULL)
1484 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001485 if (sizehint > 0) {
1486 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001487 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001488 if (rest == NULL) {
1489 Py_DECREF(line);
1490 goto error;
1491 }
1492 PyString_Concat(&line, rest);
1493 Py_DECREF(rest);
1494 if (line == NULL)
1495 goto error;
1496 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001497 err = PyList_Append(list, line);
1498 Py_DECREF(line);
1499 if (err != 0)
1500 goto error;
1501 }
1502 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001503 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001504 return list;
1505}
1506
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001507static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001508file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001509{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001510 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001511 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001512 if (f->f_fp == NULL)
1513 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001514 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001515 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001516 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001517 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001518 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001519 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001520 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001521 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001522 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001523 return NULL;
1524 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001525 Py_INCREF(Py_None);
1526 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001527}
1528
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001529static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001530file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001531{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001532#define CHUNKSIZE 1000
1533 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001534 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001535 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001536 int index, islist;
1537 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001538
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001539 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001540 if (f->f_fp == NULL)
1541 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001542
1543 result = NULL;
1544 list = NULL;
1545 islist = PyList_Check(seq);
1546 if (islist)
1547 it = NULL;
1548 else {
1549 it = PyObject_GetIter(seq);
1550 if (it == NULL) {
1551 PyErr_SetString(PyExc_TypeError,
1552 "writelines() requires an iterable argument");
1553 return NULL;
1554 }
1555 /* From here on, fail by going to error, to reclaim "it". */
1556 list = PyList_New(CHUNKSIZE);
1557 if (list == NULL)
1558 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001559 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001560
1561 /* Strategy: slurp CHUNKSIZE lines into a private list,
1562 checking that they are all strings, then write that list
1563 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001564 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001565 if (islist) {
1566 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001567 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001568 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001569 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001570 j = PyList_GET_SIZE(list);
1571 }
1572 else {
1573 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001574 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001575 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001576 if (PyErr_Occurred())
1577 goto error;
1578 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001579 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001580 PyList_SetItem(list, j, line);
1581 }
1582 }
1583 if (j == 0)
1584 break;
1585
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001586 /* Check that all entries are indeed strings. If not,
1587 apply the same rules as for file.write() and
1588 convert the results to strings. This is slow, but
1589 seems to be the only way since all conversion APIs
1590 could potentially execute Python code. */
1591 for (i = 0; i < j; i++) {
1592 PyObject *v = PyList_GET_ITEM(list, i);
1593 if (!PyString_Check(v)) {
1594 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001595 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001596 PyObject_AsReadBuffer(v,
1597 (const void**)&buffer,
1598 &len)) ||
1599 PyObject_AsCharBuffer(v,
1600 &buffer,
1601 &len))) {
1602 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001603 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001604 goto error;
1605 }
1606 line = PyString_FromStringAndSize(buffer,
1607 len);
1608 if (line == NULL)
1609 goto error;
1610 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001611 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001612 }
1613 }
1614
1615 /* Since we are releasing the global lock, the
1616 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001617 Py_BEGIN_ALLOW_THREADS
Guido van Rossumee70ad12000-03-13 16:27:06 +00001618 errno = 0;
1619 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001620 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001621 len = PyString_GET_SIZE(line);
1622 nwritten = fwrite(PyString_AS_STRING(line),
1623 1, len, f->f_fp);
1624 if (nwritten != len) {
1625 Py_BLOCK_THREADS
1626 PyErr_SetFromErrno(PyExc_IOError);
1627 clearerr(f->f_fp);
1628 goto error;
1629 }
1630 }
1631 Py_END_ALLOW_THREADS
1632
1633 if (j < CHUNKSIZE)
1634 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001635 }
1636
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001637 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001638 result = Py_None;
1639 error:
1640 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001641 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001642 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001643#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001644}
1645
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001646static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001647file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001648{
1649 if (f->f_fp == NULL)
1650 return err_closed();
1651 Py_INCREF(f);
1652 return (PyObject *)f;
1653}
1654
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001655static PyObject *
1656file_exit(PyFileObject *f, PyObject *args)
1657{
1658 PyObject *ret = file_close(f);
1659 if (!ret)
1660 /* If error occurred, pass through */
1661 return NULL;
1662 Py_DECREF(ret);
1663 /* We cannot return the result of close since a true
1664 * value will be interpreted as "yes, swallow the
1665 * exception if one was raised inside the with block". */
1666 Py_RETURN_NONE;
1667}
1668
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001669PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001670"readline([size]) -> next line from the file, as a string.\n"
1671"\n"
1672"Retain newline. A non-negative size argument limits the maximum\n"
1673"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001674"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001675
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001676PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001677"read([size]) -> read at most size bytes, returned as a string.\n"
1678"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001679"If the size argument is negative or omitted, read until EOF is reached.\n"
1680"Notice that when in non-blocking mode, less data than what was requested\n"
1681"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001682
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001683PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001684"write(str) -> None. Write string str to file.\n"
1685"\n"
1686"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001687"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001688
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001689PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001690"fileno() -> integer \"file descriptor\".\n"
1691"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001692"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001693
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001694PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001695"seek(offset[, whence]) -> None. Move to new file position.\n"
1696"\n"
1697"Argument offset is a byte count. Optional argument whence defaults to\n"
1698"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1699"(move relative to current position, positive or negative), and 2 (move\n"
1700"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001701"seeking beyond the end of a file). If the file is opened in text mode,\n"
1702"only offsets returned by tell() are legal. Use of other offsets causes\n"
1703"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001704"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001705"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001706
Guido van Rossumd7047b31995-01-02 19:07:15 +00001707#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001708PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001709"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1710"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001711"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001712#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001713
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001714PyDoc_STRVAR(tell_doc,
1715"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001716
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001717PyDoc_STRVAR(readinto_doc,
1718"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001719
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001720PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001721"readlines([size]) -> list of strings, each a line from the file.\n"
1722"\n"
1723"Call readline() repeatedly and return a list of the lines so read.\n"
1724"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001725"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001726
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001727PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001728"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001729"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001730"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001731"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001732
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001733PyDoc_STRVAR(flush_doc,
1734"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001735
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001736PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001737"close() -> None or (perhaps) an integer. Close the file.\n"
1738"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001739"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001740"further I/O operations. close() may be called more than once without\n"
1741"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001742"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001743
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001744PyDoc_STRVAR(isatty_doc,
1745"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001746
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001747PyDoc_STRVAR(enter_doc,
1748 "__enter__() -> self.");
1749
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001750PyDoc_STRVAR(exit_doc,
1751 "__exit__(*excinfo) -> None. Closes the file.");
1752
Tim Petersefc3a3a2001-09-20 07:55:22 +00001753static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001754 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1755 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1756 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1757 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1758 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001759#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001760 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001761#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001762 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1763 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1764 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001765 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1766 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1767 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1768 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001769 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Thomas Wouters73e5a5b2006-06-08 15:35:45 +00001770 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001771 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001772};
1773
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001774#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001775
Guido van Rossum6f799372001-09-20 20:46:19 +00001776static PyMemberDef file_memberlist[] = {
Guido van Rossum6f799372001-09-20 20:46:19 +00001777 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001778 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001779 {"name", T_OBJECT, OFF(f_name), RO,
1780 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001781 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1782 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001783 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001784 {NULL} /* Sentinel */
1785};
1786
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001787static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001788get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001789{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001790 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001791}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001792static PyObject *
1793get_newlines(PyFileObject *f, void *closure)
1794{
1795 switch (f->f_newlinetypes) {
1796 case NEWLINE_UNKNOWN:
1797 Py_INCREF(Py_None);
1798 return Py_None;
1799 case NEWLINE_CR:
1800 return PyString_FromString("\r");
1801 case NEWLINE_LF:
1802 return PyString_FromString("\n");
1803 case NEWLINE_CR|NEWLINE_LF:
1804 return Py_BuildValue("(ss)", "\r", "\n");
1805 case NEWLINE_CRLF:
1806 return PyString_FromString("\r\n");
1807 case NEWLINE_CR|NEWLINE_CRLF:
1808 return Py_BuildValue("(ss)", "\r", "\r\n");
1809 case NEWLINE_LF|NEWLINE_CRLF:
1810 return Py_BuildValue("(ss)", "\n", "\r\n");
1811 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1812 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1813 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001814 PyErr_Format(PyExc_SystemError,
1815 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001816 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001817 return NULL;
1818 }
1819}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001820
Guido van Rossum32d34c82001-09-20 21:45:26 +00001821static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001822 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001823 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001824 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001825 {0},
1826};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001827
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001828static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001829drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001830{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001831 if (f->f_buf != NULL) {
1832 PyMem_Free(f->f_buf);
1833 f->f_buf = NULL;
1834 }
Guido van Rossum65967252001-04-21 13:20:18 +00001835}
1836
Tim Petersf1827cf2003-09-07 03:30:18 +00001837/* Make sure that file has a readahead buffer with at least one byte
1838 (unless at EOF) and no more than bufsize. Returns negative value on
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001839 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001840static int
1841readahead(PyFileObject *f, int bufsize)
1842{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001843 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001844
1845 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001846 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001847 return 0;
1848 else
1849 drop_readahead(f);
1850 }
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001851 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
1852 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001853 return -1;
1854 }
1855 Py_BEGIN_ALLOW_THREADS
1856 errno = 0;
1857 chunksize = Py_UniversalNewlineFread(
1858 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1859 Py_END_ALLOW_THREADS
1860 if (chunksize == 0) {
1861 if (ferror(f->f_fp)) {
1862 PyErr_SetFromErrno(PyExc_IOError);
1863 clearerr(f->f_fp);
1864 drop_readahead(f);
1865 return -1;
1866 }
1867 }
1868 f->f_bufptr = f->f_buf;
1869 f->f_bufend = f->f_buf + chunksize;
1870 return 0;
1871}
1872
1873/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001874 uninitialized bytes followed by the remainder of the line. Don't be
1875 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001876 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1877
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001878static PyStringObject *
1879readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1880{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001881 PyStringObject* s;
1882 char *bufptr;
1883 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001884 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001885
1886 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001887 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001888 return NULL;
1889
1890 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001891 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001892 return (PyStringObject *)
1893 PyString_FromStringAndSize(NULL, skip);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00001894 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001895 if (bufptr != NULL) {
1896 bufptr++; /* Count the '\n' */
1897 len = bufptr - f->f_bufptr;
1898 s = (PyStringObject *)
1899 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001900 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001901 return NULL;
1902 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1903 f->f_bufptr = bufptr;
1904 if (bufptr == f->f_bufend)
1905 drop_readahead(f);
1906 } else {
1907 bufptr = f->f_bufptr;
1908 buf = f->f_buf;
1909 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001910 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001911 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001912 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001913 if (s == NULL) {
1914 PyMem_Free(buf);
1915 return NULL;
1916 }
1917 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1918 PyMem_Free(buf);
1919 }
1920 return s;
1921}
1922
1923/* A larger buffer size may actually decrease performance. */
1924#define READAHEAD_BUFSIZE 8192
1925
1926static PyObject *
1927file_iternext(PyFileObject *f)
1928{
1929 PyStringObject* l;
1930
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001931 if (f->f_fp == NULL)
1932 return err_closed();
1933
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001934 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1935 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1936 Py_XDECREF(l);
1937 return NULL;
1938 }
1939 return (PyObject *)l;
1940}
1941
1942
Tim Peters59c9a642001-09-13 05:38:56 +00001943static PyObject *
1944file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1945{
Tim Peters44410012001-09-14 03:26:08 +00001946 PyObject *self;
1947 static PyObject *not_yet_string;
1948
Guido van Rossum6f376c42007-05-24 14:31:33 +00001949 PyErr_SetString(PyExc_SystemError, "attempt to create old file");
1950 return NULL;
1951
Tim Peters44410012001-09-14 03:26:08 +00001952 assert(type != NULL && type->tp_alloc != NULL);
1953
1954 if (not_yet_string == NULL) {
1955 not_yet_string = PyString_FromString("<uninitialized file>");
1956 if (not_yet_string == NULL)
1957 return NULL;
1958 }
1959
1960 self = type->tp_alloc(type, 0);
1961 if (self != NULL) {
1962 /* Always fill in the name and mode, so that nobody else
1963 needs to special-case NULLs there. */
1964 Py_INCREF(not_yet_string);
1965 ((PyFileObject *)self)->f_name = not_yet_string;
1966 Py_INCREF(not_yet_string);
1967 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001968 Py_INCREF(Py_None);
1969 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001970 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001971 }
1972 return self;
1973}
1974
1975static int
1976file_init(PyObject *self, PyObject *args, PyObject *kwds)
1977{
1978 PyFileObject *foself = (PyFileObject *)self;
1979 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001980 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001981 char *name = NULL;
1982 char *mode = "r";
1983 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001984 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001985
1986 assert(PyFile_Check(self));
1987 if (foself->f_fp != NULL) {
1988 /* Have to close the existing file first. */
1989 PyObject *closeresult = file_close(foself);
1990 if (closeresult == NULL)
1991 return -1;
1992 Py_DECREF(closeresult);
1993 }
Tim Peters59c9a642001-09-13 05:38:56 +00001994
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001995#ifdef Py_WIN_WIDE_FILENAMES
1996 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
1997 PyObject *po;
1998 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
1999 kwlist, &po, &mode, &bufsize)) {
2000 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002001 if (fill_file_fields(foself, NULL, po, mode,
2002 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002003 goto Error;
2004 } else {
2005 /* Drop the argument parsing error as narrow
2006 strings are also valid. */
2007 PyErr_Clear();
2008 }
2009 }
2010#endif
2011
2012 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002013 PyObject *o_name;
2014
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002015 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2016 Py_FileSystemDefaultEncoding,
2017 &name,
2018 &mode, &bufsize))
2019 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002020
2021 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002022 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2023 kwlist, &o_name, &mode,
2024 &bufsize))
Thomas Wouters89f507f2006-12-13 04:49:30 +00002025 goto Error;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002026
2027 if (fill_file_fields(foself, NULL, o_name, mode,
2028 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002029 goto Error;
2030 }
Tim Peters44410012001-09-14 03:26:08 +00002031 if (open_the_file(foself, name, mode) == NULL)
2032 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002033 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002034 PyFile_SetBufSize(self, bufsize);
2035 goto Done;
2036
2037Error:
2038 ret = -1;
2039 /* fall through */
2040Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002041 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002042 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002043}
2044
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002045PyDoc_VAR(file_doc) =
2046PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002047"file(name[, mode[, buffering]]) -> file object\n"
2048"\n"
2049"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2050"writing or appending. The file will be created if it doesn't exist\n"
2051"when opened for writing or appending; it will be truncated when\n"
2052"opened for writing. Add a 'b' to the mode for binary files.\n"
2053"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2054"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002055"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002056)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002057PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002058"Add a 'U' to mode to open the file for input with universal newline\n"
2059"support. Any line ending in the input file will be seen as a '\\n'\n"
2060"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2061"the value for this attribute is one of None (no newline read yet),\n"
2062"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2063"\n"
2064"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002065);
Tim Peters59c9a642001-09-13 05:38:56 +00002066
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002067PyTypeObject PyFile_Type = {
2068 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002069 0,
2070 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002071 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002072 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002073 (destructor)file_dealloc, /* tp_dealloc */
2074 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002075 0, /* tp_getattr */
2076 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002077 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002078 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002079 0, /* tp_as_number */
2080 0, /* tp_as_sequence */
2081 0, /* tp_as_mapping */
2082 0, /* tp_hash */
2083 0, /* tp_call */
2084 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002085 PyObject_GenericGetAttr, /* tp_getattro */
Guido van Rossum79139b22007-02-09 23:20:19 +00002086 0, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002087 0, /* tp_as_buffer */
Guido van Rossum3cf5b1e2006-07-27 21:53:35 +00002088 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002089 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002090 0, /* tp_traverse */
2091 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002092 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002093 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002094 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002095 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002096 file_methods, /* tp_methods */
2097 file_memberlist, /* tp_members */
2098 file_getsetlist, /* tp_getset */
2099 0, /* tp_base */
2100 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002101 0, /* tp_descr_get */
2102 0, /* tp_descr_set */
2103 0, /* tp_dictoffset */
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002104 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002105 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002106 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002107 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002108};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002109
Guido van Rossum3165fe61992-09-25 21:59:05 +00002110/* Interfaces to write objects/strings to file-like objects */
2111
2112int
Fred Drakefd99de62000-07-09 05:02:18 +00002113PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002114{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002115 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002116 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002117 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002118 return -1;
2119 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002120 else if (PyFile_Check(f)) {
2121 FILE *fp = PyFile_AsFile(f);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002122 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2123 int result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002124 if (fp == NULL) {
2125 err_closed();
2126 return -1;
2127 }
Tim Petersf1827cf2003-09-07 03:30:18 +00002128 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002129 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002130 char *cenc = PyString_AS_STRING(enc);
2131 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2132 if (value == NULL)
2133 return -1;
2134 } else {
2135 value = v;
2136 Py_INCREF(value);
2137 }
2138 result = PyObject_Print(value, fp, flags);
2139 Py_DECREF(value);
2140 return result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002141 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002142 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002143 if (writer == NULL)
2144 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002145 if (flags & Py_PRINT_RAW) {
2146 if (PyUnicode_Check(v)) {
2147 value = v;
2148 Py_INCREF(value);
2149 } else
2150 value = PyObject_Str(v);
2151 }
2152 else
Walter Dörwald1ab83302007-05-18 17:15:44 +00002153 value = PyObject_ReprStr8(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002154 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002155 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002156 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002157 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002158 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002159 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002160 Py_DECREF(value);
2161 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002162 return -1;
2163 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002164 result = PyEval_CallObject(writer, args);
2165 Py_DECREF(args);
2166 Py_DECREF(value);
2167 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002168 if (result == NULL)
2169 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002170 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002171 return 0;
2172}
2173
Guido van Rossum27a60b11997-05-22 22:25:11 +00002174int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002175PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002176{
2177 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002178 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002179 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002180 PyErr_SetString(PyExc_SystemError,
2181 "null file for PyFile_WriteString");
2182 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002183 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002184 else if (PyFile_Check(f)) {
2185 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002186 if (fp == NULL) {
2187 err_closed();
2188 return -1;
2189 }
2190 fputs(s, fp);
2191 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002192 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002193 else if (!PyErr_Occurred()) {
2194 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002195 int err;
2196 if (v == NULL)
2197 return -1;
2198 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2199 Py_DECREF(v);
2200 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002201 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002202 else
2203 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002204}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002205
2206/* Try to get a file-descriptor from a Python object. If the object
2207 is an integer or long integer, its value is returned. If not, the
2208 object's fileno() method is called if it exists; the method must return
2209 an integer or long integer, which is returned as the file descriptor value.
2210 -1 is returned on failure.
2211*/
2212
2213int PyObject_AsFileDescriptor(PyObject *o)
2214{
2215 int fd;
2216 PyObject *meth;
2217
2218 if (PyInt_Check(o)) {
2219 fd = PyInt_AsLong(o);
2220 }
2221 else if (PyLong_Check(o)) {
2222 fd = PyLong_AsLong(o);
2223 }
2224 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2225 {
2226 PyObject *fno = PyEval_CallObject(meth, NULL);
2227 Py_DECREF(meth);
2228 if (fno == NULL)
2229 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002230
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002231 if (PyInt_Check(fno)) {
2232 fd = PyInt_AsLong(fno);
2233 Py_DECREF(fno);
2234 }
2235 else if (PyLong_Check(fno)) {
2236 fd = PyLong_AsLong(fno);
2237 Py_DECREF(fno);
2238 }
2239 else {
2240 PyErr_SetString(PyExc_TypeError,
2241 "fileno() returned a non-integer");
2242 Py_DECREF(fno);
2243 return -1;
2244 }
2245 }
2246 else {
2247 PyErr_SetString(PyExc_TypeError,
2248 "argument must be an int, or have a fileno() method.");
2249 return -1;
2250 }
2251
Guido van Rossumddefaf32007-01-14 03:31:43 +00002252 if (fd == -1 && PyErr_Occurred())
2253 return -1;
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002254 if (fd < 0) {
2255 PyErr_Format(PyExc_ValueError,
2256 "file descriptor cannot be a negative integer (%i)",
2257 fd);
2258 return -1;
2259 }
2260 return fd;
2261}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002262
Jack Jansen7b8c7542002-04-14 20:12:41 +00002263/* From here on we need access to the real fgets and fread */
2264#undef fgets
2265#undef fread
2266
2267/*
2268** Py_UniversalNewlineFgets is an fgets variation that understands
2269** all of \r, \n and \r\n conventions.
2270** The stream should be opened in binary mode.
2271** If fobj is NULL the routine always does newline conversion, and
2272** it may peek one char ahead to gobble the second char in \r\n.
2273** If fobj is non-NULL it must be a PyFileObject. In this case there
2274** is no readahead but in stead a flag is used to skip a following
2275** \n on the next read. Also, if the file is open in binary mode
2276** the whole conversion is skipped. Finally, the routine keeps track of
2277** the different types of newlines seen.
2278** Note that we need no error handling: fgets() treats error and eof
2279** identically.
2280*/
2281char *
2282Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2283{
2284 char *p = buf;
2285 int c;
2286 int newlinetypes = 0;
2287 int skipnextlf = 0;
2288 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002289
Jack Jansen7b8c7542002-04-14 20:12:41 +00002290 if (fobj) {
2291 if (!PyFile_Check(fobj)) {
2292 errno = ENXIO; /* What can you do... */
2293 return NULL;
2294 }
2295 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2296 if ( !univ_newline )
2297 return fgets(buf, n, stream);
2298 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2299 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2300 }
2301 FLOCKFILE(stream);
2302 c = 'x'; /* Shut up gcc warning */
2303 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2304 if (skipnextlf ) {
2305 skipnextlf = 0;
2306 if (c == '\n') {
2307 /* Seeing a \n here with skipnextlf true
2308 ** means we saw a \r before.
2309 */
2310 newlinetypes |= NEWLINE_CRLF;
2311 c = GETC(stream);
2312 if (c == EOF) break;
2313 } else {
2314 /*
2315 ** Note that c == EOF also brings us here,
2316 ** so we're okay if the last char in the file
2317 ** is a CR.
2318 */
2319 newlinetypes |= NEWLINE_CR;
2320 }
2321 }
2322 if (c == '\r') {
2323 /* A \r is translated into a \n, and we skip
2324 ** an adjacent \n, if any. We don't set the
2325 ** newlinetypes flag until we've seen the next char.
2326 */
2327 skipnextlf = 1;
2328 c = '\n';
2329 } else if ( c == '\n') {
2330 newlinetypes |= NEWLINE_LF;
2331 }
2332 *p++ = c;
2333 if (c == '\n') break;
2334 }
2335 if ( c == EOF && skipnextlf )
2336 newlinetypes |= NEWLINE_CR;
2337 FUNLOCKFILE(stream);
2338 *p = '\0';
2339 if (fobj) {
2340 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2341 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2342 } else if ( skipnextlf ) {
2343 /* If we have no file object we cannot save the
2344 ** skipnextlf flag. We have to readahead, which
2345 ** will cause a pause if we're reading from an
2346 ** interactive stream, but that is very unlikely
2347 ** unless we're doing something silly like
2348 ** execfile("/dev/tty").
2349 */
2350 c = GETC(stream);
2351 if ( c != '\n' )
2352 ungetc(c, stream);
2353 }
2354 if (p == buf)
2355 return NULL;
2356 return buf;
2357}
2358
2359/*
2360** Py_UniversalNewlineFread is an fread variation that understands
2361** all of \r, \n and \r\n conventions.
2362** The stream should be opened in binary mode.
2363** fobj must be a PyFileObject. In this case there
2364** is no readahead but in stead a flag is used to skip a following
2365** \n on the next read. Also, if the file is open in binary mode
2366** the whole conversion is skipped. Finally, the routine keeps track of
2367** the different types of newlines seen.
2368*/
2369size_t
Tim Peters058b1412002-04-21 07:29:14 +00002370Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002371 FILE *stream, PyObject *fobj)
2372{
Tim Peters058b1412002-04-21 07:29:14 +00002373 char *dst = buf;
2374 PyFileObject *f = (PyFileObject *)fobj;
2375 int newlinetypes, skipnextlf;
2376
2377 assert(buf != NULL);
2378 assert(stream != NULL);
2379
Jack Jansen7b8c7542002-04-14 20:12:41 +00002380 if (!fobj || !PyFile_Check(fobj)) {
2381 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002382 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002383 }
Tim Peters058b1412002-04-21 07:29:14 +00002384 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002385 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002386 newlinetypes = f->f_newlinetypes;
2387 skipnextlf = f->f_skipnextlf;
2388 /* Invariant: n is the number of bytes remaining to be filled
2389 * in the buffer.
2390 */
2391 while (n) {
2392 size_t nread;
2393 int shortread;
2394 char *src = dst;
2395
2396 nread = fread(dst, 1, n, stream);
2397 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002398 if (nread == 0)
2399 break;
2400
Tim Peterse1682a82002-04-21 18:15:20 +00002401 n -= nread; /* assuming 1 byte out for each in; will adjust */
2402 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002403 while (nread--) {
2404 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002405 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002406 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002407 *dst++ = '\n';
2408 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002409 }
2410 else if (skipnextlf && c == '\n') {
2411 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002412 skipnextlf = 0;
2413 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002414 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002415 }
2416 else {
2417 /* Normal char to be stored in buffer. Also
2418 * update the newlinetypes flag if either this
2419 * is an LF or the previous char was a CR.
2420 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002421 if (c == '\n')
2422 newlinetypes |= NEWLINE_LF;
2423 else if (skipnextlf)
2424 newlinetypes |= NEWLINE_CR;
2425 *dst++ = c;
2426 skipnextlf = 0;
2427 }
2428 }
Tim Peters058b1412002-04-21 07:29:14 +00002429 if (shortread) {
2430 /* If this is EOF, update type flags. */
2431 if (skipnextlf && feof(stream))
2432 newlinetypes |= NEWLINE_CR;
2433 break;
2434 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002435 }
Tim Peters058b1412002-04-21 07:29:14 +00002436 f->f_newlinetypes = newlinetypes;
2437 f->f_skipnextlf = skipnextlf;
2438 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002439}
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002440
2441#ifdef __cplusplus
2442}
2443#endif