- fix previous commit and adjust tests
[m6w6/ext-http] / phpstr / phpstr.h
index 50d9c283c14616a619ce72ee1cf93131dc4f4a67..04a74ed05718a7cd1076df8fa0fb03a5b1a90357 100644 (file)
@@ -4,27 +4,58 @@
 #ifndef _PHPSTR_H_
 #define _PHPSTR_H_
 
 #ifndef _PHPSTR_H_
 #define _PHPSTR_H_
 
-#ifdef PHP_WIN32
-#      define PHPSTR_API __declspec(dllexport)
+#include "php.h"
+
+#ifndef PHPSTR_DEFAULT_SIZE
+#      define PHPSTR_DEFAULT_SIZE 256
+#endif
+
+#ifndef STR_SET
+#      define STR_SET(STR, SET) \
+       { \
+               STR_FREE(STR); \
+               STR = SET; \
+       }
+#endif
+
+#if defined(PHP_WIN32)
+#      if defined(PHPSTR_EXPORTS)
+#              define PHPSTR_API __declspec(dllexport)
+#      elif defined(COMPILE_DL_PHPSTR)
+#              define PHPSTR_API __declspec(dllimport)
+#      else
+#              define PHPSTR_API
+#      endif
 #else
 #      define PHPSTR_API
 #endif
 
 #else
 #      define PHPSTR_API
 #endif
 
+#define PHPSTR(p) ((phpstr *) (p))
+#define PHPSTR_VAL(p) (PHPSTR(p))->data
+#define PHPSTR_LEN(p) (PHPSTR(p))->used
+
 #define FREE_PHPSTR_PTR(STR) efree(STR)
 #define FREE_PHPSTR_VAL(STR) phpstr_dtor(STR)
 #define FREE_PHPSTR_PTR(STR) efree(STR)
 #define FREE_PHPSTR_VAL(STR) phpstr_dtor(STR)
-#define FREE_PHPSTR_ALL(STR) phpstr_free(STR)
+#define FREE_PHPSTR_ALL(STR) phpstr_free(&(STR))
 #define FREE_PHPSTR(free, STR) \
        switch (free) \
        { \
 #define FREE_PHPSTR(free, STR) \
        switch (free) \
        { \
+               case PHPSTR_FREE_NOT:                                           break; \
                case PHPSTR_FREE_PTR:   efree(STR);                     break; \
                case PHPSTR_FREE_VAL:   phpstr_dtor(STR);       break; \
                case PHPSTR_FREE_PTR:   efree(STR);                     break; \
                case PHPSTR_FREE_VAL:   phpstr_dtor(STR);       break; \
-               case PHPSTR_FREE_ALL:   phpstr_free(STR);       break; \
-               case PHPSTR_FREE_NOT:                                           break; \
+               case PHPSTR_FREE_ALL: \
+               { \
+                       phpstr *PTR = (STR); \
+                       phpstr_free(&PTR); \
+               } \
+               break; \
                default:                                                                        break; \
        }
 
 #define RETURN_PHPSTR_PTR(STR) RETURN_PHPSTR((STR), PHPSTR_FREE_PTR, 0)
                default:                                                                        break; \
        }
 
 #define RETURN_PHPSTR_PTR(STR) RETURN_PHPSTR((STR), PHPSTR_FREE_PTR, 0)
-#define RETURN_PHPSTR_VAL(STR) RETURN_PHPSTR(&(STR), PHPSTR_FREE_NOT, 0)
+#define RETURN_PHPSTR_VAL(STR) RETURN_PHPSTR((STR), PHPSTR_FREE_NOT, 0)
+#define RETVAL_PHPSTR_PTR(STR) RETVAL_PHPSTR((STR), PHPSTR_FREE_PTR, 0)
+#define RETVAL_PHPSTR_VAL(STR) RETVAL_PHPSTR((STR), PHPSTR_FREE_NOT, 0)
 /* RETURN_PHPSTR(buf, PHPSTR_FREE_PTR, 0) */
 #define RETURN_PHPSTR(STR, free, dup) \
        RETVAL_PHPSTR((STR), (free), (dup)); \
 /* RETURN_PHPSTR(buf, PHPSTR_FREE_PTR, 0) */
 #define RETURN_PHPSTR(STR, free, dup) \
        RETVAL_PHPSTR((STR), (free), (dup)); \
        RETVAL_STRINGL((STR)->data, (STR)->used, (dup)); \
        FREE_PHPSTR((free), (STR));
 
        RETVAL_STRINGL((STR)->data, (STR)->used, (dup)); \
        FREE_PHPSTR((free), (STR));
 
