16 struct _PerlIO_funcs {
20 IV (*Pushed) (PerlIO *f, const char *mode, SV *arg);
21 IV (*Popped) (PerlIO *f);
22 PerlIO *(*Open) (pTHX_ PerlIO_funcs *tab,
23 PerlIO_list_t *layers, IV n,
25 int fd, int imode, int perm,
26 PerlIO *old, int narg, SV **args);
27 SV *(*Getarg) (pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags);
28 IV (*Fileno) (PerlIO *f);
29 PerlIO *(*Dup) (pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
30 /* Unix-like functions - cf sfio line disciplines */
31 SSize_t(*Read) (PerlIO *f, void *vbuf, Size_t count);
32 SSize_t(*Unread) (PerlIO *f, const void *vbuf, Size_t count);
33 SSize_t(*Write) (PerlIO *f, const void *vbuf, Size_t count);
34 IV (*Seek) (PerlIO *f, Off_t offset, int whence);
35 Off_t(*Tell) (PerlIO *f);
36 IV (*Close) (PerlIO *f);
37 /* Stdio-like buffered IO functions */
38 IV (*Flush) (PerlIO *f);
39 IV (*Fill) (PerlIO *f);
40 IV (*Eof) (PerlIO *f);
41 IV (*Error) (PerlIO *f);
42 void (*Clearerr) (PerlIO *f);
43 void (*Setlinebuf) (PerlIO *f);
44 /* Perl's snooping functions */
45 STDCHAR *(*Get_base) (PerlIO *f);
46 Size_t(*Get_bufsiz) (PerlIO *f);
47 STDCHAR *(*Get_ptr) (PerlIO *f);
48 SSize_t(*Get_cnt) (PerlIO *f);
49 void (*Set_ptrcnt) (PerlIO *f, STDCHAR * ptr, SSize_t cnt);
52 /*--------------------------------------------------------------------------------------*/
54 #define PERLIO_K_RAW 0x00000001
55 #define PERLIO_K_BUFFERED 0x00000002
56 #define PERLIO_K_CANCRLF 0x00000004
57 #define PERLIO_K_FASTGETS 0x00000008
58 #define PERLIO_K_DUMMY 0x00000010
59 #define PERLIO_K_UTF8 0x00008000
60 #define PERLIO_K_DESTRUCT 0x00010000
61 #define PERLIO_K_MULTIARG 0x00020000
63 /*--------------------------------------------------------------------------------------*/
65 PerlIOl *next; /* Lower layer */
66 PerlIO_funcs *tab; /* Functions for this layer */
67 IV flags; /* Various flags for state */
70 /*--------------------------------------------------------------------------------------*/
73 #define PERLIO_F_EOF 0x00000100
74 #define PERLIO_F_CANWRITE 0x00000200
75 #define PERLIO_F_CANREAD 0x00000400
76 #define PERLIO_F_ERROR 0x00000800
77 #define PERLIO_F_TRUNCATE 0x00001000
78 #define PERLIO_F_APPEND 0x00002000
79 #define PERLIO_F_CRLF 0x00004000
80 #define PERLIO_F_UTF8 0x00008000
81 #define PERLIO_F_UNBUF 0x00010000
82 #define PERLIO_F_WRBUF 0x00020000
83 #define PERLIO_F_RDBUF 0x00040000
84 #define PERLIO_F_LINEBUF 0x00080000
85 #define PERLIO_F_TEMP 0x00100000
86 #define PERLIO_F_OPEN 0x00200000
87 #define PERLIO_F_FASTGETS 0x00400000
88 #define PERLIO_F_TTY 0x00800000
90 #define PerlIOBase(f) (*(f))
91 #define PerlIOSelf(f,type) ((type *)PerlIOBase(f))
92 #define PerlIONext(f) (&(PerlIOBase(f)->next))
94 /*--------------------------------------------------------------------------------------*/
95 /* Data exports - EXT rather than extern is needed for Cygwin */
96 EXT PerlIO_funcs PerlIO_unix;
97 EXT PerlIO_funcs PerlIO_perlio;
98 EXT PerlIO_funcs PerlIO_stdio;
99 EXT PerlIO_funcs PerlIO_crlf;
100 EXT PerlIO_funcs PerlIO_utf8;
101 EXT PerlIO_funcs PerlIO_byte;
102 EXT PerlIO_funcs PerlIO_raw;
103 EXT PerlIO_funcs PerlIO_pending;
105 EXT PerlIO_funcs PerlIO_mmap;
108 EXT PerlIO_funcs PerlIO_win32;
110 extern PerlIO *PerlIO_allocate(pTHX);
111 extern SV *PerlIO_arg_fetch(PerlIO_list_t *av, IV n);
112 #define PerlIOArg PerlIO_arg_fetch(layers,n)
114 #if O_BINARY != O_TEXT
115 #define PERLIO_STDTEXT "t"
117 #define PERLIO_STDTEXT ""
120 /*--------------------------------------------------------------------------------------*/
121 /* Generic, or stub layer functions */
123 extern IV PerlIOBase_fileno(PerlIO *f);
124 extern PerlIO *PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
125 extern IV PerlIOBase_pushed(PerlIO *f, const char *mode, SV *arg);
126 extern IV PerlIOBase_popped(PerlIO *f);
127 extern SSize_t PerlIOBase_read(PerlIO *f, void *vbuf, Size_t count);
128 extern SSize_t PerlIOBase_unread(PerlIO *f, const void *vbuf,
130 extern IV PerlIOBase_eof(PerlIO *f);
131 extern IV PerlIOBase_error(PerlIO *f);
132 extern void PerlIOBase_clearerr(PerlIO *f);
133 extern IV PerlIOBase_close(PerlIO *f);
134 extern void PerlIOBase_setlinebuf(PerlIO *f);
135 extern void PerlIOBase_flush_linebuf(void);
137 extern IV PerlIOBase_noop_ok(PerlIO *f);
138 extern IV PerlIOBase_noop_fail(PerlIO *f);
140 /*--------------------------------------------------------------------------------------*/
141 /* perlio buffer layer
142 As this is reasonably generic its struct and "methods" are declared here
143 so they can be used to "inherit" from it.
147 struct _PerlIO base; /* Base "class" info */
148 STDCHAR *buf; /* Start of buffer */
149 STDCHAR *end; /* End of valid part of buffer */
150 STDCHAR *ptr; /* Current position in buffer */
151 Off_t posn; /* Offset of buf into the file */
152 Size_t bufsiz; /* Real size of buffer */
153 IV oneword; /* Emergency buffer */
156 extern SV *PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param);
157 extern PerlIO *PerlIOBuf_open(pTHX_ PerlIO_funcs *self,
158 PerlIO_list_t *layers, IV n,
159 const char *mode, int fd, int imode,
160 int perm, PerlIO *old, int narg, SV **args);
161 extern IV PerlIOBuf_pushed(PerlIO *f, const char *mode, SV *arg);
162 extern PerlIO *PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
163 extern SSize_t PerlIOBuf_read(PerlIO *f, void *vbuf, Size_t count);
164 extern SSize_t PerlIOBuf_unread(PerlIO *f, const void *vbuf, Size_t count);
165 extern SSize_t PerlIOBuf_write(PerlIO *f, const void *vbuf, Size_t count);
166 extern IV PerlIOBuf_seek(PerlIO *f, Off_t offset, int whence);
167 extern Off_t PerlIOBuf_tell(PerlIO *f);
168 extern IV PerlIOBuf_close(PerlIO *f);
169 extern IV PerlIOBuf_flush(PerlIO *f);
170 extern IV PerlIOBuf_fill(PerlIO *f);
171 extern STDCHAR *PerlIOBuf_get_base(PerlIO *f);
172 extern Size_t PerlIOBuf_bufsiz(PerlIO *f);
173 extern STDCHAR *PerlIOBuf_get_ptr(PerlIO *f);
174 extern SSize_t PerlIOBuf_get_cnt(PerlIO *f);
175 extern void PerlIOBuf_set_ptrcnt(PerlIO *f, STDCHAR * ptr, SSize_t cnt);
177 extern int PerlIOUnix_oflags(const char *mode);
179 /*--------------------------------------------------------------------------------------*/
181 #endif /* _PERLIOL_H */