xref: /PHP-7.3/Zend/zend_stream.h (revision 8d3f8ca1)
1 /*
2    +----------------------------------------------------------------------+
3    | Zend Engine                                                          |
4    +----------------------------------------------------------------------+
5    | Copyright (c) 1998-2018 Zend Technologies Ltd. (http://www.zend.com) |
6    +----------------------------------------------------------------------+
7    | This source file is subject to version 2.00 of the Zend license,     |
8    | that is bundled with this package in the file LICENSE, and is        |
9    | available through the world-wide-web at the following url:           |
10    | http://www.zend.com/license/2_00.txt.                                |
11    | If you did not receive a copy of the Zend license and are unable to  |
12    | obtain it through the world-wide-web, please send a note to          |
13    | license@zend.com so we can mail you a copy immediately.              |
14    +----------------------------------------------------------------------+
15    | Authors: Wez Furlong <wez@thebrainroom.com>                          |
16    |          Scott MacVicar <scottmac@php.net>                           |
17    |          Nuno Lopes <nlopess@php.net>                                |
18    |          Marcus Boerger <helly@php.net>                              |
19    +----------------------------------------------------------------------+
20 */
21 
22 #ifndef ZEND_STREAM_H
23 #define ZEND_STREAM_H
24 
25 #include <sys/types.h>
26 #include <sys/stat.h>
27 
28 /* Lightweight stream implementation for the ZE scanners.
29  * These functions are private to the engine.
30  * */
31 typedef size_t (*zend_stream_fsizer_t)(void* handle);
32 typedef size_t (*zend_stream_reader_t)(void* handle, char *buf, size_t len);
33 typedef void   (*zend_stream_closer_t)(void* handle);
34 
35 #define ZEND_MMAP_AHEAD 32
36 
37 typedef enum {
38 	ZEND_HANDLE_FILENAME,
39 	ZEND_HANDLE_FD,
40 	ZEND_HANDLE_FP,
41 	ZEND_HANDLE_STREAM,
42 	ZEND_HANDLE_MAPPED
43 } zend_stream_type;
44 
45 typedef struct _zend_mmap {
46 	size_t      len;
47 	size_t      pos;
48 	void        *map;
49 	char        *buf;
50 	void                  *old_handle;
51 	zend_stream_closer_t   old_closer;
52 } zend_mmap;
53 
54 typedef struct _zend_stream {
55 	void        *handle;
56 	int         isatty;
57 	zend_mmap   mmap;
58 	zend_stream_reader_t   reader;
59 	zend_stream_fsizer_t   fsizer;
60 	zend_stream_closer_t   closer;
61 } zend_stream;
62 
63 typedef struct _zend_file_handle {
64 	union {
65 		int           fd;
66 		FILE          *fp;
67 		zend_stream   stream;
68 	} handle;
69 	const char        *filename;
70 	zend_string       *opened_path;
71 	zend_stream_type  type;
72 	zend_bool free_filename;
73 } zend_file_handle;
74 
75 BEGIN_EXTERN_C()
76 ZEND_API int zend_stream_open(const char *filename, zend_file_handle *handle);
77 ZEND_API int zend_stream_fixup(zend_file_handle *file_handle, char **buf, size_t *len);
78 ZEND_API void zend_file_handle_dtor(zend_file_handle *fh);
79 ZEND_API int zend_compare_file_handles(zend_file_handle *fh1, zend_file_handle *fh2);
80 END_EXTERN_C()
81 
82 #ifdef _WIN64
83 # define zend_fseek _fseeki64
84 # define zend_ftell _ftelli64
85 # define zend_lseek _lseeki64
86 # define zend_fstat _fstat64
87 # define zend_stat  _stat64
88 typedef struct __stat64 zend_stat_t;
89 #else
90 # define zend_fseek fseek
91 # define zend_ftell ftell
92 # define zend_lseek lseek
93 # define zend_fstat fstat
94 # define zend_stat stat
95 typedef struct stat zend_stat_t;
96 #endif
97 
98 #endif
99 
100 /*
101  * Local variables:
102  * tab-width: 4
103  * c-basic-offset: 4
104  * indent-tabs-mode: t
105  * End:
106  * vim600: sw=4 ts=4 fdm=marker
107  * vim<600: sw=4 ts=4
108  */
109