-struct _phpstr {
+typedef struct {
        size_t size;
        char  *data;
        size_t used;
        size_t free;
        size_t size;
        char  *data;
        size_t used;
        size_t free;
-};
-typedef struct _phpstr phpstr;
+} phpstr;
 
 
-enum _phpstr_free {
+typedef enum {
        PHPSTR_FREE_NOT = 0,
        PHPSTR_FREE_PTR,        /* efree() */
        PHPSTR_FREE_VAL,        /* phpstr_dtor() */
        PHPSTR_FREE_ALL         /* phpstr_free() */
        PHPSTR_FREE_NOT = 0,
        PHPSTR_FREE_PTR,        /* efree() */
        PHPSTR_FREE_VAL,        /* phpstr_dtor() */
        PHPSTR_FREE_ALL         /* phpstr_free() */
-};
-typedef enum _phpstr_free phpstr_free_t;
+} phpstr_free_t;
 
 #define PHPSTR_ALL_FREE(STR) PHPSTR_FREE_ALL,(STR)
 #define PHPSTR_PTR_FREE(STR) PHPSTR_FREE_PTR,(STR)
 
 #define PHPSTR_ALL_FREE(STR) PHPSTR_FREE_ALL,(STR)
 #define PHPSTR_PTR_FREE(STR) PHPSTR_FREE_PTR,(STR)
@@ -60,13 +89,13 @@ typedef enum _phpstr_free phpstr_free_t;
 #define phpstr_new() phpstr_init(NULL)
 #define phpstr_init(b) phpstr_init_ex(b, 0, 0)
 #define phpstr_clone(phpstr_pointer) phpstr_init_ex(NULL, (phpstr_pointer)->size, 0)
 #define phpstr_new() phpstr_init(NULL)
 #define phpstr_init(b) phpstr_init_ex(b, 0, 0)
 #define phpstr_clone(phpstr_pointer) phpstr_init_ex(NULL, (phpstr_pointer)->size, 0)
-PHPSTR_API phpstr *phpstr_init_ex(phpstr *buf, size_t chunk_size, zend_bool pre_alloc);
+PHPSTR_API phpstr *phpstr_init_ex(phpstr *buf, size_t chunk_size, int pre_alloc);
 
 /* create a phpstr from a zval or c-string */
 #define phpstr_from_zval(z) phpstr_from_string(Z_STRVAL(z), Z_STRLEN(z))
 #define phpstr_from_zval_ex(b, z) phpstr_from_string_ex(b, Z_STRVAL(z), Z_STRLEN(z))
 #define phpstr_from_string(s, l) phpstr_from_string_ex(NULL, (s), (l))
 
 /* create a phpstr from a zval or c-string */
 #define phpstr_from_zval(z) phpstr_from_string(Z_STRVAL(z), Z_STRLEN(z))
 #define phpstr_from_zval_ex(b, z) phpstr_from_string_ex(b, Z_STRVAL(z), Z_STRLEN(z))
 #define phpstr_from_string(s, l) phpstr_from_string_ex(NULL, (s), (l))
-PHPSTR_API phpstr *phpstr_from_string_ex(phpstr *buf, char *string, size_t length);
+PHPSTR_API phpstr *phpstr_from_string_ex(phpstr *buf, const char *string, size_t length);
 
 /* usually only called from within the internal functions */
 #define phpstr_resize(b, s) phpstr_resize_ex((b), (s), 0)
 
 /* usually only called from within the internal functions */
 #define phpstr_resize(b, s) phpstr_resize_ex((b), (s), 0)
@@ -75,20 +104,20 @@ PHPSTR_API void phpstr_resize_ex(phpstr *buf, size_t len, size_t override_size);
 /* append data to the phpstr */
 #define phpstr_appends(b, a) phpstr_append((b), (a), sizeof(a)-1)
 #define phpstr_appendl(b, a) phpstr_append((b), (a), strlen(a))
 /* append data to the phpstr */
 #define phpstr_appends(b, a) phpstr_append((b), (a), sizeof(a)-1)
 #define phpstr_appendl(b, a) phpstr_append((b), (a), strlen(a))
