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