This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Handle PERLIO= and document a bit.
[perl5.git] / perlio.h
CommitLineData
eb1102fc
NIS
1/* perlio.h
2 *
4c79ee7a 3 * Copyright (c) 1997-2003, Larry Wall
eb1102fc
NIS
4 *
5 * You may distribute under the terms of either the GNU General Public
6 * License or the Artistic License, as specified in the README file.
7 *
8 */
9
76ced9ad
NIS
10#ifndef _PERLIO_H
11#define _PERLIO_H
12/*
13 Interface for perl to IO functions.
14 There is a hierachy of Configure determined #define controls:
15 USE_STDIO - forces PerlIO_xxx() to be #define-d onto stdio functions.
16 This is used for x2p subdirectory and for conservative
17 builds - "just like perl5.00X used to be".
18 This dominates over the others.
19
20 USE_PERLIO - The primary Configure variable that enables PerlIO.
21 If USE_PERLIO is _NOT_ set
22 then USE_STDIO above will be set to be conservative.
23 If USE_PERLIO is set
24 then there are two modes determined by USE_SFIO:
25
26 USE_SFIO - If set causes PerlIO_xxx() to be #define-d onto sfio functions.
27 A backward compatability mode for some specialist applications.
28
29 If USE_SFIO is not set then PerlIO_xxx() are real functions
30 defined in perlio.c which implement extra functionality
31 required for utf8 support.
32
33 One further note - the table-of-functions scheme controlled
34 by PERL_IMPLICIT_SYS turns on USE_PERLIO so that iperlsys.h can
35 #define PerlIO_xxx() to go via the function table, without having
36 to #undef them from (say) stdio forms.
37
38*/
39
40#if defined(PERL_IMPLICIT_SYS)
41#ifndef USE_PERLIO
2986a63f 42#ifndef NETWARE
2cbbe5a1 43/* # define USE_PERLIO */
76ced9ad
NIS
44#endif
45#endif
2986a63f 46#endif
76ced9ad
NIS
47
48#ifndef USE_PERLIO
49# define USE_STDIO
50#endif
51
52#ifdef USE_STDIO
53# ifndef PERLIO_IS_STDIO
54# define PERLIO_IS_STDIO
55# endif
56#endif
57
58/* -------------------- End of Configure controls ---------------------------- */
59
60/*
61 * Although we may not want stdio to be used including <stdio.h> here
62 * avoids issues where stdio.h has strange side effects
63 */
64#include <stdio.h>
65
2a15cca7
JH
66#ifdef __BEOS__
67int fseeko(FILE *stream, off_t offset, int whence);
68off_t ftello(FILE *stream);
69#endif
70
76ced9ad
NIS
71#if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64)
72#define ftell ftello
73#endif
74
75#if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64)
76#define fseek fseeko
77#endif
78
6f2bd249
JH
79/* BS2000 includes are sometimes a bit non standard :-( */
80#if defined(POSIX_BC) && defined(O_BINARY) && !defined(O_TEXT)
81#undef O_BINARY
82#endif
83
76ced9ad
NIS
84#ifdef PERLIO_IS_STDIO
85/* #define PerlIO_xxxx() as equivalent stdio function */
86#include "perlsdio.h"
14a5cf38 87#else /* PERLIO_IS_STDIO */
76ced9ad
NIS
88#ifdef USE_SFIO
89/* #define PerlIO_xxxx() as equivalent sfio function */
90#include "perlsfio.h"
14a5cf38
JH
91#endif /* USE_SFIO */
92#endif /* PERLIO_IS_STDIO */
76ced9ad
NIS
93
94#ifndef PerlIO
95/* ----------- PerlIO implementation ---------- */
96/* PerlIO not #define-d to something else - define the implementation */
97
98typedef struct _PerlIO PerlIOl;
99typedef struct _PerlIO_funcs PerlIO_funcs;
100typedef PerlIOl *PerlIO;
101#define PerlIO PerlIO
a1d180c4 102#define PERLIO_LAYERS 1
76ced9ad 103
14a5cf38
JH
104extern void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab);
105extern PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name, STRLEN len,
106 int load);
107extern PerlIO *PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab,
108 const char *mode, SV *arg);
109extern void PerlIO_pop(pTHX_ PerlIO *f);
39f7a870 110extern AV* PerlIO_get_layers(pTHX_ PerlIO *f);
3a1ee7e8 111extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param);
76ced9ad 112
14a5cf38 113#endif /* PerlIO */
76ced9ad
NIS
114
115/* ----------- End of implementation choices ---------- */
116
117#ifndef PERLIO_IS_STDIO
118/* Not using stdio _directly_ as PerlIO */
119
120/* We now need to determine what happens if source trys to use stdio.
121 * There are three cases based on PERLIO_NOT_STDIO which XS code
122 * can set how it wants.
123 */
124
125#ifdef PERL_CORE
126/* Make a choice for perl core code
127 - currently this is set to try and catch lingering raw stdio calls.
128 This is a known issue with some non UNIX ports which still use
129 "native" stdio features.
130*/
131#ifndef PERLIO_NOT_STDIO
132#define PERLIO_NOT_STDIO 1
133#endif
f7e7eb72
NIS
134#else
135#ifndef PERLIO_NOT_STDIO
136#define PERLIO_NOT_STDIO 0
137#endif
76ced9ad
NIS
138#endif
139
140#ifdef PERLIO_NOT_STDIO
141#if PERLIO_NOT_STDIO
142/*
143 * PERLIO_NOT_STDIO #define'd as 1
144 * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors
145 */
146#include "nostdio.h"
14a5cf38 147#else /* if PERLIO_NOT_STDIO */
76ced9ad
NIS
148/*
149 * PERLIO_NOT_STDIO #define'd as 0
150 * Case 2: Declares that both PerlIO and stdio can be used
151 */
14a5cf38
JH
152#endif /* if PERLIO_NOT_STDIO */
153#else /* ifdef PERLIO_NOT_STDIO */
76ced9ad
NIS
154/*
155 * PERLIO_NOT_STDIO not defined
156 * Case 3: Try and fake stdio calls as PerlIO calls
157 */
158#include "fakesdio.h"
14a5cf38
JH
159#endif /* ifndef PERLIO_NOT_STDIO */
160#endif /* PERLIO_IS_STDIO */
76ced9ad 161
b47b7e59 162#define specialCopIO(sv) ((sv) == Nullsv)
ac27b0f5 163
76ced9ad
NIS
164/* ----------- fill in things that have not got #define'd ---------- */
165
166#ifndef Fpos_t
167#define Fpos_t Off_t
168#endif
169
170#ifndef EOF
171#define EOF (-1)
172#endif
173
174/* This is to catch case with no stdio */
175#ifndef BUFSIZ
176#define BUFSIZ 1024
177#endif
178
179#ifndef SEEK_SET
180#define SEEK_SET 0
181#endif
182
183#ifndef SEEK_CUR
184#define SEEK_CUR 1
185#endif
186
187#ifndef SEEK_END
188#define SEEK_END 2
189#endif
190
ecdeb87c
NIS
191#define PERLIO_DUP_CLONE 1
192#define PERLIO_DUP_FD 2
193
76ced9ad
NIS
194/* --------------------- Now prototypes for functions --------------- */
195
adb71456 196START_EXTERN_C
76ced9ad 197#ifndef NEXT30_NO_ATTRIBUTE
14a5cf38
JH
198#ifndef HASATTRIBUTE /* disable GNU-cc attribute checking? */
199#ifdef __attribute__ /* Avoid possible redefinition errors */
76ced9ad
NIS
200#undef __attribute__
201#endif
202#define __attribute__(attr)
203#endif
204#endif
76ced9ad 205#ifndef PerlIO_init
3a1ee7e8 206extern void PerlIO_init(pTHX);
76ced9ad
NIS
207#endif
208#ifndef PerlIO_stdoutf
14a5cf38 209extern int PerlIO_stdoutf(const char *, ...)
1e56004e
RB
210#ifdef CHECK_FORMAT
211 __attribute__ ((__format__(__printf__, 1, 2)))
212#endif
213;
76ced9ad
NIS
214#endif
215#ifndef PerlIO_puts
14a5cf38 216extern int PerlIO_puts(PerlIO *, const char *);
76ced9ad
NIS
217#endif
218#ifndef PerlIO_open
14a5cf38 219extern PerlIO *PerlIO_open(const char *, const char *);
76ced9ad 220#endif
6e60e805 221#ifndef PerlIO_openn
14a5cf38
JH
222extern PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode,
223 int fd, int imode, int perm, PerlIO *old,
224 int narg, SV **arg);
ee518936 225#endif
76ced9ad 226#ifndef PerlIO_eof
14a5cf38 227extern int PerlIO_eof(PerlIO *);
76ced9ad
NIS
228#endif
229#ifndef PerlIO_error
14a5cf38 230extern int PerlIO_error(PerlIO *);
76ced9ad
NIS
231#endif
232#ifndef PerlIO_clearerr
14a5cf38 233extern void PerlIO_clearerr(PerlIO *);
76ced9ad
NIS
234#endif
235#ifndef PerlIO_getc
14a5cf38 236extern int PerlIO_getc(PerlIO *);
76ced9ad
NIS
237#endif
238#ifndef PerlIO_putc
14a5cf38 239extern int PerlIO_putc(PerlIO *, int);
76ced9ad 240#endif
76ced9ad 241#ifndef PerlIO_ungetc
14a5cf38 242extern int PerlIO_ungetc(PerlIO *, int);
76ced9ad 243#endif
76ced9ad 244#ifndef PerlIO_fdopen
14a5cf38 245extern PerlIO *PerlIO_fdopen(int, const char *);
76ced9ad
NIS
246#endif
247#ifndef PerlIO_importFILE
4b069b44 248extern PerlIO *PerlIO_importFILE(FILE *, const char *);
76ced9ad
NIS
249#endif
250#ifndef PerlIO_exportFILE
4b069b44 251extern FILE *PerlIO_exportFILE(PerlIO *, const char *);
76ced9ad
NIS
252#endif
253#ifndef PerlIO_findFILE
14a5cf38 254extern FILE *PerlIO_findFILE(PerlIO *);
76ced9ad
NIS
255#endif
256#ifndef PerlIO_releaseFILE
14a5cf38 257extern void PerlIO_releaseFILE(PerlIO *, FILE *);
76ced9ad
NIS
258#endif
259#ifndef PerlIO_read
14a5cf38 260extern SSize_t PerlIO_read(PerlIO *, void *, Size_t);
76ced9ad 261#endif
a15cef0c 262#ifndef PerlIO_unread
14a5cf38 263extern SSize_t PerlIO_unread(PerlIO *, const void *, Size_t);
a15cef0c 264#endif
76ced9ad 265#ifndef PerlIO_write
14a5cf38 266extern SSize_t PerlIO_write(PerlIO *, const void *, Size_t);
76ced9ad
NIS
267#endif
268#ifndef PerlIO_setlinebuf
14a5cf38 269extern void PerlIO_setlinebuf(PerlIO *);
76ced9ad
NIS
270#endif
271#ifndef PerlIO_printf
14a5cf38 272extern int PerlIO_printf(PerlIO *, const char *, ...)
1e56004e
RB
273#ifdef CHECK_FORMAT
274 __attribute__ ((__format__(__printf__, 2, 3)))
275#endif
276;
76ced9ad
NIS
277#endif
278#ifndef PerlIO_sprintf
14a5cf38 279extern int PerlIO_sprintf(char *, int, const char *, ...)
1e56004e
RB
280#ifdef CHECK_FORMAT
281 __attribute__ ((__format__(__printf__, 3, 4)))
282#endif
283;
76ced9ad
NIS
284#endif
285#ifndef PerlIO_vprintf
14a5cf38 286extern int PerlIO_vprintf(PerlIO *, const char *, va_list);
76ced9ad
NIS
287#endif
288#ifndef PerlIO_tell
14a5cf38 289extern Off_t PerlIO_tell(PerlIO *);
76ced9ad
NIS
290#endif
291#ifndef PerlIO_seek
14a5cf38 292extern int PerlIO_seek(PerlIO *, Off_t, int);
76ced9ad
NIS
293#endif
294#ifndef PerlIO_rewind
14a5cf38 295extern void PerlIO_rewind(PerlIO *);
76ced9ad
NIS
296#endif
297#ifndef PerlIO_has_base
14a5cf38 298extern int PerlIO_has_base(PerlIO *);
76ced9ad
NIS
299#endif
300#ifndef PerlIO_has_cntptr
14a5cf38 301extern int PerlIO_has_cntptr(PerlIO *);
76ced9ad
NIS
302#endif
303#ifndef PerlIO_fast_gets
14a5cf38 304extern int PerlIO_fast_gets(PerlIO *);
76ced9ad
NIS
305#endif
306#ifndef PerlIO_canset_cnt
14a5cf38 307extern int PerlIO_canset_cnt(PerlIO *);
76ced9ad
NIS
308#endif
309#ifndef PerlIO_get_ptr
14a5cf38 310extern STDCHAR *PerlIO_get_ptr(PerlIO *);
76ced9ad
NIS
311#endif
312#ifndef PerlIO_get_cnt
14a5cf38 313extern int PerlIO_get_cnt(PerlIO *);
76ced9ad
NIS
314#endif
315#ifndef PerlIO_set_cnt
14a5cf38 316extern void PerlIO_set_cnt(PerlIO *, int);
76ced9ad
NIS
317#endif
318#ifndef PerlIO_set_ptrcnt
14a5cf38 319extern void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, int);
76ced9ad
NIS
320#endif
321#ifndef PerlIO_get_base
14a5cf38 322extern STDCHAR *PerlIO_get_base(PerlIO *);
76ced9ad
NIS
323#endif
324#ifndef PerlIO_get_bufsiz
14a5cf38 325extern int PerlIO_get_bufsiz(PerlIO *);
76ced9ad
NIS
326#endif
327#ifndef PerlIO_tmpfile
14a5cf38 328extern PerlIO *PerlIO_tmpfile(void);
76ced9ad
NIS
329#endif
330#ifndef PerlIO_stdin
14a5cf38 331extern PerlIO *PerlIO_stdin(void);
76ced9ad
NIS
332#endif
333#ifndef PerlIO_stdout
14a5cf38 334extern PerlIO *PerlIO_stdout(void);
76ced9ad
NIS
335#endif
336#ifndef PerlIO_stderr
14a5cf38 337extern PerlIO *PerlIO_stderr(void);
76ced9ad
NIS
338#endif
339#ifndef PerlIO_getpos
14a5cf38 340extern int PerlIO_getpos(PerlIO *, SV *);
76ced9ad
NIS
341#endif
342#ifndef PerlIO_setpos
14a5cf38 343extern int PerlIO_setpos(PerlIO *, SV *);
76ced9ad
NIS
344#endif
345#ifndef PerlIO_fdupopen
ecdeb87c 346extern PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *, int);
5f1a76d0 347#endif
11ae941d 348#if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO)
14a5cf38 349extern char *PerlIO_modestr(PerlIO *, char *buf);
76ced9ad
NIS
350#endif
351#ifndef PerlIO_isutf8
14a5cf38 352extern int PerlIO_isutf8(PerlIO *);
76ced9ad 353#endif
156e9b51 354#ifndef PerlIO_apply_layers
14a5cf38
JH
355extern int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode,
356 const char *names);
60382766
NIS
357#endif
358#ifndef PerlIO_binmode
14a5cf38
JH
359extern int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode,
360 const char *names);
ac27b0f5 361#endif
a15cef0c 362#ifndef PerlIO_getname
14a5cf38 363extern char *PerlIO_getname(PerlIO *, char *);
a15cef0c 364#endif
76ced9ad 365
13621cfb
NIS
366extern void PerlIO_destruct(pTHX);
367
06c7082d
NIS
368extern int PerlIO_intmode2str(int rawmode, char *mode, int *writing);
369
3a1ee7e8
NIS
370#ifdef PERLIO_LAYERS
371extern void PerlIO_cleanup(pTHX);
adb71456 372
14a5cf38 373extern void PerlIO_debug(const char *fmt, ...);
3a1ee7e8
NIS
374typedef struct PerlIO_list_s PerlIO_list_t;
375
88b61e10 376
11ae941d
CB
377#endif
378
adb71456 379END_EXTERN_C
14a5cf38 380#endif /* _PERLIO_H */