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