source: trunk/essentials/dev-lang/perl/perliol.h@ 3590

Last change on this file since 3590 was 3181, checked in by bird, 19 years ago

perl 5.8.8
File size: 13.4 KB
Line 
1#ifndef _PERLIOL_H
2#define _PERLIOL_H
3
4typedef struct {
5 PerlIO_funcs *funcs;
6 SV *arg;
7} PerlIO_pair_t;
8
9struct PerlIO_list_s {
10 IV refcnt;
11 IV cur;
12 IV len;
13 PerlIO_pair_t *array;
14};
15
16struct _PerlIO_funcs {
17 Size_t fsize;
18 const char *name;
19 Size_t size;
20 U32 kind;
21 IV (*Pushed) (pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
22 IV (*Popped) (pTHX_ PerlIO *f);
23 PerlIO *(*Open) (pTHX_ PerlIO_funcs *tab,
24 PerlIO_list_t *layers, IV n,
25 const char *mode,
26 int fd, int imode, int perm,
27 PerlIO *old, int narg, SV **args);
28 IV (*Binmode)(pTHX_ PerlIO *f);
29 SV *(*Getarg) (pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags);
30 IV (*Fileno) (pTHX_ PerlIO *f);
31 PerlIO *(*Dup) (pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
32 /* Unix-like functions - cf sfio line disciplines */
33 SSize_t(*Read) (pTHX_ PerlIO *f, void *vbuf, Size_t count);
34 SSize_t(*Unread) (pTHX_ PerlIO *f, const void *vbuf, Size_t count);
35 SSize_t(*Write) (pTHX_ PerlIO *f, const void *vbuf, Size_t count);
36 IV (*Seek) (pTHX_ PerlIO *f, Off_t offset, int whence);
37 Off_t(*Tell) (pTHX_ PerlIO *f);
38 IV (*Close) (pTHX_ PerlIO *f);
39 /* Stdio-like buffered IO functions */
40 IV (*Flush) (pTHX_ PerlIO *f);
41 IV (*Fill) (pTHX_ PerlIO *f);
42 IV (*Eof) (pTHX_ PerlIO *f);
43 IV (*Error) (pTHX_ PerlIO *f);
44 void (*Clearerr) (pTHX_ PerlIO *f);
45 void (*Setlinebuf) (pTHX_ PerlIO *f);
46 /* Perl's snooping functions */
47 STDCHAR *(*Get_base) (pTHX_ PerlIO *f);
48 Size_t(*Get_bufsiz) (pTHX_ PerlIO *f);
49 STDCHAR *(*Get_ptr) (pTHX_ PerlIO *f);
50 SSize_t(*Get_cnt) (pTHX_ PerlIO *f);
51 void (*Set_ptrcnt) (pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
52};
53
54/*--------------------------------------------------------------------------------------*/
55/* Kind values */
56#define PERLIO_K_RAW 0x00000001
57#define PERLIO_K_BUFFERED 0x00000002
58#define PERLIO_K_CANCRLF 0x00000004
59#define PERLIO_K_FASTGETS 0x00000008
60#define PERLIO_K_DUMMY 0x00000010
61#define PERLIO_K_UTF8 0x00008000
62#define PERLIO_K_DESTRUCT 0x00010000
63#define PERLIO_K_MULTIARG 0x00020000
64
65/*--------------------------------------------------------------------------------------*/
66struct _PerlIO {
67 PerlIOl *next; /* Lower layer */
68 PerlIO_funcs *tab; /* Functions for this layer */
69 U32 flags; /* Various flags for state */
70};
71
72/*--------------------------------------------------------------------------------------*/
73
74/* Flag values */
75#define PERLIO_F_EOF 0x00000100
76#define PERLIO_F_CANWRITE 0x00000200
77#define PERLIO_F_CANREAD 0x00000400
78#define PERLIO_F_ERROR 0x00000800
79#define PERLIO_F_TRUNCATE 0x00001000
80#define PERLIO_F_APPEND 0x00002000
81#define PERLIO_F_CRLF 0x00004000
82#define PERLIO_F_UTF8 0x00008000
83#define PERLIO_F_UNBUF 0x00010000
84#define PERLIO_F_WRBUF 0x00020000
85#define PERLIO_F_RDBUF 0x00040000
86#define PERLIO_F_LINEBUF 0x00080000
87#define PERLIO_F_TEMP 0x00100000
88#define PERLIO_F_OPEN 0x00200000
89#define PERLIO_F_FASTGETS 0x00400000
90#define PERLIO_F_TTY 0x00800000
91#define PERLIO_F_NOTREG 0x01000000
92
93#define PerlIOBase(f) (*(f))
94#define PerlIOSelf(f,type) ((type *)PerlIOBase(f))
95#define PerlIONext(f) (&(PerlIOBase(f)->next))
96#define PerlIOValid(f) ((f) && *(f))
97
98/*--------------------------------------------------------------------------------------*/
99/* Data exports - EXTCONST rather than extern is needed for Cygwin */
100#undef EXTPERLIO
101#ifdef PERLIO_FUNCS_CONST
102#define EXTPERLIO EXTCONST
103#else
104#define EXTPERLIO EXT
105#endif
106EXTPERLIO PerlIO_funcs PerlIO_unix;
107EXTPERLIO PerlIO_funcs PerlIO_perlio;
108EXTPERLIO PerlIO_funcs PerlIO_stdio;
109EXTPERLIO PerlIO_funcs PerlIO_crlf;
110EXTPERLIO PerlIO_funcs PerlIO_utf8;
111EXTPERLIO PerlIO_funcs PerlIO_byte;
112EXTPERLIO PerlIO_funcs PerlIO_raw;
113EXTPERLIO PerlIO_funcs PerlIO_pending;
114#ifdef HAS_MMAP
115EXTPERLIO PerlIO_funcs PerlIO_mmap;
116#endif
117#ifdef WIN32
118EXTPERLIO PerlIO_funcs PerlIO_win32;
119#endif
120PERL_EXPORT_C PerlIO *PerlIO_allocate(pTHX);
121PERL_EXPORT_C SV *PerlIO_arg_fetch(PerlIO_list_t *av, IV n);
122#define PerlIOArg PerlIO_arg_fetch(layers,n)
123
124#ifdef PERLIO_USING_CRLF
125#define PERLIO_STDTEXT "t"
126#else
127#define PERLIO_STDTEXT ""
128#endif
129
130/*--------------------------------------------------------------------------------------*/
131/* perlio buffer layer
132 As this is reasonably generic its struct and "methods" are declared here
133 so they can be used to "inherit" from it.
134*/
135
136typedef struct {
137 struct _PerlIO base; /* Base "class" info */
138 STDCHAR *buf; /* Start of buffer */
139 STDCHAR *end; /* End of valid part of buffer */
140 STDCHAR *ptr; /* Current position in buffer */
141 Off_t posn; /* Offset of buf into the file */
142 Size_t bufsiz; /* Real size of buffer */
143 IV oneword; /* Emergency buffer */
144} PerlIOBuf;
145
146PERL_EXPORT_C int PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
147 PerlIO_list_t *layers, IV n, IV max);
148PERL_EXPORT_C int PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names);
149PERL_EXPORT_C PerlIO_funcs *PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def);
150
151
152PERL_EXPORT_C SV *PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param);
153PERL_EXPORT_C void PerlIO_cleantable(pTHX_ PerlIO **tablep);
154PERL_EXPORT_C SV * PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab);
155PERL_EXPORT_C void PerlIO_default_buffer(pTHX_ PerlIO_list_t *av);
156PERL_EXPORT_C void PerlIO_stdstreams(pTHX);
157PERL_EXPORT_C int PerlIO__close(pTHX_ PerlIO *f);
158PERL_EXPORT_C PerlIO_list_t * PerlIO_resolve_layers(pTHX_ const char *layers, const char *mode, int narg, SV **args);
159PERL_EXPORT_C PerlIO_funcs * PerlIO_default_layer(pTHX_ I32 n);
160PERL_EXPORT_C PerlIO_list_t * PerlIO_default_layers(pTHX);
161PERL_EXPORT_C PerlIO * PerlIO_reopen(const char *path, const char *mode, PerlIO *f);
162PERL_EXPORT_C int PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
163 __attribute__format__(__printf__,3,0);
164
165PERL_EXPORT_C PerlIO_list_t *PerlIO_list_alloc(pTHX);
166PERL_EXPORT_C PerlIO_list_t *PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param);
167PERL_EXPORT_C void PerlIO_list_free(pTHX_ PerlIO_list_t *list);
168PERL_EXPORT_C void PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg);
169PERL_EXPORT_C void PerlIO_list_free(pTHX_ PerlIO_list_t *list);
170
171/*--------------------------------------------------------------------------------------*/
172/* Generic, or stub layer functions */
173
174PERL_EXPORT_C IV PerlIOBase_binmode(pTHX_ PerlIO *f);
175PERL_EXPORT_C void PerlIOBase_clearerr(pTHX_ PerlIO *f);
176PERL_EXPORT_C IV PerlIOBase_close(pTHX_ PerlIO *f);
177PERL_EXPORT_C PerlIO * PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
178PERL_EXPORT_C IV PerlIOBase_eof(pTHX_ PerlIO *f);
179PERL_EXPORT_C IV PerlIOBase_error(pTHX_ PerlIO *f);
180PERL_EXPORT_C IV PerlIOBase_fileno(pTHX_ PerlIO *f);
181PERL_EXPORT_C void PerlIOBase_flush_linebuf(pTHX);
182PERL_EXPORT_C IV PerlIOBase_noop_fail(pTHX_ PerlIO *f);
183PERL_EXPORT_C IV PerlIOBase_noop_ok(pTHX_ PerlIO *f);
184PERL_EXPORT_C IV PerlIOBase_popped(pTHX_ PerlIO *f);
185PERL_EXPORT_C IV PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
186PERL_EXPORT_C SSize_t PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
187PERL_EXPORT_C void PerlIOBase_setlinebuf(pTHX_ PerlIO *f);
188PERL_EXPORT_C SSize_t PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
189
190/* Buf */
191PERL_EXPORT_C Size_t PerlIOBuf_bufsiz(pTHX_ PerlIO *f);
192PERL_EXPORT_C IV PerlIOBuf_close(pTHX_ PerlIO *f);
193PERL_EXPORT_C PerlIO * PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
194PERL_EXPORT_C IV PerlIOBuf_fill(pTHX_ PerlIO *f);
195PERL_EXPORT_C IV PerlIOBuf_flush(pTHX_ PerlIO *f);
196PERL_EXPORT_C STDCHAR * PerlIOBuf_get_base(pTHX_ PerlIO *f);
197PERL_EXPORT_C SSize_t PerlIOBuf_get_cnt(pTHX_ PerlIO *f);
198PERL_EXPORT_C STDCHAR * PerlIOBuf_get_ptr(pTHX_ PerlIO *f);
199PERL_EXPORT_C PerlIO * PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers, IV n, const char *mode, int fd, int imode, int perm, PerlIO *old, int narg, SV **args);
200PERL_EXPORT_C IV PerlIOBuf_popped(pTHX_ PerlIO *f);
201PERL_EXPORT_C IV PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
202PERL_EXPORT_C SSize_t PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
203PERL_EXPORT_C IV PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
204PERL_EXPORT_C void PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
205PERL_EXPORT_C Off_t PerlIOBuf_tell(pTHX_ PerlIO *f);
206PERL_EXPORT_C SSize_t PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
207PERL_EXPORT_C SSize_t PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
208
209/* Crlf */
210PERL_EXPORT_C IV PerlIOCrlf_binmode(pTHX_ PerlIO *f);
211PERL_EXPORT_C IV PerlIOCrlf_flush(pTHX_ PerlIO *f);
212PERL_EXPORT_C SSize_t PerlIOCrlf_get_cnt(pTHX_ PerlIO *f);
213PERL_EXPORT_C IV PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
214PERL_EXPORT_C void PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
215PERL_EXPORT_C SSize_t PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
216PERL_EXPORT_C SSize_t PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
217PERL_EXPORT_C SSize_t PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
218
219/* Mmap */
220PERL_EXPORT_C IV PerlIOMmap_close(pTHX_ PerlIO *f);
221PERL_EXPORT_C PerlIO * PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
222PERL_EXPORT_C IV PerlIOMmap_fill(pTHX_ PerlIO *f);
223PERL_EXPORT_C IV PerlIOMmap_flush(pTHX_ PerlIO *f);
224PERL_EXPORT_C STDCHAR * PerlIOMmap_get_base(pTHX_ PerlIO *f);
225PERL_EXPORT_C IV PerlIOMmap_map(pTHX_ PerlIO *f);
226PERL_EXPORT_C IV PerlIOMmap_unmap(pTHX_ PerlIO *f);
227PERL_EXPORT_C SSize_t PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
228PERL_EXPORT_C SSize_t PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
229
230/* Pending */
231PERL_EXPORT_C IV PerlIOPending_close(pTHX_ PerlIO *f);
232PERL_EXPORT_C IV PerlIOPending_fill(pTHX_ PerlIO *f);
233PERL_EXPORT_C IV PerlIOPending_flush(pTHX_ PerlIO *f);
234PERL_EXPORT_C IV PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
235PERL_EXPORT_C SSize_t PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
236PERL_EXPORT_C IV PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
237PERL_EXPORT_C void PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
238
239/* Pop */
240PERL_EXPORT_C IV PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
241
242/* Raw */
243PERL_EXPORT_C PerlIO * PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers, IV n, const char *mode, int fd, int imode, int perm, PerlIO *old, int narg, SV **args);
244PERL_EXPORT_C IV PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
245
246/* Stdio */
247PERL_EXPORT_C void PerlIOStdio_clearerr(pTHX_ PerlIO *f);
248PERL_EXPORT_C IV PerlIOStdio_close(pTHX_ PerlIO *f);
249PERL_EXPORT_C PerlIO * PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
250PERL_EXPORT_C IV PerlIOStdio_eof(pTHX_ PerlIO *f);
251PERL_EXPORT_C IV PerlIOStdio_error(pTHX_ PerlIO *f);
252PERL_EXPORT_C IV PerlIOStdio_fileno(pTHX_ PerlIO *f);
253PERL_EXPORT_C IV PerlIOStdio_fill(pTHX_ PerlIO *f);
254PERL_EXPORT_C IV PerlIOStdio_flush(pTHX_ PerlIO *f);
255PERL_EXPORT_C STDCHAR * PerlIOStdio_get_base(pTHX_ PerlIO *f);
256PERL_EXPORT_C char * PerlIOStdio_mode(const char *mode, char *tmode);
257PERL_EXPORT_C PerlIO * PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers, IV n, const char *mode, int fd, int imode, int perm, PerlIO *f, int narg, SV **args);
258PERL_EXPORT_C IV PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
259PERL_EXPORT_C SSize_t PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
260PERL_EXPORT_C IV PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
261PERL_EXPORT_C void PerlIOStdio_setlinebuf(pTHX_ PerlIO *f);
262PERL_EXPORT_C Off_t PerlIOStdio_tell(pTHX_ PerlIO *f);
263PERL_EXPORT_C SSize_t PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
264PERL_EXPORT_C SSize_t PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
265
266/* Unix */
267PERL_EXPORT_C IV PerlIOUnix_close(pTHX_ PerlIO *f);
268PERL_EXPORT_C PerlIO * PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
269PERL_EXPORT_C IV PerlIOUnix_fileno(pTHX_ PerlIO *f);
270PERL_EXPORT_C int PerlIOUnix_oflags(const char *mode);
271PERL_EXPORT_C PerlIO * PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers, IV n, const char *mode, int fd, int imode, int perm, PerlIO *f, int narg, SV **args);
272PERL_EXPORT_C IV PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
273PERL_EXPORT_C SSize_t PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
274PERL_EXPORT_C int PerlIOUnix_refcnt_dec(int fd);
275PERL_EXPORT_C void PerlIOUnix_refcnt_inc(int fd);
276PERL_EXPORT_C IV PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
277PERL_EXPORT_C Off_t PerlIOUnix_tell(pTHX_ PerlIO *f);
278PERL_EXPORT_C SSize_t PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
279
280/* Utf8 */
281PERL_EXPORT_C IV PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
282
283#endif /* _PERLIOL_H */
Note: See TracBrowser for help on using the repository browser.