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