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 interface */ |
| 3 | |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 4 | #ifndef Py_FILEOBJECT_H |
| 5 | #define Py_FILEOBJECT_H |
| 6 | #ifdef __cplusplus |
| 7 | extern "C" { |
| 8 | #endif |
| 9 | |
Martin v. Löwis | f6eebbb | 2002-03-15 17:42:16 +0000 | [diff] [blame] | 10 | typedef struct { |
| 11 | PyObject_HEAD |
| 12 | FILE *f_fp; |
| 13 | PyObject *f_name; |
| 14 | PyObject *f_mode; |
| 15 | int (*f_close)(FILE *); |
Guido van Rossum | 7a6e959 | 2002-08-06 15:55:28 +0000 | [diff] [blame] | 16 | int f_softspace; /* Flag used by 'print' command */ |
| 17 | int f_binary; /* Flag which indicates whether the file is |
| 18 | open in binary (1) or text (0) mode */ |
| 19 | char* f_buf; /* Allocated readahead buffer */ |
| 20 | char* f_bufend; /* Points after last occupied position */ |
| 21 | char* f_bufptr; /* Current buffer position */ |
Jack Jansen | 7b8c754 | 2002-04-14 20:12:41 +0000 | [diff] [blame] | 22 | #ifdef WITH_UNIVERSAL_NEWLINES |
| 23 | int f_univ_newline; /* Handle any newline convention */ |
| 24 | int f_newlinetypes; /* Types of newlines seen */ |
| 25 | int f_skipnextlf; /* Skip next \n */ |
| 26 | #endif |
Martin v. Löwis | f6eebbb | 2002-03-15 17:42:16 +0000 | [diff] [blame] | 27 | } PyFileObject; |
| 28 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame^] | 29 | PyAPI_DATA(PyTypeObject) PyFile_Type; |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 30 | |
Tim Peters | 59c9a64 | 2001-09-13 05:38:56 +0000 | [diff] [blame] | 31 | #define PyFile_Check(op) PyObject_TypeCheck(op, &PyFile_Type) |
| 32 | #define PyFile_CheckExact(op) ((op)->ob_type == &PyFile_Type) |
Guido van Rossum | 85a5fbb | 1990-10-14 12:07:46 +0000 | [diff] [blame] | 33 | |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame^] | 34 | PyAPI_FUNC(PyObject *) PyFile_FromString(char *, char *); |
| 35 | PyAPI_FUNC(void) PyFile_SetBufSize(PyObject *, int); |
| 36 | PyAPI_FUNC(PyObject *) PyFile_FromFile(FILE *, char *, char *, |
Fred Drake | ea9cb5a | 2000-07-09 00:20:36 +0000 | [diff] [blame] | 37 | int (*)(FILE *)); |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame^] | 38 | PyAPI_FUNC(FILE *) PyFile_AsFile(PyObject *); |
| 39 | PyAPI_FUNC(PyObject *) PyFile_Name(PyObject *); |
| 40 | PyAPI_FUNC(PyObject *) PyFile_GetLine(PyObject *, int); |
| 41 | PyAPI_FUNC(int) PyFile_WriteObject(PyObject *, PyObject *, int); |
| 42 | PyAPI_FUNC(int) PyFile_SoftSpace(PyObject *, int); |
| 43 | PyAPI_FUNC(int) PyFile_WriteString(const char *, PyObject *); |
| 44 | PyAPI_FUNC(int) PyObject_AsFileDescriptor(PyObject *); |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 45 | |
Mark Hammond | 26cffde4 | 2001-05-14 12:17:34 +0000 | [diff] [blame] | 46 | /* The default encoding used by the platform file system APIs |
Tim Peters | 058b141 | 2002-04-21 07:29:14 +0000 | [diff] [blame] | 47 | If non-NULL, this is different than the default encoding for strings |
Mark Hammond | 26cffde4 | 2001-05-14 12:17:34 +0000 | [diff] [blame] | 48 | */ |
Mark Hammond | 91a681d | 2002-08-12 07:21:58 +0000 | [diff] [blame^] | 49 | PyAPI_DATA(const char *) Py_FileSystemDefaultEncoding; |
Mark Hammond | 26cffde4 | 2001-05-14 12:17:34 +0000 | [diff] [blame] | 50 | |
Jack Jansen | 7b8c754 | 2002-04-14 20:12:41 +0000 | [diff] [blame] | 51 | #ifdef WITH_UNIVERSAL_NEWLINES |
| 52 | /* Routines to replace fread() and fgets() which accept any of \r, \n |
| 53 | or \r\n as line terminators. |
| 54 | */ |
| 55 | #define PY_STDIOTEXTMODE "b" |
| 56 | char *Py_UniversalNewlineFgets(char *, int, FILE*, PyObject *); |
Tim Peters | 058b141 | 2002-04-21 07:29:14 +0000 | [diff] [blame] | 57 | size_t Py_UniversalNewlineFread(char *, size_t, FILE *, PyObject *); |
Jack Jansen | 7b8c754 | 2002-04-14 20:12:41 +0000 | [diff] [blame] | 58 | #else |
| 59 | #define PY_STDIOTEXTMODE "" |
Tim Peters | 058b141 | 2002-04-21 07:29:14 +0000 | [diff] [blame] | 60 | #define Py_UniversalNewlineFgets(buf, len, fp, obj) fgets((buf), (len), (fp)) |
Guido van Rossum | a0a6c5a | 2002-05-24 15:24:38 +0000 | [diff] [blame] | 61 | #define Py_UniversalNewlineFread(buf, len, fp, obj) \ |
Tim Peters | 058b141 | 2002-04-21 07:29:14 +0000 | [diff] [blame] | 62 | fread((buf), 1, (len), (fp)) |
Jack Jansen | 7b8c754 | 2002-04-14 20:12:41 +0000 | [diff] [blame] | 63 | #endif /* WITH_UNIVERSAL_NEWLINES */ |
Guido van Rossum | a330996 | 1993-07-28 09:05:47 +0000 | [diff] [blame] | 64 | #ifdef __cplusplus |
| 65 | } |
| 66 | #endif |
| 67 | #endif /* !Py_FILEOBJECT_H */ |