xref: /PHP-8.3/main/php_memory_streams.h (revision 01b3fc03)
1 /*
2    +----------------------------------------------------------------------+
3    | Copyright (c) The PHP Group                                          |
4    +----------------------------------------------------------------------+
5    | This source file is subject to version 3.01 of the PHP license,      |
6    | that is bundled with this package in the file LICENSE, and is        |
7    | available through the world-wide-web at the following url:           |
8    | https://www.php.net/license/3_01.txt                                 |
9    | If you did not receive a copy of the PHP license and are unable to   |
10    | obtain it through the world-wide-web, please send a note to          |
11    | license@php.net so we can mail you a copy immediately.               |
12    +----------------------------------------------------------------------+
13    | Author: Marcus Boerger <helly@php.net>                               |
14    +----------------------------------------------------------------------+
15  */
16 
17 #ifndef PHP_MEMORY_STREAM_H
18 #define PHP_MEMORY_STREAM_H
19 
20 #include "php_streams.h"
21 
22 #define PHP_STREAM_MAX_MEM	2 * 1024 * 1024
23 
24 #define TEMP_STREAM_DEFAULT     0x0
25 #define TEMP_STREAM_READONLY    0x1
26 #define TEMP_STREAM_TAKE_BUFFER 0x2
27 #define TEMP_STREAM_APPEND      0x4
28 
29 #define php_stream_memory_create(mode) _php_stream_memory_create((mode) STREAMS_CC)
30 #define php_stream_memory_create_rel(mode) _php_stream_memory_create((mode) STREAMS_REL_CC)
31 #define php_stream_memory_open(mode, str) _php_stream_memory_open((mode), (str) STREAMS_CC)
32 #define php_stream_memory_get_buffer(stream) _php_stream_memory_get_buffer((stream) STREAMS_CC)
33 
34 #define php_stream_temp_new() php_stream_temp_create(TEMP_STREAM_DEFAULT, PHP_STREAM_MAX_MEM)
35 #define php_stream_temp_create(mode, max_memory_usage) _php_stream_temp_create((mode), (max_memory_usage) STREAMS_CC)
36 #define php_stream_temp_create_ex(mode, max_memory_usage, tmpdir) _php_stream_temp_create_ex((mode), (max_memory_usage), (tmpdir) STREAMS_CC)
37 #define php_stream_temp_create_rel(mode, max_memory_usage) _php_stream_temp_create((mode), (max_memory_usage) STREAMS_REL_CC)
38 #define php_stream_temp_open(mode, max_memory_usage, buf, length) _php_stream_temp_open((mode), (max_memory_usage), (buf), (length) STREAMS_CC)
39 
40 BEGIN_EXTERN_C()
41 
42 PHPAPI php_stream *_php_stream_memory_create(int mode STREAMS_DC);
43 PHPAPI php_stream *_php_stream_memory_open(int mode, zend_string *buf STREAMS_DC);
44 PHPAPI zend_string *_php_stream_memory_get_buffer(php_stream *stream STREAMS_DC);
45 
46 PHPAPI php_stream *_php_stream_temp_create(int mode, size_t max_memory_usage STREAMS_DC);
47 PHPAPI php_stream *_php_stream_temp_create_ex(int mode, size_t max_memory_usage, const char *tmpdir STREAMS_DC);
48 PHPAPI php_stream *_php_stream_temp_open(int mode, size_t max_memory_usage, const char *buf, size_t length STREAMS_DC);
49 
50 PHPAPI int php_stream_mode_from_str(const char *mode);
51 PHPAPI const char *_php_stream_mode_to_str(int mode);
52 
53 END_EXTERN_C()
54 
55 extern PHPAPI const php_stream_ops php_stream_memory_ops;
56 extern PHPAPI const php_stream_ops php_stream_temp_ops;
57 extern PHPAPI const php_stream_ops php_stream_rfc2397_ops;
58 extern PHPAPI const php_stream_wrapper php_stream_rfc2397_wrapper;
59 
60 #define PHP_STREAM_IS_MEMORY &php_stream_memory_ops
61 #define PHP_STREAM_IS_TEMP   &php_stream_temp_ops
62 
63 #endif
64