- allow negative time offsets
[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) efree(STR)
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: efree(STR); 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 RETVAL_PHPSTR_PTR(STR) RETVAL_PHPSTR((STR), PHPSTR_FREE_PTR, 0)
58 #define RETVAL_PHPSTR_VAL(STR) RETVAL_PHPSTR((STR), PHPSTR_FREE_NOT, 0)
59 /* RETURN_PHPSTR(buf, PHPSTR_FREE_PTR, 0) */
60 #define RETURN_PHPSTR(STR, free, dup) \
61 RETVAL_PHPSTR((STR), (free), (dup)); \
62 return;
63
64 #define RETVAL_PHPSTR(STR, free, dup) \
65 phpstr_fix(STR); \
66 RETVAL_STRINGL((STR)->data, (STR)->used, (dup)); \
67 FREE_PHPSTR((free), (STR));
68
69 typedef struct {
70 size_t size;
71 char *data;
72 size_t used;
73 size_t free;
74 } phpstr;
75
76 typedef enum {
77 PHPSTR_FREE_NOT = 0,
78 PHPSTR_FREE_PTR, /* efree() */
79 PHPSTR_FREE_VAL, /* phpstr_dtor() */
80 PHPSTR_FREE_ALL /* phpstr_free() */
81 } phpstr_free_t;
82
83 #define PHPSTR_ALL_FREE(STR) PHPSTR_FREE_ALL,(STR)
84 #define PHPSTR_PTR_FREE(STR) PHPSTR_FREE_PTR,(STR)
85 #define PHPSTR_VAL_FREE(STR) PHPSTR_FREE_VAL,(STR)
86 #define PHPSTR_NOT_FREE(STR) PHPSTR_FREE_NOT,(STR)
87
88 /* create a new phpstr */
89 #define phpstr_new() phpstr_init(NULL)
90 #define phpstr_init(b) phpstr_init_ex(b, 0, 0)
91 #define phpstr_clone(phpstr_pointer) phpstr_init_ex(NULL, (phpstr_pointer)->size, 0)
92 PHPSTR_API phpstr *phpstr_init_ex(phpstr *buf, size_t chunk_size, zend_bool pre_alloc);
93
94 /* create a phpstr from a zval or c-string */
95 #define phpstr_from_zval(z) phpstr_from_string(Z_STRVAL(z), Z_STRLEN(z))
96 #define phpstr_from_zval_ex(b, z) phpstr_from_string_ex(b, Z_STRVAL(z), Z_STRLEN(z))
97 #define phpstr_from_string(s, l) phpstr_from_string_ex(NULL, (s), (l))
98 PHPSTR_API phpstr *phpstr_from_string_ex(phpstr *buf, const char *string, size_t length);
99
100 /* usually only called from within the internal functions */
101 #define phpstr_resize(b, s) phpstr_resize_ex((b), (s), 0)
102 PHPSTR_API void phpstr_resize_ex(phpstr *buf, size_t len, size_t override_size);
103
104 /* append data to the phpstr */
105 #define phpstr_appends(b, a) phpstr_append((b), (a), sizeof(a)-1)
106 #define phpstr_appendl(b, a) phpstr_append((b), (a), strlen(a))
107 PHPSTR_API size_t phpstr_append(phpstr *buf, const char *append, size_t append_len);
108 PHPSTR_API size_t phpstr_appendf(phpstr *buf, const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 2, 3);
109
110 /* insert data at a specific position of the phpstr */
111 #define phpstr_inserts(b, i, o) phpstr_insert((b), (i), sizeof(i)-1, (o))
112 #define phpstr_insertl(b, i, o) phpstr_insert((b), (i), strlen(i), (o))
113 PHPSTR_API size_t phpstr_insert(phpstr *buf, const char *insert, size_t insert_len, size_t offset);
114 PHPSTR_API size_t phpstr_insertf(phpstr *buf, size_t offset, const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 3, 4);
115
116 /* prepend data */
117 #define phpstr_prepends(b, p) phpstr_prepend((b), (p), sizeof(p)-1)
118 #define phpstr_prependl(b, p) phpstr_prepend((b), (p), strlen(p))
119 PHPSTR_API size_t phpstr_prepend(phpstr *buf, const char *prepend, size_t prepend_len);
120 PHPSTR_API size_t phpstr_prependf(phpstr *buf, const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 2, 3);
121
122 /* get a zero-terminated string */
123 PHPSTR_API char *phpstr_data(const phpstr *buf, char **into, size_t *len);
124
125 /* get a part of the phpstr */
126 #define phpstr_mid(b, o, l) phpstr_sub((b), (o), (l))
127 #define phpstr_left(b, l) phpstr_sub((b), 0, (l))
128 PHPSTR_API phpstr *phpstr_right(const phpstr *buf, size_t length);
129 PHPSTR_API phpstr *phpstr_sub(const phpstr *buf, size_t offset, size_t len);
130
131 /* remove a substring */
132 PHPSTR_API size_t phpstr_cut(phpstr *buf, size_t offset, size_t length);
133
134 /* get a complete phpstr duplicate */
135 PHPSTR_API phpstr *phpstr_dup(const phpstr *buf);
136
137 /* merge several phpstr objects
138 use like:
139
140 phpstr *final = phpstr_merge(3,
141 PHPSTR_NOT_FREE(&keep),
142 PHPSTR_ALL_FREE(middle_ptr),
143 PHPSTR_VAL_FREE(&local);
144 */
145 PHPSTR_API phpstr *phpstr_merge(unsigned argc, ...);
146 PHPSTR_API phpstr *phpstr_merge_ex(phpstr *buf, unsigned argc, ...);
147 PHPSTR_API phpstr *phpstr_merge_va(phpstr *buf, unsigned argc, va_list argv);
148
149 /* sets a trailing NUL byte */
150 PHPSTR_API void phpstr_fix(phpstr *buf);
151
152 /* free a phpstr objects contents */
153 PHPSTR_API void phpstr_dtor(phpstr *buf);
154
155 /* free a phpstr object completely */
156 PHPSTR_API void phpstr_free(phpstr **buf);
157
158 #endif
159
160
161 /*
162 * Local variables:
163 * tab-width: 4
164 * c-basic-offset: 4
165 * End:
166 * vim600: sw=4 ts=4 fdm=marker
167 * vim<600: sw=4 ts=4
168 */