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