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