missed that part
[m6w6/ext-http] / phpstr / phpstr.h
1
2 /* $Id$ */
3
4 #ifndef _PHPSTR_H_
5 #define _PHPSTR_H_
6
7 #include "php.h"
8
9 #ifndef PHPSTR_DEFAULT_SIZE
10 # define PHPSTR_DEFAULT_SIZE 256
11 #endif
12
13 #ifndef STR_SET
14 # define STR_SET(STR, SET) \
15 { \
16 STR_FREE(STR); \
17 STR = SET; \
18 }
19 #endif
20
21 #if defined(PHP_WIN32)
22 # if defined(PHPSTR_EXPORTS)
23 # define PHPSTR_API __declspec(dllexport)
24 # elif defined(COMPILE_DL_PHPSTR)
25 # define PHPSTR_API __declspec(dllimport)
26 # else
27 # define PHPSTR_API
28 # endif
29 #else
30 # define PHPSTR_API
31 #endif
32
33 #define PHPSTR(p) ((phpstr *) (p))
34 #define PHPSTR_VAL(p) (PHPSTR(p))->data
35 #define PHPSTR_LEN(p) (PHPSTR(p))->used
36
37 #define FREE_PHPSTR_PTR(STR) pefree(STR, STR->pmem)
38 #define FREE_PHPSTR_VAL(STR) phpstr_dtor(STR)
39 #define FREE_PHPSTR_ALL(STR) phpstr_free(&(STR))
40 #define FREE_PHPSTR(free, STR) \
41 switch (free) \
42 { \
43 case PHPSTR_FREE_NOT: break; \
44 case PHPSTR_FREE_PTR: pefree(STR, STR->pmem); break; \
45 case PHPSTR_FREE_VAL: phpstr_dtor(STR); break; \
46 case PHPSTR_FREE_ALL: \
47 { \
48 phpstr *PTR = (STR); \
49 phpstr_free(&PTR); \
50 } \
51 break; \
52 default: break; \
53 }
54
55 #define RETURN_PHPSTR_PTR(STR) RETURN_PHPSTR((STR), PHPSTR_FREE_PTR, 0)
56 #define RETURN_PHPSTR_VAL(STR) RETURN_PHPSTR((STR), PHPSTR_FREE_NOT, 0)
57 #define RETURN_PHPSTR_DUP(STR) RETURN_PHPSTR((STR), PHPSTR_FREE_NOT, 1)
58 #define RETVAL_PHPSTR_PTR(STR) RETVAL_PHPSTR((STR), PHPSTR_FREE_PTR, 0)
59 #define RETVAL_PHPSTR_VAL(STR) RETVAL_PHPSTR((STR), PHPSTR_FREE_NOT, 0)
60 #define RETVAL_PHPSTR_DUP(STR) RETVAL_PHPSTR((STR), PHPSTR_FREE_NOT, 1)
61 /* RETURN_PHPSTR(buf, PHPSTR_FREE_PTR, 0) */
62 #define RETURN_PHPSTR(STR, free, dup) \
63 RETVAL_PHPSTR((STR), (free), (dup)); \
64 return;
65
66 #define RETVAL_PHPSTR(STR, free, dup) \
67 phpstr_fix(STR); \
68 RETVAL_STRINGL((STR)->data, (STR)->used, (dup)); \
69 FREE_PHPSTR((free), (STR));
70
71 typedef struct {
72 size_t size;
73 char *data;
74 size_t used;
75 size_t free;
76 int pmem;
77 } phpstr;
78
79 typedef enum {
80 PHPSTR_FREE_NOT = 0,
81 PHPSTR_FREE_PTR, /* pefree() */
82 PHPSTR_FREE_VAL, /* phpstr_dtor() */
83 PHPSTR_FREE_ALL /* phpstr_free() */
84 } phpstr_free_t;
85
86 #define PHPSTR_ALL_FREE(STR) PHPSTR_FREE_ALL,(STR)
87 #define PHPSTR_PTR_FREE(STR) PHPSTR_FREE_PTR,(STR)
88 #define PHPSTR_VAL_FREE(STR) PHPSTR_FREE_VAL,(STR)
89 #define PHPSTR_NOT_FREE(STR) PHPSTR_FREE_NOT,(STR)
90
91 #define PHPSTR_INIT_PREALLOC 0x01
92 #define PHPSTR_INIT_PERSISTENT 0x02
93
94 /* create a new phpstr */
95 #define phpstr_new() phpstr_init(NULL)
96 #define phpstr_init(b) phpstr_init_ex(b, 0, 0)
97 #define phpstr_clone(phpstr_pointer) phpstr_init_ex(NULL, (phpstr_pointer)->size, (phpstr_pointer)->pmem ? PHPSTR_INIT_PERSISTENT:0)
98 PHPSTR_API phpstr *phpstr_init_ex(phpstr *buf, size_t chunk_size, int flags);
99
100 /* create a phpstr from a zval or c-string */
101 #define phpstr_from_zval(z) phpstr_from_string(Z_STRVAL(z), Z_STRLEN(z))
102 #define phpstr_from_zval_ex(b, z) phpstr_from_string_ex(b, Z_STRVAL(z), Z_STRLEN(z))
103 #define phpstr_from_string(s, l) phpstr_from_string_ex(NULL, (s), (l))
104 PHPSTR_API phpstr *phpstr_from_string_ex(phpstr *buf, const char *string, size_t length);
105
106 /* usually only called from within the internal functions */
107 #define phpstr_resize(b, s) phpstr_resize_ex((b), (s), 0)
108 PHPSTR_API size_t phpstr_resize_ex(phpstr *buf, size_t len, size_t override_size);
109
110 /* append data to the phpstr */
111 #define phpstr_appends(b, a) phpstr_append((b), (a), sizeof(a)-1)
112 #define phpstr_appendl(b, a) phpstr_append((b), (a), strlen(a))
113 PHPSTR_API size_t phpstr_append(phpstr *buf, const char *append, size_t append_len);
114 PHPSTR_API size_t phpstr_appendf(phpstr *buf, const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 2, 3);
115
116 /* insert data at a specific position of the phpstr */
117 #define phpstr_inserts(b, i, o) phpstr_insert((b), (i), sizeof(i)-1, (o))
118 #define phpstr_insertl(b, i, o) phpstr_insert((b), (i), strlen(i), (o))
119 PHPSTR_API size_t phpstr_insert(phpstr *buf, const char *insert, size_t insert_len, size_t offset);
120 PHPSTR_API size_t phpstr_insertf(phpstr *buf, size_t offset, const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 3, 4);
121
122 /* prepend data */
123 #define phpstr_prepends(b, p) phpstr_prepend((b), (p), sizeof(p)-1)
124 #define phpstr_prependl(b, p) phpstr_prepend((b), (p), strlen(p))
125 PHPSTR_API size_t phpstr_prepend(phpstr *buf, const char *prepend, size_t prepend_len);
126 PHPSTR_API size_t phpstr_prependf(phpstr *buf, const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 2, 3);
127
128 /* get a zero-terminated string */
129 PHPSTR_API char *phpstr_data(const phpstr *buf, char **into, size_t *len);
130
131 /* get a part of the phpstr */
132 #define phpstr_mid(b, o, l) phpstr_sub((b), (o), (l))
133 #define phpstr_left(b, l) phpstr_sub((b), 0, (l))
134 PHPSTR_API phpstr *phpstr_right(const phpstr *buf, size_t length);
135 PHPSTR_API phpstr *phpstr_sub(const phpstr *buf, size_t offset, size_t len);
136
137 /* remove a substring */
138 PHPSTR_API size_t phpstr_cut(phpstr *buf, size_t offset, size_t length);
139
140 /* get a complete phpstr duplicate */
141 PHPSTR_API phpstr *phpstr_dup(const phpstr *buf);
142
143 /* merge several phpstr objects
144 use like:
145
146 phpstr *final = phpstr_merge(3,
147 PHPSTR_NOT_FREE(&keep),
148 PHPSTR_ALL_FREE(middle_ptr),
149 PHPSTR_VAL_FREE(&local);
150 */
151 PHPSTR_API phpstr *phpstr_merge(unsigned argc, ...);
152 PHPSTR_API phpstr *phpstr_merge_ex(phpstr *buf, unsigned argc, ...);
153 PHPSTR_API phpstr *phpstr_merge_va(phpstr *buf, unsigned argc, va_list argv);
154
155 /* sets a trailing NUL byte */
156 PHPSTR_API phpstr *phpstr_fix(phpstr *buf);
157
158 /* memcmp for phpstr objects */
159 PHPSTR_API int phpstr_cmp(phpstr *left, phpstr *right);
160
161 /* reset phpstr object */
162 PHPSTR_API void phpstr_reset(phpstr *buf);
163
164 /* free a phpstr objects contents */
165 PHPSTR_API void phpstr_dtor(phpstr *buf);
166
167 /* free a phpstr object completely */
168 PHPSTR_API void phpstr_free(phpstr **buf);
169
170 /* stores data in a phpstr until it reaches chunk_size */
171 PHPSTR_API size_t phpstr_chunk_buffer(phpstr **s, const char *data, size_t data_len, char **chunk, size_t chunk_size);
172
173 /* wrapper around phpstr_chunk_buffer, which passes available chunks to passthru() */
174 PHPSTR_API void phpstr_chunked_output(phpstr **s, const char *data, size_t data_len, size_t chunk_size, void (*passthru)(const char *, size_t TSRMLS_DC) TSRMLS_DC);
175
176 #endif
177
178
179 /*
180 * Local variables:
181 * tab-width: 4
182 * c-basic-offset: 4
183 * End:
184 * vim600: sw=4 ts=4 fdm=marker
185 * vim<600: sw=4 ts=4
186 */