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