blob: ced07684fd31222f5ddc31d0555dd79770196456 [file] [log] [blame]
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001/* File object implementation */
2
Martin v. Löwis18e16552006-02-15 17:27:45 +00003#define PY_SSIZE_T_CLEAN
Guido van Rossumc0b618a1997-05-02 03:12:38 +00004#include "Python.h"
Guido van Rossumb6775db1994-08-01 11:34:53 +00005#include "structmember.h"
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00006
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +00007#ifdef HAVE_SYS_TYPES_H
Guido van Rossum41498431999-01-07 22:09:51 +00008#include <sys/types.h>
Martin v. Löwis0e8bd7e2006-06-10 12:23:46 +00009#endif /* HAVE_SYS_TYPES_H */
Guido van Rossum41498431999-01-07 22:09:51 +000010
Martin v. Löwis6238d2b2002-06-30 15:26:10 +000011#ifdef MS_WINDOWS
Guido van Rossumb8199141997-05-06 15:23:24 +000012#define fileno _fileno
Tim Petersfb05db22002-03-11 00:24:00 +000013/* can simulate truncate with Win32 API functions; see file_truncate */
Guido van Rossumb8199141997-05-06 15:23:24 +000014#define HAVE_FTRUNCATE
Tim Peters7a1f9172002-07-14 22:14:19 +000015#define WIN32_LEAN_AND_MEAN
Tim Petersfb05db22002-03-11 00:24:00 +000016#include <windows.h>
Guido van Rossumb8199141997-05-06 15:23:24 +000017#endif
18
Mark Hammondc2e85bd2002-10-03 05:10:39 +000019#ifdef _MSC_VER
20/* Need GetVersion to see if on NT so safe to use _wfopen */
21#define WIN32_LEAN_AND_MEAN
22#include <windows.h>
23#endif /* _MSC_VER */
24
Andrew MacIntyrec4874392002-02-26 11:36:35 +000025#if defined(PYOS_OS2) && defined(PYCC_GCC)
26#include <io.h>
27#endif
28
Guido van Rossumc0b618a1997-05-02 03:12:38 +000029#define BUF(v) PyString_AS_STRING((PyStringObject *)v)
Guido van Rossumce5ba841991-03-06 13:06:18 +000030
Guido van Rossumff7e83d1999-08-27 20:39:37 +000031#ifndef DONT_HAVE_ERRNO_H
Guido van Rossumf1dc5661993-07-05 10:31:29 +000032#include <errno.h>
Guido van Rossumff7e83d1999-08-27 20:39:37 +000033#endif
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000034
Jack Jansen7b8c7542002-04-14 20:12:41 +000035#ifdef HAVE_GETC_UNLOCKED
36#define GETC(f) getc_unlocked(f)
37#define FLOCKFILE(f) flockfile(f)
38#define FUNLOCKFILE(f) funlockfile(f)
39#else
40#define GETC(f) getc(f)
41#define FLOCKFILE(f)
42#define FUNLOCKFILE(f)
43#endif
44
Jack Jansen7b8c7542002-04-14 20:12:41 +000045/* Bits in f_newlinetypes */
46#define NEWLINE_UNKNOWN 0 /* No newline seen, yet */
47#define NEWLINE_CR 1 /* \r newline seen */
48#define NEWLINE_LF 2 /* \n newline seen */
49#define NEWLINE_CRLF 4 /* \r\n newline seen */
Trent Mickf29f47b2000-08-11 19:02:59 +000050
Anthony Baxterac6bd462006-04-13 02:06:09 +000051#ifdef __cplusplus
52extern "C" {
53#endif
54
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000055FILE *
Fred Drakefd99de62000-07-09 05:02:18 +000056PyFile_AsFile(PyObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000057{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000058 if (f == NULL || !PyFile_Check(f))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000059 return NULL;
Guido van Rossum3165fe61992-09-25 21:59:05 +000060 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000061 return ((PyFileObject *)f)->f_fp;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +000062}
63
Guido van Rossumc0b618a1997-05-02 03:12:38 +000064PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +000065PyFile_Name(PyObject *f)
Guido van Rossumdb3165e1993-10-18 17:06:59 +000066{
Guido van Rossumc0b618a1997-05-02 03:12:38 +000067 if (f == NULL || !PyFile_Check(f))
Guido van Rossumdb3165e1993-10-18 17:06:59 +000068 return NULL;
69 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +000070 return ((PyFileObject *)f)->f_name;
Guido van Rossumdb3165e1993-10-18 17:06:59 +000071}
72
Neil Schemenauered19b882002-03-23 02:06:50 +000073/* On Unix, fopen will succeed for directories.
74 In Python, there should be no file objects referring to
75 directories, so we need a check. */
76
77static PyFileObject*
78dircheck(PyFileObject* f)
79{
80#if defined(HAVE_FSTAT) && defined(S_IFDIR) && defined(EISDIR)
81 struct stat buf;
82 if (f->f_fp == NULL)
83 return f;
84 if (fstat(fileno(f->f_fp), &buf) == 0 &&
85 S_ISDIR(buf.st_mode)) {
86#ifdef HAVE_STRERROR
87 char *msg = strerror(EISDIR);
88#else
89 char *msg = "Is a directory";
90#endif
Tim Petersf1827cf2003-09-07 03:30:18 +000091 PyObject *exc = PyObject_CallFunction(PyExc_IOError, "(is)",
Jeremy Hylton8b735422002-08-14 21:01:41 +000092 EISDIR, msg);
Neil Schemenauered19b882002-03-23 02:06:50 +000093 PyErr_SetObject(PyExc_IOError, exc);
Neal Norwitz98cad482003-08-15 20:05:45 +000094 Py_XDECREF(exc);
Neil Schemenauered19b882002-03-23 02:06:50 +000095 return NULL;
96 }
97#endif
98 return f;
99}
100
Tim Peters59c9a642001-09-13 05:38:56 +0000101
102static PyObject *
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000103fill_file_fields(PyFileObject *f, FILE *fp, PyObject *name, char *mode,
104 int (*close)(FILE *))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000105{
Neal Norwitzb337bb52006-07-17 00:55:45 +0000106 assert(name != NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000107 assert(f != NULL);
108 assert(PyFile_Check(f));
Tim Peters44410012001-09-14 03:26:08 +0000109 assert(f->f_fp == NULL);
110
111 Py_DECREF(f->f_name);
112 Py_DECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000113 Py_DECREF(f->f_encoding);
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000114
Neal Norwitzb337bb52006-07-17 00:55:45 +0000115 Py_INCREF(name);
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000116 f->f_name = name;
117
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000118 f->f_mode = PyString_FromString(mode);
Tim Peters44410012001-09-14 03:26:08 +0000119
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000120 f->f_close = close;
Guido van Rossumeb183da1991-04-04 10:44:06 +0000121 f->f_softspace = 0;
Tim Peters59c9a642001-09-13 05:38:56 +0000122 f->f_binary = strchr(mode,'b') != NULL;
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000123 f->f_buf = NULL;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000124 f->f_univ_newline = (strchr(mode, 'U') != NULL);
125 f->f_newlinetypes = NEWLINE_UNKNOWN;
126 f->f_skipnextlf = 0;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000127 Py_INCREF(Py_None);
128 f->f_encoding = Py_None;
Tim Petersf1827cf2003-09-07 03:30:18 +0000129
Neal Norwitzb337bb52006-07-17 00:55:45 +0000130 if (f->f_mode == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000131 return NULL;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000132 f->f_fp = fp;
Neil Schemenauered19b882002-03-23 02:06:50 +0000133 f = dircheck(f);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000134 return (PyObject *) f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000135}
136
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000137/* check for known incorrect mode strings - problem is, platforms are
138 free to accept any mode characters they like and are supposed to
139 ignore stuff they don't understand... write or append mode with
Georg Brandl7b90e162006-05-18 07:01:27 +0000140 universal newline support is expressly forbidden by PEP 278.
141 Additionally, remove the 'U' from the mode string as platforms
142 won't know what it is. */
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000143/* zero return is kewl - one is un-kewl */
144static int
Georg Brandl7b90e162006-05-18 07:01:27 +0000145sanitize_the_mode(char *mode)
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000146{
Georg Brandl7b90e162006-05-18 07:01:27 +0000147 char *upos;
Neal Norwitz76dc0812006-01-08 06:13:13 +0000148 size_t len = strlen(mode);
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000149
Georg Brandl7b90e162006-05-18 07:01:27 +0000150 if (!len) {
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000151 PyErr_SetString(PyExc_ValueError, "empty mode string");
152 return 1;
Georg Brandl7b90e162006-05-18 07:01:27 +0000153 }
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000154
Georg Brandl7b90e162006-05-18 07:01:27 +0000155 upos = strchr(mode, 'U');
156 if (upos) {
157 memmove(upos, upos+1, len-(upos-mode)); /* incl null char */
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000158
Georg Brandl7b90e162006-05-18 07:01:27 +0000159 if (mode[0] == 'w' || mode[0] == 'a') {
160 PyErr_Format(PyExc_ValueError, "universal newline "
161 "mode can only be used with modes "
162 "starting with 'r'");
163 return 1;
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000164 }
Georg Brandl7b90e162006-05-18 07:01:27 +0000165
166 if (mode[0] != 'r') {
167 memmove(mode+1, mode, strlen(mode)+1);
168 mode[0] = 'r';
169 }
170
171 if (!strchr(mode, 'b')) {
172 memmove(mode+2, mode+1, strlen(mode));
173 mode[1] = 'b';
174 }
175 } else if (mode[0] != 'r' && mode[0] != 'w' && mode[0] != 'a') {
176 PyErr_Format(PyExc_ValueError, "mode string must begin with "
177 "one of 'r', 'w', 'a' or 'U', not '%.200s'", mode);
178 return 1;
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000179 }
180
181 return 0;
182}
183
Tim Peters59c9a642001-09-13 05:38:56 +0000184static PyObject *
185open_the_file(PyFileObject *f, char *name, char *mode)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000186{
Georg Brandl7b90e162006-05-18 07:01:27 +0000187 char *newmode;
Tim Peters59c9a642001-09-13 05:38:56 +0000188 assert(f != NULL);
189 assert(PyFile_Check(f));
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000190#ifdef MS_WINDOWS
191 /* windows ignores the passed name in order to support Unicode */
192 assert(f->f_name != NULL);
193#else
Tim Peters59c9a642001-09-13 05:38:56 +0000194 assert(name != NULL);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000195#endif
Tim Peters59c9a642001-09-13 05:38:56 +0000196 assert(mode != NULL);
Tim Peters44410012001-09-14 03:26:08 +0000197 assert(f->f_fp == NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000198
Georg Brandl7b90e162006-05-18 07:01:27 +0000199 /* probably need to replace 'U' by 'rb' */
200 newmode = PyMem_MALLOC(strlen(mode) + 3);
201 if (!newmode) {
202 PyErr_NoMemory();
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000203 return NULL;
Georg Brandl7b90e162006-05-18 07:01:27 +0000204 }
205 strcpy(newmode, mode);
206
207 if (sanitize_the_mode(newmode)) {
208 f = NULL;
209 goto cleanup;
210 }
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000211
Tim Peters8fa45672001-09-13 21:01:29 +0000212 /* rexec.py can't stop a user from getting the file() constructor --
213 all they have to do is get *any* file object f, and then do
214 type(f). Here we prevent them from doing damage with it. */
215 if (PyEval_GetRestricted()) {
216 PyErr_SetString(PyExc_IOError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000217 "file() constructor not accessible in restricted mode");
Georg Brandl7b90e162006-05-18 07:01:27 +0000218 f = NULL;
219 goto cleanup;
Tim Peters8fa45672001-09-13 21:01:29 +0000220 }
Tim Petersa27a1502001-11-09 20:59:14 +0000221 errno = 0;
Skip Montanaro51ffac62004-06-11 04:49:03 +0000222
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000223#ifdef MS_WINDOWS
Skip Montanaro51ffac62004-06-11 04:49:03 +0000224 if (PyUnicode_Check(f->f_name)) {
225 PyObject *wmode;
Georg Brandl7b90e162006-05-18 07:01:27 +0000226 wmode = PyUnicode_DecodeASCII(newmode, strlen(newmode), NULL);
Skip Montanaro51ffac62004-06-11 04:49:03 +0000227 if (f->f_name && wmode) {
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000228 Py_BEGIN_ALLOW_THREADS
Skip Montanaro51ffac62004-06-11 04:49:03 +0000229 /* PyUnicode_AS_UNICODE OK without thread
230 lock as it is a simple dereference. */
231 f->f_fp = _wfopen(PyUnicode_AS_UNICODE(f->f_name),
232 PyUnicode_AS_UNICODE(wmode));
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000233 Py_END_ALLOW_THREADS
234 }
Skip Montanaro51ffac62004-06-11 04:49:03 +0000235 Py_XDECREF(wmode);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000236 }
Skip Montanaro51ffac62004-06-11 04:49:03 +0000237#endif
238 if (NULL == f->f_fp && NULL != name) {
239 Py_BEGIN_ALLOW_THREADS
Georg Brandl7b90e162006-05-18 07:01:27 +0000240 f->f_fp = fopen(name, newmode);
Skip Montanaro51ffac62004-06-11 04:49:03 +0000241 Py_END_ALLOW_THREADS
242 }
243
Guido van Rossuma08095a1991-02-13 23:25:27 +0000244 if (f->f_fp == NULL) {
Kristján Valur Jónsson74c3ea02006-07-03 14:59:05 +0000245#if defined _MSC_VER && (_MSC_VER < 1400 || !defined(__STDC_SECURE_LIB__))
Tim Peters2ea91112002-04-08 04:13:12 +0000246 /* MSVC 6 (Microsoft) leaves errno at 0 for bad mode strings,
247 * across all Windows flavors. When it sets EINVAL varies
248 * across Windows flavors, the exact conditions aren't
249 * documented, and the answer lies in the OS's implementation
250 * of Win32's CreateFile function (whose source is secret).
251 * Seems the best we can do is map EINVAL to ENOENT.
Kristján Valur Jónssonf6083172006-06-12 15:45:12 +0000252 * Starting with Visual Studio .NET 2005, EINVAL is correctly
253 * set by our CRT error handler (set in exceptions.c.)
Tim Peters2ea91112002-04-08 04:13:12 +0000254 */
255 if (errno == 0) /* bad mode string */
256 errno = EINVAL;
257 else if (errno == EINVAL) /* unknown, but not a mode string */
258 errno = ENOENT;
259#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000260 if (errno == EINVAL)
Tim Peters2ea91112002-04-08 04:13:12 +0000261 PyErr_Format(PyExc_IOError, "invalid mode: %s",
Jeremy Hylton41c83212001-11-09 16:17:24 +0000262 mode);
263 else
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000264 PyErr_SetFromErrnoWithFilenameObject(PyExc_IOError, f->f_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000265 f = NULL;
266 }
Tim Peters2ea91112002-04-08 04:13:12 +0000267 if (f != NULL)
Neil Schemenauered19b882002-03-23 02:06:50 +0000268 f = dircheck(f);
Georg Brandl7b90e162006-05-18 07:01:27 +0000269
270cleanup:
271 PyMem_FREE(newmode);
272
Tim Peters59c9a642001-09-13 05:38:56 +0000273 return (PyObject *)f;
274}
275
276PyObject *
277PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
278{
Tim Peters44410012001-09-14 03:26:08 +0000279 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
280 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000281 if (f != NULL) {
Neal Norwitzb337bb52006-07-17 00:55:45 +0000282 PyObject *o_name = PyString_FromString(name);
283 if (o_name == NULL)
284 return NULL;
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000285 if (fill_file_fields(f, fp, o_name, mode, close) == NULL) {
Tim Peters59c9a642001-09-13 05:38:56 +0000286 Py_DECREF(f);
287 f = NULL;
288 }
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000289 Py_DECREF(o_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000290 }
291 return (PyObject *) f;
292}
293
294PyObject *
295PyFile_FromString(char *name, char *mode)
296{
297 extern int fclose(FILE *);
298 PyFileObject *f;
299
300 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
301 if (f != NULL) {
302 if (open_the_file(f, name, mode) == NULL) {
303 Py_DECREF(f);
304 f = NULL;
305 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000306 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000307 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000308}
309
Guido van Rossumb6775db1994-08-01 11:34:53 +0000310void
Fred Drakefd99de62000-07-09 05:02:18 +0000311PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000312{
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000313 PyFileObject *file = (PyFileObject *)f;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000314 if (bufsize >= 0) {
Guido van Rossumb6775db1994-08-01 11:34:53 +0000315 int type;
316 switch (bufsize) {
317 case 0:
318 type = _IONBF;
319 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000320#ifdef HAVE_SETVBUF
Guido van Rossumb6775db1994-08-01 11:34:53 +0000321 case 1:
322 type = _IOLBF;
323 bufsize = BUFSIZ;
324 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000325#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000326 default:
327 type = _IOFBF;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000328#ifndef HAVE_SETVBUF
329 bufsize = BUFSIZ;
330#endif
331 break;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000332 }
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000333 fflush(file->f_fp);
334 if (type == _IONBF) {
335 PyMem_Free(file->f_setbuf);
336 file->f_setbuf = NULL;
337 } else {
Anthony Baxter377be112006-04-11 06:54:30 +0000338 file->f_setbuf = (char *)PyMem_Realloc(file->f_setbuf,
339 bufsize);
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000340 }
341#ifdef HAVE_SETVBUF
342 setvbuf(file->f_fp, file->f_setbuf, type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000343#else /* !HAVE_SETVBUF */
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000344 setbuf(file->f_fp, file->f_setbuf);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000345#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000346 }
347}
348
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000349/* Set the encoding used to output Unicode strings.
350 Returh 1 on success, 0 on failure. */
351
352int
353PyFile_SetEncoding(PyObject *f, const char *enc)
354{
355 PyFileObject *file = (PyFileObject*)f;
356 PyObject *str = PyString_FromString(enc);
357 if (!str)
358 return 0;
359 Py_DECREF(file->f_encoding);
360 file->f_encoding = str;
361 return 1;
362}
363
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000364static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000365err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000366{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000367 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000368 return NULL;
369}
370
Thomas Woutersc45251a2006-02-12 11:53:32 +0000371/* Refuse regular file I/O if there's data in the iteration-buffer.
372 * Mixing them would cause data to arrive out of order, as the read*
373 * methods don't use the iteration buffer. */
374static PyObject *
375err_iterbuffered(void)
376{
377 PyErr_SetString(PyExc_ValueError,
378 "Mixing iteration and read methods would lose data");
379 return NULL;
380}
381
Neal Norwitzd8b995f2002-08-06 21:50:54 +0000382static void drop_readahead(PyFileObject *);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000383
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000384/* Methods */
385
386static void
Fred Drakefd99de62000-07-09 05:02:18 +0000387file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000388{
Peter Astrandf8e74b12004-11-07 14:15:28 +0000389 int sts = 0;
Raymond Hettingercb87bc82004-05-31 00:35:52 +0000390 if (f->weakreflist != NULL)
391 PyObject_ClearWeakRefs((PyObject *) f);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000392 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000393 Py_BEGIN_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000394 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000395 Py_END_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000396 if (sts == EOF)
397#ifdef HAVE_STRERROR
398 PySys_WriteStderr("close failed: [Errno %d] %s\n", errno, strerror(errno));
399#else
400 PySys_WriteStderr("close failed: [Errno %d]\n", errno);
401#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000402 }
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000403 PyMem_Free(f->f_setbuf);
Tim Peters44410012001-09-14 03:26:08 +0000404 Py_XDECREF(f->f_name);
405 Py_XDECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000406 Py_XDECREF(f->f_encoding);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000407 drop_readahead(f);
Guido van Rossum9475a232001-10-05 20:51:39 +0000408 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000409}
410
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000411static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000412file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000413{
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000414 if (PyUnicode_Check(f->f_name)) {
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000415#ifdef Py_USING_UNICODE
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000416 PyObject *ret = NULL;
Neal Norwitzfc28e0d2006-07-16 02:32:03 +0000417 PyObject *name = PyUnicode_AsUnicodeEscapeString(f->f_name);
418 const char *name_str = name ? PyString_AsString(name) : "?";
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000419 ret = PyString_FromFormat("<%s file u'%s', mode '%s' at %p>",
420 f->f_fp == NULL ? "closed" : "open",
Neal Norwitzfc28e0d2006-07-16 02:32:03 +0000421 name_str,
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000422 PyString_AsString(f->f_mode),
423 f);
424 Py_XDECREF(name);
425 return ret;
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000426#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000427 } else {
428 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000429 f->f_fp == NULL ? "closed" : "open",
430 PyString_AsString(f->f_name),
431 PyString_AsString(f->f_mode),
432 f);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000433 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000434}
435
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000436static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000437file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000438{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000439 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000440 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000441 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000442 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000443 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000444 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000445 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000446 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000447 f->f_fp = NULL;
448 }
Martin v. Löwis7bbcde72003-09-07 20:42:29 +0000449 PyMem_Free(f->f_setbuf);
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000450 f->f_setbuf = NULL;
Guido van Rossumfebd5511992-03-04 16:39:24 +0000451 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000452 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000453 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000454 return PyInt_FromLong((long)sts);
455 Py_INCREF(Py_None);
456 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000457}
458
Trent Mickf29f47b2000-08-11 19:02:59 +0000459
Guido van Rossumb8552162001-09-05 14:58:11 +0000460/* Our very own off_t-like type, 64-bit if possible */
461#if !defined(HAVE_LARGEFILE_SUPPORT)
462typedef off_t Py_off_t;
463#elif SIZEOF_OFF_T >= 8
464typedef off_t Py_off_t;
465#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000466typedef fpos_t Py_off_t;
467#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000468#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000469#endif
470
471
Trent Mickf29f47b2000-08-11 19:02:59 +0000472/* a portable fseek() function
473 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000474static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000475_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000476{
Guido van Rossumb8552162001-09-05 14:58:11 +0000477#if !defined(HAVE_LARGEFILE_SUPPORT)
478 return fseek(fp, offset, whence);
479#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000480 return fseeko(fp, offset, whence);
481#elif defined(HAVE_FSEEK64)
482 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000483#elif defined(__BEOS__)
484 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000485#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000486 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
487 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000488 fpos_t pos;
489 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000490 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000491#ifdef MS_WINDOWS
492 fflush(fp);
493 if (_lseeki64(fileno(fp), 0, 2) == -1)
494 return -1;
495#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000496 if (fseek(fp, 0, SEEK_END) != 0)
497 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000498#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000499 /* fall through */
500 case SEEK_CUR:
501 if (fgetpos(fp, &pos) != 0)
502 return -1;
503 offset += pos;
504 break;
505 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000506 }
507 return fsetpos(fp, &offset);
508#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000509#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000510#endif
511}
512
513
514/* a portable ftell() function
515 Return -1 on failure with errno set appropriately, current file
516 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000517static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000518_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000519{
Guido van Rossumb8552162001-09-05 14:58:11 +0000520#if !defined(HAVE_LARGEFILE_SUPPORT)
521 return ftell(fp);
522#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
523 return ftello(fp);
524#elif defined(HAVE_FTELL64)
525 return ftell64(fp);
526#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000527 fpos_t pos;
528 if (fgetpos(fp, &pos) != 0)
529 return -1;
530 return pos;
531#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000532#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000533#endif
534}
535
536
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000537static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000538file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000539{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000540 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000541 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000542 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000543 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000544
Guido van Rossumd7297e61992-07-06 14:19:26 +0000545 if (f->f_fp == NULL)
546 return err_closed();
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000547 drop_readahead(f);
Guido van Rossumd7297e61992-07-06 14:19:26 +0000548 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000549 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000550 return NULL;
551#if !defined(HAVE_LARGEFILE_SUPPORT)
552 offset = PyInt_AsLong(offobj);
553#else
554 offset = PyLong_Check(offobj) ?
555 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
556#endif
557 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000558 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000559
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000560 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000561 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000562 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000563 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000564
Guido van Rossumff4949e1992-08-05 19:58:53 +0000565 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000566 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000567 clearerr(f->f_fp);
568 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000569 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000570 f->f_skipnextlf = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000571 Py_INCREF(Py_None);
572 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000573}
574
Trent Mickf29f47b2000-08-11 19:02:59 +0000575
Guido van Rossumd7047b31995-01-02 19:07:15 +0000576#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000577static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000578file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000579{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000580 Py_off_t newsize;
Tim Petersf1827cf2003-09-07 03:30:18 +0000581 PyObject *newsizeobj = NULL;
582 Py_off_t initialpos;
583 int ret;
Tim Peters86821b22001-01-07 21:19:34 +0000584
Guido van Rossumd7047b31995-01-02 19:07:15 +0000585 if (f->f_fp == NULL)
586 return err_closed();
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000587 if (!PyArg_UnpackTuple(args, "truncate", 0, 1, &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000588 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000589
Tim Petersf1827cf2003-09-07 03:30:18 +0000590 /* Get current file position. If the file happens to be open for
591 * update and the last operation was an input operation, C doesn't
592 * define what the later fflush() will do, but we promise truncate()
593 * won't change the current position (and fflush() *does* change it
594 * then at least on Windows). The easiest thing is to capture
595 * current pos now and seek back to it at the end.
596 */
597 Py_BEGIN_ALLOW_THREADS
598 errno = 0;
599 initialpos = _portable_ftell(f->f_fp);
600 Py_END_ALLOW_THREADS
601 if (initialpos == -1)
602 goto onioerror;
603
Tim Petersfb05db22002-03-11 00:24:00 +0000604 /* Set newsize to current postion if newsizeobj NULL, else to the
Tim Petersf1827cf2003-09-07 03:30:18 +0000605 * specified value.
606 */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000607 if (newsizeobj != NULL) {
608#if !defined(HAVE_LARGEFILE_SUPPORT)
609 newsize = PyInt_AsLong(newsizeobj);
610#else
611 newsize = PyLong_Check(newsizeobj) ?
612 PyLong_AsLongLong(newsizeobj) :
613 PyInt_AsLong(newsizeobj);
614#endif
615 if (PyErr_Occurred())
616 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000617 }
Tim Petersf1827cf2003-09-07 03:30:18 +0000618 else /* default to current position */
619 newsize = initialpos;
Tim Petersfb05db22002-03-11 00:24:00 +0000620
Tim Petersf1827cf2003-09-07 03:30:18 +0000621 /* Flush the stream. We're mixing stream-level I/O with lower-level
622 * I/O, and a flush may be necessary to synch both platform views
623 * of the current file state.
624 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000625 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000626 errno = 0;
627 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000628 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000629 if (ret != 0)
630 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000631
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000632#ifdef MS_WINDOWS
Tim Petersfb05db22002-03-11 00:24:00 +0000633 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000634 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000635 {
Tim Petersfb05db22002-03-11 00:24:00 +0000636 HANDLE hFile;
Tim Petersfb05db22002-03-11 00:24:00 +0000637
Tim Petersf1827cf2003-09-07 03:30:18 +0000638 /* Have to move current pos to desired endpoint on Windows. */
639 Py_BEGIN_ALLOW_THREADS
640 errno = 0;
641 ret = _portable_fseek(f->f_fp, newsize, SEEK_SET) != 0;
642 Py_END_ALLOW_THREADS
643 if (ret)
644 goto onioerror;
Tim Petersfb05db22002-03-11 00:24:00 +0000645
Tim Peters8f01b682002-03-12 03:04:44 +0000646 /* Truncate. Note that this may grow the file! */
647 Py_BEGIN_ALLOW_THREADS
648 errno = 0;
649 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
Tim Petersf1827cf2003-09-07 03:30:18 +0000650 ret = hFile == (HANDLE)-1;
651 if (ret == 0) {
652 ret = SetEndOfFile(hFile) == 0;
653 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000654 errno = EACCES;
655 }
656 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000657 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000658 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000659 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000660#else
661 Py_BEGIN_ALLOW_THREADS
662 errno = 0;
663 ret = ftruncate(fileno(f->f_fp), newsize);
664 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000665 if (ret != 0)
666 goto onioerror;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000667#endif /* !MS_WINDOWS */
Tim Peters86821b22001-01-07 21:19:34 +0000668
Tim Petersf1827cf2003-09-07 03:30:18 +0000669 /* Restore original file position. */
670 Py_BEGIN_ALLOW_THREADS
671 errno = 0;
672 ret = _portable_fseek(f->f_fp, initialpos, SEEK_SET) != 0;
673 Py_END_ALLOW_THREADS
674 if (ret)
675 goto onioerror;
676
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000677 Py_INCREF(Py_None);
678 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000679
680onioerror:
681 PyErr_SetFromErrno(PyExc_IOError);
682 clearerr(f->f_fp);
683 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000684}
685#endif /* HAVE_FTRUNCATE */
686
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000687static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000688file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000689{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000690 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000691
Guido van Rossumd7297e61992-07-06 14:19:26 +0000692 if (f->f_fp == NULL)
693 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000694 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000695 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000696 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000697 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000698 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000699 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000700 clearerr(f->f_fp);
701 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000702 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000703 if (f->f_skipnextlf) {
704 int c;
705 c = GETC(f->f_fp);
706 if (c == '\n') {
707 pos++;
708 f->f_skipnextlf = 0;
709 } else if (c != EOF) ungetc(c, f->f_fp);
710 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000711#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000712 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000713#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000714 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000715#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000716}
717
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000718static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000719file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000720{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000721 if (f->f_fp == NULL)
722 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000723 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000724}
725
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000726static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000727file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000728{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000729 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000730
Guido van Rossumd7297e61992-07-06 14:19:26 +0000731 if (f->f_fp == NULL)
732 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000733 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000734 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000735 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000736 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000737 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000738 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000739 clearerr(f->f_fp);
740 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000741 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000742 Py_INCREF(Py_None);
743 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000744}
745
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000746static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000747file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000748{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000749 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000750 if (f->f_fp == NULL)
751 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000752 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000753 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000754 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000755 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000756}
757
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000758
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000759#if BUFSIZ < 8192
760#define SMALLCHUNK 8192
761#else
762#define SMALLCHUNK BUFSIZ
763#endif
764
Guido van Rossum3c259041999-01-14 19:00:14 +0000765#if SIZEOF_INT < 4
766#define BIGCHUNK (512 * 32)
767#else
768#define BIGCHUNK (512 * 1024)
769#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000770
771static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000772new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000773{
774#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000775 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000776 struct stat st;
777 if (fstat(fileno(f->f_fp), &st) == 0) {
778 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000779 /* The following is not a bug: we really need to call lseek()
780 *and* ftell(). The reason is that some stdio libraries
781 mistakenly flush their buffer when ftell() is called and
782 the lseek() call it makes fails, thereby throwing away
783 data that cannot be recovered in any way. To avoid this,
784 we first test lseek(), and only call ftell() if lseek()
785 works. We can't use the lseek() value either, because we
786 need to take the amount of buffered data into account.
787 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000788 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000789 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000790 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000791 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000792 if (pos < 0)
793 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000794 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000795 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000796 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000797 }
798#endif
799 if (currentsize > SMALLCHUNK) {
800 /* Keep doubling until we reach BIGCHUNK;
801 then keep adding BIGCHUNK. */
802 if (currentsize <= BIGCHUNK)
803 return currentsize + currentsize;
804 else
805 return currentsize + BIGCHUNK;
806 }
807 return currentsize + SMALLCHUNK;
808}
809
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000810#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
811#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
812#else
813#ifdef EWOULDBLOCK
814#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
815#else
816#ifdef EAGAIN
817#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
818#else
819#define BLOCKED_ERRNO(x) 0
820#endif
821#endif
822#endif
823
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000824static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000825file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000826{
Guido van Rossum789a1611997-05-10 22:33:55 +0000827 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000828 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000829 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000830
Guido van Rossumd7297e61992-07-06 14:19:26 +0000831 if (f->f_fp == NULL)
832 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000833 /* refuse to mix with f.next() */
834 if (f->f_buf != NULL &&
835 (f->f_bufend - f->f_bufptr) > 0 &&
836 f->f_buf[0] != '\0')
837 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000838 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000839 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000840 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000841 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000842 else
843 buffersize = bytesrequested;
Martin v. Löwis2a190742006-04-13 07:37:25 +0000844 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000845 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000846 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000847 return NULL;
848 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000849 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000850 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000851 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000852 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000853 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000854 Py_BEGIN_ALLOW_THREADS
855 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000856 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000857 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000858 Py_END_ALLOW_THREADS
859 if (chunksize == 0) {
860 if (!ferror(f->f_fp))
861 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000862 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000863 /* When in non-blocking mode, data shouldn't
864 * be discarded if a blocking signal was
865 * received. That will also happen if
866 * chunksize != 0, but bytesread < buffersize. */
867 if (bytesread > 0 && BLOCKED_ERRNO(errno))
868 break;
869 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum6263d541997-05-10 22:07:25 +0000870 Py_DECREF(v);
871 return NULL;
872 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000873 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000874 if (bytesread < buffersize) {
875 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000876 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000877 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000878 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000879 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000880 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000881 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000882 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000883 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000884 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000885 }
886 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000887 if (bytesread != buffersize)
888 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000889 return v;
890}
891
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000892static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000893file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000894{
895 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000896 Py_ssize_t ntodo;
897 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000898
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000899 if (f->f_fp == NULL)
900 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000901 /* refuse to mix with f.next() */
902 if (f->f_buf != NULL &&
903 (f->f_bufend - f->f_bufptr) > 0 &&
904 f->f_buf[0] != '\0')
905 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000906 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000907 return NULL;
908 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000909 while (ntodo > 0) {
910 Py_BEGIN_ALLOW_THREADS
911 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000912 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000913 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000914 Py_END_ALLOW_THREADS
915 if (nnow == 0) {
916 if (!ferror(f->f_fp))
917 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000918 PyErr_SetFromErrno(PyExc_IOError);
919 clearerr(f->f_fp);
920 return NULL;
921 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000922 ndone += nnow;
923 ntodo -= nnow;
924 }
Neal Norwitz47f0ffa2006-08-21 18:44:09 +0000925 return PyInt_FromSsize_t(ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000926}
927
Tim Peters86821b22001-01-07 21:19:34 +0000928/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000929Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000930
931Under MSVC 6:
932
Tim Peters1c733232001-01-08 04:02:07 +0000933+ MS threadsafe getc is very slow (multiple layers of function calls before+
934 after each character, to lock+unlock the stream).
935+ The stream-locking functions are MS-internal -- can't access them from user
936 code.
937+ There's nothing Tim could find in the MS C or platform SDK libraries that
938 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000939+ MS fgets locks/unlocks only once per line; it's the only hook we have.
940
941So we use fgets for speed(!), despite that it's painful.
942
943MS realloc is also slow.
944
Tim Petersf29b64d2001-01-15 06:33:19 +0000945Reports from other platforms on this method vs getc_unlocked (which MS doesn't
946have):
947 Linux a wash
948 Solaris a wash
949 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000950
Tim Petersf29b64d2001-01-15 06:33:19 +0000951CAUTION: The C std isn't clear about this: in those cases where fgets
952writes something into the buffer, can it write into any position beyond the
953required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
954known on which it does; and it would be a strange way to code fgets. Still,
955getline_via_fgets may not work correctly if it does. The std test
956test_bufio.py should fail if platform fgets() routinely writes beyond the
957trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000958**************************************************************************/
959
Tim Petersf29b64d2001-01-15 06:33:19 +0000960/* Use this routine if told to, or by default on non-get_unlocked()
961 * platforms unless told not to. Yikes! Let's spell that out:
962 * On a platform with getc_unlocked():
963 * By default, use getc_unlocked().
964 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
965 * On a platform without getc_unlocked():
966 * By default, use fgets().
967 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
968 */
969#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
970#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000971#endif
972
Tim Petersf29b64d2001-01-15 06:33:19 +0000973#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
974#undef USE_FGETS_IN_GETLINE
975#endif
976
977#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000978static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000979getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000980{
Tim Peters15b83852001-01-08 00:53:12 +0000981/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000982 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
983 * to fill this much of the buffer with a known value in order to figure out
984 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
985 * than "most" lines, we waste time filling unused buffer slots. 100 is
986 * surely adequate for most peoples' email archives, chewing over source code,
987 * etc -- "regular old text files".
988 * MAXBUFSIZE is the maximum line length that lets us get away with the less
989 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
990 * cautions about boosting that. 300 was chosen because the worst real-life
991 * text-crunching job reported on Python-Dev was a mail-log crawler where over
992 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +0000993 */
Tim Peters142297a2001-01-15 10:36:56 +0000994#define INITBUFSIZE 100
995#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +0000996 char* p; /* temp */
997 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +0000998 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +0000999 char* pvfree; /* address of next free slot */
1000 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +00001001 size_t nfree; /* # of free buffer slots; pvend-pvfree */
1002 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001003 size_t increment; /* amount to increment the buffer */
Armin Rigo4b63c212006-10-04 11:44:06 +00001004 size_t prev_v_size;
Tim Peters86821b22001-01-07 21:19:34 +00001005
Tim Peters15b83852001-01-08 00:53:12 +00001006 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001007 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001008 */
Tim Peters142297a2001-01-15 10:36:56 +00001009 total_v_size = INITBUFSIZE; /* start small and pray */
1010 pvfree = buf;
1011 for (;;) {
1012 Py_BEGIN_ALLOW_THREADS
1013 pvend = buf + total_v_size;
1014 nfree = pvend - pvfree;
1015 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001016 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1017 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001018 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001019
Tim Peters142297a2001-01-15 10:36:56 +00001020 if (p == NULL) {
1021 clearerr(fp);
1022 if (PyErr_CheckSignals())
1023 return NULL;
1024 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001025 return v;
1026 }
Tim Peters142297a2001-01-15 10:36:56 +00001027 /* fgets read *something* */
1028 p = memchr(pvfree, '\n', nfree);
1029 if (p != NULL) {
1030 /* Did the \n come from fgets or from us?
1031 * Since fgets stops at the first \n, and then writes
1032 * \0, if it's from fgets a \0 must be next. But if
1033 * that's so, it could not have come from us, since
1034 * the \n's we filled the buffer with have only more
1035 * \n's to the right.
1036 */
1037 if (p+1 < pvend && *(p+1) == '\0') {
1038 /* It's from fgets: we win! In particular,
1039 * we haven't done any mallocs yet, and can
1040 * build the final result on the first try.
1041 */
1042 ++p; /* include \n from fgets */
1043 }
1044 else {
1045 /* Must be from us: fgets didn't fill the
1046 * buffer and didn't find a newline, so it
1047 * must be the last and newline-free line of
1048 * the file.
1049 */
1050 assert(p > pvfree && *(p-1) == '\0');
1051 --p; /* don't include \0 from fgets */
1052 }
1053 v = PyString_FromStringAndSize(buf, p - buf);
1054 return v;
1055 }
1056 /* yuck: fgets overwrote all the newlines, i.e. the entire
1057 * buffer. So this line isn't over yet, or maybe it is but
1058 * we're exactly at EOF. If we haven't already, try using the
1059 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001060 */
Tim Peters142297a2001-01-15 10:36:56 +00001061 assert(*(pvend-1) == '\0');
1062 if (pvfree == buf) {
1063 pvfree = pvend - 1; /* overwrite trailing null */
1064 total_v_size = MAXBUFSIZE;
1065 }
1066 else
1067 break;
Tim Peters86821b22001-01-07 21:19:34 +00001068 }
Tim Peters142297a2001-01-15 10:36:56 +00001069
1070 /* The stack buffer isn't big enough; malloc a string object and read
1071 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001072 */
Tim Petersddea2082002-03-23 10:03:50 +00001073 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001074 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001075 if (v == NULL)
1076 return v;
1077 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001078 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1079 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001080
1081 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001082 * after setting p one beyond the end of the line. The code here is
1083 * very much like the code above, except reads into v's buffer; see
1084 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001085 */
1086 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001087 Py_BEGIN_ALLOW_THREADS
1088 pvend = BUF(v) + total_v_size;
1089 nfree = pvend - pvfree;
1090 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001091 assert(nfree < INT_MAX);
1092 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001093 Py_END_ALLOW_THREADS
1094
1095 if (p == NULL) {
1096 clearerr(fp);
1097 if (PyErr_CheckSignals()) {
1098 Py_DECREF(v);
1099 return NULL;
1100 }
1101 p = pvfree;
1102 break;
1103 }
Tim Peters86821b22001-01-07 21:19:34 +00001104 p = memchr(pvfree, '\n', nfree);
1105 if (p != NULL) {
1106 if (p+1 < pvend && *(p+1) == '\0') {
1107 /* \n came from fgets */
1108 ++p;
1109 break;
1110 }
1111 /* \n came from us; last line of file, no newline */
1112 assert(p > pvfree && *(p-1) == '\0');
1113 --p;
1114 break;
1115 }
1116 /* expand buffer and try again */
1117 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001118 increment = total_v_size >> 2; /* mild exponential growth */
Armin Rigo4b63c212006-10-04 11:44:06 +00001119 prev_v_size = total_v_size;
Tim Petersddea2082002-03-23 10:03:50 +00001120 total_v_size += increment;
Armin Rigo4b63c212006-10-04 11:44:06 +00001121 /* check for overflow */
1122 if (total_v_size <= prev_v_size ||
1123 total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001124 PyErr_SetString(PyExc_OverflowError,
1125 "line is longer than a Python string can hold");
1126 Py_DECREF(v);
1127 return NULL;
1128 }
1129 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1130 return NULL;
1131 /* overwrite the trailing null byte */
Armin Rigo4b63c212006-10-04 11:44:06 +00001132 pvfree = BUF(v) + (prev_v_size - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001133 }
1134 if (BUF(v) + total_v_size != p)
1135 _PyString_Resize(&v, p - BUF(v));
1136 return v;
1137#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001138#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001139}
Tim Petersf29b64d2001-01-15 06:33:19 +00001140#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001141
Guido van Rossum0bd24411991-04-04 15:21:57 +00001142/* Internal routine to get a line.
1143 Size argument interpretation:
1144 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001145 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001146*/
1147
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001148static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001149get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001150{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001151 FILE *fp = f->f_fp;
1152 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001153 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001154 size_t total_v_size; /* total # of slots in buffer */
1155 size_t used_v_size; /* # used slots in buffer */
1156 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001157 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001158 int newlinetypes = f->f_newlinetypes;
1159 int skipnextlf = f->f_skipnextlf;
1160 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001161
Jack Jansen7b8c7542002-04-14 20:12:41 +00001162#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001163 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001164 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001165#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001166 total_v_size = n > 0 ? n : 100;
1167 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001168 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001169 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001170 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001171 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001172
Guido van Rossumce5ba841991-03-06 13:06:18 +00001173 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001174 Py_BEGIN_ALLOW_THREADS
1175 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001176 if (univ_newline) {
1177 c = 'x'; /* Shut up gcc warning */
1178 while ( buf != end && (c = GETC(fp)) != EOF ) {
1179 if (skipnextlf ) {
1180 skipnextlf = 0;
1181 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001182 /* Seeing a \n here with
1183 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001184 * saw a \r before.
1185 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001186 newlinetypes |= NEWLINE_CRLF;
1187 c = GETC(fp);
1188 if (c == EOF) break;
1189 } else {
1190 newlinetypes |= NEWLINE_CR;
1191 }
1192 }
1193 if (c == '\r') {
1194 skipnextlf = 1;
1195 c = '\n';
1196 } else if ( c == '\n')
1197 newlinetypes |= NEWLINE_LF;
1198 *buf++ = c;
1199 if (c == '\n') break;
1200 }
1201 if ( c == EOF && skipnextlf )
1202 newlinetypes |= NEWLINE_CR;
1203 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001204 while ((c = GETC(fp)) != EOF &&
1205 (*buf++ = c) != '\n' &&
1206 buf != end)
1207 ;
1208 FUNLOCKFILE(fp);
1209 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001210 f->f_newlinetypes = newlinetypes;
1211 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001212 if (c == '\n')
1213 break;
1214 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001215 if (ferror(fp)) {
1216 PyErr_SetFromErrno(PyExc_IOError);
1217 clearerr(fp);
1218 Py_DECREF(v);
1219 return NULL;
1220 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001221 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001222 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001223 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001224 return NULL;
1225 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001226 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001227 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001228 /* Must be because buf == end */
1229 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001230 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001231 used_v_size = total_v_size;
1232 increment = total_v_size >> 2; /* mild exponential growth */
1233 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001234 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001235 PyErr_SetString(PyExc_OverflowError,
1236 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001237 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001238 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001239 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001240 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001241 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001242 buf = BUF(v) + used_v_size;
1243 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001244 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001245
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001246 used_v_size = buf - BUF(v);
1247 if (used_v_size != total_v_size)
1248 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001249 return v;
1250}
1251
Guido van Rossum0bd24411991-04-04 15:21:57 +00001252/* External C interface */
1253
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001254PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001255PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001256{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001257 PyObject *result;
1258
Guido van Rossum3165fe61992-09-25 21:59:05 +00001259 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001260 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001261 return NULL;
1262 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001263
1264 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001265 PyFileObject *fo = (PyFileObject *)f;
1266 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001267 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001268 /* refuse to mix with f.next() */
1269 if (fo->f_buf != NULL &&
1270 (fo->f_bufend - fo->f_bufptr) > 0 &&
1271 fo->f_buf[0] != '\0')
1272 return err_iterbuffered();
1273 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001274 }
1275 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001276 PyObject *reader;
1277 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001278
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001279 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001280 if (reader == NULL)
1281 return NULL;
1282 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001283 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001284 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001285 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001286 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001287 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001288 return NULL;
1289 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001290 result = PyEval_CallObject(reader, args);
1291 Py_DECREF(reader);
1292 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001293 if (result != NULL && !PyString_Check(result) &&
1294 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001295 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001296 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001297 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001298 "object.readline() returned non-string");
1299 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001300 }
1301
1302 if (n < 0 && result != NULL && PyString_Check(result)) {
1303 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001304 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001305 if (len == 0) {
1306 Py_DECREF(result);
1307 result = NULL;
1308 PyErr_SetString(PyExc_EOFError,
1309 "EOF when reading a line");
1310 }
1311 else if (s[len-1] == '\n') {
1312 if (result->ob_refcnt == 1)
1313 _PyString_Resize(&result, len-1);
1314 else {
1315 PyObject *v;
1316 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001317 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001318 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001319 }
1320 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001321 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001322#ifdef Py_USING_UNICODE
1323 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1324 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001325 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001326 if (len == 0) {
1327 Py_DECREF(result);
1328 result = NULL;
1329 PyErr_SetString(PyExc_EOFError,
1330 "EOF when reading a line");
1331 }
1332 else if (s[len-1] == '\n') {
1333 if (result->ob_refcnt == 1)
1334 PyUnicode_Resize(&result, len-1);
1335 else {
1336 PyObject *v;
1337 v = PyUnicode_FromUnicode(s, len-1);
1338 Py_DECREF(result);
1339 result = v;
1340 }
1341 }
1342 }
1343#endif
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001344 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001345}
1346
1347/* Python method */
1348
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001349static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001350file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001351{
Guido van Rossum789a1611997-05-10 22:33:55 +00001352 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001353
Guido van Rossumd7297e61992-07-06 14:19:26 +00001354 if (f->f_fp == NULL)
1355 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001356 /* refuse to mix with f.next() */
1357 if (f->f_buf != NULL &&
1358 (f->f_bufend - f->f_bufptr) > 0 &&
1359 f->f_buf[0] != '\0')
1360 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001361 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001362 return NULL;
1363 if (n == 0)
1364 return PyString_FromString("");
1365 if (n < 0)
1366 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001367 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001368}
1369
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001370static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001371file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001372{
Guido van Rossum789a1611997-05-10 22:33:55 +00001373 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001374 PyObject *list;
1375 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001376 char small_buffer[SMALLCHUNK];
1377 char *buffer = small_buffer;
1378 size_t buffersize = SMALLCHUNK;
1379 PyObject *big_buffer = NULL;
1380 size_t nfilled = 0;
1381 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001382 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001383 char *p, *q, *end;
1384 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001385 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001386
Guido van Rossumd7297e61992-07-06 14:19:26 +00001387 if (f->f_fp == NULL)
1388 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001389 /* refuse to mix with f.next() */
1390 if (f->f_buf != NULL &&
1391 (f->f_bufend - f->f_bufptr) > 0 &&
1392 f->f_buf[0] != '\0')
1393 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001394 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001395 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001396 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001397 return NULL;
1398 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001399 if (shortread)
1400 nread = 0;
1401 else {
1402 Py_BEGIN_ALLOW_THREADS
1403 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001404 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001405 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001406 Py_END_ALLOW_THREADS
1407 shortread = (nread < buffersize-nfilled);
1408 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001409 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001410 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001411 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001412 break;
1413 PyErr_SetFromErrno(PyExc_IOError);
1414 clearerr(f->f_fp);
1415 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001416 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001417 list = NULL;
1418 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001419 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001420 totalread += nread;
Anthony Baxter377be112006-04-11 06:54:30 +00001421 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001422 if (p == NULL) {
1423 /* Need a larger buffer to fit this line */
1424 nfilled += nread;
1425 buffersize *= 2;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001426 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001427 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001428 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001429 goto error;
1430 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001431 if (big_buffer == NULL) {
1432 /* Create the big buffer */
1433 big_buffer = PyString_FromStringAndSize(
1434 NULL, buffersize);
1435 if (big_buffer == NULL)
1436 goto error;
1437 buffer = PyString_AS_STRING(big_buffer);
1438 memcpy(buffer, small_buffer, nfilled);
1439 }
1440 else {
1441 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001442 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1443 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001444 buffer = PyString_AS_STRING(big_buffer);
1445 }
1446 continue;
1447 }
1448 end = buffer+nfilled+nread;
1449 q = buffer;
1450 do {
1451 /* Process complete lines */
1452 p++;
1453 line = PyString_FromStringAndSize(q, p-q);
1454 if (line == NULL)
1455 goto error;
1456 err = PyList_Append(list, line);
1457 Py_DECREF(line);
1458 if (err != 0)
1459 goto error;
1460 q = p;
Anthony Baxter377be112006-04-11 06:54:30 +00001461 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001462 } while (p != NULL);
1463 /* Move the remaining incomplete line to the start */
1464 nfilled = end-q;
1465 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001466 if (sizehint > 0)
1467 if (totalread >= (size_t)sizehint)
1468 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001469 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001470 if (nfilled != 0) {
1471 /* Partial last line */
1472 line = PyString_FromStringAndSize(buffer, nfilled);
1473 if (line == NULL)
1474 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001475 if (sizehint > 0) {
1476 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001477 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001478 if (rest == NULL) {
1479 Py_DECREF(line);
1480 goto error;
1481 }
1482 PyString_Concat(&line, rest);
1483 Py_DECREF(rest);
1484 if (line == NULL)
1485 goto error;
1486 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001487 err = PyList_Append(list, line);
1488 Py_DECREF(line);
1489 if (err != 0)
1490 goto error;
1491 }
1492 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001493 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001494 return list;
1495}
1496
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001497static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001498file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001499{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001500 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001501 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001502 if (f->f_fp == NULL)
1503 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001504 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001505 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001506 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001507 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001508 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001509 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001510 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001511 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001512 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001513 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001514 return NULL;
1515 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001516 Py_INCREF(Py_None);
1517 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001518}
1519
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001520static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001521file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001522{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001523#define CHUNKSIZE 1000
1524 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001525 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001526 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001527 int index, islist;
1528 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001529
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001530 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001531 if (f->f_fp == NULL)
1532 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001533
1534 result = NULL;
1535 list = NULL;
1536 islist = PyList_Check(seq);
1537 if (islist)
1538 it = NULL;
1539 else {
1540 it = PyObject_GetIter(seq);
1541 if (it == NULL) {
1542 PyErr_SetString(PyExc_TypeError,
1543 "writelines() requires an iterable argument");
1544 return NULL;
1545 }
1546 /* From here on, fail by going to error, to reclaim "it". */
1547 list = PyList_New(CHUNKSIZE);
1548 if (list == NULL)
1549 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001550 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001551
1552 /* Strategy: slurp CHUNKSIZE lines into a private list,
1553 checking that they are all strings, then write that list
1554 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001555 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001556 if (islist) {
1557 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001558 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001559 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001560 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001561 j = PyList_GET_SIZE(list);
1562 }
1563 else {
1564 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001565 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001566 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001567 if (PyErr_Occurred())
1568 goto error;
1569 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001570 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001571 PyList_SetItem(list, j, line);
1572 }
1573 }
1574 if (j == 0)
1575 break;
1576
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001577 /* Check that all entries are indeed strings. If not,
1578 apply the same rules as for file.write() and
1579 convert the results to strings. This is slow, but
1580 seems to be the only way since all conversion APIs
1581 could potentially execute Python code. */
1582 for (i = 0; i < j; i++) {
1583 PyObject *v = PyList_GET_ITEM(list, i);
1584 if (!PyString_Check(v)) {
1585 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001586 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001587 PyObject_AsReadBuffer(v,
1588 (const void**)&buffer,
1589 &len)) ||
1590 PyObject_AsCharBuffer(v,
1591 &buffer,
1592 &len))) {
1593 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001594 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001595 goto error;
1596 }
1597 line = PyString_FromStringAndSize(buffer,
1598 len);
1599 if (line == NULL)
1600 goto error;
1601 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001602 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001603 }
1604 }
1605
1606 /* Since we are releasing the global lock, the
1607 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001608 Py_BEGIN_ALLOW_THREADS
1609 f->f_softspace = 0;
1610 errno = 0;
1611 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001612 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001613 len = PyString_GET_SIZE(line);
1614 nwritten = fwrite(PyString_AS_STRING(line),
1615 1, len, f->f_fp);
1616 if (nwritten != len) {
1617 Py_BLOCK_THREADS
1618 PyErr_SetFromErrno(PyExc_IOError);
1619 clearerr(f->f_fp);
1620 goto error;
1621 }
1622 }
1623 Py_END_ALLOW_THREADS
1624
1625 if (j < CHUNKSIZE)
1626 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001627 }
1628
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001629 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001630 result = Py_None;
1631 error:
1632 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001633 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001634 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001635#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001636}
1637
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001638static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001639file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001640{
1641 if (f->f_fp == NULL)
1642 return err_closed();
1643 Py_INCREF(f);
1644 return (PyObject *)f;
1645}
1646
Georg Brandl98b40ad2006-06-08 14:50:21 +00001647static PyObject *
1648file_exit(PyFileObject *f, PyObject *args)
1649{
1650 PyObject *ret = file_close(f);
1651 if (!ret)
1652 /* If error occurred, pass through */
1653 return NULL;
1654 Py_DECREF(ret);
1655 /* We cannot return the result of close since a true
1656 * value will be interpreted as "yes, swallow the
1657 * exception if one was raised inside the with block". */
1658 Py_RETURN_NONE;
1659}
1660
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001661PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001662"readline([size]) -> next line from the file, as a string.\n"
1663"\n"
1664"Retain newline. A non-negative size argument limits the maximum\n"
1665"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001666"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001667
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001668PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001669"read([size]) -> read at most size bytes, returned as a string.\n"
1670"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001671"If the size argument is negative or omitted, read until EOF is reached.\n"
1672"Notice that when in non-blocking mode, less data than what was requested\n"
1673"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001674
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001675PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001676"write(str) -> None. Write string str to file.\n"
1677"\n"
1678"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001679"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001680
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001681PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001682"fileno() -> integer \"file descriptor\".\n"
1683"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001684"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001685
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001686PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001687"seek(offset[, whence]) -> None. Move to new file position.\n"
1688"\n"
1689"Argument offset is a byte count. Optional argument whence defaults to\n"
1690"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1691"(move relative to current position, positive or negative), and 2 (move\n"
1692"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001693"seeking beyond the end of a file). If the file is opened in text mode,\n"
1694"only offsets returned by tell() are legal. Use of other offsets causes\n"
1695"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001696"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001697"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001698
Guido van Rossumd7047b31995-01-02 19:07:15 +00001699#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001700PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001701"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1702"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001703"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001704#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001705
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001706PyDoc_STRVAR(tell_doc,
1707"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001708
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001709PyDoc_STRVAR(readinto_doc,
1710"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001711
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001712PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001713"readlines([size]) -> list of strings, each a line from the file.\n"
1714"\n"
1715"Call readline() repeatedly and return a list of the lines so read.\n"
1716"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001717"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001718
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001719PyDoc_STRVAR(xreadlines_doc,
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001720"xreadlines() -> returns self.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001721"\n"
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001722"For backward compatibility. File objects now include the performance\n"
1723"optimizations previously implemented in the xreadlines module.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001724
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001725PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001726"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001727"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001728"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001729"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001730
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001731PyDoc_STRVAR(flush_doc,
1732"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001733
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001734PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001735"close() -> None or (perhaps) an integer. Close the file.\n"
1736"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001737"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001738"further I/O operations. close() may be called more than once without\n"
1739"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001740"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001741
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001742PyDoc_STRVAR(isatty_doc,
1743"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001744
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001745PyDoc_STRVAR(enter_doc,
1746 "__enter__() -> self.");
1747
Georg Brandl98b40ad2006-06-08 14:50:21 +00001748PyDoc_STRVAR(exit_doc,
1749 "__exit__(*excinfo) -> None. Closes the file.");
1750
Tim Petersefc3a3a2001-09-20 07:55:22 +00001751static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001752 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1753 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1754 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1755 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1756 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001757#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001758 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001759#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001760 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1761 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1762 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001763 {"xreadlines",(PyCFunction)file_self, METH_NOARGS, xreadlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001764 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1765 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1766 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1767 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001768 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Georg Brandl98b40ad2006-06-08 14:50:21 +00001769 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001770 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001771};
1772
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001773#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001774
Guido van Rossum6f799372001-09-20 20:46:19 +00001775static PyMemberDef file_memberlist[] = {
1776 {"softspace", T_INT, OFF(f_softspace), 0,
1777 "flag indicating that a space needs to be printed; used by print"},
1778 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001779 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001780 {"name", T_OBJECT, OFF(f_name), RO,
1781 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001782 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1783 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001784 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001785 {NULL} /* Sentinel */
1786};
1787
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001788static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001789get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001790{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001791 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001792}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001793static PyObject *
1794get_newlines(PyFileObject *f, void *closure)
1795{
1796 switch (f->f_newlinetypes) {
1797 case NEWLINE_UNKNOWN:
1798 Py_INCREF(Py_None);
1799 return Py_None;
1800 case NEWLINE_CR:
1801 return PyString_FromString("\r");
1802 case NEWLINE_LF:
1803 return PyString_FromString("\n");
1804 case NEWLINE_CR|NEWLINE_LF:
1805 return Py_BuildValue("(ss)", "\r", "\n");
1806 case NEWLINE_CRLF:
1807 return PyString_FromString("\r\n");
1808 case NEWLINE_CR|NEWLINE_CRLF:
1809 return Py_BuildValue("(ss)", "\r", "\r\n");
1810 case NEWLINE_LF|NEWLINE_CRLF:
1811 return Py_BuildValue("(ss)", "\n", "\r\n");
1812 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1813 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1814 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001815 PyErr_Format(PyExc_SystemError,
1816 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001817 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001818 return NULL;
1819 }
1820}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001821
Guido van Rossum32d34c82001-09-20 21:45:26 +00001822static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001823 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001824 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001825 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001826 {0},
1827};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001828
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001829static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001830drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001831{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001832 if (f->f_buf != NULL) {
1833 PyMem_Free(f->f_buf);
1834 f->f_buf = NULL;
1835 }
Guido van Rossum65967252001-04-21 13:20:18 +00001836}
1837
Tim Petersf1827cf2003-09-07 03:30:18 +00001838/* Make sure that file has a readahead buffer with at least one byte
1839 (unless at EOF) and no more than bufsize. Returns negative value on
Georg Brandled02eb62006-03-31 20:31:02 +00001840 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001841static int
1842readahead(PyFileObject *f, int bufsize)
1843{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001844 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001845
1846 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001847 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001848 return 0;
1849 else
1850 drop_readahead(f);
1851 }
Anthony Baxter377be112006-04-11 06:54:30 +00001852 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
Georg Brandled02eb62006-03-31 20:31:02 +00001853 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001854 return -1;
1855 }
1856 Py_BEGIN_ALLOW_THREADS
1857 errno = 0;
1858 chunksize = Py_UniversalNewlineFread(
1859 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1860 Py_END_ALLOW_THREADS
1861 if (chunksize == 0) {
1862 if (ferror(f->f_fp)) {
1863 PyErr_SetFromErrno(PyExc_IOError);
1864 clearerr(f->f_fp);
1865 drop_readahead(f);
1866 return -1;
1867 }
1868 }
1869 f->f_bufptr = f->f_buf;
1870 f->f_bufend = f->f_buf + chunksize;
1871 return 0;
1872}
1873
1874/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001875 uninitialized bytes followed by the remainder of the line. Don't be
1876 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001877 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1878
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001879static PyStringObject *
1880readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1881{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001882 PyStringObject* s;
1883 char *bufptr;
1884 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001885 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001886
1887 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001888 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001889 return NULL;
1890
1891 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001892 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001893 return (PyStringObject *)
1894 PyString_FromStringAndSize(NULL, skip);
Anthony Baxter377be112006-04-11 06:54:30 +00001895 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001896 if (bufptr != NULL) {
1897 bufptr++; /* Count the '\n' */
1898 len = bufptr - f->f_bufptr;
1899 s = (PyStringObject *)
1900 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001901 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001902 return NULL;
1903 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1904 f->f_bufptr = bufptr;
1905 if (bufptr == f->f_bufend)
1906 drop_readahead(f);
1907 } else {
1908 bufptr = f->f_bufptr;
1909 buf = f->f_buf;
1910 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001911 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001912 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001913 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001914 if (s == NULL) {
1915 PyMem_Free(buf);
1916 return NULL;
1917 }
1918 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1919 PyMem_Free(buf);
1920 }
1921 return s;
1922}
1923
1924/* A larger buffer size may actually decrease performance. */
1925#define READAHEAD_BUFSIZE 8192
1926
1927static PyObject *
1928file_iternext(PyFileObject *f)
1929{
1930 PyStringObject* l;
1931
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001932 if (f->f_fp == NULL)
1933 return err_closed();
1934
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001935 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1936 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1937 Py_XDECREF(l);
1938 return NULL;
1939 }
1940 return (PyObject *)l;
1941}
1942
1943
Tim Peters59c9a642001-09-13 05:38:56 +00001944static PyObject *
1945file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1946{
Tim Peters44410012001-09-14 03:26:08 +00001947 PyObject *self;
1948 static PyObject *not_yet_string;
1949
1950 assert(type != NULL && type->tp_alloc != NULL);
1951
1952 if (not_yet_string == NULL) {
1953 not_yet_string = PyString_FromString("<uninitialized file>");
1954 if (not_yet_string == NULL)
1955 return NULL;
1956 }
1957
1958 self = type->tp_alloc(type, 0);
1959 if (self != NULL) {
1960 /* Always fill in the name and mode, so that nobody else
1961 needs to special-case NULLs there. */
1962 Py_INCREF(not_yet_string);
1963 ((PyFileObject *)self)->f_name = not_yet_string;
1964 Py_INCREF(not_yet_string);
1965 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001966 Py_INCREF(Py_None);
1967 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001968 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001969 }
1970 return self;
1971}
1972
1973static int
1974file_init(PyObject *self, PyObject *args, PyObject *kwds)
1975{
1976 PyFileObject *foself = (PyFileObject *)self;
1977 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001978 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001979 char *name = NULL;
1980 char *mode = "r";
1981 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001982 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001983
1984 assert(PyFile_Check(self));
1985 if (foself->f_fp != NULL) {
1986 /* Have to close the existing file first. */
1987 PyObject *closeresult = file_close(foself);
1988 if (closeresult == NULL)
1989 return -1;
1990 Py_DECREF(closeresult);
1991 }
Tim Peters59c9a642001-09-13 05:38:56 +00001992
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001993#ifdef Py_WIN_WIDE_FILENAMES
1994 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
1995 PyObject *po;
1996 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
1997 kwlist, &po, &mode, &bufsize)) {
1998 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00001999 if (fill_file_fields(foself, NULL, po, mode,
2000 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002001 goto Error;
2002 } else {
2003 /* Drop the argument parsing error as narrow
2004 strings are also valid. */
2005 PyErr_Clear();
2006 }
2007 }
2008#endif
2009
2010 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002011 PyObject *o_name;
2012
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002013 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2014 Py_FileSystemDefaultEncoding,
2015 &name,
2016 &mode, &bufsize))
2017 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002018
2019 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002020 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2021 kwlist, &o_name, &mode,
2022 &bufsize))
Neal Norwitzfe50f8e2006-09-05 04:32:06 +00002023 goto Error;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002024
2025 if (fill_file_fields(foself, NULL, o_name, mode,
2026 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002027 goto Error;
2028 }
Tim Peters44410012001-09-14 03:26:08 +00002029 if (open_the_file(foself, name, mode) == NULL)
2030 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002031 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002032 PyFile_SetBufSize(self, bufsize);
2033 goto Done;
2034
2035Error:
2036 ret = -1;
2037 /* fall through */
2038Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002039 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002040 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002041}
2042
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002043PyDoc_VAR(file_doc) =
2044PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002045"file(name[, mode[, buffering]]) -> file object\n"
2046"\n"
2047"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2048"writing or appending. The file will be created if it doesn't exist\n"
2049"when opened for writing or appending; it will be truncated when\n"
2050"opened for writing. Add a 'b' to the mode for binary files.\n"
2051"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2052"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002053"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002054)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002055PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002056"Add a 'U' to mode to open the file for input with universal newline\n"
2057"support. Any line ending in the input file will be seen as a '\\n'\n"
2058"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2059"the value for this attribute is one of None (no newline read yet),\n"
2060"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2061"\n"
2062"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002063);
Tim Peters59c9a642001-09-13 05:38:56 +00002064
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002065PyTypeObject PyFile_Type = {
2066 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002067 0,
2068 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002069 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002070 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002071 (destructor)file_dealloc, /* tp_dealloc */
2072 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002073 0, /* tp_getattr */
2074 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002075 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002076 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002077 0, /* tp_as_number */
2078 0, /* tp_as_sequence */
2079 0, /* tp_as_mapping */
2080 0, /* tp_hash */
2081 0, /* tp_call */
2082 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002083 PyObject_GenericGetAttr, /* tp_getattro */
Tim Peters015dd822003-05-04 04:16:52 +00002084 /* softspace is writable: we must supply tp_setattro */
2085 PyObject_GenericSetAttr, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002086 0, /* tp_as_buffer */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002087 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002088 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002089 0, /* tp_traverse */
2090 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002091 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002092 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002093 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002094 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002095 file_methods, /* tp_methods */
2096 file_memberlist, /* tp_members */
2097 file_getsetlist, /* tp_getset */
2098 0, /* tp_base */
2099 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002100 0, /* tp_descr_get */
2101 0, /* tp_descr_set */
2102 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002103 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002104 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002105 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002106 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002107};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002108
2109/* Interface for the 'soft space' between print items. */
2110
2111int
Fred Drakefd99de62000-07-09 05:02:18 +00002112PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00002113{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002114 long oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002115 if (f == NULL) {
2116 /* Do nothing */
2117 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002118 else if (PyFile_Check(f)) {
2119 oldflag = ((PyFileObject *)f)->f_softspace;
2120 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002121 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00002122 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002123 PyObject *v;
2124 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002125 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002126 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002127 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002128 if (PyInt_Check(v))
2129 oldflag = PyInt_AsLong(v);
Martin v. Löwis18e16552006-02-15 17:27:45 +00002130 assert(oldflag < INT_MAX);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002131 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002132 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002133 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002134 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002135 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002136 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002137 if (PyObject_SetAttrString(f, "softspace", v) != 0)
2138 PyErr_Clear();
2139 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002140 }
2141 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002142 return (int)oldflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002143}
Guido van Rossum3165fe61992-09-25 21:59:05 +00002144
2145/* Interfaces to write objects/strings to file-like objects */
2146
2147int
Fred Drakefd99de62000-07-09 05:02:18 +00002148PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002149{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002150 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002151 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002152 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002153 return -1;
2154 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002155 else if (PyFile_Check(f)) {
2156 FILE *fp = PyFile_AsFile(f);
Fred Drake086a0f72004-03-19 15:22:36 +00002157#ifdef Py_USING_UNICODE
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002158 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2159 int result;
Fred Drake086a0f72004-03-19 15:22:36 +00002160#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002161 if (fp == NULL) {
2162 err_closed();
2163 return -1;
2164 }
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002165#ifdef Py_USING_UNICODE
Tim Petersf1827cf2003-09-07 03:30:18 +00002166 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002167 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002168 char *cenc = PyString_AS_STRING(enc);
2169 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2170 if (value == NULL)
2171 return -1;
2172 } else {
2173 value = v;
2174 Py_INCREF(value);
2175 }
2176 result = PyObject_Print(value, fp, flags);
2177 Py_DECREF(value);
2178 return result;
2179#else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002180 return PyObject_Print(v, fp, flags);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002181#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002182 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002183 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002184 if (writer == NULL)
2185 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002186 if (flags & Py_PRINT_RAW) {
2187 if (PyUnicode_Check(v)) {
2188 value = v;
2189 Py_INCREF(value);
2190 } else
2191 value = PyObject_Str(v);
2192 }
2193 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002194 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002195 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002196 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002197 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002198 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002199 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002200 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002201 Py_DECREF(value);
2202 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002203 return -1;
2204 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002205 result = PyEval_CallObject(writer, args);
2206 Py_DECREF(args);
2207 Py_DECREF(value);
2208 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002209 if (result == NULL)
2210 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002211 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002212 return 0;
2213}
2214
Guido van Rossum27a60b11997-05-22 22:25:11 +00002215int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002216PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002217{
2218 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002219 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002220 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002221 PyErr_SetString(PyExc_SystemError,
2222 "null file for PyFile_WriteString");
2223 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002224 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002225 else if (PyFile_Check(f)) {
2226 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002227 if (fp == NULL) {
2228 err_closed();
2229 return -1;
2230 }
2231 fputs(s, fp);
2232 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002233 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002234 else if (!PyErr_Occurred()) {
2235 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002236 int err;
2237 if (v == NULL)
2238 return -1;
2239 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2240 Py_DECREF(v);
2241 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002242 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002243 else
2244 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002245}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002246
2247/* Try to get a file-descriptor from a Python object. If the object
2248 is an integer or long integer, its value is returned. If not, the
2249 object's fileno() method is called if it exists; the method must return
2250 an integer or long integer, which is returned as the file descriptor value.
2251 -1 is returned on failure.
2252*/
2253
2254int PyObject_AsFileDescriptor(PyObject *o)
2255{
2256 int fd;
2257 PyObject *meth;
2258
2259 if (PyInt_Check(o)) {
2260 fd = PyInt_AsLong(o);
2261 }
2262 else if (PyLong_Check(o)) {
2263 fd = PyLong_AsLong(o);
2264 }
2265 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2266 {
2267 PyObject *fno = PyEval_CallObject(meth, NULL);
2268 Py_DECREF(meth);
2269 if (fno == NULL)
2270 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002271
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002272 if (PyInt_Check(fno)) {
2273 fd = PyInt_AsLong(fno);
2274 Py_DECREF(fno);
2275 }
2276 else if (PyLong_Check(fno)) {
2277 fd = PyLong_AsLong(fno);
2278 Py_DECREF(fno);
2279 }
2280 else {
2281 PyErr_SetString(PyExc_TypeError,
2282 "fileno() returned a non-integer");
2283 Py_DECREF(fno);
2284 return -1;
2285 }
2286 }
2287 else {
2288 PyErr_SetString(PyExc_TypeError,
2289 "argument must be an int, or have a fileno() method.");
2290 return -1;
2291 }
2292
2293 if (fd < 0) {
2294 PyErr_Format(PyExc_ValueError,
2295 "file descriptor cannot be a negative integer (%i)",
2296 fd);
2297 return -1;
2298 }
2299 return fd;
2300}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002301
Jack Jansen7b8c7542002-04-14 20:12:41 +00002302/* From here on we need access to the real fgets and fread */
2303#undef fgets
2304#undef fread
2305
2306/*
2307** Py_UniversalNewlineFgets is an fgets variation that understands
2308** all of \r, \n and \r\n conventions.
2309** The stream should be opened in binary mode.
2310** If fobj is NULL the routine always does newline conversion, and
2311** it may peek one char ahead to gobble the second char in \r\n.
2312** If fobj is non-NULL it must be a PyFileObject. In this case there
2313** is no readahead but in stead a flag is used to skip a following
2314** \n on the next read. Also, if the file is open in binary mode
2315** the whole conversion is skipped. Finally, the routine keeps track of
2316** the different types of newlines seen.
2317** Note that we need no error handling: fgets() treats error and eof
2318** identically.
2319*/
2320char *
2321Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2322{
2323 char *p = buf;
2324 int c;
2325 int newlinetypes = 0;
2326 int skipnextlf = 0;
2327 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002328
Jack Jansen7b8c7542002-04-14 20:12:41 +00002329 if (fobj) {
2330 if (!PyFile_Check(fobj)) {
2331 errno = ENXIO; /* What can you do... */
2332 return NULL;
2333 }
2334 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2335 if ( !univ_newline )
2336 return fgets(buf, n, stream);
2337 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2338 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2339 }
2340 FLOCKFILE(stream);
2341 c = 'x'; /* Shut up gcc warning */
2342 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2343 if (skipnextlf ) {
2344 skipnextlf = 0;
2345 if (c == '\n') {
2346 /* Seeing a \n here with skipnextlf true
2347 ** means we saw a \r before.
2348 */
2349 newlinetypes |= NEWLINE_CRLF;
2350 c = GETC(stream);
2351 if (c == EOF) break;
2352 } else {
2353 /*
2354 ** Note that c == EOF also brings us here,
2355 ** so we're okay if the last char in the file
2356 ** is a CR.
2357 */
2358 newlinetypes |= NEWLINE_CR;
2359 }
2360 }
2361 if (c == '\r') {
2362 /* A \r is translated into a \n, and we skip
2363 ** an adjacent \n, if any. We don't set the
2364 ** newlinetypes flag until we've seen the next char.
2365 */
2366 skipnextlf = 1;
2367 c = '\n';
2368 } else if ( c == '\n') {
2369 newlinetypes |= NEWLINE_LF;
2370 }
2371 *p++ = c;
2372 if (c == '\n') break;
2373 }
2374 if ( c == EOF && skipnextlf )
2375 newlinetypes |= NEWLINE_CR;
2376 FUNLOCKFILE(stream);
2377 *p = '\0';
2378 if (fobj) {
2379 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2380 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2381 } else if ( skipnextlf ) {
2382 /* If we have no file object we cannot save the
2383 ** skipnextlf flag. We have to readahead, which
2384 ** will cause a pause if we're reading from an
2385 ** interactive stream, but that is very unlikely
2386 ** unless we're doing something silly like
2387 ** execfile("/dev/tty").
2388 */
2389 c = GETC(stream);
2390 if ( c != '\n' )
2391 ungetc(c, stream);
2392 }
2393 if (p == buf)
2394 return NULL;
2395 return buf;
2396}
2397
2398/*
2399** Py_UniversalNewlineFread is an fread variation that understands
2400** all of \r, \n and \r\n conventions.
2401** The stream should be opened in binary mode.
2402** fobj must be a PyFileObject. In this case there
2403** is no readahead but in stead a flag is used to skip a following
2404** \n on the next read. Also, if the file is open in binary mode
2405** the whole conversion is skipped. Finally, the routine keeps track of
2406** the different types of newlines seen.
2407*/
2408size_t
Tim Peters058b1412002-04-21 07:29:14 +00002409Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002410 FILE *stream, PyObject *fobj)
2411{
Tim Peters058b1412002-04-21 07:29:14 +00002412 char *dst = buf;
2413 PyFileObject *f = (PyFileObject *)fobj;
2414 int newlinetypes, skipnextlf;
2415
2416 assert(buf != NULL);
2417 assert(stream != NULL);
2418
Jack Jansen7b8c7542002-04-14 20:12:41 +00002419 if (!fobj || !PyFile_Check(fobj)) {
2420 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002421 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002422 }
Tim Peters058b1412002-04-21 07:29:14 +00002423 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002424 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002425 newlinetypes = f->f_newlinetypes;
2426 skipnextlf = f->f_skipnextlf;
2427 /* Invariant: n is the number of bytes remaining to be filled
2428 * in the buffer.
2429 */
2430 while (n) {
2431 size_t nread;
2432 int shortread;
2433 char *src = dst;
2434
2435 nread = fread(dst, 1, n, stream);
2436 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002437 if (nread == 0)
2438 break;
2439
Tim Peterse1682a82002-04-21 18:15:20 +00002440 n -= nread; /* assuming 1 byte out for each in; will adjust */
2441 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002442 while (nread--) {
2443 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002444 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002445 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002446 *dst++ = '\n';
2447 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002448 }
2449 else if (skipnextlf && c == '\n') {
2450 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002451 skipnextlf = 0;
2452 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002453 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002454 }
2455 else {
2456 /* Normal char to be stored in buffer. Also
2457 * update the newlinetypes flag if either this
2458 * is an LF or the previous char was a CR.
2459 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002460 if (c == '\n')
2461 newlinetypes |= NEWLINE_LF;
2462 else if (skipnextlf)
2463 newlinetypes |= NEWLINE_CR;
2464 *dst++ = c;
2465 skipnextlf = 0;
2466 }
2467 }
Tim Peters058b1412002-04-21 07:29:14 +00002468 if (shortread) {
2469 /* If this is EOF, update type flags. */
2470 if (skipnextlf && feof(stream))
2471 newlinetypes |= NEWLINE_CR;
2472 break;
2473 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002474 }
Tim Peters058b1412002-04-21 07:29:14 +00002475 f->f_newlinetypes = newlinetypes;
2476 f->f_skipnextlf = skipnextlf;
2477 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002478}
Anthony Baxterac6bd462006-04-13 02:06:09 +00002479
2480#ifdef __cplusplus
2481}
2482#endif