blob: eb05cdad51e79c86d6628a66400956174814c783 [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);
Christian Heimese93237d2007-12-19 02:37:44 +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') {
Guido van Rossumad8fb0d2007-09-22 20:18:03 +0000721 f->f_newlinetypes |= NEWLINE_CRLF;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000722 pos++;
723 f->f_skipnextlf = 0;
724 } else if (c != EOF) ungetc(c, f->f_fp);
725 }
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000726#if !defined(HAVE_LARGEFILE_SUPPORT)
Trent Mickf29f47b2000-08-11 19:02:59 +0000727 return PyInt_FromLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000728#else
Trent Mickf29f47b2000-08-11 19:02:59 +0000729 return PyLong_FromLongLong(pos);
Guido van Rossum3c9fe0c1999-01-06 18:51:17 +0000730#endif
Guido van Rossumce5ba841991-03-06 13:06:18 +0000731}
732
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000733static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000734file_fileno(PyFileObject *f)
Guido van Rossumed233a51992-06-23 09:07:03 +0000735{
Guido van Rossumd7297e61992-07-06 14:19:26 +0000736 if (f->f_fp == NULL)
737 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000738 return PyInt_FromLong((long) fileno(f->f_fp));
Guido van Rossumed233a51992-06-23 09:07:03 +0000739}
740
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000741static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000742file_flush(PyFileObject *f)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000743{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000744 int res;
Tim Peters86821b22001-01-07 21:19:34 +0000745
Guido van Rossumd7297e61992-07-06 14:19:26 +0000746 if (f->f_fp == NULL)
747 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000748 Py_BEGIN_ALLOW_THREADS
Guido van Rossumce5ba841991-03-06 13:06:18 +0000749 errno = 0;
Guido van Rossumff4949e1992-08-05 19:58:53 +0000750 res = fflush(f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000751 Py_END_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000752 if (res != 0) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000753 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +0000754 clearerr(f->f_fp);
755 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000756 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000757 Py_INCREF(Py_None);
758 return Py_None;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000759}
760
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000761static PyObject *
Martin v. Löwise3eb1f22001-08-16 13:15:00 +0000762file_isatty(PyFileObject *f)
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000763{
Guido van Rossumff4949e1992-08-05 19:58:53 +0000764 long res;
Guido van Rossumd7297e61992-07-06 14:19:26 +0000765 if (f->f_fp == NULL)
766 return err_closed();
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000767 Py_BEGIN_ALLOW_THREADS
Guido van Rossumff4949e1992-08-05 19:58:53 +0000768 res = isatty((int)fileno(f->f_fp));
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000769 Py_END_ALLOW_THREADS
Guido van Rossum7f7666f2002-04-07 06:28:00 +0000770 return PyBool_FromLong(res);
Guido van Rossuma1ab7fa1991-06-04 19:37:39 +0000771}
772
Guido van Rossumff7e83d1999-08-27 20:39:37 +0000773
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000774#if BUFSIZ < 8192
775#define SMALLCHUNK 8192
776#else
777#define SMALLCHUNK BUFSIZ
778#endif
779
Guido van Rossum3c259041999-01-14 19:00:14 +0000780#if SIZEOF_INT < 4
781#define BIGCHUNK (512 * 32)
782#else
783#define BIGCHUNK (512 * 1024)
784#endif
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000785
786static size_t
Fred Drakefd99de62000-07-09 05:02:18 +0000787new_buffersize(PyFileObject *f, size_t currentsize)
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000788{
789#ifdef HAVE_FSTAT
Fred Drake1bc8fab2001-07-19 21:49:38 +0000790 off_t pos, end;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000791 struct stat st;
792 if (fstat(fileno(f->f_fp), &st) == 0) {
793 end = st.st_size;
Guido van Rossumcada2931998-12-11 20:44:56 +0000794 /* The following is not a bug: we really need to call lseek()
795 *and* ftell(). The reason is that some stdio libraries
796 mistakenly flush their buffer when ftell() is called and
797 the lseek() call it makes fails, thereby throwing away
798 data that cannot be recovered in any way. To avoid this,
799 we first test lseek(), and only call ftell() if lseek()
800 works. We can't use the lseek() value either, because we
801 need to take the amount of buffered data into account.
802 (Yet another reason why stdio stinks. :-) */
Guido van Rossum91aaa921998-05-05 22:21:35 +0000803 pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000804 if (pos >= 0) {
Guido van Rossum91aaa921998-05-05 22:21:35 +0000805 pos = ftell(f->f_fp);
Jack Jansen2771b5b2001-10-10 22:03:27 +0000806 }
Guido van Rossumd30dc0a1998-04-27 19:01:08 +0000807 if (pos < 0)
808 clearerr(f->f_fp);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000809 if (end > pos && pos >= 0)
Guido van Rossumcada2931998-12-11 20:44:56 +0000810 return currentsize + end - pos + 1;
Guido van Rossumdcb5e7f1998-03-03 22:36:10 +0000811 /* Add 1 so if the file were to grow we'd notice. */
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000812 }
813#endif
814 if (currentsize > SMALLCHUNK) {
815 /* Keep doubling until we reach BIGCHUNK;
816 then keep adding BIGCHUNK. */
817 if (currentsize <= BIGCHUNK)
818 return currentsize + currentsize;
819 else
820 return currentsize + BIGCHUNK;
821 }
822 return currentsize + SMALLCHUNK;
823}
824
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000825#if defined(EWOULDBLOCK) && defined(EAGAIN) && EWOULDBLOCK != EAGAIN
826#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK || (x) == EAGAIN)
827#else
828#ifdef EWOULDBLOCK
829#define BLOCKED_ERRNO(x) ((x) == EWOULDBLOCK)
830#else
831#ifdef EAGAIN
832#define BLOCKED_ERRNO(x) ((x) == EAGAIN)
833#else
834#define BLOCKED_ERRNO(x) 0
835#endif
836#endif
837#endif
838
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000839static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000840file_read(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000841{
Guido van Rossum789a1611997-05-10 22:33:55 +0000842 long bytesrequested = -1;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000843 size_t bytesread, buffersize, chunksize;
Guido van Rossumc0b618a1997-05-02 03:12:38 +0000844 PyObject *v;
Tim Peters86821b22001-01-07 21:19:34 +0000845
Guido van Rossumd7297e61992-07-06 14:19:26 +0000846 if (f->f_fp == NULL)
847 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000848 /* refuse to mix with f.next() */
849 if (f->f_buf != NULL &&
850 (f->f_bufend - f->f_bufptr) > 0 &&
851 f->f_buf[0] != '\0')
852 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +0000853 if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested))
Guido van Rossum789a1611997-05-10 22:33:55 +0000854 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000855 if (bytesrequested < 0)
Guido van Rossumff1ccbf1999-04-10 15:48:23 +0000856 buffersize = new_buffersize(f, (size_t)0);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000857 else
858 buffersize = bytesrequested;
Martin v. Löwis2a190742006-04-13 07:37:25 +0000859 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +0000860 PyErr_SetString(PyExc_OverflowError,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000861 "requested number of bytes is more than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +0000862 return NULL;
863 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000864 v = PyString_FromStringAndSize((char *)NULL, buffersize);
Guido van Rossum3f5da241990-12-20 15:06:42 +0000865 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000866 return NULL;
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000867 bytesread = 0;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000868 for (;;) {
Guido van Rossum6263d541997-05-10 22:07:25 +0000869 Py_BEGIN_ALLOW_THREADS
870 errno = 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +0000871 chunksize = Py_UniversalNewlineFread(BUF(v) + bytesread,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000872 buffersize - bytesread, f->f_fp, (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000873 Py_END_ALLOW_THREADS
874 if (chunksize == 0) {
875 if (!ferror(f->f_fp))
876 break;
Guido van Rossum6263d541997-05-10 22:07:25 +0000877 clearerr(f->f_fp);
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000878 /* When in non-blocking mode, data shouldn't
879 * be discarded if a blocking signal was
880 * received. That will also happen if
881 * chunksize != 0, but bytesread < buffersize. */
882 if (bytesread > 0 && BLOCKED_ERRNO(errno))
883 break;
884 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossum6263d541997-05-10 22:07:25 +0000885 Py_DECREF(v);
886 return NULL;
887 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000888 bytesread += chunksize;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000889 if (bytesread < buffersize) {
890 clearerr(f->f_fp);
Guido van Rossumce5ba841991-03-06 13:06:18 +0000891 break;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000892 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000893 if (bytesrequested < 0) {
Guido van Rossumcada2931998-12-11 20:44:56 +0000894 buffersize = new_buffersize(f, buffersize);
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000895 if (_PyString_Resize(&v, buffersize) < 0)
Guido van Rossumce5ba841991-03-06 13:06:18 +0000896 return NULL;
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000897 } else {
Gustavo Niemeyera080be82002-12-17 17:48:00 +0000898 /* Got what was requested. */
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +0000899 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +0000900 }
901 }
Guido van Rossum5449b6e1997-05-09 22:27:31 +0000902 if (bytesread != buffersize)
903 _PyString_Resize(&v, bytesread);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +0000904 return v;
905}
906
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000907static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +0000908file_readinto(PyFileObject *f, PyObject *args)
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000909{
910 char *ptr;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000911 Py_ssize_t ntodo;
912 Py_ssize_t ndone, nnow;
Tim Peters86821b22001-01-07 21:19:34 +0000913
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000914 if (f->f_fp == NULL)
915 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +0000916 /* refuse to mix with f.next() */
917 if (f->f_buf != NULL &&
918 (f->f_bufend - f->f_bufptr) > 0 &&
919 f->f_buf[0] != '\0')
920 return err_iterbuffered();
Neal Norwitz62f5a9d2002-04-01 00:09:00 +0000921 if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo))
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000922 return NULL;
923 ndone = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +0000924 while (ntodo > 0) {
925 Py_BEGIN_ALLOW_THREADS
926 errno = 0;
Tim Petersf1827cf2003-09-07 03:30:18 +0000927 nnow = Py_UniversalNewlineFread(ptr+ndone, ntodo, f->f_fp,
Jeremy Hylton8b735422002-08-14 21:01:41 +0000928 (PyObject *)f);
Guido van Rossum6263d541997-05-10 22:07:25 +0000929 Py_END_ALLOW_THREADS
930 if (nnow == 0) {
931 if (!ferror(f->f_fp))
932 break;
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000933 PyErr_SetFromErrno(PyExc_IOError);
934 clearerr(f->f_fp);
935 return NULL;
936 }
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000937 ndone += nnow;
938 ntodo -= nnow;
939 }
Neal Norwitz076d1e02006-08-21 18:20:10 +0000940 return PyInt_FromSsize_t(ndone);
Guido van Rossumfdf95dd1997-05-05 22:15:02 +0000941}
942
Tim Peters86821b22001-01-07 21:19:34 +0000943/**************************************************************************
Tim Petersf29b64d2001-01-15 06:33:19 +0000944Routine to get next line using platform fgets().
Tim Peters86821b22001-01-07 21:19:34 +0000945
946Under MSVC 6:
947
Tim Peters1c733232001-01-08 04:02:07 +0000948+ MS threadsafe getc is very slow (multiple layers of function calls before+
949 after each character, to lock+unlock the stream).
950+ The stream-locking functions are MS-internal -- can't access them from user
951 code.
952+ There's nothing Tim could find in the MS C or platform SDK libraries that
953 can worm around this.
Tim Peters86821b22001-01-07 21:19:34 +0000954+ MS fgets locks/unlocks only once per line; it's the only hook we have.
955
956So we use fgets for speed(!), despite that it's painful.
957
958MS realloc is also slow.
959
Tim Petersf29b64d2001-01-15 06:33:19 +0000960Reports from other platforms on this method vs getc_unlocked (which MS doesn't
961have):
962 Linux a wash
963 Solaris a wash
964 Tru64 Unix getline_via_fgets significantly faster
Tim Peters86821b22001-01-07 21:19:34 +0000965
Tim Petersf29b64d2001-01-15 06:33:19 +0000966CAUTION: The C std isn't clear about this: in those cases where fgets
967writes something into the buffer, can it write into any position beyond the
968required trailing null byte? MSVC 6 fgets does not, and no platform is (yet)
969known on which it does; and it would be a strange way to code fgets. Still,
970getline_via_fgets may not work correctly if it does. The std test
971test_bufio.py should fail if platform fgets() routinely writes beyond the
972trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code.
Tim Peters86821b22001-01-07 21:19:34 +0000973**************************************************************************/
974
Tim Petersf29b64d2001-01-15 06:33:19 +0000975/* Use this routine if told to, or by default on non-get_unlocked()
976 * platforms unless told not to. Yikes! Let's spell that out:
977 * On a platform with getc_unlocked():
978 * By default, use getc_unlocked().
979 * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE.
980 * On a platform without getc_unlocked():
981 * By default, use fgets().
982 * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE.
983 */
984#if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED)
985#define USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000986#endif
987
Tim Petersf29b64d2001-01-15 06:33:19 +0000988#if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE)
989#undef USE_FGETS_IN_GETLINE
990#endif
991
992#ifdef USE_FGETS_IN_GETLINE
Tim Peters86821b22001-01-07 21:19:34 +0000993static PyObject*
Tim Petersf29b64d2001-01-15 06:33:19 +0000994getline_via_fgets(FILE *fp)
Tim Peters86821b22001-01-07 21:19:34 +0000995{
Tim Peters15b83852001-01-08 00:53:12 +0000996/* INITBUFSIZE is the maximum line length that lets us get away with the fast
Tim Peters142297a2001-01-15 10:36:56 +0000997 * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have
998 * to fill this much of the buffer with a known value in order to figure out
999 * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger
1000 * than "most" lines, we waste time filling unused buffer slots. 100 is
1001 * surely adequate for most peoples' email archives, chewing over source code,
1002 * etc -- "regular old text files".
1003 * MAXBUFSIZE is the maximum line length that lets us get away with the less
1004 * fast (but still zippy) no-realloc, two-fgets()-call path. See above for
1005 * cautions about boosting that. 300 was chosen because the worst real-life
1006 * text-crunching job reported on Python-Dev was a mail-log crawler where over
1007 * half the lines were 254 chars.
Tim Peters15b83852001-01-08 00:53:12 +00001008 */
Tim Peters142297a2001-01-15 10:36:56 +00001009#define INITBUFSIZE 100
1010#define MAXBUFSIZE 300
Tim Peters142297a2001-01-15 10:36:56 +00001011 char* p; /* temp */
1012 char buf[MAXBUFSIZE];
Tim Peters86821b22001-01-07 21:19:34 +00001013 PyObject* v; /* the string object result */
Tim Peters86821b22001-01-07 21:19:34 +00001014 char* pvfree; /* address of next free slot */
1015 char* pvend; /* address one beyond last free slot */
Tim Peters142297a2001-01-15 10:36:56 +00001016 size_t nfree; /* # of free buffer slots; pvend-pvfree */
1017 size_t total_v_size; /* total # of slots in buffer */
Tim Petersddea2082002-03-23 10:03:50 +00001018 size_t increment; /* amount to increment the buffer */
Armin Rigo7ccbca92006-10-04 12:17:45 +00001019 size_t prev_v_size;
Tim Peters86821b22001-01-07 21:19:34 +00001020
Tim Peters15b83852001-01-08 00:53:12 +00001021 /* Optimize for normal case: avoid _PyString_Resize if at all
Tim Peters142297a2001-01-15 10:36:56 +00001022 * possible via first reading into stack buffer "buf".
Tim Peters15b83852001-01-08 00:53:12 +00001023 */
Tim Peters142297a2001-01-15 10:36:56 +00001024 total_v_size = INITBUFSIZE; /* start small and pray */
1025 pvfree = buf;
1026 for (;;) {
1027 Py_BEGIN_ALLOW_THREADS
1028 pvend = buf + total_v_size;
1029 nfree = pvend - pvfree;
1030 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001031 assert(nfree < INT_MAX); /* Should be atmost MAXBUFSIZE */
1032 p = fgets(pvfree, (int)nfree, fp);
Tim Peters142297a2001-01-15 10:36:56 +00001033 Py_END_ALLOW_THREADS
Tim Peters15b83852001-01-08 00:53:12 +00001034
Tim Peters142297a2001-01-15 10:36:56 +00001035 if (p == NULL) {
1036 clearerr(fp);
1037 if (PyErr_CheckSignals())
1038 return NULL;
1039 v = PyString_FromStringAndSize(buf, pvfree - buf);
Tim Peters86821b22001-01-07 21:19:34 +00001040 return v;
1041 }
Tim Peters142297a2001-01-15 10:36:56 +00001042 /* fgets read *something* */
1043 p = memchr(pvfree, '\n', nfree);
1044 if (p != NULL) {
1045 /* Did the \n come from fgets or from us?
1046 * Since fgets stops at the first \n, and then writes
1047 * \0, if it's from fgets a \0 must be next. But if
1048 * that's so, it could not have come from us, since
1049 * the \n's we filled the buffer with have only more
1050 * \n's to the right.
1051 */
1052 if (p+1 < pvend && *(p+1) == '\0') {
1053 /* It's from fgets: we win! In particular,
1054 * we haven't done any mallocs yet, and can
1055 * build the final result on the first try.
1056 */
1057 ++p; /* include \n from fgets */
1058 }
1059 else {
1060 /* Must be from us: fgets didn't fill the
1061 * buffer and didn't find a newline, so it
1062 * must be the last and newline-free line of
1063 * the file.
1064 */
1065 assert(p > pvfree && *(p-1) == '\0');
1066 --p; /* don't include \0 from fgets */
1067 }
1068 v = PyString_FromStringAndSize(buf, p - buf);
1069 return v;
1070 }
1071 /* yuck: fgets overwrote all the newlines, i.e. the entire
1072 * buffer. So this line isn't over yet, or maybe it is but
1073 * we're exactly at EOF. If we haven't already, try using the
1074 * rest of the stack buffer.
Tim Peters86821b22001-01-07 21:19:34 +00001075 */
Tim Peters142297a2001-01-15 10:36:56 +00001076 assert(*(pvend-1) == '\0');
1077 if (pvfree == buf) {
1078 pvfree = pvend - 1; /* overwrite trailing null */
1079 total_v_size = MAXBUFSIZE;
1080 }
1081 else
1082 break;
Tim Peters86821b22001-01-07 21:19:34 +00001083 }
Tim Peters142297a2001-01-15 10:36:56 +00001084
1085 /* The stack buffer isn't big enough; malloc a string object and read
1086 * into its buffer.
Tim Peters15b83852001-01-08 00:53:12 +00001087 */
Tim Petersddea2082002-03-23 10:03:50 +00001088 total_v_size = MAXBUFSIZE << 1;
Tim Peters1c733232001-01-08 04:02:07 +00001089 v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size);
Tim Peters15b83852001-01-08 00:53:12 +00001090 if (v == NULL)
1091 return v;
1092 /* copy over everything except the last null byte */
Tim Peters142297a2001-01-15 10:36:56 +00001093 memcpy(BUF(v), buf, MAXBUFSIZE-1);
1094 pvfree = BUF(v) + MAXBUFSIZE - 1;
Tim Peters86821b22001-01-07 21:19:34 +00001095
1096 /* Keep reading stuff into v; if it ever ends successfully, break
Tim Peters15b83852001-01-08 00:53:12 +00001097 * after setting p one beyond the end of the line. The code here is
1098 * very much like the code above, except reads into v's buffer; see
1099 * the code above for detailed comments about the logic.
Tim Peters86821b22001-01-07 21:19:34 +00001100 */
1101 for (;;) {
Tim Peters86821b22001-01-07 21:19:34 +00001102 Py_BEGIN_ALLOW_THREADS
1103 pvend = BUF(v) + total_v_size;
1104 nfree = pvend - pvfree;
1105 memset(pvfree, '\n', nfree);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001106 assert(nfree < INT_MAX);
1107 p = fgets(pvfree, (int)nfree, fp);
Tim Peters86821b22001-01-07 21:19:34 +00001108 Py_END_ALLOW_THREADS
1109
1110 if (p == NULL) {
1111 clearerr(fp);
1112 if (PyErr_CheckSignals()) {
1113 Py_DECREF(v);
1114 return NULL;
1115 }
1116 p = pvfree;
1117 break;
1118 }
Tim Peters86821b22001-01-07 21:19:34 +00001119 p = memchr(pvfree, '\n', nfree);
1120 if (p != NULL) {
1121 if (p+1 < pvend && *(p+1) == '\0') {
1122 /* \n came from fgets */
1123 ++p;
1124 break;
1125 }
1126 /* \n came from us; last line of file, no newline */
1127 assert(p > pvfree && *(p-1) == '\0');
1128 --p;
1129 break;
1130 }
1131 /* expand buffer and try again */
1132 assert(*(pvend-1) == '\0');
Tim Petersddea2082002-03-23 10:03:50 +00001133 increment = total_v_size >> 2; /* mild exponential growth */
Armin Rigo7ccbca92006-10-04 12:17:45 +00001134 prev_v_size = total_v_size;
Tim Petersddea2082002-03-23 10:03:50 +00001135 total_v_size += increment;
Armin Rigo7ccbca92006-10-04 12:17:45 +00001136 /* check for overflow */
1137 if (total_v_size <= prev_v_size ||
1138 total_v_size > PY_SSIZE_T_MAX) {
Tim Peters86821b22001-01-07 21:19:34 +00001139 PyErr_SetString(PyExc_OverflowError,
1140 "line is longer than a Python string can hold");
1141 Py_DECREF(v);
1142 return NULL;
1143 }
1144 if (_PyString_Resize(&v, (int)total_v_size) < 0)
1145 return NULL;
1146 /* overwrite the trailing null byte */
Armin Rigo7ccbca92006-10-04 12:17:45 +00001147 pvfree = BUF(v) + (prev_v_size - 1);
Tim Peters86821b22001-01-07 21:19:34 +00001148 }
1149 if (BUF(v) + total_v_size != p)
1150 _PyString_Resize(&v, p - BUF(v));
1151 return v;
1152#undef INITBUFSIZE
Tim Peters142297a2001-01-15 10:36:56 +00001153#undef MAXBUFSIZE
Tim Peters86821b22001-01-07 21:19:34 +00001154}
Tim Petersf29b64d2001-01-15 06:33:19 +00001155#endif /* ifdef USE_FGETS_IN_GETLINE */
Guido van Rossumfdf95dd1997-05-05 22:15:02 +00001156
Guido van Rossum0bd24411991-04-04 15:21:57 +00001157/* Internal routine to get a line.
1158 Size argument interpretation:
1159 > 0: max length;
Guido van Rossum86282062001-01-08 01:26:47 +00001160 <= 0: read arbitrary line
Guido van Rossumce5ba841991-03-06 13:06:18 +00001161*/
1162
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001163static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001164get_line(PyFileObject *f, int n)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001165{
Guido van Rossum1187aa42001-01-05 14:43:05 +00001166 FILE *fp = f->f_fp;
1167 int c;
Andrew M. Kuchling4b2b4452000-11-29 02:53:22 +00001168 char *buf, *end;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001169 size_t total_v_size; /* total # of slots in buffer */
1170 size_t used_v_size; /* # used slots in buffer */
1171 size_t increment; /* amount to increment the buffer */
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001172 PyObject *v;
Jack Jansen7b8c7542002-04-14 20:12:41 +00001173 int newlinetypes = f->f_newlinetypes;
1174 int skipnextlf = f->f_skipnextlf;
1175 int univ_newline = f->f_univ_newline;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001176
Jack Jansen7b8c7542002-04-14 20:12:41 +00001177#if defined(USE_FGETS_IN_GETLINE)
Jack Jansen7b8c7542002-04-14 20:12:41 +00001178 if (n <= 0 && !univ_newline )
Tim Petersf29b64d2001-01-15 06:33:19 +00001179 return getline_via_fgets(fp);
Tim Peters86821b22001-01-07 21:19:34 +00001180#endif
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001181 total_v_size = n > 0 ? n : 100;
1182 v = PyString_FromStringAndSize((char *)NULL, total_v_size);
Guido van Rossum3f5da241990-12-20 15:06:42 +00001183 if (v == NULL)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001184 return NULL;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001185 buf = BUF(v);
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001186 end = buf + total_v_size;
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001187
Guido van Rossumce5ba841991-03-06 13:06:18 +00001188 for (;;) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001189 Py_BEGIN_ALLOW_THREADS
1190 FLOCKFILE(fp);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001191 if (univ_newline) {
1192 c = 'x'; /* Shut up gcc warning */
1193 while ( buf != end && (c = GETC(fp)) != EOF ) {
1194 if (skipnextlf ) {
1195 skipnextlf = 0;
1196 if (c == '\n') {
Tim Petersf1827cf2003-09-07 03:30:18 +00001197 /* Seeing a \n here with
1198 * skipnextlf true means we
Jeremy Hylton8b735422002-08-14 21:01:41 +00001199 * saw a \r before.
1200 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001201 newlinetypes |= NEWLINE_CRLF;
1202 c = GETC(fp);
1203 if (c == EOF) break;
1204 } else {
1205 newlinetypes |= NEWLINE_CR;
1206 }
1207 }
1208 if (c == '\r') {
1209 skipnextlf = 1;
1210 c = '\n';
1211 } else if ( c == '\n')
1212 newlinetypes |= NEWLINE_LF;
1213 *buf++ = c;
1214 if (c == '\n') break;
1215 }
1216 if ( c == EOF && skipnextlf )
1217 newlinetypes |= NEWLINE_CR;
1218 } else /* If not universal newlines use the normal loop */
Guido van Rossum1187aa42001-01-05 14:43:05 +00001219 while ((c = GETC(fp)) != EOF &&
1220 (*buf++ = c) != '\n' &&
1221 buf != end)
1222 ;
1223 FUNLOCKFILE(fp);
1224 Py_END_ALLOW_THREADS
Jack Jansen7b8c7542002-04-14 20:12:41 +00001225 f->f_newlinetypes = newlinetypes;
1226 f->f_skipnextlf = skipnextlf;
Guido van Rossum1187aa42001-01-05 14:43:05 +00001227 if (c == '\n')
1228 break;
1229 if (c == EOF) {
Guido van Rossum29206bc2001-08-09 18:14:59 +00001230 if (ferror(fp)) {
1231 PyErr_SetFromErrno(PyExc_IOError);
1232 clearerr(fp);
1233 Py_DECREF(v);
1234 return NULL;
1235 }
Guido van Rossum76ad8ed1991-06-03 10:54:55 +00001236 clearerr(fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001237 if (PyErr_CheckSignals()) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001238 Py_DECREF(v);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001239 return NULL;
1240 }
Guido van Rossumce5ba841991-03-06 13:06:18 +00001241 break;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001242 }
Guido van Rossum1187aa42001-01-05 14:43:05 +00001243 /* Must be because buf == end */
1244 if (n > 0)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001245 break;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001246 used_v_size = total_v_size;
1247 increment = total_v_size >> 2; /* mild exponential growth */
1248 total_v_size += increment;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001249 if (total_v_size > PY_SSIZE_T_MAX) {
Guido van Rossum1187aa42001-01-05 14:43:05 +00001250 PyErr_SetString(PyExc_OverflowError,
1251 "line is longer than a Python string can hold");
Tim Peters86821b22001-01-07 21:19:34 +00001252 Py_DECREF(v);
Guido van Rossum1187aa42001-01-05 14:43:05 +00001253 return NULL;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001254 }
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001255 if (_PyString_Resize(&v, total_v_size) < 0)
Guido van Rossum1187aa42001-01-05 14:43:05 +00001256 return NULL;
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001257 buf = BUF(v) + used_v_size;
1258 end = BUF(v) + total_v_size;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001259 }
Guido van Rossum1984f1e1992-08-04 12:41:02 +00001260
Neil Schemenauer3a204a72002-03-23 19:41:34 +00001261 used_v_size = buf - BUF(v);
1262 if (used_v_size != total_v_size)
1263 _PyString_Resize(&v, used_v_size);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001264 return v;
1265}
1266
Guido van Rossum0bd24411991-04-04 15:21:57 +00001267/* External C interface */
1268
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001269PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001270PyFile_GetLine(PyObject *f, int n)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001271{
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001272 PyObject *result;
1273
Guido van Rossum3165fe61992-09-25 21:59:05 +00001274 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001275 PyErr_BadInternalCall();
Guido van Rossum0bd24411991-04-04 15:21:57 +00001276 return NULL;
1277 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001278
1279 if (PyFile_Check(f)) {
Thomas Woutersc45251a2006-02-12 11:53:32 +00001280 PyFileObject *fo = (PyFileObject *)f;
1281 if (fo->f_fp == NULL)
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001282 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001283 /* refuse to mix with f.next() */
1284 if (fo->f_buf != NULL &&
1285 (fo->f_bufend - fo->f_bufptr) > 0 &&
1286 fo->f_buf[0] != '\0')
1287 return err_iterbuffered();
1288 result = get_line(fo, n);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001289 }
1290 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001291 PyObject *reader;
1292 PyObject *args;
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001293
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001294 reader = PyObject_GetAttrString(f, "readline");
Guido van Rossum3165fe61992-09-25 21:59:05 +00001295 if (reader == NULL)
1296 return NULL;
1297 if (n <= 0)
Raymond Hettinger8ae46892003-10-12 19:09:37 +00001298 args = PyTuple_New(0);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001299 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001300 args = Py_BuildValue("(i)", n);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001301 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001302 Py_DECREF(reader);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001303 return NULL;
1304 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001305 result = PyEval_CallObject(reader, args);
1306 Py_DECREF(reader);
1307 Py_DECREF(args);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001308 if (result != NULL && !PyString_Check(result) &&
1309 !PyUnicode_Check(result)) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001310 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00001311 result = NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001312 PyErr_SetString(PyExc_TypeError,
Guido van Rossum3165fe61992-09-25 21:59:05 +00001313 "object.readline() returned non-string");
1314 }
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001315 }
1316
1317 if (n < 0 && result != NULL && PyString_Check(result)) {
1318 char *s = PyString_AS_STRING(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001319 Py_ssize_t len = PyString_GET_SIZE(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001320 if (len == 0) {
1321 Py_DECREF(result);
1322 result = NULL;
1323 PyErr_SetString(PyExc_EOFError,
1324 "EOF when reading a line");
1325 }
1326 else if (s[len-1] == '\n') {
1327 if (result->ob_refcnt == 1)
1328 _PyString_Resize(&result, len-1);
1329 else {
1330 PyObject *v;
1331 v = PyString_FromStringAndSize(s, len-1);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001332 Py_DECREF(result);
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001333 result = v;
Guido van Rossum3165fe61992-09-25 21:59:05 +00001334 }
1335 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00001336 }
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001337#ifdef Py_USING_UNICODE
1338 if (n < 0 && result != NULL && PyUnicode_Check(result)) {
1339 Py_UNICODE *s = PyUnicode_AS_UNICODE(result);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001340 Py_ssize_t len = PyUnicode_GET_SIZE(result);
Martin v. Löwisaf6a27a2003-01-03 19:16:14 +00001341 if (len == 0) {
1342 Py_DECREF(result);
1343 result = NULL;
1344 PyErr_SetString(PyExc_EOFError,
1345 "EOF when reading a line");
1346 }
1347 else if (s[len-1] == '\n') {
1348 if (result->ob_refcnt == 1)
1349 PyUnicode_Resize(&result, len-1);
1350 else {
1351 PyObject *v;
1352 v = PyUnicode_FromUnicode(s, len-1);
1353 Py_DECREF(result);
1354 result = v;
1355 }
1356 }
1357 }
1358#endif
Guido van Rossum4ddf0a02001-01-07 20:51:39 +00001359 return result;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001360}
1361
1362/* Python method */
1363
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001364static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001365file_readline(PyFileObject *f, PyObject *args)
Guido van Rossum0bd24411991-04-04 15:21:57 +00001366{
Guido van Rossum789a1611997-05-10 22:33:55 +00001367 int n = -1;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001368
Guido van Rossumd7297e61992-07-06 14:19:26 +00001369 if (f->f_fp == NULL)
1370 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001371 /* refuse to mix with f.next() */
1372 if (f->f_buf != NULL &&
1373 (f->f_bufend - f->f_bufptr) > 0 &&
1374 f->f_buf[0] != '\0')
1375 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001376 if (!PyArg_ParseTuple(args, "|i:readline", &n))
Guido van Rossum789a1611997-05-10 22:33:55 +00001377 return NULL;
1378 if (n == 0)
1379 return PyString_FromString("");
1380 if (n < 0)
1381 n = 0;
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001382 return get_line(f, n);
Guido van Rossum0bd24411991-04-04 15:21:57 +00001383}
1384
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001385static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001386file_readlines(PyFileObject *f, PyObject *args)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001387{
Guido van Rossum789a1611997-05-10 22:33:55 +00001388 long sizehint = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001389 PyObject *list;
1390 PyObject *line;
Guido van Rossum6263d541997-05-10 22:07:25 +00001391 char small_buffer[SMALLCHUNK];
1392 char *buffer = small_buffer;
1393 size_t buffersize = SMALLCHUNK;
1394 PyObject *big_buffer = NULL;
1395 size_t nfilled = 0;
1396 size_t nread;
Guido van Rossum789a1611997-05-10 22:33:55 +00001397 size_t totalread = 0;
Guido van Rossum6263d541997-05-10 22:07:25 +00001398 char *p, *q, *end;
1399 int err;
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001400 int shortread = 0;
Guido van Rossum0bd24411991-04-04 15:21:57 +00001401
Guido van Rossumd7297e61992-07-06 14:19:26 +00001402 if (f->f_fp == NULL)
1403 return err_closed();
Thomas Woutersc45251a2006-02-12 11:53:32 +00001404 /* refuse to mix with f.next() */
1405 if (f->f_buf != NULL &&
1406 (f->f_bufend - f->f_bufptr) > 0 &&
1407 f->f_buf[0] != '\0')
1408 return err_iterbuffered();
Guido van Rossum43713e52000-02-29 13:59:29 +00001409 if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint))
Guido van Rossum0bd24411991-04-04 15:21:57 +00001410 return NULL;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001411 if ((list = PyList_New(0)) == NULL)
Guido van Rossumce5ba841991-03-06 13:06:18 +00001412 return NULL;
1413 for (;;) {
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001414 if (shortread)
1415 nread = 0;
1416 else {
1417 Py_BEGIN_ALLOW_THREADS
1418 errno = 0;
Tim Peters058b1412002-04-21 07:29:14 +00001419 nread = Py_UniversalNewlineFread(buffer+nfilled,
Jack Jansen7b8c7542002-04-14 20:12:41 +00001420 buffersize-nfilled, f->f_fp, (PyObject *)f);
Guido van Rossum79fd0fc2001-10-12 20:01:53 +00001421 Py_END_ALLOW_THREADS
1422 shortread = (nread < buffersize-nfilled);
1423 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001424 if (nread == 0) {
Guido van Rossum789a1611997-05-10 22:33:55 +00001425 sizehint = 0;
Guido van Rossum3da3fce1998-02-19 20:46:48 +00001426 if (!ferror(f->f_fp))
Guido van Rossum6263d541997-05-10 22:07:25 +00001427 break;
1428 PyErr_SetFromErrno(PyExc_IOError);
1429 clearerr(f->f_fp);
1430 error:
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001431 Py_DECREF(list);
Guido van Rossum6263d541997-05-10 22:07:25 +00001432 list = NULL;
1433 goto cleanup;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001434 }
Guido van Rossum789a1611997-05-10 22:33:55 +00001435 totalread += nread;
Anthony Baxter377be112006-04-11 06:54:30 +00001436 p = (char *)memchr(buffer+nfilled, '\n', nread);
Guido van Rossum6263d541997-05-10 22:07:25 +00001437 if (p == NULL) {
1438 /* Need a larger buffer to fit this line */
1439 nfilled += nread;
1440 buffersize *= 2;
Martin v. Löwis2a190742006-04-13 07:37:25 +00001441 if (buffersize > PY_SSIZE_T_MAX) {
Trent Mickf29f47b2000-08-11 19:02:59 +00001442 PyErr_SetString(PyExc_OverflowError,
Guido van Rossume07d5cf2001-01-09 21:50:24 +00001443 "line is longer than a Python string can hold");
Trent Mickf29f47b2000-08-11 19:02:59 +00001444 goto error;
1445 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001446 if (big_buffer == NULL) {
1447 /* Create the big buffer */
1448 big_buffer = PyString_FromStringAndSize(
1449 NULL, buffersize);
1450 if (big_buffer == NULL)
1451 goto error;
1452 buffer = PyString_AS_STRING(big_buffer);
1453 memcpy(buffer, small_buffer, nfilled);
1454 }
1455 else {
1456 /* Grow the big buffer */
Jack Jansen7b8c7542002-04-14 20:12:41 +00001457 if ( _PyString_Resize(&big_buffer, buffersize) < 0 )
1458 goto error;
Guido van Rossum6263d541997-05-10 22:07:25 +00001459 buffer = PyString_AS_STRING(big_buffer);
1460 }
1461 continue;
1462 }
1463 end = buffer+nfilled+nread;
1464 q = buffer;
1465 do {
1466 /* Process complete lines */
1467 p++;
1468 line = PyString_FromStringAndSize(q, p-q);
1469 if (line == NULL)
1470 goto error;
1471 err = PyList_Append(list, line);
1472 Py_DECREF(line);
1473 if (err != 0)
1474 goto error;
1475 q = p;
Anthony Baxter377be112006-04-11 06:54:30 +00001476 p = (char *)memchr(q, '\n', end-q);
Guido van Rossum6263d541997-05-10 22:07:25 +00001477 } while (p != NULL);
1478 /* Move the remaining incomplete line to the start */
1479 nfilled = end-q;
1480 memmove(buffer, q, nfilled);
Guido van Rossum789a1611997-05-10 22:33:55 +00001481 if (sizehint > 0)
1482 if (totalread >= (size_t)sizehint)
1483 break;
Guido van Rossumce5ba841991-03-06 13:06:18 +00001484 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001485 if (nfilled != 0) {
1486 /* Partial last line */
1487 line = PyString_FromStringAndSize(buffer, nfilled);
1488 if (line == NULL)
1489 goto error;
Guido van Rossum789a1611997-05-10 22:33:55 +00001490 if (sizehint > 0) {
1491 /* Need to complete the last line */
Marc-André Lemburg1f468602000-07-05 15:32:40 +00001492 PyObject *rest = get_line(f, 0);
Guido van Rossum789a1611997-05-10 22:33:55 +00001493 if (rest == NULL) {
1494 Py_DECREF(line);
1495 goto error;
1496 }
1497 PyString_Concat(&line, rest);
1498 Py_DECREF(rest);
1499 if (line == NULL)
1500 goto error;
1501 }
Guido van Rossum6263d541997-05-10 22:07:25 +00001502 err = PyList_Append(list, line);
1503 Py_DECREF(line);
1504 if (err != 0)
1505 goto error;
1506 }
1507 cleanup:
Tim Peters5de98422002-04-27 18:44:32 +00001508 Py_XDECREF(big_buffer);
Guido van Rossumce5ba841991-03-06 13:06:18 +00001509 return list;
1510}
1511
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001512static PyObject *
Fred Drakefd99de62000-07-09 05:02:18 +00001513file_write(PyFileObject *f, PyObject *args)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001514{
Guido van Rossumd7297e61992-07-06 14:19:26 +00001515 char *s;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001516 Py_ssize_t n, n2;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001517 if (f->f_fp == NULL)
1518 return err_closed();
Michael W. Hudsone2ec3eb2001-10-31 18:51:01 +00001519 if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n))
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001520 return NULL;
Guido van Rossumeb183da1991-04-04 10:44:06 +00001521 f->f_softspace = 0;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001522 Py_BEGIN_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001523 errno = 0;
Guido van Rossumd7297e61992-07-06 14:19:26 +00001524 n2 = fwrite(s, 1, n, f->f_fp);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001525 Py_END_ALLOW_THREADS
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001526 if (n2 != n) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001527 PyErr_SetFromErrno(PyExc_IOError);
Guido van Rossumfebd5511992-03-04 16:39:24 +00001528 clearerr(f->f_fp);
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001529 return NULL;
1530 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001531 Py_INCREF(Py_None);
1532 return Py_None;
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001533}
1534
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001535static PyObject *
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001536file_writelines(PyFileObject *f, PyObject *seq)
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001537{
Guido van Rossumee70ad12000-03-13 16:27:06 +00001538#define CHUNKSIZE 1000
1539 PyObject *list, *line;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001540 PyObject *it; /* iter(seq) */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001541 PyObject *result;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001542 int index, islist;
1543 Py_ssize_t i, j, nwritten, len;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001544
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001545 assert(seq != NULL);
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001546 if (f->f_fp == NULL)
1547 return err_closed();
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001548
1549 result = NULL;
1550 list = NULL;
1551 islist = PyList_Check(seq);
1552 if (islist)
1553 it = NULL;
1554 else {
1555 it = PyObject_GetIter(seq);
1556 if (it == NULL) {
1557 PyErr_SetString(PyExc_TypeError,
1558 "writelines() requires an iterable argument");
1559 return NULL;
1560 }
1561 /* From here on, fail by going to error, to reclaim "it". */
1562 list = PyList_New(CHUNKSIZE);
1563 if (list == NULL)
1564 goto error;
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001565 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001566
1567 /* Strategy: slurp CHUNKSIZE lines into a private list,
1568 checking that they are all strings, then write that list
1569 without holding the interpreter lock, then come back for more. */
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001570 for (index = 0; ; index += CHUNKSIZE) {
Guido van Rossumee70ad12000-03-13 16:27:06 +00001571 if (islist) {
1572 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001573 list = PyList_GetSlice(seq, index, index+CHUNKSIZE);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001574 if (list == NULL)
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001575 goto error;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001576 j = PyList_GET_SIZE(list);
1577 }
1578 else {
1579 for (j = 0; j < CHUNKSIZE; j++) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001580 line = PyIter_Next(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001581 if (line == NULL) {
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001582 if (PyErr_Occurred())
1583 goto error;
1584 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001585 }
Guido van Rossumee70ad12000-03-13 16:27:06 +00001586 PyList_SetItem(list, j, line);
1587 }
1588 }
1589 if (j == 0)
1590 break;
1591
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001592 /* Check that all entries are indeed strings. If not,
1593 apply the same rules as for file.write() and
1594 convert the results to strings. This is slow, but
1595 seems to be the only way since all conversion APIs
1596 could potentially execute Python code. */
1597 for (i = 0; i < j; i++) {
1598 PyObject *v = PyList_GET_ITEM(list, i);
1599 if (!PyString_Check(v)) {
1600 const char *buffer;
Tim Peters86821b22001-01-07 21:19:34 +00001601 if (((f->f_binary &&
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001602 PyObject_AsReadBuffer(v,
1603 (const void**)&buffer,
1604 &len)) ||
1605 PyObject_AsCharBuffer(v,
1606 &buffer,
1607 &len))) {
1608 PyErr_SetString(PyExc_TypeError,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001609 "writelines() argument must be a sequence of strings");
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001610 goto error;
1611 }
1612 line = PyString_FromStringAndSize(buffer,
1613 len);
1614 if (line == NULL)
1615 goto error;
1616 Py_DECREF(v);
Marc-André Lemburgf5e96fa2000-08-25 22:49:05 +00001617 PyList_SET_ITEM(list, i, line);
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001618 }
1619 }
1620
1621 /* Since we are releasing the global lock, the
1622 following code may *not* execute Python code. */
Guido van Rossumee70ad12000-03-13 16:27:06 +00001623 Py_BEGIN_ALLOW_THREADS
1624 f->f_softspace = 0;
1625 errno = 0;
1626 for (i = 0; i < j; i++) {
Marc-André Lemburg6ef68b52000-08-25 22:39:50 +00001627 line = PyList_GET_ITEM(list, i);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001628 len = PyString_GET_SIZE(line);
1629 nwritten = fwrite(PyString_AS_STRING(line),
1630 1, len, f->f_fp);
1631 if (nwritten != len) {
1632 Py_BLOCK_THREADS
1633 PyErr_SetFromErrno(PyExc_IOError);
1634 clearerr(f->f_fp);
1635 goto error;
1636 }
1637 }
1638 Py_END_ALLOW_THREADS
1639
1640 if (j < CHUNKSIZE)
1641 break;
Guido van Rossumee70ad12000-03-13 16:27:06 +00001642 }
1643
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001644 Py_INCREF(Py_None);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001645 result = Py_None;
1646 error:
1647 Py_XDECREF(list);
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001648 Py_XDECREF(it);
Guido van Rossumee70ad12000-03-13 16:27:06 +00001649 return result;
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001650#undef CHUNKSIZE
Guido van Rossum5a2a6831993-10-25 09:59:04 +00001651}
1652
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001653static PyObject *
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001654file_self(PyFileObject *f)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001655{
1656 if (f->f_fp == NULL)
1657 return err_closed();
1658 Py_INCREF(f);
1659 return (PyObject *)f;
1660}
1661
Georg Brandl98b40ad2006-06-08 14:50:21 +00001662static PyObject *
1663file_exit(PyFileObject *f, PyObject *args)
1664{
1665 PyObject *ret = file_close(f);
1666 if (!ret)
1667 /* If error occurred, pass through */
1668 return NULL;
1669 Py_DECREF(ret);
1670 /* We cannot return the result of close since a true
1671 * value will be interpreted as "yes, swallow the
1672 * exception if one was raised inside the with block". */
1673 Py_RETURN_NONE;
1674}
1675
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001676PyDoc_STRVAR(readline_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001677"readline([size]) -> next line from the file, as a string.\n"
1678"\n"
1679"Retain newline. A non-negative size argument limits the maximum\n"
1680"number of bytes to return (an incomplete line may be returned then).\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001681"Return an empty string at EOF.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001682
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001683PyDoc_STRVAR(read_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001684"read([size]) -> read at most size bytes, returned as a string.\n"
1685"\n"
Gustavo Niemeyer786ddb22002-12-16 18:12:53 +00001686"If the size argument is negative or omitted, read until EOF is reached.\n"
1687"Notice that when in non-blocking mode, less data than what was requested\n"
1688"may be returned, even if no size parameter was given.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001689
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001690PyDoc_STRVAR(write_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001691"write(str) -> None. Write string str to file.\n"
1692"\n"
1693"Note that due to buffering, flush() or close() may be needed before\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001694"the file on disk reflects the data written.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001695
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001696PyDoc_STRVAR(fileno_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001697"fileno() -> integer \"file descriptor\".\n"
1698"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001699"This is needed for lower-level file interfaces, such os.read().");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001700
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001701PyDoc_STRVAR(seek_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001702"seek(offset[, whence]) -> None. Move to new file position.\n"
1703"\n"
1704"Argument offset is a byte count. Optional argument whence defaults to\n"
1705"0 (offset from start of file, offset should be >= 0); other values are 1\n"
1706"(move relative to current position, positive or negative), and 2 (move\n"
1707"relative to end of file, usually negative, although many platforms allow\n"
Martin v. Löwis849a9722003-10-18 09:38:01 +00001708"seeking beyond the end of a file). If the file is opened in text mode,\n"
1709"only offsets returned by tell() are legal. Use of other offsets causes\n"
1710"undefined behavior."
Tim Petersefc3a3a2001-09-20 07:55:22 +00001711"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001712"Note that not all file objects are seekable.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001713
Guido van Rossumd7047b31995-01-02 19:07:15 +00001714#ifdef HAVE_FTRUNCATE
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001715PyDoc_STRVAR(truncate_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001716"truncate([size]) -> None. Truncate the file to at most size bytes.\n"
1717"\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001718"Size defaults to the current file position, as returned by tell().");
Guido van Rossumd7047b31995-01-02 19:07:15 +00001719#endif
Tim Petersefc3a3a2001-09-20 07:55:22 +00001720
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001721PyDoc_STRVAR(tell_doc,
1722"tell() -> current file position, an integer (may be a long integer).");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001723
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001724PyDoc_STRVAR(readinto_doc,
1725"readinto() -> Undocumented. Don't use this; it may go away.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001726
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001727PyDoc_STRVAR(readlines_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001728"readlines([size]) -> list of strings, each a line from the file.\n"
1729"\n"
1730"Call readline() repeatedly and return a list of the lines so read.\n"
1731"The optional size argument, if given, is an approximate bound on the\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001732"total number of bytes in the lines returned.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001733
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001734PyDoc_STRVAR(xreadlines_doc,
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001735"xreadlines() -> returns self.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001736"\n"
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001737"For backward compatibility. File objects now include the performance\n"
1738"optimizations previously implemented in the xreadlines module.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001739
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001740PyDoc_STRVAR(writelines_doc,
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001741"writelines(sequence_of_strings) -> None. Write the strings to the file.\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001742"\n"
Tim Peters2c9aa5e2001-09-23 04:06:05 +00001743"Note that newlines are not added. The sequence can be any iterable object\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001744"producing strings. This is equivalent to calling write() for each string.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001745
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001746PyDoc_STRVAR(flush_doc,
1747"flush() -> None. Flush the internal I/O buffer.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001748
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001749PyDoc_STRVAR(close_doc,
Tim Petersefc3a3a2001-09-20 07:55:22 +00001750"close() -> None or (perhaps) an integer. Close the file.\n"
1751"\n"
Guido van Rossum77f6a652002-04-03 22:41:51 +00001752"Sets data attribute .closed to True. A closed file cannot be used for\n"
Tim Petersefc3a3a2001-09-20 07:55:22 +00001753"further I/O operations. close() may be called more than once without\n"
1754"error. Some kinds of file objects (for example, opened by popen())\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001755"may return an exit status upon closing.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001756
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00001757PyDoc_STRVAR(isatty_doc,
1758"isatty() -> true or false. True if the file is connected to a tty device.");
Tim Petersefc3a3a2001-09-20 07:55:22 +00001759
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001760PyDoc_STRVAR(enter_doc,
1761 "__enter__() -> self.");
1762
Georg Brandl98b40ad2006-06-08 14:50:21 +00001763PyDoc_STRVAR(exit_doc,
1764 "__exit__(*excinfo) -> None. Closes the file.");
1765
Tim Petersefc3a3a2001-09-20 07:55:22 +00001766static PyMethodDef file_methods[] = {
Jeremy Hylton8b735422002-08-14 21:01:41 +00001767 {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc},
1768 {"read", (PyCFunction)file_read, METH_VARARGS, read_doc},
1769 {"write", (PyCFunction)file_write, METH_VARARGS, write_doc},
1770 {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc},
1771 {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001772#ifdef HAVE_FTRUNCATE
Jeremy Hylton8b735422002-08-14 21:01:41 +00001773 {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc},
Tim Petersefc3a3a2001-09-20 07:55:22 +00001774#endif
Jeremy Hylton8b735422002-08-14 21:01:41 +00001775 {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc},
1776 {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc},
1777 {"readlines", (PyCFunction)file_readlines,METH_VARARGS, readlines_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001778 {"xreadlines",(PyCFunction)file_self, METH_NOARGS, xreadlines_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001779 {"writelines",(PyCFunction)file_writelines, METH_O, writelines_doc},
1780 {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc},
1781 {"close", (PyCFunction)file_close, METH_NOARGS, close_doc},
1782 {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc},
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00001783 {"__enter__", (PyCFunction)file_self, METH_NOARGS, enter_doc},
Georg Brandl98b40ad2006-06-08 14:50:21 +00001784 {"__exit__", (PyCFunction)file_exit, METH_VARARGS, exit_doc},
Jeremy Hylton8b735422002-08-14 21:01:41 +00001785 {NULL, NULL} /* sentinel */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001786};
1787
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001788#define OFF(x) offsetof(PyFileObject, x)
Guido van Rossumb6775db1994-08-01 11:34:53 +00001789
Guido van Rossum6f799372001-09-20 20:46:19 +00001790static PyMemberDef file_memberlist[] = {
1791 {"softspace", T_INT, OFF(f_softspace), 0,
1792 "flag indicating that a space needs to be printed; used by print"},
1793 {"mode", T_OBJECT, OFF(f_mode), RO,
Martin v. Löwis6233c9b2002-12-11 13:06:53 +00001794 "file mode ('r', 'U', 'w', 'a', possibly with 'b' or '+' added)"},
Guido van Rossum6f799372001-09-20 20:46:19 +00001795 {"name", T_OBJECT, OFF(f_name), RO,
1796 "file name"},
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001797 {"encoding", T_OBJECT, OFF(f_encoding), RO,
1798 "file encoding"},
Guido van Rossumb6775db1994-08-01 11:34:53 +00001799 /* getattr(f, "closed") is implemented without this table */
Guido van Rossumb6775db1994-08-01 11:34:53 +00001800 {NULL} /* Sentinel */
1801};
1802
Guido van Rossumc0b618a1997-05-02 03:12:38 +00001803static PyObject *
Tim Peters6d6c1a32001-08-02 04:15:00 +00001804get_closed(PyFileObject *f, void *closure)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001805{
Guido van Rossum77f6a652002-04-03 22:41:51 +00001806 return PyBool_FromLong((long)(f->f_fp == 0));
Guido van Rossumb6775db1994-08-01 11:34:53 +00001807}
Jack Jansen7b8c7542002-04-14 20:12:41 +00001808static PyObject *
1809get_newlines(PyFileObject *f, void *closure)
1810{
1811 switch (f->f_newlinetypes) {
1812 case NEWLINE_UNKNOWN:
1813 Py_INCREF(Py_None);
1814 return Py_None;
1815 case NEWLINE_CR:
1816 return PyString_FromString("\r");
1817 case NEWLINE_LF:
1818 return PyString_FromString("\n");
1819 case NEWLINE_CR|NEWLINE_LF:
1820 return Py_BuildValue("(ss)", "\r", "\n");
1821 case NEWLINE_CRLF:
1822 return PyString_FromString("\r\n");
1823 case NEWLINE_CR|NEWLINE_CRLF:
1824 return Py_BuildValue("(ss)", "\r", "\r\n");
1825 case NEWLINE_LF|NEWLINE_CRLF:
1826 return Py_BuildValue("(ss)", "\n", "\r\n");
1827 case NEWLINE_CR|NEWLINE_LF|NEWLINE_CRLF:
1828 return Py_BuildValue("(sss)", "\r", "\n", "\r\n");
1829 default:
Tim Petersf1827cf2003-09-07 03:30:18 +00001830 PyErr_Format(PyExc_SystemError,
1831 "Unknown newlines value 0x%x\n",
Jeremy Hylton8b735422002-08-14 21:01:41 +00001832 f->f_newlinetypes);
Jack Jansen7b8c7542002-04-14 20:12:41 +00001833 return NULL;
1834 }
1835}
Guido van Rossumb6775db1994-08-01 11:34:53 +00001836
Guido van Rossum32d34c82001-09-20 21:45:26 +00001837static PyGetSetDef file_getsetlist[] = {
Guido van Rossum77f6a652002-04-03 22:41:51 +00001838 {"closed", (getter)get_closed, NULL, "True if the file is closed"},
Tim Petersf1827cf2003-09-07 03:30:18 +00001839 {"newlines", (getter)get_newlines, NULL,
Jeremy Hylton8b735422002-08-14 21:01:41 +00001840 "end-of-line convention used in this file"},
Tim Peters6d6c1a32001-08-02 04:15:00 +00001841 {0},
1842};
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00001843
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001844static void
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001845drop_readahead(PyFileObject *f)
Guido van Rossum65967252001-04-21 13:20:18 +00001846{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001847 if (f->f_buf != NULL) {
1848 PyMem_Free(f->f_buf);
1849 f->f_buf = NULL;
1850 }
Guido van Rossum65967252001-04-21 13:20:18 +00001851}
1852
Tim Petersf1827cf2003-09-07 03:30:18 +00001853/* Make sure that file has a readahead buffer with at least one byte
1854 (unless at EOF) and no more than bufsize. Returns negative value on
Georg Brandled02eb62006-03-31 20:31:02 +00001855 error, will set MemoryError if bufsize bytes cannot be allocated. */
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001856static int
1857readahead(PyFileObject *f, int bufsize)
1858{
Martin v. Löwis18e16552006-02-15 17:27:45 +00001859 Py_ssize_t chunksize;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001860
1861 if (f->f_buf != NULL) {
Tim Petersf1827cf2003-09-07 03:30:18 +00001862 if( (f->f_bufend - f->f_bufptr) >= 1)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001863 return 0;
1864 else
1865 drop_readahead(f);
1866 }
Anthony Baxter377be112006-04-11 06:54:30 +00001867 if ((f->f_buf = (char *)PyMem_Malloc(bufsize)) == NULL) {
Georg Brandled02eb62006-03-31 20:31:02 +00001868 PyErr_NoMemory();
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001869 return -1;
1870 }
1871 Py_BEGIN_ALLOW_THREADS
1872 errno = 0;
1873 chunksize = Py_UniversalNewlineFread(
1874 f->f_buf, bufsize, f->f_fp, (PyObject *)f);
1875 Py_END_ALLOW_THREADS
1876 if (chunksize == 0) {
1877 if (ferror(f->f_fp)) {
1878 PyErr_SetFromErrno(PyExc_IOError);
1879 clearerr(f->f_fp);
1880 drop_readahead(f);
1881 return -1;
1882 }
1883 }
1884 f->f_bufptr = f->f_buf;
1885 f->f_bufend = f->f_buf + chunksize;
1886 return 0;
1887}
1888
1889/* Used by file_iternext. The returned string will start with 'skip'
Tim Petersf1827cf2003-09-07 03:30:18 +00001890 uninitialized bytes followed by the remainder of the line. Don't be
1891 horrified by the recursive call: maximum recursion depth is limited by
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001892 logarithmic buffer growth to about 50 even when reading a 1gb line. */
1893
Neal Norwitzd8b995f2002-08-06 21:50:54 +00001894static PyStringObject *
1895readahead_get_line_skip(PyFileObject *f, int skip, int bufsize)
1896{
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001897 PyStringObject* s;
1898 char *bufptr;
1899 char *buf;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001900 Py_ssize_t len;
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001901
1902 if (f->f_buf == NULL)
Tim Petersf1827cf2003-09-07 03:30:18 +00001903 if (readahead(f, bufsize) < 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001904 return NULL;
1905
1906 len = f->f_bufend - f->f_bufptr;
Tim Petersf1827cf2003-09-07 03:30:18 +00001907 if (len == 0)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001908 return (PyStringObject *)
1909 PyString_FromStringAndSize(NULL, skip);
Anthony Baxter377be112006-04-11 06:54:30 +00001910 bufptr = (char *)memchr(f->f_bufptr, '\n', len);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001911 if (bufptr != NULL) {
1912 bufptr++; /* Count the '\n' */
1913 len = bufptr - f->f_bufptr;
1914 s = (PyStringObject *)
1915 PyString_FromStringAndSize(NULL, skip+len);
Tim Petersf1827cf2003-09-07 03:30:18 +00001916 if (s == NULL)
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001917 return NULL;
1918 memcpy(PyString_AS_STRING(s)+skip, f->f_bufptr, len);
1919 f->f_bufptr = bufptr;
1920 if (bufptr == f->f_bufend)
1921 drop_readahead(f);
1922 } else {
1923 bufptr = f->f_bufptr;
1924 buf = f->f_buf;
1925 f->f_buf = NULL; /* Force new readahead buffer */
Martin v. Löwis18e16552006-02-15 17:27:45 +00001926 assert(skip+len < INT_MAX);
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001927 s = readahead_get_line_skip(
Martin v. Löwis18e16552006-02-15 17:27:45 +00001928 f, (int)(skip+len), bufsize + (bufsize>>2) );
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001929 if (s == NULL) {
1930 PyMem_Free(buf);
1931 return NULL;
1932 }
1933 memcpy(PyString_AS_STRING(s)+skip, bufptr, len);
1934 PyMem_Free(buf);
1935 }
1936 return s;
1937}
1938
1939/* A larger buffer size may actually decrease performance. */
1940#define READAHEAD_BUFSIZE 8192
1941
1942static PyObject *
1943file_iternext(PyFileObject *f)
1944{
1945 PyStringObject* l;
1946
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001947 if (f->f_fp == NULL)
1948 return err_closed();
1949
Guido van Rossum7a6e9592002-08-06 15:55:28 +00001950 l = readahead_get_line_skip(f, 0, READAHEAD_BUFSIZE);
1951 if (l == NULL || PyString_GET_SIZE(l) == 0) {
1952 Py_XDECREF(l);
1953 return NULL;
1954 }
1955 return (PyObject *)l;
1956}
1957
1958
Tim Peters59c9a642001-09-13 05:38:56 +00001959static PyObject *
1960file_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
1961{
Tim Peters44410012001-09-14 03:26:08 +00001962 PyObject *self;
1963 static PyObject *not_yet_string;
1964
1965 assert(type != NULL && type->tp_alloc != NULL);
1966
1967 if (not_yet_string == NULL) {
Christian Heimesd7e1b2b2008-01-28 02:07:53 +00001968 not_yet_string = PyString_InternFromString("<uninitialized file>");
Tim Peters44410012001-09-14 03:26:08 +00001969 if (not_yet_string == NULL)
1970 return NULL;
1971 }
1972
1973 self = type->tp_alloc(type, 0);
1974 if (self != NULL) {
1975 /* Always fill in the name and mode, so that nobody else
1976 needs to special-case NULLs there. */
1977 Py_INCREF(not_yet_string);
1978 ((PyFileObject *)self)->f_name = not_yet_string;
1979 Py_INCREF(not_yet_string);
1980 ((PyFileObject *)self)->f_mode = not_yet_string;
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00001981 Py_INCREF(Py_None);
1982 ((PyFileObject *)self)->f_encoding = Py_None;
Raymond Hettingercb87bc82004-05-31 00:35:52 +00001983 ((PyFileObject *)self)->weakreflist = NULL;
Tim Peters44410012001-09-14 03:26:08 +00001984 }
1985 return self;
1986}
1987
1988static int
1989file_init(PyObject *self, PyObject *args, PyObject *kwds)
1990{
1991 PyFileObject *foself = (PyFileObject *)self;
1992 int ret = 0;
Martin v. Löwis15e62742006-02-27 16:46:16 +00001993 static char *kwlist[] = {"name", "mode", "buffering", 0};
Tim Peters59c9a642001-09-13 05:38:56 +00001994 char *name = NULL;
1995 char *mode = "r";
1996 int bufsize = -1;
Mark Hammondc2e85bd2002-10-03 05:10:39 +00001997 int wideargument = 0;
Tim Peters44410012001-09-14 03:26:08 +00001998
1999 assert(PyFile_Check(self));
2000 if (foself->f_fp != NULL) {
2001 /* Have to close the existing file first. */
2002 PyObject *closeresult = file_close(foself);
2003 if (closeresult == NULL)
2004 return -1;
2005 Py_DECREF(closeresult);
2006 }
Tim Peters59c9a642001-09-13 05:38:56 +00002007
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002008#ifdef Py_WIN_WIDE_FILENAMES
2009 if (GetVersion() < 0x80000000) { /* On NT, so wide API available */
2010 PyObject *po;
2011 if (PyArg_ParseTupleAndKeywords(args, kwds, "U|si:file",
2012 kwlist, &po, &mode, &bufsize)) {
2013 wideargument = 1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002014 if (fill_file_fields(foself, NULL, po, mode,
2015 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002016 goto Error;
2017 } else {
2018 /* Drop the argument parsing error as narrow
2019 strings are also valid. */
2020 PyErr_Clear();
2021 }
2022 }
2023#endif
2024
2025 if (!wideargument) {
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002026 PyObject *o_name;
2027
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002028 if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist,
2029 Py_FileSystemDefaultEncoding,
2030 &name,
2031 &mode, &bufsize))
2032 return -1;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002033
2034 /* We parse again to get the name as a PyObject */
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00002035 if (!PyArg_ParseTupleAndKeywords(args, kwds, "O|si:file",
2036 kwlist, &o_name, &mode,
2037 &bufsize))
Brett Cannon2b3666f2006-08-31 18:54:26 +00002038 goto Error;
Nicholas Bastinabce8a62004-03-21 20:24:07 +00002039
2040 if (fill_file_fields(foself, NULL, o_name, mode,
2041 fclose) == NULL)
Mark Hammondc2e85bd2002-10-03 05:10:39 +00002042 goto Error;
2043 }
Tim Peters44410012001-09-14 03:26:08 +00002044 if (open_the_file(foself, name, mode) == NULL)
2045 goto Error;
Martin v. Löwis1e3bdf62003-09-04 19:01:46 +00002046 foself->f_setbuf = NULL;
Tim Peters44410012001-09-14 03:26:08 +00002047 PyFile_SetBufSize(self, bufsize);
2048 goto Done;
2049
2050Error:
2051 ret = -1;
2052 /* fall through */
2053Done:
Tim Peters59c9a642001-09-13 05:38:56 +00002054 PyMem_Free(name); /* free the encoded string */
Tim Peters44410012001-09-14 03:26:08 +00002055 return ret;
Tim Peters59c9a642001-09-13 05:38:56 +00002056}
2057
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002058PyDoc_VAR(file_doc) =
2059PyDoc_STR(
Tim Peters59c9a642001-09-13 05:38:56 +00002060"file(name[, mode[, buffering]]) -> file object\n"
2061"\n"
2062"Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n"
2063"writing or appending. The file will be created if it doesn't exist\n"
2064"when opened for writing or appending; it will be truncated when\n"
2065"opened for writing. Add a 'b' to the mode for binary files.\n"
2066"Add a '+' to the mode to allow simultaneous reading and writing.\n"
2067"If the buffering argument is given, 0 means unbuffered, 1 means line\n"
Skip Montanaro4e3ebe02007-12-08 14:37:43 +00002068"buffered, and larger numbers specify the buffer size. The preferred way\n"
2069"to open a file is with the builtin open() function.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002070)
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002071PyDoc_STR(
Barry Warsaw4be55b52002-05-22 20:37:53 +00002072"Add a 'U' to mode to open the file for input with universal newline\n"
2073"support. Any line ending in the input file will be seen as a '\\n'\n"
2074"in Python. Also, a file so opened gains the attribute 'newlines';\n"
2075"the value for this attribute is one of None (no newline read yet),\n"
2076"'\\r', '\\n', '\\r\\n' or a tuple containing all the newline types seen.\n"
2077"\n"
2078"'U' cannot be combined with 'w' or '+' mode.\n"
Martin v. Löwis14f8b4c2002-06-13 20:33:02 +00002079);
Tim Peters59c9a642001-09-13 05:38:56 +00002080
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002081PyTypeObject PyFile_Type = {
Martin v. Löwis68192102007-07-21 06:55:02 +00002082 PyVarObject_HEAD_INIT(&PyType_Type, 0)
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002083 "file",
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002084 sizeof(PyFileObject),
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002085 0,
Guido van Rossum65967252001-04-21 13:20:18 +00002086 (destructor)file_dealloc, /* tp_dealloc */
2087 0, /* tp_print */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002088 0, /* tp_getattr */
2089 0, /* tp_setattr */
Guido van Rossum65967252001-04-21 13:20:18 +00002090 0, /* tp_compare */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002091 (reprfunc)file_repr, /* tp_repr */
Guido van Rossum65967252001-04-21 13:20:18 +00002092 0, /* tp_as_number */
2093 0, /* tp_as_sequence */
2094 0, /* tp_as_mapping */
2095 0, /* tp_hash */
2096 0, /* tp_call */
2097 0, /* tp_str */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002098 PyObject_GenericGetAttr, /* tp_getattro */
Tim Peters015dd822003-05-04 04:16:52 +00002099 /* softspace is writable: we must supply tp_setattro */
2100 PyObject_GenericSetAttr, /* tp_setattro */
Guido van Rossum65967252001-04-21 13:20:18 +00002101 0, /* tp_as_buffer */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002102 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_WEAKREFS, /* tp_flags */
Tim Peters59c9a642001-09-13 05:38:56 +00002103 file_doc, /* tp_doc */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002104 0, /* tp_traverse */
2105 0, /* tp_clear */
Guido van Rossum65967252001-04-21 13:20:18 +00002106 0, /* tp_richcompare */
Raymond Hettingercb87bc82004-05-31 00:35:52 +00002107 offsetof(PyFileObject, weakreflist), /* tp_weaklistoffset */
Guido van Rossum1a5e21e2006-02-28 21:57:43 +00002108 (getiterfunc)file_self, /* tp_iter */
Guido van Rossum7a6e9592002-08-06 15:55:28 +00002109 (iternextfunc)file_iternext, /* tp_iternext */
Tim Peters6d6c1a32001-08-02 04:15:00 +00002110 file_methods, /* tp_methods */
2111 file_memberlist, /* tp_members */
2112 file_getsetlist, /* tp_getset */
2113 0, /* tp_base */
2114 0, /* tp_dict */
Tim Peters59c9a642001-09-13 05:38:56 +00002115 0, /* tp_descr_get */
2116 0, /* tp_descr_set */
2117 0, /* tp_dictoffset */
Georg Brandl347b3002006-03-30 11:57:00 +00002118 file_init, /* tp_init */
Tim Peters44410012001-09-14 03:26:08 +00002119 PyType_GenericAlloc, /* tp_alloc */
Tim Peters59c9a642001-09-13 05:38:56 +00002120 file_new, /* tp_new */
Neil Schemenaueraa769ae2002-04-12 02:44:10 +00002121 PyObject_Del, /* tp_free */
Guido van Rossum85a5fbb1990-10-14 12:07:46 +00002122};
Guido van Rossumeb183da1991-04-04 10:44:06 +00002123
2124/* Interface for the 'soft space' between print items. */
2125
2126int
Fred Drakefd99de62000-07-09 05:02:18 +00002127PyFile_SoftSpace(PyObject *f, int newflag)
Guido van Rossumeb183da1991-04-04 10:44:06 +00002128{
Martin v. Löwis18e16552006-02-15 17:27:45 +00002129 long oldflag = 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002130 if (f == NULL) {
2131 /* Do nothing */
2132 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002133 else if (PyFile_Check(f)) {
2134 oldflag = ((PyFileObject *)f)->f_softspace;
2135 ((PyFileObject *)f)->f_softspace = newflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002136 }
Guido van Rossum3165fe61992-09-25 21:59:05 +00002137 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002138 PyObject *v;
2139 v = PyObject_GetAttrString(f, "softspace");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002140 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002141 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002142 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002143 if (PyInt_Check(v))
2144 oldflag = PyInt_AsLong(v);
Martin v. Löwis18e16552006-02-15 17:27:45 +00002145 assert(oldflag < INT_MAX);
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002146 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002147 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002148 v = PyInt_FromLong((long)newflag);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002149 if (v == NULL)
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002150 PyErr_Clear();
Guido van Rossum3165fe61992-09-25 21:59:05 +00002151 else {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002152 if (PyObject_SetAttrString(f, "softspace", v) != 0)
2153 PyErr_Clear();
2154 Py_DECREF(v);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002155 }
2156 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002157 return (int)oldflag;
Guido van Rossumeb183da1991-04-04 10:44:06 +00002158}
Guido van Rossum3165fe61992-09-25 21:59:05 +00002159
2160/* Interfaces to write objects/strings to file-like objects */
2161
2162int
Fred Drakefd99de62000-07-09 05:02:18 +00002163PyFile_WriteObject(PyObject *v, PyObject *f, int flags)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002164{
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002165 PyObject *writer, *value, *args, *result;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002166 if (f == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002167 PyErr_SetString(PyExc_TypeError, "writeobject with NULL file");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002168 return -1;
2169 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002170 else if (PyFile_Check(f)) {
2171 FILE *fp = PyFile_AsFile(f);
Fred Drake086a0f72004-03-19 15:22:36 +00002172#ifdef Py_USING_UNICODE
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002173 PyObject *enc = ((PyFileObject*)f)->f_encoding;
2174 int result;
Fred Drake086a0f72004-03-19 15:22:36 +00002175#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002176 if (fp == NULL) {
2177 err_closed();
2178 return -1;
2179 }
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002180#ifdef Py_USING_UNICODE
Tim Petersf1827cf2003-09-07 03:30:18 +00002181 if ((flags & Py_PRINT_RAW) &&
Martin v. Löwis415da6e2003-05-18 12:56:25 +00002182 PyUnicode_Check(v) && enc != Py_None) {
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002183 char *cenc = PyString_AS_STRING(enc);
2184 value = PyUnicode_AsEncodedString(v, cenc, "strict");
2185 if (value == NULL)
2186 return -1;
2187 } else {
2188 value = v;
2189 Py_INCREF(value);
2190 }
2191 result = PyObject_Print(value, fp, flags);
2192 Py_DECREF(value);
2193 return result;
2194#else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002195 return PyObject_Print(v, fp, flags);
Martin v. Löwis5467d4c2003-05-10 07:10:12 +00002196#endif
Guido van Rossum3165fe61992-09-25 21:59:05 +00002197 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002198 writer = PyObject_GetAttrString(f, "write");
Guido van Rossum3165fe61992-09-25 21:59:05 +00002199 if (writer == NULL)
2200 return -1;
Martin v. Löwis2777c022001-09-19 13:47:32 +00002201 if (flags & Py_PRINT_RAW) {
2202 if (PyUnicode_Check(v)) {
2203 value = v;
2204 Py_INCREF(value);
2205 } else
2206 value = PyObject_Str(v);
2207 }
2208 else
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002209 value = PyObject_Repr(v);
Guido van Rossumc6004111993-11-05 10:22:19 +00002210 if (value == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002211 Py_DECREF(writer);
Guido van Rossumc6004111993-11-05 10:22:19 +00002212 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002213 }
Raymond Hettinger8ae46892003-10-12 19:09:37 +00002214 args = PyTuple_Pack(1, value);
Guido van Rossume9eec541997-05-22 14:02:25 +00002215 if (args == NULL) {
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002216 Py_DECREF(value);
2217 Py_DECREF(writer);
Guido van Rossumd3f9a1a1995-07-10 23:32:26 +00002218 return -1;
2219 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002220 result = PyEval_CallObject(writer, args);
2221 Py_DECREF(args);
2222 Py_DECREF(value);
2223 Py_DECREF(writer);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002224 if (result == NULL)
2225 return -1;
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002226 Py_DECREF(result);
Guido van Rossum3165fe61992-09-25 21:59:05 +00002227 return 0;
2228}
2229
Guido van Rossum27a60b11997-05-22 22:25:11 +00002230int
Tim Petersc1bbcb82001-11-28 22:13:25 +00002231PyFile_WriteString(const char *s, PyObject *f)
Guido van Rossum3165fe61992-09-25 21:59:05 +00002232{
2233 if (f == NULL) {
Guido van Rossum27a60b11997-05-22 22:25:11 +00002234 /* Should be caused by a pre-existing error */
Fred Drakefd99de62000-07-09 05:02:18 +00002235 if (!PyErr_Occurred())
Guido van Rossum27a60b11997-05-22 22:25:11 +00002236 PyErr_SetString(PyExc_SystemError,
2237 "null file for PyFile_WriteString");
2238 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002239 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002240 else if (PyFile_Check(f)) {
2241 FILE *fp = PyFile_AsFile(f);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002242 if (fp == NULL) {
2243 err_closed();
2244 return -1;
2245 }
Brett Cannon01531592007-09-17 03:28:34 +00002246 Py_BEGIN_ALLOW_THREADS
Guido van Rossum27a60b11997-05-22 22:25:11 +00002247 fputs(s, fp);
Brett Cannon01531592007-09-17 03:28:34 +00002248 Py_END_ALLOW_THREADS
Guido van Rossum27a60b11997-05-22 22:25:11 +00002249 return 0;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002250 }
Guido van Rossumc0b618a1997-05-02 03:12:38 +00002251 else if (!PyErr_Occurred()) {
2252 PyObject *v = PyString_FromString(s);
Guido van Rossum27a60b11997-05-22 22:25:11 +00002253 int err;
2254 if (v == NULL)
2255 return -1;
2256 err = PyFile_WriteObject(v, f, Py_PRINT_RAW);
2257 Py_DECREF(v);
2258 return err;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002259 }
Guido van Rossum74ba2471997-07-13 03:56:50 +00002260 else
2261 return -1;
Guido van Rossum3165fe61992-09-25 21:59:05 +00002262}
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002263
2264/* Try to get a file-descriptor from a Python object. If the object
2265 is an integer or long integer, its value is returned. If not, the
2266 object's fileno() method is called if it exists; the method must return
2267 an integer or long integer, which is returned as the file descriptor value.
2268 -1 is returned on failure.
2269*/
2270
2271int PyObject_AsFileDescriptor(PyObject *o)
2272{
2273 int fd;
2274 PyObject *meth;
2275
2276 if (PyInt_Check(o)) {
2277 fd = PyInt_AsLong(o);
2278 }
2279 else if (PyLong_Check(o)) {
2280 fd = PyLong_AsLong(o);
2281 }
2282 else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL)
2283 {
2284 PyObject *fno = PyEval_CallObject(meth, NULL);
2285 Py_DECREF(meth);
2286 if (fno == NULL)
2287 return -1;
Tim Peters86821b22001-01-07 21:19:34 +00002288
Andrew M. Kuchling06051ed2000-07-13 23:56:54 +00002289 if (PyInt_Check(fno)) {
2290 fd = PyInt_AsLong(fno);
2291 Py_DECREF(fno);
2292 }
2293 else if (PyLong_Check(fno)) {
2294 fd = PyLong_AsLong(fno);
2295 Py_DECREF(fno);
2296 }
2297 else {
2298 PyErr_SetString(PyExc_TypeError,
2299 "fileno() returned a non-integer");
2300 Py_DECREF(fno);
2301 return -1;
2302 }
2303 }
2304 else {
2305 PyErr_SetString(PyExc_TypeError,
2306 "argument must be an int, or have a fileno() method.");
2307 return -1;
2308 }
2309
2310 if (fd < 0) {
2311 PyErr_Format(PyExc_ValueError,
2312 "file descriptor cannot be a negative integer (%i)",
2313 fd);
2314 return -1;
2315 }
2316 return fd;
2317}
Jack Jansen7b8c7542002-04-14 20:12:41 +00002318
Jack Jansen7b8c7542002-04-14 20:12:41 +00002319/* From here on we need access to the real fgets and fread */
2320#undef fgets
2321#undef fread
2322
2323/*
2324** Py_UniversalNewlineFgets is an fgets variation that understands
2325** all of \r, \n and \r\n conventions.
2326** The stream should be opened in binary mode.
2327** If fobj is NULL the routine always does newline conversion, and
2328** it may peek one char ahead to gobble the second char in \r\n.
2329** If fobj is non-NULL it must be a PyFileObject. In this case there
2330** is no readahead but in stead a flag is used to skip a following
2331** \n on the next read. Also, if the file is open in binary mode
2332** the whole conversion is skipped. Finally, the routine keeps track of
2333** the different types of newlines seen.
2334** Note that we need no error handling: fgets() treats error and eof
2335** identically.
2336*/
2337char *
2338Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)
2339{
2340 char *p = buf;
2341 int c;
2342 int newlinetypes = 0;
2343 int skipnextlf = 0;
2344 int univ_newline = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002345
Jack Jansen7b8c7542002-04-14 20:12:41 +00002346 if (fobj) {
2347 if (!PyFile_Check(fobj)) {
2348 errno = ENXIO; /* What can you do... */
2349 return NULL;
2350 }
2351 univ_newline = ((PyFileObject *)fobj)->f_univ_newline;
2352 if ( !univ_newline )
2353 return fgets(buf, n, stream);
2354 newlinetypes = ((PyFileObject *)fobj)->f_newlinetypes;
2355 skipnextlf = ((PyFileObject *)fobj)->f_skipnextlf;
2356 }
2357 FLOCKFILE(stream);
2358 c = 'x'; /* Shut up gcc warning */
2359 while (--n > 0 && (c = GETC(stream)) != EOF ) {
2360 if (skipnextlf ) {
2361 skipnextlf = 0;
2362 if (c == '\n') {
2363 /* Seeing a \n here with skipnextlf true
2364 ** means we saw a \r before.
2365 */
2366 newlinetypes |= NEWLINE_CRLF;
2367 c = GETC(stream);
2368 if (c == EOF) break;
2369 } else {
2370 /*
2371 ** Note that c == EOF also brings us here,
2372 ** so we're okay if the last char in the file
2373 ** is a CR.
2374 */
2375 newlinetypes |= NEWLINE_CR;
2376 }
2377 }
2378 if (c == '\r') {
2379 /* A \r is translated into a \n, and we skip
2380 ** an adjacent \n, if any. We don't set the
2381 ** newlinetypes flag until we've seen the next char.
2382 */
2383 skipnextlf = 1;
2384 c = '\n';
2385 } else if ( c == '\n') {
2386 newlinetypes |= NEWLINE_LF;
2387 }
2388 *p++ = c;
2389 if (c == '\n') break;
2390 }
2391 if ( c == EOF && skipnextlf )
2392 newlinetypes |= NEWLINE_CR;
2393 FUNLOCKFILE(stream);
2394 *p = '\0';
2395 if (fobj) {
2396 ((PyFileObject *)fobj)->f_newlinetypes = newlinetypes;
2397 ((PyFileObject *)fobj)->f_skipnextlf = skipnextlf;
2398 } else if ( skipnextlf ) {
2399 /* If we have no file object we cannot save the
2400 ** skipnextlf flag. We have to readahead, which
2401 ** will cause a pause if we're reading from an
2402 ** interactive stream, but that is very unlikely
2403 ** unless we're doing something silly like
2404 ** execfile("/dev/tty").
2405 */
2406 c = GETC(stream);
2407 if ( c != '\n' )
2408 ungetc(c, stream);
2409 }
2410 if (p == buf)
2411 return NULL;
2412 return buf;
2413}
2414
2415/*
2416** Py_UniversalNewlineFread is an fread variation that understands
2417** all of \r, \n and \r\n conventions.
2418** The stream should be opened in binary mode.
2419** fobj must be a PyFileObject. In this case there
2420** is no readahead but in stead a flag is used to skip a following
2421** \n on the next read. Also, if the file is open in binary mode
2422** the whole conversion is skipped. Finally, the routine keeps track of
2423** the different types of newlines seen.
2424*/
2425size_t
Tim Peters058b1412002-04-21 07:29:14 +00002426Py_UniversalNewlineFread(char *buf, size_t n,
Jack Jansen7b8c7542002-04-14 20:12:41 +00002427 FILE *stream, PyObject *fobj)
2428{
Tim Peters058b1412002-04-21 07:29:14 +00002429 char *dst = buf;
2430 PyFileObject *f = (PyFileObject *)fobj;
2431 int newlinetypes, skipnextlf;
2432
2433 assert(buf != NULL);
2434 assert(stream != NULL);
2435
Jack Jansen7b8c7542002-04-14 20:12:41 +00002436 if (!fobj || !PyFile_Check(fobj)) {
2437 errno = ENXIO; /* What can you do... */
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002438 return 0;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002439 }
Tim Peters058b1412002-04-21 07:29:14 +00002440 if (!f->f_univ_newline)
Jack Jansen7b8c7542002-04-14 20:12:41 +00002441 return fread(buf, 1, n, stream);
Tim Peters058b1412002-04-21 07:29:14 +00002442 newlinetypes = f->f_newlinetypes;
2443 skipnextlf = f->f_skipnextlf;
2444 /* Invariant: n is the number of bytes remaining to be filled
2445 * in the buffer.
2446 */
2447 while (n) {
2448 size_t nread;
2449 int shortread;
2450 char *src = dst;
2451
2452 nread = fread(dst, 1, n, stream);
2453 assert(nread <= n);
Neal Norwitzcb3319f2003-02-09 01:10:02 +00002454 if (nread == 0)
2455 break;
2456
Tim Peterse1682a82002-04-21 18:15:20 +00002457 n -= nread; /* assuming 1 byte out for each in; will adjust */
2458 shortread = n != 0; /* true iff EOF or error */
Tim Peters058b1412002-04-21 07:29:14 +00002459 while (nread--) {
2460 char c = *src++;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002461 if (c == '\r') {
Tim Peters058b1412002-04-21 07:29:14 +00002462 /* Save as LF and set flag to skip next LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002463 *dst++ = '\n';
2464 skipnextlf = 1;
Tim Peters058b1412002-04-21 07:29:14 +00002465 }
2466 else if (skipnextlf && c == '\n') {
2467 /* Skip LF, and remember we saw CR LF. */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002468 skipnextlf = 0;
2469 newlinetypes |= NEWLINE_CRLF;
Tim Peterse1682a82002-04-21 18:15:20 +00002470 ++n;
Tim Peters058b1412002-04-21 07:29:14 +00002471 }
2472 else {
2473 /* Normal char to be stored in buffer. Also
2474 * update the newlinetypes flag if either this
2475 * is an LF or the previous char was a CR.
2476 */
Jack Jansen7b8c7542002-04-14 20:12:41 +00002477 if (c == '\n')
2478 newlinetypes |= NEWLINE_LF;
2479 else if (skipnextlf)
2480 newlinetypes |= NEWLINE_CR;
2481 *dst++ = c;
2482 skipnextlf = 0;
2483 }
2484 }
Tim Peters058b1412002-04-21 07:29:14 +00002485 if (shortread) {
2486 /* If this is EOF, update type flags. */
2487 if (skipnextlf && feof(stream))
2488 newlinetypes |= NEWLINE_CR;
2489 break;
2490 }
Jack Jansen7b8c7542002-04-14 20:12:41 +00002491 }
Tim Peters058b1412002-04-21 07:29:14 +00002492 f->f_newlinetypes = newlinetypes;
2493 f->f_skipnextlf = skipnextlf;
2494 return dst - buf;
Jack Jansen7b8c7542002-04-14 20:12:41 +00002495}
Anthony Baxterac6bd462006-04-13 02:06:09 +00002496
2497#ifdef __cplusplus
2498}
2499#endif