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