- get rid of 1001 strict-aliasing warnings
[m6w6/ext-http] / php_http_message_api.h
index b82f0a7bade7b2a18a9e452c57b43a49acc7a0fa..e3ab8397a53ca8c6d425e6157c75112cd0ce50d5 100644 (file)
 /*
-   +----------------------------------------------------------------------+
-   | PECL :: http                                                         |
-   +----------------------------------------------------------------------+
-   | This source file is subject to version 3.0 of the PHP license, that  |
-   | is bundled with this package in the file LICENSE, and is available   |
-   | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
-   | If you did not receive a copy of the PHP license and are unable to   |
-   | obtain it through the world-wide-web, please send a note to          |
-   | license@php.net so we can mail you a copy immediately.               |
-   +----------------------------------------------------------------------+
-   | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
-   +----------------------------------------------------------------------+
+    +--------------------------------------------------------------------+
+    | PECL :: http                                                       |
+    +--------------------------------------------------------------------+
+    | Redistribution and use in source and binary forms, with or without |
+    | modification, are permitted provided that the conditions mentioned |
+    | in the accompanying LICENSE file are met.                          |
+    +--------------------------------------------------------------------+
+    | Copyright (c) 2004-2006, Michael Wallner <mike@php.net>            |
+    +--------------------------------------------------------------------+
 */
 
 /* $Id$ */
 
-/*
-DUMP:
-HttpMessage
-       ->toResponseString();
-       ->toRequestString();
-       ->__toString(); ->__sleep(); ->serialize();
-       ->fromString(); __wakeup($message); ->unserialize();
-       ->setStatusCode();
-       ->setHeader(); ->addHeader()...
-*/
+#ifndef PHP_HTTP_MESSAGE_API_H
+#define PHP_HTTP_MESSAGE_API_H
 
-#include "phpstr/phpstr.h"
+#include "php_http_info_api.h"
 
