This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix 'mmap' lib/filehand.t (ungetc) test fail.
[perl5.git] / perliol.h
1 #ifndef _PERLIOL_H
2 #define _PERLIOL_H
3
4 struct _PerlIO_funcs
5 {
6  char *         name;
7  Size_t         size;
8  IV             kind;
9  IV             (*Fileno)(PerlIO *f);
10  PerlIO *       (*Fdopen)(PerlIO_funcs *tab, int fd, const char *mode);
11  PerlIO *       (*Open)(PerlIO_funcs *tab, const char *path, const char *mode);
12  int            (*Reopen)(const char *path, const char *mode, PerlIO *f);
13  IV             (*Pushed)(PerlIO *f,const char *mode);
14  IV             (*Popped)(PerlIO *f);
15  /* Unix-like functions - cf sfio line disciplines */
16  SSize_t        (*Read)(PerlIO *f, void *vbuf, Size_t count);
17  SSize_t        (*Unread)(PerlIO *f, const void *vbuf, Size_t count);
18  SSize_t        (*Write)(PerlIO *f, const void *vbuf, Size_t count);
19  IV             (*Seek)(PerlIO *f, Off_t offset, int whence);
20  Off_t          (*Tell)(PerlIO *f);
21  IV             (*Close)(PerlIO *f);
22  /* Stdio-like buffered IO functions */
23  IV             (*Flush)(PerlIO *f);
24  IV             (*Fill)(PerlIO *f);
25  IV             (*Eof)(PerlIO *f);
26  IV             (*Error)(PerlIO *f);
27  void           (*Clearerr)(PerlIO *f);
28  void           (*Setlinebuf)(PerlIO *f);
29  /* Perl's snooping functions */
30  STDCHAR *      (*Get_base)(PerlIO *f);
31  Size_t         (*Get_bufsiz)(PerlIO *f);
32  STDCHAR *      (*Get_ptr)(PerlIO *f);
33  SSize_t        (*Get_cnt)(PerlIO *f);
34  void           (*Set_ptrcnt)(PerlIO *f,STDCHAR *ptr,SSize_t cnt);
35 };
36
37 /*--------------------------------------------------------------------------------------*/
38 /* Kind values */
39 #define PERLIO_K_RAW            0x00000001
40 #define PERLIO_K_BUFFERED       0x00000002
41 #define PERLIO_K_CANCRLF        0x00000004
42 #define PERLIO_K_FASTGETS       0x00000008
43
44 /*--------------------------------------------------------------------------------------*/
45 struct _PerlIO
46 {
47  PerlIOl *      next;       /* Lower layer */
48  PerlIO_funcs * tab;        /* Functions for this layer */
49  IV             flags;      /* Various flags for state */
50 };
51
52 /*--------------------------------------------------------------------------------------*/
53
54 /* Flag values */
55 #define PERLIO_F_EOF            0x00000100
56 #define PERLIO_F_CANWRITE       0x00000200
57 #define PERLIO_F_CANREAD        0x00000400
58 #define PERLIO_F_ERROR          0x00000800
59 #define PERLIO_F_TRUNCATE       0x00001000
60 #define PERLIO_F_APPEND         0x00002000
61 #define PERLIO_F_CRLF           0x00004000
62 #define PERLIO_F_UTF8           0x00008000
63 #define PERLIO_F_UNBUF          0x00010000
64 #define PERLIO_F_WRBUF          0x00020000
65 #define PERLIO_F_RDBUF          0x00040000
66 #define PERLIO_F_LINEBUF        0x00080000
67 #define PERLIO_F_TEMP           0x00100000
68 #define PERLIO_F_OPEN           0x00200000
69 #define PERLIO_F_FASTGETS       0x00400000
70
71 #define PerlIOBase(f)      (*(f))
72 #define PerlIOSelf(f,type) ((type *)PerlIOBase(f))
73 #define PerlIONext(f)      (&(PerlIOBase(f)->next))
74
75 /*--------------------------------------------------------------------------------------*/
76
77 extern PerlIO_funcs PerlIO_unix;
78 extern PerlIO_funcs PerlIO_perlio;
79 extern PerlIO_funcs PerlIO_stdio;
80 extern PerlIO_funcs PerlIO_crlf;
81 #ifdef HAS_MMAP
82 extern PerlIO_funcs PerlIO_mmap;
83 #endif
84
85 extern PerlIO *PerlIO_allocate(void);
86
87 #if O_BINARY != O_TEXT
88 #define PERLIO_STDTEXT "t"
89 #else
90 #define PERLIO_STDTEXT ""
91 #endif
92
93 /*--------------------------------------------------------------------------------------*/
94 /* Generic, or stub layer functions */
95
96 extern IV       PerlIOBase_fileno    (PerlIO *f);
97 extern IV       PerlIOBase_pushed    (PerlIO *f, const char *mode);
98 extern IV       PerlIOBase_popped    (PerlIO *f);
99 extern SSize_t  PerlIOBase_unread    (PerlIO *f, const void *vbuf, Size_t count);
100 extern IV       PerlIOBase_eof       (PerlIO *f);
101 extern IV       PerlIOBase_error     (PerlIO *f);
102 extern void     PerlIOBase_clearerr  (PerlIO *f);
103 extern IV       PerlIOBase_flush     (PerlIO *f);
104 extern IV       PerlIOBase_fill      (PerlIO *f);
105 extern IV       PerlIOBase_close     (PerlIO *f);
106 extern void     PerlIOBase_setlinebuf(PerlIO *f);
107
108 extern IV       PerlIOBase_noop_ok   (PerlIO *f);
109 extern IV       PerlIOBase_noop_fail (PerlIO *f);
110
111 /*--------------------------------------------------------------------------------------*/
112 /* perlio buffer layer
113    As this is reasonably generic its struct and "methods" are declared here
114    so they can be used to "inherit" from it.
115 */
116
117 typedef struct
118 {
119  struct _PerlIO base;       /* Base "class" info */
120  STDCHAR *      buf;        /* Start of buffer */
121  STDCHAR *      end;        /* End of valid part of buffer */
122  STDCHAR *      ptr;        /* Current position in buffer */
123  Off_t          posn;       /* Offset of buf into the file */
124  Size_t         bufsiz;     /* Real size of buffer */
125  IV             oneword;    /* Emergency buffer */
126 } PerlIOBuf;
127
128 extern PerlIO * PerlIOBuf_fdopen     (PerlIO_funcs *self, int fd, const char *mode);
129 extern PerlIO * PerlIOBuf_open       (PerlIO_funcs *self, const char *path, const char *mode);
130 extern int      PerlIOBuf_reopen     (const char *path, const char *mode, PerlIO *f);
131 extern SSize_t  PerlIOBuf_read       (PerlIO *f, void *vbuf, Size_t count);
132 extern SSize_t  PerlIOBuf_unread     (PerlIO *f, const void *vbuf, Size_t count);
133 extern SSize_t  PerlIOBuf_write      (PerlIO *f, const void *vbuf, Size_t count);
134 extern IV       PerlIOBuf_seek       (PerlIO *f, Off_t offset, int whence);
135 extern Off_t    PerlIOBuf_tell       (PerlIO *f);
136 extern IV       PerlIOBuf_close      (PerlIO *f);
137 extern IV       PerlIOBuf_flush      (PerlIO *f);
138 extern IV       PerlIOBuf_fill       (PerlIO *f);
139 extern void     PerlIOBuf_setlinebuf (PerlIO *f);
140 extern STDCHAR *PerlIOBuf_get_base   (PerlIO *f);
141 extern Size_t   PerlIOBuf_bufsiz     (PerlIO *f);
142 extern STDCHAR *PerlIOBuf_get_ptr    (PerlIO *f);
143 extern SSize_t  PerlIOBuf_get_cnt    (PerlIO *f);
144 extern void     PerlIOBuf_set_ptrcnt (PerlIO *f, STDCHAR *ptr, SSize_t cnt);
145
146 /*--------------------------------------------------------------------------------------*/
147
148 #endif /* _PERLIOL_H */