Commit | Line | Data |
76ced9ad |
1 | #ifndef _PERLIOL_H |
2 | #define _PERLIOL_H |
3 | |
4 | struct _PerlIO_funcs |
5 | { |
6 | char * name; |
7 | Size_t size; |
8 | IV kind; |
e3f3bf95 |
9 | IV (*Pushed)(PerlIO *f,const char *mode,SV *arg); |
76ced9ad |
10 | IV (*Popped)(PerlIO *f); |
e3f3bf95 |
11 | PerlIO * (*Open)(pTHX_ PerlIO_funcs *tab, |
12 | AV *layers, IV n, |
13 | const char *mode, |
14 | int fd, int imode, int perm, |
15 | PerlIO *old, |
16 | int narg, SV **args); |
17 | SV * (*Getarg)(PerlIO *f); |
18 | IV (*Fileno)(PerlIO *f); |
76ced9ad |
19 | /* Unix-like functions - cf sfio line disciplines */ |
20 | SSize_t (*Read)(PerlIO *f, void *vbuf, Size_t count); |
21 | SSize_t (*Unread)(PerlIO *f, const void *vbuf, Size_t count); |
22 | SSize_t (*Write)(PerlIO *f, const void *vbuf, Size_t count); |
23 | IV (*Seek)(PerlIO *f, Off_t offset, int whence); |
24 | Off_t (*Tell)(PerlIO *f); |
25 | IV (*Close)(PerlIO *f); |
26 | /* Stdio-like buffered IO functions */ |
27 | IV (*Flush)(PerlIO *f); |
28 | IV (*Fill)(PerlIO *f); |
29 | IV (*Eof)(PerlIO *f); |
30 | IV (*Error)(PerlIO *f); |
31 | void (*Clearerr)(PerlIO *f); |
32 | void (*Setlinebuf)(PerlIO *f); |
33 | /* Perl's snooping functions */ |
34 | STDCHAR * (*Get_base)(PerlIO *f); |
35 | Size_t (*Get_bufsiz)(PerlIO *f); |
36 | STDCHAR * (*Get_ptr)(PerlIO *f); |
37 | SSize_t (*Get_cnt)(PerlIO *f); |
38 | void (*Set_ptrcnt)(PerlIO *f,STDCHAR *ptr,SSize_t cnt); |
39 | }; |
40 | |
f5b9d040 |
41 | /*--------------------------------------------------------------------------------------*/ |
42 | /* Kind values */ |
5e2ab84b |
43 | #define PERLIO_K_RAW 0x00000001 |
44 | #define PERLIO_K_BUFFERED 0x00000002 |
f5b9d040 |
45 | #define PERLIO_K_CANCRLF 0x00000004 |
5e2ab84b |
46 | #define PERLIO_K_FASTGETS 0x00000008 |
dfebf958 |
47 | #define PERLIO_K_DUMMY 0x00000010 |
26fb694e |
48 | #define PERLIO_K_UTF8 0x00008000 |
f5b9d040 |
49 | |
50 | /*--------------------------------------------------------------------------------------*/ |
76ced9ad |
51 | struct _PerlIO |
52 | { |
53 | PerlIOl * next; /* Lower layer */ |
54 | PerlIO_funcs * tab; /* Functions for this layer */ |
55 | IV flags; /* Various flags for state */ |
56 | }; |
57 | |
58 | /*--------------------------------------------------------------------------------------*/ |
59 | |
60 | /* Flag values */ |
5e2ab84b |
61 | #define PERLIO_F_EOF 0x00000100 |
62 | #define PERLIO_F_CANWRITE 0x00000200 |
63 | #define PERLIO_F_CANREAD 0x00000400 |
64 | #define PERLIO_F_ERROR 0x00000800 |
65 | #define PERLIO_F_TRUNCATE 0x00001000 |
66 | #define PERLIO_F_APPEND 0x00002000 |
67 | #define PERLIO_F_CRLF 0x00004000 |
68 | #define PERLIO_F_UTF8 0x00008000 |
69 | #define PERLIO_F_UNBUF 0x00010000 |
70 | #define PERLIO_F_WRBUF 0x00020000 |
71 | #define PERLIO_F_RDBUF 0x00040000 |
72 | #define PERLIO_F_LINEBUF 0x00080000 |
73 | #define PERLIO_F_TEMP 0x00100000 |
74 | #define PERLIO_F_OPEN 0x00200000 |
75 | #define PERLIO_F_FASTGETS 0x00400000 |
76ced9ad |
76 | |
77 | #define PerlIOBase(f) (*(f)) |
78 | #define PerlIOSelf(f,type) ((type *)PerlIOBase(f)) |
79 | #define PerlIONext(f) (&(PerlIOBase(f)->next)) |
80 | |
81 | /*--------------------------------------------------------------------------------------*/ |
26fb694e |
82 | /* Data exports - EXT rather than extern is needed for Cygwin */ |
83 | EXT PerlIO_funcs PerlIO_unix; |
84 | EXT PerlIO_funcs PerlIO_perlio; |
85 | EXT PerlIO_funcs PerlIO_stdio; |
86 | EXT PerlIO_funcs PerlIO_crlf; |
87 | EXT PerlIO_funcs PerlIO_utf8; |
88 | EXT PerlIO_funcs PerlIO_byte; |
89 | EXT PerlIO_funcs PerlIO_raw; |
7ea3cd40 |
90 | EXT PerlIO_funcs PerlIO_pending; |
76ced9ad |
91 | #ifdef HAS_MMAP |
26fb694e |
92 | EXT PerlIO_funcs PerlIO_mmap; |
76ced9ad |
93 | #endif |
94 | |
5f1a76d0 |
95 | extern PerlIO *PerlIO_allocate(pTHX); |
f6c77cf1 |
96 | extern SV *PerlIO_arg_fetch(pTHX_ AV *av,IV n); |
97 | #define PerlIOArg PerlIO_arg_fetch(aTHX_ layers,n+1) |
76ced9ad |
98 | |
f5b9d040 |
99 | #if O_BINARY != O_TEXT |
100 | #define PERLIO_STDTEXT "t" |
101 | #else |
102 | #define PERLIO_STDTEXT "" |
103 | #endif |
104 | |
76ced9ad |
105 | /*--------------------------------------------------------------------------------------*/ |
106 | /* Generic, or stub layer functions */ |
107 | |
108 | extern IV PerlIOBase_fileno (PerlIO *f); |
e3f3bf95 |
109 | extern IV PerlIOBase_pushed (PerlIO *f, const char *mode,SV *arg); |
76ced9ad |
110 | extern IV PerlIOBase_popped (PerlIO *f); |
f6c77cf1 |
111 | extern SSize_t PerlIOBase_read (PerlIO *f, void *vbuf, Size_t count); |
76ced9ad |
112 | extern SSize_t PerlIOBase_unread (PerlIO *f, const void *vbuf, Size_t count); |
113 | extern IV PerlIOBase_eof (PerlIO *f); |
114 | extern IV PerlIOBase_error (PerlIO *f); |
115 | extern void PerlIOBase_clearerr (PerlIO *f); |
116 | extern IV PerlIOBase_flush (PerlIO *f); |
117 | extern IV PerlIOBase_fill (PerlIO *f); |
118 | extern IV PerlIOBase_close (PerlIO *f); |
119 | extern void PerlIOBase_setlinebuf(PerlIO *f); |
120 | |
121 | extern IV PerlIOBase_noop_ok (PerlIO *f); |
122 | extern IV PerlIOBase_noop_fail (PerlIO *f); |
123 | |
124 | /*--------------------------------------------------------------------------------------*/ |
125 | /* perlio buffer layer |
126 | As this is reasonably generic its struct and "methods" are declared here |
127 | so they can be used to "inherit" from it. |
128 | */ |
129 | |
130 | typedef struct |
131 | { |
132 | struct _PerlIO base; /* Base "class" info */ |
133 | STDCHAR * buf; /* Start of buffer */ |
134 | STDCHAR * end; /* End of valid part of buffer */ |
135 | STDCHAR * ptr; /* Current position in buffer */ |
136 | Off_t posn; /* Offset of buf into the file */ |
137 | Size_t bufsiz; /* Real size of buffer */ |
138 | IV oneword; /* Emergency buffer */ |
139 | } PerlIOBuf; |
140 | |
e3f3bf95 |
141 | extern PerlIO * PerlIOBuf_open (pTHX_ PerlIO_funcs *self, AV *layers, IV n, const char *mode, int fd, int imode, int perm, PerlIO *old, int narg, SV **args); |
142 | extern IV PerlIOBuf_pushed (PerlIO *f, const char *mode,SV *arg); |
76ced9ad |
143 | extern SSize_t PerlIOBuf_read (PerlIO *f, void *vbuf, Size_t count); |
144 | extern SSize_t PerlIOBuf_unread (PerlIO *f, const void *vbuf, Size_t count); |
145 | extern SSize_t PerlIOBuf_write (PerlIO *f, const void *vbuf, Size_t count); |
146 | extern IV PerlIOBuf_seek (PerlIO *f, Off_t offset, int whence); |
147 | extern Off_t PerlIOBuf_tell (PerlIO *f); |
148 | extern IV PerlIOBuf_close (PerlIO *f); |
149 | extern IV PerlIOBuf_flush (PerlIO *f); |
150 | extern IV PerlIOBuf_fill (PerlIO *f); |
76ced9ad |
151 | extern STDCHAR *PerlIOBuf_get_base (PerlIO *f); |
152 | extern Size_t PerlIOBuf_bufsiz (PerlIO *f); |
153 | extern STDCHAR *PerlIOBuf_get_ptr (PerlIO *f); |
154 | extern SSize_t PerlIOBuf_get_cnt (PerlIO *f); |
155 | extern void PerlIOBuf_set_ptrcnt (PerlIO *f, STDCHAR *ptr, SSize_t cnt); |
156 | |
157 | /*--------------------------------------------------------------------------------------*/ |
158 | |
159 | #endif /* _PERLIOL_H */ |