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 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.
24 PerlIO_xxx() are real functions
25 defined in perlio.c which implement extra functionality
26 required for utf8 support.
28 One further note - the table-of-functions scheme controlled
29 by PERL_IMPLICIT_SYS turns on USE_PERLIO so that iperlsys.h can
30 #define PerlIO_xxx() to go via the function table, without having
31 to #undef them from (say) stdio forms.
35 #if defined(PERL_IMPLICIT_SYS)
38 /* # define USE_PERLIO */
48 # ifndef PERLIO_IS_STDIO
49 # define PERLIO_IS_STDIO
53 /* -------------------- End of Configure controls ---------------------------- */
56 * Although we may not want stdio to be used including <stdio.h> here
57 * avoids issues where stdio.h has strange side effects
61 #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64)
65 #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64)
69 /* BS2000 includes are sometimes a bit non standard :-( */
70 #if defined(POSIX_BC) && defined(O_BINARY) && !defined(O_TEXT)
74 #ifdef PERLIO_IS_STDIO
75 /* #define PerlIO_xxxx() as equivalent stdio function */
77 #endif /* PERLIO_IS_STDIO */
80 /* ----------- PerlIO implementation ---------- */
81 /* PerlIO not #define-d to something else - define the implementation */
83 typedef struct _PerlIO PerlIOl;
84 typedef struct _PerlIO_funcs PerlIO_funcs;
85 typedef PerlIOl *PerlIO;
87 #define PERLIO_LAYERS 1
89 /* PERLIO_FUNCS_CONST is now on by default for efficiency, PERLIO_FUNCS_CONST
90 can be removed 1 day once stable & then PerlIO vtables are permanently RO */
91 #ifdef PERLIO_FUNCS_CONST
92 #define PERLIO_FUNCS_DECL(funcs) const PerlIO_funcs funcs
93 #define PERLIO_FUNCS_CAST(funcs) (PerlIO_funcs*)(funcs)
95 #define PERLIO_FUNCS_DECL(funcs) PerlIO_funcs funcs
96 #define PERLIO_FUNCS_CAST(funcs) (funcs)
99 PERL_EXPORT_C void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab);
100 PERL_EXPORT_C PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name,
103 PERL_EXPORT_C PerlIO *PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab),
104 const char *mode, SV *arg);
105 PERL_EXPORT_C void PerlIO_pop(pTHX_ PerlIO *f);
106 PERL_EXPORT_C AV* PerlIO_get_layers(pTHX_ PerlIO *f);
107 PERL_EXPORT_C void PerlIO_clone(pTHX_ PerlInterpreter *proto,
108 CLONE_PARAMS *param);
112 /* ----------- End of implementation choices ---------- */
114 #ifndef PERLIO_IS_STDIO
115 /* Not using stdio _directly_ as PerlIO */
117 /* We now need to determine what happens if source trys to use stdio.
118 * There are three cases based on PERLIO_NOT_STDIO which XS code
119 * can set how it wants.
123 /* Make a choice for perl core code
124 - currently this is set to try and catch lingering raw stdio calls.
125 This is a known issue with some non UNIX ports which still use
126 "native" stdio features.
128 # ifndef PERLIO_NOT_STDIO
129 # define PERLIO_NOT_STDIO 1
132 # ifndef PERLIO_NOT_STDIO
133 # define PERLIO_NOT_STDIO 0
137 #ifdef PERLIO_NOT_STDIO
140 * PERLIO_NOT_STDIO #define'd as 1
141 * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
144 #else /* if PERLIO_NOT_STDIO */
146 * PERLIO_NOT_STDIO #define'd as 0
147 * Case 2: Declares that both PerlIO and stdio can be used
149 #endif /* if PERLIO_NOT_STDIO */
150 #else /* ifdef PERLIO_NOT_STDIO */
152 * PERLIO_NOT_STDIO not defined
153 * Case 3: Try and fake stdio calls as PerlIO calls
155 #include "fakesdio.h"
156 #endif /* ifndef PERLIO_NOT_STDIO */
157 #endif /* PERLIO_IS_STDIO */
159 /* ----------- fill in things that have not got #define'd ---------- */
169 /* This is to catch case with no stdio */
174 /* The default buffer size for the perlio buffering layer */
175 #ifndef PERLIOBUF_DEFAULT_BUFSIZ
176 #define PERLIOBUF_DEFAULT_BUFSIZ (BUFSIZ > 8192 ? BUFSIZ : 8192)
191 #define PERLIO_DUP_CLONE 1
192 #define PERLIO_DUP_FD 2
194 /* --------------------- Now prototypes for functions --------------- */
197 #ifndef __attribute__format__
198 # ifdef HASATTRIBUTE_FORMAT
199 # define __attribute__format__(x,y,z) __attribute__((format(x,y,z)))
201 # define __attribute__format__(x,y,z)
205 PERL_EXPORT_C void PerlIO_init(pTHX);
207 #ifndef PerlIO_stdoutf
208 PERL_EXPORT_C int PerlIO_stdoutf(const char *, ...)
209 __attribute__format__(__printf__, 1, 2);
212 PERL_EXPORT_C int PerlIO_puts(PerlIO *, const char *);
215 PERL_EXPORT_C PerlIO *PerlIO_open(const char *, const char *);
218 PERL_EXPORT_C PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode,
219 int fd, int imode, int perm, PerlIO *old,
223 PERL_EXPORT_C int PerlIO_eof(PerlIO *);
226 PERL_EXPORT_C int PerlIO_error(PerlIO *);
228 #ifndef PerlIO_clearerr
229 PERL_EXPORT_C void PerlIO_clearerr(PerlIO *);
232 PERL_EXPORT_C int PerlIO_getc(PerlIO *);
235 PERL_EXPORT_C int PerlIO_putc(PerlIO *, int);
237 #ifndef PerlIO_ungetc
238 PERL_EXPORT_C int PerlIO_ungetc(PerlIO *, int);
240 #ifndef PerlIO_fdopen
241 PERL_EXPORT_C PerlIO *PerlIO_fdopen(int, const char *);
243 #ifndef PerlIO_importFILE
244 PERL_EXPORT_C PerlIO *PerlIO_importFILE(FILE *, const char *);
246 #ifndef PerlIO_exportFILE
247 PERL_EXPORT_C FILE *PerlIO_exportFILE(PerlIO *, const char *);
249 #ifndef PerlIO_findFILE
250 PERL_EXPORT_C FILE *PerlIO_findFILE(PerlIO *);
252 #ifndef PerlIO_releaseFILE
253 PERL_EXPORT_C void PerlIO_releaseFILE(PerlIO *, FILE *);
256 PERL_EXPORT_C SSize_t PerlIO_read(PerlIO *, void *, Size_t);
258 #ifndef PerlIO_unread
259 PERL_EXPORT_C SSize_t PerlIO_unread(PerlIO *, const void *, Size_t);
262 PERL_EXPORT_C SSize_t PerlIO_write(PerlIO *, const void *, Size_t);
264 #ifndef PerlIO_setlinebuf
265 PERL_EXPORT_C void PerlIO_setlinebuf(PerlIO *);
267 #ifndef PerlIO_printf
268 PERL_EXPORT_C int PerlIO_printf(PerlIO *, const char *, ...)
269 __attribute__format__(__printf__, 2, 3);
271 #ifndef PerlIO_vprintf
272 PERL_EXPORT_C int PerlIO_vprintf(PerlIO *, const char *, va_list);
275 PERL_EXPORT_C Off_t PerlIO_tell(PerlIO *);
278 PERL_EXPORT_C int PerlIO_seek(PerlIO *, Off_t, int);
280 #ifndef PerlIO_rewind
281 PERL_EXPORT_C void PerlIO_rewind(PerlIO *);
283 #ifndef PerlIO_has_base
284 PERL_EXPORT_C int PerlIO_has_base(PerlIO *);
286 #ifndef PerlIO_has_cntptr
287 PERL_EXPORT_C int PerlIO_has_cntptr(PerlIO *);
289 #ifndef PerlIO_fast_gets
290 PERL_EXPORT_C int PerlIO_fast_gets(PerlIO *);
292 #ifndef PerlIO_canset_cnt
293 PERL_EXPORT_C int PerlIO_canset_cnt(PerlIO *);
295 #ifndef PerlIO_get_ptr
296 PERL_EXPORT_C STDCHAR *PerlIO_get_ptr(PerlIO *);
298 #ifndef PerlIO_get_cnt
299 PERL_EXPORT_C SSize_t PerlIO_get_cnt(PerlIO *);
301 #ifndef PerlIO_set_cnt
302 PERL_EXPORT_C void PerlIO_set_cnt(PerlIO *, SSize_t);
304 #ifndef PerlIO_set_ptrcnt
305 PERL_EXPORT_C void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, SSize_t);
307 #ifndef PerlIO_get_base
308 PERL_EXPORT_C STDCHAR *PerlIO_get_base(PerlIO *);
310 #ifndef PerlIO_get_bufsiz
311 PERL_EXPORT_C SSize_t PerlIO_get_bufsiz(PerlIO *);
313 #ifndef PerlIO_tmpfile
314 PERL_EXPORT_C PerlIO *PerlIO_tmpfile(void);
317 PERL_EXPORT_C PerlIO *PerlIO_stdin(void);
319 #ifndef PerlIO_stdout
320 PERL_EXPORT_C PerlIO *PerlIO_stdout(void);
322 #ifndef PerlIO_stderr
323 PERL_EXPORT_C PerlIO *PerlIO_stderr(void);
325 #ifndef PerlIO_getpos
326 PERL_EXPORT_C int PerlIO_getpos(PerlIO *, SV *);
328 #ifndef PerlIO_setpos
329 PERL_EXPORT_C int PerlIO_setpos(PerlIO *, SV *);
331 #ifndef PerlIO_fdupopen
332 PERL_EXPORT_C PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *, int);
334 #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO)
335 PERL_EXPORT_C char *PerlIO_modestr(PerlIO *, char *buf);
337 #ifndef PerlIO_isutf8
338 PERL_EXPORT_C int PerlIO_isutf8(PerlIO *);
340 #ifndef PerlIO_apply_layers
341 PERL_EXPORT_C int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode,
344 #ifndef PerlIO_binmode
345 PERL_EXPORT_C int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode,
348 #ifndef PerlIO_getname
349 PERL_EXPORT_C char *PerlIO_getname(PerlIO *, char *);
352 PERL_EXPORT_C void PerlIO_destruct(pTHX);
354 PERL_EXPORT_C int PerlIO_intmode2str(int rawmode, char *mode, int *writing);
357 PERL_EXPORT_C void PerlIO_cleanup(pTHX);
359 PERL_EXPORT_C void PerlIO_debug(const char *fmt, ...)
360 __attribute__format__(__printf__, 1, 2);
361 typedef struct PerlIO_list_s PerlIO_list_t;
367 #endif /* _PERLIO_H */
370 * ex: set ts=8 sts=4 sw=4 et: