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