blob: 90c9687ddbd7797b644d84508935ec407bb52578 [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;
Martin v. Löwis056dac12006-11-12 18:24:26 +0000543 PyObject *offobj, *off_index;
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;
Martin v. Löwis056dac12006-11-12 18:24:26 +0000551 off_index = PyNumber_Index(offobj);
552 if (!off_index) {
553 if (!PyFloat_Check(offobj))
554 return NULL;
555 /* Deprecated in 2.6 */
556 PyErr_Clear();
557 if (PyErr_Warn(PyExc_DeprecationWarning,
558 "integer argument expected, got float"))
559 return NULL;
560 off_index = offobj;
561 Py_INCREF(offobj);
562 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000563#if !defined(HAVE_LARGEFILE_SUPPORT)
Martin v. Löwis056dac12006-11-12 18:24:26 +0000564 offset = PyInt_AsLong(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000565#else
Martin v. Löwis056dac12006-11-12 18:24:26 +0000566 offset = PyLong_Check(off_index) ?
567 PyLong_AsLongLong(off_index) : PyInt_AsLong(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000568#endif
Martin v. Löwis056dac12006-11-12 18:24:26 +0000569 Py_DECREF(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000570 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000571 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000572
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000573 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000574 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000575 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000576 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000577
Guido van Rossumff4949e1992-08-05 19:58:53 +0000578 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000579 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000580 clearerr(f->f_fp);
581 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000582 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000583 f->f_skipnextlf = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000584 Py_INCREF(Py_None);
585 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000586}
587
Trent Mickf29f47b2000-08-11 19:02:59 +0000588
Guido van Rossumd7047b31995-01-02 19:07:15 +0000589#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000590static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000591file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000592{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000593 Py_off_t newsize;
Tim Petersf1827cf2003-09-07 03:30:18 +0000594 PyObject *newsizeobj = NULL;
595 Py_off_t initialpos;
596 int ret;
Tim Peters86821b22001-01-07 21:19:34 +0000597
Guido van Rossumd7047b31995-01-02 19:07:15 +0000598 if (f->f_fp == NULL)
599 return err_closed();
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000600 if (!PyArg_UnpackTuple(args, "truncate", 0, 1, &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000601 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000602
Tim Petersf1827cf2003-09-07 03:30:18 +0000603 /* Get current file position. If the file happens to be open for
604 * update and the last operation was an input operation, C doesn't
605 * define what the later fflush() will do, but we promise truncate()
606 * won't change the current position (and fflush() *does* change it
607 * then at least on Windows). The easiest thing is to capture
608 * current pos now and seek back to it at the end.
609 */
610 Py_BEGIN_ALLOW_THREADS
611 errno = 0;
612 initialpos = _portable_ftell(f->f_fp);
613 Py_END_ALLOW_THREADS
614 if (initialpos == -1)
615 goto onioerror;
616
Tim Petersfb05db22002-03-11 00:24:00 +0000617 /* Set newsize to current postion if newsizeobj NULL, else to the
Tim Petersf1827cf2003-09-07 03:30:18 +0000618 * specified value.
619 */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000620 if (newsizeobj != NULL) {
621#if !defined(HAVE_LARGEFILE_SUPPORT)
622 newsize = PyInt_AsLong(newsizeobj);
623#else
624 newsize = PyLong_Check(newsizeobj) ?
625 PyLong_AsLongLong(newsizeobj) :
626 PyInt_AsLong(newsizeobj);
627#endif
628 if (PyErr_Occurred())
629 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000630 }
Tim Petersf1827cf2003-09-07 03:30:18 +0000631 else /* default to current position */
632 newsize = initialpos;
Tim Petersfb05db22002-03-11 00:24:00 +0000633
Tim Petersf1827cf2003-09-07 03:30:18 +0000634 /* Flush the stream. We're mixing stream-level I/O with lower-level
635 * I/O, and a flush may be necessary to synch both platform views
636 * of the current file state.
637 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000638 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000639 errno = 0;
640 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000641 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000642 if (ret != 0)
643 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000644
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000645#ifdef MS_WINDOWS
Tim Petersfb05db22002-03-11 00:24:00 +0000646 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000647 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000648 {
Tim Petersfb05db22002-03-11 00:24:00 +0000649 HANDLE hFile;
Tim Petersfb05db22002-03-11 00:24:00 +0000650
Tim Petersf1827cf2003-09-07 03:30:18 +0000651 /* Have to move current pos to desired endpoint on Windows. */
652 Py_BEGIN_ALLOW_THREADS
653 errno = 0;
654 ret = _portable_fseek(f->f_fp, newsize, SEEK_SET) != 0;
655 Py_END_ALLOW_THREADS
656 if (ret)
657 goto onioerror;
Tim Petersfb05db22002-03-11 00:24:00 +0000658
Tim Peters8f01b682002-03-12 03:04:44 +0000659 /* Truncate. Note that this may grow the file! */
660 Py_BEGIN_ALLOW_THREADS
661 errno = 0;
662 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
Tim Petersf1827cf2003-09-07 03:30:18 +0000663 ret = hFile == (HANDLE)-1;
664 if (ret == 0) {
665 ret = SetEndOfFile(hFile) == 0;
666 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000667 errno = EACCES;
668 }
669 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000670 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000671 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000672 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000673#else
674 Py_BEGIN_ALLOW_THREADS
675 errno = 0;
676 ret = ftruncate(fileno(f->f_fp), newsize);
677 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000678 if (ret != 0)
679 goto onioerror;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000680#endif /* !MS_WINDOWS */
Tim Peters86821b22001-01-07 21:19:34 +0000681
Tim Petersf1827cf2003-09-07 03:30:18 +0000682 /* Restore original file position. */
683 Py_BEGIN_ALLOW_THREADS
684 errno = 0;
685 ret = _portable_fseek(f->f_fp, initialpos, SEEK_SET) != 0;
686 Py_END_ALLOW_THREADS
687 if (ret)
688 goto onioerror;
689
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000690 Py_INCREF(Py_None);
691 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000692
693onioerror:
694 PyErr_SetFromErrno(PyExc_IOError);
695 clearerr(f->f_fp);
696 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000697}
698#endif /* HAVE_FTRUNCATE */
699
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000700static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000701file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000702{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000703 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000704
Guido van Rossumd7297e61992-07-06 14:19:26 +0000705 if (f->f_fp == NULL)
706 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000707 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000708 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000709 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000710 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000711 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000712 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000713 clearerr(f->f_fp);
714 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000715 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000716 if (f->f_skipnextlf) {
717 int c;
718 c = GETC(f->f_fp);
719 if (c == '\n') {
720 pos++;
721 f->f_skipnextlf = 0;
722 } else if (c != EOF) ungetc(c, f->f_fp);
723 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000724#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000725 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000726#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000727 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000728#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000729}
730
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000731static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000732file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000733{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000734 if (f->f_fp == NULL)
735 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000736 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000737}
738
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000739static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000740file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000741{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000742 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000743
Guido van Rossumd7297e61992-07-06 14:19:26 +0000744 if (f->f_fp == NULL)
745 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000746 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000747 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000748 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000749 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000750 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000751 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000752 clearerr(f->f_fp);
753 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000754 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000755 Py_INCREF(Py_None);
756 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000757}
758
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000759static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000760file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000761{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000762 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000763 if (f->f_fp == NULL)
764 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000765 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000766 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000767 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000768 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000769}
770
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000771
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000772#if BUFSIZ < 8192
773#define SMALLCHUNK 8192
774#else
775#define SMALLCHUNK BUFSIZ
776#endif
777
Guido van Rossum3c259041999-01-14 19:00:14 +0000778#if SIZEOF_INT < 4
779#define BIGCHUNK (512 * 32)
780#else
781#define BIGCHUNK (512 * 1024)
782#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000783
784static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000785new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000786{
787#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000788 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000789 struct stat st;
790 if (fstat(fileno(f->f_fp), &st) == 0) {
791 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000792 /* The following is not a bug: we really need to call lseek()
793 *and* ftell(). The reason is that some stdio libraries
794 mistakenly flush their buffer when ftell() is called and
795 the lseek() call it makes fails, thereby throwing away
796 data that cannot be recovered in any way. To avoid this,
797 we first test lseek(), and only call ftell() if lseek()
798 works. We can't use the lseek() value either, because we
799 need to take the amount of buffered data into account.
800 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000801 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000802 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000803 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000804 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000805 if (pos < 0)
806 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000807 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000808 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000809 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000810 }
811#endif
812 if (currentsize > SMALLCHUNK) {
813 /* Keep doubling until we reach BIGCHUNK;
814 then keep adding BIGCHUNK. */
815 if (currentsize <= BIGCHUNK)
816 return currentsize + currentsize;
817 else
818 return currentsize + BIGCHUNK;
819 }
820 return currentsize + SMALLCHUNK;
821}
822
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000823#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
824#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
825#else
826#ifdef EWOULDBLOCK
827#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
828#else
829#ifdef EAGAIN
830#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
831#else
832#define BLOCKED_ERRNO(x) 0
833#endif
834#endif
835#endif
836
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000837static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000838file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000839{
Guido van Rossum789a1611997-05-10 22:33:55 +0000840 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000841 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000842 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000843
Guido van Rossumd7297e61992-07-06 14:19:26 +0000844 if (f->f_fp == NULL)
845 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000846 /* refuse to mix with f.next() */
847 if (f->f_buf != NULL &&
848 (f->f_bufend - f->f_bufptr) > 0 &&
849 f->f_buf[0] != '\0')
850 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000851 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000852 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000853 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000854 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000855 else
856 buffersize = bytesrequested;
Martin v. Löwis2a190742006-04-13 07:37:25 +0000857 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000858 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000859 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000860 return NULL;
861 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000862 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000863 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000864 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000865 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000866 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000867 Py_BEGIN_ALLOW_THREADS
868 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000869 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000870 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000871 Py_END_ALLOW_THREADS
872 if (chunksize == 0) {
873 if (!ferror(f->f_fp))
874 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000875 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000876 /* When in non-blocking mode, data shouldn't
877 * be discarded if a blocking signal was
878 * received. That will also happen if
879 * chunksize != 0, but bytesread < buffersize. */
880 if (bytesread > 0 && BLOCKED_ERRNO(errno))
881 break;
882 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum6263d541997-05-10 22:07:25 +0000883 Py_DECREF(v);
884 return NULL;
885 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000886 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000887 if (bytesread < buffersize) {
888 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000889 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000890 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000891 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000892 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000893 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000894 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000895 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000896 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000897 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000898 }
899 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000900 if (bytesread != buffersize)
901 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000902 return v;
903}
904
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000905static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000906file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000907{
908 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000909 Py_ssize_t ntodo;
910 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000911
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000912 if (f->f_fp == NULL)
913 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000914 /* refuse to mix with f.next() */
915 if (f->f_buf != NULL &&
916 (f->f_bufend - f->f_bufptr) > 0 &&
917 f->f_buf[0] != '\0')
918 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000919 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000920 return NULL;
921 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000922 while (ntodo > 0) {
923 Py_BEGIN_ALLOW_THREADS
924 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000925 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000926 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000927 Py_END_ALLOW_THREADS
928 if (nnow == 0) {
929 if (!ferror(f->f_fp))
930 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000931 PyErr_SetFromErrno(PyExc_IOError);
932 clearerr(f->f_fp);
933 return NULL;
934 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000935 ndone += nnow;
936 ntodo -= nnow;
937 }
Neal Norwitz076d1e02006-08-21 18:20:10 +0000938 return PyInt_FromSsize_t(ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000939}
940
Tim Peters86821b22001-01-07 21:19:34 +0000941/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000942Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000943
944Under MSVC 6:
945
Tim Peters1c733232001-01-08 04:02:07 +0000946+ MS threadsafe getc is very slow (multiple layers of function calls before+
947 after each character, to lock+unlock the stream).
948+ The stream-locking functions are MS-internal -- can't access them from user
949 code.
950+ There's nothing Tim could find in the MS C or platform SDK libraries that
951 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000952+ MS fgets locks/unlocks only once per line; it's the only hook we have.
953
954So we use fgets for speed(!), despite that it's painful.
955
956MS realloc is also slow.
957
Tim Petersf29b64d2001-01-15 06:33:19 +0000958Reports from other platforms on this method vs getc_unlocked (which MS doesn't
959have):
960 Linux a wash
961 Solaris a wash
962 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000963
Tim Petersf29b64d2001-01-15 06:33:19 +0000964CAUTION: The C std isn't clear about this: in those cases where fgets
965writes something into the buffer, can it write into any position beyond the
966required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
967known on which it does; and it would be a strange way to code fgets. Still,
968getline_via_fgets may not work correctly if it does. The std test
969test_bufio.py should fail if platform fgets() routinely writes beyond the
970trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000971**************************************************************************/
972
Tim Petersf29b64d2001-01-15 06:33:19 +0000973/* Use this routine if told to, or by default on non-get_unlocked()
974 * platforms unless told not to. Yikes! Let's spell that out:
975 * On a platform with getc_unlocked():
976 * By default, use getc_unlocked().
977 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
978 * On a platform without getc_unlocked():
979 * By default, use fgets().
980 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
981 */
982#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
983#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000984#endif
985
Tim Petersf29b64d2001-01-15 06:33:19 +0000986#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
987#undef USE_FGETS_IN_GETLINE
988#endif
989
990#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000991static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000992getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000993{
Tim Peters15b83852001-01-08 00:53:12 +0000994/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000995 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
996 * to fill this much of the buffer with a known value in order to figure out
997 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
998 * than "most" lines, we waste time filling unused buffer slots. 100 is
999 * surely adequate for most peoples' email archives, chewing over source code,
1000 * etc -- "regular old text files".
1001 * MAXBUFSIZE is the maximum line length that lets us get away with the less
1002 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
1003 * cautions about boosting that. 300 was chosen because the worst real-life
1004 * text-crunching job reported on Python-Dev was a mail-log crawler where over
1005 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +00001006 */
Tim Peters142297a2001-01-15 10:36:56 +00001007#define INITBUFSIZE 100
1008#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +00001009 char* p; /* temp */
1010 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +00001011 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +00001012 char* pvfree; /* address of next free slot */
1013 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +00001014 size_t nfree; /* # of free buffer slots; pvend-pvfree */
1015 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001016 size_t increment; /* amount to increment the buffer */
Armin Rigo7ccbca92006-10-04 12:17:45 +00001017 size_t prev_v_size;
Tim Peters86821b22001-01-07 21:19:34 +00001018
Tim Peters15b83852001-01-08 00:53:12 +00001019 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001020 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001021 */
Tim Peters142297a2001-01-15 10:36:56 +00001022 total_v_size = INITBUFSIZE; /* start small and pray */
1023 pvfree = buf;
1024 for (;;) {
1025 Py_BEGIN_ALLOW_THREADS
1026 pvend = buf + total_v_size;
1027 nfree = pvend - pvfree;
1028 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001029 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1030 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001031 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001032
Tim Peters142297a2001-01-15 10:36:56 +00001033 if (p == NULL) {
1034 clearerr(fp);
1035 if (PyErr_CheckSignals())
1036 return NULL;
1037 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001038 return v;
1039 }
Tim Peters142297a2001-01-15 10:36:56 +00001040 /* fgets read *something* */
1041 p = memchr(pvfree, '\n', nfree);
1042 if (p != NULL) {
1043 /* Did the \n come from fgets or from us?
1044 * Since fgets stops at the first \n, and then writes
1045 * \0, if it's from fgets a \0 must be next. But if
1046 * that's so, it could not have come from us, since
1047 * the \n's we filled the buffer with have only more
1048 * \n's to the right.
1049 */
1050 if (p+1 < pvend && *(p+1) == '\0') {
1051 /* It's from fgets: we win! In particular,
1052 * we haven't done any mallocs yet, and can
1053 * build the final result on the first try.
1054 */
1055 ++p; /* include \n from fgets */
1056 }
1057 else {
1058 /* Must be from us: fgets didn't fill the
1059 * buffer and didn't find a newline, so it
1060 * must be the last and newline-free line of
1061 * the file.
1062 */
1063 assert(p > pvfree && *(p-1) == '\0');
1064 --p; /* don't include \0 from fgets */
1065 }
1066 v = PyString_FromStringAndSize(buf, p - buf);
1067 return v;
1068 }
1069 /* yuck: fgets overwrote all the newlines, i.e. the entire
1070 * buffer. So this line isn't over yet, or maybe it is but
1071 * we're exactly at EOF. If we haven't already, try using the
1072 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001073 */
Tim Peters142297a2001-01-15 10:36:56 +00001074 assert(*(pvend-1) == '\0');
1075 if (pvfree == buf) {
1076 pvfree = pvend - 1; /* overwrite trailing null */
1077 total_v_size = MAXBUFSIZE;
1078 }
1079 else
1080 break;
Tim Peters86821b22001-01-07 21:19:34 +00001081 }
Tim Peters142297a2001-01-15 10:36:56 +00001082
1083 /* The stack buffer isn't big enough; malloc a string object and read
1084 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001085 */
Tim Petersddea2082002-03-23 10:03:50 +00001086 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001087 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001088 if (v == NULL)
1089 return v;
1090 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001091 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1092 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001093
1094 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001095 * after setting p one beyond the end of the line. The code here is
1096 * very much like the code above, except reads into v's buffer; see
1097 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001098 */
1099 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001100 Py_BEGIN_ALLOW_THREADS
1101 pvend = BUF(v) + total_v_size;
1102 nfree = pvend - pvfree;
1103 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001104 assert(nfree < INT_MAX);
1105 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001106 Py_END_ALLOW_THREADS
1107
1108 if (p == NULL) {
1109 clearerr(fp);
1110 if (PyErr_CheckSignals()) {
1111 Py_DECREF(v);
1112 return NULL;
1113 }
1114 p = pvfree;
1115 break;
1116 }
Tim Peters86821b22001-01-07 21:19:34 +00001117 p = memchr(pvfree, '\n', nfree);
1118 if (p != NULL) {
1119 if (p+1 < pvend && *(p+1) == '\0') {
1120 /* \n came from fgets */
1121 ++p;
1122 break;
1123 }
1124 /* \n came from us; last line of file, no newline */
1125 assert(p > pvfree && *(p-1) == '\0');
1126 --p;
1127 break;
1128 }
1129 /* expand buffer and try again */
1130 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001131 increment = total_v_size >> 2; /* mild exponential growth */
Armin Rigo7ccbca92006-10-04 12:17:45 +00001132 prev_v_size = total_v_size;
Tim Petersddea2082002-03-23 10:03:50 +00001133 total_v_size += increment;
Armin Rigo7ccbca92006-10-04 12:17:45 +00001134 /* check for overflow */
1135 if (total_v_size <= prev_v_size ||
1136 total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001137 PyErr_SetString(PyExc_OverflowError,
1138 "line is longer than a Python string can hold");
1139 Py_DECREF(v);
1140 return NULL;
1141 }
1142 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1143 return NULL;
1144 /* overwrite the trailing null byte */
Armin Rigo7ccbca92006-10-04 12:17:45 +00001145 pvfree = BUF(v) + (prev_v_size - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001146 }
1147 if (BUF(v) + total_v_size != p)
1148 _PyString_Resize(&v, p - BUF(v));
1149 return v;
1150#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001151#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001152}
Tim Petersf29b64d2001-01-15 06:33:19 +00001153#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001154
Guido van Rossum0bd24411991-04-04 15:21:57 +00001155/* Internal routine to get a line.
1156 Size argument interpretation:
1157 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001158 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001159*/
1160
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001161static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001162get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001163{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001164 FILE *fp = f->f_fp;
1165 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001166 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001167 size_t total_v_size; /* total # of slots in buffer */
1168 size_t used_v_size; /* # used slots in buffer */
1169 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001170 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001171 int newlinetypes = f->f_newlinetypes;
1172 int skipnextlf = f->f_skipnextlf;
1173 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001174
Jack Jansen7b8c7542002-04-14 20:12:41 +00001175#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001176 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001177 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001178#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001179 total_v_size = n > 0 ? n : 100;
1180 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001181 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001182 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001183 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001184 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001185
Guido van Rossumce5ba841991-03-06 13:06:18 +00001186 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001187 Py_BEGIN_ALLOW_THREADS
1188 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001189 if (univ_newline) {
1190 c = 'x'; /* Shut up gcc warning */
1191 while ( buf != end && (c = GETC(fp)) != EOF ) {
1192 if (skipnextlf ) {
1193 skipnextlf = 0;
1194 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001195 /* Seeing a \n here with
1196 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001197 * saw a \r before.
1198 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001199 newlinetypes |= NEWLINE_CRLF;
1200 c = GETC(fp);
1201 if (c == EOF) break;
1202 } else {
1203 newlinetypes |= NEWLINE_CR;
1204 }
1205 }
1206 if (c == '\r') {
1207 skipnextlf = 1;
1208 c = '\n';
1209 } else if ( c == '\n')
1210 newlinetypes |= NEWLINE_LF;
1211 *buf++ = c;
1212 if (c == '\n') break;
1213 }
1214 if ( c == EOF && skipnextlf )
1215 newlinetypes |= NEWLINE_CR;
1216 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001217 while ((c = GETC(fp)) != EOF &&
1218 (*buf++ = c) != '\n' &&
1219 buf != end)
1220 ;
1221 FUNLOCKFILE(fp);
1222 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001223 f->f_newlinetypes = newlinetypes;
1224 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001225 if (c == '\n')
1226 break;
1227 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001228 if (ferror(fp)) {
1229 PyErr_SetFromErrno(PyExc_IOError);
1230 clearerr(fp);
1231 Py_DECREF(v);
1232 return NULL;
1233 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001234 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001235 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001236 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001237 return NULL;
1238 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001239 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001240 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001241 /* Must be because buf == end */
1242 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001243 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001244 used_v_size = total_v_size;
1245 increment = total_v_size >> 2; /* mild exponential growth */
1246 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001247 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001248 PyErr_SetString(PyExc_OverflowError,
1249 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001250 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001251 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001252 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001253 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001254 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001255 buf = BUF(v) + used_v_size;
1256 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001257 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001258
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001259 used_v_size = buf - BUF(v);
1260 if (used_v_size != total_v_size)
1261 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001262 return v;
1263}
1264
Guido van Rossum0bd24411991-04-04 15:21:57 +00001265/* External C interface */
1266
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001267PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001268PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001269{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001270 PyObject *result;
1271
Guido van Rossum3165fe61992-09-25 21:59:05 +00001272 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001273 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001274 return NULL;
1275 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001276
1277 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001278 PyFileObject *fo = (PyFileObject *)f;
1279 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001280 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001281 /* refuse to mix with f.next() */
1282 if (fo->f_buf != NULL &&
1283 (fo->f_bufend - fo->f_bufptr) > 0 &&
1284 fo->f_buf[0] != '\0')
1285 return err_iterbuffered();
1286 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001287 }
1288 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001289 PyObject *reader;
1290 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001291
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001292 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001293 if (reader == NULL)
1294 return NULL;
1295 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001296 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001297 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001298 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001299 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001300 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001301 return NULL;
1302 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001303 result = PyEval_CallObject(reader, args);
1304 Py_DECREF(reader);
1305 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001306 if (result != NULL && !PyString_Check(result) &&
1307 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001308 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001309 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001310 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001311 "object.readline() returned non-string");
1312 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001313 }
1314
1315 if (n < 0 && result != NULL && PyString_Check(result)) {
1316 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001317 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001318 if (len == 0) {
1319 Py_DECREF(result);
1320 result = NULL;
1321 PyErr_SetString(PyExc_EOFError,
1322 "EOF when reading a line");
1323 }
1324 else if (s[len-1] == '\n') {
1325 if (result->ob_refcnt == 1)
1326 _PyString_Resize(&result, len-1);
1327 else {
1328 PyObject *v;
1329 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001330 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001331 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001332 }
1333 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001334 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001335#ifdef Py_USING_UNICODE
1336 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1337 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001338 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001339 if (len == 0) {
1340 Py_DECREF(result);
1341 result = NULL;
1342 PyErr_SetString(PyExc_EOFError,
1343 "EOF when reading a line");
1344 }
1345 else if (s[len-1] == '\n') {
1346 if (result->ob_refcnt == 1)
1347 PyUnicode_Resize(&result, len-1);
1348 else {
1349 PyObject *v;
1350 v = PyUnicode_FromUnicode(s, len-1);
1351 Py_DECREF(result);
1352 result = v;
1353 }
1354 }
1355 }
1356#endif
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001357 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001358}
1359
1360/* Python method */
1361
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001362static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001363file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001364{
Guido van Rossum789a1611997-05-10 22:33:55 +00001365 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001366
Guido van Rossumd7297e61992-07-06 14:19:26 +00001367 if (f->f_fp == NULL)
1368 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001369 /* refuse to mix with f.next() */
1370 if (f->f_buf != NULL &&
1371 (f->f_bufend - f->f_bufptr) > 0 &&
1372 f->f_buf[0] != '\0')
1373 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001374 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001375 return NULL;
1376 if (n == 0)
1377 return PyString_FromString("");
1378 if (n < 0)
1379 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001380 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001381}
1382
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001383static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001384file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001385{
Guido van Rossum789a1611997-05-10 22:33:55 +00001386 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001387 PyObject *list;
1388 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001389 char small_buffer[SMALLCHUNK];
1390 char *buffer = small_buffer;
1391 size_t buffersize = SMALLCHUNK;
1392 PyObject *big_buffer = NULL;
1393 size_t nfilled = 0;
1394 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001395 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001396 char *p, *q, *end;
1397 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001398 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001399
Guido van Rossumd7297e61992-07-06 14:19:26 +00001400 if (f->f_fp == NULL)
1401 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001402 /* refuse to mix with f.next() */
1403 if (f->f_buf != NULL &&
1404 (f->f_bufend - f->f_bufptr) > 0 &&
1405 f->f_buf[0] != '\0')
1406 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001407 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001408 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001409 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001410 return NULL;
1411 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001412 if (shortread)
1413 nread = 0;
1414 else {
1415 Py_BEGIN_ALLOW_THREADS
1416 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001417 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001418 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001419 Py_END_ALLOW_THREADS
1420 shortread = (nread < buffersize-nfilled);
1421 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001422 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001423 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001424 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001425 break;
1426 PyErr_SetFromErrno(PyExc_IOError);
1427 clearerr(f->f_fp);
1428 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001429 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001430 list = NULL;
1431 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001432 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001433 totalread += nread;
Anthony Baxter377be112006-04-11 06:54:30 +00001434 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001435 if (p == NULL) {
1436 /* Need a larger buffer to fit this line */
1437 nfilled += nread;
1438 buffersize *= 2;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001439 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001440 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001441 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001442 goto error;
1443 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001444 if (big_buffer == NULL) {
1445 /* Create the big buffer */
1446 big_buffer = PyString_FromStringAndSize(
1447 NULL, buffersize);
1448 if (big_buffer == NULL)
1449 goto error;
1450 buffer = PyString_AS_STRING(big_buffer);
1451 memcpy(buffer, small_buffer, nfilled);
1452 }
1453 else {
1454 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001455 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1456 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001457 buffer = PyString_AS_STRING(big_buffer);
1458 }
1459 continue;
1460 }
1461 end = buffer+nfilled+nread;
1462 q = buffer;
1463 do {
1464 /* Process complete lines */
1465 p++;
1466 line = PyString_FromStringAndSize(q, p-q);
1467 if (line == NULL)
1468 goto error;
1469 err = PyList_Append(list, line);
1470 Py_DECREF(line);
1471 if (err != 0)
1472 goto error;
1473 q = p;
Anthony Baxter377be112006-04-11 06:54:30 +00001474 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001475 } while (p != NULL);
1476 /* Move the remaining incomplete line to the start */
1477 nfilled = end-q;
1478 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001479 if (sizehint > 0)
1480 if (totalread >= (size_t)sizehint)
1481 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001482 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001483 if (nfilled != 0) {
1484 /* Partial last line */
1485 line = PyString_FromStringAndSize(buffer, nfilled);
1486 if (line == NULL)
1487 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001488 if (sizehint > 0) {
1489 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001490 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001491 if (rest == NULL) {
1492 Py_DECREF(line);
1493 goto error;
1494 }
1495 PyString_Concat(&line, rest);
1496 Py_DECREF(rest);
1497 if (line == NULL)
1498 goto error;
1499 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001500 err = PyList_Append(list, line);
1501 Py_DECREF(line);
1502 if (err != 0)
1503 goto error;
1504 }
1505 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001506 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001507 return list;
1508}
1509
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001510static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001511file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001512{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001513 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001514 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001515 if (f->f_fp == NULL)
1516 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001517 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001518 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001519 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001520 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001521 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001522 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001523 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001524 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001525 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001526 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001527 return NULL;
1528 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001529 Py_INCREF(Py_None);
1530 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001531}
1532
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001533static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001534file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001535{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001536#define CHUNKSIZE 1000
1537 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001538 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001539 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001540 int index, islist;
1541 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001542
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001543 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001544 if (f->f_fp == NULL)
1545 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001546
1547 result = NULL;
1548 list = NULL;
1549 islist = PyList_Check(seq);
1550 if (islist)
1551 it = NULL;
1552 else {
1553 it = PyObject_GetIter(seq);
1554 if (it == NULL) {
1555 PyErr_SetString(PyExc_TypeError,
1556 "writelines() requires an iterable argument");
1557 return NULL;
1558 }
1559 /* From here on, fail by going to error, to reclaim "it". */
1560 list = PyList_New(CHUNKSIZE);
1561 if (list == NULL)
1562 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001563 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001564
1565 /* Strategy: slurp CHUNKSIZE lines into a private list,
1566 checking that they are all strings, then write that list
1567 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001568 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001569 if (islist) {
1570 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001571 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001572 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001573 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001574 j = PyList_GET_SIZE(list);
1575 }
1576 else {
1577 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001578 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001579 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001580 if (PyErr_Occurred())
1581 goto error;
1582 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001583 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001584 PyList_SetItem(list, j, line);
1585 }
1586 }
1587 if (j == 0)
1588 break;
1589
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001590 /* Check that all entries are indeed strings. If not,
1591 apply the same rules as for file.write() and
1592 convert the results to strings. This is slow, but
1593 seems to be the only way since all conversion APIs
1594 could potentially execute Python code. */
1595 for (i = 0; i < j; i++) {
1596 PyObject *v = PyList_GET_ITEM(list, i);
1597 if (!PyString_Check(v)) {
1598 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001599 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001600 PyObject_AsReadBuffer(v,
1601 (const void**)&buffer,
1602 &len)) ||
1603 PyObject_AsCharBuffer(v,
1604 &buffer,
1605 &len))) {
1606 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001607 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001608 goto error;
1609 }
1610 line = PyString_FromStringAndSize(buffer,
1611 len);
1612 if (line == NULL)
1613 goto error;
1614 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001615 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001616 }
1617 }
1618
1619 /* Since we are releasing the global lock, the
1620 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001621 Py_BEGIN_ALLOW_THREADS
1622 f->f_softspace = 0;
1623 errno = 0;
1624 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001625 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001626 len = PyString_GET_SIZE(line);
1627 nwritten = fwrite(PyString_AS_STRING(line),
1628 1, len, f->f_fp);
1629 if (nwritten != len) {
1630 Py_BLOCK_THREADS
1631 PyErr_SetFromErrno(PyExc_IOError);
1632 clearerr(f->f_fp);
1633 goto error;
1634 }
1635 }
1636 Py_END_ALLOW_THREADS
1637
1638 if (j < CHUNKSIZE)
1639 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001640 }
1641
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001642 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001643 result = Py_None;
1644 error:
1645 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001646 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001647 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001648#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001649}
1650
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001651static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001652file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001653{
1654 if (f->f_fp == NULL)
1655 return err_closed();
1656 Py_INCREF(f);
1657 return (PyObject *)f;
1658}
1659
Georg Brandl98b40ad2006-06-08 14:50:21 +00001660static PyObject *
1661file_exit(PyFileObject *f, PyObject *args)
1662{
1663 PyObject *ret = file_close(f);
1664 if (!ret)
1665 /* If error occurred, pass through */
1666 return NULL;
1667 Py_DECREF(ret);
1668 /* We cannot return the result of close since a true
1669 * value will be interpreted as "yes, swallow the
1670 * exception if one was raised inside the with block". */
1671 Py_RETURN_NONE;
1672}
1673
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001674PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001675"readline([size]) -> next line from the file, as a string.\n"
1676"\n"
1677"Retain newline. A non-negative size argument limits the maximum\n"
1678"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001679"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001680
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001681PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001682"read([size]) -> read at most size bytes, returned as a string.\n"
1683"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001684"If the size argument is negative or omitted, read until EOF is reached.\n"
1685"Notice that when in non-blocking mode, less data than what was requested\n"
1686"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001687
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001688PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001689"write(str) -> None. Write string str to file.\n"
1690"\n"
1691"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001692"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001693
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001694PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001695"fileno() -> integer \"file descriptor\".\n"
1696"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001697"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001698
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001699PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001700"seek(offset[, whence]) -> None. Move to new file position.\n"
1701"\n"
1702"Argument offset is a byte count. Optional argument whence defaults to\n"
1703"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1704"(move relative to current position, positive or negative), and 2 (move\n"
1705"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001706"seeking beyond the end of a file). If the file is opened in text mode,\n"
1707"only offsets returned by tell() are legal. Use of other offsets causes\n"
1708"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001709"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001710"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001711
Guido van Rossumd7047b31995-01-02 19:07:15 +00001712#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001713PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001714"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1715"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001716"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001717#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001718
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001719PyDoc_STRVAR(tell_doc,
1720"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001721
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001722PyDoc_STRVAR(readinto_doc,
1723"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001724
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001725PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001726"readlines([size]) -> list of strings, each a line from the file.\n"
1727"\n"
1728"Call readline() repeatedly and return a list of the lines so read.\n"
1729"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001730"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001731
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001732PyDoc_STRVAR(xreadlines_doc,
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001733"xreadlines() -> returns self.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001734"\n"
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001735"For backward compatibility. File objects now include the performance\n"
1736"optimizations previously implemented in the xreadlines module.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001737
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001738PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001739"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001740"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001741"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001742"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001743
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001744PyDoc_STRVAR(flush_doc,
1745"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001746
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001747PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001748"close() -> None or (perhaps) an integer. Close the file.\n"
1749"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001750"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001751"further I/O operations. close() may be called more than once without\n"
1752"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001753"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001754
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001755PyDoc_STRVAR(isatty_doc,
1756"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001757
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001758PyDoc_STRVAR(enter_doc,
1759 "__enter__() -> self.");
1760
Georg Brandl98b40ad2006-06-08 14:50:21 +00001761PyDoc_STRVAR(exit_doc,
1762 "__exit__(*excinfo) -> None. Closes the file.");
1763
Tim Petersefc3a3a2001-09-20 07:55:22 +00001764static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001765 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1766 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1767 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1768 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1769 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001770#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001771 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001772#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001773 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1774 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1775 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001776 {"xreadlines",(PyCFunction)file_self, METH_NOARGS, xreadlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001777 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1778 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1779 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1780 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001781 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Georg Brandl98b40ad2006-06-08 14:50:21 +00001782 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001783 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001784};
1785
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001786#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001787
Guido van Rossum6f799372001-09-20 20:46:19 +00001788static PyMemberDef file_memberlist[] = {
1789 {"softspace", T_INT, OFF(f_softspace), 0,
1790 "flag indicating that a space needs to be printed; used by print"},
1791 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001792 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001793 {"name", T_OBJECT, OFF(f_name), RO,
1794 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001795 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1796 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001797 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001798 {NULL} /* Sentinel */
1799};
1800
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001801static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001802get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001803{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001804 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001805}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001806static PyObject *
1807get_newlines(PyFileObject *f, void *closure)
1808{
1809 switch (f->f_newlinetypes) {
1810 case NEWLINE_UNKNOWN:
1811 Py_INCREF(Py_None);
1812 return Py_None;
1813 case NEWLINE_CR:
1814 return PyString_FromString("\r");
1815 case NEWLINE_LF:
1816 return PyString_FromString("\n");
1817 case NEWLINE_CR|NEWLINE_LF:
1818 return Py_BuildValue("(ss)", "\r", "\n");
1819 case NEWLINE_CRLF:
1820 return PyString_FromString("\r\n");
1821 case NEWLINE_CR|NEWLINE_CRLF:
1822 return Py_BuildValue("(ss)", "\r", "\r\n");
1823 case NEWLINE_LF|NEWLINE_CRLF:
1824 return Py_BuildValue("(ss)", "\n", "\r\n");
1825 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1826 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1827 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001828 PyErr_Format(PyExc_SystemError,
1829 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001830 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001831 return NULL;
1832 }
1833}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001834
Guido van Rossum32d34c82001-09-20 21:45:26 +00001835static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001836 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001837 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001838 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001839 {0},
1840};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001841
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001842static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001843drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001844{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001845 if (f->f_buf != NULL) {
1846 PyMem_Free(f->f_buf);
1847 f->f_buf = NULL;
1848 }
Guido van Rossum65967252001-04-21 13:20:18 +00001849}
1850
Tim Petersf1827cf2003-09-07 03:30:18 +00001851/* Make sure that file has a readahead buffer with at least one byte
1852 (unless at EOF) and no more than bufsize. Returns negative value on
Georg Brandled02eb62006-03-31 20:31:02 +00001853 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001854static int
1855readahead(PyFileObject *f, int bufsize)
1856{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001857 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001858
1859 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001860 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001861 return 0;
1862 else
1863 drop_readahead(f);
1864 }
Anthony Baxter377be112006-04-11 06:54:30 +00001865 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
Georg Brandled02eb62006-03-31 20:31:02 +00001866 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001867 return -1;
1868 }
1869 Py_BEGIN_ALLOW_THREADS
1870 errno = 0;
1871 chunksize = Py_UniversalNewlineFread(
1872 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1873 Py_END_ALLOW_THREADS
1874 if (chunksize == 0) {
1875 if (ferror(f->f_fp)) {
1876 PyErr_SetFromErrno(PyExc_IOError);
1877 clearerr(f->f_fp);
1878 drop_readahead(f);
1879 return -1;
1880 }
1881 }
1882 f->f_bufptr = f->f_buf;
1883 f->f_bufend = f->f_buf + chunksize;
1884 return 0;
1885}
1886
1887/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001888 uninitialized bytes followed by the remainder of the line. Don't be
1889 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001890 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1891
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001892static PyStringObject *
1893readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1894{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001895 PyStringObject* s;
1896 char *bufptr;
1897 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001898 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001899
1900 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001901 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001902 return NULL;
1903
1904 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001905 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001906 return (PyStringObject *)
1907 PyString_FromStringAndSize(NULL, skip);
Anthony Baxter377be112006-04-11 06:54:30 +00001908 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001909 if (bufptr != NULL) {
1910 bufptr++; /* Count the '\n' */
1911 len = bufptr - f->f_bufptr;
1912 s = (PyStringObject *)
1913 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001914 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001915 return NULL;
1916 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1917 f->f_bufptr = bufptr;
1918 if (bufptr == f->f_bufend)
1919 drop_readahead(f);
1920 } else {
1921 bufptr = f->f_bufptr;
1922 buf = f->f_buf;
1923 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001924 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001925 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001926 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001927 if (s == NULL) {
1928 PyMem_Free(buf);
1929 return NULL;
1930 }
1931 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1932 PyMem_Free(buf);
1933 }
1934 return s;
1935}
1936
1937/* A larger buffer size may actually decrease performance. */
1938#define READAHEAD_BUFSIZE 8192
1939
1940static PyObject *
1941file_iternext(PyFileObject *f)
1942{
1943 PyStringObject* l;
1944
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001945 if (f->f_fp == NULL)
1946 return err_closed();
1947
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001948 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1949 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1950 Py_XDECREF(l);
1951 return NULL;
1952 }
1953 return (PyObject *)l;
1954}
1955
1956
Tim Peters59c9a642001-09-13 05:38:56 +00001957static PyObject *
1958file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1959{
Tim Peters44410012001-09-14 03:26:08 +00001960 PyObject *self;
1961 static PyObject *not_yet_string;
1962
1963 assert(type != NULL && type->tp_alloc != NULL);
1964
1965 if (not_yet_string == NULL) {
1966 not_yet_string = PyString_FromString("<uninitialized file>");
1967 if (not_yet_string == NULL)
1968 return NULL;
1969 }
1970
1971 self = type->tp_alloc(type, 0);
1972 if (self != NULL) {
1973 /* Always fill in the name and mode, so that nobody else
1974 needs to special-case NULLs there. */
1975 Py_INCREF(not_yet_string);
1976 ((PyFileObject *)self)->f_name = not_yet_string;
1977 Py_INCREF(not_yet_string);
1978 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001979 Py_INCREF(Py_None);
1980 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001981 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001982 }
1983 return self;
1984}
1985
1986static int
1987file_init(PyObject *self, PyObject *args, PyObject *kwds)
1988{
1989 PyFileObject *foself = (PyFileObject *)self;
1990 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001991 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001992 char *name = NULL;
1993 char *mode = "r";
1994 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001995 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001996
1997 assert(PyFile_Check(self));
1998 if (foself->f_fp != NULL) {
1999 /* Have to close the existing file first. */
2000 PyObject *closeresult = file_close(foself);
2001 if (closeresult == NULL)
2002 return -1;
2003 Py_DECREF(closeresult);
2004 }
Tim Peters59c9a642001-09-13 05:38:56 +00002005
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002006#ifdef Py_WIN_WIDE_FILENAMES
2007 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
2008 PyObject *po;
2009 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
2010 kwlist, &po, &mode, &bufsize)) {
2011 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002012 if (fill_file_fields(foself, NULL, po, mode,
2013 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002014 goto Error;
2015 } else {
2016 /* Drop the argument parsing error as narrow
2017 strings are also valid. */
2018 PyErr_Clear();
2019 }
2020 }
2021#endif
2022
2023 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002024 PyObject *o_name;
2025
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002026 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2027 Py_FileSystemDefaultEncoding,
2028 &name,
2029 &mode, &bufsize))
2030 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002031
2032 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002033 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2034 kwlist, &o_name, &mode,
2035 &bufsize))
Brett Cannon2b3666f2006-08-31 18:54:26 +00002036 goto Error;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002037
2038 if (fill_file_fields(foself, NULL, o_name, mode,
2039 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002040 goto Error;
2041 }
Tim Peters44410012001-09-14 03:26:08 +00002042 if (open_the_file(foself, name, mode) == NULL)
2043 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002044 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002045 PyFile_SetBufSize(self, bufsize);
2046 goto Done;
2047
2048Error:
2049 ret = -1;
2050 /* fall through */
2051Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002052 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002053 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002054}
2055
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002056PyDoc_VAR(file_doc) =
2057PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002058"file(name[, mode[, buffering]]) -> file object\n"
2059"\n"
2060"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2061"writing or appending. The file will be created if it doesn't exist\n"
2062"when opened for writing or appending; it will be truncated when\n"
2063"opened for writing. Add a 'b' to the mode for binary files.\n"
2064"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2065"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002066"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002067)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002068PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002069"Add a 'U' to mode to open the file for input with universal newline\n"
2070"support. Any line ending in the input file will be seen as a '\\n'\n"
2071"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2072"the value for this attribute is one of None (no newline read yet),\n"
2073"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2074"\n"
2075"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002076);
Tim Peters59c9a642001-09-13 05:38:56 +00002077
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002078PyTypeObject PyFile_Type = {
2079 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002080 0,
2081 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002082 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002083 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002084 (destructor)file_dealloc, /* tp_dealloc */
2085 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002086 0, /* tp_getattr */
2087 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002088 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002089 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002090 0, /* tp_as_number */
2091 0, /* tp_as_sequence */
2092 0, /* tp_as_mapping */
2093 0, /* tp_hash */
2094 0, /* tp_call */
2095 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002096 PyObject_GenericGetAttr, /* tp_getattro */
Tim Peters015dd822003-05-04 04:16:52 +00002097 /* softspace is writable: we must supply tp_setattro */
2098 PyObject_GenericSetAttr, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002099 0, /* tp_as_buffer */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002100 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002101 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002102 0, /* tp_traverse */
2103 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002104 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002105 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002106 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002107 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002108 file_methods, /* tp_methods */
2109 file_memberlist, /* tp_members */
2110 file_getsetlist, /* tp_getset */
2111 0, /* tp_base */
2112 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002113 0, /* tp_descr_get */
2114 0, /* tp_descr_set */
2115 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002116 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002117 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002118 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002119 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002120};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002121
2122/* Interface for the 'soft space' between print items. */
2123
2124int
Fred Drakefd99de62000-07-09 05:02:18 +00002125PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00002126{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002127 long oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002128 if (f == NULL) {
2129 /* Do nothing */
2130 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002131 else if (PyFile_Check(f)) {
2132 oldflag = ((PyFileObject *)f)->f_softspace;
2133 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002134 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00002135 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002136 PyObject *v;
2137 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002138 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002139 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002140 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002141 if (PyInt_Check(v))
2142 oldflag = PyInt_AsLong(v);
Martin v. Löwis18e16552006-02-15 17:27:45 +00002143 assert(oldflag < INT_MAX);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002144 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002145 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002146 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002147 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002148 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002149 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002150 if (PyObject_SetAttrString(f, "softspace", v) != 0)
2151 PyErr_Clear();
2152 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002153 }
2154 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002155 return (int)oldflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002156}
Guido van Rossum3165fe61992-09-25 21:59:05 +00002157
2158/* Interfaces to write objects/strings to file-like objects */
2159
2160int
Fred Drakefd99de62000-07-09 05:02:18 +00002161PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002162{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002163 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002164 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002165 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002166 return -1;
2167 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002168 else if (PyFile_Check(f)) {
2169 FILE *fp = PyFile_AsFile(f);
Fred Drake086a0f72004-03-19 15:22:36 +00002170#ifdef Py_USING_UNICODE
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002171 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2172 int result;
Fred Drake086a0f72004-03-19 15:22:36 +00002173#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002174 if (fp == NULL) {
2175 err_closed();
2176 return -1;
2177 }
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002178#ifdef Py_USING_UNICODE
Tim Petersf1827cf2003-09-07 03:30:18 +00002179 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002180 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002181 char *cenc = PyString_AS_STRING(enc);
2182 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2183 if (value == NULL)
2184 return -1;
2185 } else {
2186 value = v;
2187 Py_INCREF(value);
2188 }
2189 result = PyObject_Print(value, fp, flags);
2190 Py_DECREF(value);
2191 return result;
2192#else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002193 return PyObject_Print(v, fp, flags);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002194#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002195 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002196 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002197 if (writer == NULL)
2198 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002199 if (flags & Py_PRINT_RAW) {
2200 if (PyUnicode_Check(v)) {
2201 value = v;
2202 Py_INCREF(value);
2203 } else
2204 value = PyObject_Str(v);
2205 }
2206 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002207 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002208 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002209 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002210 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002211 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002212 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002213 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002214 Py_DECREF(value);
2215 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002216 return -1;
2217 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002218 result = PyEval_CallObject(writer, args);
2219 Py_DECREF(args);
2220 Py_DECREF(value);
2221 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002222 if (result == NULL)
2223 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002224 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002225 return 0;
2226}
2227
Guido van Rossum27a60b11997-05-22 22:25:11 +00002228int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002229PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002230{
2231 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002232 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002233 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002234 PyErr_SetString(PyExc_SystemError,
2235 "null file for PyFile_WriteString");
2236 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002237 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002238 else if (PyFile_Check(f)) {
2239 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002240 if (fp == NULL) {
2241 err_closed();
2242 return -1;
2243 }
2244 fputs(s, fp);
2245 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002246 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002247 else if (!PyErr_Occurred()) {
2248 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002249 int err;
2250 if (v == NULL)
2251 return -1;
2252 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2253 Py_DECREF(v);
2254 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002255 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002256 else
2257 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002258}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002259
2260/* Try to get a file-descriptor from a Python object. If the object
2261 is an integer or long integer, its value is returned. If not, the
2262 object's fileno() method is called if it exists; the method must return
2263 an integer or long integer, which is returned as the file descriptor value.
2264 -1 is returned on failure.
2265*/
2266
2267int PyObject_AsFileDescriptor(PyObject *o)
2268{
2269 int fd;
2270 PyObject *meth;
2271
2272 if (PyInt_Check(o)) {
2273 fd = PyInt_AsLong(o);
2274 }
2275 else if (PyLong_Check(o)) {
2276 fd = PyLong_AsLong(o);
2277 }
2278 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2279 {
2280 PyObject *fno = PyEval_CallObject(meth, NULL);
2281 Py_DECREF(meth);
2282 if (fno == NULL)
2283 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002284
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002285 if (PyInt_Check(fno)) {
2286 fd = PyInt_AsLong(fno);
2287 Py_DECREF(fno);
2288 }
2289 else if (PyLong_Check(fno)) {
2290 fd = PyLong_AsLong(fno);
2291 Py_DECREF(fno);
2292 }
2293 else {
2294 PyErr_SetString(PyExc_TypeError,
2295 "fileno() returned a non-integer");
2296 Py_DECREF(fno);
2297 return -1;
2298 }
2299 }
2300 else {
2301 PyErr_SetString(PyExc_TypeError,
2302 "argument must be an int, or have a fileno() method.");
2303 return -1;
2304 }
2305
2306 if (fd < 0) {
2307 PyErr_Format(PyExc_ValueError,
2308 "file descriptor cannot be a negative integer (%i)",
2309 fd);
2310 return -1;
2311 }
2312 return fd;
2313}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002314
Jack Jansen7b8c7542002-04-14 20:12:41 +00002315/* From here on we need access to the real fgets and fread */
2316#undef fgets
2317#undef fread
2318
2319/*
2320** Py_UniversalNewlineFgets is an fgets variation that understands
2321** all of \r, \n and \r\n conventions.
2322** The stream should be opened in binary mode.
2323** If fobj is NULL the routine always does newline conversion, and
2324** it may peek one char ahead to gobble the second char in \r\n.
2325** If fobj is non-NULL it must be a PyFileObject. In this case there
2326** is no readahead but in stead a flag is used to skip a following
2327** \n on the next read. Also, if the file is open in binary mode
2328** the whole conversion is skipped. Finally, the routine keeps track of
2329** the different types of newlines seen.
2330** Note that we need no error handling: fgets() treats error and eof
2331** identically.
2332*/
2333char *
2334Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2335{
2336 char *p = buf;
2337 int c;
2338 int newlinetypes = 0;
2339 int skipnextlf = 0;
2340 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002341
Jack Jansen7b8c7542002-04-14 20:12:41 +00002342 if (fobj) {
2343 if (!PyFile_Check(fobj)) {
2344 errno = ENXIO; /* What can you do... */
2345 return NULL;
2346 }
2347 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2348 if ( !univ_newline )
2349 return fgets(buf, n, stream);
2350 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2351 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2352 }
2353 FLOCKFILE(stream);
2354 c = 'x'; /* Shut up gcc warning */
2355 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2356 if (skipnextlf ) {
2357 skipnextlf = 0;
2358 if (c == '\n') {
2359 /* Seeing a \n here with skipnextlf true
2360 ** means we saw a \r before.
2361 */
2362 newlinetypes |= NEWLINE_CRLF;
2363 c = GETC(stream);
2364 if (c == EOF) break;
2365 } else {
2366 /*
2367 ** Note that c == EOF also brings us here,
2368 ** so we're okay if the last char in the file
2369 ** is a CR.
2370 */
2371 newlinetypes |= NEWLINE_CR;
2372 }
2373 }
2374 if (c == '\r') {
2375 /* A \r is translated into a \n, and we skip
2376 ** an adjacent \n, if any. We don't set the
2377 ** newlinetypes flag until we've seen the next char.
2378 */
2379 skipnextlf = 1;
2380 c = '\n';
2381 } else if ( c == '\n') {
2382 newlinetypes |= NEWLINE_LF;
2383 }
2384 *p++ = c;
2385 if (c == '\n') break;
2386 }
2387 if ( c == EOF && skipnextlf )
2388 newlinetypes |= NEWLINE_CR;
2389 FUNLOCKFILE(stream);
2390 *p = '\0';
2391 if (fobj) {
2392 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2393 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2394 } else if ( skipnextlf ) {
2395 /* If we have no file object we cannot save the
2396 ** skipnextlf flag. We have to readahead, which
2397 ** will cause a pause if we're reading from an
2398 ** interactive stream, but that is very unlikely
2399 ** unless we're doing something silly like
2400 ** execfile("/dev/tty").
2401 */
2402 c = GETC(stream);
2403 if ( c != '\n' )
2404 ungetc(c, stream);
2405 }
2406 if (p == buf)
2407 return NULL;
2408 return buf;
2409}
2410
2411/*
2412** Py_UniversalNewlineFread is an fread variation that understands
2413** all of \r, \n and \r\n conventions.
2414** The stream should be opened in binary mode.
2415** fobj must be a PyFileObject. In this case there
2416** is no readahead but in stead a flag is used to skip a following
2417** \n on the next read. Also, if the file is open in binary mode
2418** the whole conversion is skipped. Finally, the routine keeps track of
2419** the different types of newlines seen.
2420*/
2421size_t
Tim Peters058b1412002-04-21 07:29:14 +00002422Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002423 FILE *stream, PyObject *fobj)
2424{
Tim Peters058b1412002-04-21 07:29:14 +00002425 char *dst = buf;
2426 PyFileObject *f = (PyFileObject *)fobj;
2427 int newlinetypes, skipnextlf;
2428
2429 assert(buf != NULL);
2430 assert(stream != NULL);
2431
Jack Jansen7b8c7542002-04-14 20:12:41 +00002432 if (!fobj || !PyFile_Check(fobj)) {
2433 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002434 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002435 }
Tim Peters058b1412002-04-21 07:29:14 +00002436 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002437 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002438 newlinetypes = f->f_newlinetypes;
2439 skipnextlf = f->f_skipnextlf;
2440 /* Invariant: n is the number of bytes remaining to be filled
2441 * in the buffer.
2442 */
2443 while (n) {
2444 size_t nread;
2445 int shortread;
2446 char *src = dst;
2447
2448 nread = fread(dst, 1, n, stream);
2449 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002450 if (nread == 0)
2451 break;
2452
Tim Peterse1682a82002-04-21 18:15:20 +00002453 n -= nread; /* assuming 1 byte out for each in; will adjust */
2454 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002455 while (nread--) {
2456 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002457 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002458 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002459 *dst++ = '\n';
2460 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002461 }
2462 else if (skipnextlf && c == '\n') {
2463 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002464 skipnextlf = 0;
2465 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002466 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002467 }
2468 else {
2469 /* Normal char to be stored in buffer. Also
2470 * update the newlinetypes flag if either this
2471 * is an LF or the previous char was a CR.
2472 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002473 if (c == '\n')
2474 newlinetypes |= NEWLINE_LF;
2475 else if (skipnextlf)
2476 newlinetypes |= NEWLINE_CR;
2477 *dst++ = c;
2478 skipnextlf = 0;
2479 }
2480 }
Tim Peters058b1412002-04-21 07:29:14 +00002481 if (shortread) {
2482 /* If this is EOF, update type flags. */
2483 if (skipnextlf && feof(stream))
2484 newlinetypes |= NEWLINE_CR;
2485 break;
2486 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002487 }
Tim Peters058b1412002-04-21 07:29:14 +00002488 f->f_newlinetypes = newlinetypes;
2489 f->f_skipnextlf = skipnextlf;
2490 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002491}
Anthony Baxterac6bd462006-04-13 02:06:09 +00002492
2493#ifdef __cplusplus
2494}
2495#endif