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)
42 # ifndef PERLIO_IS_STDIO
43 # define PERLIO_IS_STDIO
47 /* -------------------- End of Configure controls ---------------------------- */
50 * Although we may not want stdio to be used including <stdio.h> here
51 * avoids issues where stdio.h has strange side effects
55 #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64)
59 #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64)
63 #ifdef PERLIO_IS_STDIO
64 /* #define PerlIO_xxxx() as equivalent stdio function */
66 #else /* PERLIO_IS_STDIO */
68 /* #define PerlIO_xxxx() as equivalent sfio function */
71 #endif /* PERLIO_IS_STDIO */
74 /* ----------- PerlIO implementation ---------- */
75 /* PerlIO not #define-d to something else - define the implementation */
77 typedef struct _PerlIO PerlIOl;
78 typedef struct _PerlIO_funcs PerlIO_funcs;
79 typedef PerlIOl *PerlIO;
81 #define PERLIO_LAYERS 1
83 extern void PerlIO_define_layer (PerlIO_funcs *tab);
84 extern SV * PerlIO_find_layer (const char *name, STRLEN len);
85 extern PerlIO * PerlIO_push (PerlIO *f,PerlIO_funcs *tab,const char *mode);
86 extern void PerlIO_pop (PerlIO *f);
90 /* ----------- End of implementation choices ---------- */
92 #ifndef PERLIO_IS_STDIO
93 /* Not using stdio _directly_ as PerlIO */
95 /* We now need to determine what happens if source trys to use stdio.
96 * There are three cases based on PERLIO_NOT_STDIO which XS code
97 * can set how it wants.
101 /* Make a choice for perl core code
102 - currently this is set to try and catch lingering raw stdio calls.
103 This is a known issue with some non UNIX ports which still use
104 "native" stdio features.
106 #ifndef PERLIO_NOT_STDIO
107 #define PERLIO_NOT_STDIO 1
111 #ifdef PERLIO_NOT_STDIO
114 * PERLIO_NOT_STDIO #define'd as 1
115 * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
118 #else /* if PERLIO_NOT_STDIO */
120 * PERLIO_NOT_STDIO #define'd as 0
121 * Case 2: Declares that both PerlIO and stdio can be used
123 #endif /* if PERLIO_NOT_STDIO */
124 #else /* ifdef PERLIO_NOT_STDIO */
126 * PERLIO_NOT_STDIO not defined
127 * Case 3: Try and fake stdio calls as PerlIO calls
129 #include "fakesdio.h"
130 #endif /* ifndef PERLIO_NOT_STDIO */
131 #endif /* PERLIO_IS_STDIO */
133 #define specialCopIO(sv) ((sv) != Nullsv)
135 /* ----------- fill in things that have not got #define'd ---------- */
145 /* This is to catch case with no stdio */
162 /* --------------------- Now prototypes for functions --------------- */
164 #ifndef NEXT30_NO_ATTRIBUTE
165 #ifndef HASATTRIBUTE /* disable GNU-cc attribute checking? */
166 #ifdef __attribute__ /* Avoid possible redefinition errors */
169 #define __attribute__(attr)
174 extern void PerlIO_init (void);
176 #ifndef PerlIO_stdoutf
177 extern int PerlIO_stdoutf (const char *,...)
178 __attribute__((__format__ (__printf__, 1, 2)));
181 extern int PerlIO_puts (PerlIO *,const char *);
184 extern PerlIO * PerlIO_open (const char *,const char *);
187 extern int PerlIO_close (PerlIO *);
190 extern int PerlIO_eof (PerlIO *);
193 extern int PerlIO_error (PerlIO *);
195 #ifndef PerlIO_clearerr
196 extern void PerlIO_clearerr (PerlIO *);
199 extern int PerlIO_getc (PerlIO *);
202 extern int PerlIO_putc (PerlIO *,int);
205 extern int PerlIO_flush (PerlIO *);
207 #ifndef PerlIO_ungetc
208 extern int PerlIO_ungetc (PerlIO *,int);
210 #ifndef PerlIO_fileno
211 extern int PerlIO_fileno (PerlIO *);
213 #ifndef PerlIO_fdopen
214 extern PerlIO * PerlIO_fdopen (int, const char *);
216 #ifndef PerlIO_importFILE
217 extern PerlIO * PerlIO_importFILE (FILE *,int);
219 #ifndef PerlIO_exportFILE
220 extern FILE * PerlIO_exportFILE (PerlIO *,int);
222 #ifndef PerlIO_findFILE
223 extern FILE * PerlIO_findFILE (PerlIO *);
225 #ifndef PerlIO_releaseFILE
226 extern void PerlIO_releaseFILE (PerlIO *,FILE *);
229 extern SSize_t PerlIO_read (PerlIO *,void *,Size_t);
232 extern SSize_t PerlIO_write (PerlIO *,const void *,Size_t);
234 #ifndef PerlIO_setlinebuf
235 extern void PerlIO_setlinebuf (PerlIO *);
237 #ifndef PerlIO_printf
238 extern int PerlIO_printf (PerlIO *, const char *,...)
239 __attribute__((__format__ (__printf__, 2, 3)));
241 #ifndef PerlIO_sprintf
242 extern int PerlIO_sprintf (char *, int, const char *,...)
243 __attribute__((__format__ (__printf__, 3, 4)));
245 #ifndef PerlIO_vprintf
246 extern int PerlIO_vprintf (PerlIO *, const char *, va_list);
249 extern Off_t PerlIO_tell (PerlIO *);
252 extern int PerlIO_seek (PerlIO *, Off_t, int);
254 #ifndef PerlIO_rewind
255 extern void PerlIO_rewind (PerlIO *);
257 #ifndef PerlIO_has_base
258 extern int PerlIO_has_base (PerlIO *);
260 #ifndef PerlIO_has_cntptr
261 extern int PerlIO_has_cntptr (PerlIO *);
263 #ifndef PerlIO_fast_gets
264 extern int PerlIO_fast_gets (PerlIO *);
266 #ifndef PerlIO_canset_cnt
267 extern int PerlIO_canset_cnt (PerlIO *);
269 #ifndef PerlIO_get_ptr
270 extern STDCHAR * PerlIO_get_ptr (PerlIO *);
272 #ifndef PerlIO_get_cnt
273 extern int PerlIO_get_cnt (PerlIO *);
275 #ifndef PerlIO_set_cnt
276 extern void PerlIO_set_cnt (PerlIO *,int);
278 #ifndef PerlIO_set_ptrcnt
279 extern void PerlIO_set_ptrcnt (PerlIO *,STDCHAR *,int);
281 #ifndef PerlIO_get_base
282 extern STDCHAR * PerlIO_get_base (PerlIO *);
284 #ifndef PerlIO_get_bufsiz
285 extern int PerlIO_get_bufsiz (PerlIO *);
287 #ifndef PerlIO_tmpfile
288 extern PerlIO * PerlIO_tmpfile (void);
291 extern PerlIO * PerlIO_stdin (void);
293 #ifndef PerlIO_stdout
294 extern PerlIO * PerlIO_stdout (void);
296 #ifndef PerlIO_stderr
297 extern PerlIO * PerlIO_stderr (void);
299 #ifndef PerlIO_getpos
300 extern int PerlIO_getpos (PerlIO *,Fpos_t *);
302 #ifndef PerlIO_setpos
303 extern int PerlIO_setpos (PerlIO *,const Fpos_t *);
305 #ifndef PerlIO_fdupopen
306 #define PerlIO_fdupopen(f) (f)
307 /* extern PerlIO * PerlIO_fdupopen (PerlIO *); */
309 #ifndef PerlIO_isutf8
310 extern int PerlIO_isutf8 (PerlIO *);
312 #ifndef PerlIO_apply_layers
313 extern int PerlIO_apply_layers (pTHX_ PerlIO *f, const char *mode, const char *names);
315 #ifndef PerlIO_binmode
316 extern int PerlIO_binmode (pTHX_ PerlIO *f, int iotype, int omode, const char *names);
319 extern void PerlIO_debug(const char *fmt,...);
321 #endif /* _PERLIO_H */