Guido van Rossum | f70e43a | 1991-02-19 12:39:46 +0000 | [diff] [blame] | 1 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 2 | /* File object implementation */ |
| 3 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 4 | #include "Python.h" |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 5 | #include "structmember.h" |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 6 | |
Guido van Rossum | ff7e83d | 1999-08-27 20:39:37 +0000 | [diff] [blame] | 7 | #ifndef DONT_HAVE_SYS_TYPES_H |
Guido van Rossum | 4149843 | 1999-01-07 22:09:51 +0000 | [diff] [blame] | 8 | #include <sys/types.h> |
Guido van Rossum | ff7e83d | 1999-08-27 20:39:37 +0000 | [diff] [blame] | 9 | #endif /* DONT_HAVE_SYS_TYPES_H */ |
Guido van Rossum | 4149843 | 1999-01-07 22:09:51 +0000 | [diff] [blame] | 10 | |
Guido van Rossum | b819914 | 1997-05-06 15:23:24 +0000 | [diff] [blame] | 11 | #ifdef MS_WIN32 |
Guido van Rossum | b819914 | 1997-05-06 15:23:24 +0000 | [diff] [blame] | 12 | #define fileno _fileno |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 13 | /* can simulate truncate with Win32 API functions; see file_truncate */ |
Guido van Rossum | b819914 | 1997-05-06 15:23:24 +0000 | [diff] [blame] | 14 | #define HAVE_FTRUNCATE |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 15 | #define WINDOWS_LEAN_AND_MEAN |
| 16 | #include <windows.h> |
Guido van Rossum | b819914 | 1997-05-06 15:23:24 +0000 | [diff] [blame] | 17 | #endif |
| 18 | |
Guido van Rossum | f2044e1 | 1998-04-28 16:05:59 +0000 | [diff] [blame] | 19 | #ifdef macintosh |
| 20 | #ifdef USE_GUSI |
| 21 | #define HAVE_FTRUNCATE |
| 22 | #endif |
| 23 | #endif |
| 24 | |
Jack Jansen | e08dea19 | 1995-04-23 22:12:47 +0000 | [diff] [blame] | 25 | #ifdef __MWERKS__ |
| 26 | /* Mwerks fopen() doesn't always set errno */ |
| 27 | #define NO_FOPEN_ERRNO |
| 28 | #endif |
Guido van Rossum | 295d171 | 1995-02-19 15:55:19 +0000 | [diff] [blame] | 29 | |
Andrew MacIntyre | c487439 | 2002-02-26 11:36:35 +0000 | [diff] [blame] | 30 | #if defined(PYOS_OS2) && defined(PYCC_GCC) |
| 31 | #include <io.h> |
| 32 | #endif |
| 33 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 34 | #define BUF(v) PyString_AS_STRING((PyStringObject *)v) |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 35 | |
Guido van Rossum | ff7e83d | 1999-08-27 20:39:37 +0000 | [diff] [blame] | 36 | #ifndef DONT_HAVE_ERRNO_H |
Guido van Rossum | f1dc566 | 1993-07-05 10:31:29 +0000 | [diff] [blame] | 37 | #include <errno.h> |
Guido van Rossum | ff7e83d | 1999-08-27 20:39:37 +0000 | [diff] [blame] | 38 | #endif |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 39 | |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 40 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 41 | FILE * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 42 | PyFile_AsFile(PyObject *f) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 43 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 44 | if (f == NULL || !PyFile_Check(f)) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 45 | return NULL; |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 46 | else |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 47 | return ((PyFileObject *)f)->f_fp; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 48 | } |
| 49 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 50 | PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 51 | PyFile_Name(PyObject *f) |
Guido van Rossum | db3165e | 1993-10-18 17:06:59 +0000 | [diff] [blame] | 52 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 53 | if (f == NULL || !PyFile_Check(f)) |
Guido van Rossum | db3165e | 1993-10-18 17:06:59 +0000 | [diff] [blame] | 54 | return NULL; |
| 55 | else |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 56 | return ((PyFileObject *)f)->f_name; |
Guido van Rossum | db3165e | 1993-10-18 17:06:59 +0000 | [diff] [blame] | 57 | } |
| 58 | |
Neil Schemenauer | ed19b88 | 2002-03-23 02:06:50 +0000 | [diff] [blame] | 59 | /* On Unix, fopen will succeed for directories. |
| 60 | In Python, there should be no file objects referring to |
| 61 | directories, so we need a check. */ |
| 62 | |
| 63 | static PyFileObject* |
| 64 | dircheck(PyFileObject* f) |
| 65 | { |
| 66 | #if defined(HAVE_FSTAT) && defined(S_IFDIR) && defined(EISDIR) |
| 67 | struct stat buf; |
| 68 | if (f->f_fp == NULL) |
| 69 | return f; |
| 70 | if (fstat(fileno(f->f_fp), &buf) == 0 && |
| 71 | S_ISDIR(buf.st_mode)) { |
| 72 | #ifdef HAVE_STRERROR |
| 73 | char *msg = strerror(EISDIR); |
| 74 | #else |
| 75 | char *msg = "Is a directory"; |
| 76 | #endif |
| 77 | PyObject *exc = PyObject_CallFunction(PyExc_IOError, "(is)", EISDIR, msg); |
| 78 | PyErr_SetObject(PyExc_IOError, exc); |
| 79 | return NULL; |
| 80 | } |
| 81 | #endif |
| 82 | return f; |
| 83 | } |
| 84 | |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 85 | |
| 86 | static PyObject * |
| 87 | fill_file_fields(PyFileObject *f, FILE *fp, char *name, char *mode, |
| 88 | int (*close)(FILE *)) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 89 | { |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 90 | assert(f != NULL); |
| 91 | assert(PyFile_Check(f)); |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 92 | assert(f->f_fp == NULL); |
| 93 | |
| 94 | Py_DECREF(f->f_name); |
| 95 | Py_DECREF(f->f_mode); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 96 | f->f_name = PyString_FromString(name); |
| 97 | f->f_mode = PyString_FromString(mode); |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 98 | |
Guido van Rossum | a1ab7fa | 1991-06-04 19:37:39 +0000 | [diff] [blame] | 99 | f->f_close = close; |
Guido van Rossum | eb183da | 1991-04-04 10:44:06 +0000 | [diff] [blame] | 100 | f->f_softspace = 0; |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 101 | f->f_binary = strchr(mode,'b') != NULL; |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 102 | |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 103 | if (f->f_name == NULL || f->f_mode == NULL) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 104 | return NULL; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 105 | f->f_fp = fp; |
Neil Schemenauer | ed19b88 | 2002-03-23 02:06:50 +0000 | [diff] [blame] | 106 | f = dircheck(f); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 107 | return (PyObject *) f; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 108 | } |
| 109 | |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 110 | static PyObject * |
| 111 | open_the_file(PyFileObject *f, char *name, char *mode) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 112 | { |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 113 | assert(f != NULL); |
| 114 | assert(PyFile_Check(f)); |
| 115 | assert(name != NULL); |
| 116 | assert(mode != NULL); |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 117 | assert(f->f_fp == NULL); |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 118 | |
Tim Peters | 8fa4567 | 2001-09-13 21:01:29 +0000 | [diff] [blame] | 119 | /* rexec.py can't stop a user from getting the file() constructor -- |
| 120 | all they have to do is get *any* file object f, and then do |
| 121 | type(f). Here we prevent them from doing damage with it. */ |
| 122 | if (PyEval_GetRestricted()) { |
| 123 | PyErr_SetString(PyExc_IOError, |
| 124 | "file() constructor not accessible in restricted mode"); |
| 125 | return NULL; |
| 126 | } |
Tim Peters | a27a150 | 2001-11-09 20:59:14 +0000 | [diff] [blame] | 127 | errno = 0; |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 128 | #ifdef HAVE_FOPENRF |
Guido van Rossum | a08095a | 1991-02-13 23:25:27 +0000 | [diff] [blame] | 129 | if (*mode == '*') { |
| 130 | FILE *fopenRF(); |
| 131 | f->f_fp = fopenRF(name, mode+1); |
| 132 | } |
| 133 | else |
| 134 | #endif |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 135 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 136 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 137 | f->f_fp = fopen(name, mode); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 138 | Py_END_ALLOW_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 139 | } |
Guido van Rossum | a08095a | 1991-02-13 23:25:27 +0000 | [diff] [blame] | 140 | if (f->f_fp == NULL) { |
Jack Jansen | e08dea19 | 1995-04-23 22:12:47 +0000 | [diff] [blame] | 141 | #ifdef NO_FOPEN_ERRNO |
Jack Jansen | b3be216 | 2001-11-30 14:16:36 +0000 | [diff] [blame] | 142 | /* Metroworks only, wich does not always sets errno */ |
Jeremy Hylton | 41c8321 | 2001-11-09 16:17:24 +0000 | [diff] [blame] | 143 | if (errno == 0) { |
Jack Jansen | b3be216 | 2001-11-30 14:16:36 +0000 | [diff] [blame] | 144 | PyObject *v; |
| 145 | v = Py_BuildValue("(is)", 0, "Cannot open file"); |
| 146 | if (v != NULL) { |
| 147 | PyErr_SetObject(PyExc_IOError, v); |
| 148 | Py_DECREF(v); |
| 149 | } |
Jack Jansen | e08dea19 | 1995-04-23 22:12:47 +0000 | [diff] [blame] | 150 | return NULL; |
| 151 | } |
| 152 | #endif |
Jeremy Hylton | 41c8321 | 2001-11-09 16:17:24 +0000 | [diff] [blame] | 153 | if (errno == EINVAL) |
| 154 | PyErr_Format(PyExc_IOError, "invalid argument: %s", |
| 155 | mode); |
| 156 | else |
| 157 | PyErr_SetFromErrnoWithFilename(PyExc_IOError, name); |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 158 | f = NULL; |
| 159 | } |
Neil Schemenauer | ed19b88 | 2002-03-23 02:06:50 +0000 | [diff] [blame] | 160 | if (f != NULL) |
| 161 | f = dircheck(f); |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 162 | return (PyObject *)f; |
| 163 | } |
| 164 | |
| 165 | PyObject * |
| 166 | PyFile_FromFile(FILE *fp, char *name, char *mode, int (*close)(FILE *)) |
| 167 | { |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 168 | PyFileObject *f = (PyFileObject *)PyFile_Type.tp_new(&PyFile_Type, |
| 169 | NULL, NULL); |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 170 | if (f != NULL) { |
| 171 | if (fill_file_fields(f, fp, name, mode, close) == NULL) { |
| 172 | Py_DECREF(f); |
| 173 | f = NULL; |
| 174 | } |
| 175 | } |
| 176 | return (PyObject *) f; |
| 177 | } |
| 178 | |
| 179 | PyObject * |
| 180 | PyFile_FromString(char *name, char *mode) |
| 181 | { |
| 182 | extern int fclose(FILE *); |
| 183 | PyFileObject *f; |
| 184 | |
| 185 | f = (PyFileObject *)PyFile_FromFile((FILE *)NULL, name, mode, fclose); |
| 186 | if (f != NULL) { |
| 187 | if (open_the_file(f, name, mode) == NULL) { |
| 188 | Py_DECREF(f); |
| 189 | f = NULL; |
| 190 | } |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 191 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 192 | return (PyObject *)f; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 193 | } |
| 194 | |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 195 | void |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 196 | PyFile_SetBufSize(PyObject *f, int bufsize) |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 197 | { |
| 198 | if (bufsize >= 0) { |
| 199 | #ifdef HAVE_SETVBUF |
| 200 | int type; |
| 201 | switch (bufsize) { |
| 202 | case 0: |
| 203 | type = _IONBF; |
| 204 | break; |
| 205 | case 1: |
| 206 | type = _IOLBF; |
| 207 | bufsize = BUFSIZ; |
| 208 | break; |
| 209 | default: |
| 210 | type = _IOFBF; |
| 211 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 212 | setvbuf(((PyFileObject *)f)->f_fp, (char *)NULL, |
| 213 | type, bufsize); |
Guido van Rossum | f8b4de0 | 1998-03-06 15:32:40 +0000 | [diff] [blame] | 214 | #else /* !HAVE_SETVBUF */ |
| 215 | if (bufsize <= 1) |
| 216 | setbuf(((PyFileObject *)f)->f_fp, (char *)NULL); |
| 217 | #endif /* !HAVE_SETVBUF */ |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 218 | } |
| 219 | } |
| 220 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 221 | static PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 222 | err_closed(void) |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 223 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 224 | PyErr_SetString(PyExc_ValueError, "I/O operation on closed file"); |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 225 | return NULL; |
| 226 | } |
| 227 | |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 228 | /* Methods */ |
| 229 | |
| 230 | static void |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 231 | file_dealloc(PyFileObject *f) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 232 | { |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 233 | if (f->f_fp != NULL && f->f_close != NULL) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 234 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | a1ab7fa | 1991-06-04 19:37:39 +0000 | [diff] [blame] | 235 | (*f->f_close)(f->f_fp); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 236 | Py_END_ALLOW_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 237 | } |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 238 | Py_XDECREF(f->f_name); |
| 239 | Py_XDECREF(f->f_mode); |
Guido van Rossum | 9475a23 | 2001-10-05 20:51:39 +0000 | [diff] [blame] | 240 | f->ob_type->tp_free((PyObject *)f); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 241 | } |
| 242 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 243 | static PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 244 | file_repr(PyFileObject *f) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 245 | { |
Barry Warsaw | 7ce3694 | 2001-08-24 18:34:26 +0000 | [diff] [blame] | 246 | return PyString_FromFormat("<%s file '%s', mode '%s' at %p>", |
| 247 | f->f_fp == NULL ? "closed" : "open", |
| 248 | PyString_AsString(f->f_name), |
| 249 | PyString_AsString(f->f_mode), |
| 250 | f); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 251 | } |
| 252 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 253 | static PyObject * |
Martin v. Löwis | e3eb1f2 | 2001-08-16 13:15:00 +0000 | [diff] [blame] | 254 | file_close(PyFileObject *f) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 255 | { |
Guido van Rossum | a1ab7fa | 1991-06-04 19:37:39 +0000 | [diff] [blame] | 256 | int sts = 0; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 257 | if (f->f_fp != NULL) { |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 258 | if (f->f_close != NULL) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 259 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 260 | errno = 0; |
Guido van Rossum | a1ab7fa | 1991-06-04 19:37:39 +0000 | [diff] [blame] | 261 | sts = (*f->f_close)(f->f_fp); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 262 | Py_END_ALLOW_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 263 | } |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 264 | f->f_fp = NULL; |
| 265 | } |
Guido van Rossum | febd551 | 1992-03-04 16:39:24 +0000 | [diff] [blame] | 266 | if (sts == EOF) |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 267 | return PyErr_SetFromErrno(PyExc_IOError); |
Guido van Rossum | a1ab7fa | 1991-06-04 19:37:39 +0000 | [diff] [blame] | 268 | if (sts != 0) |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 269 | return PyInt_FromLong((long)sts); |
| 270 | Py_INCREF(Py_None); |
| 271 | return Py_None; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 272 | } |
| 273 | |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 274 | |
Guido van Rossum | b855216 | 2001-09-05 14:58:11 +0000 | [diff] [blame] | 275 | /* Our very own off_t-like type, 64-bit if possible */ |
| 276 | #if !defined(HAVE_LARGEFILE_SUPPORT) |
| 277 | typedef off_t Py_off_t; |
| 278 | #elif SIZEOF_OFF_T >= 8 |
| 279 | typedef off_t Py_off_t; |
| 280 | #elif SIZEOF_FPOS_T >= 8 |
Guido van Rossum | 4f53da0 | 2001-03-01 18:26:53 +0000 | [diff] [blame] | 281 | typedef fpos_t Py_off_t; |
| 282 | #else |
Guido van Rossum | b855216 | 2001-09-05 14:58:11 +0000 | [diff] [blame] | 283 | #error "Large file support, but neither off_t nor fpos_t is large enough." |
Guido van Rossum | 4f53da0 | 2001-03-01 18:26:53 +0000 | [diff] [blame] | 284 | #endif |
| 285 | |
| 286 | |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 287 | /* a portable fseek() function |
| 288 | return 0 on success, non-zero on failure (with errno set) */ |
Guido van Rossum | f68d8e5 | 2001-04-14 17:55:09 +0000 | [diff] [blame] | 289 | static int |
Guido van Rossum | 4f53da0 | 2001-03-01 18:26:53 +0000 | [diff] [blame] | 290 | _portable_fseek(FILE *fp, Py_off_t offset, int whence) |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 291 | { |
Guido van Rossum | b855216 | 2001-09-05 14:58:11 +0000 | [diff] [blame] | 292 | #if !defined(HAVE_LARGEFILE_SUPPORT) |
| 293 | return fseek(fp, offset, whence); |
| 294 | #elif defined(HAVE_FSEEKO) && SIZEOF_OFF_T >= 8 |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 295 | return fseeko(fp, offset, whence); |
| 296 | #elif defined(HAVE_FSEEK64) |
| 297 | return fseek64(fp, offset, whence); |
Fred Drake | db810ac | 2000-10-06 20:42:33 +0000 | [diff] [blame] | 298 | #elif defined(__BEOS__) |
| 299 | return _fseek(fp, offset, whence); |
Guido van Rossum | b855216 | 2001-09-05 14:58:11 +0000 | [diff] [blame] | 300 | #elif SIZEOF_FPOS_T >= 8 |
Guido van Rossum | e54e0be | 2001-01-16 20:53:31 +0000 | [diff] [blame] | 301 | /* lacking a 64-bit capable fseek(), use a 64-bit capable fsetpos() |
| 302 | and fgetpos() to implement fseek()*/ |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 303 | fpos_t pos; |
| 304 | switch (whence) { |
Guido van Rossum | e54e0be | 2001-01-16 20:53:31 +0000 | [diff] [blame] | 305 | case SEEK_END: |
Guido van Rossum | 8b4e43e | 2001-09-10 20:43:35 +0000 | [diff] [blame] | 306 | #ifdef MS_WINDOWS |
| 307 | fflush(fp); |
| 308 | if (_lseeki64(fileno(fp), 0, 2) == -1) |
| 309 | return -1; |
| 310 | #else |
Guido van Rossum | e54e0be | 2001-01-16 20:53:31 +0000 | [diff] [blame] | 311 | if (fseek(fp, 0, SEEK_END) != 0) |
| 312 | return -1; |
Guido van Rossum | 8b4e43e | 2001-09-10 20:43:35 +0000 | [diff] [blame] | 313 | #endif |
Guido van Rossum | e54e0be | 2001-01-16 20:53:31 +0000 | [diff] [blame] | 314 | /* fall through */ |
| 315 | case SEEK_CUR: |
| 316 | if (fgetpos(fp, &pos) != 0) |
| 317 | return -1; |
| 318 | offset += pos; |
| 319 | break; |
| 320 | /* case SEEK_SET: break; */ |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 321 | } |
| 322 | return fsetpos(fp, &offset); |
| 323 | #else |
Guido van Rossum | b855216 | 2001-09-05 14:58:11 +0000 | [diff] [blame] | 324 | #error "Large file support, but no way to fseek." |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 325 | #endif |
| 326 | } |
| 327 | |
| 328 | |
| 329 | /* a portable ftell() function |
| 330 | Return -1 on failure with errno set appropriately, current file |
| 331 | position on success */ |
Guido van Rossum | f68d8e5 | 2001-04-14 17:55:09 +0000 | [diff] [blame] | 332 | static Py_off_t |
Fred Drake | 8ce159a | 2000-08-31 05:18:54 +0000 | [diff] [blame] | 333 | _portable_ftell(FILE* fp) |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 334 | { |
Guido van Rossum | b855216 | 2001-09-05 14:58:11 +0000 | [diff] [blame] | 335 | #if !defined(HAVE_LARGEFILE_SUPPORT) |
| 336 | return ftell(fp); |
| 337 | #elif defined(HAVE_FTELLO) && SIZEOF_OFF_T >= 8 |
| 338 | return ftello(fp); |
| 339 | #elif defined(HAVE_FTELL64) |
| 340 | return ftell64(fp); |
| 341 | #elif SIZEOF_FPOS_T >= 8 |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 342 | fpos_t pos; |
| 343 | if (fgetpos(fp, &pos) != 0) |
| 344 | return -1; |
| 345 | return pos; |
| 346 | #else |
Guido van Rossum | b855216 | 2001-09-05 14:58:11 +0000 | [diff] [blame] | 347 | #error "Large file support, but no way to ftell." |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 348 | #endif |
| 349 | } |
| 350 | |
| 351 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 352 | static PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 353 | file_seek(PyFileObject *f, PyObject *args) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 354 | { |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 355 | int whence; |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 356 | int ret; |
Guido van Rossum | 4f53da0 | 2001-03-01 18:26:53 +0000 | [diff] [blame] | 357 | Py_off_t offset; |
Guido van Rossum | 3c9fe0c | 1999-01-06 18:51:17 +0000 | [diff] [blame] | 358 | PyObject *offobj; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 359 | |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 360 | if (f->f_fp == NULL) |
| 361 | return err_closed(); |
| 362 | whence = 0; |
Guido van Rossum | 43713e5 | 2000-02-29 13:59:29 +0000 | [diff] [blame] | 363 | if (!PyArg_ParseTuple(args, "O|i:seek", &offobj, &whence)) |
Guido van Rossum | 3c9fe0c | 1999-01-06 18:51:17 +0000 | [diff] [blame] | 364 | return NULL; |
| 365 | #if !defined(HAVE_LARGEFILE_SUPPORT) |
| 366 | offset = PyInt_AsLong(offobj); |
| 367 | #else |
| 368 | offset = PyLong_Check(offobj) ? |
| 369 | PyLong_AsLongLong(offobj) : PyInt_AsLong(offobj); |
| 370 | #endif |
| 371 | if (PyErr_Occurred()) |
Guido van Rossum | 8830319 | 1999-01-04 17:22:18 +0000 | [diff] [blame] | 372 | return NULL; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 373 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 374 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 375 | errno = 0; |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 376 | ret = _portable_fseek(f->f_fp, offset, whence); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 377 | Py_END_ALLOW_THREADS |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 378 | |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 379 | if (ret != 0) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 380 | PyErr_SetFromErrno(PyExc_IOError); |
Guido van Rossum | febd551 | 1992-03-04 16:39:24 +0000 | [diff] [blame] | 381 | clearerr(f->f_fp); |
| 382 | return NULL; |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 383 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 384 | Py_INCREF(Py_None); |
| 385 | return Py_None; |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 386 | } |
| 387 | |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 388 | |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 389 | #ifdef HAVE_FTRUNCATE |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 390 | static PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 391 | file_truncate(PyFileObject *f, PyObject *args) |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 392 | { |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 393 | int ret; |
Guido van Rossum | 4f53da0 | 2001-03-01 18:26:53 +0000 | [diff] [blame] | 394 | Py_off_t newsize; |
Guido van Rossum | 3c9fe0c | 1999-01-06 18:51:17 +0000 | [diff] [blame] | 395 | PyObject *newsizeobj; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 396 | |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 397 | if (f->f_fp == NULL) |
| 398 | return err_closed(); |
Guido van Rossum | 3c9fe0c | 1999-01-06 18:51:17 +0000 | [diff] [blame] | 399 | newsizeobj = NULL; |
Guido van Rossum | 43713e5 | 2000-02-29 13:59:29 +0000 | [diff] [blame] | 400 | if (!PyArg_ParseTuple(args, "|O:truncate", &newsizeobj)) |
Guido van Rossum | 8830319 | 1999-01-04 17:22:18 +0000 | [diff] [blame] | 401 | return NULL; |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 402 | |
| 403 | /* Set newsize to current postion if newsizeobj NULL, else to the |
| 404 | specified value. */ |
Guido van Rossum | 3c9fe0c | 1999-01-06 18:51:17 +0000 | [diff] [blame] | 405 | if (newsizeobj != NULL) { |
| 406 | #if !defined(HAVE_LARGEFILE_SUPPORT) |
| 407 | newsize = PyInt_AsLong(newsizeobj); |
| 408 | #else |
| 409 | newsize = PyLong_Check(newsizeobj) ? |
| 410 | PyLong_AsLongLong(newsizeobj) : |
| 411 | PyInt_AsLong(newsizeobj); |
| 412 | #endif |
| 413 | if (PyErr_Occurred()) |
| 414 | return NULL; |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 415 | } |
| 416 | else { |
| 417 | /* Default to current position. */ |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 418 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 419 | errno = 0; |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 420 | newsize = _portable_ftell(f->f_fp); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 421 | Py_END_ALLOW_THREADS |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 422 | if (newsize == -1) |
| 423 | goto onioerror; |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 424 | } |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 425 | |
| 426 | /* Flush the file. */ |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 427 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 428 | errno = 0; |
| 429 | ret = fflush(f->f_fp); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 430 | Py_END_ALLOW_THREADS |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 431 | if (ret != 0) |
| 432 | goto onioerror; |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 433 | |
| 434 | #ifdef MS_WIN32 |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 435 | /* MS _chsize doesn't work if newsize doesn't fit in 32 bits, |
Tim Peters | 8f01b68 | 2002-03-12 03:04:44 +0000 | [diff] [blame] | 436 | so don't even try using it. */ |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 437 | { |
Tim Peters | 8f01b68 | 2002-03-12 03:04:44 +0000 | [diff] [blame] | 438 | Py_off_t current; /* current file position */ |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 439 | HANDLE hFile; |
| 440 | int error; |
| 441 | |
Tim Peters | 8f01b68 | 2002-03-12 03:04:44 +0000 | [diff] [blame] | 442 | /* current <- current file postion. */ |
| 443 | if (newsizeobj == NULL) |
| 444 | current = newsize; |
| 445 | else { |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 446 | Py_BEGIN_ALLOW_THREADS |
| 447 | errno = 0; |
Tim Peters | 8f01b68 | 2002-03-12 03:04:44 +0000 | [diff] [blame] | 448 | current = _portable_ftell(f->f_fp); |
| 449 | Py_END_ALLOW_THREADS |
| 450 | if (current == -1) |
| 451 | goto onioerror; |
| 452 | } |
| 453 | |
| 454 | /* Move to newsize. */ |
| 455 | if (current != newsize) { |
| 456 | Py_BEGIN_ALLOW_THREADS |
| 457 | errno = 0; |
| 458 | error = _portable_fseek(f->f_fp, newsize, SEEK_SET) |
| 459 | != 0; |
Tim Peters | fb05db2 | 2002-03-11 00:24:00 +0000 | [diff] [blame] | 460 | Py_END_ALLOW_THREADS |
| 461 | if (error) |
| 462 | goto onioerror; |
| 463 | } |
| 464 | |
Tim Peters | 8f01b68 | 2002-03-12 03:04:44 +0000 | [diff] [blame] | 465 | /* Truncate. Note that this may grow the file! */ |
| 466 | Py_BEGIN_ALLOW_THREADS |
| 467 | errno = 0; |
| 468 | hFile = (HANDLE)_get_osfhandle(fileno(f->f_fp)); |
| 469 | error = hFile == (HANDLE)-1; |
| 470 | if (!error) { |
| 471 | error = SetEndOfFile(hFile) == 0; |
| 472 | if (error) |
| 473 | errno = EACCES; |
| 474 | } |
| 475 | Py_END_ALLOW_THREADS |
| 476 | if (error) |
| 477 | goto onioerror; |
| 478 | |
| 479 | /* Restore original file position. */ |
| 480 | if (current != newsize) { |
| 481 | Py_BEGIN_ALLOW_THREADS |
| 482 | errno = 0; |
| 483 | error = _portable_fseek(f->f_fp, current, SEEK_SET) |
| 484 | != 0; |
| 485 | Py_END_ALLOW_THREADS |
| 486 | if (error) |
| 487 | goto onioerror; |
| 488 | } |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 489 | } |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 490 | #else |
| 491 | Py_BEGIN_ALLOW_THREADS |
| 492 | errno = 0; |
| 493 | ret = ftruncate(fileno(f->f_fp), newsize); |
| 494 | Py_END_ALLOW_THREADS |
| 495 | if (ret != 0) goto onioerror; |
| 496 | #endif /* !MS_WIN32 */ |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 497 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 498 | Py_INCREF(Py_None); |
| 499 | return Py_None; |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 500 | |
| 501 | onioerror: |
| 502 | PyErr_SetFromErrno(PyExc_IOError); |
| 503 | clearerr(f->f_fp); |
| 504 | return NULL; |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 505 | } |
| 506 | #endif /* HAVE_FTRUNCATE */ |
| 507 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 508 | static PyObject * |
Martin v. Löwis | e3eb1f2 | 2001-08-16 13:15:00 +0000 | [diff] [blame] | 509 | file_tell(PyFileObject *f) |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 510 | { |
Guido van Rossum | 4f53da0 | 2001-03-01 18:26:53 +0000 | [diff] [blame] | 511 | Py_off_t pos; |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 512 | |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 513 | if (f->f_fp == NULL) |
| 514 | return err_closed(); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 515 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 516 | errno = 0; |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 517 | pos = _portable_ftell(f->f_fp); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 518 | Py_END_ALLOW_THREADS |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 519 | if (pos == -1) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 520 | PyErr_SetFromErrno(PyExc_IOError); |
Guido van Rossum | febd551 | 1992-03-04 16:39:24 +0000 | [diff] [blame] | 521 | clearerr(f->f_fp); |
| 522 | return NULL; |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 523 | } |
Guido van Rossum | 3c9fe0c | 1999-01-06 18:51:17 +0000 | [diff] [blame] | 524 | #if !defined(HAVE_LARGEFILE_SUPPORT) |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 525 | return PyInt_FromLong(pos); |
Guido van Rossum | 3c9fe0c | 1999-01-06 18:51:17 +0000 | [diff] [blame] | 526 | #else |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 527 | return PyLong_FromLongLong(pos); |
Guido van Rossum | 3c9fe0c | 1999-01-06 18:51:17 +0000 | [diff] [blame] | 528 | #endif |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 529 | } |
| 530 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 531 | static PyObject * |
Martin v. Löwis | e3eb1f2 | 2001-08-16 13:15:00 +0000 | [diff] [blame] | 532 | file_fileno(PyFileObject *f) |
Guido van Rossum | ed233a5 | 1992-06-23 09:07:03 +0000 | [diff] [blame] | 533 | { |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 534 | if (f->f_fp == NULL) |
| 535 | return err_closed(); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 536 | return PyInt_FromLong((long) fileno(f->f_fp)); |
Guido van Rossum | ed233a5 | 1992-06-23 09:07:03 +0000 | [diff] [blame] | 537 | } |
| 538 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 539 | static PyObject * |
Martin v. Löwis | e3eb1f2 | 2001-08-16 13:15:00 +0000 | [diff] [blame] | 540 | file_flush(PyFileObject *f) |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 541 | { |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 542 | int res; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 543 | |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 544 | if (f->f_fp == NULL) |
| 545 | return err_closed(); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 546 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 547 | errno = 0; |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 548 | res = fflush(f->f_fp); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 549 | Py_END_ALLOW_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 550 | if (res != 0) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 551 | PyErr_SetFromErrno(PyExc_IOError); |
Guido van Rossum | febd551 | 1992-03-04 16:39:24 +0000 | [diff] [blame] | 552 | clearerr(f->f_fp); |
| 553 | return NULL; |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 554 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 555 | Py_INCREF(Py_None); |
| 556 | return Py_None; |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 557 | } |
| 558 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 559 | static PyObject * |
Martin v. Löwis | e3eb1f2 | 2001-08-16 13:15:00 +0000 | [diff] [blame] | 560 | file_isatty(PyFileObject *f) |
Guido van Rossum | a1ab7fa | 1991-06-04 19:37:39 +0000 | [diff] [blame] | 561 | { |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 562 | long res; |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 563 | if (f->f_fp == NULL) |
| 564 | return err_closed(); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 565 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | ff4949e | 1992-08-05 19:58:53 +0000 | [diff] [blame] | 566 | res = isatty((int)fileno(f->f_fp)); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 567 | Py_END_ALLOW_THREADS |
| 568 | return PyInt_FromLong(res); |
Guido van Rossum | a1ab7fa | 1991-06-04 19:37:39 +0000 | [diff] [blame] | 569 | } |
| 570 | |
Guido van Rossum | ff7e83d | 1999-08-27 20:39:37 +0000 | [diff] [blame] | 571 | |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 572 | #if BUFSIZ < 8192 |
| 573 | #define SMALLCHUNK 8192 |
| 574 | #else |
| 575 | #define SMALLCHUNK BUFSIZ |
| 576 | #endif |
| 577 | |
Guido van Rossum | 3c25904 | 1999-01-14 19:00:14 +0000 | [diff] [blame] | 578 | #if SIZEOF_INT < 4 |
| 579 | #define BIGCHUNK (512 * 32) |
| 580 | #else |
| 581 | #define BIGCHUNK (512 * 1024) |
| 582 | #endif |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 583 | |
| 584 | static size_t |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 585 | new_buffersize(PyFileObject *f, size_t currentsize) |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 586 | { |
| 587 | #ifdef HAVE_FSTAT |
Fred Drake | 1bc8fab | 2001-07-19 21:49:38 +0000 | [diff] [blame] | 588 | off_t pos, end; |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 589 | struct stat st; |
| 590 | if (fstat(fileno(f->f_fp), &st) == 0) { |
| 591 | end = st.st_size; |
Guido van Rossum | cada293 | 1998-12-11 20:44:56 +0000 | [diff] [blame] | 592 | /* The following is not a bug: we really need to call lseek() |
| 593 | *and* ftell(). The reason is that some stdio libraries |
| 594 | mistakenly flush their buffer when ftell() is called and |
| 595 | the lseek() call it makes fails, thereby throwing away |
| 596 | data that cannot be recovered in any way. To avoid this, |
| 597 | we first test lseek(), and only call ftell() if lseek() |
| 598 | works. We can't use the lseek() value either, because we |
| 599 | need to take the amount of buffered data into account. |
| 600 | (Yet another reason why stdio stinks. :-) */ |
Jack Jansen | 2771b5b | 2001-10-10 22:03:27 +0000 | [diff] [blame] | 601 | #ifdef USE_GUSI2 |
| 602 | pos = lseek(fileno(f->f_fp), 1L, SEEK_CUR); |
| 603 | pos = lseek(fileno(f->f_fp), -1L, SEEK_CUR); |
| 604 | #else |
Guido van Rossum | 91aaa92 | 1998-05-05 22:21:35 +0000 | [diff] [blame] | 605 | pos = lseek(fileno(f->f_fp), 0L, SEEK_CUR); |
Jack Jansen | 2771b5b | 2001-10-10 22:03:27 +0000 | [diff] [blame] | 606 | #endif |
| 607 | if (pos >= 0) { |
Guido van Rossum | 91aaa92 | 1998-05-05 22:21:35 +0000 | [diff] [blame] | 608 | pos = ftell(f->f_fp); |
Jack Jansen | 2771b5b | 2001-10-10 22:03:27 +0000 | [diff] [blame] | 609 | } |
Guido van Rossum | d30dc0a | 1998-04-27 19:01:08 +0000 | [diff] [blame] | 610 | if (pos < 0) |
| 611 | clearerr(f->f_fp); |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 612 | if (end > pos && pos >= 0) |
Guido van Rossum | cada293 | 1998-12-11 20:44:56 +0000 | [diff] [blame] | 613 | return currentsize + end - pos + 1; |
Guido van Rossum | dcb5e7f | 1998-03-03 22:36:10 +0000 | [diff] [blame] | 614 | /* Add 1 so if the file were to grow we'd notice. */ |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 615 | } |
| 616 | #endif |
| 617 | if (currentsize > SMALLCHUNK) { |
| 618 | /* Keep doubling until we reach BIGCHUNK; |
| 619 | then keep adding BIGCHUNK. */ |
| 620 | if (currentsize <= BIGCHUNK) |
| 621 | return currentsize + currentsize; |
| 622 | else |
| 623 | return currentsize + BIGCHUNK; |
| 624 | } |
| 625 | return currentsize + SMALLCHUNK; |
| 626 | } |
| 627 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 628 | static PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 629 | file_read(PyFileObject *f, PyObject *args) |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 630 | { |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 631 | long bytesrequested = -1; |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 632 | size_t bytesread, buffersize, chunksize; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 633 | PyObject *v; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 634 | |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 635 | if (f->f_fp == NULL) |
| 636 | return err_closed(); |
Guido van Rossum | 43713e5 | 2000-02-29 13:59:29 +0000 | [diff] [blame] | 637 | if (!PyArg_ParseTuple(args, "|l:read", &bytesrequested)) |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 638 | return NULL; |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 639 | if (bytesrequested < 0) |
Guido van Rossum | ff1ccbf | 1999-04-10 15:48:23 +0000 | [diff] [blame] | 640 | buffersize = new_buffersize(f, (size_t)0); |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 641 | else |
| 642 | buffersize = bytesrequested; |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 643 | if (buffersize > INT_MAX) { |
| 644 | PyErr_SetString(PyExc_OverflowError, |
| 645 | "requested number of bytes is more than a Python string can hold"); |
| 646 | return NULL; |
| 647 | } |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 648 | v = PyString_FromStringAndSize((char *)NULL, buffersize); |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 649 | if (v == NULL) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 650 | return NULL; |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 651 | bytesread = 0; |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 652 | for (;;) { |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 653 | Py_BEGIN_ALLOW_THREADS |
| 654 | errno = 0; |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 655 | chunksize = fread(BUF(v) + bytesread, 1, |
| 656 | buffersize - bytesread, f->f_fp); |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 657 | Py_END_ALLOW_THREADS |
| 658 | if (chunksize == 0) { |
| 659 | if (!ferror(f->f_fp)) |
| 660 | break; |
| 661 | PyErr_SetFromErrno(PyExc_IOError); |
| 662 | clearerr(f->f_fp); |
| 663 | Py_DECREF(v); |
| 664 | return NULL; |
| 665 | } |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 666 | bytesread += chunksize; |
| 667 | if (bytesread < buffersize) |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 668 | break; |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 669 | if (bytesrequested < 0) { |
Guido van Rossum | cada293 | 1998-12-11 20:44:56 +0000 | [diff] [blame] | 670 | buffersize = new_buffersize(f, buffersize); |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 671 | if (_PyString_Resize(&v, buffersize) < 0) |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 672 | return NULL; |
| 673 | } |
| 674 | } |
Guido van Rossum | 5449b6e | 1997-05-09 22:27:31 +0000 | [diff] [blame] | 675 | if (bytesread != buffersize) |
| 676 | _PyString_Resize(&v, bytesread); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 677 | return v; |
| 678 | } |
| 679 | |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 680 | static PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 681 | file_readinto(PyFileObject *f, PyObject *args) |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 682 | { |
| 683 | char *ptr; |
Guido van Rossum | 00ebd46 | 2001-10-23 21:25:24 +0000 | [diff] [blame] | 684 | int ntodo; |
| 685 | size_t ndone, nnow; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 686 | |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 687 | if (f->f_fp == NULL) |
| 688 | return err_closed(); |
Neal Norwitz | 62f5a9d | 2002-04-01 00:09:00 +0000 | [diff] [blame^] | 689 | if (!PyArg_ParseTuple(args, "w#", &ptr, &ntodo)) |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 690 | return NULL; |
| 691 | ndone = 0; |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 692 | while (ntodo > 0) { |
| 693 | Py_BEGIN_ALLOW_THREADS |
| 694 | errno = 0; |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 695 | nnow = fread(ptr+ndone, 1, ntodo, f->f_fp); |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 696 | Py_END_ALLOW_THREADS |
| 697 | if (nnow == 0) { |
| 698 | if (!ferror(f->f_fp)) |
| 699 | break; |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 700 | PyErr_SetFromErrno(PyExc_IOError); |
| 701 | clearerr(f->f_fp); |
| 702 | return NULL; |
| 703 | } |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 704 | ndone += nnow; |
| 705 | ntodo -= nnow; |
| 706 | } |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 707 | return PyInt_FromLong((long)ndone); |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 708 | } |
| 709 | |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 710 | /************************************************************************** |
Tim Peters | f29b64d | 2001-01-15 06:33:19 +0000 | [diff] [blame] | 711 | Routine to get next line using platform fgets(). |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 712 | |
| 713 | Under MSVC 6: |
| 714 | |
Tim Peters | 1c73323 | 2001-01-08 04:02:07 +0000 | [diff] [blame] | 715 | + MS threadsafe getc is very slow (multiple layers of function calls before+ |
| 716 | after each character, to lock+unlock the stream). |
| 717 | + The stream-locking functions are MS-internal -- can't access them from user |
| 718 | code. |
| 719 | + There's nothing Tim could find in the MS C or platform SDK libraries that |
| 720 | can worm around this. |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 721 | + MS fgets locks/unlocks only once per line; it's the only hook we have. |
| 722 | |
| 723 | So we use fgets for speed(!), despite that it's painful. |
| 724 | |
| 725 | MS realloc is also slow. |
| 726 | |
Tim Peters | f29b64d | 2001-01-15 06:33:19 +0000 | [diff] [blame] | 727 | Reports from other platforms on this method vs getc_unlocked (which MS doesn't |
| 728 | have): |
| 729 | Linux a wash |
| 730 | Solaris a wash |
| 731 | Tru64 Unix getline_via_fgets significantly faster |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 732 | |
Tim Peters | f29b64d | 2001-01-15 06:33:19 +0000 | [diff] [blame] | 733 | CAUTION: The C std isn't clear about this: in those cases where fgets |
| 734 | writes something into the buffer, can it write into any position beyond the |
| 735 | required trailing null byte? MSVC 6 fgets does not, and no platform is (yet) |
| 736 | known on which it does; and it would be a strange way to code fgets. Still, |
| 737 | getline_via_fgets may not work correctly if it does. The std test |
| 738 | test_bufio.py should fail if platform fgets() routinely writes beyond the |
| 739 | trailing null byte. #define DONT_USE_FGETS_IN_GETLINE to disable this code. |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 740 | **************************************************************************/ |
| 741 | |
Tim Peters | f29b64d | 2001-01-15 06:33:19 +0000 | [diff] [blame] | 742 | /* Use this routine if told to, or by default on non-get_unlocked() |
| 743 | * platforms unless told not to. Yikes! Let's spell that out: |
| 744 | * On a platform with getc_unlocked(): |
| 745 | * By default, use getc_unlocked(). |
| 746 | * If you want to use fgets() instead, #define USE_FGETS_IN_GETLINE. |
| 747 | * On a platform without getc_unlocked(): |
| 748 | * By default, use fgets(). |
| 749 | * If you don't want to use fgets(), #define DONT_USE_FGETS_IN_GETLINE. |
| 750 | */ |
| 751 | #if !defined(USE_FGETS_IN_GETLINE) && !defined(HAVE_GETC_UNLOCKED) |
| 752 | #define USE_FGETS_IN_GETLINE |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 753 | #endif |
| 754 | |
Tim Peters | f29b64d | 2001-01-15 06:33:19 +0000 | [diff] [blame] | 755 | #if defined(DONT_USE_FGETS_IN_GETLINE) && defined(USE_FGETS_IN_GETLINE) |
| 756 | #undef USE_FGETS_IN_GETLINE |
| 757 | #endif |
| 758 | |
| 759 | #ifdef USE_FGETS_IN_GETLINE |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 760 | static PyObject* |
Tim Peters | f29b64d | 2001-01-15 06:33:19 +0000 | [diff] [blame] | 761 | getline_via_fgets(FILE *fp) |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 762 | { |
Tim Peters | 15b8385 | 2001-01-08 00:53:12 +0000 | [diff] [blame] | 763 | /* INITBUFSIZE is the maximum line length that lets us get away with the fast |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 764 | * no-realloc, one-fgets()-call path. Boosting it isn't free, because we have |
| 765 | * to fill this much of the buffer with a known value in order to figure out |
| 766 | * how much of the buffer fgets() overwrites. So if INITBUFSIZE is larger |
| 767 | * than "most" lines, we waste time filling unused buffer slots. 100 is |
| 768 | * surely adequate for most peoples' email archives, chewing over source code, |
| 769 | * etc -- "regular old text files". |
| 770 | * MAXBUFSIZE is the maximum line length that lets us get away with the less |
| 771 | * fast (but still zippy) no-realloc, two-fgets()-call path. See above for |
| 772 | * cautions about boosting that. 300 was chosen because the worst real-life |
| 773 | * text-crunching job reported on Python-Dev was a mail-log crawler where over |
| 774 | * half the lines were 254 chars. |
Tim Peters | 15b8385 | 2001-01-08 00:53:12 +0000 | [diff] [blame] | 775 | */ |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 776 | #define INITBUFSIZE 100 |
| 777 | #define MAXBUFSIZE 300 |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 778 | char* p; /* temp */ |
| 779 | char buf[MAXBUFSIZE]; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 780 | PyObject* v; /* the string object result */ |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 781 | char* pvfree; /* address of next free slot */ |
| 782 | char* pvend; /* address one beyond last free slot */ |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 783 | size_t nfree; /* # of free buffer slots; pvend-pvfree */ |
| 784 | size_t total_v_size; /* total # of slots in buffer */ |
Tim Peters | ddea208 | 2002-03-23 10:03:50 +0000 | [diff] [blame] | 785 | size_t increment; /* amount to increment the buffer */ |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 786 | |
Tim Peters | 15b8385 | 2001-01-08 00:53:12 +0000 | [diff] [blame] | 787 | /* Optimize for normal case: avoid _PyString_Resize if at all |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 788 | * possible via first reading into stack buffer "buf". |
Tim Peters | 15b8385 | 2001-01-08 00:53:12 +0000 | [diff] [blame] | 789 | */ |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 790 | total_v_size = INITBUFSIZE; /* start small and pray */ |
| 791 | pvfree = buf; |
| 792 | for (;;) { |
| 793 | Py_BEGIN_ALLOW_THREADS |
| 794 | pvend = buf + total_v_size; |
| 795 | nfree = pvend - pvfree; |
| 796 | memset(pvfree, '\n', nfree); |
| 797 | p = fgets(pvfree, nfree, fp); |
| 798 | Py_END_ALLOW_THREADS |
Tim Peters | 15b8385 | 2001-01-08 00:53:12 +0000 | [diff] [blame] | 799 | |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 800 | if (p == NULL) { |
| 801 | clearerr(fp); |
| 802 | if (PyErr_CheckSignals()) |
| 803 | return NULL; |
| 804 | v = PyString_FromStringAndSize(buf, pvfree - buf); |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 805 | return v; |
| 806 | } |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 807 | /* fgets read *something* */ |
| 808 | p = memchr(pvfree, '\n', nfree); |
| 809 | if (p != NULL) { |
| 810 | /* Did the \n come from fgets or from us? |
| 811 | * Since fgets stops at the first \n, and then writes |
| 812 | * \0, if it's from fgets a \0 must be next. But if |
| 813 | * that's so, it could not have come from us, since |
| 814 | * the \n's we filled the buffer with have only more |
| 815 | * \n's to the right. |
| 816 | */ |
| 817 | if (p+1 < pvend && *(p+1) == '\0') { |
| 818 | /* It's from fgets: we win! In particular, |
| 819 | * we haven't done any mallocs yet, and can |
| 820 | * build the final result on the first try. |
| 821 | */ |
| 822 | ++p; /* include \n from fgets */ |
| 823 | } |
| 824 | else { |
| 825 | /* Must be from us: fgets didn't fill the |
| 826 | * buffer and didn't find a newline, so it |
| 827 | * must be the last and newline-free line of |
| 828 | * the file. |
| 829 | */ |
| 830 | assert(p > pvfree && *(p-1) == '\0'); |
| 831 | --p; /* don't include \0 from fgets */ |
| 832 | } |
| 833 | v = PyString_FromStringAndSize(buf, p - buf); |
| 834 | return v; |
| 835 | } |
| 836 | /* yuck: fgets overwrote all the newlines, i.e. the entire |
| 837 | * buffer. So this line isn't over yet, or maybe it is but |
| 838 | * we're exactly at EOF. If we haven't already, try using the |
| 839 | * rest of the stack buffer. |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 840 | */ |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 841 | assert(*(pvend-1) == '\0'); |
| 842 | if (pvfree == buf) { |
| 843 | pvfree = pvend - 1; /* overwrite trailing null */ |
| 844 | total_v_size = MAXBUFSIZE; |
| 845 | } |
| 846 | else |
| 847 | break; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 848 | } |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 849 | |
| 850 | /* The stack buffer isn't big enough; malloc a string object and read |
| 851 | * into its buffer. |
Tim Peters | 15b8385 | 2001-01-08 00:53:12 +0000 | [diff] [blame] | 852 | */ |
Tim Peters | ddea208 | 2002-03-23 10:03:50 +0000 | [diff] [blame] | 853 | total_v_size = MAXBUFSIZE << 1; |
Tim Peters | 1c73323 | 2001-01-08 04:02:07 +0000 | [diff] [blame] | 854 | v = PyString_FromStringAndSize((char*)NULL, (int)total_v_size); |
Tim Peters | 15b8385 | 2001-01-08 00:53:12 +0000 | [diff] [blame] | 855 | if (v == NULL) |
| 856 | return v; |
| 857 | /* copy over everything except the last null byte */ |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 858 | memcpy(BUF(v), buf, MAXBUFSIZE-1); |
| 859 | pvfree = BUF(v) + MAXBUFSIZE - 1; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 860 | |
| 861 | /* Keep reading stuff into v; if it ever ends successfully, break |
Tim Peters | 15b8385 | 2001-01-08 00:53:12 +0000 | [diff] [blame] | 862 | * after setting p one beyond the end of the line. The code here is |
| 863 | * very much like the code above, except reads into v's buffer; see |
| 864 | * the code above for detailed comments about the logic. |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 865 | */ |
| 866 | for (;;) { |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 867 | Py_BEGIN_ALLOW_THREADS |
| 868 | pvend = BUF(v) + total_v_size; |
| 869 | nfree = pvend - pvfree; |
| 870 | memset(pvfree, '\n', nfree); |
| 871 | p = fgets(pvfree, nfree, fp); |
| 872 | Py_END_ALLOW_THREADS |
| 873 | |
| 874 | if (p == NULL) { |
| 875 | clearerr(fp); |
| 876 | if (PyErr_CheckSignals()) { |
| 877 | Py_DECREF(v); |
| 878 | return NULL; |
| 879 | } |
| 880 | p = pvfree; |
| 881 | break; |
| 882 | } |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 883 | p = memchr(pvfree, '\n', nfree); |
| 884 | if (p != NULL) { |
| 885 | if (p+1 < pvend && *(p+1) == '\0') { |
| 886 | /* \n came from fgets */ |
| 887 | ++p; |
| 888 | break; |
| 889 | } |
| 890 | /* \n came from us; last line of file, no newline */ |
| 891 | assert(p > pvfree && *(p-1) == '\0'); |
| 892 | --p; |
| 893 | break; |
| 894 | } |
| 895 | /* expand buffer and try again */ |
| 896 | assert(*(pvend-1) == '\0'); |
Tim Peters | ddea208 | 2002-03-23 10:03:50 +0000 | [diff] [blame] | 897 | increment = total_v_size >> 2; /* mild exponential growth */ |
| 898 | total_v_size += increment; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 899 | if (total_v_size > INT_MAX) { |
| 900 | PyErr_SetString(PyExc_OverflowError, |
| 901 | "line is longer than a Python string can hold"); |
| 902 | Py_DECREF(v); |
| 903 | return NULL; |
| 904 | } |
| 905 | if (_PyString_Resize(&v, (int)total_v_size) < 0) |
| 906 | return NULL; |
| 907 | /* overwrite the trailing null byte */ |
Tim Peters | ddea208 | 2002-03-23 10:03:50 +0000 | [diff] [blame] | 908 | pvfree = BUF(v) + (total_v_size - increment - 1); |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 909 | } |
| 910 | if (BUF(v) + total_v_size != p) |
| 911 | _PyString_Resize(&v, p - BUF(v)); |
| 912 | return v; |
| 913 | #undef INITBUFSIZE |
Tim Peters | 142297a | 2001-01-15 10:36:56 +0000 | [diff] [blame] | 914 | #undef MAXBUFSIZE |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 915 | } |
Tim Peters | f29b64d | 2001-01-15 06:33:19 +0000 | [diff] [blame] | 916 | #endif /* ifdef USE_FGETS_IN_GETLINE */ |
Guido van Rossum | fdf95dd | 1997-05-05 22:15:02 +0000 | [diff] [blame] | 917 | |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 918 | /* Internal routine to get a line. |
| 919 | Size argument interpretation: |
| 920 | > 0: max length; |
Guido van Rossum | 8628206 | 2001-01-08 01:26:47 +0000 | [diff] [blame] | 921 | <= 0: read arbitrary line |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 922 | */ |
| 923 | |
Guido van Rossum | 1187aa4 | 2001-01-05 14:43:05 +0000 | [diff] [blame] | 924 | #ifdef HAVE_GETC_UNLOCKED |
| 925 | #define GETC(f) getc_unlocked(f) |
| 926 | #define FLOCKFILE(f) flockfile(f) |
| 927 | #define FUNLOCKFILE(f) funlockfile(f) |
| 928 | #else |
| 929 | #define GETC(f) getc(f) |
| 930 | #define FLOCKFILE(f) |
| 931 | #define FUNLOCKFILE(f) |
| 932 | #endif |
| 933 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 934 | static PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 935 | get_line(PyFileObject *f, int n) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 936 | { |
Guido van Rossum | 1187aa4 | 2001-01-05 14:43:05 +0000 | [diff] [blame] | 937 | FILE *fp = f->f_fp; |
| 938 | int c; |
Andrew M. Kuchling | 4b2b445 | 2000-11-29 02:53:22 +0000 | [diff] [blame] | 939 | char *buf, *end; |
Neil Schemenauer | 3a204a7 | 2002-03-23 19:41:34 +0000 | [diff] [blame] | 940 | size_t total_v_size; /* total # of slots in buffer */ |
| 941 | size_t used_v_size; /* # used slots in buffer */ |
| 942 | size_t increment; /* amount to increment the buffer */ |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 943 | PyObject *v; |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 944 | |
Tim Peters | f29b64d | 2001-01-15 06:33:19 +0000 | [diff] [blame] | 945 | #ifdef USE_FGETS_IN_GETLINE |
Guido van Rossum | 8628206 | 2001-01-08 01:26:47 +0000 | [diff] [blame] | 946 | if (n <= 0) |
Tim Peters | f29b64d | 2001-01-15 06:33:19 +0000 | [diff] [blame] | 947 | return getline_via_fgets(fp); |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 948 | #endif |
Neil Schemenauer | 3a204a7 | 2002-03-23 19:41:34 +0000 | [diff] [blame] | 949 | total_v_size = n > 0 ? n : 100; |
| 950 | v = PyString_FromStringAndSize((char *)NULL, total_v_size); |
Guido van Rossum | 3f5da24 | 1990-12-20 15:06:42 +0000 | [diff] [blame] | 951 | if (v == NULL) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 952 | return NULL; |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 953 | buf = BUF(v); |
Neil Schemenauer | 3a204a7 | 2002-03-23 19:41:34 +0000 | [diff] [blame] | 954 | end = buf + total_v_size; |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 955 | |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 956 | for (;;) { |
Guido van Rossum | 1187aa4 | 2001-01-05 14:43:05 +0000 | [diff] [blame] | 957 | Py_BEGIN_ALLOW_THREADS |
| 958 | FLOCKFILE(fp); |
| 959 | while ((c = GETC(fp)) != EOF && |
| 960 | (*buf++ = c) != '\n' && |
| 961 | buf != end) |
| 962 | ; |
| 963 | FUNLOCKFILE(fp); |
| 964 | Py_END_ALLOW_THREADS |
| 965 | if (c == '\n') |
| 966 | break; |
| 967 | if (c == EOF) { |
Guido van Rossum | 29206bc | 2001-08-09 18:14:59 +0000 | [diff] [blame] | 968 | if (ferror(fp)) { |
| 969 | PyErr_SetFromErrno(PyExc_IOError); |
| 970 | clearerr(fp); |
| 971 | Py_DECREF(v); |
| 972 | return NULL; |
| 973 | } |
Guido van Rossum | 76ad8ed | 1991-06-03 10:54:55 +0000 | [diff] [blame] | 974 | clearerr(fp); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 975 | if (PyErr_CheckSignals()) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 976 | Py_DECREF(v); |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 977 | return NULL; |
| 978 | } |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 979 | break; |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 980 | } |
Guido van Rossum | 1187aa4 | 2001-01-05 14:43:05 +0000 | [diff] [blame] | 981 | /* Must be because buf == end */ |
| 982 | if (n > 0) |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 983 | break; |
Neil Schemenauer | 3a204a7 | 2002-03-23 19:41:34 +0000 | [diff] [blame] | 984 | used_v_size = total_v_size; |
| 985 | increment = total_v_size >> 2; /* mild exponential growth */ |
| 986 | total_v_size += increment; |
| 987 | if (total_v_size > INT_MAX) { |
Guido van Rossum | 1187aa4 | 2001-01-05 14:43:05 +0000 | [diff] [blame] | 988 | PyErr_SetString(PyExc_OverflowError, |
| 989 | "line is longer than a Python string can hold"); |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 990 | Py_DECREF(v); |
Guido van Rossum | 1187aa4 | 2001-01-05 14:43:05 +0000 | [diff] [blame] | 991 | return NULL; |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 992 | } |
Neil Schemenauer | 3a204a7 | 2002-03-23 19:41:34 +0000 | [diff] [blame] | 993 | if (_PyString_Resize(&v, total_v_size) < 0) |
Guido van Rossum | 1187aa4 | 2001-01-05 14:43:05 +0000 | [diff] [blame] | 994 | return NULL; |
Neil Schemenauer | 3a204a7 | 2002-03-23 19:41:34 +0000 | [diff] [blame] | 995 | buf = BUF(v) + used_v_size; |
| 996 | end = BUF(v) + total_v_size; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 997 | } |
Guido van Rossum | 1984f1e | 1992-08-04 12:41:02 +0000 | [diff] [blame] | 998 | |
Neil Schemenauer | 3a204a7 | 2002-03-23 19:41:34 +0000 | [diff] [blame] | 999 | used_v_size = buf - BUF(v); |
| 1000 | if (used_v_size != total_v_size) |
| 1001 | _PyString_Resize(&v, used_v_size); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1002 | return v; |
| 1003 | } |
| 1004 | |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 1005 | /* External C interface */ |
| 1006 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1007 | PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 1008 | PyFile_GetLine(PyObject *f, int n) |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 1009 | { |
Guido van Rossum | 4ddf0a0 | 2001-01-07 20:51:39 +0000 | [diff] [blame] | 1010 | PyObject *result; |
| 1011 | |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1012 | if (f == NULL) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1013 | PyErr_BadInternalCall(); |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 1014 | return NULL; |
| 1015 | } |
Guido van Rossum | 4ddf0a0 | 2001-01-07 20:51:39 +0000 | [diff] [blame] | 1016 | |
| 1017 | if (PyFile_Check(f)) { |
| 1018 | if (((PyFileObject*)f)->f_fp == NULL) |
| 1019 | return err_closed(); |
| 1020 | result = get_line((PyFileObject *)f, n); |
| 1021 | } |
| 1022 | else { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1023 | PyObject *reader; |
| 1024 | PyObject *args; |
Guido van Rossum | 4ddf0a0 | 2001-01-07 20:51:39 +0000 | [diff] [blame] | 1025 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1026 | reader = PyObject_GetAttrString(f, "readline"); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1027 | if (reader == NULL) |
| 1028 | return NULL; |
| 1029 | if (n <= 0) |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1030 | args = Py_BuildValue("()"); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1031 | else |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1032 | args = Py_BuildValue("(i)", n); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1033 | if (args == NULL) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1034 | Py_DECREF(reader); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1035 | return NULL; |
| 1036 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1037 | result = PyEval_CallObject(reader, args); |
| 1038 | Py_DECREF(reader); |
| 1039 | Py_DECREF(args); |
| 1040 | if (result != NULL && !PyString_Check(result)) { |
| 1041 | Py_DECREF(result); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1042 | result = NULL; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1043 | PyErr_SetString(PyExc_TypeError, |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1044 | "object.readline() returned non-string"); |
| 1045 | } |
Guido van Rossum | 4ddf0a0 | 2001-01-07 20:51:39 +0000 | [diff] [blame] | 1046 | } |
| 1047 | |
| 1048 | if (n < 0 && result != NULL && PyString_Check(result)) { |
| 1049 | char *s = PyString_AS_STRING(result); |
| 1050 | int len = PyString_GET_SIZE(result); |
| 1051 | if (len == 0) { |
| 1052 | Py_DECREF(result); |
| 1053 | result = NULL; |
| 1054 | PyErr_SetString(PyExc_EOFError, |
| 1055 | "EOF when reading a line"); |
| 1056 | } |
| 1057 | else if (s[len-1] == '\n') { |
| 1058 | if (result->ob_refcnt == 1) |
| 1059 | _PyString_Resize(&result, len-1); |
| 1060 | else { |
| 1061 | PyObject *v; |
| 1062 | v = PyString_FromStringAndSize(s, len-1); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1063 | Py_DECREF(result); |
Guido van Rossum | 4ddf0a0 | 2001-01-07 20:51:39 +0000 | [diff] [blame] | 1064 | result = v; |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1065 | } |
| 1066 | } |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1067 | } |
Guido van Rossum | 4ddf0a0 | 2001-01-07 20:51:39 +0000 | [diff] [blame] | 1068 | return result; |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 1069 | } |
| 1070 | |
| 1071 | /* Python method */ |
| 1072 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1073 | static PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 1074 | file_readline(PyFileObject *f, PyObject *args) |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 1075 | { |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 1076 | int n = -1; |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 1077 | |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 1078 | if (f->f_fp == NULL) |
| 1079 | return err_closed(); |
Guido van Rossum | 43713e5 | 2000-02-29 13:59:29 +0000 | [diff] [blame] | 1080 | if (!PyArg_ParseTuple(args, "|i:readline", &n)) |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 1081 | return NULL; |
| 1082 | if (n == 0) |
| 1083 | return PyString_FromString(""); |
| 1084 | if (n < 0) |
| 1085 | n = 0; |
Marc-André Lemburg | 1f46860 | 2000-07-05 15:32:40 +0000 | [diff] [blame] | 1086 | return get_line(f, n); |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 1087 | } |
| 1088 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1089 | static PyObject * |
Martin v. Löwis | e3eb1f2 | 2001-08-16 13:15:00 +0000 | [diff] [blame] | 1090 | file_xreadlines(PyFileObject *f) |
Guido van Rossum | e07d5cf | 2001-01-09 21:50:24 +0000 | [diff] [blame] | 1091 | { |
| 1092 | static PyObject* xreadlines_function = NULL; |
Tim Peters | f29b64d | 2001-01-15 06:33:19 +0000 | [diff] [blame] | 1093 | |
Neal Norwitz | 649b759 | 2002-01-01 19:07:13 +0000 | [diff] [blame] | 1094 | if (f->f_fp == NULL) |
| 1095 | return err_closed(); |
Guido van Rossum | e07d5cf | 2001-01-09 21:50:24 +0000 | [diff] [blame] | 1096 | if (!xreadlines_function) { |
| 1097 | PyObject *xreadlines_module = |
| 1098 | PyImport_ImportModule("xreadlines"); |
| 1099 | if(!xreadlines_module) |
| 1100 | return NULL; |
| 1101 | |
| 1102 | xreadlines_function = PyObject_GetAttrString(xreadlines_module, |
| 1103 | "xreadlines"); |
| 1104 | Py_DECREF(xreadlines_module); |
| 1105 | if(!xreadlines_function) |
| 1106 | return NULL; |
| 1107 | } |
| 1108 | return PyObject_CallFunction(xreadlines_function, "(O)", f); |
| 1109 | } |
| 1110 | |
| 1111 | static PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 1112 | file_readlines(PyFileObject *f, PyObject *args) |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 1113 | { |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 1114 | long sizehint = 0; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1115 | PyObject *list; |
| 1116 | PyObject *line; |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 1117 | char small_buffer[SMALLCHUNK]; |
| 1118 | char *buffer = small_buffer; |
| 1119 | size_t buffersize = SMALLCHUNK; |
| 1120 | PyObject *big_buffer = NULL; |
| 1121 | size_t nfilled = 0; |
| 1122 | size_t nread; |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 1123 | size_t totalread = 0; |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 1124 | char *p, *q, *end; |
| 1125 | int err; |
Guido van Rossum | 79fd0fc | 2001-10-12 20:01:53 +0000 | [diff] [blame] | 1126 | int shortread = 0; |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 1127 | |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 1128 | if (f->f_fp == NULL) |
| 1129 | return err_closed(); |
Guido van Rossum | 43713e5 | 2000-02-29 13:59:29 +0000 | [diff] [blame] | 1130 | if (!PyArg_ParseTuple(args, "|l:readlines", &sizehint)) |
Guido van Rossum | 0bd2441 | 1991-04-04 15:21:57 +0000 | [diff] [blame] | 1131 | return NULL; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1132 | if ((list = PyList_New(0)) == NULL) |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 1133 | return NULL; |
| 1134 | for (;;) { |
Guido van Rossum | 79fd0fc | 2001-10-12 20:01:53 +0000 | [diff] [blame] | 1135 | if (shortread) |
| 1136 | nread = 0; |
| 1137 | else { |
| 1138 | Py_BEGIN_ALLOW_THREADS |
| 1139 | errno = 0; |
| 1140 | nread = fread(buffer+nfilled, 1, |
| 1141 | buffersize-nfilled, f->f_fp); |
| 1142 | Py_END_ALLOW_THREADS |
| 1143 | shortread = (nread < buffersize-nfilled); |
| 1144 | } |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 1145 | if (nread == 0) { |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 1146 | sizehint = 0; |
Guido van Rossum | 3da3fce | 1998-02-19 20:46:48 +0000 | [diff] [blame] | 1147 | if (!ferror(f->f_fp)) |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 1148 | break; |
| 1149 | PyErr_SetFromErrno(PyExc_IOError); |
| 1150 | clearerr(f->f_fp); |
| 1151 | error: |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1152 | Py_DECREF(list); |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 1153 | list = NULL; |
| 1154 | goto cleanup; |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 1155 | } |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 1156 | totalread += nread; |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 1157 | p = memchr(buffer+nfilled, '\n', nread); |
| 1158 | if (p == NULL) { |
| 1159 | /* Need a larger buffer to fit this line */ |
| 1160 | nfilled += nread; |
| 1161 | buffersize *= 2; |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 1162 | if (buffersize > INT_MAX) { |
| 1163 | PyErr_SetString(PyExc_OverflowError, |
Guido van Rossum | e07d5cf | 2001-01-09 21:50:24 +0000 | [diff] [blame] | 1164 | "line is longer than a Python string can hold"); |
Trent Mick | f29f47b | 2000-08-11 19:02:59 +0000 | [diff] [blame] | 1165 | goto error; |
| 1166 | } |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 1167 | if (big_buffer == NULL) { |
| 1168 | /* Create the big buffer */ |
| 1169 | big_buffer = PyString_FromStringAndSize( |
| 1170 | NULL, buffersize); |
| 1171 | if (big_buffer == NULL) |
| 1172 | goto error; |
| 1173 | buffer = PyString_AS_STRING(big_buffer); |
| 1174 | memcpy(buffer, small_buffer, nfilled); |
| 1175 | } |
| 1176 | else { |
| 1177 | /* Grow the big buffer */ |
| 1178 | _PyString_Resize(&big_buffer, buffersize); |
| 1179 | buffer = PyString_AS_STRING(big_buffer); |
| 1180 | } |
| 1181 | continue; |
| 1182 | } |
| 1183 | end = buffer+nfilled+nread; |
| 1184 | q = buffer; |
| 1185 | do { |
| 1186 | /* Process complete lines */ |
| 1187 | p++; |
| 1188 | line = PyString_FromStringAndSize(q, p-q); |
| 1189 | if (line == NULL) |
| 1190 | goto error; |
| 1191 | err = PyList_Append(list, line); |
| 1192 | Py_DECREF(line); |
| 1193 | if (err != 0) |
| 1194 | goto error; |
| 1195 | q = p; |
| 1196 | p = memchr(q, '\n', end-q); |
| 1197 | } while (p != NULL); |
| 1198 | /* Move the remaining incomplete line to the start */ |
| 1199 | nfilled = end-q; |
| 1200 | memmove(buffer, q, nfilled); |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 1201 | if (sizehint > 0) |
| 1202 | if (totalread >= (size_t)sizehint) |
| 1203 | break; |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 1204 | } |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 1205 | if (nfilled != 0) { |
| 1206 | /* Partial last line */ |
| 1207 | line = PyString_FromStringAndSize(buffer, nfilled); |
| 1208 | if (line == NULL) |
| 1209 | goto error; |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 1210 | if (sizehint > 0) { |
| 1211 | /* Need to complete the last line */ |
Marc-André Lemburg | 1f46860 | 2000-07-05 15:32:40 +0000 | [diff] [blame] | 1212 | PyObject *rest = get_line(f, 0); |
Guido van Rossum | 789a161 | 1997-05-10 22:33:55 +0000 | [diff] [blame] | 1213 | if (rest == NULL) { |
| 1214 | Py_DECREF(line); |
| 1215 | goto error; |
| 1216 | } |
| 1217 | PyString_Concat(&line, rest); |
| 1218 | Py_DECREF(rest); |
| 1219 | if (line == NULL) |
| 1220 | goto error; |
| 1221 | } |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 1222 | err = PyList_Append(list, line); |
| 1223 | Py_DECREF(line); |
| 1224 | if (err != 0) |
| 1225 | goto error; |
| 1226 | } |
| 1227 | cleanup: |
Guido van Rossum | 1109fbc | 1998-04-10 22:16:39 +0000 | [diff] [blame] | 1228 | if (big_buffer) { |
Guido van Rossum | 6263d54 | 1997-05-10 22:07:25 +0000 | [diff] [blame] | 1229 | Py_DECREF(big_buffer); |
Guido van Rossum | 1109fbc | 1998-04-10 22:16:39 +0000 | [diff] [blame] | 1230 | } |
Guido van Rossum | ce5ba84 | 1991-03-06 13:06:18 +0000 | [diff] [blame] | 1231 | return list; |
| 1232 | } |
| 1233 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1234 | static PyObject * |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 1235 | file_write(PyFileObject *f, PyObject *args) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1236 | { |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 1237 | char *s; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1238 | int n, n2; |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 1239 | if (f->f_fp == NULL) |
| 1240 | return err_closed(); |
Michael W. Hudson | e2ec3eb | 2001-10-31 18:51:01 +0000 | [diff] [blame] | 1241 | if (!PyArg_ParseTuple(args, f->f_binary ? "s#" : "t#", &s, &n)) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1242 | return NULL; |
Guido van Rossum | eb183da | 1991-04-04 10:44:06 +0000 | [diff] [blame] | 1243 | f->f_softspace = 0; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1244 | Py_BEGIN_ALLOW_THREADS |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1245 | errno = 0; |
Guido van Rossum | d7297e6 | 1992-07-06 14:19:26 +0000 | [diff] [blame] | 1246 | n2 = fwrite(s, 1, n, f->f_fp); |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1247 | Py_END_ALLOW_THREADS |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1248 | if (n2 != n) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1249 | PyErr_SetFromErrno(PyExc_IOError); |
Guido van Rossum | febd551 | 1992-03-04 16:39:24 +0000 | [diff] [blame] | 1250 | clearerr(f->f_fp); |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1251 | return NULL; |
| 1252 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1253 | Py_INCREF(Py_None); |
| 1254 | return Py_None; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1255 | } |
| 1256 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1257 | static PyObject * |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1258 | file_writelines(PyFileObject *f, PyObject *seq) |
Guido van Rossum | 5a2a683 | 1993-10-25 09:59:04 +0000 | [diff] [blame] | 1259 | { |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1260 | #define CHUNKSIZE 1000 |
| 1261 | PyObject *list, *line; |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1262 | PyObject *it; /* iter(seq) */ |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1263 | PyObject *result; |
| 1264 | int i, j, index, len, nwritten, islist; |
| 1265 | |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1266 | assert(seq != NULL); |
Guido van Rossum | 5a2a683 | 1993-10-25 09:59:04 +0000 | [diff] [blame] | 1267 | if (f->f_fp == NULL) |
| 1268 | return err_closed(); |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1269 | |
| 1270 | result = NULL; |
| 1271 | list = NULL; |
| 1272 | islist = PyList_Check(seq); |
| 1273 | if (islist) |
| 1274 | it = NULL; |
| 1275 | else { |
| 1276 | it = PyObject_GetIter(seq); |
| 1277 | if (it == NULL) { |
| 1278 | PyErr_SetString(PyExc_TypeError, |
| 1279 | "writelines() requires an iterable argument"); |
| 1280 | return NULL; |
| 1281 | } |
| 1282 | /* From here on, fail by going to error, to reclaim "it". */ |
| 1283 | list = PyList_New(CHUNKSIZE); |
| 1284 | if (list == NULL) |
| 1285 | goto error; |
Guido van Rossum | 5a2a683 | 1993-10-25 09:59:04 +0000 | [diff] [blame] | 1286 | } |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1287 | |
| 1288 | /* Strategy: slurp CHUNKSIZE lines into a private list, |
| 1289 | checking that they are all strings, then write that list |
| 1290 | without holding the interpreter lock, then come back for more. */ |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1291 | for (index = 0; ; index += CHUNKSIZE) { |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1292 | if (islist) { |
| 1293 | Py_XDECREF(list); |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1294 | list = PyList_GetSlice(seq, index, index+CHUNKSIZE); |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1295 | if (list == NULL) |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1296 | goto error; |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1297 | j = PyList_GET_SIZE(list); |
| 1298 | } |
| 1299 | else { |
| 1300 | for (j = 0; j < CHUNKSIZE; j++) { |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1301 | line = PyIter_Next(it); |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1302 | if (line == NULL) { |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1303 | if (PyErr_Occurred()) |
| 1304 | goto error; |
| 1305 | break; |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1306 | } |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1307 | PyList_SetItem(list, j, line); |
| 1308 | } |
| 1309 | } |
| 1310 | if (j == 0) |
| 1311 | break; |
| 1312 | |
Marc-André Lemburg | 6ef68b5 | 2000-08-25 22:39:50 +0000 | [diff] [blame] | 1313 | /* Check that all entries are indeed strings. If not, |
| 1314 | apply the same rules as for file.write() and |
| 1315 | convert the results to strings. This is slow, but |
| 1316 | seems to be the only way since all conversion APIs |
| 1317 | could potentially execute Python code. */ |
| 1318 | for (i = 0; i < j; i++) { |
| 1319 | PyObject *v = PyList_GET_ITEM(list, i); |
| 1320 | if (!PyString_Check(v)) { |
| 1321 | const char *buffer; |
| 1322 | int len; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 1323 | if (((f->f_binary && |
Marc-André Lemburg | 6ef68b5 | 2000-08-25 22:39:50 +0000 | [diff] [blame] | 1324 | PyObject_AsReadBuffer(v, |
| 1325 | (const void**)&buffer, |
| 1326 | &len)) || |
| 1327 | PyObject_AsCharBuffer(v, |
| 1328 | &buffer, |
| 1329 | &len))) { |
| 1330 | PyErr_SetString(PyExc_TypeError, |
Fred Drake | 661ea26 | 2000-10-24 19:57:45 +0000 | [diff] [blame] | 1331 | "writelines() argument must be a sequence of strings"); |
Marc-André Lemburg | 6ef68b5 | 2000-08-25 22:39:50 +0000 | [diff] [blame] | 1332 | goto error; |
| 1333 | } |
| 1334 | line = PyString_FromStringAndSize(buffer, |
| 1335 | len); |
| 1336 | if (line == NULL) |
| 1337 | goto error; |
| 1338 | Py_DECREF(v); |
Marc-André Lemburg | f5e96fa | 2000-08-25 22:49:05 +0000 | [diff] [blame] | 1339 | PyList_SET_ITEM(list, i, line); |
Marc-André Lemburg | 6ef68b5 | 2000-08-25 22:39:50 +0000 | [diff] [blame] | 1340 | } |
| 1341 | } |
| 1342 | |
| 1343 | /* Since we are releasing the global lock, the |
| 1344 | following code may *not* execute Python code. */ |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1345 | Py_BEGIN_ALLOW_THREADS |
| 1346 | f->f_softspace = 0; |
| 1347 | errno = 0; |
| 1348 | for (i = 0; i < j; i++) { |
Marc-André Lemburg | 6ef68b5 | 2000-08-25 22:39:50 +0000 | [diff] [blame] | 1349 | line = PyList_GET_ITEM(list, i); |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1350 | len = PyString_GET_SIZE(line); |
| 1351 | nwritten = fwrite(PyString_AS_STRING(line), |
| 1352 | 1, len, f->f_fp); |
| 1353 | if (nwritten != len) { |
| 1354 | Py_BLOCK_THREADS |
| 1355 | PyErr_SetFromErrno(PyExc_IOError); |
| 1356 | clearerr(f->f_fp); |
| 1357 | goto error; |
| 1358 | } |
| 1359 | } |
| 1360 | Py_END_ALLOW_THREADS |
| 1361 | |
| 1362 | if (j < CHUNKSIZE) |
| 1363 | break; |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1364 | } |
| 1365 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1366 | Py_INCREF(Py_None); |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1367 | result = Py_None; |
| 1368 | error: |
| 1369 | Py_XDECREF(list); |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1370 | Py_XDECREF(it); |
Guido van Rossum | ee70ad1 | 2000-03-13 16:27:06 +0000 | [diff] [blame] | 1371 | return result; |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1372 | #undef CHUNKSIZE |
Guido van Rossum | 5a2a683 | 1993-10-25 09:59:04 +0000 | [diff] [blame] | 1373 | } |
| 1374 | |
Tim Peters | efc3a3a | 2001-09-20 07:55:22 +0000 | [diff] [blame] | 1375 | static char readline_doc[] = |
| 1376 | "readline([size]) -> next line from the file, as a string.\n" |
| 1377 | "\n" |
| 1378 | "Retain newline. A non-negative size argument limits the maximum\n" |
| 1379 | "number of bytes to return (an incomplete line may be returned then).\n" |
| 1380 | "Return an empty string at EOF."; |
| 1381 | |
| 1382 | static char read_doc[] = |
| 1383 | "read([size]) -> read at most size bytes, returned as a string.\n" |
| 1384 | "\n" |
| 1385 | "If the size argument is negative or omitted, read until EOF is reached."; |
| 1386 | |
| 1387 | static char write_doc[] = |
| 1388 | "write(str) -> None. Write string str to file.\n" |
| 1389 | "\n" |
| 1390 | "Note that due to buffering, flush() or close() may be needed before\n" |
| 1391 | "the file on disk reflects the data written."; |
| 1392 | |
| 1393 | static char fileno_doc[] = |
| 1394 | "fileno() -> integer \"file descriptor\".\n" |
| 1395 | "\n" |
| 1396 | "This is needed for lower-level file interfaces, such os.read()."; |
| 1397 | |
| 1398 | static char seek_doc[] = |
| 1399 | "seek(offset[, whence]) -> None. Move to new file position.\n" |
| 1400 | "\n" |
| 1401 | "Argument offset is a byte count. Optional argument whence defaults to\n" |
| 1402 | "0 (offset from start of file, offset should be >= 0); other values are 1\n" |
| 1403 | "(move relative to current position, positive or negative), and 2 (move\n" |
| 1404 | "relative to end of file, usually negative, although many platforms allow\n" |
| 1405 | "seeking beyond the end of a file).\n" |
| 1406 | "\n" |
| 1407 | "Note that not all file objects are seekable."; |
| 1408 | |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 1409 | #ifdef HAVE_FTRUNCATE |
Tim Peters | efc3a3a | 2001-09-20 07:55:22 +0000 | [diff] [blame] | 1410 | static char truncate_doc[] = |
| 1411 | "truncate([size]) -> None. Truncate the file to at most size bytes.\n" |
| 1412 | "\n" |
| 1413 | "Size defaults to the current file position, as returned by tell()."; |
Guido van Rossum | d7047b3 | 1995-01-02 19:07:15 +0000 | [diff] [blame] | 1414 | #endif |
Tim Peters | efc3a3a | 2001-09-20 07:55:22 +0000 | [diff] [blame] | 1415 | |
| 1416 | static char tell_doc[] = |
| 1417 | "tell() -> current file position, an integer (may be a long integer)."; |
| 1418 | |
| 1419 | static char readinto_doc[] = |
| 1420 | "readinto() -> Undocumented. Don't use this; it may go away."; |
| 1421 | |
| 1422 | static char readlines_doc[] = |
| 1423 | "readlines([size]) -> list of strings, each a line from the file.\n" |
| 1424 | "\n" |
| 1425 | "Call readline() repeatedly and return a list of the lines so read.\n" |
| 1426 | "The optional size argument, if given, is an approximate bound on the\n" |
| 1427 | "total number of bytes in the lines returned."; |
| 1428 | |
| 1429 | static char xreadlines_doc[] = |
| 1430 | "xreadlines() -> next line from the file, as a string.\n" |
| 1431 | "\n" |
| 1432 | "Equivalent to xreadlines.xreadlines(file). This is like readline(), but\n" |
| 1433 | "often quicker, due to reading ahead internally."; |
| 1434 | |
| 1435 | static char writelines_doc[] = |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1436 | "writelines(sequence_of_strings) -> None. Write the strings to the file.\n" |
Tim Peters | efc3a3a | 2001-09-20 07:55:22 +0000 | [diff] [blame] | 1437 | "\n" |
Tim Peters | 2c9aa5e | 2001-09-23 04:06:05 +0000 | [diff] [blame] | 1438 | "Note that newlines are not added. The sequence can be any iterable object\n" |
| 1439 | "producing strings. This is equivalent to calling write() for each string."; |
Tim Peters | efc3a3a | 2001-09-20 07:55:22 +0000 | [diff] [blame] | 1440 | |
| 1441 | static char flush_doc[] = |
| 1442 | "flush() -> None. Flush the internal I/O buffer."; |
| 1443 | |
| 1444 | static char close_doc[] = |
| 1445 | "close() -> None or (perhaps) an integer. Close the file.\n" |
| 1446 | "\n" |
| 1447 | "Sets data attribute .closed to true. A closed file cannot be used for\n" |
| 1448 | "further I/O operations. close() may be called more than once without\n" |
| 1449 | "error. Some kinds of file objects (for example, opened by popen())\n" |
| 1450 | "may return an exit status upon closing."; |
| 1451 | |
| 1452 | static char isatty_doc[] = |
| 1453 | "isatty() -> true or false. True if the file is connected to a tty device."; |
| 1454 | |
| 1455 | static PyMethodDef file_methods[] = { |
| 1456 | {"readline", (PyCFunction)file_readline, METH_VARARGS, readline_doc}, |
| 1457 | {"read", (PyCFunction)file_read, METH_VARARGS, read_doc}, |
Michael W. Hudson | e2ec3eb | 2001-10-31 18:51:01 +0000 | [diff] [blame] | 1458 | {"write", (PyCFunction)file_write, METH_VARARGS, write_doc}, |
Tim Peters | efc3a3a | 2001-09-20 07:55:22 +0000 | [diff] [blame] | 1459 | {"fileno", (PyCFunction)file_fileno, METH_NOARGS, fileno_doc}, |
| 1460 | {"seek", (PyCFunction)file_seek, METH_VARARGS, seek_doc}, |
| 1461 | #ifdef HAVE_FTRUNCATE |
| 1462 | {"truncate", (PyCFunction)file_truncate, METH_VARARGS, truncate_doc}, |
| 1463 | #endif |
| 1464 | {"tell", (PyCFunction)file_tell, METH_NOARGS, tell_doc}, |
Neal Norwitz | 62f5a9d | 2002-04-01 00:09:00 +0000 | [diff] [blame^] | 1465 | {"readinto", (PyCFunction)file_readinto, METH_VARARGS, readinto_doc}, |
Tim Peters | efc3a3a | 2001-09-20 07:55:22 +0000 | [diff] [blame] | 1466 | {"readlines", (PyCFunction)file_readlines, METH_VARARGS, readlines_doc}, |
| 1467 | {"xreadlines", (PyCFunction)file_xreadlines, METH_NOARGS, xreadlines_doc}, |
| 1468 | {"writelines", (PyCFunction)file_writelines, METH_O, writelines_doc}, |
| 1469 | {"flush", (PyCFunction)file_flush, METH_NOARGS, flush_doc}, |
| 1470 | {"close", (PyCFunction)file_close, METH_NOARGS, close_doc}, |
| 1471 | {"isatty", (PyCFunction)file_isatty, METH_NOARGS, isatty_doc}, |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1472 | {NULL, NULL} /* sentinel */ |
| 1473 | }; |
| 1474 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1475 | #define OFF(x) offsetof(PyFileObject, x) |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1476 | |
Guido van Rossum | 6f79937 | 2001-09-20 20:46:19 +0000 | [diff] [blame] | 1477 | static PyMemberDef file_memberlist[] = { |
| 1478 | {"softspace", T_INT, OFF(f_softspace), 0, |
| 1479 | "flag indicating that a space needs to be printed; used by print"}, |
| 1480 | {"mode", T_OBJECT, OFF(f_mode), RO, |
| 1481 | "file mode ('r', 'w', 'a', possibly with 'b' or '+' added)"}, |
| 1482 | {"name", T_OBJECT, OFF(f_name), RO, |
| 1483 | "file name"}, |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1484 | /* getattr(f, "closed") is implemented without this table */ |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1485 | {NULL} /* Sentinel */ |
| 1486 | }; |
| 1487 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1488 | static PyObject * |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1489 | get_closed(PyFileObject *f, void *closure) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1490 | { |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1491 | return PyInt_FromLong((long)(f->f_fp == 0)); |
Guido van Rossum | b6775db | 1994-08-01 11:34:53 +0000 | [diff] [blame] | 1492 | } |
| 1493 | |
Guido van Rossum | 32d34c8 | 2001-09-20 21:45:26 +0000 | [diff] [blame] | 1494 | static PyGetSetDef file_getsetlist[] = { |
| 1495 | {"closed", (getter)get_closed, NULL, "flag set if the file is closed"}, |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1496 | {0}, |
| 1497 | }; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1498 | |
Guido van Rossum | 6596725 | 2001-04-21 13:20:18 +0000 | [diff] [blame] | 1499 | static PyObject * |
Guido van Rossum | 5b02184 | 2001-05-22 16:48:37 +0000 | [diff] [blame] | 1500 | file_getiter(PyObject *f) |
Guido van Rossum | 6596725 | 2001-04-21 13:20:18 +0000 | [diff] [blame] | 1501 | { |
Guido van Rossum | 5b02184 | 2001-05-22 16:48:37 +0000 | [diff] [blame] | 1502 | return PyObject_CallMethod(f, "xreadlines", ""); |
Guido van Rossum | 6596725 | 2001-04-21 13:20:18 +0000 | [diff] [blame] | 1503 | } |
| 1504 | |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 1505 | static PyObject * |
| 1506 | file_new(PyTypeObject *type, PyObject *args, PyObject *kwds) |
| 1507 | { |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 1508 | PyObject *self; |
| 1509 | static PyObject *not_yet_string; |
| 1510 | |
| 1511 | assert(type != NULL && type->tp_alloc != NULL); |
| 1512 | |
| 1513 | if (not_yet_string == NULL) { |
| 1514 | not_yet_string = PyString_FromString("<uninitialized file>"); |
| 1515 | if (not_yet_string == NULL) |
| 1516 | return NULL; |
| 1517 | } |
| 1518 | |
| 1519 | self = type->tp_alloc(type, 0); |
| 1520 | if (self != NULL) { |
| 1521 | /* Always fill in the name and mode, so that nobody else |
| 1522 | needs to special-case NULLs there. */ |
| 1523 | Py_INCREF(not_yet_string); |
| 1524 | ((PyFileObject *)self)->f_name = not_yet_string; |
| 1525 | Py_INCREF(not_yet_string); |
| 1526 | ((PyFileObject *)self)->f_mode = not_yet_string; |
| 1527 | } |
| 1528 | return self; |
| 1529 | } |
| 1530 | |
| 1531 | static int |
| 1532 | file_init(PyObject *self, PyObject *args, PyObject *kwds) |
| 1533 | { |
| 1534 | PyFileObject *foself = (PyFileObject *)self; |
| 1535 | int ret = 0; |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 1536 | static char *kwlist[] = {"name", "mode", "buffering", 0}; |
| 1537 | char *name = NULL; |
| 1538 | char *mode = "r"; |
| 1539 | int bufsize = -1; |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 1540 | |
| 1541 | assert(PyFile_Check(self)); |
| 1542 | if (foself->f_fp != NULL) { |
| 1543 | /* Have to close the existing file first. */ |
| 1544 | PyObject *closeresult = file_close(foself); |
| 1545 | if (closeresult == NULL) |
| 1546 | return -1; |
| 1547 | Py_DECREF(closeresult); |
| 1548 | } |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 1549 | |
| 1550 | if (!PyArg_ParseTupleAndKeywords(args, kwds, "et|si:file", kwlist, |
| 1551 | Py_FileSystemDefaultEncoding, &name, |
| 1552 | &mode, &bufsize)) |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 1553 | return -1; |
| 1554 | if (fill_file_fields(foself, NULL, name, mode, fclose) == NULL) |
| 1555 | goto Error; |
| 1556 | if (open_the_file(foself, name, mode) == NULL) |
| 1557 | goto Error; |
| 1558 | PyFile_SetBufSize(self, bufsize); |
| 1559 | goto Done; |
| 1560 | |
| 1561 | Error: |
| 1562 | ret = -1; |
| 1563 | /* fall through */ |
| 1564 | Done: |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 1565 | PyMem_Free(name); /* free the encoded string */ |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 1566 | return ret; |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 1567 | } |
| 1568 | |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 1569 | static char file_doc[] = |
| 1570 | "file(name[, mode[, buffering]]) -> file object\n" |
| 1571 | "\n" |
| 1572 | "Open a file. The mode can be 'r', 'w' or 'a' for reading (default),\n" |
| 1573 | "writing or appending. The file will be created if it doesn't exist\n" |
| 1574 | "when opened for writing or appending; it will be truncated when\n" |
| 1575 | "opened for writing. Add a 'b' to the mode for binary files.\n" |
| 1576 | "Add a '+' to the mode to allow simultaneous reading and writing.\n" |
| 1577 | "If the buffering argument is given, 0 means unbuffered, 1 means line\n" |
Tim Peters | 742dfd6 | 2001-09-13 21:49:44 +0000 | [diff] [blame] | 1578 | "buffered, and larger numbers specify the buffer size.\n" |
| 1579 | "Note: open() is an alias for file().\n"; |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 1580 | |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1581 | PyTypeObject PyFile_Type = { |
| 1582 | PyObject_HEAD_INIT(&PyType_Type) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1583 | 0, |
| 1584 | "file", |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1585 | sizeof(PyFileObject), |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1586 | 0, |
Guido van Rossum | 6596725 | 2001-04-21 13:20:18 +0000 | [diff] [blame] | 1587 | (destructor)file_dealloc, /* tp_dealloc */ |
| 1588 | 0, /* tp_print */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1589 | 0, /* tp_getattr */ |
| 1590 | 0, /* tp_setattr */ |
Guido van Rossum | 6596725 | 2001-04-21 13:20:18 +0000 | [diff] [blame] | 1591 | 0, /* tp_compare */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1592 | (reprfunc)file_repr, /* tp_repr */ |
Guido van Rossum | 6596725 | 2001-04-21 13:20:18 +0000 | [diff] [blame] | 1593 | 0, /* tp_as_number */ |
| 1594 | 0, /* tp_as_sequence */ |
| 1595 | 0, /* tp_as_mapping */ |
| 1596 | 0, /* tp_hash */ |
| 1597 | 0, /* tp_call */ |
| 1598 | 0, /* tp_str */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1599 | PyObject_GenericGetAttr, /* tp_getattro */ |
Guido van Rossum | 6596725 | 2001-04-21 13:20:18 +0000 | [diff] [blame] | 1600 | 0, /* tp_setattro */ |
| 1601 | 0, /* tp_as_buffer */ |
Guido van Rossum | 9475a23 | 2001-10-05 20:51:39 +0000 | [diff] [blame] | 1602 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 1603 | file_doc, /* tp_doc */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1604 | 0, /* tp_traverse */ |
| 1605 | 0, /* tp_clear */ |
Guido van Rossum | 6596725 | 2001-04-21 13:20:18 +0000 | [diff] [blame] | 1606 | 0, /* tp_richcompare */ |
| 1607 | 0, /* tp_weaklistoffset */ |
Guido van Rossum | 5b02184 | 2001-05-22 16:48:37 +0000 | [diff] [blame] | 1608 | file_getiter, /* tp_iter */ |
Guido van Rossum | 213c7a6 | 2001-04-23 14:08:49 +0000 | [diff] [blame] | 1609 | 0, /* tp_iternext */ |
Tim Peters | 6d6c1a3 | 2001-08-02 04:15:00 +0000 | [diff] [blame] | 1610 | file_methods, /* tp_methods */ |
| 1611 | file_memberlist, /* tp_members */ |
| 1612 | file_getsetlist, /* tp_getset */ |
| 1613 | 0, /* tp_base */ |
| 1614 | 0, /* tp_dict */ |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 1615 | 0, /* tp_descr_get */ |
| 1616 | 0, /* tp_descr_set */ |
| 1617 | 0, /* tp_dictoffset */ |
Tim Peters | 4441001 | 2001-09-14 03:26:08 +0000 | [diff] [blame] | 1618 | (initproc)file_init, /* tp_init */ |
| 1619 | PyType_GenericAlloc, /* tp_alloc */ |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 1620 | file_new, /* tp_new */ |
Guido van Rossum | 9475a23 | 2001-10-05 20:51:39 +0000 | [diff] [blame] | 1621 | _PyObject_Del, /* tp_free */ |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 1622 | }; |
Guido van Rossum | eb183da | 1991-04-04 10:44:06 +0000 | [diff] [blame] | 1623 | |
| 1624 | /* Interface for the 'soft space' between print items. */ |
| 1625 | |
| 1626 | int |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 1627 | PyFile_SoftSpace(PyObject *f, int newflag) |
Guido van Rossum | eb183da | 1991-04-04 10:44:06 +0000 | [diff] [blame] | 1628 | { |
| 1629 | int oldflag = 0; |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1630 | if (f == NULL) { |
| 1631 | /* Do nothing */ |
| 1632 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1633 | else if (PyFile_Check(f)) { |
| 1634 | oldflag = ((PyFileObject *)f)->f_softspace; |
| 1635 | ((PyFileObject *)f)->f_softspace = newflag; |
Guido van Rossum | eb183da | 1991-04-04 10:44:06 +0000 | [diff] [blame] | 1636 | } |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1637 | else { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1638 | PyObject *v; |
| 1639 | v = PyObject_GetAttrString(f, "softspace"); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1640 | if (v == NULL) |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1641 | PyErr_Clear(); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1642 | else { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1643 | if (PyInt_Check(v)) |
| 1644 | oldflag = PyInt_AsLong(v); |
| 1645 | Py_DECREF(v); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1646 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1647 | v = PyInt_FromLong((long)newflag); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1648 | if (v == NULL) |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1649 | PyErr_Clear(); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1650 | else { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1651 | if (PyObject_SetAttrString(f, "softspace", v) != 0) |
| 1652 | PyErr_Clear(); |
| 1653 | Py_DECREF(v); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1654 | } |
| 1655 | } |
Guido van Rossum | eb183da | 1991-04-04 10:44:06 +0000 | [diff] [blame] | 1656 | return oldflag; |
| 1657 | } |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1658 | |
| 1659 | /* Interfaces to write objects/strings to file-like objects */ |
| 1660 | |
| 1661 | int |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 1662 | PyFile_WriteObject(PyObject *v, PyObject *f, int flags) |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1663 | { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1664 | PyObject *writer, *value, *args, *result; |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1665 | if (f == NULL) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1666 | PyErr_SetString(PyExc_TypeError, "writeobject with NULL file"); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1667 | return -1; |
| 1668 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1669 | else if (PyFile_Check(f)) { |
| 1670 | FILE *fp = PyFile_AsFile(f); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1671 | if (fp == NULL) { |
| 1672 | err_closed(); |
| 1673 | return -1; |
| 1674 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1675 | return PyObject_Print(v, fp, flags); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1676 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1677 | writer = PyObject_GetAttrString(f, "write"); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1678 | if (writer == NULL) |
| 1679 | return -1; |
Martin v. Löwis | 2777c02 | 2001-09-19 13:47:32 +0000 | [diff] [blame] | 1680 | if (flags & Py_PRINT_RAW) { |
| 1681 | if (PyUnicode_Check(v)) { |
| 1682 | value = v; |
| 1683 | Py_INCREF(value); |
| 1684 | } else |
| 1685 | value = PyObject_Str(v); |
| 1686 | } |
| 1687 | else |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1688 | value = PyObject_Repr(v); |
Guido van Rossum | c600411 | 1993-11-05 10:22:19 +0000 | [diff] [blame] | 1689 | if (value == NULL) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1690 | Py_DECREF(writer); |
Guido van Rossum | c600411 | 1993-11-05 10:22:19 +0000 | [diff] [blame] | 1691 | return -1; |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1692 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1693 | args = Py_BuildValue("(O)", value); |
Guido van Rossum | e9eec54 | 1997-05-22 14:02:25 +0000 | [diff] [blame] | 1694 | if (args == NULL) { |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1695 | Py_DECREF(value); |
| 1696 | Py_DECREF(writer); |
Guido van Rossum | d3f9a1a | 1995-07-10 23:32:26 +0000 | [diff] [blame] | 1697 | return -1; |
| 1698 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1699 | result = PyEval_CallObject(writer, args); |
| 1700 | Py_DECREF(args); |
| 1701 | Py_DECREF(value); |
| 1702 | Py_DECREF(writer); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1703 | if (result == NULL) |
| 1704 | return -1; |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1705 | Py_DECREF(result); |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1706 | return 0; |
| 1707 | } |
| 1708 | |
Guido van Rossum | 27a60b1 | 1997-05-22 22:25:11 +0000 | [diff] [blame] | 1709 | int |
Tim Peters | c1bbcb8 | 2001-11-28 22:13:25 +0000 | [diff] [blame] | 1710 | PyFile_WriteString(const char *s, PyObject *f) |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1711 | { |
| 1712 | if (f == NULL) { |
Guido van Rossum | 27a60b1 | 1997-05-22 22:25:11 +0000 | [diff] [blame] | 1713 | /* Should be caused by a pre-existing error */ |
Fred Drake | fd99de6 | 2000-07-09 05:02:18 +0000 | [diff] [blame] | 1714 | if (!PyErr_Occurred()) |
Guido van Rossum | 27a60b1 | 1997-05-22 22:25:11 +0000 | [diff] [blame] | 1715 | PyErr_SetString(PyExc_SystemError, |
| 1716 | "null file for PyFile_WriteString"); |
| 1717 | return -1; |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1718 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1719 | else if (PyFile_Check(f)) { |
| 1720 | FILE *fp = PyFile_AsFile(f); |
Guido van Rossum | 27a60b1 | 1997-05-22 22:25:11 +0000 | [diff] [blame] | 1721 | if (fp == NULL) { |
| 1722 | err_closed(); |
| 1723 | return -1; |
| 1724 | } |
| 1725 | fputs(s, fp); |
| 1726 | return 0; |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1727 | } |
Guido van Rossum | c0b618a | 1997-05-02 03:12:38 +0000 | [diff] [blame] | 1728 | else if (!PyErr_Occurred()) { |
| 1729 | PyObject *v = PyString_FromString(s); |
Guido van Rossum | 27a60b1 | 1997-05-22 22:25:11 +0000 | [diff] [blame] | 1730 | int err; |
| 1731 | if (v == NULL) |
| 1732 | return -1; |
| 1733 | err = PyFile_WriteObject(v, f, Py_PRINT_RAW); |
| 1734 | Py_DECREF(v); |
| 1735 | return err; |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1736 | } |
Guido van Rossum | 74ba247 | 1997-07-13 03:56:50 +0000 | [diff] [blame] | 1737 | else |
| 1738 | return -1; |
Guido van Rossum | 3165fe6 | 1992-09-25 21:59:05 +0000 | [diff] [blame] | 1739 | } |
Andrew M. Kuchling | 06051ed | 2000-07-13 23:56:54 +0000 | [diff] [blame] | 1740 | |
| 1741 | /* Try to get a file-descriptor from a Python object. If the object |
| 1742 | is an integer or long integer, its value is returned. If not, the |
| 1743 | object's fileno() method is called if it exists; the method must return |
| 1744 | an integer or long integer, which is returned as the file descriptor value. |
| 1745 | -1 is returned on failure. |
| 1746 | */ |
| 1747 | |
| 1748 | int PyObject_AsFileDescriptor(PyObject *o) |
| 1749 | { |
| 1750 | int fd; |
| 1751 | PyObject *meth; |
| 1752 | |
| 1753 | if (PyInt_Check(o)) { |
| 1754 | fd = PyInt_AsLong(o); |
| 1755 | } |
| 1756 | else if (PyLong_Check(o)) { |
| 1757 | fd = PyLong_AsLong(o); |
| 1758 | } |
| 1759 | else if ((meth = PyObject_GetAttrString(o, "fileno")) != NULL) |
| 1760 | { |
| 1761 | PyObject *fno = PyEval_CallObject(meth, NULL); |
| 1762 | Py_DECREF(meth); |
| 1763 | if (fno == NULL) |
| 1764 | return -1; |
Tim Peters | 86821b2 | 2001-01-07 21:19:34 +0000 | [diff] [blame] | 1765 | |
Andrew M. Kuchling | 06051ed | 2000-07-13 23:56:54 +0000 | [diff] [blame] | 1766 | if (PyInt_Check(fno)) { |
| 1767 | fd = PyInt_AsLong(fno); |
| 1768 | Py_DECREF(fno); |
| 1769 | } |
| 1770 | else if (PyLong_Check(fno)) { |
| 1771 | fd = PyLong_AsLong(fno); |
| 1772 | Py_DECREF(fno); |
| 1773 | } |
| 1774 | else { |
| 1775 | PyErr_SetString(PyExc_TypeError, |
| 1776 | "fileno() returned a non-integer"); |
| 1777 | Py_DECREF(fno); |
| 1778 | return -1; |
| 1779 | } |
| 1780 | } |
| 1781 | else { |
| 1782 | PyErr_SetString(PyExc_TypeError, |
| 1783 | "argument must be an int, or have a fileno() method."); |
| 1784 | return -1; |
| 1785 | } |
| 1786 | |
| 1787 | if (fd < 0) { |
| 1788 | PyErr_Format(PyExc_ValueError, |
| 1789 | "file descriptor cannot be a negative integer (%i)", |
| 1790 | fd); |
| 1791 | return -1; |
| 1792 | } |
| 1793 | return fd; |
| 1794 | } |