1 2/* File object interface */ 3 4#ifndef Py_FILEOBJECT_H 5#define Py_FILEOBJECT_H 6#ifdef __cplusplus 7extern "C" { 8#endif 9 10typedef 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 int readable; 32 int writable; 33} PyFileObject; 34 35PyAPI_DATA(PyTypeObject) PyFile_Type; 36 37#define PyFile_Check(op) PyObject_TypeCheck(op, &PyFile_Type) 38#define PyFile_CheckExact(op) (Py_TYPE(op) == &PyFile_Type) 39 40PyAPI_FUNC(PyObject *) PyFile_FromString(char *, char *); 41PyAPI_FUNC(void) PyFile_SetBufSize(PyObject *, int); 42PyAPI_FUNC(int) PyFile_SetEncoding(PyObject *, const char *); 43PyAPI_FUNC(int) PyFile_SetEncodingAndErrors(PyObject *, const char *, char *errors); 44PyAPI_FUNC(PyObject *) PyFile_FromFile(FILE *, char *, char *, 45 int (*)(FILE *)); 46PyAPI_FUNC(FILE *) PyFile_AsFile(PyObject *); 47PyAPI_FUNC(void) PyFile_IncUseCount(PyFileObject *); 48PyAPI_FUNC(void) PyFile_DecUseCount(PyFileObject *); 49PyAPI_FUNC(PyObject *) PyFile_Name(PyObject *); 50PyAPI_FUNC(PyObject *) PyFile_GetLine(PyObject *, int); 51PyAPI_FUNC(int) PyFile_WriteObject(PyObject *, PyObject *, int); 52PyAPI_FUNC(int) PyFile_SoftSpace(PyObject *, int); 53PyAPI_FUNC(int) PyFile_WriteString(const char *, PyObject *); 54PyAPI_FUNC(int) PyObject_AsFileDescriptor(PyObject *); 55 56/* The default encoding used by the platform file system APIs 57 If non-NULL, this is different than the default encoding for strings 58*/ 59PyAPI_DATA(const char *) Py_FileSystemDefaultEncoding; 60 61/* Routines to replace fread() and fgets() which accept any of \r, \n 62 or \r\n as line terminators. 63*/ 64#define PY_STDIOTEXTMODE "b" 65char *Py_UniversalNewlineFgets(char *, int, FILE*, PyObject *); 66size_t Py_UniversalNewlineFread(char *, size_t, FILE *, PyObject *); 67 68/* A routine to do sanity checking on the file mode string. returns 69 non-zero on if an exception occurred 70*/ 71int _PyFile_SanitizeMode(char *mode); 72 73#if defined _MSC_VER && _MSC_VER >= 1400 74/* A routine to check if a file descriptor is valid on Windows. Returns 0 75 * and sets errno to EBADF if it isn't. This is to avoid Assertions 76 * from various functions in the Windows CRT beginning with 77 * Visual Studio 2005 78 */ 79int _PyVerify_fd(int fd); 80#elif defined _MSC_VER && _MSC_VER >= 1200 81/* fdopen doesn't set errno EBADF and crashes for large fd on debug build */ 82#define _PyVerify_fd(fd) (_get_osfhandle(fd) >= 0) 83#else 84#define _PyVerify_fd(A) (1) /* dummy */ 85#endif 86 87/* A routine to check if a file descriptor can be select()-ed. */ 88#ifdef HAVE_SELECT 89 #define _PyIsSelectable_fd(FD) (((FD) >= 0) && ((FD) < FD_SETSIZE)) 90#else 91 #define _PyIsSelectable_fd(FD) (1) 92#endif /* HAVE_SELECT */ 93 94#ifdef __cplusplus 95} 96#endif 97#endif /* !Py_FILEOBJECT_H */ 98