a8a55bf9339c1c251df46767ff29719c258ca22f
[m6w6/ext-http] / php_http_encoding_api.h
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #ifndef PHP_HTTP_ENCODING_API_H
16 #define PHP_HTTP_ENCODING_API_H
17
18 #define http_encoding_dechunk(e, el, d, dl) _http_encoding_dechunk((e), (el), (d), (dl) TSRMLS_CC)
19 PHP_HTTP_API const char *_http_encoding_dechunk(const char *encoded, size_t encoded_len, char **decoded, size_t *decoded_len TSRMLS_DC);
20
21 #define http_encoding_response_start(cl) _http_encoding_response_start((cl) TSRMLS_CC)
22 PHP_HTTP_API zend_bool _http_encoding_response_start(size_t content_length TSRMLS_DC);
23
24 #ifdef HTTP_HAVE_ZLIB
25
26 extern PHP_MINIT_FUNCTION(http_encoding);
27
28 /* 100% compression should be fairly good */
29 #define HTTP_ENCODING_MAXTRY 100
30 /* safe padding */
31 #define HTTP_ENCODING_SAFPAD 28
32 /* add 1% extra space in case we need to encode widely differing (binary) data */
33 #define HTTP_ENCODING_BUFLEN(l) (l + (l / 100) + HTTP_ENCODING_SAFPAD)
34
35 typedef enum {
36 HTTP_ENCODING_NONE,
37 HTTP_ENCODING_GZIP,
38 HTTP_ENCODING_DEFLATE,
39 } http_encoding_type;
40
41 #define HTTP_DEFLATE_LEVEL_DEF 0x00000000
42 #define HTTP_DEFLATE_LEVEL_MIN 0x00000001
43 #define HTTP_DEFLATE_LEVEL_MAX 0x00000002
44 #define HTTP_DEFLATE_TYPE_ZLIB 0x00000000
45 #define HTTP_DEFLATE_TYPE_GZIP 0x00000010
46 #define HTTP_DEFLATE_TYPE_RAW 0x00000020
47 #define HTTP_DEFLATE_STRATEGY_DEF 0x00000000
48 #define HTTP_DEFLATE_STRATEGY_FILT 0x00000100
49 #define HTTP_DEFLATE_STRATEGY_HUFF 0x00000200
50 #define HTTP_DEFLATE_STRATEGY_RLE 0x00000300
51 #define HTTP_DEFLATE_STRATEGY_FIXED 0x00000400
52
53 #define HTTP_INFLATE_TYPE_ZLIB 0x00000000
54 #define HTTP_INFLATE_TYPE_GZIP 0x00000000
55 #define HTTP_INFLATE_TYPE_RAW 0x00000001
56
57 #define HTTP_ENCODING_STREAM_PERSISTENT 0x01000000
58
59 typedef struct {
60 z_stream stream;
61 int flags;
62 void *storage;
63 } http_encoding_stream;
64
65 #define http_encoding_deflate(f, d, dl, r, rl) _http_encoding_deflate((f), (d), (dl), (r), (rl) TSRMLS_CC)
66 PHP_HTTP_API STATUS _http_encoding_deflate(int flags, const char *data, size_t data_len, char **encoded, size_t *encoded_len TSRMLS_DC);
67 #define http_encoding_inflate(d, dl, r, rl) _http_encoding_inflate((d), (dl), (r), (rl) TSRMLS_CC)
68 PHP_HTTP_API STATUS _http_encoding_inflate(const char *data, size_t data_len, char **decoded, size_t *decoded_len TSRMLS_DC);
69
70 #define http_encoding_deflate_stream_init(s, f) _http_encoding_deflate_stream_init((s), (f) TSRMLS_CC)
71 PHP_HTTP_API http_encoding_stream *_http_encoding_deflate_stream_init(http_encoding_stream *s, int flags TSRMLS_DC);
72 #define http_encoding_deflate_stream_update(s, d, dl, e, el) _http_encoding_deflate_stream_update((s), (d), (dl), (e), (el) TSRMLS_CC)
73 PHP_HTTP_API STATUS _http_encoding_deflate_stream_update(http_encoding_stream *s, const char *data, size_t data_len, char **encoded, size_t *encoded_len TSRMLS_DC);
74 #define http_encoding_deflate_stream_flush(s, e, el) _http_encoding_deflate_stream_flush((s), (e), (el) TSRMLS_CC)
75 PHP_HTTP_API STATUS _http_encoding_deflate_stream_flush(http_encoding_stream *s, char **encoded, size_t *encoded_len TSRMLS_DC);
76 #define http_encoding_deflate_stream_finish(s, e, el) _http_encoding_deflate_stream_finish((s), (e), (el) TSRMLS_CC)
77 PHP_HTTP_API STATUS _http_encoding_deflate_stream_finish(http_encoding_stream *s, char **encoded, size_t *encoded_len TSRMLS_DC);
78 #define http_encoding_deflate_stream_dtor(s) _http_encoding_deflate_stream_dtor((s) TSRMLS_CC)
79 PHP_HTTP_API void _http_encoding_deflate_stream_dtor(http_encoding_stream *s TSRMLS_DC);
80 #define http_encoding_deflate_stream_free(s) _http_encoding_deflate_stream_free((s) TSRMLS_CC)
81 PHP_HTTP_API void _http_encoding_deflate_stream_free(http_encoding_stream **s TSRMLS_DC);
82
83 #define http_encoding_inflate_stream_init(s, f) _http_encoding_inflate_stream_init((s), (f) TSRMLS_CC)
84 PHP_HTTP_API http_encoding_stream *_http_encoding_inflate_stream_init(http_encoding_stream *s, int flags TSRMLS_DC);
85 #define http_encoding_inflate_stream_update(s, d, dl, e, el) _http_encoding_inflate_stream_update((s), (d), (dl), (e), (el) TSRMLS_CC)
86 PHP_HTTP_API STATUS _http_encoding_inflate_stream_update(http_encoding_stream *s, const char *data, size_t data_len, char **decoded, size_t *decoded_len TSRMLS_DC);
87 #define http_encoding_inflate_stream_flush(s, d, dl) _http_encoding_inflate_stream_flush((s), (d), (dl) TSRMLS_CC)
88 PHP_HTTP_API STATUS _http_encoding_inflate_stream_flush(http_encoding_stream *s, char **decoded, size_t *decoded_len TSRMLS_DC);
89 #define http_encoding_inflate_stream_finish(s, e, el) _http_encoding_inflate_stream_finish((s), (e), (el) TSRMLS_CC)
90 PHP_HTTP_API STATUS _http_encoding_inflate_stream_finish(http_encoding_stream *s, char **decoded, size_t *decoded_len TSRMLS_DC);
91 #define http_encoding_inflate_stream_dtor(s) _http_encoding_inflate_stream_dtor((s) TSRMLS_CC)
92 PHP_HTTP_API void _http_encoding_inflate_stream_dtor(http_encoding_stream *s TSRMLS_DC);
93 #define http_encoding_inflate_stream_free(s) _http_encoding_inflate_stream_free((s) TSRMLS_CC)
94 PHP_HTTP_API void _http_encoding_inflate_stream_free(http_encoding_stream **s TSRMLS_DC);
95
96 #endif /* HTTP_HAVE_ZLIB */
97
98 #endif
99
100 /*
101 * Local variables:
102 * tab-width: 4
103 * c-basic-offset: 4
104 * End:
105 * vim600: noet sw=4 ts=4 fdm=marker
106 * vim<600: noet sw=4 ts=4
107 */