This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
clarify that it must be a simple identifier in {}
[perl5.git] / perliol.h
CommitLineData
76ced9ad
NIS
1#ifndef _PERLIOL_H
2#define _PERLIOL_H
3
14a5cf38
JH
4typedef struct {
5 PerlIO_funcs *funcs;
6 SV *arg;
fcf2db38
NIS
7} PerlIO_pair_t;
8
3a1ee7e8 9struct PerlIO_list_s {
14a5cf38
JH
10 IV refcnt;
11 IV cur;
12 IV len;
13 PerlIO_pair_t *array;
3a1ee7e8 14};
fcf2db38 15
14a5cf38 16struct _PerlIO_funcs {
2dc2558e 17 Size_t fsize;
e1ec3a88 18 const char *name;
14a5cf38 19 Size_t size;
c9e984e3 20 U32 kind;
2dc2558e 21 IV (*Pushed) (pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
f62ce20a 22 IV (*Popped) (pTHX_ PerlIO *f);
14a5cf38
JH
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);
86e05cf2 28 IV (*Binmode)(pTHX_ PerlIO *f);
ecdeb87c 29 SV *(*Getarg) (pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags);
f62ce20a 30 IV (*Fileno) (pTHX_ PerlIO *f);
ecdeb87c 31 PerlIO *(*Dup) (pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
14a5cf38 32 /* Unix-like functions - cf sfio line disciplines */
f62ce20a
NIS
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);
94a175e1 36 IV (*Seek) (pTHX_ PerlIO *f, Off_t offset, int whence);
f62ce20a
NIS
37 Off_t(*Tell) (pTHX_ PerlIO *f);
38 IV (*Close) (pTHX_ PerlIO *f);
14a5cf38 39 /* Stdio-like buffered IO functions */
f62ce20a
NIS
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);
14a5cf38 46 /* Perl's snooping functions */
f62ce20a
NIS
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);
76ced9ad
NIS
52};
53
f5b9d040
NIS
54/*--------------------------------------------------------------------------------------*/
55/* Kind values */
5e2ab84b
NIS
56#define PERLIO_K_RAW 0x00000001
57#define PERLIO_K_BUFFERED 0x00000002
f5b9d040 58#define PERLIO_K_CANCRLF 0x00000004
5e2ab84b 59#define PERLIO_K_FASTGETS 0x00000008
dfebf958 60#define PERLIO_K_DUMMY 0x00000010
26fb694e 61#define PERLIO_K_UTF8 0x00008000
13621cfb 62#define PERLIO_K_DESTRUCT 0x00010000
7cf31beb 63#define PERLIO_K_MULTIARG 0x00020000
f5b9d040
NIS
64
65/*--------------------------------------------------------------------------------------*/
14a5cf38
JH
66struct _PerlIO {
67 PerlIOl *next; /* Lower layer */
68 PerlIO_funcs *tab; /* Functions for this layer */
4b069b44 69 U32 flags; /* Various flags for state */
16865ff7 70 PerlIOl *head; /* our ultimate parent pointer */
76ced9ad
NIS
71};
72
73/*--------------------------------------------------------------------------------------*/
74
75/* Flag values */
5e2ab84b
NIS
76#define PERLIO_F_EOF 0x00000100
77#define PERLIO_F_CANWRITE 0x00000200
78#define PERLIO_F_CANREAD 0x00000400
79#define PERLIO_F_ERROR 0x00000800
80#define PERLIO_F_TRUNCATE 0x00001000
81#define PERLIO_F_APPEND 0x00002000
82#define PERLIO_F_CRLF 0x00004000
83#define PERLIO_F_UTF8 0x00008000
84#define PERLIO_F_UNBUF 0x00010000
85#define PERLIO_F_WRBUF 0x00020000
86#define PERLIO_F_RDBUF 0x00040000
87#define PERLIO_F_LINEBUF 0x00080000
88#define PERLIO_F_TEMP 0x00100000
89#define PERLIO_F_OPEN 0x00200000
90#define PERLIO_F_FASTGETS 0x00400000
a9c883f6 91#define PERLIO_F_TTY 0x00800000
6caa5a9c 92#define PERLIO_F_NOTREG 0x01000000
abf9167d 93#define PERLIO_F_CLEARED 0x02000000 /* layer cleared but not freed */
76ced9ad
NIS
94
95#define PerlIOBase(f) (*(f))
96#define PerlIOSelf(f,type) ((type *)PerlIOBase(f))
97#define PerlIONext(f) (&(PerlIOBase(f)->next))
04892f78 98#define PerlIOValid(f) ((f) && *(f))
76ced9ad
NIS
99
100/*--------------------------------------------------------------------------------------*/
27da23d5
JH
101/* Data exports - EXTCONST rather than extern is needed for Cygwin */
102#undef EXTPERLIO
103#ifdef PERLIO_FUNCS_CONST
104#define EXTPERLIO EXTCONST
105#else
106#define EXTPERLIO EXT
107#endif
108EXTPERLIO PerlIO_funcs PerlIO_unix;
109EXTPERLIO PerlIO_funcs PerlIO_perlio;
110EXTPERLIO PerlIO_funcs PerlIO_stdio;
111EXTPERLIO PerlIO_funcs PerlIO_crlf;
112EXTPERLIO PerlIO_funcs PerlIO_utf8;
113EXTPERLIO PerlIO_funcs PerlIO_byte;
114EXTPERLIO PerlIO_funcs PerlIO_raw;
115EXTPERLIO PerlIO_funcs PerlIO_pending;
0c4128ad 116#ifdef WIN32
27da23d5 117EXTPERLIO PerlIO_funcs PerlIO_win32;
0c4128ad 118#endif
27da23d5
JH
119PERL_EXPORT_C PerlIO *PerlIO_allocate(pTHX);
120PERL_EXPORT_C SV *PerlIO_arg_fetch(PerlIO_list_t *av, IV n);
fcf2db38 121#define PerlIOArg PerlIO_arg_fetch(layers,n)
76ced9ad 122
35990314 123#ifdef PERLIO_USING_CRLF
f5b9d040
NIS
124#define PERLIO_STDTEXT "t"
125#else
126#define PERLIO_STDTEXT ""
127#endif
128
76ced9ad 129/*--------------------------------------------------------------------------------------*/
76ced9ad
NIS
130/* perlio buffer layer
131 As this is reasonably generic its struct and "methods" are declared here
132 so they can be used to "inherit" from it.
133*/
134
14a5cf38
JH
135typedef struct {
136 struct _PerlIO base; /* Base "class" info */
137 STDCHAR *buf; /* Start of buffer */
138 STDCHAR *end; /* End of valid part of buffer */
139 STDCHAR *ptr; /* Current position in buffer */
140 Off_t posn; /* Offset of buf into the file */
141 Size_t bufsiz; /* Real size of buffer */
142 IV oneword; /* Emergency buffer */
76ced9ad
NIS
143} PerlIOBuf;
144
27da23d5 145PERL_EXPORT_C int PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
d9dac8cd 146 PerlIO_list_t *layers, IV n, IV max);
27da23d5 147PERL_EXPORT_C int PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names);
27da23d5 148PERL_EXPORT_C PerlIO_funcs *PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def);
d9dac8cd
NIS
149
150
27da23d5 151PERL_EXPORT_C SV *PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param);
303f2dc3 152PERL_EXPORT_C void PerlIO_cleantable(pTHX_ PerlIOl **tablep);
de009b76
AL
153PERL_EXPORT_C SV * PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab);
154PERL_EXPORT_C void PerlIO_default_buffer(pTHX_ PerlIO_list_t *av);
155PERL_EXPORT_C void PerlIO_stdstreams(pTHX);
156PERL_EXPORT_C int PerlIO__close(pTHX_ PerlIO *f);
157PERL_EXPORT_C PerlIO_list_t * PerlIO_resolve_layers(pTHX_ const char *layers, const char *mode, int narg, SV **args);
158PERL_EXPORT_C PerlIO_funcs * PerlIO_default_layer(pTHX_ I32 n);
159PERL_EXPORT_C PerlIO_list_t * PerlIO_default_layers(pTHX);
160PERL_EXPORT_C PerlIO * PerlIO_reopen(const char *path, const char *mode, PerlIO *f);
b7787f18
AL
161PERL_EXPORT_C int PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
162 __attribute__format__(__printf__,3,0);
de009b76
AL
163
164PERL_EXPORT_C PerlIO_list_t *PerlIO_list_alloc(pTHX);
165PERL_EXPORT_C PerlIO_list_t *PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param);
166PERL_EXPORT_C void PerlIO_list_free(pTHX_ PerlIO_list_t *list);
167PERL_EXPORT_C void PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg);
168PERL_EXPORT_C void PerlIO_list_free(pTHX_ PerlIO_list_t *list);
e670910b
JH
169
170/* PerlIO_teardown doesn't need exporting, but the EXTERN_C is needed
171 * for compiling as C++. Must also match with what perl.h says. */
0934c9d9 172EXTERN_C void PerlIO_teardown(void);
0c4128ad 173
76ced9ad 174/*--------------------------------------------------------------------------------------*/
de009b76
AL
175/* Generic, or stub layer functions */
176
177PERL_EXPORT_C IV PerlIOBase_binmode(pTHX_ PerlIO *f);
178PERL_EXPORT_C void PerlIOBase_clearerr(pTHX_ PerlIO *f);
179PERL_EXPORT_C IV PerlIOBase_close(pTHX_ PerlIO *f);
180PERL_EXPORT_C PerlIO * PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
181PERL_EXPORT_C IV PerlIOBase_eof(pTHX_ PerlIO *f);
182PERL_EXPORT_C IV PerlIOBase_error(pTHX_ PerlIO *f);
183PERL_EXPORT_C IV PerlIOBase_fileno(pTHX_ PerlIO *f);
184PERL_EXPORT_C void PerlIOBase_flush_linebuf(pTHX);
185PERL_EXPORT_C IV PerlIOBase_noop_fail(pTHX_ PerlIO *f);
186PERL_EXPORT_C IV PerlIOBase_noop_ok(pTHX_ PerlIO *f);
187PERL_EXPORT_C IV PerlIOBase_popped(pTHX_ PerlIO *f);
188PERL_EXPORT_C IV PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
81fe74fb 189PERL_EXPORT_C PerlIO * PerlIOBase_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);
de009b76
AL
190PERL_EXPORT_C SSize_t PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
191PERL_EXPORT_C void PerlIOBase_setlinebuf(pTHX_ PerlIO *f);
192PERL_EXPORT_C SSize_t PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
193
194/* Buf */
195PERL_EXPORT_C Size_t PerlIOBuf_bufsiz(pTHX_ PerlIO *f);
196PERL_EXPORT_C IV PerlIOBuf_close(pTHX_ PerlIO *f);
197PERL_EXPORT_C PerlIO * PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
198PERL_EXPORT_C IV PerlIOBuf_fill(pTHX_ PerlIO *f);
199PERL_EXPORT_C IV PerlIOBuf_flush(pTHX_ PerlIO *f);
200PERL_EXPORT_C STDCHAR * PerlIOBuf_get_base(pTHX_ PerlIO *f);
201PERL_EXPORT_C SSize_t PerlIOBuf_get_cnt(pTHX_ PerlIO *f);
202PERL_EXPORT_C STDCHAR * PerlIOBuf_get_ptr(pTHX_ PerlIO *f);
203PERL_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);
204PERL_EXPORT_C IV PerlIOBuf_popped(pTHX_ PerlIO *f);
205PERL_EXPORT_C IV PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
206PERL_EXPORT_C SSize_t PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
207PERL_EXPORT_C IV PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
208PERL_EXPORT_C void PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
209PERL_EXPORT_C Off_t PerlIOBuf_tell(pTHX_ PerlIO *f);
210PERL_EXPORT_C SSize_t PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
211PERL_EXPORT_C SSize_t PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
212
213/* Crlf */
214PERL_EXPORT_C IV PerlIOCrlf_binmode(pTHX_ PerlIO *f);
215PERL_EXPORT_C IV PerlIOCrlf_flush(pTHX_ PerlIO *f);
216PERL_EXPORT_C SSize_t PerlIOCrlf_get_cnt(pTHX_ PerlIO *f);
217PERL_EXPORT_C IV PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
218PERL_EXPORT_C void PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
219PERL_EXPORT_C SSize_t PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
220PERL_EXPORT_C SSize_t PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
221PERL_EXPORT_C SSize_t PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
222
de009b76
AL
223/* Pending */
224PERL_EXPORT_C IV PerlIOPending_close(pTHX_ PerlIO *f);
225PERL_EXPORT_C IV PerlIOPending_fill(pTHX_ PerlIO *f);
226PERL_EXPORT_C IV PerlIOPending_flush(pTHX_ PerlIO *f);
227PERL_EXPORT_C IV PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
228PERL_EXPORT_C SSize_t PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
229PERL_EXPORT_C IV PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
230PERL_EXPORT_C void PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt);
231
232/* Pop */
233PERL_EXPORT_C IV PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
234
235/* Raw */
de009b76
AL
236PERL_EXPORT_C IV PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
237
238/* Stdio */
239PERL_EXPORT_C void PerlIOStdio_clearerr(pTHX_ PerlIO *f);
240PERL_EXPORT_C IV PerlIOStdio_close(pTHX_ PerlIO *f);
241PERL_EXPORT_C PerlIO * PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
242PERL_EXPORT_C IV PerlIOStdio_eof(pTHX_ PerlIO *f);
243PERL_EXPORT_C IV PerlIOStdio_error(pTHX_ PerlIO *f);
244PERL_EXPORT_C IV PerlIOStdio_fileno(pTHX_ PerlIO *f);
245PERL_EXPORT_C IV PerlIOStdio_fill(pTHX_ PerlIO *f);
246PERL_EXPORT_C IV PerlIOStdio_flush(pTHX_ PerlIO *f);
247PERL_EXPORT_C STDCHAR * PerlIOStdio_get_base(pTHX_ PerlIO *f);
248PERL_EXPORT_C char * PerlIOStdio_mode(const char *mode, char *tmode);
249PERL_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);
250PERL_EXPORT_C IV PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
251PERL_EXPORT_C SSize_t PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
252PERL_EXPORT_C IV PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
253PERL_EXPORT_C void PerlIOStdio_setlinebuf(pTHX_ PerlIO *f);
254PERL_EXPORT_C Off_t PerlIOStdio_tell(pTHX_ PerlIO *f);
255PERL_EXPORT_C SSize_t PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
256PERL_EXPORT_C SSize_t PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
257
258/* Unix */
259PERL_EXPORT_C IV PerlIOUnix_close(pTHX_ PerlIO *f);
260PERL_EXPORT_C PerlIO * PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags);
261PERL_EXPORT_C IV PerlIOUnix_fileno(pTHX_ PerlIO *f);
262PERL_EXPORT_C int PerlIOUnix_oflags(const char *mode);
263PERL_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);
264PERL_EXPORT_C IV PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
265PERL_EXPORT_C SSize_t PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count);
266PERL_EXPORT_C int PerlIOUnix_refcnt_dec(int fd);
267PERL_EXPORT_C void PerlIOUnix_refcnt_inc(int fd);
2e0cfa16 268PERL_EXPORT_C int PerlIOUnix_refcnt(int fd);
de009b76
AL
269PERL_EXPORT_C IV PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence);
270PERL_EXPORT_C Off_t PerlIOUnix_tell(pTHX_ PerlIO *f);
271PERL_EXPORT_C SSize_t PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count);
272
273/* Utf8 */
274PERL_EXPORT_C IV PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab);
76ced9ad 275
14a5cf38 276#endif /* _PERLIOL_H */
e9a8c099
MHM
277
278/*
279 * Local variables:
280 * c-indentation-style: bsd
281 * c-basic-offset: 4
282 * indent-tabs-mode: t
283 * End:
284 *
285 * ex: set ts=8 sts=4 sw=4 noet:
286 */