fileobject.h 2.16 KB
Newer Older
1

Guido van Rossum's avatar
Guido van Rossum committed
2 3
/* File object interface */

4 5 6 7 8 9
#ifndef Py_FILEOBJECT_H
#define Py_FILEOBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

10 11 12 13 14 15
typedef struct {
	PyObject_HEAD
	FILE *f_fp;
	PyObject *f_name;
	PyObject *f_mode;
	int (*f_close)(FILE *);
16 17 18 19 20 21
	int f_softspace;	/* Flag used by 'print' command */
	int f_binary;		/* Flag which indicates whether the file is 
				   open in binary (1) or text (0) mode */
	char* f_buf;		/* Allocated readahead buffer */
	char* f_bufend;		/* Points after last occupied position */
	char* f_bufptr;		/* Current buffer position */
22
	char *f_setbuf;		/* Buffer for setbuf(3) and setvbuf(3) */
23 24 25
	int f_univ_newline;	/* Handle any newline convention */
	int f_newlinetypes;	/* Types of newlines seen */
	int f_skipnextlf;	/* Skip next \n */
26
	PyObject *f_encoding;
27
	PyObject *weakreflist; /* List of weak references */
28 29
} PyFileObject;

30
PyAPI_DATA(PyTypeObject) PyFile_Type;
Guido van Rossum's avatar
Guido van Rossum committed
31

32 33
#define PyFile_Check(op) PyObject_TypeCheck(op, &PyFile_Type)
#define PyFile_CheckExact(op) ((op)->ob_type == &PyFile_Type)
Guido van Rossum's avatar
Guido van Rossum committed
34

35 36
PyAPI_FUNC(PyObject *) PyFile_FromString(char *, char *);
PyAPI_FUNC(void) PyFile_SetBufSize(PyObject *, int);
37
PyAPI_FUNC(int) PyFile_SetEncoding(PyObject *, const char *);
38
PyAPI_FUNC(PyObject *) PyFile_FromFile(FILE *, char *, char *,
39
                                             int (*)(FILE *));
40 41 42 43 44 45 46
PyAPI_FUNC(FILE *) PyFile_AsFile(PyObject *);
PyAPI_FUNC(PyObject *) PyFile_Name(PyObject *);
PyAPI_FUNC(PyObject *) PyFile_GetLine(PyObject *, int);
PyAPI_FUNC(int) PyFile_WriteObject(PyObject *, PyObject *, int);
PyAPI_FUNC(int) PyFile_SoftSpace(PyObject *, int);
PyAPI_FUNC(int) PyFile_WriteString(const char *, PyObject *);
PyAPI_FUNC(int) PyObject_AsFileDescriptor(PyObject *);
47

48
/* The default encoding used by the platform file system APIs
49
   If non-NULL, this is different than the default encoding for strings
50
*/
51
PyAPI_DATA(const char *) Py_FileSystemDefaultEncoding;
52

53 54 55 56 57
/* Routines to replace fread() and fgets() which accept any of \r, \n
   or \r\n as line terminators.
*/
#define PY_STDIOTEXTMODE "b"
char *Py_UniversalNewlineFgets(char *, int, FILE*, PyObject *);
58
size_t Py_UniversalNewlineFread(char *, size_t, FILE *, PyObject *);
59

60 61 62 63
#ifdef __cplusplus
}
#endif
#endif /* !Py_FILEOBJECT_H */