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 - No longer available via Configure. Formerly forced
17 PerlIO_xxx() to be #define-d onto stdio functions.
18 Now generates compile-time error.
20 USE_PERLIO - The primary Configure variable that enables PerlIO.
21 PerlIO_xxx() are real functions
22 defined in perlio.c which implement extra functionality
23 required for utf8 support.
32 # error "stdio is no longer supported as the default base layer -- use perlio."
35 /* -------------------- End of Configure controls ---------------------------- */
38 * Although we may not want stdio to be used including <stdio.h> here
39 * avoids issues where stdio.h has strange side effects
43 #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64)
47 #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64)
51 /* BS2000 includes are sometimes a bit non standard :-( */
52 #if defined(POSIX_BC) && defined(O_BINARY) && !defined(O_TEXT)
57 /* ----------- PerlIO implementation ---------- */
58 /* PerlIO not #define-d to something else - define the implementation */
60 typedef struct _PerlIO PerlIOl;
61 typedef struct _PerlIO_funcs PerlIO_funcs;
62 typedef PerlIOl *PerlIO;
64 #define PERLIO_LAYERS 1
66 #define PERLIO_FUNCS_DECL(funcs) const PerlIO_funcs funcs
67 #define PERLIO_FUNCS_CAST(funcs) (PerlIO_funcs*)(funcs)
69 PERL_CALLCONV void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab);
70 PERL_CALLCONV PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name,
73 PERL_CALLCONV PerlIO *PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab),
74 const char *mode, SV *arg);
75 PERL_CALLCONV void PerlIO_pop(pTHX_ PerlIO *f);
76 PERL_CALLCONV AV* PerlIO_get_layers(pTHX_ PerlIO *f);
77 PERL_CALLCONV void PerlIO_clone(pTHX_ PerlInterpreter *proto,
82 /* ----------- End of implementation choices ---------- */
84 /* We now need to determine what happens if source trys to use stdio.
85 * There are three cases based on PERLIO_NOT_STDIO which XS code
86 * can set how it wants.
90 /* Make a choice for perl core code
91 - currently this is set to try and catch lingering raw stdio calls.
92 This is a known issue with some non UNIX ports which still use
93 "native" stdio features.
95 # ifndef PERLIO_NOT_STDIO
96 # define PERLIO_NOT_STDIO 1
99 # ifndef PERLIO_NOT_STDIO
100 # define PERLIO_NOT_STDIO 0
104 #ifdef PERLIO_NOT_STDIO
107 * PERLIO_NOT_STDIO #define'd as 1
108 * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
111 #else /* if PERLIO_NOT_STDIO */
113 * PERLIO_NOT_STDIO #define'd as 0
114 * Case 2: Declares that both PerlIO and stdio can be used
116 #endif /* if PERLIO_NOT_STDIO */
117 #else /* ifdef PERLIO_NOT_STDIO */
119 * PERLIO_NOT_STDIO not defined
120 * Case 3: Try and fake stdio calls as PerlIO calls
122 #include "fakesdio.h"
123 #endif /* ifndef PERLIO_NOT_STDIO */
125 /* ----------- fill in things that have not got #define'd ---------- */
135 /* This is to catch case with no stdio */
140 /* The default buffer size for the perlio buffering layer */
141 #ifndef PERLIOBUF_DEFAULT_BUFSIZ
142 #define PERLIOBUF_DEFAULT_BUFSIZ (BUFSIZ > 8192 ? BUFSIZ : 8192)
157 #define PERLIO_DUP_CLONE 1
158 #define PERLIO_DUP_FD 2
160 /* --------------------- Now prototypes for functions --------------- */
163 #ifndef __attribute__format__
164 # ifdef HASATTRIBUTE_FORMAT
165 # define __attribute__format__(x,y,z) __attribute__((format(x,y,z)))
167 # define __attribute__format__(x,y,z)
171 PERL_CALLCONV void PerlIO_init(pTHX);
173 #ifndef PerlIO_stdoutf
174 PERL_CALLCONV int PerlIO_stdoutf(const char *, ...)
175 __attribute__format__(__printf__, 1, 2);
178 PERL_CALLCONV int PerlIO_puts(PerlIO *, const char *);
181 PERL_CALLCONV PerlIO *PerlIO_open(const char *, const char *);
184 PERL_CALLCONV PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode,
185 int fd, int imode, int perm, PerlIO *old,
189 PERL_CALLCONV int PerlIO_eof(PerlIO *);
192 PERL_CALLCONV int PerlIO_error(PerlIO *);
194 #ifndef PerlIO_clearerr
195 PERL_CALLCONV void PerlIO_clearerr(PerlIO *);
198 PERL_CALLCONV int PerlIO_getc(PerlIO *);
201 PERL_CALLCONV int PerlIO_putc(PerlIO *, int);
203 #ifndef PerlIO_ungetc
204 PERL_CALLCONV int PerlIO_ungetc(PerlIO *, int);
206 #ifndef PerlIO_fdopen
207 PERL_CALLCONV PerlIO *PerlIO_fdopen(int, const char *);
209 #ifndef PerlIO_importFILE
210 PERL_CALLCONV PerlIO *PerlIO_importFILE(FILE *, const char *);
212 #ifndef PerlIO_exportFILE
213 PERL_CALLCONV FILE *PerlIO_exportFILE(PerlIO *, const char *);
215 #ifndef PerlIO_findFILE
216 PERL_CALLCONV FILE *PerlIO_findFILE(PerlIO *);
218 #ifndef PerlIO_releaseFILE
219 PERL_CALLCONV void PerlIO_releaseFILE(PerlIO *, FILE *);
222 PERL_CALLCONV SSize_t PerlIO_read(PerlIO *, void *, Size_t);
224 #ifndef PerlIO_unread
225 PERL_CALLCONV SSize_t PerlIO_unread(PerlIO *, const void *, Size_t);
228 PERL_CALLCONV SSize_t PerlIO_write(PerlIO *, const void *, Size_t);
230 #ifndef PerlIO_setlinebuf
231 PERL_CALLCONV void PerlIO_setlinebuf(PerlIO *);
233 #ifndef PerlIO_printf
234 PERL_CALLCONV int PerlIO_printf(PerlIO *, const char *, ...)
235 __attribute__format__(__printf__, 2, 3);
237 #ifndef PerlIO_vprintf
238 PERL_CALLCONV int PerlIO_vprintf(PerlIO *, const char *, va_list);
241 PERL_CALLCONV Off_t PerlIO_tell(PerlIO *);
244 PERL_CALLCONV int PerlIO_seek(PerlIO *, Off_t, int);
246 #ifndef PerlIO_rewind
247 PERL_CALLCONV void PerlIO_rewind(PerlIO *);
249 #ifndef PerlIO_has_base
250 PERL_CALLCONV int PerlIO_has_base(PerlIO *);
252 #ifndef PerlIO_has_cntptr
253 PERL_CALLCONV int PerlIO_has_cntptr(PerlIO *);
255 #ifndef PerlIO_fast_gets
256 PERL_CALLCONV int PerlIO_fast_gets(PerlIO *);
258 #ifndef PerlIO_canset_cnt
259 PERL_CALLCONV int PerlIO_canset_cnt(PerlIO *);
261 #ifndef PerlIO_get_ptr
262 PERL_CALLCONV STDCHAR *PerlIO_get_ptr(PerlIO *);
264 #ifndef PerlIO_get_cnt
265 PERL_CALLCONV SSize_t PerlIO_get_cnt(PerlIO *);
267 #ifndef PerlIO_set_cnt
268 PERL_CALLCONV void PerlIO_set_cnt(PerlIO *, SSize_t);
270 #ifndef PerlIO_set_ptrcnt
271 PERL_CALLCONV void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, SSize_t);
273 #ifndef PerlIO_get_base
274 PERL_CALLCONV STDCHAR *PerlIO_get_base(PerlIO *);
276 #ifndef PerlIO_get_bufsiz
277 PERL_CALLCONV SSize_t PerlIO_get_bufsiz(PerlIO *);
279 #ifndef PerlIO_tmpfile
280 PERL_CALLCONV PerlIO *PerlIO_tmpfile(void);
282 #ifndef PerlIO_tmpfile_flags
283 PERL_CALLCONV PerlIO *PerlIO_tmpfile_flags(int flags);
286 PERL_CALLCONV PerlIO *PerlIO_stdin(void);
288 #ifndef PerlIO_stdout
289 PERL_CALLCONV PerlIO *PerlIO_stdout(void);
291 #ifndef PerlIO_stderr
292 PERL_CALLCONV PerlIO *PerlIO_stderr(void);
294 #ifndef PerlIO_getpos
295 PERL_CALLCONV int PerlIO_getpos(PerlIO *, SV *);
297 #ifndef PerlIO_setpos
298 PERL_CALLCONV int PerlIO_setpos(PerlIO *, SV *);
300 #ifndef PerlIO_fdupopen
301 PERL_CALLCONV PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *, int);
303 #if !defined(PerlIO_modestr)
304 PERL_CALLCONV char *PerlIO_modestr(PerlIO *, char *buf);
306 #ifndef PerlIO_isutf8
307 PERL_CALLCONV int PerlIO_isutf8(PerlIO *);
309 #ifndef PerlIO_apply_layers
310 PERL_CALLCONV int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode,
313 #ifndef PerlIO_binmode
314 PERL_CALLCONV int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode,
317 #ifndef PerlIO_getname
318 PERL_CALLCONV char *PerlIO_getname(PerlIO *, char *);
321 PERL_CALLCONV void PerlIO_destruct(pTHX);
323 PERL_CALLCONV int PerlIO_intmode2str(int rawmode, char *mode, int *writing);
326 PERL_CALLCONV void PerlIO_cleanup(pTHX);
328 PERL_CALLCONV void PerlIO_debug(const char *fmt, ...)
329 __attribute__format__(__printf__, 1, 2);
330 typedef struct PerlIO_list_s PerlIO_list_t;
335 #endif /* PERLIO_H_ */
338 * ex: set ts=8 sts=4 sw=4 et: