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 #ifdef PERLIO_IS_STDIO
66 /* #define PerlIO_xxxx() as equivalent stdio function */
68 #else /* PERLIO_IS_STDIO */
70 /* #define PerlIO_xxxx() as equivalent sfio function */
73 #endif /* PERLIO_IS_STDIO */
76 /* ----------- PerlIO implementation ---------- */
77 /* PerlIO not #define-d to something else - define the implementation */
79 typedef struct _PerlIO PerlIOl;
80 typedef struct _PerlIO_funcs PerlIO_funcs;
81 typedef PerlIOl *PerlIO;
83 #define PERLIO_LAYERS 1
85 extern void PerlIO_define_layer (pTHX_ PerlIO_funcs *tab);
86 extern PerlIO_funcs *PerlIO_find_layer (pTHX_ const char *name, STRLEN len, int load);
87 extern PerlIO * PerlIO_push (pTHX_ PerlIO *f,PerlIO_funcs *tab,const char *mode,SV *arg);
88 extern void PerlIO_pop (pTHX_ PerlIO *f);
92 /* ----------- End of implementation choices ---------- */
94 #ifndef PERLIO_IS_STDIO
95 /* Not using stdio _directly_ as PerlIO */
97 /* We now need to determine what happens if source trys to use stdio.
98 * There are three cases based on PERLIO_NOT_STDIO which XS code
99 * can set how it wants.
103 /* Make a choice for perl core code
104 - currently this is set to try and catch lingering raw stdio calls.
105 This is a known issue with some non UNIX ports which still use
106 "native" stdio features.
108 #ifndef PERLIO_NOT_STDIO
109 #define PERLIO_NOT_STDIO 1
112 #ifndef PERLIO_NOT_STDIO
113 #define PERLIO_NOT_STDIO 0
117 #ifdef PERLIO_NOT_STDIO
120 * PERLIO_NOT_STDIO #define'd as 1
121 * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
124 #else /* if PERLIO_NOT_STDIO */
126 * PERLIO_NOT_STDIO #define'd as 0
127 * Case 2: Declares that both PerlIO and stdio can be used
129 #endif /* if PERLIO_NOT_STDIO */
130 #else /* ifdef PERLIO_NOT_STDIO */
132 * PERLIO_NOT_STDIO not defined
133 * Case 3: Try and fake stdio calls as PerlIO calls
135 #include "fakesdio.h"
136 #endif /* ifndef PERLIO_NOT_STDIO */
137 #endif /* PERLIO_IS_STDIO */
139 #define specialCopIO(sv) ((sv) != Nullsv)
141 /* ----------- fill in things that have not got #define'd ---------- */
151 /* This is to catch case with no stdio */
168 /* --------------------- Now prototypes for functions --------------- */
172 #ifndef NEXT30_NO_ATTRIBUTE
173 #ifndef HASATTRIBUTE /* disable GNU-cc attribute checking? */
174 #ifdef __attribute__ /* Avoid possible redefinition errors */
177 #define __attribute__(attr)
182 extern void PerlIO_init (void);
184 #ifndef PerlIO_stdoutf
185 extern int PerlIO_stdoutf (const char *,...)
186 __attribute__((__format__ (__printf__, 1, 2)));
189 extern int PerlIO_puts (PerlIO *,const char *);
192 extern PerlIO * PerlIO_open (const char *,const char *);
195 extern PerlIO * PerlIO_openn (pTHX_ const char *layers, const char *mode,int fd,int imode,int perm,PerlIO *old,int narg,SV **arg);
198 extern int PerlIO_close (PerlIO *);
201 extern int PerlIO_eof (PerlIO *);
204 extern int PerlIO_error (PerlIO *);
206 #ifndef PerlIO_clearerr
207 extern void PerlIO_clearerr (PerlIO *);
210 extern int PerlIO_getc (PerlIO *);
213 extern int PerlIO_putc (PerlIO *,int);
216 extern int PerlIO_flush (PerlIO *);
218 #ifndef PerlIO_ungetc
219 extern int PerlIO_ungetc (PerlIO *,int);
221 #ifndef PerlIO_fileno
222 extern int PerlIO_fileno (PerlIO *);
224 #ifndef PerlIO_fdopen
225 extern PerlIO * PerlIO_fdopen (int, const char *);
227 #ifndef PerlIO_importFILE
228 extern PerlIO * PerlIO_importFILE (FILE *,int);
230 #ifndef PerlIO_exportFILE
231 extern FILE * PerlIO_exportFILE (PerlIO *,int);
233 #ifndef PerlIO_findFILE
234 extern FILE * PerlIO_findFILE (PerlIO *);
236 #ifndef PerlIO_releaseFILE
237 extern void PerlIO_releaseFILE (PerlIO *,FILE *);
240 extern SSize_t PerlIO_read (PerlIO *,void *,Size_t);
242 #ifndef PerlIO_unread
243 extern SSize_t PerlIO_unread (PerlIO *,const void *,Size_t);
246 extern SSize_t PerlIO_write (PerlIO *,const void *,Size_t);
248 #ifndef PerlIO_setlinebuf
249 extern void PerlIO_setlinebuf (PerlIO *);
251 #ifndef PerlIO_printf
252 extern int PerlIO_printf (PerlIO *, const char *,...)
253 __attribute__((__format__ (__printf__, 2, 3)));
255 #ifndef PerlIO_sprintf
256 extern int PerlIO_sprintf (char *, int, const char *,...)
257 __attribute__((__format__ (__printf__, 3, 4)));
259 #ifndef PerlIO_vprintf
260 extern int PerlIO_vprintf (PerlIO *, const char *, va_list);
263 extern Off_t PerlIO_tell (PerlIO *);
266 extern int PerlIO_seek (PerlIO *, Off_t, int);
268 #ifndef PerlIO_rewind
269 extern void PerlIO_rewind (PerlIO *);
271 #ifndef PerlIO_has_base
272 extern int PerlIO_has_base (PerlIO *);
274 #ifndef PerlIO_has_cntptr
275 extern int PerlIO_has_cntptr (PerlIO *);
277 #ifndef PerlIO_fast_gets
278 extern int PerlIO_fast_gets (PerlIO *);
280 #ifndef PerlIO_canset_cnt
281 extern int PerlIO_canset_cnt (PerlIO *);
283 #ifndef PerlIO_get_ptr
284 extern STDCHAR * PerlIO_get_ptr (PerlIO *);
286 #ifndef PerlIO_get_cnt
287 extern int PerlIO_get_cnt (PerlIO *);
289 #ifndef PerlIO_set_cnt
290 extern void PerlIO_set_cnt (PerlIO *,int);
292 #ifndef PerlIO_set_ptrcnt
293 extern void PerlIO_set_ptrcnt (PerlIO *,STDCHAR *,int);
295 #ifndef PerlIO_get_base
296 extern STDCHAR * PerlIO_get_base (PerlIO *);
298 #ifndef PerlIO_get_bufsiz
299 extern int PerlIO_get_bufsiz (PerlIO *);
301 #ifndef PerlIO_tmpfile
302 extern PerlIO * PerlIO_tmpfile (void);
305 extern PerlIO * PerlIO_stdin (void);
307 #ifndef PerlIO_stdout
308 extern PerlIO * PerlIO_stdout (void);
310 #ifndef PerlIO_stderr
311 extern PerlIO * PerlIO_stderr (void);
313 #ifndef PerlIO_getpos
314 extern int PerlIO_getpos (PerlIO *,SV *);
316 #ifndef PerlIO_setpos
317 extern int PerlIO_setpos (PerlIO *,SV *);
319 #ifndef PerlIO_fdupopen
320 extern PerlIO * PerlIO_fdupopen (pTHX_ PerlIO *);
322 #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO)
323 extern char *PerlIO_modestr (PerlIO *,char *buf);
325 #ifndef PerlIO_isutf8
326 extern int PerlIO_isutf8 (PerlIO *);
328 #ifndef PerlIO_apply_layers
329 extern int PerlIO_apply_layers (pTHX_ PerlIO *f, const char *mode, const char *names);
331 #ifndef PerlIO_binmode
332 extern int PerlIO_binmode (pTHX_ PerlIO *f, int iotype, int omode, const char *names);
334 #ifndef PerlIO_getname
335 extern char * PerlIO_getname (PerlIO *, char *);
338 extern void PerlIO_destruct(pTHX);
340 #ifndef PERLIO_IS_STDIO
342 extern void PerlIO_cleanup(void);
344 extern void PerlIO_debug(const char *fmt,...);
350 #endif /* _PERLIO_H */