consitency with type names
[m6w6/ext-http] / php_http_buffer.h
index 57729bbdac2a118d84837bf2940b7e232bc6f150..ee78c41165f048ea5bd4b505c3dd141401dc4f7c 100644 (file)
@@ -1,5 +1,5 @@
 
-/* $Id: php_http_buffer.h 229282 2007-02-07 15:31:50Z mike $ */
+/* $Id: php_http_buffer_t.h 229282 2007-02-07 15:31:50Z mike $ */
 
 #ifndef _PHP_HTTP_BUFFER_H
 #define _PHP_HTTP_BUFFER_H
@@ -64,7 +64,7 @@ static inline void *estrndup(void *p, size_t s)
 #      define PHP_HTTP_BUFFER_API
 #endif
 
-#define PHP_HTTP_BUFFER(p) ((php_http_buffer *) (p))
+#define PHP_HTTP_BUFFER(p) ((php_http_buffer_t *) (p))
 #define PHP_HTTP_BUFFER_VAL(p) (PHP_HTTP_BUFFER(p))->data
 #define PHP_HTTP_BUFFER_LEN(p) (PHP_HTTP_BUFFER(p))->used
 
@@ -79,7 +79,7 @@ static inline void *estrndup(void *p, size_t s)
                case PHP_HTTP_BUFFER_FREE_VAL:  php_http_buffer_dtor(STR);              break; \
                case PHP_HTTP_BUFFER_FREE_ALL: \
                { \
-                       php_http_buffer *PTR = (STR); \
+                       php_http_buffer_t *PTR = (STR); \
                        php_http_buffer_free(&PTR); \
                } \
                break; \
@@ -102,20 +102,20 @@ static inline void *estrndup(void *p, size_t s)
        RETVAL_STRINGL((STR)->data, (STR)->used, (dup)); \
        FREE_PHP_HTTP_BUFFER((free), (STR));
 
-typedef struct _php_http_buffer_t {
+typedef struct php_http_buffer {
        char  *data;
        size_t used;
        size_t free;
        size_t size;
        unsigned pmem:1;
        unsigned reserved:31;
-} php_http_buffer;
+} php_http_buffer_t;
 
