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