Socket::my_inet_aton() tweak
[p5sagit/p5-mst-13.2.git] / perlio.h
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
33 #ifndef NETWARE
34 # define USE_PERLIO
35 #endif
36 #endif
37 #endif
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 #ifdef __BEOS__
58 int fseeko(FILE *stream, off_t offset, int whence);
59 off_t ftello(FILE *stream);
60 #endif
61
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
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
75 #ifdef PERLIO_IS_STDIO
76 /* #define PerlIO_xxxx() as equivalent stdio function */
77 #include "perlsdio.h"
78 #else                           /* PERLIO_IS_STDIO */
79 #ifdef USE_SFIO
80 /* #define PerlIO_xxxx() as equivalent sfio function */
81 #include "perlsfio.h"
82 #endif                          /* USE_SFIO */
83 #endif                          /* PERLIO_IS_STDIO */
84
85 #ifndef PerlIO
86 /* ----------- PerlIO implementation ---------- */
87 /* PerlIO not #define-d to something else - define the implementation */
88
89 typedef struct _PerlIO PerlIOl;
90 typedef struct _PerlIO_funcs PerlIO_funcs;
91 typedef PerlIOl *PerlIO;
92 #define PerlIO PerlIO
93 #define PERLIO_LAYERS 1
94
95 extern void PerlIO_define_layer(pTHX_ PerlIO_funcs *tab);
96 extern PerlIO_funcs *PerlIO_find_layer(pTHX_ const char *name, STRLEN len,
97                                        int load);
98 extern PerlIO *PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab,
99                            const char *mode, SV *arg);
100 extern void PerlIO_pop(pTHX_ PerlIO *f);
101 extern void PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param);
102
103 #endif                          /* PerlIO */
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
124 #else
125 #ifndef PERLIO_NOT_STDIO
126 #define PERLIO_NOT_STDIO 0
127 #endif
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"
137 #else                           /* if PERLIO_NOT_STDIO */
138 /*
139  * PERLIO_NOT_STDIO #define'd as 0
140  * Case 2: Declares that both PerlIO and stdio can be used
141  */
142 #endif                          /* if PERLIO_NOT_STDIO */
143 #else                           /* ifdef PERLIO_NOT_STDIO */
144 /*
145  * PERLIO_NOT_STDIO not defined
146  * Case 3: Try and fake stdio calls as PerlIO calls
147  */
148 #include "fakesdio.h"
149 #endif                          /* ifndef PERLIO_NOT_STDIO */
150 #endif                          /* PERLIO_IS_STDIO */
151
152 #define specialCopIO(sv) ((sv) != Nullsv)
153
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 #define PERLIO_DUP_CLONE        1
182 #define PERLIO_DUP_FD           2
183
184 /* --------------------- Now prototypes for functions --------------- */
185
186 START_EXTERN_C
187 #ifndef NEXT30_NO_ATTRIBUTE
188 #ifndef HASATTRIBUTE            /* disable GNU-cc attribute checking? */
189 #ifdef  __attribute__           /* Avoid possible redefinition errors */
190 #undef  __attribute__
191 #endif
192 #define __attribute__(attr)
193 #endif
194 #endif
195 #ifndef PerlIO_init
196 extern void PerlIO_init(pTHX);
197 #endif
198 #ifndef PerlIO_stdoutf
199 extern int PerlIO_stdoutf(const char *, ...)
200     __attribute__ ((__format__(__printf__, 1, 2)));
201 #endif
202 #ifndef PerlIO_puts
203 extern int PerlIO_puts(PerlIO *, const char *);
204 #endif
205 #ifndef PerlIO_open
206 extern PerlIO *PerlIO_open(const char *, const char *);
207 #endif
208 #ifndef PerlIO_openn
209 extern PerlIO *PerlIO_openn(pTHX_ const char *layers, const char *mode,
210                             int fd, int imode, int perm, PerlIO *old,
211                             int narg, SV **arg);
212 #endif
213 #ifndef PerlIO_close
214 extern int PerlIO_close(PerlIO *);
215 #endif
216 #ifndef PerlIO_eof
217 extern int PerlIO_eof(PerlIO *);
218 #endif
219 #ifndef PerlIO_error
220 extern int PerlIO_error(PerlIO *);
221 #endif
222 #ifndef PerlIO_clearerr
223 extern void PerlIO_clearerr(PerlIO *);
224 #endif
225 #ifndef PerlIO_getc
226 extern int PerlIO_getc(PerlIO *);
227 #endif
228 #ifndef PerlIO_putc
229 extern int PerlIO_putc(PerlIO *, int);
230 #endif
231 #ifndef PerlIO_flush
232 extern int PerlIO_flush(PerlIO *);
233 #endif
234 #ifndef PerlIO_ungetc
235 extern int PerlIO_ungetc(PerlIO *, int);
236 #endif
237 #ifndef PerlIO_fileno
238 extern int PerlIO_fileno(PerlIO *);
239 #endif
240 #ifndef PerlIO_fdopen
241 extern PerlIO *PerlIO_fdopen(int, const char *);
242 #endif
243 #ifndef PerlIO_importFILE
244 extern PerlIO *PerlIO_importFILE(FILE *, int);
245 #endif
246 #ifndef PerlIO_exportFILE
247 extern FILE *PerlIO_exportFILE(PerlIO *, int);
248 #endif
249 #ifndef PerlIO_findFILE
250 extern FILE *PerlIO_findFILE(PerlIO *);
251 #endif
252 #ifndef PerlIO_releaseFILE
253 extern void PerlIO_releaseFILE(PerlIO *, FILE *);
254 #endif
255 #ifndef PerlIO_read
256 extern SSize_t PerlIO_read(PerlIO *, void *, Size_t);
257 #endif
258 #ifndef PerlIO_unread
259 extern SSize_t PerlIO_unread(PerlIO *, const void *, Size_t);
260 #endif
261 #ifndef PerlIO_write
262 extern SSize_t PerlIO_write(PerlIO *, const void *, Size_t);
263 #endif
264 #ifndef PerlIO_setlinebuf
265 extern void PerlIO_setlinebuf(PerlIO *);
266 #endif
267 #ifndef PerlIO_printf
268 extern int PerlIO_printf(PerlIO *, const char *, ...)
269     __attribute__ ((__format__(__printf__, 2, 3)));
270 #endif
271 #ifndef PerlIO_sprintf
272 extern int PerlIO_sprintf(char *, int, const char *, ...)
273     __attribute__ ((__format__(__printf__, 3, 4)));
274 #endif
275 #ifndef PerlIO_vprintf
276 extern int PerlIO_vprintf(PerlIO *, const char *, va_list);
277 #endif
278 #ifndef PerlIO_tell
279 extern Off_t PerlIO_tell(PerlIO *);
280 #endif
281 #ifndef PerlIO_seek
282 extern int PerlIO_seek(PerlIO *, Off_t, int);
283 #endif
284 #ifndef PerlIO_rewind
285 extern void PerlIO_rewind(PerlIO *);
286 #endif
287 #ifndef PerlIO_has_base
288 extern int PerlIO_has_base(PerlIO *);
289 #endif
290 #ifndef PerlIO_has_cntptr
291 extern int PerlIO_has_cntptr(PerlIO *);
292 #endif
293 #ifndef PerlIO_fast_gets
294 extern int PerlIO_fast_gets(PerlIO *);
295 #endif
296 #ifndef PerlIO_canset_cnt
297 extern int PerlIO_canset_cnt(PerlIO *);
298 #endif
299 #ifndef PerlIO_get_ptr
300 extern STDCHAR *PerlIO_get_ptr(PerlIO *);
301 #endif
302 #ifndef PerlIO_get_cnt
303 extern int PerlIO_get_cnt(PerlIO *);
304 #endif
305 #ifndef PerlIO_set_cnt
306 extern void PerlIO_set_cnt(PerlIO *, int);
307 #endif
308 #ifndef PerlIO_set_ptrcnt
309 extern void PerlIO_set_ptrcnt(PerlIO *, STDCHAR *, int);
310 #endif
311 #ifndef PerlIO_get_base
312 extern STDCHAR *PerlIO_get_base(PerlIO *);
313 #endif
314 #ifndef PerlIO_get_bufsiz
315 extern int PerlIO_get_bufsiz(PerlIO *);
316 #endif
317 #ifndef PerlIO_tmpfile
318 extern PerlIO *PerlIO_tmpfile(void);
319 #endif
320 #ifndef PerlIO_stdin
321 extern PerlIO *PerlIO_stdin(void);
322 #endif
323 #ifndef PerlIO_stdout
324 extern PerlIO *PerlIO_stdout(void);
325 #endif
326 #ifndef PerlIO_stderr
327 extern PerlIO *PerlIO_stderr(void);
328 #endif
329 #ifndef PerlIO_getpos
330 extern int PerlIO_getpos(PerlIO *, SV *);
331 #endif
332 #ifndef PerlIO_setpos
333 extern int PerlIO_setpos(PerlIO *, SV *);
334 #endif
335 #ifndef PerlIO_fdupopen
336 extern PerlIO *PerlIO_fdupopen(pTHX_ PerlIO *, CLONE_PARAMS *, int);
337 #endif
338 #if !defined(PerlIO_modestr) && !defined(PERLIO_IS_STDIO)
339 extern char *PerlIO_modestr(PerlIO *, char *buf);
340 #endif
341 #ifndef PerlIO_isutf8
342 extern int PerlIO_isutf8(PerlIO *);
343 #endif
344 #ifndef PerlIO_apply_layers
345 extern int PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode,
346                                const char *names);
347 #endif
348 #ifndef PerlIO_binmode
349 extern int PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int omode,
350                           const char *names);
351 #endif
352 #ifndef PerlIO_getname
353 extern char *PerlIO_getname(PerlIO *, char *);
354 #endif
355
356 extern void PerlIO_destruct(pTHX);
357
358 extern int PerlIO_intmode2str(int rawmode, char *mode, int *writing);
359
360 #ifdef PERLIO_LAYERS
361 extern void PerlIO_cleanup(pTHX);
362
363 extern void PerlIO_debug(const char *fmt, ...);
364 typedef struct PerlIO_list_s PerlIO_list_t;
365
366
367 #endif
368
369 END_EXTERN_C
370 #endif                          /* _PERLIO_H */