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