xref: /PHP-7.1/main/php_memory_streams.h (revision ccd4716e)
1 /*
2    +----------------------------------------------------------------------+
3    | PHP Version 7                                                        |
4    +----------------------------------------------------------------------+
5    | Copyright (c) 1997-2018 The PHP Group                                |
6    +----------------------------------------------------------------------+
7    | This source file is subject to version 3.01 of the PHP 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.php.net/license/3_01.txt                                  |
11    | If you did not receive a copy of the PHP license and are unable to   |
12    | obtain it through the world-wide-web, please send a note to          |
13    | license@php.net so we can mail you a copy immediately.               |
14    +----------------------------------------------------------------------+
15    | Author: Marcus Boerger <helly@php.net>                               |
16    +----------------------------------------------------------------------+
17  */
18 
19 /* $Id$ */
20 
21 #ifndef PHP_MEMORY_STREAM_H
22 #define PHP_MEMORY_STREAM_H
23 
24 #include "php_streams.h"
25 
26 #define PHP_STREAM_MAX_MEM	2 * 1024 * 1024
27 
28 #define TEMP_STREAM_DEFAULT  0
29 #define TEMP_STREAM_READONLY 1
30 #define TEMP_STREAM_TAKE_BUFFER 2
31 
32 #define php_stream_memory_create(mode) _php_stream_memory_create((mode) STREAMS_CC)
33 #define php_stream_memory_create_rel(mode) _php_stream_memory_create((mode) STREAMS_REL_CC)
34 #define php_stream_memory_open(mode, buf, length) _php_stream_memory_open((mode), (buf), (length) STREAMS_CC)
35 #define php_stream_memory_get_buffer(stream, length) _php_stream_memory_get_buffer((stream), (length) STREAMS_CC)
36 
37 #define php_stream_temp_new() php_stream_temp_create(TEMP_STREAM_DEFAULT, PHP_STREAM_MAX_MEM)
38 #define php_stream_temp_create(mode, max_memory_usage) _php_stream_temp_create((mode), (max_memory_usage) STREAMS_CC)
39 #define php_stream_temp_create_ex(mode, max_memory_usage, tmpdir) _php_stream_temp_create_ex((mode), (max_memory_usage), (tmpdir) STREAMS_CC)
40 #define php_stream_temp_create_rel(mode, max_memory_usage) _php_stream_temp_create((mode), (max_memory_usage) STREAMS_REL_CC)
41 #define php_stream_temp_open(mode, max_memory_usage, buf, length) _php_stream_temp_open((mode), (max_memory_usage), (buf), (length) STREAMS_CC)
42 
43 BEGIN_EXTERN_C()
44 PHPAPI php_stream *_php_stream_memory_create(int mode STREAMS_DC);
45 PHPAPI php_stream *_php_stream_memory_open(int mode, char *buf, size_t length STREAMS_DC);
46 PHPAPI char *_php_stream_memory_get_buffer(php_stream *stream, size_t *length STREAMS_DC);
47 
48 PHPAPI php_stream *_php_stream_temp_create(int mode, size_t max_memory_usage STREAMS_DC);
49 PHPAPI php_stream *_php_stream_temp_create_ex(int mode, size_t max_memory_usage, const char *tmpdir STREAMS_DC);
50 PHPAPI php_stream *_php_stream_temp_open(int mode, size_t max_memory_usage, char *buf, size_t length STREAMS_DC);
51 END_EXTERN_C()
52 
53 extern PHPAPI php_stream_ops php_stream_memory_ops;
54 extern PHPAPI php_stream_ops php_stream_temp_ops;
55 extern PHPAPI php_stream_ops php_stream_rfc2397_ops;
56 extern PHPAPI php_stream_wrapper php_stream_rfc2397_wrapper;
57 
58 #define PHP_STREAM_IS_MEMORY &php_stream_memory_ops
59 #define PHP_STREAM_IS_TEMP   &php_stream_temp_ops
60 
61 #endif
62 
63 /*
64  * Local variables:
65  * tab-width: 4
66  * c-basic-offset: 4
67  * End:
68  * vim600: sw=4 ts=4 fdm=marker
69  * vim<600: sw=4 ts=4
70  */
71