4 Interface for perl to IO functions.
5 There is a hierachy of Configure determined #define controls:
6 USE_STDIO - forces PerlIO_xxx() to be #define-d onto stdio functions.
7 This is used for x2p subdirectory and for conservative
8 builds - "just like perl5.00X used to be".
9 This dominates over the others.
11 USE_PERLIO - The primary Configure variable that enables PerlIO.
12 If USE_PERLIO is _NOT_ set
13 then USE_STDIO above will be set to be conservative.
15 then there are two modes determined by USE_SFIO:
17 USE_SFIO - If set causes PerlIO_xxx() to be #define-d onto sfio functions.
18 A backward compatability mode for some specialist applications.
20 If USE_SFIO is not set then PerlIO_xxx() are real functions
21 defined in perlio.c which implement extra functionality
22 required for utf8 support.
24 One further note - the table-of-functions scheme controlled
25 by PERL_IMPLICIT_SYS turns on USE_PERLIO so that iperlsys.h can
26 #define PerlIO_xxx() to go via the function table, without having
27 to #undef them from (say) stdio forms.
31 #if defined(PERL_IMPLICIT_SYS)
44 # ifndef PERLIO_IS_STDIO
45 # define PERLIO_IS_STDIO
49 /* -------------------- End of Configure controls ---------------------------- */
52 * Although we may not want stdio to be used including <stdio.h> here
53 * avoids issues where stdio.h has strange side effects
57 #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64)
61 #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64)
65 /* BS2000 includes are sometimes a bit non standard :-( */
66 #if defined(POSIX_BC) && defined(O_BINARY) && !defined(O_TEXT)
70 #ifdef PERLIO_IS_STDIO
71 /* #define PerlIO_xxxx() as equivalent stdio function */
73 #else /* PERLIO_IS_STDIO */
75 /* #define PerlIO_xxxx() as equivalent sfio function */
78 #endif /* PERLIO_IS_STDIO */
81 /* ----------- PerlIO implementation ---------- */
82 /* PerlIO not #define-d to something else - define the implementation */
84 typedef struct _PerlIO PerlIOl;
85 typedef struct _PerlIO_funcs PerlIO_funcs;
86 typedef PerlIOl *PerlIO;
88 #define PERLIO_LAYERS 1
90 extern void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab);
91 extern PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name, STRLEN len,
93 extern PerlIO *PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab,
94 const char *mode, SV *arg);
95 extern void PerlIO_pop(pTHX_ PerlIO *f);
96 extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param);
100 /* ----------- End of implementation choices ---------- */
102 #ifndef PERLIO_IS_STDIO
103 /* Not using stdio _directly_ as PerlIO */
105 /* We now need to determine what happens if source trys to use stdio.
106 * There are three cases based on PERLIO_NOT_STDIO which XS code
107 * can set how it wants.
111 /* Make a choice for perl core code
112 - currently this is set to try and catch lingering raw stdio calls.
113 This is a known issue with some non UNIX ports which still use
114 "native" stdio features.
116 #ifndef PERLIO_NOT_STDIO
117 #define PERLIO_NOT_STDIO 1
120 #ifndef PERLIO_NOT_STDIO
121 #define PERLIO_NOT_STDIO 0
125 #ifdef PERLIO_NOT_STDIO
128 * PERLIO_NOT_STDIO #define'd as 1
129 * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
132 #else /* if PERLIO_NOT_STDIO */
134 * PERLIO_NOT_STDIO #define'd as 0
135 * Case 2: Declares that both PerlIO and stdio can be used
137 #endif /* if PERLIO_NOT_STDIO */
138 #else /* ifdef PERLIO_NOT_STDIO */
140 * PERLIO_NOT_STDIO not defined
141 * Case 3: Try and fake stdio calls as PerlIO calls
143 #include "fakesdio.h"
144 #endif /* ifndef PERLIO_NOT_STDIO */
145 #endif /* PERLIO_IS_STDIO */
147 #define specialCopIO(sv) ((sv) != Nullsv)
149 /* ----------- fill in things that have not got #define'd ---------- */
159 /* This is to catch case with no stdio */
176 /* --------------------- Now prototypes for functions --------------- */
179 #ifndef NEXT30_NO_ATTRIBUTE
180 #ifndef HASATTRIBUTE /* disable GNU-cc attribute checking? */
181 #ifdef __attribute__ /* Avoid possible redefinition errors */
184 #define __attribute__(attr)
188 extern void PerlIO_init(pTHX);
190 #ifndef PerlIO_stdoutf
191 extern int PerlIO_stdoutf(const char *, ...)
192 __attribute__ ((__format__(__printf__, 1, 2)));
195 extern int PerlIO_puts(PerlIO *, const char *);
198 extern PerlIO *PerlIO_open(const char *, const char *);
201 extern PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode,
202 int fd, int imode, int perm, PerlIO *old,
206 extern int PerlIO_close(PerlIO *);
209 extern int PerlIO_eof(PerlIO *);
212 extern int PerlIO_error(PerlIO *);
214 #ifndef PerlIO_clearerr
215 extern void PerlIO_clearerr(PerlIO *);
218 extern int PerlIO_getc(PerlIO *);
221 extern int PerlIO_putc(PerlIO *, int);
224 extern int PerlIO_flush(PerlIO *);
226 #ifndef PerlIO_ungetc
227 extern int PerlIO_ungetc(PerlIO *, int);
229 #ifndef PerlIO_fileno
230 extern int PerlIO_fileno(PerlIO *);
232 #ifndef PerlIO_fdopen
233 extern PerlIO *PerlIO_fdopen(int, const char *);
235 #ifndef PerlIO_importFILE
236 extern PerlIO *PerlIO_importFILE(FILE *, int);
238 #ifndef PerlIO_exportFILE
239 extern FILE *PerlIO_exportFILE(PerlIO *, int);
241 #ifndef PerlIO_findFILE
242 extern FILE *PerlIO_findFILE(PerlIO *);
244 #ifndef PerlIO_releaseFILE
245 extern void PerlIO_releaseFILE(PerlIO *, FILE *);
248 extern SSize_t PerlIO_read(PerlIO *, void *, Size_t);
250 #ifndef PerlIO_unread
251 extern SSize_t PerlIO_unread(PerlIO *, const void *, Size_t);
254 extern SSize_t PerlIO_write(PerlIO *, const void *, Size_t);
256 #ifndef PerlIO_setlinebuf
257 extern void PerlIO_setlinebuf(PerlIO *);
259 #ifndef PerlIO_printf
260 extern int PerlIO_printf(PerlIO *, const char *, ...)
261 __attribute__ ((__format__(__printf__, 2, 3)));
263 #ifndef PerlIO_sprintf
264 extern int PerlIO_sprintf(char *, int, const char *, ...)
265 __attribute__ ((__format__(__printf__, 3, 4)));
267 #ifndef PerlIO_vprintf
268 extern int PerlIO_vprintf(PerlIO *, const char *, va_list);
271 extern Off_t PerlIO_tell(PerlIO *);
274 extern int PerlIO_seek(PerlIO *, Off_t, int);
276 #ifndef PerlIO_rewind
277 extern void PerlIO_rewind(PerlIO *);
279 #ifndef PerlIO_has_base
280 extern int PerlIO_has_base(PerlIO *);
282 #ifndef PerlIO_has_cntptr
283 extern int PerlIO_has_cntptr(PerlIO *);
285 #ifndef PerlIO_fast_gets
286 extern int PerlIO_fast_gets(PerlIO *);
288 #ifndef PerlIO_canset_cnt
289 extern int PerlIO_canset_cnt(PerlIO *);
291 #ifndef PerlIO_get_ptr
292 extern STDCHAR *PerlIO_get_ptr(PerlIO *);
294 #ifndef PerlIO_get_cnt
295 extern int PerlIO_get_cnt(PerlIO *);
297 #ifndef PerlIO_set_cnt
298 extern void PerlIO_set_cnt(PerlIO *, int);
300 #ifndef PerlIO_set_ptrcnt
301 extern void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, int);
303 #ifndef PerlIO_get_base
304 extern STDCHAR *PerlIO_get_base(PerlIO *);
306 #ifndef PerlIO_get_bufsiz
307 extern int PerlIO_get_bufsiz(PerlIO *);
309 #ifndef PerlIO_tmpfile
310 extern PerlIO *PerlIO_tmpfile(void);
313 extern PerlIO *PerlIO_stdin(void);
315 #ifndef PerlIO_stdout
316 extern PerlIO *PerlIO_stdout(void);
318 #ifndef PerlIO_stderr
319 extern PerlIO *PerlIO_stderr(void);
321 #ifndef PerlIO_getpos
322 extern int PerlIO_getpos(PerlIO *, SV *);
324 #ifndef PerlIO_setpos
325 extern int PerlIO_setpos(PerlIO *, SV *);
327 #ifndef PerlIO_fdupopen
328 extern PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *);
330 #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO)
331 extern char *PerlIO_modestr(PerlIO *, char *buf);
333 #ifndef PerlIO_isutf8
334 extern int PerlIO_isutf8(PerlIO *);
336 #ifndef PerlIO_apply_layers
337 extern int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode,
340 #ifndef PerlIO_binmode
341 extern int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode,
344 #ifndef PerlIO_getname
345 extern char *PerlIO_getname(PerlIO *, char *);
348 extern void PerlIO_destruct(pTHX);
350 extern int PerlIO_intmode2str(int rawmode, char *mode, int *writing);
353 extern void PerlIO_cleanup(pTHX);
355 extern void PerlIO_debug(const char *fmt, ...);
356 typedef struct PerlIO_list_s PerlIO_list_t;
362 #endif /* _PERLIO_H */