3 * Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003,
4 * by Larry Wall and others
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.
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.
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.
25 then there are two modes determined by USE_SFIO:
27 USE_SFIO - If set causes PerlIO_xxx() to be #define-d onto sfio functions.
28 A backward compatability mode for some specialist applications.
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.
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.
41 #if defined(PERL_IMPLICIT_SYS)
44 /* # define USE_PERLIO */
54 # ifndef PERLIO_IS_STDIO
55 # define PERLIO_IS_STDIO
59 /* -------------------- End of Configure controls ---------------------------- */
62 * Although we may not want stdio to be used including <stdio.h> here
63 * avoids issues where stdio.h has strange side effects
68 int fseeko(FILE *stream, off_t offset, int whence);
69 off_t ftello(FILE *stream);
72 #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64)
76 #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64)
80 /* BS2000 includes are sometimes a bit non standard :-( */
81 #if defined(POSIX_BC) && defined(O_BINARY) && !defined(O_TEXT)
85 #ifdef PERLIO_IS_STDIO
86 /* #define PerlIO_xxxx() as equivalent stdio function */
88 #else /* PERLIO_IS_STDIO */
90 /* #define PerlIO_xxxx() as equivalent sfio function */
93 #endif /* PERLIO_IS_STDIO */
96 /* ----------- PerlIO implementation ---------- */
97 /* PerlIO not #define-d to something else - define the implementation */
99 typedef struct _PerlIO PerlIOl;
100 typedef struct _PerlIO_funcs PerlIO_funcs;
101 typedef PerlIOl *PerlIO;
102 #define PerlIO PerlIO
103 #define PERLIO_LAYERS 1
105 extern void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab);
106 extern PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name, STRLEN len,
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);
111 extern AV* PerlIO_get_layers(pTHX_ PerlIO *f);
112 extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param);
116 /* ----------- End of implementation choices ---------- */
118 #ifndef PERLIO_IS_STDIO
119 /* Not using stdio _directly_ as PerlIO */
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.
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.
132 #ifndef PERLIO_NOT_STDIO
133 #define PERLIO_NOT_STDIO 1
136 #ifndef PERLIO_NOT_STDIO
137 #define PERLIO_NOT_STDIO 0
141 #ifdef PERLIO_NOT_STDIO
144 * PERLIO_NOT_STDIO #define'd as 1
145 * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
148 #else /* if PERLIO_NOT_STDIO */
150 * PERLIO_NOT_STDIO #define'd as 0
151 * Case 2: Declares that both PerlIO and stdio can be used
153 #endif /* if PERLIO_NOT_STDIO */
154 #else /* ifdef PERLIO_NOT_STDIO */
156 * PERLIO_NOT_STDIO not defined
157 * Case 3: Try and fake stdio calls as PerlIO calls
159 #include "fakesdio.h"
160 #endif /* ifndef PERLIO_NOT_STDIO */
161 #endif /* PERLIO_IS_STDIO */
163 #define specialCopIO(sv) ((sv) == Nullsv)
165 /* ----------- fill in things that have not got #define'd ---------- */
175 /* This is to catch case with no stdio */
192 #define PERLIO_DUP_CLONE 1
193 #define PERLIO_DUP_FD 2
195 /* --------------------- Now prototypes for functions --------------- */
198 #ifndef NEXT30_NO_ATTRIBUTE
199 #ifndef HASATTRIBUTE /* disable GNU-cc attribute checking? */
200 #ifdef __attribute__ /* Avoid possible redefinition errors */
203 #define __attribute__(attr)
207 extern void PerlIO_init(pTHX);
209 #ifndef PerlIO_stdoutf
210 extern int PerlIO_stdoutf(const char *, ...)
212 __attribute__ ((__format__(__printf__, 1, 2)))
217 extern int PerlIO_puts(PerlIO *, const char *);
220 extern PerlIO *PerlIO_open(const char *, const char *);
223 extern PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode,
224 int fd, int imode, int perm, PerlIO *old,
228 extern int PerlIO_eof(PerlIO *);
231 extern int PerlIO_error(PerlIO *);
233 #ifndef PerlIO_clearerr
234 extern void PerlIO_clearerr(PerlIO *);
237 extern int PerlIO_getc(PerlIO *);
240 extern int PerlIO_putc(PerlIO *, int);
242 #ifndef PerlIO_ungetc
243 extern int PerlIO_ungetc(PerlIO *, int);
245 #ifndef PerlIO_fdopen
246 extern PerlIO *PerlIO_fdopen(int, const char *);
248 #ifndef PerlIO_importFILE
249 extern PerlIO *PerlIO_importFILE(FILE *, const char *);
251 #ifndef PerlIO_exportFILE
252 extern FILE *PerlIO_exportFILE(PerlIO *, const char *);
254 #ifndef PerlIO_findFILE
255 extern FILE *PerlIO_findFILE(PerlIO *);
257 #ifndef PerlIO_releaseFILE
258 extern void PerlIO_releaseFILE(PerlIO *, FILE *);
261 extern SSize_t PerlIO_read(PerlIO *, void *, Size_t);
263 #ifndef PerlIO_unread
264 extern SSize_t PerlIO_unread(PerlIO *, const void *, Size_t);
267 extern SSize_t PerlIO_write(PerlIO *, const void *, Size_t);
269 #ifndef PerlIO_setlinebuf
270 extern void PerlIO_setlinebuf(PerlIO *);
272 #ifndef PerlIO_printf
273 extern int PerlIO_printf(PerlIO *, const char *, ...)
275 __attribute__ ((__format__(__printf__, 2, 3)))
279 #ifndef PerlIO_sprintf
280 extern int PerlIO_sprintf(char *, int, const char *, ...)
282 __attribute__ ((__format__(__printf__, 3, 4)))
286 #ifndef PerlIO_vprintf
287 extern int PerlIO_vprintf(PerlIO *, const char *, va_list);
290 extern Off_t PerlIO_tell(PerlIO *);
293 extern int PerlIO_seek(PerlIO *, Off_t, int);
295 #ifndef PerlIO_rewind
296 extern void PerlIO_rewind(PerlIO *);
298 #ifndef PerlIO_has_base
299 extern int PerlIO_has_base(PerlIO *);
301 #ifndef PerlIO_has_cntptr
302 extern int PerlIO_has_cntptr(PerlIO *);
304 #ifndef PerlIO_fast_gets
305 extern int PerlIO_fast_gets(PerlIO *);
307 #ifndef PerlIO_canset_cnt
308 extern int PerlIO_canset_cnt(PerlIO *);
310 #ifndef PerlIO_get_ptr
311 extern STDCHAR *PerlIO_get_ptr(PerlIO *);
313 #ifndef PerlIO_get_cnt
314 extern int PerlIO_get_cnt(PerlIO *);
316 #ifndef PerlIO_set_cnt
317 extern void PerlIO_set_cnt(PerlIO *, int);
319 #ifndef PerlIO_set_ptrcnt
320 extern void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, int);
322 #ifndef PerlIO_get_base
323 extern STDCHAR *PerlIO_get_base(PerlIO *);
325 #ifndef PerlIO_get_bufsiz
326 extern int PerlIO_get_bufsiz(PerlIO *);
328 #ifndef PerlIO_tmpfile
329 extern PerlIO *PerlIO_tmpfile(void);
332 extern PerlIO *PerlIO_stdin(void);
334 #ifndef PerlIO_stdout
335 extern PerlIO *PerlIO_stdout(void);
337 #ifndef PerlIO_stderr
338 extern PerlIO *PerlIO_stderr(void);
340 #ifndef PerlIO_getpos
341 extern int PerlIO_getpos(PerlIO *, SV *);
343 #ifndef PerlIO_setpos
344 extern int PerlIO_setpos(PerlIO *, SV *);
346 #ifndef PerlIO_fdupopen
347 extern PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *, int);
349 #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO)
350 extern char *PerlIO_modestr(PerlIO *, char *buf);
352 #ifndef PerlIO_isutf8
353 extern int PerlIO_isutf8(PerlIO *);
355 #ifndef PerlIO_apply_layers
356 extern int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode,
359 #ifndef PerlIO_binmode
360 extern int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode,
363 #ifndef PerlIO_getname
364 extern char *PerlIO_getname(PerlIO *, char *);
367 extern void PerlIO_destruct(pTHX);
369 extern int PerlIO_intmode2str(int rawmode, char *mode, int *writing);
372 extern void PerlIO_cleanup(pTHX);
374 extern void PerlIO_debug(const char *fmt, ...);
375 typedef struct PerlIO_list_s PerlIO_list_t;
381 #endif /* _PERLIO_H */