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