3 * Copyright (C) 1996, 1997, 1999, 2000, 2001, 2002, 2003,
4 * 2004, 2005, 2006, 2007, 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 hierarchy 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 compatibility 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
67 #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64)
71 #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64)
75 /* BS2000 includes are sometimes a bit non standard :-( */
76 #if defined(POSIX_BC) && defined(O_BINARY) && !defined(O_TEXT)
80 #ifdef PERLIO_IS_STDIO
81 /* #define PerlIO_xxxx() as equivalent stdio function */
83 #else /* PERLIO_IS_STDIO */
85 /* #define PerlIO_xxxx() as equivalent sfio function */
88 #endif /* PERLIO_IS_STDIO */
91 /* ----------- PerlIO implementation ---------- */
92 /* PerlIO not #define-d to something else - define the implementation */
94 typedef struct _PerlIO PerlIOl;
95 typedef struct _PerlIO_funcs PerlIO_funcs;
96 typedef PerlIOl *PerlIO;
98 #define PERLIO_LAYERS 1
100 /* Making the big PerlIO_funcs vtables const is good (enables placing
101 * them in the const section which is good for speed, security, and
102 * embeddability) but this cannot be done by default because of
103 * backward compatibility. */
104 #ifdef PERLIO_FUNCS_CONST
105 #define PERLIO_FUNCS_DECL(funcs) const PerlIO_funcs funcs
106 #define PERLIO_FUNCS_CAST(funcs) (PerlIO_funcs*)(funcs)
108 #define PERLIO_FUNCS_DECL(funcs) PerlIO_funcs funcs
109 #define PERLIO_FUNCS_CAST(funcs) (funcs)
112 PERL_EXPORT_C void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab);
113 PERL_EXPORT_C PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name,
116 PERL_EXPORT_C PerlIO *PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab),
117 const char *mode, SV *arg);
118 PERL_EXPORT_C void PerlIO_pop(pTHX_ PerlIO *f);
119 PERL_EXPORT_C AV* PerlIO_get_layers(pTHX_ PerlIO *f);
120 PERL_EXPORT_C void PerlIO_clone(pTHX_ PerlInterpreter *proto,
121 CLONE_PARAMS *param);
125 /* ----------- End of implementation choices ---------- */
127 #ifndef PERLIO_IS_STDIO
128 /* Not using stdio _directly_ as PerlIO */
130 /* We now need to determine what happens if source trys to use stdio.
131 * There are three cases based on PERLIO_NOT_STDIO which XS code
132 * can set how it wants.
136 /* Make a choice for perl core code
137 - currently this is set to try and catch lingering raw stdio calls.
138 This is a known issue with some non UNIX ports which still use
139 "native" stdio features.
141 #ifndef PERLIO_NOT_STDIO
142 #define PERLIO_NOT_STDIO 1
145 #ifndef PERLIO_NOT_STDIO
146 #define PERLIO_NOT_STDIO 0
150 #ifdef PERLIO_NOT_STDIO
153 * PERLIO_NOT_STDIO #define'd as 1
154 * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
157 #else /* if PERLIO_NOT_STDIO */
159 * PERLIO_NOT_STDIO #define'd as 0
160 * Case 2: Declares that both PerlIO and stdio can be used
162 #endif /* if PERLIO_NOT_STDIO */
163 #else /* ifdef PERLIO_NOT_STDIO */
165 * PERLIO_NOT_STDIO not defined
166 * Case 3: Try and fake stdio calls as PerlIO calls
168 #include "fakesdio.h"
169 #endif /* ifndef PERLIO_NOT_STDIO */
170 #endif /* PERLIO_IS_STDIO */
172 /* ----------- fill in things that have not got #define'd ---------- */
182 /* This is to catch case with no stdio */
187 /* The default buffer size for the perlio buffering layer */
188 #ifndef PERLIOBUF_DEFAULT_BUFSIZ
189 #define PERLIOBUF_DEFAULT_BUFSIZ (BUFSIZ > 8192 ? BUFSIZ : 8192)
204 #define PERLIO_DUP_CLONE 1
205 #define PERLIO_DUP_FD 2
207 /* --------------------- Now prototypes for functions --------------- */
210 #ifndef __attribute__format__
211 # ifdef HASATTRIBUTE_FORMAT
212 # define __attribute__format__(x,y,z) __attribute__((format(x,y,z)))
214 # define __attribute__format__(x,y,z)
218 PERL_EXPORT_C void PerlIO_init(pTHX);
220 #ifndef PerlIO_stdoutf
221 PERL_EXPORT_C int PerlIO_stdoutf(const char *, ...)
222 __attribute__format__(__printf__, 1, 2);
225 PERL_EXPORT_C int PerlIO_puts(PerlIO *, const char *);
228 PERL_EXPORT_C PerlIO *PerlIO_open(const char *, const char *);
231 PERL_EXPORT_C PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode,
232 int fd, int imode, int perm, PerlIO *old,
236 PERL_EXPORT_C int PerlIO_eof(PerlIO *);
239 PERL_EXPORT_C int PerlIO_error(PerlIO *);
241 #ifndef PerlIO_clearerr
242 PERL_EXPORT_C void PerlIO_clearerr(PerlIO *);
245 PERL_EXPORT_C int PerlIO_getc(PerlIO *);
248 PERL_EXPORT_C int PerlIO_putc(PerlIO *, int);
250 #ifndef PerlIO_ungetc
251 PERL_EXPORT_C int PerlIO_ungetc(PerlIO *, int);
253 #ifndef PerlIO_fdopen
254 PERL_EXPORT_C PerlIO *PerlIO_fdopen(int, const char *);
256 #ifndef PerlIO_importFILE
257 PERL_EXPORT_C PerlIO *PerlIO_importFILE(FILE *, const char *);
259 #ifndef PerlIO_exportFILE
260 PERL_EXPORT_C FILE *PerlIO_exportFILE(PerlIO *, const char *);
262 #ifndef PerlIO_findFILE
263 PERL_EXPORT_C FILE *PerlIO_findFILE(PerlIO *);
265 #ifndef PerlIO_releaseFILE
266 PERL_EXPORT_C void PerlIO_releaseFILE(PerlIO *, FILE *);
269 PERL_EXPORT_C SSize_t PerlIO_read(PerlIO *, void *, Size_t);
271 #ifndef PerlIO_unread
272 PERL_EXPORT_C SSize_t PerlIO_unread(PerlIO *, const void *, Size_t);
275 PERL_EXPORT_C SSize_t PerlIO_write(PerlIO *, const void *, Size_t);
277 #ifndef PerlIO_setlinebuf
278 PERL_EXPORT_C void PerlIO_setlinebuf(PerlIO *);
280 #ifndef PerlIO_printf
281 PERL_EXPORT_C int PerlIO_printf(PerlIO *, const char *, ...)
282 __attribute__format__(__printf__, 2, 3);
284 #ifndef PerlIO_vprintf
285 PERL_EXPORT_C int PerlIO_vprintf(PerlIO *, const char *, va_list);
288 PERL_EXPORT_C Off_t PerlIO_tell(PerlIO *);
291 PERL_EXPORT_C int PerlIO_seek(PerlIO *, Off_t, int);
293 #ifndef PerlIO_rewind
294 PERL_EXPORT_C void PerlIO_rewind(PerlIO *);
296 #ifndef PerlIO_has_base
297 PERL_EXPORT_C int PerlIO_has_base(PerlIO *);
299 #ifndef PerlIO_has_cntptr
300 PERL_EXPORT_C int PerlIO_has_cntptr(PerlIO *);
302 #ifndef PerlIO_fast_gets
303 PERL_EXPORT_C int PerlIO_fast_gets(PerlIO *);
305 #ifndef PerlIO_canset_cnt
306 PERL_EXPORT_C int PerlIO_canset_cnt(PerlIO *);
308 #ifndef PerlIO_get_ptr
309 PERL_EXPORT_C STDCHAR *PerlIO_get_ptr(PerlIO *);
311 #ifndef PerlIO_get_cnt
312 PERL_EXPORT_C SSize_t PerlIO_get_cnt(PerlIO *);
314 #ifndef PerlIO_set_cnt
315 PERL_EXPORT_C void PerlIO_set_cnt(PerlIO *, SSize_t);
317 #ifndef PerlIO_set_ptrcnt
318 PERL_EXPORT_C void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, SSize_t);
320 #ifndef PerlIO_get_base
321 PERL_EXPORT_C STDCHAR *PerlIO_get_base(PerlIO *);
323 #ifndef PerlIO_get_bufsiz
324 PERL_EXPORT_C SSize_t PerlIO_get_bufsiz(PerlIO *);
326 #ifndef PerlIO_tmpfile
327 PERL_EXPORT_C PerlIO *PerlIO_tmpfile(void);
330 PERL_EXPORT_C PerlIO *PerlIO_stdin(void);
332 #ifndef PerlIO_stdout
333 PERL_EXPORT_C PerlIO *PerlIO_stdout(void);
335 #ifndef PerlIO_stderr
336 PERL_EXPORT_C PerlIO *PerlIO_stderr(void);
338 #ifndef PerlIO_getpos
339 PERL_EXPORT_C int PerlIO_getpos(PerlIO *, SV *);
341 #ifndef PerlIO_setpos
342 PERL_EXPORT_C int PerlIO_setpos(PerlIO *, SV *);
344 #ifndef PerlIO_fdupopen
345 PERL_EXPORT_C PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *, int);
347 #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO)
348 PERL_EXPORT_C char *PerlIO_modestr(PerlIO *, char *buf);
350 #ifndef PerlIO_isutf8
351 PERL_EXPORT_C int PerlIO_isutf8(PerlIO *);
353 #ifndef PerlIO_apply_layers
354 PERL_EXPORT_C int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode,
357 #ifndef PerlIO_binmode
358 PERL_EXPORT_C int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode,
361 #ifndef PerlIO_getname
362 PERL_EXPORT_C char *PerlIO_getname(PerlIO *, char *);
365 PERL_EXPORT_C void PerlIO_destruct(pTHX);
367 PERL_EXPORT_C int PerlIO_intmode2str(int rawmode, char *mode, int *writing);
370 PERL_EXPORT_C void PerlIO_cleanup(pTHX);
372 PERL_EXPORT_C void PerlIO_debug(const char *fmt, ...)
373 __attribute__format__(__printf__, 1, 2);
374 typedef struct PerlIO_list_s PerlIO_list_t;
380 #endif /* _PERLIO_H */
384 * c-indentation-style: bsd
386 * indent-tabs-mode: nil
389 * ex: set ts=8 sts=4 sw=4 et: