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 |
33 | # define USE_PERLIO |
34 | #endif |
35 | #endif |
36 | |
37 | #ifndef USE_PERLIO |
38 | # define USE_STDIO |
39 | #endif |
40 | |
41 | #ifdef USE_STDIO |
42 | # ifndef PERLIO_IS_STDIO |
43 | # define PERLIO_IS_STDIO |
44 | # endif |
45 | #endif |
46 | |
47 | /* -------------------- End of Configure controls ---------------------------- */ |
48 | |
49 | /* |
50 | * Although we may not want stdio to be used including <stdio.h> here |
51 | * avoids issues where stdio.h has strange side effects |
52 | */ |
53 | #include <stdio.h> |
54 | |
55 | #if defined(USE_64_BIT_STDIO) && defined(HAS_FTELLO) && !defined(USE_FTELL64) |
56 | #define ftell ftello |
57 | #endif |
58 | |
59 | #if defined(USE_64_BIT_STDIO) && defined(HAS_FSEEKO) && !defined(USE_FSEEK64) |
60 | #define fseek fseeko |
61 | #endif |
62 | |
63 | #ifdef PERLIO_IS_STDIO |
64 | /* #define PerlIO_xxxx() as equivalent stdio function */ |
65 | #include "perlsdio.h" |
66 | #else /* PERLIO_IS_STDIO */ |
67 | #ifdef USE_SFIO |
68 | /* #define PerlIO_xxxx() as equivalent sfio function */ |
69 | #include "perlsfio.h" |
70 | #endif /* USE_SFIO */ |
71 | #endif /* PERLIO_IS_STDIO */ |
72 | |
73 | #ifndef PerlIO |
74 | /* ----------- PerlIO implementation ---------- */ |
75 | /* PerlIO not #define-d to something else - define the implementation */ |
76 | |
77 | typedef struct _PerlIO PerlIOl; |
78 | typedef struct _PerlIO_funcs PerlIO_funcs; |
79 | typedef PerlIOl *PerlIO; |
80 | #define PerlIO PerlIO |
81 | |
82 | extern void PerlIO_define_layer (PerlIO_funcs *tab); |
83 | extern PerlIO * PerlIO_push (PerlIO *f,PerlIO_funcs *tab,const char *mode); |
84 | extern void PerlIO_pop (PerlIO *f); |
85 | |
86 | #endif /* PerlIO */ |
87 | |
88 | /* ----------- End of implementation choices ---------- */ |
89 | |
90 | #ifndef PERLIO_IS_STDIO |
91 | /* Not using stdio _directly_ as PerlIO */ |
92 | |
93 | /* We now need to determine what happens if source trys to use stdio. |
94 | * There are three cases based on PERLIO_NOT_STDIO which XS code |
95 | * can set how it wants. |
96 | */ |
97 | |
98 | #ifdef PERL_CORE |
99 | /* Make a choice for perl core code |
100 | - currently this is set to try and catch lingering raw stdio calls. |
101 | This is a known issue with some non UNIX ports which still use |
102 | "native" stdio features. |
103 | */ |
104 | #ifndef PERLIO_NOT_STDIO |
105 | #define PERLIO_NOT_STDIO 1 |
106 | #endif |
107 | #endif |
108 | |
109 | #ifdef PERLIO_NOT_STDIO |
110 | #if PERLIO_NOT_STDIO |
111 | /* |
112 | * PERLIO_NOT_STDIO #define'd as 1 |
113 | * Case 1: Strong denial of stdio - make all stdio calls (we can think of) errors |
114 | */ |
115 | #include "nostdio.h" |
116 | #else /* if PERLIO_NOT_STDIO */ |
117 | /* |
118 | * PERLIO_NOT_STDIO #define'd as 0 |
119 | * Case 2: Declares that both PerlIO and stdio can be used |
120 | */ |
121 | #endif /* if PERLIO_NOT_STDIO */ |
122 | #else /* ifdef PERLIO_NOT_STDIO */ |
123 | /* |
124 | * PERLIO_NOT_STDIO not defined |
125 | * Case 3: Try and fake stdio calls as PerlIO calls |
126 | */ |
127 | #include "fakesdio.h" |
128 | #endif /* ifndef PERLIO_NOT_STDIO */ |
129 | #endif /* PERLIO_IS_STDIO */ |
130 | |
131 | /* ----------- fill in things that have not got #define'd ---------- */ |
132 | |
133 | #ifndef Fpos_t |
134 | #define Fpos_t Off_t |
135 | #endif |
136 | |
137 | #ifndef EOF |
138 | #define EOF (-1) |
139 | #endif |
140 | |
141 | /* This is to catch case with no stdio */ |
142 | #ifndef BUFSIZ |
143 | #define BUFSIZ 1024 |
144 | #endif |
145 | |
146 | #ifndef SEEK_SET |
147 | #define SEEK_SET 0 |
148 | #endif |
149 | |
150 | #ifndef SEEK_CUR |
151 | #define SEEK_CUR 1 |
152 | #endif |
153 | |
154 | #ifndef SEEK_END |
155 | #define SEEK_END 2 |
156 | #endif |
157 | |
158 | /* --------------------- Now prototypes for functions --------------- */ |
159 | |
160 | #ifndef NEXT30_NO_ATTRIBUTE |
161 | #ifndef HASATTRIBUTE /* disable GNU-cc attribute checking? */ |
162 | #ifdef __attribute__ /* Avoid possible redefinition errors */ |
163 | #undef __attribute__ |
164 | #endif |
165 | #define __attribute__(attr) |
166 | #endif |
167 | #endif |
168 | |
169 | #ifndef PerlIO_init |
170 | extern void PerlIO_init (void); |
171 | #endif |
172 | #ifndef PerlIO_stdoutf |
173 | extern int PerlIO_stdoutf (const char *,...) |
174 | __attribute__((__format__ (__printf__, 1, 2))); |
175 | #endif |
176 | #ifndef PerlIO_puts |
177 | extern int PerlIO_puts (PerlIO *,const char *); |
178 | #endif |
179 | #ifndef PerlIO_open |
180 | extern PerlIO * PerlIO_open (const char *,const char *); |
181 | #endif |
182 | #ifndef PerlIO_close |
183 | extern int PerlIO_close (PerlIO *); |
184 | #endif |
185 | #ifndef PerlIO_eof |
186 | extern int PerlIO_eof (PerlIO *); |
187 | #endif |
188 | #ifndef PerlIO_error |
189 | extern int PerlIO_error (PerlIO *); |
190 | #endif |
191 | #ifndef PerlIO_clearerr |
192 | extern void PerlIO_clearerr (PerlIO *); |
193 | #endif |
194 | #ifndef PerlIO_getc |
195 | extern int PerlIO_getc (PerlIO *); |
196 | #endif |
197 | #ifndef PerlIO_putc |
198 | extern int PerlIO_putc (PerlIO *,int); |
199 | #endif |
200 | #ifndef PerlIO_flush |
201 | extern int PerlIO_flush (PerlIO *); |
202 | #endif |
203 | #ifndef PerlIO_ungetc |
204 | extern int PerlIO_ungetc (PerlIO *,int); |
205 | #endif |
206 | #ifndef PerlIO_fileno |
207 | extern int PerlIO_fileno (PerlIO *); |
208 | #endif |
209 | #ifndef PerlIO_fdopen |
210 | extern PerlIO * PerlIO_fdopen (int, const char *); |
211 | #endif |
212 | #ifndef PerlIO_importFILE |
213 | extern PerlIO * PerlIO_importFILE (FILE *,int); |
214 | #endif |
215 | #ifndef PerlIO_exportFILE |
216 | extern FILE * PerlIO_exportFILE (PerlIO *,int); |
217 | #endif |
218 | #ifndef PerlIO_findFILE |
219 | extern FILE * PerlIO_findFILE (PerlIO *); |
220 | #endif |
221 | #ifndef PerlIO_releaseFILE |
222 | extern void PerlIO_releaseFILE (PerlIO *,FILE *); |
223 | #endif |
224 | #ifndef PerlIO_read |
225 | extern SSize_t PerlIO_read (PerlIO *,void *,Size_t); |
226 | #endif |
227 | #ifndef PerlIO_write |
228 | extern SSize_t PerlIO_write (PerlIO *,const void *,Size_t); |
229 | #endif |
230 | #ifndef PerlIO_setlinebuf |
231 | extern void PerlIO_setlinebuf (PerlIO *); |
232 | #endif |
233 | #ifndef PerlIO_printf |
234 | extern int PerlIO_printf (PerlIO *, const char *,...) |
235 | __attribute__((__format__ (__printf__, 2, 3))); |
236 | #endif |
237 | #ifndef PerlIO_sprintf |
238 | extern int PerlIO_sprintf (char *, int, const char *,...) |
239 | __attribute__((__format__ (__printf__, 3, 4))); |
240 | #endif |
241 | #ifndef PerlIO_vprintf |
242 | extern int PerlIO_vprintf (PerlIO *, const char *, va_list); |
243 | #endif |
244 | #ifndef PerlIO_tell |
245 | extern Off_t PerlIO_tell (PerlIO *); |
246 | #endif |
247 | #ifndef PerlIO_seek |
248 | extern int PerlIO_seek (PerlIO *, Off_t, int); |
249 | #endif |
250 | #ifndef PerlIO_rewind |
251 | extern void PerlIO_rewind (PerlIO *); |
252 | #endif |
253 | #ifndef PerlIO_has_base |
254 | extern int PerlIO_has_base (PerlIO *); |
255 | #endif |
256 | #ifndef PerlIO_has_cntptr |
257 | extern int PerlIO_has_cntptr (PerlIO *); |
258 | #endif |
259 | #ifndef PerlIO_fast_gets |
260 | extern int PerlIO_fast_gets (PerlIO *); |
261 | #endif |
262 | #ifndef PerlIO_canset_cnt |
263 | extern int PerlIO_canset_cnt (PerlIO *); |
264 | #endif |
265 | #ifndef PerlIO_get_ptr |
266 | extern STDCHAR * PerlIO_get_ptr (PerlIO *); |
267 | #endif |
268 | #ifndef PerlIO_get_cnt |
269 | extern int PerlIO_get_cnt (PerlIO *); |
270 | #endif |
271 | #ifndef PerlIO_set_cnt |
272 | extern void PerlIO_set_cnt (PerlIO *,int); |
273 | #endif |
274 | #ifndef PerlIO_set_ptrcnt |
275 | extern void PerlIO_set_ptrcnt (PerlIO *,STDCHAR *,int); |
276 | #endif |
277 | #ifndef PerlIO_get_base |
278 | extern STDCHAR * PerlIO_get_base (PerlIO *); |
279 | #endif |
280 | #ifndef PerlIO_get_bufsiz |
281 | extern int PerlIO_get_bufsiz (PerlIO *); |
282 | #endif |
283 | #ifndef PerlIO_tmpfile |
284 | extern PerlIO * PerlIO_tmpfile (void); |
285 | #endif |
286 | #ifndef PerlIO_stdin |
287 | extern PerlIO * PerlIO_stdin (void); |
288 | #endif |
289 | #ifndef PerlIO_stdout |
290 | extern PerlIO * PerlIO_stdout (void); |
291 | #endif |
292 | #ifndef PerlIO_stderr |
293 | extern PerlIO * PerlIO_stderr (void); |
294 | #endif |
295 | #ifndef PerlIO_getpos |
296 | extern int PerlIO_getpos (PerlIO *,Fpos_t *); |
297 | #endif |
298 | #ifndef PerlIO_setpos |
299 | extern int PerlIO_setpos (PerlIO *,const Fpos_t *); |
300 | #endif |
301 | #ifndef PerlIO_fdupopen |
302 | extern PerlIO * PerlIO_fdupopen (PerlIO *); |
303 | #endif |
304 | #ifndef PerlIO_isutf8 |
305 | extern int PerlIO_isutf8 (PerlIO *); |
306 | #endif |
307 | |
308 | #endif /* _PERLIO_H */ |