This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
PerlIO layer table as PL_perlio (per-interpreter)
[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
14a5cf38
JH
9typedef struct {
10 IV refcnt;
11 IV cur;
12 IV len;
13 PerlIO_pair_t *array;
fcf2db38
NIS
14} PerlIO_list_t;
15
14a5cf38
JH
16struct _PerlIO_funcs {
17 char *name;
18 Size_t size;
19 IV kind;
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,
24 const char *mode,
25 int fd, int imode, int perm,
26 PerlIO *old, int narg, SV **args);
27 SV *(*Getarg) (PerlIO *f);
28 IV (*Fileno) (PerlIO *f);
8cf8f3d1 29 PerlIO *(*Dup) (pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param);
14a5cf38
JH
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);
76ced9ad
NIS
50};
51
f5b9d040
NIS
52/*--------------------------------------------------------------------------------------*/
53/* Kind values */
5e2ab84b
NIS
54#define PERLIO_K_RAW 0x00000001
55#define PERLIO_K_BUFFERED 0x00000002
f5b9d040 56#define PERLIO_K_CANCRLF 0x00000004
5e2ab84b 57#define PERLIO_K_FASTGETS 0x00000008
dfebf958 58#define PERLIO_K_DUMMY 0x00000010
26fb694e 59#define PERLIO_K_UTF8 0x00008000
13621cfb 60#define PERLIO_K_DESTRUCT 0x00010000
f5b9d040
NIS
61
62/*--------------------------------------------------------------------------------------*/
14a5cf38
JH
63struct _PerlIO {
64 PerlIOl *next; /* Lower layer */
65 PerlIO_funcs *tab; /* Functions for this layer */
66 IV flags; /* Various flags for state */
76ced9ad
NIS
67};
68
69/*--------------------------------------------------------------------------------------*/
70
71/* Flag values */
5e2ab84b
NIS
72#define PERLIO_F_EOF 0x00000100
73#define PERLIO_F_CANWRITE 0x00000200
74#define PERLIO_F_CANREAD 0x00000400
75#define PERLIO_F_ERROR 0x00000800
76#define PERLIO_F_TRUNCATE 0x00001000
77#define PERLIO_F_APPEND 0x00002000
78#define PERLIO_F_CRLF 0x00004000
79#define PERLIO_F_UTF8 0x00008000
80#define PERLIO_F_UNBUF 0x00010000
81#define PERLIO_F_WRBUF 0x00020000
82#define PERLIO_F_RDBUF 0x00040000
83#define PERLIO_F_LINEBUF 0x00080000
84#define PERLIO_F_TEMP 0x00100000
85#define PERLIO_F_OPEN 0x00200000
86#define PERLIO_F_FASTGETS 0x00400000
a9c883f6 87#define PERLIO_F_TTY 0x00800000
76ced9ad
NIS
88
89#define PerlIOBase(f) (*(f))
90#define PerlIOSelf(f,type) ((type *)PerlIOBase(f))
91#define PerlIONext(f) (&(PerlIOBase(f)->next))
92
93/*--------------------------------------------------------------------------------------*/
26fb694e
NIS
94/* Data exports - EXT rather than extern is needed for Cygwin */
95EXT PerlIO_funcs PerlIO_unix;
96EXT PerlIO_funcs PerlIO_perlio;
97EXT PerlIO_funcs PerlIO_stdio;
98EXT PerlIO_funcs PerlIO_crlf;
99EXT PerlIO_funcs PerlIO_utf8;
100EXT PerlIO_funcs PerlIO_byte;
101EXT PerlIO_funcs PerlIO_raw;
7ea3cd40 102EXT PerlIO_funcs PerlIO_pending;
76ced9ad 103#ifdef HAS_MMAP
26fb694e 104EXT PerlIO_funcs PerlIO_mmap;
76ced9ad 105#endif
0c4128ad
NIS
106#ifdef WIN32
107EXT PerlIO_funcs PerlIO_win32;
108#endif
5f1a76d0 109extern PerlIO *PerlIO_allocate(pTHX);
14a5cf38 110extern SV *PerlIO_arg_fetch(PerlIO_list_t *av, IV n);
fcf2db38 111#define PerlIOArg PerlIO_arg_fetch(layers,n)
76ced9ad 112
f5b9d040
NIS
113#if O_BINARY != O_TEXT
114#define PERLIO_STDTEXT "t"
115#else
116#define PERLIO_STDTEXT ""
117#endif
118
76ced9ad
NIS
119/*--------------------------------------------------------------------------------------*/
120/* Generic, or stub layer functions */
121
14a5cf38 122extern IV PerlIOBase_fileno(PerlIO *f);
8cf8f3d1 123extern PerlIO *PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param);
14a5cf38
JH
124extern IV PerlIOBase_pushed(PerlIO *f, const char *mode, SV *arg);
125extern IV PerlIOBase_popped(PerlIO *f);
126extern SSize_t PerlIOBase_read(PerlIO *f, void *vbuf, Size_t count);
127extern SSize_t PerlIOBase_unread(PerlIO *f, const void *vbuf,
128 Size_t count);
129extern IV PerlIOBase_eof(PerlIO *f);
130extern IV PerlIOBase_error(PerlIO *f);
131extern void PerlIOBase_clearerr(PerlIO *f);
132extern IV PerlIOBase_close(PerlIO *f);
133extern void PerlIOBase_setlinebuf(PerlIO *f);
134extern void PerlIOBase_flush_linebuf(void);
135
136extern IV PerlIOBase_noop_ok(PerlIO *f);
137extern IV PerlIOBase_noop_fail(PerlIO *f);
76ced9ad
NIS
138
139/*--------------------------------------------------------------------------------------*/
140/* perlio buffer layer
141 As this is reasonably generic its struct and "methods" are declared here
142 so they can be used to "inherit" from it.
143*/
144
14a5cf38
JH
145typedef struct {
146 struct _PerlIO base; /* Base "class" info */
147 STDCHAR *buf; /* Start of buffer */
148 STDCHAR *end; /* End of valid part of buffer */
149 STDCHAR *ptr; /* Current position in buffer */
150 Off_t posn; /* Offset of buf into the file */
151 Size_t bufsiz; /* Real size of buffer */
152 IV oneword; /* Emergency buffer */
76ced9ad
NIS
153} PerlIOBuf;
154
8cf8f3d1 155extern SV *PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param);
14a5cf38
JH
156extern PerlIO *PerlIOBuf_open(pTHX_ PerlIO_funcs *self,
157 PerlIO_list_t *layers, IV n,
158 const char *mode, int fd, int imode,
159 int perm, PerlIO *old, int narg, SV **args);
160extern IV PerlIOBuf_pushed(PerlIO *f, const char *mode, SV *arg);
161extern SSize_t PerlIOBuf_read(PerlIO *f, void *vbuf, Size_t count);
162extern SSize_t PerlIOBuf_unread(PerlIO *f, const void *vbuf, Size_t count);
163extern SSize_t PerlIOBuf_write(PerlIO *f, const void *vbuf, Size_t count);
164extern IV PerlIOBuf_seek(PerlIO *f, Off_t offset, int whence);
165extern Off_t PerlIOBuf_tell(PerlIO *f);
166extern IV PerlIOBuf_close(PerlIO *f);
167extern IV PerlIOBuf_flush(PerlIO *f);
168extern IV PerlIOBuf_fill(PerlIO *f);
169extern STDCHAR *PerlIOBuf_get_base(PerlIO *f);
170extern Size_t PerlIOBuf_bufsiz(PerlIO *f);
171extern STDCHAR *PerlIOBuf_get_ptr(PerlIO *f);
172extern SSize_t PerlIOBuf_get_cnt(PerlIO *f);
173extern void PerlIOBuf_set_ptrcnt(PerlIO *f, STDCHAR * ptr, SSize_t cnt);
174
175extern int PerlIOUnix_oflags(const char *mode);
0c4128ad 176
76ced9ad
NIS
177/*--------------------------------------------------------------------------------------*/
178
14a5cf38 179#endif /* _PERLIOL_H */