-typedef enum {
-       HTTP_MSG_NONE,
-       HTTP_MSG_REQUEST,
-       HTTP_MSG_RESPONSE
+typedef enum _http_message_type_t {
+       HTTP_MSG_NONE           = 0,
+       HTTP_MSG_REQUEST        = IS_HTTP_REQUEST,
+       HTTP_MSG_RESPONSE       = IS_HTTP_RESPONSE,
 } http_message_type;
 
-typedef struct _http_message http_message;
+typedef struct _http_message_t http_message;
 
-struct _http_message {
+struct _http_message_t {
        phpstr body;
        HashTable hdrs;
        http_message_type type;
+       struct http_info http;
+       http_message *parent;
+};
 
-       union {
-               struct {
-                       float http_version;
-                       char *method;
-                       char *URI;
-               } request;
+/* required minimum length of an HTTP message "HTTP/1.1" */
+#define HTTP_MSG_MIN_SIZE 8
+
+/* shorthand for type checks */
+#define HTTP_MSG_TYPE(TYPE, msg) ((msg) && ((msg)->type == HTTP_MSG_ ##TYPE))
+
+#define http_message_new() http_message_init_ex(NULL, 0)
+#define http_message_init(m) http_message_init_ex((m), 0)
+#define http_message_init_ex(m, t) _http_message_init_ex((m), (t) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC)
+#define http_message_init_rel(m, t) _http_message_init_ex((m), (t) ZEND_FILE_LINE_RELAY_CC ZEND_FILE_LINE_ORIG_RELAY_CC)
+PHP_HTTP_API http_message *_http_message_init_ex(http_message *m, http_message_type t ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC);
+
+#define http_message_set_type(m, t) _http_message_set_type((m), (t))
+PHP_HTTP_API void _http_message_set_type(http_message *m, http_message_type t);
+
+#define http_message_set_info(m, i) _http_message_set_info((m), (i))
+PHP_HTTP_API void _http_message_set_info(http_message *message, http_info *info);
+
+#define http_message_header(m, h) _http_message_header_ex((m), (h), sizeof(h))
+#define http_message_header_ex _http_message_header_ex
+static inline zval *_http_message_header_ex(http_message *msg, char *key_str, size_t key_len)
+{
+       zval **header;
+       if (SUCCESS == zend_hash_find(&msg->hdrs, key_str, key_len, (void *) &header)) {
+               return *header;
+       }
+       return NULL;
+}
+
+#define http_message_count(c, m) \
+{ \
+       http_message *__tmp_msg = (m); \
+       for (c = 0; __tmp_msg; __tmp_msg = __tmp_msg->parent, ++(c)); \
+}
+
+#define http_message_parse(m, l) http_message_parse_ex(NULL, (m), (l))
+#define http_message_parse_ex(h, m, l) _http_message_parse_ex((h), (m), (l) ZEND_FILE_LINE_CC ZEND_FILE_LINE_EMPTY_CC TSRMLS_CC)
+#define http_message_parse_rel(h, m, l) _http_message_parse_ex((h), (m), (l) ZEND_FILE_LINE_RELAY_CC ZEND_FILE_LINE_ORIG_RELAY_CC TSRMLS_CC)
+PHP_HTTP_API http_message *_http_message_parse_ex(http_message *msg, const char *message, size_t length ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC);
 
-               struct {
-                       float http_version;
-                       int status;
-               } response;
+#define http_message_tostring(m, s, l) _http_message_tostring((m), (s), (l))
+PHP_HTTP_API void _http_message_tostring(http_message *msg, char **string, size_t *length);
 
-       } info;
+#define http_message_serialize(m, s, l) _http_message_serialize((m), (s), (l))
+PHP_HTTP_API void _http_message_serialize(http_message *message, char **string, size_t *length);
 
-       size_t          len;
-       zend_bool       dup;
+#define http_message_reverse(m) _http_message_reverse(m)
+PHP_HTTP_API http_message *_http_message_reverse(http_message *msg);
 
-       union {
-               char *dup;
-               const char *ptr;
-       } raw;
+#define http_message_interconnect(m1, m2) _http_message_interconnect((m1), (m2))
+PHP_HTTP_API http_message *_http_message_interconnect(http_message *m1, http_message *m2);
 
-       http_message *nested;
-};
+#define http_message_tostruct_recursive(m, s) _http_message_tostruct_recursive((m), (s) TSRMLS_CC)
+PHP_HTTP_API void _http_message_tostruct_recursive(http_message *msg, zval *strct TSRMLS_DC);
 
-/* required minimum length of an HTTP message "HTTP/1.1 200\r\n" */
-#define HTTP_MSG_MIN_SIZE 15
+#define http_message_send(m) _http_message_send((m) TSRMLS_CC)
+PHP_HTTP_API STATUS _http_message_send(http_message *message TSRMLS_DC);
 
-#define HTTP_MSG_RAW(msg) ( (msg)->dup ? msg->raw.dup : msg->raw.ptr )
+#define http_message_dup(m) _http_message_dup((m) TSRMLS_CC)
+PHP_HTTP_API http_message *_http_message_dup(http_message *msg TSRMLS_DC);
 
-#define http_message_init() _http_message_init_ex(NULL, 0)
-#define http_message_init_ex(m, t) _http_message_init_ex((m), (t))
-#define http_message_free(m) _http_message_free((m))
 #define http_message_dtor(m) _http_message_dtor((m))
-
 PHP_HTTP_API void _http_message_dtor(http_message *message);
-PHP_HTTP_API void _http_message_free(http_message *message);
 
-#define http_message_parse(m, l) http_message_parse_ex((m), (l), 1)
-#define http_message_parse_ex(m, l, d) _http_message_parse_ex((m), (l), (d) TSRMLS_CC)
-PHP_HTTP_API http_message *_http_message_parse_ex(const char *message, size_t length, zend_bool duplicate TSRMLS_DC);
+#define http_message_free(m) _http_message_free((m))
+PHP_HTTP_API void _http_message_free(http_message **message);
 
-#define http_message_tostring(m, s, l) _http_message_tostring((m), (s), (l))
-PHP_HTTP_API void _http_message_tostring(http_message *msg, char **string, size_t *length);
+#endif
 
+/*
+ * Local variables:
+ * tab-width: 4
+ * c-basic-offset: 4
+ * End:
+ * vim600: noet sw=4 ts=4 fdm=marker
+ * vim<600: noet sw=4 ts=4
+ */