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