blob: 869ded916cb56606efca1b087353022a08af3041 [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);
Thomas Wouterse4713172007-01-23 13:54:30 +0000357
358 assert(PyFile_Check(f));
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000359 if (!str)
360 return 0;
361 Py_DECREF(file->f_encoding);
362 file->f_encoding = str;
363 return 1;
364}
365
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000366static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000367err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000368{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000369 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000370 return NULL;
371}
372
Thomas Woutersc45251a2006-02-12 11:53:32 +0000373/* Refuse regular file I/O if there's data in the iteration-buffer.
374 * Mixing them would cause data to arrive out of order, as the read*
375 * methods don't use the iteration buffer. */
376static PyObject *
377err_iterbuffered(void)
378{
379 PyErr_SetString(PyExc_ValueError,
380 "Mixing iteration and read methods would lose data");
381 return NULL;
382}
383
Neal Norwitzd8b995f2002-08-06 21:50:54 +0000384static void drop_readahead(PyFileObject *);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000385
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000386/* Methods */
387
388static void
Fred Drakefd99de62000-07-09 05:02:18 +0000389file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000390{
Peter Astrandf8e74b12004-11-07 14:15:28 +0000391 int sts = 0;
Raymond Hettingercb87bc82004-05-31 00:35:52 +0000392 if (f->weakreflist != NULL)
393 PyObject_ClearWeakRefs((PyObject *) f);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000394 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000395 Py_BEGIN_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000396 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000397 Py_END_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000398 if (sts == EOF)
399#ifdef HAVE_STRERROR
400 PySys_WriteStderr("close failed: [Errno %d] %s\n", errno, strerror(errno));
401#else
402 PySys_WriteStderr("close failed: [Errno %d]\n", errno);
403#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000404 }
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000405 PyMem_Free(f->f_setbuf);
Tim Peters44410012001-09-14 03:26:08 +0000406 Py_XDECREF(f->f_name);
407 Py_XDECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000408 Py_XDECREF(f->f_encoding);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000409 drop_readahead(f);
Guido van Rossum9475a232001-10-05 20:51:39 +0000410 f->ob_type->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000411}
412
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000413static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000414file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000415{
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000416 if (PyUnicode_Check(f->f_name)) {
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000417#ifdef Py_USING_UNICODE
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000418 PyObject *ret = NULL;
Neal Norwitzfc28e0d2006-07-16 02:32:03 +0000419 PyObject *name = PyUnicode_AsUnicodeEscapeString(f->f_name);
420 const char *name_str = name ? PyString_AsString(name) : "?";
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000421 ret = PyString_FromFormat("<%s file u'%s', mode '%s' at %p>",
422 f->f_fp == NULL ? "closed" : "open",
Neal Norwitzfc28e0d2006-07-16 02:32:03 +0000423 name_str,
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000424 PyString_AsString(f->f_mode),
425 f);
426 Py_XDECREF(name);
427 return ret;
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000428#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000429 } else {
430 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000431 f->f_fp == NULL ? "closed" : "open",
432 PyString_AsString(f->f_name),
433 PyString_AsString(f->f_mode),
434 f);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000435 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000436}
437
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000438static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000439file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000440{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000441 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000442 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000443 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000444 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000445 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000446 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000447 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000448 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000449 f->f_fp = NULL;
450 }
Martin v. Löwis7bbcde72003-09-07 20:42:29 +0000451 PyMem_Free(f->f_setbuf);
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000452 f->f_setbuf = NULL;
Guido van Rossumfebd5511992-03-04 16:39:24 +0000453 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000454 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000455 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000456 return PyInt_FromLong((long)sts);
457 Py_INCREF(Py_None);
458 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000459}
460
Trent Mickf29f47b2000-08-11 19:02:59 +0000461
Guido van Rossumb8552162001-09-05 14:58:11 +0000462/* Our very own off_t-like type, 64-bit if possible */
463#if !defined(HAVE_LARGEFILE_SUPPORT)
464typedef off_t Py_off_t;
465#elif SIZEOF_OFF_T >= 8
466typedef off_t Py_off_t;
467#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000468typedef fpos_t Py_off_t;
469#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000470#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000471#endif
472
473
Trent Mickf29f47b2000-08-11 19:02:59 +0000474/* a portable fseek() function
475 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000476static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000477_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000478{
Guido van Rossumb8552162001-09-05 14:58:11 +0000479#if !defined(HAVE_LARGEFILE_SUPPORT)
480 return fseek(fp, offset, whence);
481#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000482 return fseeko(fp, offset, whence);
483#elif defined(HAVE_FSEEK64)
484 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000485#elif defined(__BEOS__)
486 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000487#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000488 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
489 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000490 fpos_t pos;
491 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000492 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000493#ifdef MS_WINDOWS
494 fflush(fp);
495 if (_lseeki64(fileno(fp), 0, 2) == -1)
496 return -1;
497#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000498 if (fseek(fp, 0, SEEK_END) != 0)
499 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000500#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000501 /* fall through */
502 case SEEK_CUR:
503 if (fgetpos(fp, &pos) != 0)
504 return -1;
505 offset += pos;
506 break;
507 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000508 }
509 return fsetpos(fp, &offset);
510#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000511#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000512#endif
513}
514
515
516/* a portable ftell() function
517 Return -1 on failure with errno set appropriately, current file
518 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000519static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000520_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000521{
Guido van Rossumb8552162001-09-05 14:58:11 +0000522#if !defined(HAVE_LARGEFILE_SUPPORT)
523 return ftell(fp);
524#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
525 return ftello(fp);
526#elif defined(HAVE_FTELL64)
527 return ftell64(fp);
528#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000529 fpos_t pos;
530 if (fgetpos(fp, &pos) != 0)
531 return -1;
532 return pos;
533#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000534#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000535#endif
536}
537
538
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000539static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000540file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000541{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000542 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000543 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000544 Py_off_t offset;
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000545 PyObject *offobj;
Tim Peters86821b22001-01-07 21:19:34 +0000546
Guido van Rossumd7297e61992-07-06 14:19:26 +0000547 if (f->f_fp == NULL)
548 return err_closed();
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000549 drop_readahead(f);
Guido van Rossumd7297e61992-07-06 14:19:26 +0000550 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000551 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000552 return NULL;
553#if !defined(HAVE_LARGEFILE_SUPPORT)
554 offset = PyInt_AsLong(offobj);
555#else
556 offset = PyLong_Check(offobj) ?
557 PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj);
558#endif
559 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000560 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000561
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000562 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000563 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000564 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000565 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000566
Guido van Rossumff4949e1992-08-05 19:58:53 +0000567 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000568 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000569 clearerr(f->f_fp);
570 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000571 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000572 f->f_skipnextlf = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000573 Py_INCREF(Py_None);
574 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000575}
576
Trent Mickf29f47b2000-08-11 19:02:59 +0000577
Guido van Rossumd7047b31995-01-02 19:07:15 +0000578#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000579static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000580file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000581{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000582 Py_off_t newsize;
Tim Petersf1827cf2003-09-07 03:30:18 +0000583 PyObject *newsizeobj = NULL;
584 Py_off_t initialpos;
585 int ret;
Tim Peters86821b22001-01-07 21:19:34 +0000586
Guido van Rossumd7047b31995-01-02 19:07:15 +0000587 if (f->f_fp == NULL)
588 return err_closed();
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000589 if (!PyArg_UnpackTuple(args, "truncate", 0, 1, &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000590 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000591
Tim Petersf1827cf2003-09-07 03:30:18 +0000592 /* Get current file position. If the file happens to be open for
593 * update and the last operation was an input operation, C doesn't
594 * define what the later fflush() will do, but we promise truncate()
595 * won't change the current position (and fflush() *does* change it
596 * then at least on Windows). The easiest thing is to capture
597 * current pos now and seek back to it at the end.
598 */
599 Py_BEGIN_ALLOW_THREADS
600 errno = 0;
601 initialpos = _portable_ftell(f->f_fp);
602 Py_END_ALLOW_THREADS
603 if (initialpos == -1)
604 goto onioerror;
605
Tim Petersfb05db22002-03-11 00:24:00 +0000606 /* Set newsize to current postion if newsizeobj NULL, else to the
Tim Petersf1827cf2003-09-07 03:30:18 +0000607 * specified value.
608 */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000609 if (newsizeobj != NULL) {
610#if !defined(HAVE_LARGEFILE_SUPPORT)
611 newsize = PyInt_AsLong(newsizeobj);
612#else
613 newsize = PyLong_Check(newsizeobj) ?
614 PyLong_AsLongLong(newsizeobj) :
615 PyInt_AsLong(newsizeobj);
616#endif
617 if (PyErr_Occurred())
618 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000619 }
Tim Petersf1827cf2003-09-07 03:30:18 +0000620 else /* default to current position */
621 newsize = initialpos;
Tim Petersfb05db22002-03-11 00:24:00 +0000622
Tim Petersf1827cf2003-09-07 03:30:18 +0000623 /* Flush the stream. We're mixing stream-level I/O with lower-level
624 * I/O, and a flush may be necessary to synch both platform views
625 * of the current file state.
626 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000627 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000628 errno = 0;
629 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000630 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000631 if (ret != 0)
632 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000633
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000634#ifdef MS_WINDOWS
Tim Petersfb05db22002-03-11 00:24:00 +0000635 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000636 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000637 {
Tim Petersfb05db22002-03-11 00:24:00 +0000638 HANDLE hFile;
Tim Petersfb05db22002-03-11 00:24:00 +0000639
Tim Petersf1827cf2003-09-07 03:30:18 +0000640 /* Have to move current pos to desired endpoint on Windows. */
641 Py_BEGIN_ALLOW_THREADS
642 errno = 0;
643 ret = _portable_fseek(f->f_fp, newsize, SEEK_SET) != 0;
644 Py_END_ALLOW_THREADS
645 if (ret)
646 goto onioerror;
Tim Petersfb05db22002-03-11 00:24:00 +0000647
Tim Peters8f01b682002-03-12 03:04:44 +0000648 /* Truncate. Note that this may grow the file! */
649 Py_BEGIN_ALLOW_THREADS
650 errno = 0;
651 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
Tim Petersf1827cf2003-09-07 03:30:18 +0000652 ret = hFile == (HANDLE)-1;
653 if (ret == 0) {
654 ret = SetEndOfFile(hFile) == 0;
655 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000656 errno = EACCES;
657 }
658 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000659 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000660 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000661 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000662#else
663 Py_BEGIN_ALLOW_THREADS
664 errno = 0;
665 ret = ftruncate(fileno(f->f_fp), newsize);
666 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000667 if (ret != 0)
668 goto onioerror;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000669#endif /* !MS_WINDOWS */
Tim Peters86821b22001-01-07 21:19:34 +0000670
Tim Petersf1827cf2003-09-07 03:30:18 +0000671 /* Restore original file position. */
672 Py_BEGIN_ALLOW_THREADS
673 errno = 0;
674 ret = _portable_fseek(f->f_fp, initialpos, SEEK_SET) != 0;
675 Py_END_ALLOW_THREADS
676 if (ret)
677 goto onioerror;
678
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000679 Py_INCREF(Py_None);
680 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000681
682onioerror:
683 PyErr_SetFromErrno(PyExc_IOError);
684 clearerr(f->f_fp);
685 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000686}
687#endif /* HAVE_FTRUNCATE */
688
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000689static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000690file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000691{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000692 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000693
Guido van Rossumd7297e61992-07-06 14:19:26 +0000694 if (f->f_fp == NULL)
695 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000696 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000697 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000698 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000699 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000700 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000701 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000702 clearerr(f->f_fp);
703 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000704 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000705 if (f->f_skipnextlf) {
706 int c;
707 c = GETC(f->f_fp);
708 if (c == '\n') {
709 pos++;
710 f->f_skipnextlf = 0;
711 } else if (c != EOF) ungetc(c, f->f_fp);
712 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000713#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000714 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000715#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000716 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000717#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000718}
719
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000720static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000721file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000722{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000723 if (f->f_fp == NULL)
724 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000725 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000726}
727
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000728static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000729file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000730{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000731 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000732
Guido van Rossumd7297e61992-07-06 14:19:26 +0000733 if (f->f_fp == NULL)
734 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000735 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000736 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000737 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000738 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000739 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000740 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000741 clearerr(f->f_fp);
742 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000743 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000744 Py_INCREF(Py_None);
745 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000746}
747
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000748static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000749file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000750{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000751 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000752 if (f->f_fp == NULL)
753 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000754 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000755 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000756 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000757 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000758}
759
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000760
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000761#if BUFSIZ < 8192
762#define SMALLCHUNK 8192
763#else
764#define SMALLCHUNK BUFSIZ
765#endif
766
Guido van Rossum3c259041999-01-14 19:00:14 +0000767#if SIZEOF_INT < 4
768#define BIGCHUNK (512 * 32)
769#else
770#define BIGCHUNK (512 * 1024)
771#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000772
773static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000774new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000775{
776#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000777 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000778 struct stat st;
779 if (fstat(fileno(f->f_fp), &st) == 0) {
780 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000781 /* The following is not a bug: we really need to call lseek()
782 *and* ftell(). The reason is that some stdio libraries
783 mistakenly flush their buffer when ftell() is called and
784 the lseek() call it makes fails, thereby throwing away
785 data that cannot be recovered in any way. To avoid this,
786 we first test lseek(), and only call ftell() if lseek()
787 works. We can't use the lseek() value either, because we
788 need to take the amount of buffered data into account.
789 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000790 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000791 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000792 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000793 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000794 if (pos < 0)
795 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000796 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000797 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000798 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000799 }
800#endif
801 if (currentsize > SMALLCHUNK) {
802 /* Keep doubling until we reach BIGCHUNK;
803 then keep adding BIGCHUNK. */
804 if (currentsize <= BIGCHUNK)
805 return currentsize + currentsize;
806 else
807 return currentsize + BIGCHUNK;
808 }
809 return currentsize + SMALLCHUNK;
810}
811
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000812#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
813#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
814#else
815#ifdef EWOULDBLOCK
816#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
817#else
818#ifdef EAGAIN
819#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
820#else
821#define BLOCKED_ERRNO(x) 0
822#endif
823#endif
824#endif
825
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000826static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000827file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000828{
Guido van Rossum789a1611997-05-10 22:33:55 +0000829 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000830 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000831 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000832
Guido van Rossumd7297e61992-07-06 14:19:26 +0000833 if (f->f_fp == NULL)
834 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000835 /* refuse to mix with f.next() */
836 if (f->f_buf != NULL &&
837 (f->f_bufend - f->f_bufptr) > 0 &&
838 f->f_buf[0] != '\0')
839 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000840 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000841 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000842 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000843 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000844 else
845 buffersize = bytesrequested;
Martin v. Löwis2a190742006-04-13 07:37:25 +0000846 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000847 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000848 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000849 return NULL;
850 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000851 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000852 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000853 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000854 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000855 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000856 Py_BEGIN_ALLOW_THREADS
857 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000858 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000859 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000860 Py_END_ALLOW_THREADS
861 if (chunksize == 0) {
862 if (!ferror(f->f_fp))
863 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000864 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000865 /* When in non-blocking mode, data shouldn't
866 * be discarded if a blocking signal was
867 * received. That will also happen if
868 * chunksize != 0, but bytesread < buffersize. */
869 if (bytesread > 0 && BLOCKED_ERRNO(errno))
870 break;
871 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum6263d541997-05-10 22:07:25 +0000872 Py_DECREF(v);
873 return NULL;
874 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000875 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000876 if (bytesread < buffersize) {
877 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000878 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000879 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000880 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000881 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000882 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000883 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000884 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000885 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000886 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000887 }
888 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000889 if (bytesread != buffersize)
890 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000891 return v;
892}
893
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000894static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000895file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000896{
897 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000898 Py_ssize_t ntodo;
899 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000900
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000901 if (f->f_fp == NULL)
902 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000903 /* refuse to mix with f.next() */
904 if (f->f_buf != NULL &&
905 (f->f_bufend - f->f_bufptr) > 0 &&
906 f->f_buf[0] != '\0')
907 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000908 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000909 return NULL;
910 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000911 while (ntodo > 0) {
912 Py_BEGIN_ALLOW_THREADS
913 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000914 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000915 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000916 Py_END_ALLOW_THREADS
917 if (nnow == 0) {
918 if (!ferror(f->f_fp))
919 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000920 PyErr_SetFromErrno(PyExc_IOError);
921 clearerr(f->f_fp);
922 return NULL;
923 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000924 ndone += nnow;
925 ntodo -= nnow;
926 }
Neal Norwitz47f0ffa2006-08-21 18:44:09 +0000927 return PyInt_FromSsize_t(ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000928}
929
Tim Peters86821b22001-01-07 21:19:34 +0000930/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000931Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000932
933Under MSVC 6:
934
Tim Peters1c733232001-01-08 04:02:07 +0000935+ MS threadsafe getc is very slow (multiple layers of function calls before+
936 after each character, to lock+unlock the stream).
937+ The stream-locking functions are MS-internal -- can't access them from user
938 code.
939+ There's nothing Tim could find in the MS C or platform SDK libraries that
940 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000941+ MS fgets locks/unlocks only once per line; it's the only hook we have.
942
943So we use fgets for speed(!), despite that it's painful.
944
945MS realloc is also slow.
946
Tim Petersf29b64d2001-01-15 06:33:19 +0000947Reports from other platforms on this method vs getc_unlocked (which MS doesn't
948have):
949 Linux a wash
950 Solaris a wash
951 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000952
Tim Petersf29b64d2001-01-15 06:33:19 +0000953CAUTION: The C std isn't clear about this: in those cases where fgets
954writes something into the buffer, can it write into any position beyond the
955required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
956known on which it does; and it would be a strange way to code fgets. Still,
957getline_via_fgets may not work correctly if it does. The std test
958test_bufio.py should fail if platform fgets() routinely writes beyond the
959trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000960**************************************************************************/
961
Tim Petersf29b64d2001-01-15 06:33:19 +0000962/* Use this routine if told to, or by default on non-get_unlocked()
963 * platforms unless told not to. Yikes! Let's spell that out:
964 * On a platform with getc_unlocked():
965 * By default, use getc_unlocked().
966 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
967 * On a platform without getc_unlocked():
968 * By default, use fgets().
969 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
970 */
971#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
972#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000973#endif
974
Tim Petersf29b64d2001-01-15 06:33:19 +0000975#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
976#undef USE_FGETS_IN_GETLINE
977#endif
978
979#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000980static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000981getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000982{
Tim Peters15b83852001-01-08 00:53:12 +0000983/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000984 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
985 * to fill this much of the buffer with a known value in order to figure out
986 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
987 * than "most" lines, we waste time filling unused buffer slots. 100 is
988 * surely adequate for most peoples' email archives, chewing over source code,
989 * etc -- "regular old text files".
990 * MAXBUFSIZE is the maximum line length that lets us get away with the less
991 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
992 * cautions about boosting that. 300 was chosen because the worst real-life
993 * text-crunching job reported on Python-Dev was a mail-log crawler where over
994 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +0000995 */
Tim Peters142297a2001-01-15 10:36:56 +0000996#define INITBUFSIZE 100
997#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +0000998 char* p; /* temp */
999 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +00001000 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +00001001 char* pvfree; /* address of next free slot */
1002 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +00001003 size_t nfree; /* # of free buffer slots; pvend-pvfree */
1004 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001005 size_t increment; /* amount to increment the buffer */
Armin Rigo4b63c212006-10-04 11:44:06 +00001006 size_t prev_v_size;
Tim Peters86821b22001-01-07 21:19:34 +00001007
Tim Peters15b83852001-01-08 00:53:12 +00001008 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001009 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001010 */
Tim Peters142297a2001-01-15 10:36:56 +00001011 total_v_size = INITBUFSIZE; /* start small and pray */
1012 pvfree = buf;
1013 for (;;) {
1014 Py_BEGIN_ALLOW_THREADS
1015 pvend = buf + total_v_size;
1016 nfree = pvend - pvfree;
1017 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001018 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1019 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001020 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001021
Tim Peters142297a2001-01-15 10:36:56 +00001022 if (p == NULL) {
1023 clearerr(fp);
1024 if (PyErr_CheckSignals())
1025 return NULL;
1026 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001027 return v;
1028 }
Tim Peters142297a2001-01-15 10:36:56 +00001029 /* fgets read *something* */
1030 p = memchr(pvfree, '\n', nfree);
1031 if (p != NULL) {
1032 /* Did the \n come from fgets or from us?
1033 * Since fgets stops at the first \n, and then writes
1034 * \0, if it's from fgets a \0 must be next. But if
1035 * that's so, it could not have come from us, since
1036 * the \n's we filled the buffer with have only more
1037 * \n's to the right.
1038 */
1039 if (p+1 < pvend && *(p+1) == '\0') {
1040 /* It's from fgets: we win! In particular,
1041 * we haven't done any mallocs yet, and can
1042 * build the final result on the first try.
1043 */
1044 ++p; /* include \n from fgets */
1045 }
1046 else {
1047 /* Must be from us: fgets didn't fill the
1048 * buffer and didn't find a newline, so it
1049 * must be the last and newline-free line of
1050 * the file.
1051 */
1052 assert(p > pvfree && *(p-1) == '\0');
1053 --p; /* don't include \0 from fgets */
1054 }
1055 v = PyString_FromStringAndSize(buf, p - buf);
1056 return v;
1057 }
1058 /* yuck: fgets overwrote all the newlines, i.e. the entire
1059 * buffer. So this line isn't over yet, or maybe it is but
1060 * we're exactly at EOF. If we haven't already, try using the
1061 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001062 */
Tim Peters142297a2001-01-15 10:36:56 +00001063 assert(*(pvend-1) == '\0');
1064 if (pvfree == buf) {
1065 pvfree = pvend - 1; /* overwrite trailing null */
1066 total_v_size = MAXBUFSIZE;
1067 }
1068 else
1069 break;
Tim Peters86821b22001-01-07 21:19:34 +00001070 }
Tim Peters142297a2001-01-15 10:36:56 +00001071
1072 /* The stack buffer isn't big enough; malloc a string object and read
1073 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001074 */
Tim Petersddea2082002-03-23 10:03:50 +00001075 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001076 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001077 if (v == NULL)
1078 return v;
1079 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001080 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1081 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001082
1083 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001084 * after setting p one beyond the end of the line. The code here is
1085 * very much like the code above, except reads into v's buffer; see
1086 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001087 */
1088 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001089 Py_BEGIN_ALLOW_THREADS
1090 pvend = BUF(v) + total_v_size;
1091 nfree = pvend - pvfree;
1092 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001093 assert(nfree < INT_MAX);
1094 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001095 Py_END_ALLOW_THREADS
1096
1097 if (p == NULL) {
1098 clearerr(fp);
1099 if (PyErr_CheckSignals()) {
1100 Py_DECREF(v);
1101 return NULL;
1102 }
1103 p = pvfree;
1104 break;
1105 }
Tim Peters86821b22001-01-07 21:19:34 +00001106 p = memchr(pvfree, '\n', nfree);
1107 if (p != NULL) {
1108 if (p+1 < pvend && *(p+1) == '\0') {
1109 /* \n came from fgets */
1110 ++p;
1111 break;
1112 }
1113 /* \n came from us; last line of file, no newline */
1114 assert(p > pvfree && *(p-1) == '\0');
1115 --p;
1116 break;
1117 }
1118 /* expand buffer and try again */
1119 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001120 increment = total_v_size >> 2; /* mild exponential growth */
Armin Rigo4b63c212006-10-04 11:44:06 +00001121 prev_v_size = total_v_size;
Tim Petersddea2082002-03-23 10:03:50 +00001122 total_v_size += increment;
Armin Rigo4b63c212006-10-04 11:44:06 +00001123 /* check for overflow */
1124 if (total_v_size <= prev_v_size ||
1125 total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001126 PyErr_SetString(PyExc_OverflowError,
1127 "line is longer than a Python string can hold");
1128 Py_DECREF(v);
1129 return NULL;
1130 }
1131 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1132 return NULL;
1133 /* overwrite the trailing null byte */
Armin Rigo4b63c212006-10-04 11:44:06 +00001134 pvfree = BUF(v) + (prev_v_size - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001135 }
1136 if (BUF(v) + total_v_size != p)
1137 _PyString_Resize(&v, p - BUF(v));
1138 return v;
1139#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001140#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001141}
Tim Petersf29b64d2001-01-15 06:33:19 +00001142#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001143
Guido van Rossum0bd24411991-04-04 15:21:57 +00001144/* Internal routine to get a line.
1145 Size argument interpretation:
1146 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001147 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001148*/
1149
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001150static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001151get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001152{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001153 FILE *fp = f->f_fp;
1154 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001155 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001156 size_t total_v_size; /* total # of slots in buffer */
1157 size_t used_v_size; /* # used slots in buffer */
1158 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001159 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001160 int newlinetypes = f->f_newlinetypes;
1161 int skipnextlf = f->f_skipnextlf;
1162 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001163
Jack Jansen7b8c7542002-04-14 20:12:41 +00001164#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001165 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001166 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001167#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001168 total_v_size = n > 0 ? n : 100;
1169 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001170 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001171 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001172 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001173 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001174
Guido van Rossumce5ba841991-03-06 13:06:18 +00001175 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001176 Py_BEGIN_ALLOW_THREADS
1177 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001178 if (univ_newline) {
1179 c = 'x'; /* Shut up gcc warning */
1180 while ( buf != end && (c = GETC(fp)) != EOF ) {
1181 if (skipnextlf ) {
1182 skipnextlf = 0;
1183 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001184 /* Seeing a \n here with
1185 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001186 * saw a \r before.
1187 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001188 newlinetypes |= NEWLINE_CRLF;
1189 c = GETC(fp);
1190 if (c == EOF) break;
1191 } else {
1192 newlinetypes |= NEWLINE_CR;
1193 }
1194 }
1195 if (c == '\r') {
1196 skipnextlf = 1;
1197 c = '\n';
1198 } else if ( c == '\n')
1199 newlinetypes |= NEWLINE_LF;
1200 *buf++ = c;
1201 if (c == '\n') break;
1202 }
1203 if ( c == EOF && skipnextlf )
1204 newlinetypes |= NEWLINE_CR;
1205 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001206 while ((c = GETC(fp)) != EOF &&
1207 (*buf++ = c) != '\n' &&
1208 buf != end)
1209 ;
1210 FUNLOCKFILE(fp);
1211 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001212 f->f_newlinetypes = newlinetypes;
1213 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001214 if (c == '\n')
1215 break;
1216 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001217 if (ferror(fp)) {
1218 PyErr_SetFromErrno(PyExc_IOError);
1219 clearerr(fp);
1220 Py_DECREF(v);
1221 return NULL;
1222 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001223 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001224 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001225 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001226 return NULL;
1227 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001228 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001229 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001230 /* Must be because buf == end */
1231 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001232 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001233 used_v_size = total_v_size;
1234 increment = total_v_size >> 2; /* mild exponential growth */
1235 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001236 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001237 PyErr_SetString(PyExc_OverflowError,
1238 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001239 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001240 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001241 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001242 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001243 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001244 buf = BUF(v) + used_v_size;
1245 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001246 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001247
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001248 used_v_size = buf - BUF(v);
1249 if (used_v_size != total_v_size)
1250 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001251 return v;
1252}
1253
Guido van Rossum0bd24411991-04-04 15:21:57 +00001254/* External C interface */
1255
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001256PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001257PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001258{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001259 PyObject *result;
1260
Guido van Rossum3165fe61992-09-25 21:59:05 +00001261 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001262 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001263 return NULL;
1264 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001265
1266 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001267 PyFileObject *fo = (PyFileObject *)f;
1268 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001269 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001270 /* refuse to mix with f.next() */
1271 if (fo->f_buf != NULL &&
1272 (fo->f_bufend - fo->f_bufptr) > 0 &&
1273 fo->f_buf[0] != '\0')
1274 return err_iterbuffered();
1275 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001276 }
1277 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001278 PyObject *reader;
1279 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001280
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001281 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001282 if (reader == NULL)
1283 return NULL;
1284 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001285 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001286 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001287 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001288 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001289 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001290 return NULL;
1291 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001292 result = PyEval_CallObject(reader, args);
1293 Py_DECREF(reader);
1294 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001295 if (result != NULL && !PyString_Check(result) &&
1296 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001297 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001298 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001299 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001300 "object.readline() returned non-string");
1301 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001302 }
1303
1304 if (n < 0 && result != NULL && PyString_Check(result)) {
1305 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001306 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001307 if (len == 0) {
1308 Py_DECREF(result);
1309 result = NULL;
1310 PyErr_SetString(PyExc_EOFError,
1311 "EOF when reading a line");
1312 }
1313 else if (s[len-1] == '\n') {
1314 if (result->ob_refcnt == 1)
1315 _PyString_Resize(&result, len-1);
1316 else {
1317 PyObject *v;
1318 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001319 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001320 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001321 }
1322 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001323 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001324#ifdef Py_USING_UNICODE
1325 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1326 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001327 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001328 if (len == 0) {
1329 Py_DECREF(result);
1330 result = NULL;
1331 PyErr_SetString(PyExc_EOFError,
1332 "EOF when reading a line");
1333 }
1334 else if (s[len-1] == '\n') {
1335 if (result->ob_refcnt == 1)
1336 PyUnicode_Resize(&result, len-1);
1337 else {
1338 PyObject *v;
1339 v = PyUnicode_FromUnicode(s, len-1);
1340 Py_DECREF(result);
1341 result = v;
1342 }
1343 }
1344 }
1345#endif
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001346 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001347}
1348
1349/* Python method */
1350
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001351static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001352file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001353{
Guido van Rossum789a1611997-05-10 22:33:55 +00001354 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001355
Guido van Rossumd7297e61992-07-06 14:19:26 +00001356 if (f->f_fp == NULL)
1357 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001358 /* refuse to mix with f.next() */
1359 if (f->f_buf != NULL &&
1360 (f->f_bufend - f->f_bufptr) > 0 &&
1361 f->f_buf[0] != '\0')
1362 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001363 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001364 return NULL;
1365 if (n == 0)
1366 return PyString_FromString("");
1367 if (n < 0)
1368 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001369 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001370}
1371
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001372static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001373file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001374{
Guido van Rossum789a1611997-05-10 22:33:55 +00001375 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001376 PyObject *list;
1377 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001378 char small_buffer[SMALLCHUNK];
1379 char *buffer = small_buffer;
1380 size_t buffersize = SMALLCHUNK;
1381 PyObject *big_buffer = NULL;
1382 size_t nfilled = 0;
1383 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001384 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001385 char *p, *q, *end;
1386 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001387 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001388
Guido van Rossumd7297e61992-07-06 14:19:26 +00001389 if (f->f_fp == NULL)
1390 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001391 /* refuse to mix with f.next() */
1392 if (f->f_buf != NULL &&
1393 (f->f_bufend - f->f_bufptr) > 0 &&
1394 f->f_buf[0] != '\0')
1395 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001396 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001397 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001398 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001399 return NULL;
1400 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001401 if (shortread)
1402 nread = 0;
1403 else {
1404 Py_BEGIN_ALLOW_THREADS
1405 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001406 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001407 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001408 Py_END_ALLOW_THREADS
1409 shortread = (nread < buffersize-nfilled);
1410 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001411 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001412 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001413 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001414 break;
1415 PyErr_SetFromErrno(PyExc_IOError);
1416 clearerr(f->f_fp);
1417 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001418 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001419 list = NULL;
1420 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001421 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001422 totalread += nread;
Anthony Baxter377be112006-04-11 06:54:30 +00001423 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001424 if (p == NULL) {
1425 /* Need a larger buffer to fit this line */
1426 nfilled += nread;
1427 buffersize *= 2;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001428 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001429 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001430 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001431 goto error;
1432 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001433 if (big_buffer == NULL) {
1434 /* Create the big buffer */
1435 big_buffer = PyString_FromStringAndSize(
1436 NULL, buffersize);
1437 if (big_buffer == NULL)
1438 goto error;
1439 buffer = PyString_AS_STRING(big_buffer);
1440 memcpy(buffer, small_buffer, nfilled);
1441 }
1442 else {
1443 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001444 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1445 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001446 buffer = PyString_AS_STRING(big_buffer);
1447 }
1448 continue;
1449 }
1450 end = buffer+nfilled+nread;
1451 q = buffer;
1452 do {
1453 /* Process complete lines */
1454 p++;
1455 line = PyString_FromStringAndSize(q, p-q);
1456 if (line == NULL)
1457 goto error;
1458 err = PyList_Append(list, line);
1459 Py_DECREF(line);
1460 if (err != 0)
1461 goto error;
1462 q = p;
Anthony Baxter377be112006-04-11 06:54:30 +00001463 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001464 } while (p != NULL);
1465 /* Move the remaining incomplete line to the start */
1466 nfilled = end-q;
1467 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001468 if (sizehint > 0)
1469 if (totalread >= (size_t)sizehint)
1470 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001471 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001472 if (nfilled != 0) {
1473 /* Partial last line */
1474 line = PyString_FromStringAndSize(buffer, nfilled);
1475 if (line == NULL)
1476 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001477 if (sizehint > 0) {
1478 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001479 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001480 if (rest == NULL) {
1481 Py_DECREF(line);
1482 goto error;
1483 }
1484 PyString_Concat(&line, rest);
1485 Py_DECREF(rest);
1486 if (line == NULL)
1487 goto error;
1488 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001489 err = PyList_Append(list, line);
1490 Py_DECREF(line);
1491 if (err != 0)
1492 goto error;
1493 }
1494 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001495 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001496 return list;
1497}
1498
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001499static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001500file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001501{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001502 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001503 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001504 if (f->f_fp == NULL)
1505 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001506 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001507 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001508 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001509 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001510 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001511 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001512 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001513 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001514 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001515 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001516 return NULL;
1517 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001518 Py_INCREF(Py_None);
1519 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001520}
1521
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001522static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001523file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001524{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001525#define CHUNKSIZE 1000
1526 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001527 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001528 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001529 int index, islist;
1530 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001531
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001532 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001533 if (f->f_fp == NULL)
1534 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001535
1536 result = NULL;
1537 list = NULL;
1538 islist = PyList_Check(seq);
1539 if (islist)
1540 it = NULL;
1541 else {
1542 it = PyObject_GetIter(seq);
1543 if (it == NULL) {
1544 PyErr_SetString(PyExc_TypeError,
1545 "writelines() requires an iterable argument");
1546 return NULL;
1547 }
1548 /* From here on, fail by going to error, to reclaim "it". */
1549 list = PyList_New(CHUNKSIZE);
1550 if (list == NULL)
1551 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001552 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001553
1554 /* Strategy: slurp CHUNKSIZE lines into a private list,
1555 checking that they are all strings, then write that list
1556 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001557 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001558 if (islist) {
1559 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001560 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001561 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001562 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001563 j = PyList_GET_SIZE(list);
1564 }
1565 else {
1566 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001567 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001568 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001569 if (PyErr_Occurred())
1570 goto error;
1571 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001572 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001573 PyList_SetItem(list, j, line);
1574 }
1575 }
1576 if (j == 0)
1577 break;
1578
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001579 /* Check that all entries are indeed strings. If not,
1580 apply the same rules as for file.write() and
1581 convert the results to strings. This is slow, but
1582 seems to be the only way since all conversion APIs
1583 could potentially execute Python code. */
1584 for (i = 0; i < j; i++) {
1585 PyObject *v = PyList_GET_ITEM(list, i);
1586 if (!PyString_Check(v)) {
1587 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001588 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001589 PyObject_AsReadBuffer(v,
1590 (const void**)&buffer,
1591 &len)) ||
1592 PyObject_AsCharBuffer(v,
1593 &buffer,
1594 &len))) {
1595 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001596 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001597 goto error;
1598 }
1599 line = PyString_FromStringAndSize(buffer,
1600 len);
1601 if (line == NULL)
1602 goto error;
1603 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001604 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001605 }
1606 }
1607
1608 /* Since we are releasing the global lock, the
1609 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001610 Py_BEGIN_ALLOW_THREADS
1611 f->f_softspace = 0;
1612 errno = 0;
1613 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001614 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001615 len = PyString_GET_SIZE(line);
1616 nwritten = fwrite(PyString_AS_STRING(line),
1617 1, len, f->f_fp);
1618 if (nwritten != len) {
1619 Py_BLOCK_THREADS
1620 PyErr_SetFromErrno(PyExc_IOError);
1621 clearerr(f->f_fp);
1622 goto error;
1623 }
1624 }
1625 Py_END_ALLOW_THREADS
1626
1627 if (j < CHUNKSIZE)
1628 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001629 }
1630
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001631 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001632 result = Py_None;
1633 error:
1634 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001635 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001636 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001637#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001638}
1639
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001640static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001641file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001642{
1643 if (f->f_fp == NULL)
1644 return err_closed();
1645 Py_INCREF(f);
1646 return (PyObject *)f;
1647}
1648
Georg Brandl98b40ad2006-06-08 14:50:21 +00001649static PyObject *
1650file_exit(PyFileObject *f, PyObject *args)
1651{
1652 PyObject *ret = file_close(f);
1653 if (!ret)
1654 /* If error occurred, pass through */
1655 return NULL;
1656 Py_DECREF(ret);
1657 /* We cannot return the result of close since a true
1658 * value will be interpreted as "yes, swallow the
1659 * exception if one was raised inside the with block". */
1660 Py_RETURN_NONE;
1661}
1662
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001663PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001664"readline([size]) -> next line from the file, as a string.\n"
1665"\n"
1666"Retain newline. A non-negative size argument limits the maximum\n"
1667"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001668"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001669
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001670PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001671"read([size]) -> read at most size bytes, returned as a string.\n"
1672"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001673"If the size argument is negative or omitted, read until EOF is reached.\n"
1674"Notice that when in non-blocking mode, less data than what was requested\n"
1675"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001676
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001677PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001678"write(str) -> None. Write string str to file.\n"
1679"\n"
1680"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001681"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001682
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001683PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001684"fileno() -> integer \"file descriptor\".\n"
1685"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001686"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001687
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001688PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001689"seek(offset[, whence]) -> None. Move to new file position.\n"
1690"\n"
1691"Argument offset is a byte count. Optional argument whence defaults to\n"
1692"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1693"(move relative to current position, positive or negative), and 2 (move\n"
1694"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001695"seeking beyond the end of a file). If the file is opened in text mode,\n"
1696"only offsets returned by tell() are legal. Use of other offsets causes\n"
1697"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001698"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001699"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001700
Guido van Rossumd7047b31995-01-02 19:07:15 +00001701#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001702PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001703"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1704"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001705"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001706#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001707
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001708PyDoc_STRVAR(tell_doc,
1709"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001710
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001711PyDoc_STRVAR(readinto_doc,
1712"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001713
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001714PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001715"readlines([size]) -> list of strings, each a line from the file.\n"
1716"\n"
1717"Call readline() repeatedly and return a list of the lines so read.\n"
1718"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001719"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001720
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001721PyDoc_STRVAR(xreadlines_doc,
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001722"xreadlines() -> returns self.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001723"\n"
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001724"For backward compatibility. File objects now include the performance\n"
1725"optimizations previously implemented in the xreadlines module.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001726
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001727PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001728"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001729"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001730"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001731"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001732
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001733PyDoc_STRVAR(flush_doc,
1734"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001735
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001736PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001737"close() -> None or (perhaps) an integer. Close the file.\n"
1738"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001739"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001740"further I/O operations. close() may be called more than once without\n"
1741"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001742"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001743
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001744PyDoc_STRVAR(isatty_doc,
1745"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001746
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001747PyDoc_STRVAR(enter_doc,
1748 "__enter__() -> self.");
1749
Georg Brandl98b40ad2006-06-08 14:50:21 +00001750PyDoc_STRVAR(exit_doc,
1751 "__exit__(*excinfo) -> None. Closes the file.");
1752
Tim Petersefc3a3a2001-09-20 07:55:22 +00001753static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001754 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1755 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1756 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1757 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1758 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001759#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001760 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001761#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001762 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1763 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1764 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001765 {"xreadlines",(PyCFunction)file_self, METH_NOARGS, xreadlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001766 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1767 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1768 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1769 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001770 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Georg Brandl98b40ad2006-06-08 14:50:21 +00001771 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001772 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001773};
1774
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001775#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001776
Guido van Rossum6f799372001-09-20 20:46:19 +00001777static PyMemberDef file_memberlist[] = {
1778 {"softspace", T_INT, OFF(f_softspace), 0,
1779 "flag indicating that a space needs to be printed; used by print"},
1780 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001781 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001782 {"name", T_OBJECT, OFF(f_name), RO,
1783 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001784 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1785 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001786 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001787 {NULL} /* Sentinel */
1788};
1789
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001790static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001791get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001792{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001793 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001794}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001795static PyObject *
1796get_newlines(PyFileObject *f, void *closure)
1797{
1798 switch (f->f_newlinetypes) {
1799 case NEWLINE_UNKNOWN:
1800 Py_INCREF(Py_None);
1801 return Py_None;
1802 case NEWLINE_CR:
1803 return PyString_FromString("\r");
1804 case NEWLINE_LF:
1805 return PyString_FromString("\n");
1806 case NEWLINE_CR|NEWLINE_LF:
1807 return Py_BuildValue("(ss)", "\r", "\n");
1808 case NEWLINE_CRLF:
1809 return PyString_FromString("\r\n");
1810 case NEWLINE_CR|NEWLINE_CRLF:
1811 return Py_BuildValue("(ss)", "\r", "\r\n");
1812 case NEWLINE_LF|NEWLINE_CRLF:
1813 return Py_BuildValue("(ss)", "\n", "\r\n");
1814 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1815 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1816 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001817 PyErr_Format(PyExc_SystemError,
1818 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001819 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001820 return NULL;
1821 }
1822}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001823
Guido van Rossum32d34c82001-09-20 21:45:26 +00001824static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001825 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001826 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001827 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001828 {0},
1829};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001830
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001831static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001832drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001833{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001834 if (f->f_buf != NULL) {
1835 PyMem_Free(f->f_buf);
1836 f->f_buf = NULL;
1837 }
Guido van Rossum65967252001-04-21 13:20:18 +00001838}
1839
Tim Petersf1827cf2003-09-07 03:30:18 +00001840/* Make sure that file has a readahead buffer with at least one byte
1841 (unless at EOF) and no more than bufsize. Returns negative value on
Georg Brandled02eb62006-03-31 20:31:02 +00001842 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001843static int
1844readahead(PyFileObject *f, int bufsize)
1845{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001846 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001847
1848 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001849 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001850 return 0;
1851 else
1852 drop_readahead(f);
1853 }
Anthony Baxter377be112006-04-11 06:54:30 +00001854 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
Georg Brandled02eb62006-03-31 20:31:02 +00001855 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001856 return -1;
1857 }
1858 Py_BEGIN_ALLOW_THREADS
1859 errno = 0;
1860 chunksize = Py_UniversalNewlineFread(
1861 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1862 Py_END_ALLOW_THREADS
1863 if (chunksize == 0) {
1864 if (ferror(f->f_fp)) {
1865 PyErr_SetFromErrno(PyExc_IOError);
1866 clearerr(f->f_fp);
1867 drop_readahead(f);
1868 return -1;
1869 }
1870 }
1871 f->f_bufptr = f->f_buf;
1872 f->f_bufend = f->f_buf + chunksize;
1873 return 0;
1874}
1875
1876/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001877 uninitialized bytes followed by the remainder of the line. Don't be
1878 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001879 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1880
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001881static PyStringObject *
1882readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1883{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001884 PyStringObject* s;
1885 char *bufptr;
1886 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001887 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001888
1889 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001890 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001891 return NULL;
1892
1893 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001894 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001895 return (PyStringObject *)
1896 PyString_FromStringAndSize(NULL, skip);
Anthony Baxter377be112006-04-11 06:54:30 +00001897 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001898 if (bufptr != NULL) {
1899 bufptr++; /* Count the '\n' */
1900 len = bufptr - f->f_bufptr;
1901 s = (PyStringObject *)
1902 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001903 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001904 return NULL;
1905 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1906 f->f_bufptr = bufptr;
1907 if (bufptr == f->f_bufend)
1908 drop_readahead(f);
1909 } else {
1910 bufptr = f->f_bufptr;
1911 buf = f->f_buf;
1912 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001913 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001914 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001915 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001916 if (s == NULL) {
1917 PyMem_Free(buf);
1918 return NULL;
1919 }
1920 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1921 PyMem_Free(buf);
1922 }
1923 return s;
1924}
1925
1926/* A larger buffer size may actually decrease performance. */
1927#define READAHEAD_BUFSIZE 8192
1928
1929static PyObject *
1930file_iternext(PyFileObject *f)
1931{
1932 PyStringObject* l;
1933
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001934 if (f->f_fp == NULL)
1935 return err_closed();
1936
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001937 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1938 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1939 Py_XDECREF(l);
1940 return NULL;
1941 }
1942 return (PyObject *)l;
1943}
1944
1945
Tim Peters59c9a642001-09-13 05:38:56 +00001946static PyObject *
1947file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1948{
Tim Peters44410012001-09-14 03:26:08 +00001949 PyObject *self;
1950 static PyObject *not_yet_string;
1951
1952 assert(type != NULL && type->tp_alloc != NULL);
1953
1954 if (not_yet_string == NULL) {
1955 not_yet_string = PyString_FromString("<uninitialized file>");
1956 if (not_yet_string == NULL)
1957 return NULL;
1958 }
1959
1960 self = type->tp_alloc(type, 0);
1961 if (self != NULL) {
1962 /* Always fill in the name and mode, so that nobody else
1963 needs to special-case NULLs there. */
1964 Py_INCREF(not_yet_string);
1965 ((PyFileObject *)self)->f_name = not_yet_string;
1966 Py_INCREF(not_yet_string);
1967 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001968 Py_INCREF(Py_None);
1969 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001970 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001971 }
1972 return self;
1973}
1974
1975static int
1976file_init(PyObject *self, PyObject *args, PyObject *kwds)
1977{
1978 PyFileObject *foself = (PyFileObject *)self;
1979 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001980 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001981 char *name = NULL;
1982 char *mode = "r";
1983 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001984 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001985
1986 assert(PyFile_Check(self));
1987 if (foself->f_fp != NULL) {
1988 /* Have to close the existing file first. */
1989 PyObject *closeresult = file_close(foself);
1990 if (closeresult == NULL)
1991 return -1;
1992 Py_DECREF(closeresult);
1993 }
Tim Peters59c9a642001-09-13 05:38:56 +00001994
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001995#ifdef Py_WIN_WIDE_FILENAMES
1996 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
1997 PyObject *po;
1998 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
1999 kwlist, &po, &mode, &bufsize)) {
2000 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002001 if (fill_file_fields(foself, NULL, po, mode,
2002 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002003 goto Error;
2004 } else {
2005 /* Drop the argument parsing error as narrow
2006 strings are also valid. */
2007 PyErr_Clear();
2008 }
2009 }
2010#endif
2011
2012 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002013 PyObject *o_name;
2014
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002015 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2016 Py_FileSystemDefaultEncoding,
2017 &name,
2018 &mode, &bufsize))
2019 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002020
2021 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002022 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2023 kwlist, &o_name, &mode,
2024 &bufsize))
Neal Norwitzfe50f8e2006-09-05 04:32:06 +00002025 goto Error;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002026
2027 if (fill_file_fields(foself, NULL, o_name, mode,
2028 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002029 goto Error;
2030 }
Tim Peters44410012001-09-14 03:26:08 +00002031 if (open_the_file(foself, name, mode) == NULL)
2032 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002033 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002034 PyFile_SetBufSize(self, bufsize);
2035 goto Done;
2036
2037Error:
2038 ret = -1;
2039 /* fall through */
2040Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002041 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002042 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002043}
2044
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002045PyDoc_VAR(file_doc) =
2046PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002047"file(name[, mode[, buffering]]) -> file object\n"
2048"\n"
2049"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2050"writing or appending. The file will be created if it doesn't exist\n"
2051"when opened for writing or appending; it will be truncated when\n"
2052"opened for writing. Add a 'b' to the mode for binary files.\n"
2053"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2054"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002055"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002056)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002057PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002058"Add a 'U' to mode to open the file for input with universal newline\n"
2059"support. Any line ending in the input file will be seen as a '\\n'\n"
2060"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2061"the value for this attribute is one of None (no newline read yet),\n"
2062"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2063"\n"
2064"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002065);
Tim Peters59c9a642001-09-13 05:38:56 +00002066
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002067PyTypeObject PyFile_Type = {
2068 PyObject_HEAD_INIT(&PyType_Type)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002069 0,
2070 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002071 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002072 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002073 (destructor)file_dealloc, /* tp_dealloc */
2074 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002075 0, /* tp_getattr */
2076 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002077 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002078 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002079 0, /* tp_as_number */
2080 0, /* tp_as_sequence */
2081 0, /* tp_as_mapping */
2082 0, /* tp_hash */
2083 0, /* tp_call */
2084 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002085 PyObject_GenericGetAttr, /* tp_getattro */
Tim Peters015dd822003-05-04 04:16:52 +00002086 /* softspace is writable: we must supply tp_setattro */
2087 PyObject_GenericSetAttr, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002088 0, /* tp_as_buffer */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002089 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002090 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002091 0, /* tp_traverse */
2092 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002093 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002094 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002095 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002096 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002097 file_methods, /* tp_methods */
2098 file_memberlist, /* tp_members */
2099 file_getsetlist, /* tp_getset */
2100 0, /* tp_base */
2101 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002102 0, /* tp_descr_get */
2103 0, /* tp_descr_set */
2104 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002105 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002106 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002107 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002108 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002109};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002110
2111/* Interface for the 'soft space' between print items. */
2112
2113int
Fred Drakefd99de62000-07-09 05:02:18 +00002114PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00002115{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002116 long oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002117 if (f == NULL) {
2118 /* Do nothing */
2119 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002120 else if (PyFile_Check(f)) {
2121 oldflag = ((PyFileObject *)f)->f_softspace;
2122 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002123 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00002124 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002125 PyObject *v;
2126 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002127 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002128 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002129 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002130 if (PyInt_Check(v))
2131 oldflag = PyInt_AsLong(v);
Martin v. Löwis18e16552006-02-15 17:27:45 +00002132 assert(oldflag < INT_MAX);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002133 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002134 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002135 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002136 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002137 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002138 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002139 if (PyObject_SetAttrString(f, "softspace", v) != 0)
2140 PyErr_Clear();
2141 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002142 }
2143 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002144 return (int)oldflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002145}
Guido van Rossum3165fe61992-09-25 21:59:05 +00002146
2147/* Interfaces to write objects/strings to file-like objects */
2148
2149int
Fred Drakefd99de62000-07-09 05:02:18 +00002150PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002151{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002152 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002153 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002154 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002155 return -1;
2156 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002157 else if (PyFile_Check(f)) {
2158 FILE *fp = PyFile_AsFile(f);
Fred Drake086a0f72004-03-19 15:22:36 +00002159#ifdef Py_USING_UNICODE
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002160 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2161 int result;
Fred Drake086a0f72004-03-19 15:22:36 +00002162#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002163 if (fp == NULL) {
2164 err_closed();
2165 return -1;
2166 }
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002167#ifdef Py_USING_UNICODE
Tim Petersf1827cf2003-09-07 03:30:18 +00002168 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002169 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002170 char *cenc = PyString_AS_STRING(enc);
2171 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2172 if (value == NULL)
2173 return -1;
2174 } else {
2175 value = v;
2176 Py_INCREF(value);
2177 }
2178 result = PyObject_Print(value, fp, flags);
2179 Py_DECREF(value);
2180 return result;
2181#else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002182 return PyObject_Print(v, fp, flags);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002183#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002184 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002185 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002186 if (writer == NULL)
2187 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002188 if (flags & Py_PRINT_RAW) {
2189 if (PyUnicode_Check(v)) {
2190 value = v;
2191 Py_INCREF(value);
2192 } else
2193 value = PyObject_Str(v);
2194 }
2195 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002196 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002197 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002198 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002199 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002200 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002201 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002202 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002203 Py_DECREF(value);
2204 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002205 return -1;
2206 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002207 result = PyEval_CallObject(writer, args);
2208 Py_DECREF(args);
2209 Py_DECREF(value);
2210 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002211 if (result == NULL)
2212 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002213 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002214 return 0;
2215}
2216
Guido van Rossum27a60b11997-05-22 22:25:11 +00002217int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002218PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002219{
2220 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002221 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002222 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002223 PyErr_SetString(PyExc_SystemError,
2224 "null file for PyFile_WriteString");
2225 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002226 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002227 else if (PyFile_Check(f)) {
2228 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002229 if (fp == NULL) {
2230 err_closed();
2231 return -1;
2232 }
2233 fputs(s, fp);
2234 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002235 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002236 else if (!PyErr_Occurred()) {
2237 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002238 int err;
2239 if (v == NULL)
2240 return -1;
2241 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2242 Py_DECREF(v);
2243 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002244 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002245 else
2246 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002247}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002248
2249/* Try to get a file-descriptor from a Python object. If the object
2250 is an integer or long integer, its value is returned. If not, the
2251 object's fileno() method is called if it exists; the method must return
2252 an integer or long integer, which is returned as the file descriptor value.
2253 -1 is returned on failure.
2254*/
2255
2256int PyObject_AsFileDescriptor(PyObject *o)
2257{
2258 int fd;
2259 PyObject *meth;
2260
2261 if (PyInt_Check(o)) {
2262 fd = PyInt_AsLong(o);
2263 }
2264 else if (PyLong_Check(o)) {
2265 fd = PyLong_AsLong(o);
2266 }
2267 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2268 {
2269 PyObject *fno = PyEval_CallObject(meth, NULL);
2270 Py_DECREF(meth);
2271 if (fno == NULL)
2272 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002273
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002274 if (PyInt_Check(fno)) {
2275 fd = PyInt_AsLong(fno);
2276 Py_DECREF(fno);
2277 }
2278 else if (PyLong_Check(fno)) {
2279 fd = PyLong_AsLong(fno);
2280 Py_DECREF(fno);
2281 }
2282 else {
2283 PyErr_SetString(PyExc_TypeError,
2284 "fileno() returned a non-integer");
2285 Py_DECREF(fno);
2286 return -1;
2287 }
2288 }
2289 else {
2290 PyErr_SetString(PyExc_TypeError,
2291 "argument must be an int, or have a fileno() method.");
2292 return -1;
2293 }
2294
2295 if (fd < 0) {
2296 PyErr_Format(PyExc_ValueError,
2297 "file descriptor cannot be a negative integer (%i)",
2298 fd);
2299 return -1;
2300 }
2301 return fd;
2302}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002303
Jack Jansen7b8c7542002-04-14 20:12:41 +00002304/* From here on we need access to the real fgets and fread */
2305#undef fgets
2306#undef fread
2307
2308/*
2309** Py_UniversalNewlineFgets is an fgets variation that understands
2310** all of \r, \n and \r\n conventions.
2311** The stream should be opened in binary mode.
2312** If fobj is NULL the routine always does newline conversion, and
2313** it may peek one char ahead to gobble the second char in \r\n.
2314** If fobj is non-NULL it must be a PyFileObject. In this case there
2315** is no readahead but in stead a flag is used to skip a following
2316** \n on the next read. Also, if the file is open in binary mode
2317** the whole conversion is skipped. Finally, the routine keeps track of
2318** the different types of newlines seen.
2319** Note that we need no error handling: fgets() treats error and eof
2320** identically.
2321*/
2322char *
2323Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2324{
2325 char *p = buf;
2326 int c;
2327 int newlinetypes = 0;
2328 int skipnextlf = 0;
2329 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002330
Jack Jansen7b8c7542002-04-14 20:12:41 +00002331 if (fobj) {
2332 if (!PyFile_Check(fobj)) {
2333 errno = ENXIO; /* What can you do... */
2334 return NULL;
2335 }
2336 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2337 if ( !univ_newline )
2338 return fgets(buf, n, stream);
2339 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2340 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2341 }
2342 FLOCKFILE(stream);
2343 c = 'x'; /* Shut up gcc warning */
2344 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2345 if (skipnextlf ) {
2346 skipnextlf = 0;
2347 if (c == '\n') {
2348 /* Seeing a \n here with skipnextlf true
2349 ** means we saw a \r before.
2350 */
2351 newlinetypes |= NEWLINE_CRLF;
2352 c = GETC(stream);
2353 if (c == EOF) break;
2354 } else {
2355 /*
2356 ** Note that c == EOF also brings us here,
2357 ** so we're okay if the last char in the file
2358 ** is a CR.
2359 */
2360 newlinetypes |= NEWLINE_CR;
2361 }
2362 }
2363 if (c == '\r') {
2364 /* A \r is translated into a \n, and we skip
2365 ** an adjacent \n, if any. We don't set the
2366 ** newlinetypes flag until we've seen the next char.
2367 */
2368 skipnextlf = 1;
2369 c = '\n';
2370 } else if ( c == '\n') {
2371 newlinetypes |= NEWLINE_LF;
2372 }
2373 *p++ = c;
2374 if (c == '\n') break;
2375 }
2376 if ( c == EOF && skipnextlf )
2377 newlinetypes |= NEWLINE_CR;
2378 FUNLOCKFILE(stream);
2379 *p = '\0';
2380 if (fobj) {
2381 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2382 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2383 } else if ( skipnextlf ) {
2384 /* If we have no file object we cannot save the
2385 ** skipnextlf flag. We have to readahead, which
2386 ** will cause a pause if we're reading from an
2387 ** interactive stream, but that is very unlikely
2388 ** unless we're doing something silly like
2389 ** execfile("/dev/tty").
2390 */
2391 c = GETC(stream);
2392 if ( c != '\n' )
2393 ungetc(c, stream);
2394 }
2395 if (p == buf)
2396 return NULL;
2397 return buf;
2398}
2399
2400/*
2401** Py_UniversalNewlineFread is an fread variation that understands
2402** all of \r, \n and \r\n conventions.
2403** The stream should be opened in binary mode.
2404** fobj must be a PyFileObject. In this case there
2405** is no readahead but in stead a flag is used to skip a following
2406** \n on the next read. Also, if the file is open in binary mode
2407** the whole conversion is skipped. Finally, the routine keeps track of
2408** the different types of newlines seen.
2409*/
2410size_t
Tim Peters058b1412002-04-21 07:29:14 +00002411Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002412 FILE *stream, PyObject *fobj)
2413{
Tim Peters058b1412002-04-21 07:29:14 +00002414 char *dst = buf;
2415 PyFileObject *f = (PyFileObject *)fobj;
2416 int newlinetypes, skipnextlf;
2417
2418 assert(buf != NULL);
2419 assert(stream != NULL);
2420
Jack Jansen7b8c7542002-04-14 20:12:41 +00002421 if (!fobj || !PyFile_Check(fobj)) {
2422 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002423 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002424 }
Tim Peters058b1412002-04-21 07:29:14 +00002425 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002426 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002427 newlinetypes = f->f_newlinetypes;
2428 skipnextlf = f->f_skipnextlf;
2429 /* Invariant: n is the number of bytes remaining to be filled
2430 * in the buffer.
2431 */
2432 while (n) {
2433 size_t nread;
2434 int shortread;
2435 char *src = dst;
2436
2437 nread = fread(dst, 1, n, stream);
2438 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002439 if (nread == 0)
2440 break;
2441
Tim Peterse1682a82002-04-21 18:15:20 +00002442 n -= nread; /* assuming 1 byte out for each in; will adjust */
2443 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002444 while (nread--) {
2445 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002446 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002447 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002448 *dst++ = '\n';
2449 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002450 }
2451 else if (skipnextlf && c == '\n') {
2452 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002453 skipnextlf = 0;
2454 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002455 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002456 }
2457 else {
2458 /* Normal char to be stored in buffer. Also
2459 * update the newlinetypes flag if either this
2460 * is an LF or the previous char was a CR.
2461 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002462 if (c == '\n')
2463 newlinetypes |= NEWLINE_LF;
2464 else if (skipnextlf)
2465 newlinetypes |= NEWLINE_CR;
2466 *dst++ = c;
2467 skipnextlf = 0;
2468 }
2469 }
Tim Peters058b1412002-04-21 07:29:14 +00002470 if (shortread) {
2471 /* If this is EOF, update type flags. */
2472 if (skipnextlf && feof(stream))
2473 newlinetypes |= NEWLINE_CR;
2474 break;
2475 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002476 }
Tim Peters058b1412002-04-21 07:29:14 +00002477 f->f_newlinetypes = newlinetypes;
2478 f->f_skipnextlf = skipnextlf;
2479 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002480}
Anthony Baxterac6bd462006-04-13 02:06:09 +00002481
2482#ifdef __cplusplus
2483}
2484#endif