This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
fd9aa3bb0b56c01dfba5e77a99b74bbfe60f217a
[perl5.git] / perlio.h
1 #ifndef _PERLIO_H
2 #define _PERLIO_H
3 /*
4   Interface for perl to IO functions.
5   There is a hierachy of Configure determined #define controls:
6    USE_STDIO   - forces PerlIO_xxx() to be #define-d onto stdio functions.
7                  This is used for x2p subdirectory and for conservative
8                  builds - "just like perl5.00X used to be".
9                  This dominates over the others.
10
11    USE_PERLIO  - The primary Configure variable that enables PerlIO.
12                  If USE_PERLIO is _NOT_ set
13                    then USE_STDIO above will be set to be conservative.
14                  If USE_PERLIO is set
15                    then there are two modes determined by USE_SFIO:
16
17    USE_SFIO    - If set causes PerlIO_xxx() to be #define-d onto sfio functions.
18                  A backward compatability mode for some specialist applications.
19
20                  If USE_SFIO is not set then PerlIO_xxx() are real functions
21                  defined in perlio.c which implement extra functionality
22                  required for utf8 support.
23
24    One further note - the table-of-functions scheme controlled
25    by PERL_IMPLICIT_SYS turns on USE_PERLIO so that iperlsys.h can
26    #define PerlIO_xxx() to go via the function table, without having
27    to #undef them from (say) stdio forms.
28
29 */
30
31 #if defined(PERL_IMPLICIT_SYS)
32 #ifndef USE_PERLIO
33 # define USE_PERLIO
34 #endif
35 #endif
36
37 #ifndef USE_PERLIO
38 # define USE_STDIO
39 #endif
40
41 #ifdef USE_STDIO
42 #  ifndef PERLIO_IS_STDIO
43 #      define PERLIO_IS_STDIO
44 #  endif
45 #endif
46
47 /* --------------------  End of Configure controls ---------------------------- */
48
49 /*
50  * Although we may not want stdio to be used including <stdio.h> here
51  * avoids issues where stdio.h has strange side effects
52  */
53 #include <stdio.h>
54
55 #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64)
56 #define ftell ftello
57 #endif
58
59 #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64)
60 #define fseek fseeko
61 #endif
62
63 #ifdef PERLIO_IS_STDIO
64 /* #define PerlIO_xxxx() as equivalent stdio function */
65 #include "perlsdio.h"
66 #else  /* PERLIO_IS_STDIO */
67 #ifdef USE_SFIO
68 /* #define PerlIO_xxxx() as equivalent sfio function */
69 #include "perlsfio.h"
70 #endif /* USE_SFIO */
71 #endif /* PERLIO_IS_STDIO */
72
73 #ifndef PerlIO
74 /* ----------- PerlIO implementation ---------- */
75 /* PerlIO not #define-d to something else - define the implementation */
76
77 typedef struct _PerlIO PerlIOl;
78 typedef struct _PerlIO_funcs PerlIO_funcs;
79 typedef PerlIOl *PerlIO;
80 #define PerlIO PerlIO
81 #define PERLIO_LAYERS 1
82
83 extern void     PerlIO_define_layer     (PerlIO_funcs *tab);
84 extern SV *     PerlIO_find_layer(char *name, STRLEN len);
85 extern PerlIO * PerlIO_push             (PerlIO *f,PerlIO_funcs *tab,const char *mode);
86 extern void     PerlIO_pop              (PerlIO *f);
87
88 #endif /* PerlIO */
89
90 /* ----------- End of implementation choices  ---------- */
91
92 #ifndef PERLIO_IS_STDIO
93 /* Not using stdio _directly_ as PerlIO */
94
95 /* We now need to determine  what happens if source trys to use stdio.
96  * There are three cases based on PERLIO_NOT_STDIO which XS code
97  * can set how it wants.
98  */
99
100 #ifdef PERL_CORE
101 /* Make a choice for perl core code
102    - currently this is set to try and catch lingering raw stdio calls.
103      This is a known issue with some non UNIX ports which still use
104      "native" stdio features.
105 */
106 #ifndef PERLIO_NOT_STDIO
107 #define PERLIO_NOT_STDIO 1
108 #endif
109 #endif
110
111 #ifdef PERLIO_NOT_STDIO
112 #if PERLIO_NOT_STDIO
113 /*
114  * PERLIO_NOT_STDIO #define'd as 1
115  * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
116  */
117 #include "nostdio.h"
118 #else /* if PERLIO_NOT_STDIO */
119 /*
120  * PERLIO_NOT_STDIO #define'd as 0
121  * Case 2: Declares that both PerlIO and stdio can be used
122  */
123 #endif /* if PERLIO_NOT_STDIO */
124 #else  /* ifdef PERLIO_NOT_STDIO */
125 /*
126  * PERLIO_NOT_STDIO not defined
127  * Case 3: Try and fake stdio calls as PerlIO calls
128  */
129 #include "fakesdio.h"
130 #endif /* ifndef PERLIO_NOT_STDIO */
131 #endif /* PERLIO_IS_STDIO */
132
133 /* ----------- fill in things that have not got #define'd  ---------- */
134
135 #ifndef Fpos_t
136 #define Fpos_t Off_t
137 #endif
138
139 #ifndef EOF
140 #define EOF (-1)
141 #endif
142
143 /* This is to catch case with no stdio */
144 #ifndef BUFSIZ
145 #define BUFSIZ 1024
146 #endif
147
148 #ifndef SEEK_SET
149 #define SEEK_SET 0
150 #endif
151
152 #ifndef SEEK_CUR
153 #define SEEK_CUR 1
154 #endif
155
156 #ifndef SEEK_END
157 #define SEEK_END 2
158 #endif
159
160 /* --------------------- Now prototypes for functions --------------- */
161
162 #ifndef NEXT30_NO_ATTRIBUTE
163 #ifndef HASATTRIBUTE       /* disable GNU-cc attribute checking? */
164 #ifdef  __attribute__      /* Avoid possible redefinition errors */
165 #undef  __attribute__
166 #endif
167 #define __attribute__(attr)
168 #endif
169 #endif
170
171 #ifndef PerlIO_init
172 extern void     PerlIO_init             (void);
173 #endif
174 #ifndef PerlIO_stdoutf
175 extern int      PerlIO_stdoutf          (const char *,...)
176                                         __attribute__((__format__ (__printf__, 1, 2)));
177 #endif
178 #ifndef PerlIO_puts
179 extern int      PerlIO_puts             (PerlIO *,const char *);
180 #endif
181 #ifndef PerlIO_open
182 extern PerlIO * PerlIO_open             (const char *,const char *);
183 #endif
184 #ifndef PerlIO_close
185 extern int      PerlIO_close            (PerlIO *);
186 #endif
187 #ifndef PerlIO_eof
188 extern int      PerlIO_eof              (PerlIO *);
189 #endif
190 #ifndef PerlIO_error
191 extern int      PerlIO_error            (PerlIO *);
192 #endif
193 #ifndef PerlIO_clearerr
194 extern void     PerlIO_clearerr         (PerlIO *);
195 #endif
196 #ifndef PerlIO_getc
197 extern int      PerlIO_getc             (PerlIO *);
198 #endif
199 #ifndef PerlIO_putc
200 extern int      PerlIO_putc             (PerlIO *,int);
201 #endif
202 #ifndef PerlIO_flush
203 extern int      PerlIO_flush            (PerlIO *);
204 #endif
205 #ifndef PerlIO_ungetc
206 extern int      PerlIO_ungetc           (PerlIO *,int);
207 #endif
208 #ifndef PerlIO_fileno
209 extern int      PerlIO_fileno           (PerlIO *);
210 #endif
211 #ifndef PerlIO_fdopen
212 extern PerlIO * PerlIO_fdopen           (int, const char *);
213 #endif
214 #ifndef PerlIO_importFILE
215 extern PerlIO * PerlIO_importFILE       (FILE *,int);
216 #endif
217 #ifndef PerlIO_exportFILE
218 extern FILE *   PerlIO_exportFILE       (PerlIO *,int);
219 #endif
220 #ifndef PerlIO_findFILE
221 extern FILE *   PerlIO_findFILE         (PerlIO *);
222 #endif
223 #ifndef PerlIO_releaseFILE
224 extern void     PerlIO_releaseFILE      (PerlIO *,FILE *);
225 #endif
226 #ifndef PerlIO_read
227 extern SSize_t  PerlIO_read             (PerlIO *,void *,Size_t);
228 #endif
229 #ifndef PerlIO_write
230 extern SSize_t  PerlIO_write            (PerlIO *,const void *,Size_t);
231 #endif
232 #ifndef PerlIO_setlinebuf
233 extern void     PerlIO_setlinebuf       (PerlIO *);
234 #endif
235 #ifndef PerlIO_printf
236 extern int      PerlIO_printf           (PerlIO *, const char *,...)
237                                         __attribute__((__format__ (__printf__, 2, 3)));
238 #endif
239 #ifndef PerlIO_sprintf
240 extern int      PerlIO_sprintf          (char *, int, const char *,...)
241                                         __attribute__((__format__ (__printf__, 3, 4)));
242 #endif
243 #ifndef PerlIO_vprintf
244 extern int      PerlIO_vprintf          (PerlIO *, const char *, va_list);
245 #endif
246 #ifndef PerlIO_tell
247 extern Off_t    PerlIO_tell             (PerlIO *);
248 #endif
249 #ifndef PerlIO_seek
250 extern int      PerlIO_seek             (PerlIO *, Off_t, int);
251 #endif
252 #ifndef PerlIO_rewind
253 extern void     PerlIO_rewind           (PerlIO *);
254 #endif
255 #ifndef PerlIO_has_base
256 extern int      PerlIO_has_base         (PerlIO *);
257 #endif
258 #ifndef PerlIO_has_cntptr
259 extern int      PerlIO_has_cntptr       (PerlIO *);
260 #endif
261 #ifndef PerlIO_fast_gets
262 extern int      PerlIO_fast_gets        (PerlIO *);
263 #endif
264 #ifndef PerlIO_canset_cnt
265 extern int      PerlIO_canset_cnt       (PerlIO *);
266 #endif
267 #ifndef PerlIO_get_ptr
268 extern STDCHAR * PerlIO_get_ptr         (PerlIO *);
269 #endif
270 #ifndef PerlIO_get_cnt
271 extern int      PerlIO_get_cnt          (PerlIO *);
272 #endif
273 #ifndef PerlIO_set_cnt
274 extern void     PerlIO_set_cnt          (PerlIO *,int);
275 #endif
276 #ifndef PerlIO_set_ptrcnt
277 extern void     PerlIO_set_ptrcnt       (PerlIO *,STDCHAR *,int);
278 #endif
279 #ifndef PerlIO_get_base
280 extern STDCHAR * PerlIO_get_base        (PerlIO *);
281 #endif
282 #ifndef PerlIO_get_bufsiz
283 extern int      PerlIO_get_bufsiz       (PerlIO *);
284 #endif
285 #ifndef PerlIO_tmpfile
286 extern PerlIO * PerlIO_tmpfile          (void);
287 #endif
288 #ifndef PerlIO_stdin
289 extern PerlIO * PerlIO_stdin            (void);
290 #endif
291 #ifndef PerlIO_stdout
292 extern PerlIO * PerlIO_stdout           (void);
293 #endif
294 #ifndef PerlIO_stderr
295 extern PerlIO * PerlIO_stderr           (void);
296 #endif
297 #ifndef PerlIO_getpos
298 extern int      PerlIO_getpos           (PerlIO *,Fpos_t *);
299 #endif
300 #ifndef PerlIO_setpos
301 extern int      PerlIO_setpos           (PerlIO *,const Fpos_t *);
302 #endif
303 #ifndef PerlIO_fdupopen
304 extern PerlIO * PerlIO_fdupopen         (PerlIO *);
305 #endif
306 #ifndef PerlIO_isutf8
307 extern int      PerlIO_isutf8           (PerlIO *);
308 #endif
309
310 #endif /* _PERLIO_H */