This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Avoid AV and HV in perlio.c by inventing PerlIO_list_t which is AV-ish
[perl5.git] / perliol.h
1 #ifndef _PERLIOL_H
2 #define _PERLIOL_H
3
4 typedef struct
5 {
6  PerlIO_funcs *funcs;
7  SV *arg;
8 } PerlIO_pair_t;
9
10 typedef struct
11 {
12  IV refcnt;
13  IV cur;
14  IV len;
15  PerlIO_pair_t *array;
16 } PerlIO_list_t;
17
18 struct _PerlIO_funcs
19 {
20  char *         name;
21  Size_t         size;
22  IV             kind;
23  IV             (*Pushed)(PerlIO *f,const char *mode,SV *arg);
24  IV             (*Popped)(PerlIO *f);
25  PerlIO *       (*Open)(pTHX_ PerlIO_funcs *tab,
26                         PerlIO_list_t *layers, IV n,
27                         const char *mode,
28                         int fd, int imode, int perm,
29                         PerlIO *old,
30                         int narg, SV **args);
31  SV *           (*Getarg)(PerlIO *f);
32  IV             (*Fileno)(PerlIO *f);
33  /* Unix-like functions - cf sfio line disciplines */
34  SSize_t        (*Read)(PerlIO *f, void *vbuf, Size_t count);
35  SSize_t        (*Unread)(PerlIO *f, const void *vbuf, Size_t count);
36  SSize_t        (*Write)(PerlIO *f, const void *vbuf, Size_t count);
37  IV             (*Seek)(PerlIO *f, Off_t offset, int whence);
38  Off_t          (*Tell)(PerlIO *f);
39  IV             (*Close)(PerlIO *f);
40  /* Stdio-like buffered IO functions */
41  IV             (*Flush)(PerlIO *f);
42  IV             (*Fill)(PerlIO *f);
43  IV             (*Eof)(PerlIO *f);
44  IV             (*Error)(PerlIO *f);
45  void           (*Clearerr)(PerlIO *f);
46  void           (*Setlinebuf)(PerlIO *f);
47  /* Perl's snooping functions */
48  STDCHAR *      (*Get_base)(PerlIO *f);
49  Size_t         (*Get_bufsiz)(PerlIO *f);
50  STDCHAR *      (*Get_ptr)(PerlIO *f);
51  SSize_t        (*Get_cnt)(PerlIO *f);
52  void           (*Set_ptrcnt)(PerlIO *f,STDCHAR *ptr,SSize_t cnt);
53 };
54
55 /*--------------------------------------------------------------------------------------*/
56 /* Kind values */
57 #define PERLIO_K_RAW            0x00000001
58 #define PERLIO_K_BUFFERED       0x00000002
59 #define PERLIO_K_CANCRLF        0x00000004
60 #define PERLIO_K_FASTGETS       0x00000008
61 #define PERLIO_K_DUMMY          0x00000010
62 #define PERLIO_K_UTF8           0x00008000
63 #define PERLIO_K_DESTRUCT       0x00010000
64
65 /*--------------------------------------------------------------------------------------*/
66 struct _PerlIO
67 {
68  PerlIOl *      next;       /* Lower layer */
69  PerlIO_funcs * tab;        /* Functions for this layer */
70  IV             flags;      /* Various flags for state */
71 };
72
73 /*--------------------------------------------------------------------------------------*/
74
75 /* Flag values */
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
91 #define PERLIO_F_TTY            0x00800000
92
93 #define PerlIOBase(f)      (*(f))
94 #define PerlIOSelf(f,type) ((type *)PerlIOBase(f))
95 #define PerlIONext(f)      (&(PerlIOBase(f)->next))
96
97 /*--------------------------------------------------------------------------------------*/
98 /* Data exports - EXT rather than extern is needed for Cygwin */
99 EXT PerlIO_funcs PerlIO_unix;
100 EXT PerlIO_funcs PerlIO_perlio;
101 EXT PerlIO_funcs PerlIO_stdio;
102 EXT PerlIO_funcs PerlIO_crlf;
103 EXT PerlIO_funcs PerlIO_utf8;
104 EXT PerlIO_funcs PerlIO_byte;
105 EXT PerlIO_funcs PerlIO_raw;
106 EXT PerlIO_funcs PerlIO_pending;
107 #ifdef HAS_MMAP
108 EXT PerlIO_funcs PerlIO_mmap;
109 #endif
110
111 extern PerlIO *PerlIO_allocate(pTHX);
112 extern SV *PerlIO_arg_fetch(PerlIO_list_t *av,IV n);
113 #define PerlIOArg PerlIO_arg_fetch(layers,n)
114
115 #if O_BINARY != O_TEXT
116 #define PERLIO_STDTEXT "t"
117 #else
118 #define PERLIO_STDTEXT ""
119 #endif
120
121 /*--------------------------------------------------------------------------------------*/
122 /* Generic, or stub layer functions */
123
124 extern IV       PerlIOBase_fileno    (PerlIO *f);
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, Size_t count);
129 extern IV       PerlIOBase_eof       (PerlIO *f);
130 extern IV       PerlIOBase_error     (PerlIO *f);
131 extern void     PerlIOBase_clearerr  (PerlIO *f);
132 extern IV       PerlIOBase_close     (PerlIO *f);
133 extern void     PerlIOBase_setlinebuf(PerlIO *f);
134 extern void     PerlIOBase_flush_linebuf(void);
135
136 extern IV       PerlIOBase_noop_ok   (PerlIO *f);
137 extern IV       PerlIOBase_noop_fail (PerlIO *f);
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
145 typedef struct
146 {
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 */
154 } PerlIOBuf;
155
156 extern 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);
157 extern IV       PerlIOBuf_pushed     (PerlIO *f, const char *mode,SV *arg);
158 extern SSize_t  PerlIOBuf_read       (PerlIO *f, void *vbuf, Size_t count);
159 extern SSize_t  PerlIOBuf_unread     (PerlIO *f, const void *vbuf, Size_t count);
160 extern SSize_t  PerlIOBuf_write      (PerlIO *f, const void *vbuf, Size_t count);
161 extern IV       PerlIOBuf_seek       (PerlIO *f, Off_t offset, int whence);
162 extern Off_t    PerlIOBuf_tell       (PerlIO *f);
163 extern IV       PerlIOBuf_close      (PerlIO *f);
164 extern IV       PerlIOBuf_flush      (PerlIO *f);
165 extern IV       PerlIOBuf_fill       (PerlIO *f);
166 extern STDCHAR *PerlIOBuf_get_base   (PerlIO *f);
167 extern Size_t   PerlIOBuf_bufsiz     (PerlIO *f);
168 extern STDCHAR *PerlIOBuf_get_ptr    (PerlIO *f);
169 extern SSize_t  PerlIOBuf_get_cnt    (PerlIO *f);
170 extern void     PerlIOBuf_set_ptrcnt (PerlIO *f, STDCHAR *ptr, SSize_t cnt);
171
172 /*--------------------------------------------------------------------------------------*/
173
174 #endif /* _PERLIOL_H */