- add PHP_ATTRIBUTE_FORMAT

[m6w6/ext-http] / phpstr / phpstr.h

diff --git a/phpstr/phpstr.h b/phpstr/phpstr.h
index 50d9c283c14616a619ce72ee1cf93131dc4f4a67..9ef71efbe5d3bc33a9a3802b20529f5ffe0e4e6e 100644 (file)
--- a/phpstr/phpstr.h
+++ b/phpstr/phpstr.h
@@ -4,12 +4,18 @@
 #ifndef _PHPSTR_H_
 #define _PHPSTR_H_
 
+#include "php.h"
+
 #ifdef PHP_WIN32
 #      define PHPSTR_API __declspec(dllexport)
 #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_ALL(STR) phpstr_free(STR)
@@ -25,6 +31,8 @@
 
 #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 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)); \
@@ -35,21 +43,19 @@
        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;
-};
-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() */
-};
-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)
@@ -66,7 +72,7 @@ PHPSTR_API phpstr *phpstr_init_ex(phpstr *buf, size_t chunk_size, zend_bool pre_
 #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)
@@ -75,20 +81,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))
-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))
-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))
-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);
@@ -100,7 +106,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 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);