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