blob: 4c5b37d2f6a8eb06e68be964d74583b7475de030 [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
Kristján Valur Jónsson0a440d42007-04-26 09:15:08 +0000142 won't know what it is. Non-zero return signals an exception */
143int
144_PyFile_SanitizeMode(char *mode)
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000145{
Georg Brandl7b90e162006-05-18 07:01:27 +0000146 char *upos;
Neal Norwitz76dc0812006-01-08 06:13:13 +0000147 size_t len = strlen(mode);
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000148
Georg Brandl7b90e162006-05-18 07:01:27 +0000149 if (!len) {
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000150 PyErr_SetString(PyExc_ValueError, "empty mode string");
Kristján Valur Jónsson0a440d42007-04-26 09:15:08 +0000151 return -1;
Georg Brandl7b90e162006-05-18 07:01:27 +0000152 }
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000153
Georg Brandl7b90e162006-05-18 07:01:27 +0000154 upos = strchr(mode, 'U');
155 if (upos) {
156 memmove(upos, upos+1, len-(upos-mode)); /* incl null char */
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000157
Georg Brandl7b90e162006-05-18 07:01:27 +0000158 if (mode[0] == 'w' || mode[0] == 'a') {
159 PyErr_Format(PyExc_ValueError, "universal newline "
160 "mode can only be used with modes "
161 "starting with 'r'");
Kristján Valur Jónsson0a440d42007-04-26 09:15:08 +0000162 return -1;
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000163 }
Georg Brandl7b90e162006-05-18 07:01:27 +0000164
165 if (mode[0] != 'r') {
166 memmove(mode+1, mode, strlen(mode)+1);
167 mode[0] = 'r';
168 }
169
170 if (!strchr(mode, 'b')) {
171 memmove(mode+2, mode+1, strlen(mode));
172 mode[1] = 'b';
173 }
174 } else if (mode[0] != 'r' && mode[0] != 'w' && mode[0] != 'a') {
175 PyErr_Format(PyExc_ValueError, "mode string must begin with "
176 "one of 'r', 'w', 'a' or 'U', not '%.200s'", mode);
Kristján Valur Jónsson0a440d42007-04-26 09:15:08 +0000177 return -1;
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000178 }
179
180 return 0;
181}
182
Tim Peters59c9a642001-09-13 05:38:56 +0000183static PyObject *
184open_the_file(PyFileObject *f, char *name, char *mode)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000185{
Georg Brandl7b90e162006-05-18 07:01:27 +0000186 char *newmode;
Tim Peters59c9a642001-09-13 05:38:56 +0000187 assert(f != NULL);
188 assert(PyFile_Check(f));
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000189#ifdef MS_WINDOWS
190 /* windows ignores the passed name in order to support Unicode */
191 assert(f->f_name != NULL);
192#else
Tim Peters59c9a642001-09-13 05:38:56 +0000193 assert(name != NULL);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000194#endif
Tim Peters59c9a642001-09-13 05:38:56 +0000195 assert(mode != NULL);
Tim Peters44410012001-09-14 03:26:08 +0000196 assert(f->f_fp == NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000197
Georg Brandl7b90e162006-05-18 07:01:27 +0000198 /* probably need to replace 'U' by 'rb' */
199 newmode = PyMem_MALLOC(strlen(mode) + 3);
200 if (!newmode) {
201 PyErr_NoMemory();
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000202 return NULL;
Georg Brandl7b90e162006-05-18 07:01:27 +0000203 }
204 strcpy(newmode, mode);
205
Kristján Valur Jónsson0a440d42007-04-26 09:15:08 +0000206 if (_PyFile_SanitizeMode(newmode)) {
Georg Brandl7b90e162006-05-18 07:01:27 +0000207 f = NULL;
208 goto cleanup;
209 }
Skip Montanarobbf12ba2005-05-20 03:07:06 +0000210
Tim Peters8fa45672001-09-13 21:01:29 +0000211 /* rexec.py can't stop a user from getting the file() constructor --
212 all they have to do is get *any* file object f, and then do
213 type(f). Here we prevent them from doing damage with it. */
214 if (PyEval_GetRestricted()) {
215 PyErr_SetString(PyExc_IOError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000216 "file() constructor not accessible in restricted mode");
Georg Brandl7b90e162006-05-18 07:01:27 +0000217 f = NULL;
218 goto cleanup;
Tim Peters8fa45672001-09-13 21:01:29 +0000219 }
Tim Petersa27a1502001-11-09 20:59:14 +0000220 errno = 0;
Skip Montanaro51ffac62004-06-11 04:49:03 +0000221
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000222#ifdef MS_WINDOWS
Skip Montanaro51ffac62004-06-11 04:49:03 +0000223 if (PyUnicode_Check(f->f_name)) {
224 PyObject *wmode;
Georg Brandl7b90e162006-05-18 07:01:27 +0000225 wmode = PyUnicode_DecodeASCII(newmode, strlen(newmode), NULL);
Skip Montanaro51ffac62004-06-11 04:49:03 +0000226 if (f->f_name && wmode) {
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000227 Py_BEGIN_ALLOW_THREADS
Skip Montanaro51ffac62004-06-11 04:49:03 +0000228 /* PyUnicode_AS_UNICODE OK without thread
229 lock as it is a simple dereference. */
230 f->f_fp = _wfopen(PyUnicode_AS_UNICODE(f->f_name),
231 PyUnicode_AS_UNICODE(wmode));
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000232 Py_END_ALLOW_THREADS
233 }
Skip Montanaro51ffac62004-06-11 04:49:03 +0000234 Py_XDECREF(wmode);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000235 }
Skip Montanaro51ffac62004-06-11 04:49:03 +0000236#endif
237 if (NULL == f->f_fp && NULL != name) {
238 Py_BEGIN_ALLOW_THREADS
Georg Brandl7b90e162006-05-18 07:01:27 +0000239 f->f_fp = fopen(name, newmode);
Skip Montanaro51ffac62004-06-11 04:49:03 +0000240 Py_END_ALLOW_THREADS
241 }
242
Guido van Rossuma08095a1991-02-13 23:25:27 +0000243 if (f->f_fp == NULL) {
Kristján Valur Jónsson74c3ea02006-07-03 14:59:05 +0000244#if defined _MSC_VER && (_MSC_VER < 1400 || !defined(__STDC_SECURE_LIB__))
Tim Peters2ea91112002-04-08 04:13:12 +0000245 /* MSVC 6 (Microsoft) leaves errno at 0 for bad mode strings,
246 * across all Windows flavors. When it sets EINVAL varies
247 * across Windows flavors, the exact conditions aren't
248 * documented, and the answer lies in the OS's implementation
249 * of Win32's CreateFile function (whose source is secret).
250 * Seems the best we can do is map EINVAL to ENOENT.
Kristján Valur Jónssonf6083172006-06-12 15:45:12 +0000251 * Starting with Visual Studio .NET 2005, EINVAL is correctly
252 * set by our CRT error handler (set in exceptions.c.)
Tim Peters2ea91112002-04-08 04:13:12 +0000253 */
254 if (errno == 0) /* bad mode string */
255 errno = EINVAL;
256 else if (errno == EINVAL) /* unknown, but not a mode string */
257 errno = ENOENT;
258#endif
Jeremy Hylton41c83212001-11-09 16:17:24 +0000259 if (errno == EINVAL)
Tim Peters2ea91112002-04-08 04:13:12 +0000260 PyErr_Format(PyExc_IOError, "invalid mode: %s",
Jeremy Hylton41c83212001-11-09 16:17:24 +0000261 mode);
262 else
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000263 PyErr_SetFromErrnoWithFilenameObject(PyExc_IOError, f->f_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000264 f = NULL;
265 }
Tim Peters2ea91112002-04-08 04:13:12 +0000266 if (f != NULL)
Neil Schemenauered19b882002-03-23 02:06:50 +0000267 f = dircheck(f);
Georg Brandl7b90e162006-05-18 07:01:27 +0000268
269cleanup:
270 PyMem_FREE(newmode);
271
Tim Peters59c9a642001-09-13 05:38:56 +0000272 return (PyObject *)f;
273}
274
275PyObject *
276PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *))
277{
Tim Peters44410012001-09-14 03:26:08 +0000278 PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type,
279 NULL, NULL);
Tim Peters59c9a642001-09-13 05:38:56 +0000280 if (f != NULL) {
Neal Norwitzb337bb52006-07-17 00:55:45 +0000281 PyObject *o_name = PyString_FromString(name);
282 if (o_name == NULL)
283 return NULL;
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000284 if (fill_file_fields(f, fp, o_name, mode, close) == NULL) {
Tim Peters59c9a642001-09-13 05:38:56 +0000285 Py_DECREF(f);
286 f = NULL;
287 }
Nicholas Bastinabce8a62004-03-21 20:24:07 +0000288 Py_DECREF(o_name);
Tim Peters59c9a642001-09-13 05:38:56 +0000289 }
290 return (PyObject *) f;
291}
292
293PyObject *
294PyFile_FromString(char *name, char *mode)
295{
296 extern int fclose(FILE *);
297 PyFileObject *f;
298
299 f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose);
300 if (f != NULL) {
301 if (open_the_file(f, name, mode) == NULL) {
302 Py_DECREF(f);
303 f = NULL;
304 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000305 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000306 return (PyObject *)f;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000307}
308
Guido van Rossumb6775db1994-08-01 11:34:53 +0000309void
Fred Drakefd99de62000-07-09 05:02:18 +0000310PyFile_SetBufSize(PyObject *f, int bufsize)
Guido van Rossumb6775db1994-08-01 11:34:53 +0000311{
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000312 PyFileObject *file = (PyFileObject *)f;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000313 if (bufsize >= 0) {
Guido van Rossumb6775db1994-08-01 11:34:53 +0000314 int type;
315 switch (bufsize) {
316 case 0:
317 type = _IONBF;
318 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000319#ifdef HAVE_SETVBUF
Guido van Rossumb6775db1994-08-01 11:34:53 +0000320 case 1:
321 type = _IOLBF;
322 bufsize = BUFSIZ;
323 break;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000324#endif
Guido van Rossumb6775db1994-08-01 11:34:53 +0000325 default:
326 type = _IOFBF;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000327#ifndef HAVE_SETVBUF
328 bufsize = BUFSIZ;
329#endif
330 break;
Guido van Rossumb6775db1994-08-01 11:34:53 +0000331 }
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000332 fflush(file->f_fp);
333 if (type == _IONBF) {
334 PyMem_Free(file->f_setbuf);
335 file->f_setbuf = NULL;
336 } else {
Anthony Baxter377be112006-04-11 06:54:30 +0000337 file->f_setbuf = (char *)PyMem_Realloc(file->f_setbuf,
338 bufsize);
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000339 }
340#ifdef HAVE_SETVBUF
341 setvbuf(file->f_fp, file->f_setbuf, type, bufsize);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000342#else /* !HAVE_SETVBUF */
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +0000343 setbuf(file->f_fp, file->f_setbuf);
Guido van Rossumf8b4de01998-03-06 15:32:40 +0000344#endif /* !HAVE_SETVBUF */
Guido van Rossumb6775db1994-08-01 11:34:53 +0000345 }
346}
347
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000348/* Set the encoding used to output Unicode strings.
349 Returh 1 on success, 0 on failure. */
350
351int
352PyFile_SetEncoding(PyObject *f, const char *enc)
353{
354 PyFileObject *file = (PyFileObject*)f;
355 PyObject *str = PyString_FromString(enc);
Thomas Woutersafea5292007-01-23 13:42:00 +0000356
357 assert(PyFile_Check(f));
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000358 if (!str)
359 return 0;
360 Py_DECREF(file->f_encoding);
361 file->f_encoding = str;
362 return 1;
363}
364
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000365static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000366err_closed(void)
Guido van Rossumd7297e61992-07-06 14:19:26 +0000367{
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000368 PyErr_SetString(PyExc_ValueError, "I/O operation on closed file");
Guido van Rossumd7297e61992-07-06 14:19:26 +0000369 return NULL;
370}
371
Thomas Woutersc45251a2006-02-12 11:53:32 +0000372/* Refuse regular file I/O if there's data in the iteration-buffer.
373 * Mixing them would cause data to arrive out of order, as the read*
374 * methods don't use the iteration buffer. */
375static PyObject *
376err_iterbuffered(void)
377{
378 PyErr_SetString(PyExc_ValueError,
379 "Mixing iteration and read methods would lose data");
380 return NULL;
381}
382
Neal Norwitzd8b995f2002-08-06 21:50:54 +0000383static void drop_readahead(PyFileObject *);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000384
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000385/* Methods */
386
387static void
Fred Drakefd99de62000-07-09 05:02:18 +0000388file_dealloc(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000389{
Peter Astrandf8e74b12004-11-07 14:15:28 +0000390 int sts = 0;
Raymond Hettingercb87bc82004-05-31 00:35:52 +0000391 if (f->weakreflist != NULL)
392 PyObject_ClearWeakRefs((PyObject *) f);
Guido van Rossumff4949e1992-08-05 19:58:53 +0000393 if (f->f_fp != NULL && f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000394 Py_BEGIN_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000395 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000396 Py_END_ALLOW_THREADS
Peter Astrandf8e74b12004-11-07 14:15:28 +0000397 if (sts == EOF)
398#ifdef HAVE_STRERROR
399 PySys_WriteStderr("close failed: [Errno %d] %s\n", errno, strerror(errno));
400#else
401 PySys_WriteStderr("close failed: [Errno %d]\n", errno);
402#endif
Guido van Rossumff4949e1992-08-05 19:58:53 +0000403 }
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000404 PyMem_Free(f->f_setbuf);
Tim Peters44410012001-09-14 03:26:08 +0000405 Py_XDECREF(f->f_name);
406 Py_XDECREF(f->f_mode);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +0000407 Py_XDECREF(f->f_encoding);
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000408 drop_readahead(f);
Martin v. Löwis68192102007-07-21 06:55:02 +0000409 Py_Type(f)->tp_free((PyObject *)f);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000410}
411
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000412static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000413file_repr(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000414{
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000415 if (PyUnicode_Check(f->f_name)) {
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000416#ifdef Py_USING_UNICODE
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000417 PyObject *ret = NULL;
Neal Norwitzfc28e0d2006-07-16 02:32:03 +0000418 PyObject *name = PyUnicode_AsUnicodeEscapeString(f->f_name);
419 const char *name_str = name ? PyString_AsString(name) : "?";
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000420 ret = PyString_FromFormat("<%s file u'%s', mode '%s' at %p>",
421 f->f_fp == NULL ? "closed" : "open",
Neal Norwitzfc28e0d2006-07-16 02:32:03 +0000422 name_str,
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000423 PyString_AsString(f->f_mode),
424 f);
425 Py_XDECREF(name);
426 return ret;
Martin v. Löwis0073f2e2002-11-21 23:52:35 +0000427#endif
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000428 } else {
429 return PyString_FromFormat("<%s file '%s', mode '%s' at %p>",
Barry Warsaw7ce36942001-08-24 18:34:26 +0000430 f->f_fp == NULL ? "closed" : "open",
431 PyString_AsString(f->f_name),
432 PyString_AsString(f->f_mode),
433 f);
Mark Hammondc2e85bd2002-10-03 05:10:39 +0000434 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000435}
436
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000437static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000438file_close(PyFileObject *f)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000439{
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000440 int sts = 0;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000441 if (f->f_fp != NULL) {
Guido van Rossumff4949e1992-08-05 19:58:53 +0000442 if (f->f_close != NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000443 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000444 errno = 0;
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000445 sts = (*f->f_close)(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000446 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000447 }
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000448 f->f_fp = NULL;
449 }
Martin v. Löwis7bbcde72003-09-07 20:42:29 +0000450 PyMem_Free(f->f_setbuf);
Andrew MacIntyre4e10ed32004-04-04 07:01:35 +0000451 f->f_setbuf = NULL;
Guido van Rossumfebd5511992-03-04 16:39:24 +0000452 if (sts == EOF)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000453 return PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000454 if (sts != 0)
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000455 return PyInt_FromLong((long)sts);
456 Py_INCREF(Py_None);
457 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000458}
459
Trent Mickf29f47b2000-08-11 19:02:59 +0000460
Guido van Rossumb8552162001-09-05 14:58:11 +0000461/* Our very own off_t-like type, 64-bit if possible */
462#if !defined(HAVE_LARGEFILE_SUPPORT)
463typedef off_t Py_off_t;
464#elif SIZEOF_OFF_T >= 8
465typedef off_t Py_off_t;
466#elif SIZEOF_FPOS_T >= 8
Guido van Rossum4f53da02001-03-01 18:26:53 +0000467typedef fpos_t Py_off_t;
468#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000469#error "Large file support, but neither off_t nor fpos_t is large enough."
Guido van Rossum4f53da02001-03-01 18:26:53 +0000470#endif
471
472
Trent Mickf29f47b2000-08-11 19:02:59 +0000473/* a portable fseek() function
474 return 0 on success, non-zero on failure (with errno set) */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000475static int
Guido van Rossum4f53da02001-03-01 18:26:53 +0000476_portable_fseek(FILE *fp, Py_off_t offset, int whence)
Trent Mickf29f47b2000-08-11 19:02:59 +0000477{
Guido van Rossumb8552162001-09-05 14:58:11 +0000478#if !defined(HAVE_LARGEFILE_SUPPORT)
479 return fseek(fp, offset, whence);
480#elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000481 return fseeko(fp, offset, whence);
482#elif defined(HAVE_FSEEK64)
483 return fseek64(fp, offset, whence);
Fred Drakedb810ac2000-10-06 20:42:33 +0000484#elif defined(__BEOS__)
485 return _fseek(fp, offset, whence);
Guido van Rossumb8552162001-09-05 14:58:11 +0000486#elif SIZEOF_FPOS_T >= 8
Guido van Rossume54e0be2001-01-16 20:53:31 +0000487 /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos()
488 and fgetpos() to implement fseek()*/
Trent Mickf29f47b2000-08-11 19:02:59 +0000489 fpos_t pos;
490 switch (whence) {
Guido van Rossume54e0be2001-01-16 20:53:31 +0000491 case SEEK_END:
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000492#ifdef MS_WINDOWS
493 fflush(fp);
494 if (_lseeki64(fileno(fp), 0, 2) == -1)
495 return -1;
496#else
Guido van Rossume54e0be2001-01-16 20:53:31 +0000497 if (fseek(fp, 0, SEEK_END) != 0)
498 return -1;
Guido van Rossum8b4e43e2001-09-10 20:43:35 +0000499#endif
Guido van Rossume54e0be2001-01-16 20:53:31 +0000500 /* fall through */
501 case SEEK_CUR:
502 if (fgetpos(fp, &pos) != 0)
503 return -1;
504 offset += pos;
505 break;
506 /* case SEEK_SET: break; */
Trent Mickf29f47b2000-08-11 19:02:59 +0000507 }
508 return fsetpos(fp, &offset);
509#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000510#error "Large file support, but no way to fseek."
Trent Mickf29f47b2000-08-11 19:02:59 +0000511#endif
512}
513
514
515/* a portable ftell() function
516 Return -1 on failure with errno set appropriately, current file
517 position on success */
Guido van Rossumf68d8e52001-04-14 17:55:09 +0000518static Py_off_t
Fred Drake8ce159a2000-08-31 05:18:54 +0000519_portable_ftell(FILE* fp)
Trent Mickf29f47b2000-08-11 19:02:59 +0000520{
Guido van Rossumb8552162001-09-05 14:58:11 +0000521#if !defined(HAVE_LARGEFILE_SUPPORT)
522 return ftell(fp);
523#elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8
524 return ftello(fp);
525#elif defined(HAVE_FTELL64)
526 return ftell64(fp);
527#elif SIZEOF_FPOS_T >= 8
Trent Mickf29f47b2000-08-11 19:02:59 +0000528 fpos_t pos;
529 if (fgetpos(fp, &pos) != 0)
530 return -1;
531 return pos;
532#else
Guido van Rossumb8552162001-09-05 14:58:11 +0000533#error "Large file support, but no way to ftell."
Trent Mickf29f47b2000-08-11 19:02:59 +0000534#endif
535}
536
537
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000538static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000539file_seek(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000540{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000541 int whence;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000542 int ret;
Guido van Rossum4f53da02001-03-01 18:26:53 +0000543 Py_off_t offset;
Martin v. Löwis056dac12006-11-12 18:24:26 +0000544 PyObject *offobj, *off_index;
Tim Peters86821b22001-01-07 21:19:34 +0000545
Guido van Rossumd7297e61992-07-06 14:19:26 +0000546 if (f->f_fp == NULL)
547 return err_closed();
Guido van Rossum7a6e9592002-08-06 15:55:28 +0000548 drop_readahead(f);
Guido van Rossumd7297e61992-07-06 14:19:26 +0000549 whence = 0;
Guido van Rossum43713e52000-02-29 13:59:29 +0000550 if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence))
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000551 return NULL;
Martin v. Löwis056dac12006-11-12 18:24:26 +0000552 off_index = PyNumber_Index(offobj);
553 if (!off_index) {
554 if (!PyFloat_Check(offobj))
555 return NULL;
556 /* Deprecated in 2.6 */
557 PyErr_Clear();
558 if (PyErr_Warn(PyExc_DeprecationWarning,
559 "integer argument expected, got float"))
560 return NULL;
561 off_index = offobj;
562 Py_INCREF(offobj);
563 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000564#if !defined(HAVE_LARGEFILE_SUPPORT)
Martin v. Löwis056dac12006-11-12 18:24:26 +0000565 offset = PyInt_AsLong(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000566#else
Martin v. Löwis056dac12006-11-12 18:24:26 +0000567 offset = PyLong_Check(off_index) ?
568 PyLong_AsLongLong(off_index) : PyInt_AsLong(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000569#endif
Martin v. Löwis056dac12006-11-12 18:24:26 +0000570 Py_DECREF(off_index);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000571 if (PyErr_Occurred())
Guido van Rossum88303191999-01-04 17:22:18 +0000572 return NULL;
Tim Peters86821b22001-01-07 21:19:34 +0000573
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000574 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000575 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000576 ret = _portable_fseek(f->f_fp, offset, whence);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000577 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000578
Guido van Rossumff4949e1992-08-05 19:58:53 +0000579 if (ret != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000580 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000581 clearerr(f->f_fp);
582 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000583 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000584 f->f_skipnextlf = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000585 Py_INCREF(Py_None);
586 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000587}
588
Trent Mickf29f47b2000-08-11 19:02:59 +0000589
Guido van Rossumd7047b31995-01-02 19:07:15 +0000590#ifdef HAVE_FTRUNCATE
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000591static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000592file_truncate(PyFileObject *f, PyObject *args)
Guido van Rossumd7047b31995-01-02 19:07:15 +0000593{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000594 Py_off_t newsize;
Tim Petersf1827cf2003-09-07 03:30:18 +0000595 PyObject *newsizeobj = NULL;
596 Py_off_t initialpos;
597 int ret;
Tim Peters86821b22001-01-07 21:19:34 +0000598
Guido van Rossumd7047b31995-01-02 19:07:15 +0000599 if (f->f_fp == NULL)
600 return err_closed();
Raymond Hettingerea3fdf42002-12-29 16:33:45 +0000601 if (!PyArg_UnpackTuple(args, "truncate", 0, 1, &newsizeobj))
Guido van Rossum88303191999-01-04 17:22:18 +0000602 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000603
Tim Petersf1827cf2003-09-07 03:30:18 +0000604 /* Get current file position. If the file happens to be open for
605 * update and the last operation was an input operation, C doesn't
606 * define what the later fflush() will do, but we promise truncate()
607 * won't change the current position (and fflush() *does* change it
608 * then at least on Windows). The easiest thing is to capture
609 * current pos now and seek back to it at the end.
610 */
611 Py_BEGIN_ALLOW_THREADS
612 errno = 0;
613 initialpos = _portable_ftell(f->f_fp);
614 Py_END_ALLOW_THREADS
615 if (initialpos == -1)
616 goto onioerror;
617
Tim Petersfb05db22002-03-11 00:24:00 +0000618 /* Set newsize to current postion if newsizeobj NULL, else to the
Tim Petersf1827cf2003-09-07 03:30:18 +0000619 * specified value.
620 */
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000621 if (newsizeobj != NULL) {
622#if !defined(HAVE_LARGEFILE_SUPPORT)
623 newsize = PyInt_AsLong(newsizeobj);
624#else
625 newsize = PyLong_Check(newsizeobj) ?
626 PyLong_AsLongLong(newsizeobj) :
627 PyInt_AsLong(newsizeobj);
628#endif
629 if (PyErr_Occurred())
630 return NULL;
Tim Petersfb05db22002-03-11 00:24:00 +0000631 }
Tim Petersf1827cf2003-09-07 03:30:18 +0000632 else /* default to current position */
633 newsize = initialpos;
Tim Petersfb05db22002-03-11 00:24:00 +0000634
Tim Petersf1827cf2003-09-07 03:30:18 +0000635 /* Flush the stream. We're mixing stream-level I/O with lower-level
636 * I/O, and a flush may be necessary to synch both platform views
637 * of the current file state.
638 */
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000639 Py_BEGIN_ALLOW_THREADS
Guido van Rossumd7047b31995-01-02 19:07:15 +0000640 errno = 0;
641 ret = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000642 Py_END_ALLOW_THREADS
Tim Petersfb05db22002-03-11 00:24:00 +0000643 if (ret != 0)
644 goto onioerror;
Trent Mickf29f47b2000-08-11 19:02:59 +0000645
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000646#ifdef MS_WINDOWS
Tim Petersfb05db22002-03-11 00:24:00 +0000647 /* MS _chsize doesn't work if newsize doesn't fit in 32 bits,
Tim Peters8f01b682002-03-12 03:04:44 +0000648 so don't even try using it. */
Tim Petersfb05db22002-03-11 00:24:00 +0000649 {
Tim Petersfb05db22002-03-11 00:24:00 +0000650 HANDLE hFile;
Tim Petersfb05db22002-03-11 00:24:00 +0000651
Tim Petersf1827cf2003-09-07 03:30:18 +0000652 /* Have to move current pos to desired endpoint on Windows. */
653 Py_BEGIN_ALLOW_THREADS
654 errno = 0;
655 ret = _portable_fseek(f->f_fp, newsize, SEEK_SET) != 0;
656 Py_END_ALLOW_THREADS
657 if (ret)
658 goto onioerror;
Tim Petersfb05db22002-03-11 00:24:00 +0000659
Tim Peters8f01b682002-03-12 03:04:44 +0000660 /* Truncate. Note that this may grow the file! */
661 Py_BEGIN_ALLOW_THREADS
662 errno = 0;
663 hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp));
Tim Petersf1827cf2003-09-07 03:30:18 +0000664 ret = hFile == (HANDLE)-1;
665 if (ret == 0) {
666 ret = SetEndOfFile(hFile) == 0;
667 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000668 errno = EACCES;
669 }
670 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000671 if (ret)
Tim Peters8f01b682002-03-12 03:04:44 +0000672 goto onioerror;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000673 }
Trent Mickf29f47b2000-08-11 19:02:59 +0000674#else
675 Py_BEGIN_ALLOW_THREADS
676 errno = 0;
677 ret = ftruncate(fileno(f->f_fp), newsize);
678 Py_END_ALLOW_THREADS
Tim Petersf1827cf2003-09-07 03:30:18 +0000679 if (ret != 0)
680 goto onioerror;
Martin v. Löwis6238d2b2002-06-30 15:26:10 +0000681#endif /* !MS_WINDOWS */
Tim Peters86821b22001-01-07 21:19:34 +0000682
Tim Petersf1827cf2003-09-07 03:30:18 +0000683 /* Restore original file position. */
684 Py_BEGIN_ALLOW_THREADS
685 errno = 0;
686 ret = _portable_fseek(f->f_fp, initialpos, SEEK_SET) != 0;
687 Py_END_ALLOW_THREADS
688 if (ret)
689 goto onioerror;
690
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000691 Py_INCREF(Py_None);
692 return Py_None;
Trent Mickf29f47b2000-08-11 19:02:59 +0000693
694onioerror:
695 PyErr_SetFromErrno(PyExc_IOError);
696 clearerr(f->f_fp);
697 return NULL;
Guido van Rossumd7047b31995-01-02 19:07:15 +0000698}
699#endif /* HAVE_FTRUNCATE */
700
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000701static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000702file_tell(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000703{
Guido van Rossum4f53da02001-03-01 18:26:53 +0000704 Py_off_t pos;
Trent Mickf29f47b2000-08-11 19:02:59 +0000705
Guido van Rossumd7297e61992-07-06 14:19:26 +0000706 if (f->f_fp == NULL)
707 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000708 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000709 errno = 0;
Trent Mickf29f47b2000-08-11 19:02:59 +0000710 pos = _portable_ftell(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000711 Py_END_ALLOW_THREADS
Trent Mickf29f47b2000-08-11 19:02:59 +0000712 if (pos == -1) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000713 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000714 clearerr(f->f_fp);
715 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000716 }
Jack Jansen7b8c7542002-04-14 20:12:41 +0000717 if (f->f_skipnextlf) {
718 int c;
719 c = GETC(f->f_fp);
720 if (c == '\n') {
721 pos++;
722 f->f_skipnextlf = 0;
723 } else if (c != EOF) ungetc(c, f->f_fp);
724 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000725#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000726 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000727#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000728 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000729#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000730}
731
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000732static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000733file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000734{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000735 if (f->f_fp == NULL)
736 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000737 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000738}
739
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000740static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000741file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000742{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000743 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000744
Guido van Rossumd7297e61992-07-06 14:19:26 +0000745 if (f->f_fp == NULL)
746 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000747 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000748 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000749 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000750 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000751 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000752 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000753 clearerr(f->f_fp);
754 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000755 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000756 Py_INCREF(Py_None);
757 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000758}
759
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000760static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000761file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000762{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000763 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000764 if (f->f_fp == NULL)
765 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000766 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000767 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000768 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000769 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000770}
771
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000772
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000773#if BUFSIZ < 8192
774#define SMALLCHUNK 8192
775#else
776#define SMALLCHUNK BUFSIZ
777#endif
778
Guido van Rossum3c259041999-01-14 19:00:14 +0000779#if SIZEOF_INT < 4
780#define BIGCHUNK (512 * 32)
781#else
782#define BIGCHUNK (512 * 1024)
783#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000784
785static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000786new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000787{
788#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000789 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000790 struct stat st;
791 if (fstat(fileno(f->f_fp), &st) == 0) {
792 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000793 /* The following is not a bug: we really need to call lseek()
794 *and* ftell(). The reason is that some stdio libraries
795 mistakenly flush their buffer when ftell() is called and
796 the lseek() call it makes fails, thereby throwing away
797 data that cannot be recovered in any way. To avoid this,
798 we first test lseek(), and only call ftell() if lseek()
799 works. We can't use the lseek() value either, because we
800 need to take the amount of buffered data into account.
801 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000802 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000803 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000804 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000805 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000806 if (pos < 0)
807 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000808 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000809 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000810 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000811 }
812#endif
813 if (currentsize > SMALLCHUNK) {
814 /* Keep doubling until we reach BIGCHUNK;
815 then keep adding BIGCHUNK. */
816 if (currentsize <= BIGCHUNK)
817 return currentsize + currentsize;
818 else
819 return currentsize + BIGCHUNK;
820 }
821 return currentsize + SMALLCHUNK;
822}
823
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000824#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
825#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
826#else
827#ifdef EWOULDBLOCK
828#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
829#else
830#ifdef EAGAIN
831#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
832#else
833#define BLOCKED_ERRNO(x) 0
834#endif
835#endif
836#endif
837
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000838static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000839file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000840{
Guido van Rossum789a1611997-05-10 22:33:55 +0000841 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000842 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000843 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000844
Guido van Rossumd7297e61992-07-06 14:19:26 +0000845 if (f->f_fp == NULL)
846 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000847 /* refuse to mix with f.next() */
848 if (f->f_buf != NULL &&
849 (f->f_bufend - f->f_bufptr) > 0 &&
850 f->f_buf[0] != '\0')
851 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000852 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000853 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000854 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000855 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000856 else
857 buffersize = bytesrequested;
Martin v. Löwis2a190742006-04-13 07:37:25 +0000858 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000859 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000860 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000861 return NULL;
862 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000863 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000864 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000865 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000866 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000867 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000868 Py_BEGIN_ALLOW_THREADS
869 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000870 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000871 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000872 Py_END_ALLOW_THREADS
873 if (chunksize == 0) {
874 if (!ferror(f->f_fp))
875 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000876 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000877 /* When in non-blocking mode, data shouldn't
878 * be discarded if a blocking signal was
879 * received. That will also happen if
880 * chunksize != 0, but bytesread < buffersize. */
881 if (bytesread > 0 && BLOCKED_ERRNO(errno))
882 break;
883 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum6263d541997-05-10 22:07:25 +0000884 Py_DECREF(v);
885 return NULL;
886 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000887 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000888 if (bytesread < buffersize) {
889 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000890 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000891 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000892 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000893 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000894 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000895 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000896 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000897 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000898 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000899 }
900 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000901 if (bytesread != buffersize)
902 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000903 return v;
904}
905
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000906static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000907file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000908{
909 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000910 Py_ssize_t ntodo;
911 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000912
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000913 if (f->f_fp == NULL)
914 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000915 /* refuse to mix with f.next() */
916 if (f->f_buf != NULL &&
917 (f->f_bufend - f->f_bufptr) > 0 &&
918 f->f_buf[0] != '\0')
919 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000920 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000921 return NULL;
922 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000923 while (ntodo > 0) {
924 Py_BEGIN_ALLOW_THREADS
925 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000926 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000927 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000928 Py_END_ALLOW_THREADS
929 if (nnow == 0) {
930 if (!ferror(f->f_fp))
931 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000932 PyErr_SetFromErrno(PyExc_IOError);
933 clearerr(f->f_fp);
934 return NULL;
935 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000936 ndone += nnow;
937 ntodo -= nnow;
938 }
Neal Norwitz076d1e02006-08-21 18:20:10 +0000939 return PyInt_FromSsize_t(ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000940}
941
Tim Peters86821b22001-01-07 21:19:34 +0000942/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000943Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000944
945Under MSVC 6:
946
Tim Peters1c733232001-01-08 04:02:07 +0000947+ MS threadsafe getc is very slow (multiple layers of function calls before+
948 after each character, to lock+unlock the stream).
949+ The stream-locking functions are MS-internal -- can't access them from user
950 code.
951+ There's nothing Tim could find in the MS C or platform SDK libraries that
952 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000953+ MS fgets locks/unlocks only once per line; it's the only hook we have.
954
955So we use fgets for speed(!), despite that it's painful.
956
957MS realloc is also slow.
958
Tim Petersf29b64d2001-01-15 06:33:19 +0000959Reports from other platforms on this method vs getc_unlocked (which MS doesn't
960have):
961 Linux a wash
962 Solaris a wash
963 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000964
Tim Petersf29b64d2001-01-15 06:33:19 +0000965CAUTION: The C std isn't clear about this: in those cases where fgets
966writes something into the buffer, can it write into any position beyond the
967required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
968known on which it does; and it would be a strange way to code fgets. Still,
969getline_via_fgets may not work correctly if it does. The std test
970test_bufio.py should fail if platform fgets() routinely writes beyond the
971trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000972**************************************************************************/
973
Tim Petersf29b64d2001-01-15 06:33:19 +0000974/* Use this routine if told to, or by default on non-get_unlocked()
975 * platforms unless told not to. Yikes! Let's spell that out:
976 * On a platform with getc_unlocked():
977 * By default, use getc_unlocked().
978 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
979 * On a platform without getc_unlocked():
980 * By default, use fgets().
981 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
982 */
983#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
984#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000985#endif
986
Tim Petersf29b64d2001-01-15 06:33:19 +0000987#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
988#undef USE_FGETS_IN_GETLINE
989#endif
990
991#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000992static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000993getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000994{
Tim Peters15b83852001-01-08 00:53:12 +0000995/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000996 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
997 * to fill this much of the buffer with a known value in order to figure out
998 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
999 * than "most" lines, we waste time filling unused buffer slots. 100 is
1000 * surely adequate for most peoples' email archives, chewing over source code,
1001 * etc -- "regular old text files".
1002 * MAXBUFSIZE is the maximum line length that lets us get away with the less
1003 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
1004 * cautions about boosting that. 300 was chosen because the worst real-life
1005 * text-crunching job reported on Python-Dev was a mail-log crawler where over
1006 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +00001007 */
Tim Peters142297a2001-01-15 10:36:56 +00001008#define INITBUFSIZE 100
1009#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +00001010 char* p; /* temp */
1011 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +00001012 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +00001013 char* pvfree; /* address of next free slot */
1014 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +00001015 size_t nfree; /* # of free buffer slots; pvend-pvfree */
1016 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001017 size_t increment; /* amount to increment the buffer */
Armin Rigo7ccbca92006-10-04 12:17:45 +00001018 size_t prev_v_size;
Tim Peters86821b22001-01-07 21:19:34 +00001019
Tim Peters15b83852001-01-08 00:53:12 +00001020 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001021 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001022 */
Tim Peters142297a2001-01-15 10:36:56 +00001023 total_v_size = INITBUFSIZE; /* start small and pray */
1024 pvfree = buf;
1025 for (;;) {
1026 Py_BEGIN_ALLOW_THREADS
1027 pvend = buf + total_v_size;
1028 nfree = pvend - pvfree;
1029 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001030 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1031 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001032 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001033
Tim Peters142297a2001-01-15 10:36:56 +00001034 if (p == NULL) {
1035 clearerr(fp);
1036 if (PyErr_CheckSignals())
1037 return NULL;
1038 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001039 return v;
1040 }
Tim Peters142297a2001-01-15 10:36:56 +00001041 /* fgets read *something* */
1042 p = memchr(pvfree, '\n', nfree);
1043 if (p != NULL) {
1044 /* Did the \n come from fgets or from us?
1045 * Since fgets stops at the first \n, and then writes
1046 * \0, if it's from fgets a \0 must be next. But if
1047 * that's so, it could not have come from us, since
1048 * the \n's we filled the buffer with have only more
1049 * \n's to the right.
1050 */
1051 if (p+1 < pvend && *(p+1) == '\0') {
1052 /* It's from fgets: we win! In particular,
1053 * we haven't done any mallocs yet, and can
1054 * build the final result on the first try.
1055 */
1056 ++p; /* include \n from fgets */
1057 }
1058 else {
1059 /* Must be from us: fgets didn't fill the
1060 * buffer and didn't find a newline, so it
1061 * must be the last and newline-free line of
1062 * the file.
1063 */
1064 assert(p > pvfree && *(p-1) == '\0');
1065 --p; /* don't include \0 from fgets */
1066 }
1067 v = PyString_FromStringAndSize(buf, p - buf);
1068 return v;
1069 }
1070 /* yuck: fgets overwrote all the newlines, i.e. the entire
1071 * buffer. So this line isn't over yet, or maybe it is but
1072 * we're exactly at EOF. If we haven't already, try using the
1073 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001074 */
Tim Peters142297a2001-01-15 10:36:56 +00001075 assert(*(pvend-1) == '\0');
1076 if (pvfree == buf) {
1077 pvfree = pvend - 1; /* overwrite trailing null */
1078 total_v_size = MAXBUFSIZE;
1079 }
1080 else
1081 break;
Tim Peters86821b22001-01-07 21:19:34 +00001082 }
Tim Peters142297a2001-01-15 10:36:56 +00001083
1084 /* The stack buffer isn't big enough; malloc a string object and read
1085 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001086 */
Tim Petersddea2082002-03-23 10:03:50 +00001087 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001088 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001089 if (v == NULL)
1090 return v;
1091 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001092 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1093 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001094
1095 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001096 * after setting p one beyond the end of the line. The code here is
1097 * very much like the code above, except reads into v's buffer; see
1098 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001099 */
1100 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001101 Py_BEGIN_ALLOW_THREADS
1102 pvend = BUF(v) + total_v_size;
1103 nfree = pvend - pvfree;
1104 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001105 assert(nfree < INT_MAX);
1106 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001107 Py_END_ALLOW_THREADS
1108
1109 if (p == NULL) {
1110 clearerr(fp);
1111 if (PyErr_CheckSignals()) {
1112 Py_DECREF(v);
1113 return NULL;
1114 }
1115 p = pvfree;
1116 break;
1117 }
Tim Peters86821b22001-01-07 21:19:34 +00001118 p = memchr(pvfree, '\n', nfree);
1119 if (p != NULL) {
1120 if (p+1 < pvend && *(p+1) == '\0') {
1121 /* \n came from fgets */
1122 ++p;
1123 break;
1124 }
1125 /* \n came from us; last line of file, no newline */
1126 assert(p > pvfree && *(p-1) == '\0');
1127 --p;
1128 break;
1129 }
1130 /* expand buffer and try again */
1131 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001132 increment = total_v_size >> 2; /* mild exponential growth */
Armin Rigo7ccbca92006-10-04 12:17:45 +00001133 prev_v_size = total_v_size;
Tim Petersddea2082002-03-23 10:03:50 +00001134 total_v_size += increment;
Armin Rigo7ccbca92006-10-04 12:17:45 +00001135 /* check for overflow */
1136 if (total_v_size <= prev_v_size ||
1137 total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001138 PyErr_SetString(PyExc_OverflowError,
1139 "line is longer than a Python string can hold");
1140 Py_DECREF(v);
1141 return NULL;
1142 }
1143 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1144 return NULL;
1145 /* overwrite the trailing null byte */
Armin Rigo7ccbca92006-10-04 12:17:45 +00001146 pvfree = BUF(v) + (prev_v_size - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001147 }
1148 if (BUF(v) + total_v_size != p)
1149 _PyString_Resize(&v, p - BUF(v));
1150 return v;
1151#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001152#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001153}
Tim Petersf29b64d2001-01-15 06:33:19 +00001154#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001155
Guido van Rossum0bd24411991-04-04 15:21:57 +00001156/* Internal routine to get a line.
1157 Size argument interpretation:
1158 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001159 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001160*/
1161
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001162static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001163get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001164{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001165 FILE *fp = f->f_fp;
1166 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001167 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001168 size_t total_v_size; /* total # of slots in buffer */
1169 size_t used_v_size; /* # used slots in buffer */
1170 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001171 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001172 int newlinetypes = f->f_newlinetypes;
1173 int skipnextlf = f->f_skipnextlf;
1174 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001175
Jack Jansen7b8c7542002-04-14 20:12:41 +00001176#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001177 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001178 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001179#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001180 total_v_size = n > 0 ? n : 100;
1181 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001182 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001183 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001184 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001185 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001186
Guido van Rossumce5ba841991-03-06 13:06:18 +00001187 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001188 Py_BEGIN_ALLOW_THREADS
1189 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001190 if (univ_newline) {
1191 c = 'x'; /* Shut up gcc warning */
1192 while ( buf != end && (c = GETC(fp)) != EOF ) {
1193 if (skipnextlf ) {
1194 skipnextlf = 0;
1195 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001196 /* Seeing a \n here with
1197 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001198 * saw a \r before.
1199 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001200 newlinetypes |= NEWLINE_CRLF;
1201 c = GETC(fp);
1202 if (c == EOF) break;
1203 } else {
1204 newlinetypes |= NEWLINE_CR;
1205 }
1206 }
1207 if (c == '\r') {
1208 skipnextlf = 1;
1209 c = '\n';
1210 } else if ( c == '\n')
1211 newlinetypes |= NEWLINE_LF;
1212 *buf++ = c;
1213 if (c == '\n') break;
1214 }
1215 if ( c == EOF && skipnextlf )
1216 newlinetypes |= NEWLINE_CR;
1217 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001218 while ((c = GETC(fp)) != EOF &&
1219 (*buf++ = c) != '\n' &&
1220 buf != end)
1221 ;
1222 FUNLOCKFILE(fp);
1223 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001224 f->f_newlinetypes = newlinetypes;
1225 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001226 if (c == '\n')
1227 break;
1228 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001229 if (ferror(fp)) {
1230 PyErr_SetFromErrno(PyExc_IOError);
1231 clearerr(fp);
1232 Py_DECREF(v);
1233 return NULL;
1234 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001235 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001236 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001237 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001238 return NULL;
1239 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001240 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001241 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001242 /* Must be because buf == end */
1243 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001244 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001245 used_v_size = total_v_size;
1246 increment = total_v_size >> 2; /* mild exponential growth */
1247 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001248 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001249 PyErr_SetString(PyExc_OverflowError,
1250 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001251 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001252 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001253 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001254 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001255 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001256 buf = BUF(v) + used_v_size;
1257 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001258 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001259
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001260 used_v_size = buf - BUF(v);
1261 if (used_v_size != total_v_size)
1262 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001263 return v;
1264}
1265
Guido van Rossum0bd24411991-04-04 15:21:57 +00001266/* External C interface */
1267
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001268PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001269PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001270{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001271 PyObject *result;
1272
Guido van Rossum3165fe61992-09-25 21:59:05 +00001273 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001274 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001275 return NULL;
1276 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001277
1278 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001279 PyFileObject *fo = (PyFileObject *)f;
1280 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001281 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001282 /* refuse to mix with f.next() */
1283 if (fo->f_buf != NULL &&
1284 (fo->f_bufend - fo->f_bufptr) > 0 &&
1285 fo->f_buf[0] != '\0')
1286 return err_iterbuffered();
1287 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001288 }
1289 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001290 PyObject *reader;
1291 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001292
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001293 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001294 if (reader == NULL)
1295 return NULL;
1296 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001297 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001298 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001299 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001300 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001301 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001302 return NULL;
1303 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001304 result = PyEval_CallObject(reader, args);
1305 Py_DECREF(reader);
1306 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001307 if (result != NULL && !PyString_Check(result) &&
1308 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001309 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001310 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001311 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001312 "object.readline() returned non-string");
1313 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001314 }
1315
1316 if (n < 0 && result != NULL && PyString_Check(result)) {
1317 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001318 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001319 if (len == 0) {
1320 Py_DECREF(result);
1321 result = NULL;
1322 PyErr_SetString(PyExc_EOFError,
1323 "EOF when reading a line");
1324 }
1325 else if (s[len-1] == '\n') {
1326 if (result->ob_refcnt == 1)
1327 _PyString_Resize(&result, len-1);
1328 else {
1329 PyObject *v;
1330 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001331 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001332 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001333 }
1334 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001335 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001336#ifdef Py_USING_UNICODE
1337 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1338 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001339 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001340 if (len == 0) {
1341 Py_DECREF(result);
1342 result = NULL;
1343 PyErr_SetString(PyExc_EOFError,
1344 "EOF when reading a line");
1345 }
1346 else if (s[len-1] == '\n') {
1347 if (result->ob_refcnt == 1)
1348 PyUnicode_Resize(&result, len-1);
1349 else {
1350 PyObject *v;
1351 v = PyUnicode_FromUnicode(s, len-1);
1352 Py_DECREF(result);
1353 result = v;
1354 }
1355 }
1356 }
1357#endif
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001358 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001359}
1360
1361/* Python method */
1362
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001363static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001364file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001365{
Guido van Rossum789a1611997-05-10 22:33:55 +00001366 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001367
Guido van Rossumd7297e61992-07-06 14:19:26 +00001368 if (f->f_fp == NULL)
1369 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001370 /* refuse to mix with f.next() */
1371 if (f->f_buf != NULL &&
1372 (f->f_bufend - f->f_bufptr) > 0 &&
1373 f->f_buf[0] != '\0')
1374 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001375 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001376 return NULL;
1377 if (n == 0)
1378 return PyString_FromString("");
1379 if (n < 0)
1380 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001381 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001382}
1383
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001384static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001385file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001386{
Guido van Rossum789a1611997-05-10 22:33:55 +00001387 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001388 PyObject *list;
1389 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001390 char small_buffer[SMALLCHUNK];
1391 char *buffer = small_buffer;
1392 size_t buffersize = SMALLCHUNK;
1393 PyObject *big_buffer = NULL;
1394 size_t nfilled = 0;
1395 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001396 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001397 char *p, *q, *end;
1398 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001399 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001400
Guido van Rossumd7297e61992-07-06 14:19:26 +00001401 if (f->f_fp == NULL)
1402 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001403 /* refuse to mix with f.next() */
1404 if (f->f_buf != NULL &&
1405 (f->f_bufend - f->f_bufptr) > 0 &&
1406 f->f_buf[0] != '\0')
1407 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001408 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001409 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001410 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001411 return NULL;
1412 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001413 if (shortread)
1414 nread = 0;
1415 else {
1416 Py_BEGIN_ALLOW_THREADS
1417 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001418 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001419 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001420 Py_END_ALLOW_THREADS
1421 shortread = (nread < buffersize-nfilled);
1422 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001423 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001424 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001425 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001426 break;
1427 PyErr_SetFromErrno(PyExc_IOError);
1428 clearerr(f->f_fp);
1429 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001430 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001431 list = NULL;
1432 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001433 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001434 totalread += nread;
Anthony Baxter377be112006-04-11 06:54:30 +00001435 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001436 if (p == NULL) {
1437 /* Need a larger buffer to fit this line */
1438 nfilled += nread;
1439 buffersize *= 2;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001440 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001441 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001442 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001443 goto error;
1444 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001445 if (big_buffer == NULL) {
1446 /* Create the big buffer */
1447 big_buffer = PyString_FromStringAndSize(
1448 NULL, buffersize);
1449 if (big_buffer == NULL)
1450 goto error;
1451 buffer = PyString_AS_STRING(big_buffer);
1452 memcpy(buffer, small_buffer, nfilled);
1453 }
1454 else {
1455 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001456 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1457 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001458 buffer = PyString_AS_STRING(big_buffer);
1459 }
1460 continue;
1461 }
1462 end = buffer+nfilled+nread;
1463 q = buffer;
1464 do {
1465 /* Process complete lines */
1466 p++;
1467 line = PyString_FromStringAndSize(q, p-q);
1468 if (line == NULL)
1469 goto error;
1470 err = PyList_Append(list, line);
1471 Py_DECREF(line);
1472 if (err != 0)
1473 goto error;
1474 q = p;
Anthony Baxter377be112006-04-11 06:54:30 +00001475 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001476 } while (p != NULL);
1477 /* Move the remaining incomplete line to the start */
1478 nfilled = end-q;
1479 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001480 if (sizehint > 0)
1481 if (totalread >= (size_t)sizehint)
1482 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001483 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001484 if (nfilled != 0) {
1485 /* Partial last line */
1486 line = PyString_FromStringAndSize(buffer, nfilled);
1487 if (line == NULL)
1488 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001489 if (sizehint > 0) {
1490 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001491 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001492 if (rest == NULL) {
1493 Py_DECREF(line);
1494 goto error;
1495 }
1496 PyString_Concat(&line, rest);
1497 Py_DECREF(rest);
1498 if (line == NULL)
1499 goto error;
1500 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001501 err = PyList_Append(list, line);
1502 Py_DECREF(line);
1503 if (err != 0)
1504 goto error;
1505 }
1506 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001507 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001508 return list;
1509}
1510
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001511static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001512file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001513{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001514 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001515 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001516 if (f->f_fp == NULL)
1517 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001518 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001519 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001520 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001521 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001522 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001523 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001524 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001525 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001526 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001527 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001528 return NULL;
1529 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001530 Py_INCREF(Py_None);
1531 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001532}
1533
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001534static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001535file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001536{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001537#define CHUNKSIZE 1000
1538 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001539 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001540 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001541 int index, islist;
1542 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001543
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001544 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001545 if (f->f_fp == NULL)
1546 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001547
1548 result = NULL;
1549 list = NULL;
1550 islist = PyList_Check(seq);
1551 if (islist)
1552 it = NULL;
1553 else {
1554 it = PyObject_GetIter(seq);
1555 if (it == NULL) {
1556 PyErr_SetString(PyExc_TypeError,
1557 "writelines() requires an iterable argument");
1558 return NULL;
1559 }
1560 /* From here on, fail by going to error, to reclaim "it". */
1561 list = PyList_New(CHUNKSIZE);
1562 if (list == NULL)
1563 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001564 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001565
1566 /* Strategy: slurp CHUNKSIZE lines into a private list,
1567 checking that they are all strings, then write that list
1568 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001569 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001570 if (islist) {
1571 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001572 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001573 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001574 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001575 j = PyList_GET_SIZE(list);
1576 }
1577 else {
1578 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001579 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001580 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001581 if (PyErr_Occurred())
1582 goto error;
1583 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001584 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001585 PyList_SetItem(list, j, line);
1586 }
1587 }
1588 if (j == 0)
1589 break;
1590
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001591 /* Check that all entries are indeed strings. If not,
1592 apply the same rules as for file.write() and
1593 convert the results to strings. This is slow, but
1594 seems to be the only way since all conversion APIs
1595 could potentially execute Python code. */
1596 for (i = 0; i < j; i++) {
1597 PyObject *v = PyList_GET_ITEM(list, i);
1598 if (!PyString_Check(v)) {
1599 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001600 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001601 PyObject_AsReadBuffer(v,
1602 (const void**)&buffer,
1603 &len)) ||
1604 PyObject_AsCharBuffer(v,
1605 &buffer,
1606 &len))) {
1607 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001608 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001609 goto error;
1610 }
1611 line = PyString_FromStringAndSize(buffer,
1612 len);
1613 if (line == NULL)
1614 goto error;
1615 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001616 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001617 }
1618 }
1619
1620 /* Since we are releasing the global lock, the
1621 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001622 Py_BEGIN_ALLOW_THREADS
1623 f->f_softspace = 0;
1624 errno = 0;
1625 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001626 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001627 len = PyString_GET_SIZE(line);
1628 nwritten = fwrite(PyString_AS_STRING(line),
1629 1, len, f->f_fp);
1630 if (nwritten != len) {
1631 Py_BLOCK_THREADS
1632 PyErr_SetFromErrno(PyExc_IOError);
1633 clearerr(f->f_fp);
1634 goto error;
1635 }
1636 }
1637 Py_END_ALLOW_THREADS
1638
1639 if (j < CHUNKSIZE)
1640 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001641 }
1642
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001643 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001644 result = Py_None;
1645 error:
1646 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001647 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001648 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001649#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001650}
1651
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001652static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001653file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001654{
1655 if (f->f_fp == NULL)
1656 return err_closed();
1657 Py_INCREF(f);
1658 return (PyObject *)f;
1659}
1660
Georg Brandl98b40ad2006-06-08 14:50:21 +00001661static PyObject *
1662file_exit(PyFileObject *f, PyObject *args)
1663{
1664 PyObject *ret = file_close(f);
1665 if (!ret)
1666 /* If error occurred, pass through */
1667 return NULL;
1668 Py_DECREF(ret);
1669 /* We cannot return the result of close since a true
1670 * value will be interpreted as "yes, swallow the
1671 * exception if one was raised inside the with block". */
1672 Py_RETURN_NONE;
1673}
1674
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001675PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001676"readline([size]) -> next line from the file, as a string.\n"
1677"\n"
1678"Retain newline. A non-negative size argument limits the maximum\n"
1679"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001680"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001681
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001682PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001683"read([size]) -> read at most size bytes, returned as a string.\n"
1684"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001685"If the size argument is negative or omitted, read until EOF is reached.\n"
1686"Notice that when in non-blocking mode, less data than what was requested\n"
1687"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001688
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001689PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001690"write(str) -> None. Write string str to file.\n"
1691"\n"
1692"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001693"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001694
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001695PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001696"fileno() -> integer \"file descriptor\".\n"
1697"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001698"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001699
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001700PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001701"seek(offset[, whence]) -> None. Move to new file position.\n"
1702"\n"
1703"Argument offset is a byte count. Optional argument whence defaults to\n"
1704"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1705"(move relative to current position, positive or negative), and 2 (move\n"
1706"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001707"seeking beyond the end of a file). If the file is opened in text mode,\n"
1708"only offsets returned by tell() are legal. Use of other offsets causes\n"
1709"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001710"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001711"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001712
Guido van Rossumd7047b31995-01-02 19:07:15 +00001713#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001714PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001715"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1716"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001717"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001718#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001719
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001720PyDoc_STRVAR(tell_doc,
1721"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001722
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001723PyDoc_STRVAR(readinto_doc,
1724"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001725
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001726PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001727"readlines([size]) -> list of strings, each a line from the file.\n"
1728"\n"
1729"Call readline() repeatedly and return a list of the lines so read.\n"
1730"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001731"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001732
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001733PyDoc_STRVAR(xreadlines_doc,
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001734"xreadlines() -> returns self.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001735"\n"
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001736"For backward compatibility. File objects now include the performance\n"
1737"optimizations previously implemented in the xreadlines module.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001738
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001739PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001740"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001741"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001742"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001743"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001744
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001745PyDoc_STRVAR(flush_doc,
1746"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001747
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001748PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001749"close() -> None or (perhaps) an integer. Close the file.\n"
1750"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001751"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001752"further I/O operations. close() may be called more than once without\n"
1753"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001754"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001755
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001756PyDoc_STRVAR(isatty_doc,
1757"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001758
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001759PyDoc_STRVAR(enter_doc,
1760 "__enter__() -> self.");
1761
Georg Brandl98b40ad2006-06-08 14:50:21 +00001762PyDoc_STRVAR(exit_doc,
1763 "__exit__(*excinfo) -> None. Closes the file.");
1764
Tim Petersefc3a3a2001-09-20 07:55:22 +00001765static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001766 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1767 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1768 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1769 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1770 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001771#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001772 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001773#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001774 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1775 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1776 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001777 {"xreadlines",(PyCFunction)file_self, METH_NOARGS, xreadlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001778 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1779 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1780 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1781 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001782 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Georg Brandl98b40ad2006-06-08 14:50:21 +00001783 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001784 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001785};
1786
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001787#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001788
Guido van Rossum6f799372001-09-20 20:46:19 +00001789static PyMemberDef file_memberlist[] = {
1790 {"softspace", T_INT, OFF(f_softspace), 0,
1791 "flag indicating that a space needs to be printed; used by print"},
1792 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001793 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001794 {"name", T_OBJECT, OFF(f_name), RO,
1795 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001796 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1797 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001798 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001799 {NULL} /* Sentinel */
1800};
1801
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001802static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001803get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001804{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001805 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001806}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001807static PyObject *
1808get_newlines(PyFileObject *f, void *closure)
1809{
1810 switch (f->f_newlinetypes) {
1811 case NEWLINE_UNKNOWN:
1812 Py_INCREF(Py_None);
1813 return Py_None;
1814 case NEWLINE_CR:
1815 return PyString_FromString("\r");
1816 case NEWLINE_LF:
1817 return PyString_FromString("\n");
1818 case NEWLINE_CR|NEWLINE_LF:
1819 return Py_BuildValue("(ss)", "\r", "\n");
1820 case NEWLINE_CRLF:
1821 return PyString_FromString("\r\n");
1822 case NEWLINE_CR|NEWLINE_CRLF:
1823 return Py_BuildValue("(ss)", "\r", "\r\n");
1824 case NEWLINE_LF|NEWLINE_CRLF:
1825 return Py_BuildValue("(ss)", "\n", "\r\n");
1826 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1827 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1828 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001829 PyErr_Format(PyExc_SystemError,
1830 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001831 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001832 return NULL;
1833 }
1834}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001835
Guido van Rossum32d34c82001-09-20 21:45:26 +00001836static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001837 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001838 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001839 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001840 {0},
1841};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001842
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001843static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001844drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001845{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001846 if (f->f_buf != NULL) {
1847 PyMem_Free(f->f_buf);
1848 f->f_buf = NULL;
1849 }
Guido van Rossum65967252001-04-21 13:20:18 +00001850}
1851
Tim Petersf1827cf2003-09-07 03:30:18 +00001852/* Make sure that file has a readahead buffer with at least one byte
1853 (unless at EOF) and no more than bufsize. Returns negative value on
Georg Brandled02eb62006-03-31 20:31:02 +00001854 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001855static int
1856readahead(PyFileObject *f, int bufsize)
1857{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001858 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001859
1860 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001861 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001862 return 0;
1863 else
1864 drop_readahead(f);
1865 }
Anthony Baxter377be112006-04-11 06:54:30 +00001866 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
Georg Brandled02eb62006-03-31 20:31:02 +00001867 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001868 return -1;
1869 }
1870 Py_BEGIN_ALLOW_THREADS
1871 errno = 0;
1872 chunksize = Py_UniversalNewlineFread(
1873 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1874 Py_END_ALLOW_THREADS
1875 if (chunksize == 0) {
1876 if (ferror(f->f_fp)) {
1877 PyErr_SetFromErrno(PyExc_IOError);
1878 clearerr(f->f_fp);
1879 drop_readahead(f);
1880 return -1;
1881 }
1882 }
1883 f->f_bufptr = f->f_buf;
1884 f->f_bufend = f->f_buf + chunksize;
1885 return 0;
1886}
1887
1888/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001889 uninitialized bytes followed by the remainder of the line. Don't be
1890 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001891 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1892
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001893static PyStringObject *
1894readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1895{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001896 PyStringObject* s;
1897 char *bufptr;
1898 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001899 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001900
1901 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001902 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001903 return NULL;
1904
1905 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001906 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001907 return (PyStringObject *)
1908 PyString_FromStringAndSize(NULL, skip);
Anthony Baxter377be112006-04-11 06:54:30 +00001909 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001910 if (bufptr != NULL) {
1911 bufptr++; /* Count the '\n' */
1912 len = bufptr - f->f_bufptr;
1913 s = (PyStringObject *)
1914 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001915 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001916 return NULL;
1917 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1918 f->f_bufptr = bufptr;
1919 if (bufptr == f->f_bufend)
1920 drop_readahead(f);
1921 } else {
1922 bufptr = f->f_bufptr;
1923 buf = f->f_buf;
1924 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001925 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001926 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001927 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001928 if (s == NULL) {
1929 PyMem_Free(buf);
1930 return NULL;
1931 }
1932 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1933 PyMem_Free(buf);
1934 }
1935 return s;
1936}
1937
1938/* A larger buffer size may actually decrease performance. */
1939#define READAHEAD_BUFSIZE 8192
1940
1941static PyObject *
1942file_iternext(PyFileObject *f)
1943{
1944 PyStringObject* l;
1945
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001946 if (f->f_fp == NULL)
1947 return err_closed();
1948
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001949 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1950 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1951 Py_XDECREF(l);
1952 return NULL;
1953 }
1954 return (PyObject *)l;
1955}
1956
1957
Tim Peters59c9a642001-09-13 05:38:56 +00001958static PyObject *
1959file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1960{
Tim Peters44410012001-09-14 03:26:08 +00001961 PyObject *self;
1962 static PyObject *not_yet_string;
1963
1964 assert(type != NULL && type->tp_alloc != NULL);
1965
1966 if (not_yet_string == NULL) {
1967 not_yet_string = PyString_FromString("<uninitialized file>");
1968 if (not_yet_string == NULL)
1969 return NULL;
1970 }
1971
1972 self = type->tp_alloc(type, 0);
1973 if (self != NULL) {
1974 /* Always fill in the name and mode, so that nobody else
1975 needs to special-case NULLs there. */
1976 Py_INCREF(not_yet_string);
1977 ((PyFileObject *)self)->f_name = not_yet_string;
1978 Py_INCREF(not_yet_string);
1979 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001980 Py_INCREF(Py_None);
1981 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001982 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001983 }
1984 return self;
1985}
1986
1987static int
1988file_init(PyObject *self, PyObject *args, PyObject *kwds)
1989{
1990 PyFileObject *foself = (PyFileObject *)self;
1991 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001992 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001993 char *name = NULL;
1994 char *mode = "r";
1995 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001996 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001997
1998 assert(PyFile_Check(self));
1999 if (foself->f_fp != NULL) {
2000 /* Have to close the existing file first. */
2001 PyObject *closeresult = file_close(foself);
2002 if (closeresult == NULL)
2003 return -1;
2004 Py_DECREF(closeresult);
2005 }
Tim Peters59c9a642001-09-13 05:38:56 +00002006
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002007#ifdef Py_WIN_WIDE_FILENAMES
2008 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
2009 PyObject *po;
2010 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
2011 kwlist, &po, &mode, &bufsize)) {
2012 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002013 if (fill_file_fields(foself, NULL, po, mode,
2014 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002015 goto Error;
2016 } else {
2017 /* Drop the argument parsing error as narrow
2018 strings are also valid. */
2019 PyErr_Clear();
2020 }
2021 }
2022#endif
2023
2024 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002025 PyObject *o_name;
2026
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002027 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2028 Py_FileSystemDefaultEncoding,
2029 &name,
2030 &mode, &bufsize))
2031 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002032
2033 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002034 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2035 kwlist, &o_name, &mode,
2036 &bufsize))
Brett Cannon2b3666f2006-08-31 18:54:26 +00002037 goto Error;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002038
2039 if (fill_file_fields(foself, NULL, o_name, mode,
2040 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002041 goto Error;
2042 }
Tim Peters44410012001-09-14 03:26:08 +00002043 if (open_the_file(foself, name, mode) == NULL)
2044 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002045 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002046 PyFile_SetBufSize(self, bufsize);
2047 goto Done;
2048
2049Error:
2050 ret = -1;
2051 /* fall through */
2052Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002053 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002054 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002055}
2056
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002057PyDoc_VAR(file_doc) =
2058PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002059"file(name[, mode[, buffering]]) -> file object\n"
2060"\n"
2061"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2062"writing or appending. The file will be created if it doesn't exist\n"
2063"when opened for writing or appending; it will be truncated when\n"
2064"opened for writing. Add a 'b' to the mode for binary files.\n"
2065"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2066"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Tim Peters742dfd62001-09-13 21:49:44 +00002067"buffered, and larger numbers specify the buffer size.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002068)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002069PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002070"Add a 'U' to mode to open the file for input with universal newline\n"
2071"support. Any line ending in the input file will be seen as a '\\n'\n"
2072"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2073"the value for this attribute is one of None (no newline read yet),\n"
2074"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2075"\n"
2076"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002077);
Tim Peters59c9a642001-09-13 05:38:56 +00002078
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002079PyTypeObject PyFile_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00002080 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002081 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002082 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002083 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002084 (destructor)file_dealloc, /* tp_dealloc */
2085 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002086 0, /* tp_getattr */
2087 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002088 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002089 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002090 0, /* tp_as_number */
2091 0, /* tp_as_sequence */
2092 0, /* tp_as_mapping */
2093 0, /* tp_hash */
2094 0, /* tp_call */
2095 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002096 PyObject_GenericGetAttr, /* tp_getattro */
Tim Peters015dd822003-05-04 04:16:52 +00002097 /* softspace is writable: we must supply tp_setattro */
2098 PyObject_GenericSetAttr, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002099 0, /* tp_as_buffer */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002100 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002101 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002102 0, /* tp_traverse */
2103 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002104 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002105 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002106 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002107 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002108 file_methods, /* tp_methods */
2109 file_memberlist, /* tp_members */
2110 file_getsetlist, /* tp_getset */
2111 0, /* tp_base */
2112 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002113 0, /* tp_descr_get */
2114 0, /* tp_descr_set */
2115 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002116 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002117 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002118 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002119 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002120};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002121
2122/* Interface for the 'soft space' between print items. */
2123
2124int
Fred Drakefd99de62000-07-09 05:02:18 +00002125PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00002126{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002127 long oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002128 if (f == NULL) {
2129 /* Do nothing */
2130 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002131 else if (PyFile_Check(f)) {
2132 oldflag = ((PyFileObject *)f)->f_softspace;
2133 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002134 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00002135 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002136 PyObject *v;
2137 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002138 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002139 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002140 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002141 if (PyInt_Check(v))
2142 oldflag = PyInt_AsLong(v);
Martin v. Löwis18e16552006-02-15 17:27:45 +00002143 assert(oldflag < INT_MAX);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002144 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002145 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002146 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002147 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002148 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002149 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002150 if (PyObject_SetAttrString(f, "softspace", v) != 0)
2151 PyErr_Clear();
2152 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002153 }
2154 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002155 return (int)oldflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002156}
Guido van Rossum3165fe61992-09-25 21:59:05 +00002157
2158/* Interfaces to write objects/strings to file-like objects */
2159
2160int
Fred Drakefd99de62000-07-09 05:02:18 +00002161PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002162{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002163 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002164 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002165 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002166 return -1;
2167 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002168 else if (PyFile_Check(f)) {
2169 FILE *fp = PyFile_AsFile(f);
Fred Drake086a0f72004-03-19 15:22:36 +00002170#ifdef Py_USING_UNICODE
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002171 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2172 int result;
Fred Drake086a0f72004-03-19 15:22:36 +00002173#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002174 if (fp == NULL) {
2175 err_closed();
2176 return -1;
2177 }
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002178#ifdef Py_USING_UNICODE
Tim Petersf1827cf2003-09-07 03:30:18 +00002179 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002180 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002181 char *cenc = PyString_AS_STRING(enc);
2182 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2183 if (value == NULL)
2184 return -1;
2185 } else {
2186 value = v;
2187 Py_INCREF(value);
2188 }
2189 result = PyObject_Print(value, fp, flags);
2190 Py_DECREF(value);
2191 return result;
2192#else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002193 return PyObject_Print(v, fp, flags);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002194#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002195 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002196 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002197 if (writer == NULL)
2198 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002199 if (flags & Py_PRINT_RAW) {
2200 if (PyUnicode_Check(v)) {
2201 value = v;
2202 Py_INCREF(value);
2203 } else
2204 value = PyObject_Str(v);
2205 }
2206 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002207 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002208 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002209 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002210 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002211 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002212 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002213 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002214 Py_DECREF(value);
2215 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002216 return -1;
2217 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002218 result = PyEval_CallObject(writer, args);
2219 Py_DECREF(args);
2220 Py_DECREF(value);
2221 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002222 if (result == NULL)
2223 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002224 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002225 return 0;
2226}
2227
Guido van Rossum27a60b11997-05-22 22:25:11 +00002228int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002229PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002230{
2231 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002232 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002233 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002234 PyErr_SetString(PyExc_SystemError,
2235 "null file for PyFile_WriteString");
2236 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002237 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002238 else if (PyFile_Check(f)) {
2239 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002240 if (fp == NULL) {
2241 err_closed();
2242 return -1;
2243 }
2244 fputs(s, fp);
2245 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002246 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002247 else if (!PyErr_Occurred()) {
2248 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002249 int err;
2250 if (v == NULL)
2251 return -1;
2252 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2253 Py_DECREF(v);
2254 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002255 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002256 else
2257 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002258}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002259
2260/* Try to get a file-descriptor from a Python object. If the object
2261 is an integer or long integer, its value is returned. If not, the
2262 object's fileno() method is called if it exists; the method must return
2263 an integer or long integer, which is returned as the file descriptor value.
2264 -1 is returned on failure.
2265*/
2266
2267int PyObject_AsFileDescriptor(PyObject *o)
2268{
2269 int fd;
2270 PyObject *meth;
2271
2272 if (PyInt_Check(o)) {
2273 fd = PyInt_AsLong(o);
2274 }
2275 else if (PyLong_Check(o)) {
2276 fd = PyLong_AsLong(o);
2277 }
2278 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2279 {
2280 PyObject *fno = PyEval_CallObject(meth, NULL);
2281 Py_DECREF(meth);
2282 if (fno == NULL)
2283 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002284
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002285 if (PyInt_Check(fno)) {
2286 fd = PyInt_AsLong(fno);
2287 Py_DECREF(fno);
2288 }
2289 else if (PyLong_Check(fno)) {
2290 fd = PyLong_AsLong(fno);
2291 Py_DECREF(fno);
2292 }
2293 else {
2294 PyErr_SetString(PyExc_TypeError,
2295 "fileno() returned a non-integer");
2296 Py_DECREF(fno);
2297 return -1;
2298 }
2299 }
2300 else {
2301 PyErr_SetString(PyExc_TypeError,
2302 "argument must be an int, or have a fileno() method.");
2303 return -1;
2304 }
2305
2306 if (fd < 0) {
2307 PyErr_Format(PyExc_ValueError,
2308 "file descriptor cannot be a negative integer (%i)",
2309 fd);
2310 return -1;
2311 }
2312 return fd;
2313}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002314
Jack Jansen7b8c7542002-04-14 20:12:41 +00002315/* From here on we need access to the real fgets and fread */
2316#undef fgets
2317#undef fread
2318
2319/*
2320** Py_UniversalNewlineFgets is an fgets variation that understands
2321** all of \r, \n and \r\n conventions.
2322** The stream should be opened in binary mode.
2323** If fobj is NULL the routine always does newline conversion, and
2324** it may peek one char ahead to gobble the second char in \r\n.
2325** If fobj is non-NULL it must be a PyFileObject. In this case there
2326** is no readahead but in stead a flag is used to skip a following
2327** \n on the next read. Also, if the file is open in binary mode
2328** the whole conversion is skipped. Finally, the routine keeps track of
2329** the different types of newlines seen.
2330** Note that we need no error handling: fgets() treats error and eof
2331** identically.
2332*/
2333char *
2334Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2335{
2336 char *p = buf;
2337 int c;
2338 int newlinetypes = 0;
2339 int skipnextlf = 0;
2340 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002341
Jack Jansen7b8c7542002-04-14 20:12:41 +00002342 if (fobj) {
2343 if (!PyFile_Check(fobj)) {
2344 errno = ENXIO; /* What can you do... */
2345 return NULL;
2346 }
2347 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2348 if ( !univ_newline )
2349 return fgets(buf, n, stream);
2350 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2351 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2352 }
2353 FLOCKFILE(stream);
2354 c = 'x'; /* Shut up gcc warning */
2355 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2356 if (skipnextlf ) {
2357 skipnextlf = 0;
2358 if (c == '\n') {
2359 /* Seeing a \n here with skipnextlf true
2360 ** means we saw a \r before.
2361 */
2362 newlinetypes |= NEWLINE_CRLF;
2363 c = GETC(stream);
2364 if (c == EOF) break;
2365 } else {
2366 /*
2367 ** Note that c == EOF also brings us here,
2368 ** so we're okay if the last char in the file
2369 ** is a CR.
2370 */
2371 newlinetypes |= NEWLINE_CR;
2372 }
2373 }
2374 if (c == '\r') {
2375 /* A \r is translated into a \n, and we skip
2376 ** an adjacent \n, if any. We don't set the
2377 ** newlinetypes flag until we've seen the next char.
2378 */
2379 skipnextlf = 1;
2380 c = '\n';
2381 } else if ( c == '\n') {
2382 newlinetypes |= NEWLINE_LF;
2383 }
2384 *p++ = c;
2385 if (c == '\n') break;
2386 }
2387 if ( c == EOF && skipnextlf )
2388 newlinetypes |= NEWLINE_CR;
2389 FUNLOCKFILE(stream);
2390 *p = '\0';
2391 if (fobj) {
2392 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2393 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2394 } else if ( skipnextlf ) {
2395 /* If we have no file object we cannot save the
2396 ** skipnextlf flag. We have to readahead, which
2397 ** will cause a pause if we're reading from an
2398 ** interactive stream, but that is very unlikely
2399 ** unless we're doing something silly like
2400 ** execfile("/dev/tty").
2401 */
2402 c = GETC(stream);
2403 if ( c != '\n' )
2404 ungetc(c, stream);
2405 }
2406 if (p == buf)
2407 return NULL;
2408 return buf;
2409}
2410
2411/*
2412** Py_UniversalNewlineFread is an fread variation that understands
2413** all of \r, \n and \r\n conventions.
2414** The stream should be opened in binary mode.
2415** fobj must be a PyFileObject. In this case there
2416** is no readahead but in stead a flag is used to skip a following
2417** \n on the next read. Also, if the file is open in binary mode
2418** the whole conversion is skipped. Finally, the routine keeps track of
2419** the different types of newlines seen.
2420*/
2421size_t
Tim Peters058b1412002-04-21 07:29:14 +00002422Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002423 FILE *stream, PyObject *fobj)
2424{
Tim Peters058b1412002-04-21 07:29:14 +00002425 char *dst = buf;
2426 PyFileObject *f = (PyFileObject *)fobj;
2427 int newlinetypes, skipnextlf;
2428
2429 assert(buf != NULL);
2430 assert(stream != NULL);
2431
Jack Jansen7b8c7542002-04-14 20:12:41 +00002432 if (!fobj || !PyFile_Check(fobj)) {
2433 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002434 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002435 }
Tim Peters058b1412002-04-21 07:29:14 +00002436 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002437 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002438 newlinetypes = f->f_newlinetypes;
2439 skipnextlf = f->f_skipnextlf;
2440 /* Invariant: n is the number of bytes remaining to be filled
2441 * in the buffer.
2442 */
2443 while (n) {
2444 size_t nread;
2445 int shortread;
2446 char *src = dst;
2447
2448 nread = fread(dst, 1, n, stream);
2449 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002450 if (nread == 0)
2451 break;
2452
Tim Peterse1682a82002-04-21 18:15:20 +00002453 n -= nread; /* assuming 1 byte out for each in; will adjust */
2454 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002455 while (nread--) {
2456 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002457 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002458 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002459 *dst++ = '\n';
2460 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002461 }
2462 else if (skipnextlf && c == '\n') {
2463 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002464 skipnextlf = 0;
2465 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002466 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002467 }
2468 else {
2469 /* Normal char to be stored in buffer. Also
2470 * update the newlinetypes flag if either this
2471 * is an LF or the previous char was a CR.
2472 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002473 if (c == '\n')
2474 newlinetypes |= NEWLINE_LF;
2475 else if (skipnextlf)
2476 newlinetypes |= NEWLINE_CR;
2477 *dst++ = c;
2478 skipnextlf = 0;
2479 }
2480 }
Tim Peters058b1412002-04-21 07:29:14 +00002481 if (shortread) {
2482 /* If this is EOF, update type flags. */
2483 if (skipnextlf && feof(stream))
2484 newlinetypes |= NEWLINE_CR;
2485 break;
2486 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002487 }
Tim Peters058b1412002-04-21 07:29:14 +00002488 f->f_newlinetypes = newlinetypes;
2489 f->f_skipnextlf = skipnextlf;
2490 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002491}
Anthony Baxterac6bd462006-04-13 02:06:09 +00002492
2493#ifdef __cplusplus
2494}
2495#endif