|
1 |
|
2 /* File object interface */ |
|
3 |
|
4 #ifndef Py_FILEOBJECT_H |
|
5 #define Py_FILEOBJECT_H |
|
6 #ifdef __cplusplus |
|
7 extern "C" { |
|
8 #endif |
|
9 |
|
10 typedef struct { |
|
11 PyObject_HEAD |
|
12 FILE *f_fp; |
|
13 PyObject *f_name; |
|
14 PyObject *f_mode; |
|
15 int (*f_close)(FILE *); |
|
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 */ |
|
22 char *f_setbuf; /* Buffer for setbuf(3) and setvbuf(3) */ |
|
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 PyObject *f_encoding; |
|
27 PyObject *f_errors; |
|
28 PyObject *weakreflist; /* List of weak references */ |
|
29 int unlocked_count; /* Num. currently running sections of code |
|
30 using f_fp with the GIL released. */ |
|
31 } PyFileObject; |
|
32 |
|
33 PyAPI_DATA(PyTypeObject) PyFile_Type; |
|
34 |
|
35 #define PyFile_Check(op) PyObject_TypeCheck(op, &PyFile_Type) |
|
36 #define PyFile_CheckExact(op) (Py_TYPE(op) == &PyFile_Type) |
|
37 |
|
38 PyAPI_FUNC(PyObject *) PyFile_FromString(char *, char *); |
|
39 PyAPI_FUNC(void) PyFile_SetBufSize(PyObject *, int); |
|
40 PyAPI_FUNC(int) PyFile_SetEncoding(PyObject *, const char *); |
|
41 PyAPI_FUNC(int) PyFile_SetEncodingAndErrors(PyObject *, const char *, char *errors); |
|
42 PyAPI_FUNC(PyObject *) PyFile_FromFile(FILE *, char *, char *, |
|
43 int (*)(FILE *)); |
|
44 PyAPI_FUNC(FILE *) PyFile_AsFile(PyObject *); |
|
45 PyAPI_FUNC(void) PyFile_IncUseCount(PyFileObject *); |
|
46 PyAPI_FUNC(void) PyFile_DecUseCount(PyFileObject *); |
|
47 PyAPI_FUNC(PyObject *) PyFile_Name(PyObject *); |
|
48 PyAPI_FUNC(PyObject *) PyFile_GetLine(PyObject *, int); |
|
49 PyAPI_FUNC(int) PyFile_WriteObject(PyObject *, PyObject *, int); |
|
50 PyAPI_FUNC(int) PyFile_SoftSpace(PyObject *, int); |
|
51 PyAPI_FUNC(int) PyFile_WriteString(const char *, PyObject *); |
|
52 PyAPI_FUNC(int) PyObject_AsFileDescriptor(PyObject *); |
|
53 |
|
54 /* The default encoding used by the platform file system APIs |
|
55 If non-NULL, this is different than the default encoding for strings |
|
56 */ |
|
57 PyAPI_DATA(const char *) Py_FileSystemDefaultEncoding; |
|
58 |
|
59 /* Routines to replace fread() and fgets() which accept any of \r, \n |
|
60 or \r\n as line terminators. |
|
61 */ |
|
62 #define PY_STDIOTEXTMODE "b" |
|
63 char *Py_UniversalNewlineFgets(char *, int, FILE*, PyObject *); |
|
64 size_t Py_UniversalNewlineFread(char *, size_t, FILE *, PyObject *); |
|
65 |
|
66 /* A routine to do sanity checking on the file mode string. returns |
|
67 non-zero on if an exception occurred |
|
68 */ |
|
69 int _PyFile_SanitizeMode(char *mode); |
|
70 |
|
71 #ifdef __cplusplus |
|
72 } |
|
73 #endif |
|
74 #endif /* !Py_FILEOBJECT_H */ |