-PHPSTR_API void phpstr_append(phpstr *buf, const char *append, size_t append_len);
-PHPSTR_API size_t phpstr_appendf(phpstr *buf, const char *format, ...);
+PHPSTR_API size_t phpstr_append(phpstr *buf, const char *append, size_t append_len);
+PHPSTR_API size_t phpstr_appendf(phpstr *buf, const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 2, 3);
 
 /* insert data at a specific position of the phpstr */
 #define phpstr_inserts(b, i, o) phpstr_insert((b), (i), sizeof(i)-1, (o))
 #define phpstr_insertl(b, i, o) phpstr_insert((b), (i), strlen(i), (o))
 
 /* insert data at a specific position of the phpstr */
 #define phpstr_inserts(b, i, o) phpstr_insert((b), (i), sizeof(i)-1, (o))
 #define phpstr_insertl(b, i, o) phpstr_insert((b), (i), strlen(i), (o))
-PHPSTR_API void phpstr_insert(phpstr *buf, const char *insert, size_t insert_len, size_t offset);
-PHPSTR_API size_t phpstr_insertf(phpstr *buf, size_t offset, const char *format, ...);
+PHPSTR_API size_t phpstr_insert(phpstr *buf, const char *insert, size_t insert_len, size_t offset);
+PHPSTR_API size_t phpstr_insertf(phpstr *buf, size_t offset, const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 3, 4);
 
 /* prepend data */
 #define phpstr_prepends(b, p) phpstr_prepend((b), (p), sizeof(p)-1)
 #define phpstr_prependl(b, p) phpstr_prepend((b), (p), strlen(p))
 
 /* prepend data */
 #define phpstr_prepends(b, p) phpstr_prepend((b), (p), sizeof(p)-1)
 #define phpstr_prependl(b, p) phpstr_prepend((b), (p), strlen(p))
-PHPSTR_API void phpstr_prepend(phpstr *buf, const char *prepend, size_t prepend_len);
-PHPSTR_API size_t phpstr_prependf(phpstr *buf, const char *format, ...);
+PHPSTR_API size_t phpstr_prepend(phpstr *buf, const char *prepend, size_t prepend_len);
+PHPSTR_API size_t phpstr_prependf(phpstr *buf, const char *format, ...) PHP_ATTRIBUTE_FORMAT(printf, 2, 3);
 
 /* get a zero-terminated string */
 PHPSTR_API char *phpstr_data(const phpstr *buf, char **into, size_t *len);
 
 /* get a zero-terminated string */
 PHPSTR_API char *phpstr_data(const phpstr *buf, char **into, size_t *len);
@@ -100,7 +129,7 @@ PHPSTR_API phpstr *phpstr_right(const phpstr *buf, size_t length);
 PHPSTR_API phpstr *phpstr_sub(const phpstr *buf, size_t offset, size_t len);
 
 /* remove a substring */
 PHPSTR_API phpstr *phpstr_sub(const phpstr *buf, size_t offset, size_t len);
 
 /* remove a substring */
-PHPSTR_API ssize_t phpstr_cut(phpstr *buf, size_t offset, size_t length);
+PHPSTR_API size_t phpstr_cut(phpstr *buf, size_t offset, size_t length);
 
 /* get a complete phpstr duplicate */
 PHPSTR_API phpstr *phpstr_dup(const phpstr *buf);
 
 /* get a complete phpstr duplicate */
 PHPSTR_API phpstr *phpstr_dup(const phpstr *buf);
@@ -124,7 +153,13 @@ PHPSTR_API void phpstr_fix(phpstr *buf);
 PHPSTR_API void phpstr_dtor(phpstr *buf);
 
 /* free a phpstr object completely */
 PHPSTR_API void phpstr_dtor(phpstr *buf);
 
 /* free a phpstr object completely */
-PHPSTR_API void phpstr_free(phpstr *buf);
+PHPSTR_API void phpstr_free(phpstr **buf);
+
+/* stores data in a phpstr until it reaches chunk_size */
+PHPSTR_API size_t phpstr_chunk_buffer(phpstr **s, const char *data, size_t data_len, char **chunk, size_t chunk_size);
+
+/* wrapper around phpstr_chunk_buffer, which passes available chunks to passthru() */
+PHPSTR_API void phpstr_chunked_output(phpstr **s, const char *data, size_t data_len, size_t chunk_size, void (*passthru)(const char *, size_t TSRMLS_DC) TSRMLS_DC);
 
 #endif
 
 
 #endif
 
@@ -137,4 +172,3 @@ PHPSTR_API void phpstr_free(phpstr *buf);
  * vim600: sw=4 ts=4 fdm=marker
  * vim<600: sw=4 ts=4
  */
  * vim600: sw=4 ts=4 fdm=marker
  * vim<600: sw=4 ts=4
  */
-