Commit | Line | Data |
---|---|---|
eb1102fc NIS |
1 | /* perlio.h |
2 | * | |
4bb101f2 JH |
3 | * Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003, |
4 | * 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. | |
15 | There is a hierachy of Configure determined #define controls: | |
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 | |
14a5cf38 JH |
105 | extern void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab); |
106 | extern PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name, STRLEN len, | |
107 | int load); | |
108 | extern PerlIO *PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab, | |
109 | const char *mode, SV *arg); | |
110 | extern void PerlIO_pop(pTHX_ PerlIO *f); | |
39f7a870 | 111 | extern AV* PerlIO_get_layers(pTHX_ PerlIO *f); |
3a1ee7e8 | 112 | extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param); |
76ced9ad | 113 | |
14a5cf38 | 114 | #endif /* PerlIO */ |
76ced9ad NIS |
115 | |
116 | /* ----------- End of implementation choices ---------- */ | |
117 | ||
118 | #ifndef PERLIO_IS_STDIO | |
119 | /* Not using stdio _directly_ as PerlIO */ | |
120 | ||
121 | /* We now need to determine what happens if source trys to use stdio. | |
122 | * There are three cases based on PERLIO_NOT_STDIO which XS code | |
123 | * can set how it wants. | |
124 | */ | |
125 | ||
126 | #ifdef PERL_CORE | |
127 | /* Make a choice for perl core code | |
128 | - currently this is set to try and catch lingering raw stdio calls. | |
129 | This is a known issue with some non UNIX ports which still use | |
130 | "native" stdio features. | |
131 | */ | |
132 | #ifndef PERLIO_NOT_STDIO | |
133 | #define PERLIO_NOT_STDIO 1 | |
134 | #endif | |
f7e7eb72 NIS |
135 | #else |
136 | #ifndef PERLIO_NOT_STDIO | |
137 | #define PERLIO_NOT_STDIO 0 | |
138 | #endif | |
76ced9ad NIS |
139 | #endif |
140 | ||
141 | #ifdef PERLIO_NOT_STDIO | |
142 | #if PERLIO_NOT_STDIO | |
143 | /* | |
144 | * PERLIO_NOT_STDIO #define'd as 1 | |
145 | * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors | |
146 | */ | |
147 | #include "nostdio.h" | |
14a5cf38 | 148 | #else /* if PERLIO_NOT_STDIO */ |
76ced9ad NIS |
149 | /* |
150 | * PERLIO_NOT_STDIO #define'd as 0 | |
151 | * Case 2: Declares that both PerlIO and stdio can be used | |
152 | */ | |
14a5cf38 JH |
153 | #endif /* if PERLIO_NOT_STDIO */ |
154 | #else /* ifdef PERLIO_NOT_STDIO */ | |
76ced9ad NIS |
155 | /* |
156 | * PERLIO_NOT_STDIO not defined | |
157 | * Case 3: Try and fake stdio calls as PerlIO calls | |
158 | */ | |
159 | #include "fakesdio.h" | |
14a5cf38 JH |
160 | #endif /* ifndef PERLIO_NOT_STDIO */ |
161 | #endif /* PERLIO_IS_STDIO */ | |
76ced9ad | 162 | |
b47b7e59 | 163 | #define specialCopIO(sv) ((sv) == Nullsv) |
ac27b0f5 | 164 | |
76ced9ad NIS |
165 | /* ----------- fill in things that have not got #define'd ---------- */ |
166 | ||
167 | #ifndef Fpos_t | |
168 | #define Fpos_t Off_t | |
169 | #endif | |
170 | ||
171 | #ifndef EOF | |
172 | #define EOF (-1) | |
173 | #endif | |
174 | ||
175 | /* This is to catch case with no stdio */ | |
176 | #ifndef BUFSIZ | |
177 | #define BUFSIZ 1024 | |
178 | #endif | |
179 | ||
180 | #ifndef SEEK_SET | |
181 | #define SEEK_SET 0 | |
182 | #endif | |
183 | ||
184 | #ifndef SEEK_CUR | |
185 | #define SEEK_CUR 1 | |
186 | #endif | |
187 | ||
188 | #ifndef SEEK_END | |
189 | #define SEEK_END 2 | |
190 | #endif | |
191 | ||
ecdeb87c NIS |
192 | #define PERLIO_DUP_CLONE 1 |
193 | #define PERLIO_DUP_FD 2 | |
194 | ||
76ced9ad NIS |
195 | /* --------------------- Now prototypes for functions --------------- */ |
196 | ||
adb71456 | 197 | START_EXTERN_C |
76ced9ad | 198 | #ifndef NEXT30_NO_ATTRIBUTE |
14a5cf38 JH |
199 | #ifndef HASATTRIBUTE /* disable GNU-cc attribute checking? */ |
200 | #ifdef __attribute__ /* Avoid possible redefinition errors */ | |
76ced9ad NIS |
201 | #undef __attribute__ |
202 | #endif | |
203 | #define __attribute__(attr) | |
204 | #endif | |
205 | #endif | |
76ced9ad | 206 | #ifndef PerlIO_init |
3a1ee7e8 | 207 | extern void PerlIO_init(pTHX); |
76ced9ad NIS |
208 | #endif |
209 | #ifndef PerlIO_stdoutf | |
14a5cf38 | 210 | extern int PerlIO_stdoutf(const char *, ...) |
1e56004e RB |
211 | #ifdef CHECK_FORMAT |
212 | __attribute__ ((__format__(__printf__, 1, 2))) | |
213 | #endif | |
214 | ; | |
76ced9ad NIS |
215 | #endif |
216 | #ifndef PerlIO_puts | |
14a5cf38 | 217 | extern int PerlIO_puts(PerlIO *, const char *); |
76ced9ad NIS |
218 | #endif |
219 | #ifndef PerlIO_open | |
14a5cf38 | 220 | extern PerlIO *PerlIO_open(const char *, const char *); |
76ced9ad | 221 | #endif |
6e60e805 | 222 | #ifndef PerlIO_openn |
14a5cf38 JH |
223 | extern PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode, |
224 | int fd, int imode, int perm, PerlIO *old, | |
225 | int narg, SV **arg); | |
ee518936 | 226 | #endif |
76ced9ad | 227 | #ifndef PerlIO_eof |
14a5cf38 | 228 | extern int PerlIO_eof(PerlIO *); |
76ced9ad NIS |
229 | #endif |
230 | #ifndef PerlIO_error | |
14a5cf38 | 231 | extern int PerlIO_error(PerlIO *); |
76ced9ad NIS |
232 | #endif |
233 | #ifndef PerlIO_clearerr | |
14a5cf38 | 234 | extern void PerlIO_clearerr(PerlIO *); |
76ced9ad NIS |
235 | #endif |
236 | #ifndef PerlIO_getc | |
14a5cf38 | 237 | extern int PerlIO_getc(PerlIO *); |
76ced9ad NIS |
238 | #endif |
239 | #ifndef PerlIO_putc | |
14a5cf38 | 240 | extern int PerlIO_putc(PerlIO *, int); |
76ced9ad | 241 | #endif |
76ced9ad | 242 | #ifndef PerlIO_ungetc |
14a5cf38 | 243 | extern int PerlIO_ungetc(PerlIO *, int); |
76ced9ad | 244 | #endif |
76ced9ad | 245 | #ifndef PerlIO_fdopen |
14a5cf38 | 246 | extern PerlIO *PerlIO_fdopen(int, const char *); |
76ced9ad NIS |
247 | #endif |
248 | #ifndef PerlIO_importFILE | |
4b069b44 | 249 | extern PerlIO *PerlIO_importFILE(FILE *, const char *); |
76ced9ad NIS |
250 | #endif |
251 | #ifndef PerlIO_exportFILE | |
4b069b44 | 252 | extern FILE *PerlIO_exportFILE(PerlIO *, const char *); |
76ced9ad NIS |
253 | #endif |
254 | #ifndef PerlIO_findFILE | |
14a5cf38 | 255 | extern FILE *PerlIO_findFILE(PerlIO *); |
76ced9ad NIS |
256 | #endif |
257 | #ifndef PerlIO_releaseFILE | |
14a5cf38 | 258 | extern void PerlIO_releaseFILE(PerlIO *, FILE *); |
76ced9ad NIS |
259 | #endif |
260 | #ifndef PerlIO_read | |
14a5cf38 | 261 | extern SSize_t PerlIO_read(PerlIO *, void *, Size_t); |
76ced9ad | 262 | #endif |
a15cef0c | 263 | #ifndef PerlIO_unread |
14a5cf38 | 264 | extern SSize_t PerlIO_unread(PerlIO *, const void *, Size_t); |
a15cef0c | 265 | #endif |
76ced9ad | 266 | #ifndef PerlIO_write |
14a5cf38 | 267 | extern SSize_t PerlIO_write(PerlIO *, const void *, Size_t); |
76ced9ad NIS |
268 | #endif |
269 | #ifndef PerlIO_setlinebuf | |
14a5cf38 | 270 | extern void PerlIO_setlinebuf(PerlIO *); |
76ced9ad NIS |
271 | #endif |
272 | #ifndef PerlIO_printf | |
14a5cf38 | 273 | extern int PerlIO_printf(PerlIO *, const char *, ...) |
1e56004e RB |
274 | #ifdef CHECK_FORMAT |
275 | __attribute__ ((__format__(__printf__, 2, 3))) | |
276 | #endif | |
277 | ; | |
76ced9ad NIS |
278 | #endif |
279 | #ifndef PerlIO_sprintf | |
14a5cf38 | 280 | extern int PerlIO_sprintf(char *, int, const char *, ...) |
1e56004e RB |
281 | #ifdef CHECK_FORMAT |
282 | __attribute__ ((__format__(__printf__, 3, 4))) | |
283 | #endif | |
284 | ; | |
76ced9ad NIS |
285 | #endif |
286 | #ifndef PerlIO_vprintf | |
14a5cf38 | 287 | extern int PerlIO_vprintf(PerlIO *, const char *, va_list); |
76ced9ad NIS |
288 | #endif |
289 | #ifndef PerlIO_tell | |
14a5cf38 | 290 | extern Off_t PerlIO_tell(PerlIO *); |
76ced9ad NIS |
291 | #endif |
292 | #ifndef PerlIO_seek | |
14a5cf38 | 293 | extern int PerlIO_seek(PerlIO *, Off_t, int); |
76ced9ad NIS |
294 | #endif |
295 | #ifndef PerlIO_rewind | |
14a5cf38 | 296 | extern void PerlIO_rewind(PerlIO *); |
76ced9ad NIS |
297 | #endif |
298 | #ifndef PerlIO_has_base | |
14a5cf38 | 299 | extern int PerlIO_has_base(PerlIO *); |
76ced9ad NIS |
300 | #endif |
301 | #ifndef PerlIO_has_cntptr | |
14a5cf38 | 302 | extern int PerlIO_has_cntptr(PerlIO *); |
76ced9ad NIS |
303 | #endif |
304 | #ifndef PerlIO_fast_gets | |
14a5cf38 | 305 | extern int PerlIO_fast_gets(PerlIO *); |
76ced9ad NIS |
306 | #endif |
307 | #ifndef PerlIO_canset_cnt | |
14a5cf38 | 308 | extern int PerlIO_canset_cnt(PerlIO *); |
76ced9ad NIS |
309 | #endif |
310 | #ifndef PerlIO_get_ptr | |
14a5cf38 | 311 | extern STDCHAR *PerlIO_get_ptr(PerlIO *); |
76ced9ad NIS |
312 | #endif |
313 | #ifndef PerlIO_get_cnt | |
14a5cf38 | 314 | extern int PerlIO_get_cnt(PerlIO *); |
76ced9ad NIS |
315 | #endif |
316 | #ifndef PerlIO_set_cnt | |
14a5cf38 | 317 | extern void PerlIO_set_cnt(PerlIO *, int); |
76ced9ad NIS |
318 | #endif |
319 | #ifndef PerlIO_set_ptrcnt | |
14a5cf38 | 320 | extern void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, int); |
76ced9ad NIS |
321 | #endif |
322 | #ifndef PerlIO_get_base | |
14a5cf38 | 323 | extern STDCHAR *PerlIO_get_base(PerlIO *); |
76ced9ad NIS |
324 | #endif |
325 | #ifndef PerlIO_get_bufsiz | |
14a5cf38 | 326 | extern int PerlIO_get_bufsiz(PerlIO *); |
76ced9ad NIS |
327 | #endif |
328 | #ifndef PerlIO_tmpfile | |
14a5cf38 | 329 | extern PerlIO *PerlIO_tmpfile(void); |
76ced9ad NIS |
330 | #endif |
331 | #ifndef PerlIO_stdin | |
14a5cf38 | 332 | extern PerlIO *PerlIO_stdin(void); |
76ced9ad NIS |
333 | #endif |
334 | #ifndef PerlIO_stdout | |
14a5cf38 | 335 | extern PerlIO *PerlIO_stdout(void); |
76ced9ad NIS |
336 | #endif |
337 | #ifndef PerlIO_stderr | |
14a5cf38 | 338 | extern PerlIO *PerlIO_stderr(void); |
76ced9ad NIS |
339 | #endif |
340 | #ifndef PerlIO_getpos | |
14a5cf38 | 341 | extern int PerlIO_getpos(PerlIO *, SV *); |
76ced9ad NIS |
342 | #endif |
343 | #ifndef PerlIO_setpos | |
14a5cf38 | 344 | extern int PerlIO_setpos(PerlIO *, SV *); |
76ced9ad NIS |
345 | #endif |
346 | #ifndef PerlIO_fdupopen | |
ecdeb87c | 347 | extern PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *, int); |
5f1a76d0 | 348 | #endif |
11ae941d | 349 | #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO) |
14a5cf38 | 350 | extern char *PerlIO_modestr(PerlIO *, char *buf); |
76ced9ad NIS |
351 | #endif |
352 | #ifndef PerlIO_isutf8 | |
14a5cf38 | 353 | extern int PerlIO_isutf8(PerlIO *); |
76ced9ad | 354 | #endif |
156e9b51 | 355 | #ifndef PerlIO_apply_layers |
14a5cf38 JH |
356 | extern int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, |
357 | const char *names); | |
60382766 NIS |
358 | #endif |
359 | #ifndef PerlIO_binmode | |
14a5cf38 JH |
360 | extern int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode, |
361 | const char *names); | |
ac27b0f5 | 362 | #endif |
a15cef0c | 363 | #ifndef PerlIO_getname |
14a5cf38 | 364 | extern char *PerlIO_getname(PerlIO *, char *); |
a15cef0c | 365 | #endif |
76ced9ad | 366 | |
13621cfb NIS |
367 | extern void PerlIO_destruct(pTHX); |
368 | ||
06c7082d NIS |
369 | extern int PerlIO_intmode2str(int rawmode, char *mode, int *writing); |
370 | ||
3a1ee7e8 NIS |
371 | #ifdef PERLIO_LAYERS |
372 | extern void PerlIO_cleanup(pTHX); | |
adb71456 | 373 | |
14a5cf38 | 374 | extern void PerlIO_debug(const char *fmt, ...); |
3a1ee7e8 NIS |
375 | typedef struct PerlIO_list_s PerlIO_list_t; |
376 | ||
88b61e10 | 377 | |
11ae941d CB |
378 | #endif |
379 | ||
adb71456 | 380 | END_EXTERN_C |
14a5cf38 | 381 | #endif /* _PERLIO_H */ |