-typedef enum _php_http_buffer_free_t {
+typedef enum php_http_buffer_free {
        PHP_HTTP_BUFFER_FREE_NOT = 0,
        PHP_HTTP_BUFFER_FREE_PTR,       /* pefree() */
        PHP_HTTP_BUFFER_FREE_VAL,       /* php_http_buffer_dtor() */
-       PHP_HTTP_BUFFER_FREE_ALL                /* php_http_buffer_free() */
+       PHP_HTTP_BUFFER_FREE_ALL        /* php_http_buffer_free() */
 } php_http_buffer_free_t;
 
 #define PHP_HTTP_BUFFER_ALL_FREE(STR) PHP_HTTP_BUFFER_FREE_ALL,(STR)
@@ -126,95 +126,95 @@ typedef enum _php_http_buffer_free_t {
 #define PHP_HTTP_BUFFER_INIT_PREALLOC  0x01
 #define PHP_HTTP_BUFFER_INIT_PERSISTENT        0x02
 
-/* create a new php_http_buffer */
+/* create a new php_http_buffer_t */
 #define php_http_buffer_new() php_http_buffer_init(NULL)
 #define php_http_buffer_init(b) php_http_buffer_init_ex(b, PHP_HTTP_BUFFER_DEFAULT_SIZE, 0)
-#define php_http_buffer_clone(php_http_buffer_pointer) php_http_buffer_init_ex(NULL, (php_http_buffer_pointer)->size, (php_http_buffer_pointer)->pmem ? PHP_HTTP_BUFFER_INIT_PERSISTENT:0)
-PHP_HTTP_BUFFER_API php_http_buffer *php_http_buffer_init_ex(php_http_buffer *buf, size_t chunk_size, int flags);
+#define php_http_buffer_clone(from, to) php_http_buffer_init_ex((to), (from)->size, (from)->pmem ? PHP_HTTP_BUFFER_INIT_PERSISTENT:0)
+PHP_HTTP_BUFFER_API php_http_buffer_t *php_http_buffer_init_ex(php_http_buffer_t *buf, size_t chunk_size, int flags);
 
-/* create a php_http_buffer from a zval or c-string */
+/* create a php_http_buffer_t from a zval or c-string */
 #define php_http_buffer_from_zval(z) php_http_buffer_from_string(Z_STRVAL(z), Z_STRLEN(z))
 #define php_http_buffer_from_zval_ex(b, z) php_http_buffer_from_string_ex(b, Z_STRVAL(z), Z_STRLEN(z))
 #define php_http_buffer_from_string(s, l) php_http_buffer_from_string_ex(NULL, (s), (l))
-PHP_HTTP_BUFFER_API php_http_buffer *php_http_buffer_from_string_ex(php_http_buffer *buf, const char *string, size_t length);
+PHP_HTTP_BUFFER_API php_http_buffer_t *php_http_buffer_from_string_ex(php_http_buffer_t *buf, const char *string, size_t length);
 
 /* usually only called from within the internal functions */
 #define php_http_buffer_resize(b, s) php_http_buffer_resize_ex((b), (s), 0, 0)
-PHP_HTTP_BUFFER_API size_t php_http_buffer_resize_ex(php_http_buffer *buf, size_t len, size_t override_size, int allow_error);
+PHP_HTTP_BUFFER_API size_t php_http_buffer_resize_ex(php_http_buffer_t *buf, size_t len, size_t override_size, int allow_error);
 
 /* shrink memory chunk to actually used size (+1) */
-PHP_HTTP_BUFFER_API size_t php_http_buffer_shrink(php_http_buffer *buf);
+PHP_HTTP_BUFFER_API size_t php_http_buffer_shrink(php_http_buffer_t *buf);
 
-/* append data to the php_http_buffer */
+/* append data to the php_http_buffer_t */
 #define php_http_buffer_appends(b, a) php_http_buffer_append((b), (a), sizeof(a)-1)
 #define php_http_buffer_appendl(b, a) php_http_buffer_append((b), (a), strlen(a))
-PHP_HTTP_BUFFER_API size_t php_http_buffer_append(php_http_buffer *buf, const char *append, size_t append_len);
-PHP_HTTP_BUFFER_API size_t php_http_buffer_appendf(php_http_buffer *buf, const char *format, ...) PHP_HTTP_BUFFER_ATTRIBUTE_FORMAT(printf, 2, 3);
+PHP_HTTP_BUFFER_API size_t php_http_buffer_append(php_http_buffer_t *buf, const char *append, size_t append_len);
+PHP_HTTP_BUFFER_API size_t php_http_buffer_appendf(php_http_buffer_t *buf, const char *format, ...) PHP_HTTP_BUFFER_ATTRIBUTE_FORMAT(printf, 2, 3);
 
-/* insert data at a specific position of the php_http_buffer */
+/* insert data at a specific position of the php_http_buffer_t */
 #define php_http_buffer_inserts(b, i, o) php_http_buffer_insert((b), (i), sizeof(i)-1, (o))
 #define php_http_buffer_insertl(b, i, o) php_http_buffer_insert((b), (i), strlen(i), (o))
-PHP_HTTP_BUFFER_API size_t php_http_buffer_insert(php_http_buffer *buf, const char *insert, size_t insert_len, size_t offset);
-PHP_HTTP_BUFFER_API size_t php_http_buffer_insertf(php_http_buffer *buf, size_t offset, const char *format, ...) PHP_HTTP_BUFFER_ATTRIBUTE_FORMAT(printf, 3, 4);
+PHP_HTTP_BUFFER_API size_t php_http_buffer_insert(php_http_buffer_t *buf, const char *insert, size_t insert_len, size_t offset);
+PHP_HTTP_BUFFER_API size_t php_http_buffer_insertf(php_http_buffer_t *buf, size_t offset, const char *format, ...) PHP_HTTP_BUFFER_ATTRIBUTE_FORMAT(printf, 3, 4);
 
 /* prepend data */
 #define php_http_buffer_prepends(b, p) php_http_buffer_prepend((b), (p), sizeof(p)-1)
 #define php_http_buffer_prependl(b, p) php_http_buffer_prepend((b), (p), strlen(p))
-PHP_HTTP_BUFFER_API size_t php_http_buffer_prepend(php_http_buffer *buf, const char *prepend, size_t prepend_len);
-PHP_HTTP_BUFFER_API size_t php_http_buffer_prependf(php_http_buffer *buf, const char *format, ...) PHP_HTTP_BUFFER_ATTRIBUTE_FORMAT(printf, 2, 3);
+PHP_HTTP_BUFFER_API size_t php_http_buffer_prepend(php_http_buffer_t *buf, const char *prepend, size_t prepend_len);
+PHP_HTTP_BUFFER_API size_t php_http_buffer_prependf(php_http_buffer_t *buf, const char *format, ...) PHP_HTTP_BUFFER_ATTRIBUTE_FORMAT(printf, 2, 3);
 
 /* get a zero-terminated string */
-PHP_HTTP_BUFFER_API char *php_http_buffer_data(const php_http_buffer *buf, char **into, size_t *len);
+PHP_HTTP_BUFFER_API char *php_http_buffer_data(const php_http_buffer_t *buf, char **into, size_t *len);
 
-/* get a part of the php_http_buffer */
+/* get a part of the php_http_buffer_t */
 #define php_http_buffer_mid(b, o, l) php_http_buffer_sub((b), (o), (l))
 #define php_http_buffer_left(b, l) php_http_buffer_sub((b), 0, (l))
-PHP_HTTP_BUFFER_API php_http_buffer *php_http_buffer_right(const php_http_buffer *buf, size_t length);
-PHP_HTTP_BUFFER_API php_http_buffer *php_http_buffer_sub(const php_http_buffer *buf, size_t offset, size_t len);
+PHP_HTTP_BUFFER_API php_http_buffer_t *php_http_buffer_right(const php_http_buffer_t *buf, size_t length);
+PHP_HTTP_BUFFER_API php_http_buffer_t *php_http_buffer_sub(const php_http_buffer_t *buf, size_t offset, size_t len);
 
 /* remove a substring */
-PHP_HTTP_BUFFER_API size_t php_http_buffer_cut(php_http_buffer *buf, size_t offset, size_t length);
+PHP_HTTP_BUFFER_API size_t php_http_buffer_cut(php_http_buffer_t *buf, size_t offset, size_t length);
 
-/* get a complete php_http_buffer duplicate */
-PHP_HTTP_BUFFER_API php_http_buffer *php_http_buffer_dup(const php_http_buffer *buf);
+/* get a complete php_http_buffer_t duplicate */
+PHP_HTTP_BUFFER_API php_http_buffer_t *php_http_buffer_copy(const php_http_buffer_t *from, php_http_buffer_t *to);
 
-/* merge several php_http_buffer objects
+/* merge several php_http_buffer_t objects
    use like:
 
-       php_http_buffer *final = php_http_buffer_merge(3,
+       php_http_buffer_t *final = php_http_buffer_merge(3,
                PHP_HTTP_BUFFER_NOT_FREE(&keep),
                PHP_HTTP_BUFFER_ALL_FREE(middle_ptr),
                PHP_HTTP_BUFFER_VAL_FREE(&local);
 */
-PHP_HTTP_BUFFER_API php_http_buffer *php_http_buffer_merge(unsigned argc, ...);
-PHP_HTTP_BUFFER_API php_http_buffer *php_http_buffer_merge_ex(php_http_buffer *buf, unsigned argc, ...);
-PHP_HTTP_BUFFER_API php_http_buffer *php_http_buffer_merge_va(php_http_buffer *buf, unsigned argc, va_list argv);
+PHP_HTTP_BUFFER_API php_http_buffer_t *php_http_buffer_merge(unsigned argc, ...);
+PHP_HTTP_BUFFER_API php_http_buffer_t *php_http_buffer_merge_ex(php_http_buffer_t *buf, unsigned argc, ...);
+PHP_HTTP_BUFFER_API php_http_buffer_t *php_http_buffer_merge_va(php_http_buffer_t *buf, unsigned argc, va_list argv);
 
 /* sets a trailing NUL byte */
-PHP_HTTP_BUFFER_API php_http_buffer *php_http_buffer_fix(php_http_buffer *buf);
+PHP_HTTP_BUFFER_API php_http_buffer_t *php_http_buffer_fix(php_http_buffer_t *buf);
 
-/* memcmp for php_http_buffer objects */
-PHP_HTTP_BUFFER_API int php_http_buffer_cmp(php_http_buffer *left, php_http_buffer *right);
+/* memcmp for php_http_buffer_t objects */
+PHP_HTTP_BUFFER_API int php_http_buffer_cmp(php_http_buffer_t *left, php_http_buffer_t *right);
 
-/* reset php_http_buffer object */
-PHP_HTTP_BUFFER_API void php_http_buffer_reset(php_http_buffer *buf);
+/* reset php_http_buffer_t object */
+PHP_HTTP_BUFFER_API void php_http_buffer_reset(php_http_buffer_t *buf);
 
-/* free a php_http_buffer objects contents */
-PHP_HTTP_BUFFER_API void php_http_buffer_dtor(php_http_buffer *buf);
+/* free a php_http_buffer_t objects contents */
+PHP_HTTP_BUFFER_API void php_http_buffer_dtor(php_http_buffer_t *buf);
 
-/* free a php_http_buffer object completely */
-PHP_HTTP_BUFFER_API void php_http_buffer_free(php_http_buffer **buf);
+/* free a php_http_buffer_t object completely */
+PHP_HTTP_BUFFER_API void php_http_buffer_free(php_http_buffer_t **buf);
 
-/* stores data in a php_http_buffer until it reaches chunk_size */
-PHP_HTTP_BUFFER_API size_t php_http_buffer_chunk_buffer(php_http_buffer **s, const char *data, size_t data_len, char **chunk, size_t chunk_size);
+/* stores data in a php_http_buffer_t until it reaches chunk_size */
+PHP_HTTP_BUFFER_API size_t php_http_buffer_chunk_buffer(php_http_buffer_t **s, const char *data, size_t data_len, char **chunk, size_t chunk_size);
 
 typedef size_t (*php_http_buffer_pass_func_t)(void *opaque, const char *, size_t TSRMLS_DC);
 
 /* wrapper around php_http_buffer_chunk_buffer, which passes available chunks to passthru() */
-PHP_HTTP_BUFFER_API void php_http_buffer_chunked_output(php_http_buffer **s, const char *data, size_t data_len, size_t chunk_size, php_http_buffer_pass_func_t passout, void *opaque TSRMLS_DC);
+PHP_HTTP_BUFFER_API void php_http_buffer_chunked_output(php_http_buffer_t **s, const char *data, size_t data_len, size_t chunk_size, php_http_buffer_pass_func_t passout, void *opaque TSRMLS_DC);
 
-/* write chunks directly into php_http_buffer buffer */
-PHP_HTTP_BUFFER_API size_t php_http_buffer_chunked_input(php_http_buffer **s, size_t chunk_size, php_http_buffer_pass_func_t passin, void *opaque TSRMLS_DC);
+/* write chunks directly into php_http_buffer_t buffer */
+PHP_HTTP_BUFFER_API size_t php_http_buffer_chunked_input(php_http_buffer_t **s, size_t chunk_size, php_http_buffer_pass_func_t passin, void *opaque TSRMLS_DC);
 
 #endif