Commit | Line | Data |
---|---|---|
eb1102fc NIS |
1 | /* perlio.h |
2 | * | |
4bb101f2 | 3 | * Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003, |
699a97de | 4 | * 2004, 2005, 2006 by Larry Wall and others |
eb1102fc NIS |
5 | * |
6 | * You may distribute under the terms of either the GNU General Public | |
7 | * License or the Artistic License, as specified in the README file. | |
8 | * | |
9 | */ | |
10 | ||
76ced9ad NIS |
11 | #ifndef _PERLIO_H |
12 | #define _PERLIO_H | |
13 | /* | |
14 | Interface for perl to IO functions. | |
3d036c2b | 15 | There is a hierarchy of Configure determined #define controls: |
76ced9ad NIS |
16 | USE_STDIO - forces PerlIO_xxx() to be #define-d onto stdio functions. |
17 | This is used for x2p subdirectory and for conservative | |
18 | builds - "just like perl5.00X used to be". | |
19 | This dominates over the others. | |
20 | ||
21 | USE_PERLIO - The primary Configure variable that enables PerlIO. | |
22 | If USE_PERLIO is _NOT_ set | |
23 | then USE_STDIO above will be set to be conservative. | |
24 | If USE_PERLIO is set | |
25 | then there are two modes determined by USE_SFIO: | |
26 | ||
27 | USE_SFIO - If set causes PerlIO_xxx() to be #define-d onto sfio functions. | |
28 | A backward compatability mode for some specialist applications. | |
29 | ||
30 | If USE_SFIO is not set then PerlIO_xxx() are real functions | |
31 | defined in perlio.c which implement extra functionality | |
32 | required for utf8 support. | |
33 | ||
34 | One further note - the table-of-functions scheme controlled | |
35 | by PERL_IMPLICIT_SYS turns on USE_PERLIO so that iperlsys.h can | |
36 | #define PerlIO_xxx() to go via the function table, without having | |
37 | to #undef them from (say) stdio forms. | |
38 | ||
39 | */ | |
40 | ||
41 | #if defined(PERL_IMPLICIT_SYS) | |
42 | #ifndef USE_PERLIO | |
2986a63f | 43 | #ifndef NETWARE |
2cbbe5a1 | 44 | /* # define USE_PERLIO */ |
76ced9ad NIS |
45 | #endif |
46 | #endif | |
2986a63f | 47 | #endif |
76ced9ad NIS |
48 | |
49 | #ifndef USE_PERLIO | |
50 | # define USE_STDIO | |
51 | #endif | |
52 | ||
53 | #ifdef USE_STDIO | |
54 | # ifndef PERLIO_IS_STDIO | |
55 | # define PERLIO_IS_STDIO | |
56 | # endif | |
57 | #endif | |
58 | ||
59 | /* -------------------- End of Configure controls ---------------------------- */ | |
60 | ||
61 | /* | |
62 | * Although we may not want stdio to be used including <stdio.h> here | |
63 | * avoids issues where stdio.h has strange side effects | |
64 | */ | |
65 | #include <stdio.h> | |
66 | ||
2a15cca7 JH |
67 | #ifdef __BEOS__ |
68 | int fseeko(FILE *stream, off_t offset, int whence); | |
69 | off_t ftello(FILE *stream); | |
70 | #endif | |
71 | ||
76ced9ad NIS |
72 | #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64) |
73 | #define ftell ftello | |
74 | #endif | |
75 | ||
76 | #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64) | |
77 | #define fseek fseeko | |
78 | #endif | |
79 | ||
6f2bd249 JH |
80 | /* BS2000 includes are sometimes a bit non standard :-( */ |
81 | #if defined(POSIX_BC) && defined(O_BINARY) && !defined(O_TEXT) | |
82 | #undef O_BINARY | |
83 | #endif | |
84 | ||
76ced9ad NIS |
85 | #ifdef PERLIO_IS_STDIO |
86 | /* #define PerlIO_xxxx() as equivalent stdio function */ | |
87 | #include "perlsdio.h" | |
14a5cf38 | 88 | #else /* PERLIO_IS_STDIO */ |
76ced9ad NIS |
89 | #ifdef USE_SFIO |
90 | /* #define PerlIO_xxxx() as equivalent sfio function */ | |
91 | #include "perlsfio.h" | |
14a5cf38 JH |
92 | #endif /* USE_SFIO */ |
93 | #endif /* PERLIO_IS_STDIO */ | |
76ced9ad NIS |
94 | |
95 | #ifndef PerlIO | |
96 | /* ----------- PerlIO implementation ---------- */ | |
97 | /* PerlIO not #define-d to something else - define the implementation */ | |
98 | ||
99 | typedef struct _PerlIO PerlIOl; | |
100 | typedef struct _PerlIO_funcs PerlIO_funcs; | |
101 | typedef PerlIOl *PerlIO; | |
102 | #define PerlIO PerlIO | |
a1d180c4 | 103 | #define PERLIO_LAYERS 1 |
76ced9ad | 104 | |
27da23d5 JH |
105 | /* Making the big PerlIO_funcs vtables const is good (enables placing |
106 | * them in the const section which is good for speed, security, and | |
107 | * embeddability) but this cannot be done by default because of | |
108 | * backward compatibility. */ | |
109 | #ifdef PERLIO_FUNCS_CONST | |
110 | #define PERLIO_FUNCS_DECL(funcs) const PerlIO_funcs funcs | |
111 | #define PERLIO_FUNCS_CAST(funcs) (PerlIO_funcs*)(funcs) | |
112 | #else | |
113 | #define PERLIO_FUNCS_DECL(funcs) PerlIO_funcs funcs | |
114 | #define PERLIO_FUNCS_CAST(funcs) (funcs) | |
115 | #endif | |
116 | ||
117 | PERL_EXPORT_C void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab); | |
118 | PERL_EXPORT_C PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name, | |
119 | STRLEN len, | |
120 | int load); | |
121 | PERL_EXPORT_C PerlIO *PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), | |
122 | const char *mode, SV *arg); | |
123 | PERL_EXPORT_C void PerlIO_pop(pTHX_ PerlIO *f); | |
124 | PERL_EXPORT_C AV* PerlIO_get_layers(pTHX_ PerlIO *f); | |
125 | PERL_EXPORT_C void PerlIO_clone(pTHX_ PerlInterpreter *proto, | |
126 | CLONE_PARAMS *param); | |
76ced9ad | 127 | |
14a5cf38 | 128 | #endif /* PerlIO */ |
76ced9ad NIS |
129 | |
130 | /* ----------- End of implementation choices ---------- */ | |
131 | ||
132 | #ifndef PERLIO_IS_STDIO | |
133 | /* Not using stdio _directly_ as PerlIO */ | |
134 | ||
135 | /* We now need to determine what happens if source trys to use stdio. | |
136 | * There are three cases based on PERLIO_NOT_STDIO which XS code | |
137 | * can set how it wants. | |
138 | */ | |
139 | ||
140 | #ifdef PERL_CORE | |
141 | /* Make a choice for perl core code | |
142 | - currently this is set to try and catch lingering raw stdio calls. | |
143 | This is a known issue with some non UNIX ports which still use | |
144 | "native" stdio features. | |
145 | */ | |
146 | #ifndef PERLIO_NOT_STDIO | |
147 | #define PERLIO_NOT_STDIO 1 | |
148 | #endif | |
f7e7eb72 NIS |
149 | #else |
150 | #ifndef PERLIO_NOT_STDIO | |
151 | #define PERLIO_NOT_STDIO 0 | |
152 | #endif | |
76ced9ad NIS |
153 | #endif |
154 | ||
155 | #ifdef PERLIO_NOT_STDIO | |
156 | #if PERLIO_NOT_STDIO | |
157 | /* | |
158 | * PERLIO_NOT_STDIO #define'd as 1 | |
159 | * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors | |
160 | */ | |
161 | #include "nostdio.h" | |
14a5cf38 | 162 | #else /* if PERLIO_NOT_STDIO */ |
76ced9ad NIS |
163 | /* |
164 | * PERLIO_NOT_STDIO #define'd as 0 | |
165 | * Case 2: Declares that both PerlIO and stdio can be used | |
166 | */ | |
14a5cf38 JH |
167 | #endif /* if PERLIO_NOT_STDIO */ |
168 | #else /* ifdef PERLIO_NOT_STDIO */ | |
76ced9ad NIS |
169 | /* |
170 | * PERLIO_NOT_STDIO not defined | |
171 | * Case 3: Try and fake stdio calls as PerlIO calls | |
172 | */ | |
173 | #include "fakesdio.h" | |
14a5cf38 JH |
174 | #endif /* ifndef PERLIO_NOT_STDIO */ |
175 | #endif /* PERLIO_IS_STDIO */ | |
76ced9ad NIS |
176 | |
177 | /* ----------- fill in things that have not got #define'd ---------- */ | |
178 | ||
179 | #ifndef Fpos_t | |
180 | #define Fpos_t Off_t | |
181 | #endif | |
182 | ||
183 | #ifndef EOF | |
184 | #define EOF (-1) | |
185 | #endif | |
186 | ||
187 | /* This is to catch case with no stdio */ | |
188 | #ifndef BUFSIZ | |
189 | #define BUFSIZ 1024 | |
190 | #endif | |
191 | ||
192 | #ifndef SEEK_SET | |
193 | #define SEEK_SET 0 | |
194 | #endif | |
195 | ||
196 | #ifndef SEEK_CUR | |
197 | #define SEEK_CUR 1 | |
198 | #endif | |
199 | ||
200 | #ifndef SEEK_END | |
201 | #define SEEK_END 2 | |
202 | #endif | |
203 | ||
ecdeb87c NIS |
204 | #define PERLIO_DUP_CLONE 1 |
205 | #define PERLIO_DUP_FD 2 | |
206 | ||
76ced9ad NIS |
207 | /* --------------------- Now prototypes for functions --------------- */ |
208 | ||
adb71456 | 209 | START_EXTERN_C |
2c2e4525 | 210 | #ifndef __attribute__format__ |
b79c357a RGS |
211 | # ifdef HASATTRIBUTE_FORMAT |
212 | # define __attribute__format__(x,y,z) __attribute__((format(x,y,z))) | |
213 | # else | |
214 | # define __attribute__format__(x,y,z) | |
215 | # endif | |
76ced9ad | 216 | #endif |
76ced9ad | 217 | #ifndef PerlIO_init |
27da23d5 | 218 | PERL_EXPORT_C void PerlIO_init(pTHX); |
76ced9ad NIS |
219 | #endif |
220 | #ifndef PerlIO_stdoutf | |
27da23d5 | 221 | PERL_EXPORT_C int PerlIO_stdoutf(const char *, ...) |
287c8091 | 222 | __attribute__format__(__printf__, 1, 2); |
76ced9ad NIS |
223 | #endif |
224 | #ifndef PerlIO_puts | |
27da23d5 | 225 | PERL_EXPORT_C int PerlIO_puts(PerlIO *, const char *); |
76ced9ad NIS |
226 | #endif |
227 | #ifndef PerlIO_open | |
27da23d5 | 228 | PERL_EXPORT_C PerlIO *PerlIO_open(const char *, const char *); |
76ced9ad | 229 | #endif |
6e60e805 | 230 | #ifndef PerlIO_openn |
27da23d5 JH |
231 | PERL_EXPORT_C PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode, |
232 | int fd, int imode, int perm, PerlIO *old, | |
233 | int narg, SV **arg); | |
ee518936 | 234 | #endif |
76ced9ad | 235 | #ifndef PerlIO_eof |
27da23d5 | 236 | PERL_EXPORT_C int PerlIO_eof(PerlIO *); |
76ced9ad NIS |
237 | #endif |
238 | #ifndef PerlIO_error | |
27da23d5 | 239 | PERL_EXPORT_C int PerlIO_error(PerlIO *); |
76ced9ad NIS |
240 | #endif |
241 | #ifndef PerlIO_clearerr | |
27da23d5 | 242 | PERL_EXPORT_C void PerlIO_clearerr(PerlIO *); |
76ced9ad NIS |
243 | #endif |
244 | #ifndef PerlIO_getc | |
27da23d5 | 245 | PERL_EXPORT_C int PerlIO_getc(PerlIO *); |
76ced9ad NIS |
246 | #endif |
247 | #ifndef PerlIO_putc | |
27da23d5 | 248 | PERL_EXPORT_C int PerlIO_putc(PerlIO *, int); |
76ced9ad | 249 | #endif |
76ced9ad | 250 | #ifndef PerlIO_ungetc |
27da23d5 | 251 | PERL_EXPORT_C int PerlIO_ungetc(PerlIO *, int); |
76ced9ad | 252 | #endif |
76ced9ad | 253 | #ifndef PerlIO_fdopen |
27da23d5 | 254 | PERL_EXPORT_C PerlIO *PerlIO_fdopen(int, const char *); |
76ced9ad NIS |
255 | #endif |
256 | #ifndef PerlIO_importFILE | |
27da23d5 | 257 | PERL_EXPORT_C PerlIO *PerlIO_importFILE(FILE *, const char *); |
76ced9ad NIS |
258 | #endif |
259 | #ifndef PerlIO_exportFILE | |
27da23d5 | 260 | PERL_EXPORT_C FILE *PerlIO_exportFILE(PerlIO *, const char *); |
76ced9ad NIS |
261 | #endif |
262 | #ifndef PerlIO_findFILE | |
27da23d5 | 263 | PERL_EXPORT_C FILE *PerlIO_findFILE(PerlIO *); |
76ced9ad NIS |
264 | #endif |
265 | #ifndef PerlIO_releaseFILE | |
27da23d5 | 266 | PERL_EXPORT_C void PerlIO_releaseFILE(PerlIO *, FILE *); |
76ced9ad NIS |
267 | #endif |
268 | #ifndef PerlIO_read | |
27da23d5 | 269 | PERL_EXPORT_C SSize_t PerlIO_read(PerlIO *, void *, Size_t); |
76ced9ad | 270 | #endif |
a15cef0c | 271 | #ifndef PerlIO_unread |
27da23d5 | 272 | PERL_EXPORT_C SSize_t PerlIO_unread(PerlIO *, const void *, Size_t); |
a15cef0c | 273 | #endif |
76ced9ad | 274 | #ifndef PerlIO_write |
27da23d5 | 275 | PERL_EXPORT_C SSize_t PerlIO_write(PerlIO *, const void *, Size_t); |
76ced9ad NIS |
276 | #endif |
277 | #ifndef PerlIO_setlinebuf | |
27da23d5 | 278 | PERL_EXPORT_C void PerlIO_setlinebuf(PerlIO *); |
76ced9ad NIS |
279 | #endif |
280 | #ifndef PerlIO_printf | |
27da23d5 | 281 | PERL_EXPORT_C int PerlIO_printf(PerlIO *, const char *, ...) |
287c8091 | 282 | __attribute__format__(__printf__, 2, 3); |
76ced9ad NIS |
283 | #endif |
284 | #ifndef PerlIO_sprintf | |
27da23d5 | 285 | PERL_EXPORT_C int PerlIO_sprintf(char *, int, const char *, ...) |
287c8091 | 286 | __attribute__format__(__printf__, 3, 4); |
76ced9ad NIS |
287 | #endif |
288 | #ifndef PerlIO_vprintf | |
27da23d5 | 289 | PERL_EXPORT_C int PerlIO_vprintf(PerlIO *, const char *, va_list); |
76ced9ad NIS |
290 | #endif |
291 | #ifndef PerlIO_tell | |
27da23d5 | 292 | PERL_EXPORT_C Off_t PerlIO_tell(PerlIO *); |
76ced9ad NIS |
293 | #endif |
294 | #ifndef PerlIO_seek | |
27da23d5 | 295 | PERL_EXPORT_C int PerlIO_seek(PerlIO *, Off_t, int); |
76ced9ad NIS |
296 | #endif |
297 | #ifndef PerlIO_rewind | |
27da23d5 | 298 | PERL_EXPORT_C void PerlIO_rewind(PerlIO *); |
76ced9ad NIS |
299 | #endif |
300 | #ifndef PerlIO_has_base | |
27da23d5 | 301 | PERL_EXPORT_C int PerlIO_has_base(PerlIO *); |
76ced9ad NIS |
302 | #endif |
303 | #ifndef PerlIO_has_cntptr | |
27da23d5 | 304 | PERL_EXPORT_C int PerlIO_has_cntptr(PerlIO *); |
76ced9ad NIS |
305 | #endif |
306 | #ifndef PerlIO_fast_gets | |
27da23d5 | 307 | PERL_EXPORT_C int PerlIO_fast_gets(PerlIO *); |
76ced9ad NIS |
308 | #endif |
309 | #ifndef PerlIO_canset_cnt | |
27da23d5 | 310 | PERL_EXPORT_C int PerlIO_canset_cnt(PerlIO *); |
76ced9ad NIS |
311 | #endif |
312 | #ifndef PerlIO_get_ptr | |
27da23d5 | 313 | PERL_EXPORT_C STDCHAR *PerlIO_get_ptr(PerlIO *); |
76ced9ad NIS |
314 | #endif |
315 | #ifndef PerlIO_get_cnt | |
27da23d5 | 316 | PERL_EXPORT_C int PerlIO_get_cnt(PerlIO *); |
76ced9ad NIS |
317 | #endif |
318 | #ifndef PerlIO_set_cnt | |
27da23d5 | 319 | PERL_EXPORT_C void PerlIO_set_cnt(PerlIO *, int); |
76ced9ad NIS |
320 | #endif |
321 | #ifndef PerlIO_set_ptrcnt | |
27da23d5 | 322 | PERL_EXPORT_C void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, int); |
76ced9ad NIS |
323 | #endif |
324 | #ifndef PerlIO_get_base | |
27da23d5 | 325 | PERL_EXPORT_C STDCHAR *PerlIO_get_base(PerlIO *); |
76ced9ad NIS |
326 | #endif |
327 | #ifndef PerlIO_get_bufsiz | |
27da23d5 | 328 | PERL_EXPORT_C int PerlIO_get_bufsiz(PerlIO *); |
76ced9ad NIS |
329 | #endif |
330 | #ifndef PerlIO_tmpfile | |
27da23d5 | 331 | PERL_EXPORT_C PerlIO *PerlIO_tmpfile(void); |
76ced9ad NIS |
332 | #endif |
333 | #ifndef PerlIO_stdin | |
27da23d5 | 334 | PERL_EXPORT_C PerlIO *PerlIO_stdin(void); |
76ced9ad NIS |
335 | #endif |
336 | #ifndef PerlIO_stdout | |
27da23d5 | 337 | PERL_EXPORT_C PerlIO *PerlIO_stdout(void); |
76ced9ad NIS |
338 | #endif |
339 | #ifndef PerlIO_stderr | |
27da23d5 | 340 | PERL_EXPORT_C PerlIO *PerlIO_stderr(void); |
76ced9ad NIS |
341 | #endif |
342 | #ifndef PerlIO_getpos | |
27da23d5 | 343 | PERL_EXPORT_C int PerlIO_getpos(PerlIO *, SV *); |
76ced9ad NIS |
344 | #endif |
345 | #ifndef PerlIO_setpos | |
27da23d5 | 346 | PERL_EXPORT_C int PerlIO_setpos(PerlIO *, SV *); |
76ced9ad NIS |
347 | #endif |
348 | #ifndef PerlIO_fdupopen | |
27da23d5 | 349 | PERL_EXPORT_C PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *, int); |
5f1a76d0 | 350 | #endif |
11ae941d | 351 | #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO) |
27da23d5 | 352 | PERL_EXPORT_C char *PerlIO_modestr(PerlIO *, char *buf); |
76ced9ad NIS |
353 | #endif |
354 | #ifndef PerlIO_isutf8 | |
27da23d5 | 355 | PERL_EXPORT_C int PerlIO_isutf8(PerlIO *); |
76ced9ad | 356 | #endif |
156e9b51 | 357 | #ifndef PerlIO_apply_layers |
27da23d5 JH |
358 | PERL_EXPORT_C int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, |
359 | const char *names); | |
60382766 NIS |
360 | #endif |
361 | #ifndef PerlIO_binmode | |
27da23d5 JH |
362 | PERL_EXPORT_C int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode, |
363 | const char *names); | |
ac27b0f5 | 364 | #endif |
a15cef0c | 365 | #ifndef PerlIO_getname |
27da23d5 | 366 | PERL_EXPORT_C char *PerlIO_getname(PerlIO *, char *); |
a15cef0c | 367 | #endif |
76ced9ad | 368 | |
27da23d5 | 369 | PERL_EXPORT_C void PerlIO_destruct(pTHX); |
13621cfb | 370 | |
27da23d5 | 371 | PERL_EXPORT_C int PerlIO_intmode2str(int rawmode, char *mode, int *writing); |
06c7082d | 372 | |
3a1ee7e8 | 373 | #ifdef PERLIO_LAYERS |
27da23d5 | 374 | PERL_EXPORT_C void PerlIO_cleanup(pTHX); |
adb71456 | 375 | |
de009b76 AL |
376 | PERL_EXPORT_C void PerlIO_debug(const char *fmt, ...) |
377 | __attribute__format__(__printf__, 1, 2); | |
3a1ee7e8 NIS |
378 | typedef struct PerlIO_list_s PerlIO_list_t; |
379 | ||
88b61e10 | 380 | |
11ae941d CB |
381 | #endif |
382 | ||
adb71456 | 383 | END_EXTERN_C |
14a5cf38 | 384 | #endif /* _PERLIO_H */ |