From: Michael Wallner Date: Wed, 30 Sep 2015 09:13:06 +0000 (+0200) Subject: more standardization X-Git-Tag: release-1.0.2RC1~8 X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-propro;a=commitdiff_plain;h=8e6c28e6e5c9ef473c705f49a4b9f30ed774231b more standardization --- diff --git a/.editorconfig b/.editorconfig index 84c9933..9b444ae 100644 --- a/.editorconfig +++ b/.editorconfig @@ -14,3 +14,10 @@ trim_trailing_whitespace = false [*.json] indent_style = space indent_size = 4 + +[package.xml] +indent_style = space +indent_size = 1 + +[config.w32] +end_of_line = crlf diff --git a/.gitattributes b/.gitattributes index f6d1a5e..9d51e13 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,2 +1,3 @@ package.xml merge=touch php_propro.h merge=touch +config.w32 eol=crlf diff --git a/.gitignore b/.gitignore index a59cb22..82c850f 100644 --- a/.gitignore +++ b/.gitignore @@ -3,8 +3,8 @@ *~ /*.tgz /.deps -/*.lo -/*.la +*.lo +*.la /config.[^wm]* /configure* /lib* @@ -21,3 +21,5 @@ /autom4te* /.dep.inc run-tests.php +.libs/ +/php_propro_api.h diff --git a/BUGS b/BUGS new file mode 100644 index 0000000..75711d2 --- /dev/null +++ b/BUGS @@ -0,0 +1 @@ +Yay, now known and unresolved issues yet! diff --git a/CREDITS b/CREDITS index 28b53ed..920bbcb 100644 --- a/CREDITS +++ b/CREDITS @@ -1 +1,2 @@ -propro \ No newline at end of file +propro +Michael Wallner diff --git a/README.md b/README.md index 88242d9..a4aaa1f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,16 @@ # ext-propro -[![Build Status](https://travis-ci.org/m6w6/ext-propro.svg?branch=R_1_0)](https://travis-ci.org/m6w6/ext-propro) +[![Build Status](https://travis-ci.org/m6w6/ext-propro.svg?branch=v1.0.x)](https://travis-ci.org/m6w6/ext-propro) -Property Proxy +The "Property Proxy" extension provides a fairly transparent proxy for internal +object properties hidden in custom non-zval implementations. ## Documentation See the [online markdown reference](https://mdref.m6w6.name/propro). +Known issues are listed in [BUGS](./BUGS) and future ideas can be found in [TODO](./TODO). + ## Installing ### PECL diff --git a/TODO b/TODO new file mode 100644 index 0000000..e69de29 diff --git a/config.m4 b/config.m4 index 1a4965e..3b883c8 100644 --- a/config.m4 +++ b/config.m4 @@ -1,7 +1 @@ -PHP_ARG_ENABLE(propro, whether to enable property proxy support, -[ --enable-propro Enable property proxy support]) - -if test "$PHP_PROPRO" != "no"; then - PHP_INSTALL_HEADERS(ext/propro, php_propro.h php_propro_api.h) - PHP_NEW_EXTENSION(propro, php_propro.c, $ext_shared) -fi +sinclude(config0.m4) diff --git a/config.w32 b/config.w32 index 53ab56e..ed086e8 100644 --- a/config.w32 +++ b/config.w32 @@ -1,9 +1,16 @@ - -ARG_ENABLE("propro", "for propro support", "no"); - -if (PHP_PROPRO == "yes") { - EXTENSION("propro", "php_propro.c"); - - AC_DEFINE("HAVE_PROPRO", 1); - PHP_INSTALL_HEADERS("ext/propro", "php_propro.h"); -} + +ARG_ENABLE("propro", "for propro support", "no"); + +if (PHP_PROPRO == "yes") { + var PHP_PROPRO_HEADERS=glob("src/*.h"), PHP_PROPRO_SOURCES=glob("src/*.c"); + + EXTENSION("propro", PHP_PROPRO_SOURCES); + PHP_INSTALL_HEADERS("ext/propro", "php_propro.h"); + for (var i=0; i ["5.4", "5.5", "5.6"], - "enable_debug", - "enable_maintainer_zts", -]); -foreach ($env as $e) { - printf(" - %s\n", $e); -} - -?> - -before_script: - - make -f travis/pecl/Makefile php - - make -f travis/pecl/Makefile ext PECL=propro - -script: - - make -f travis/pecl/Makefile test - diff --git a/package.xml b/package.xml index 60f0d38..f926f4d 100644 --- a/package.xml +++ b/package.xml @@ -35,18 +35,25 @@ http://pear.php.net/dtd/package-2.0.xsd"> + + + - - - + + + + + + + diff --git a/php_propro.c b/php_propro.c deleted file mode 100644 index d7232b3..0000000 --- a/php_propro.c +++ /dev/null @@ -1,590 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | PECL :: propro | - +--------------------------------------------------------------------+ - | 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) 2013 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - - -#ifdef HAVE_CONFIG_H -# include "config.h" -#endif - -#include -#include - -#include "php_propro_api.h" - -#if PHP_VERSION_ID < 50500 -#undef SUCCESS -#undef FAILURE -typedef enum { - SUCCESS = 0, - FAILURE = -1 -} ZEND_RESULT_CODE; -#endif - -#define DEBUG_PROPRO 0 - -#if PHP_VERSION_ID < 50400 -# define object_properties_init(o, ce) \ - zend_hash_copy(((zend_object *) o)->properties, &(ce->default_properties), \ - (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval*)) -#endif - -php_property_proxy_t *php_property_proxy_init(zval *container, - const char *member_str, size_t member_len TSRMLS_DC) -{ - php_property_proxy_t *proxy = ecalloc(1, sizeof(*proxy)); - - Z_ADDREF_P(container); - proxy->container = container; - proxy->member_str = estrndup(member_str, member_len); - proxy->member_len = member_len; - - return proxy; -} - -void php_property_proxy_free(php_property_proxy_t **proxy) -{ - if (*proxy) { - zval_ptr_dtor(&(*proxy)->container); - efree((*proxy)->member_str); - efree(*proxy); - *proxy = NULL; - } -} - -static zend_class_entry *php_property_proxy_class_entry; -static zend_object_handlers php_property_proxy_object_handlers; - -zend_class_entry *php_property_proxy_get_class_entry(void) -{ - return php_property_proxy_class_entry; -} - -zend_object_value php_property_proxy_object_new(zend_class_entry *ce TSRMLS_DC) -{ - return php_property_proxy_object_new_ex(ce, NULL, NULL TSRMLS_CC); -} - -static void php_property_proxy_object_free(void *object TSRMLS_DC) -{ - php_property_proxy_object_t *o = object; - -#if DEBUG_PROPRO - fprintf(stderr, "#PP %p free\n", o); -#endif - - if (o->proxy) { - php_property_proxy_free(&o->proxy); - } - if (o->parent) { - zend_objects_store_del_ref_by_handle_ex(o->parent->zv.handle, - o->parent->zv.handlers TSRMLS_CC); - o->parent = NULL; - } - zend_object_std_dtor((zend_object *) o TSRMLS_CC); - efree(o); -} - -zend_object_value php_property_proxy_object_new_ex(zend_class_entry *ce, - php_property_proxy_t *proxy, php_property_proxy_object_t **ptr TSRMLS_DC) -{ - php_property_proxy_object_t *o; - - o = ecalloc(1, sizeof(*o)); - zend_object_std_init((zend_object *) o, ce TSRMLS_CC); - object_properties_init((zend_object *) o, ce); - - if (ptr) { - *ptr = o; - } - o->proxy = proxy; - - o->zv.handle = zend_objects_store_put(o, NULL, - php_property_proxy_object_free, NULL TSRMLS_CC); - o->zv.handlers = &php_property_proxy_object_handlers; - -#if DEBUG_PROPRO - fprintf(stderr, "#PP %p init\n", o); -#endif - - return o->zv; -} - -#if DEBUG_PROPRO -/* we do not really care about TS when debugging */ -static int level = 1; -static const char space[] = " "; -static const char *inoutstr[] = {"< return",""," > enter"}; -static void _walk(php_property_proxy_object_t *obj TSRMLS_DC) -{ - if (obj) { - _walk(obj->parent TSRMLS_CC); - fprintf(stderr, ".%s", obj->proxy->member_str); - } -} - -static void debug_propro(int inout, const char *f, zval *object, zval *offset, - zval *value TSRMLS_DC) -{ - php_property_proxy_object_t *obj; - - obj = zend_object_store_get_object(object TSRMLS_CC); - fprintf(stderr, "#PP %p %s %s %s ", obj, &space[sizeof(space)-level], - inoutstr[inout+1], f); - - level += inout; - - _walk(obj TSRMLS_CC); - - if (*f++=='d' - && *f++=='i' - && *f++=='m' - ) { - char *offset_str = "[]"; - zval *o = offset; - - if (o) { - convert_to_string_ex(&o); - offset_str = Z_STRVAL_P(o); - } - - fprintf(stderr, ".%s", offset_str); - - if (o && o != offset) { - zval_ptr_dtor(&o); - } - } - if (value) { - const char *t[] = { - "NULL", - "int", - "float", - "bool", - "Array", - "Object", - "string", - "resource", - "const", - "const Array", - "callable" - }; - fprintf(stderr, " = (%s) ", t[Z_TYPE_P(value)&0xf]); - zend_print_flat_zval_r(value TSRMLS_CC); - } - - fprintf(stderr, "\n"); -} -#else -#define debug_propro(l, f, obj, off, val) -#endif - -static zval *get_parent_proxied_value(zval *object TSRMLS_DC); -static zval *get_proxied_value(zval *object TSRMLS_DC); -static zval *read_dimension(zval *object, zval *offset, int type TSRMLS_DC); -static ZEND_RESULT_CODE cast_proxied_value(zval *object, zval *return_value, - int type TSRMLS_DC); -static void write_dimension(zval *object, zval *offset, zval *value TSRMLS_DC); -static void set_proxied_value(zval **object, zval *value TSRMLS_DC); - -static zval *get_parent_proxied_value(zval *object TSRMLS_DC) -{ - zval *value = NULL; - php_property_proxy_object_t *obj; - - obj = zend_object_store_get_object(object TSRMLS_CC); - if (obj->proxy) { - if (obj->parent) { - zval *parent; - - MAKE_STD_ZVAL(parent); - parent->type = IS_OBJECT; - parent->value.obj = obj->parent->zv; - zend_objects_store_add_ref_by_handle( - obj->parent->zv.handle TSRMLS_CC); - value = get_proxied_value(parent TSRMLS_CC); - zval_ptr_dtor(&parent); - } - } - - return value; -} - -static zval *get_proxied_value(zval *object TSRMLS_DC) -{ - zval **hash_value, *value = NULL; - php_property_proxy_object_t *obj; - ZEND_RESULT_CODE rv; - - obj = zend_object_store_get_object(object TSRMLS_CC); - debug_propro(1, "get", object, NULL, NULL TSRMLS_CC); - - if (obj->proxy) { - if (obj->parent) { - zval *parent_value = get_parent_proxied_value(object TSRMLS_CC); - - if (parent_value && parent_value != obj->proxy->container) { - Z_ADDREF_P(parent_value); - zval_ptr_dtor(&obj->proxy->container); - obj->proxy->container = parent_value; - } - } - switch (Z_TYPE_P(obj->proxy->container)) { - case IS_OBJECT: - value = zend_read_property(Z_OBJCE_P(obj->proxy->container), - obj->proxy->container, obj->proxy->member_str, - obj->proxy->member_len, 0 TSRMLS_CC); - break; - - case IS_ARRAY: - rv = zend_symtable_find(Z_ARRVAL_P(obj->proxy->container), - obj->proxy->member_str, obj->proxy->member_len + 1, - (void *) &hash_value); - - if (SUCCESS == rv) { - value = *hash_value; - } - break; - } - } - - debug_propro(-1, "get", object, NULL, value TSRMLS_CC); - - return value; -} - -static ZEND_RESULT_CODE cast_proxied_value(zval *object, zval *return_value, - int type TSRMLS_DC) -{ - zval *proxied_value; - - if ((proxied_value = get_proxied_value(object TSRMLS_CC))) { - RETVAL_ZVAL(proxied_value, 1, 0); - if (Z_TYPE_P(proxied_value) != type) { - convert_to_explicit_type(return_value, type); - } - return SUCCESS; - } - - return FAILURE; -} - -static void set_proxied_value(zval **object, zval *value TSRMLS_DC) -{ - php_property_proxy_object_t *obj; - - obj = zend_object_store_get_object(*object TSRMLS_CC); - debug_propro(1, "set", *object, NULL, value TSRMLS_CC); - - if (obj->proxy) { - if (obj->parent) { - zval *parent_value = get_parent_proxied_value(*object TSRMLS_CC); - - if (parent_value && parent_value != obj->proxy->container) { - Z_ADDREF_P(parent_value); - zval_ptr_dtor(&obj->proxy->container); - obj->proxy->container = parent_value; - } - } - - switch (Z_TYPE_P(obj->proxy->container)) { - case IS_OBJECT: - zend_update_property(Z_OBJCE_P(obj->proxy->container), - obj->proxy->container, obj->proxy->member_str, - obj->proxy->member_len, value TSRMLS_CC); - break; - - case IS_ARRAY: - Z_ADDREF_P(value); - zend_symtable_update(Z_ARRVAL_P(obj->proxy->container), - obj->proxy->member_str, obj->proxy->member_len + 1, - (void *) &value, sizeof(zval *), NULL); - break; - } - - if (obj->parent) { - zval *zparent; - MAKE_STD_ZVAL(zparent); - zparent->type = IS_OBJECT; - zparent->value.obj = obj->parent->zv; - zend_objects_store_add_ref_by_handle( - obj->parent->zv.handle TSRMLS_CC); - set_proxied_value(&zparent, obj->proxy->container TSRMLS_CC); - zval_ptr_dtor(&zparent); - } - } - - debug_propro(-1, "set", *object, NULL, NULL TSRMLS_CC); -} - -static zval *read_dimension(zval *object, zval *offset, int type TSRMLS_DC) -{ - zval *value = NULL; - zval *proxied_value; - zval *o = offset; - - debug_propro(1, type == BP_VAR_R ? "dim_read" : "dim_read_ref", object, - offset, NULL TSRMLS_CC); - - proxied_value = get_proxied_value(object TSRMLS_CC); - convert_to_string_ex(&o); - - if (BP_VAR_R == type && proxied_value) { - if (Z_TYPE_P(proxied_value) == IS_ARRAY) { - zval **hash_value; - ZEND_RESULT_CODE rv = zend_symtable_find(Z_ARRVAL_P(proxied_value), - Z_STRVAL_P(o), Z_STRLEN_P(o), (void *) &hash_value); - - if (SUCCESS == rv) { - Z_ADDREF_PP(hash_value); - value = *hash_value; - } - } - } else { - php_property_proxy_t *proxy; - php_property_proxy_object_t *proxy_obj; - - if (proxied_value) { - convert_to_array(proxied_value); - Z_ADDREF_P(proxied_value); - } else { - MAKE_STD_ZVAL(proxied_value); - array_init(proxied_value); - set_proxied_value(&object, proxied_value TSRMLS_CC); - } - - proxy = php_property_proxy_init(proxied_value, Z_STRVAL_P(o), - Z_STRLEN_P(o) TSRMLS_CC); - zval_ptr_dtor(&proxied_value); - MAKE_STD_ZVAL(value); - Z_SET_REFCOUNT_P(value, 0); - value->type = IS_OBJECT; - value->value.obj = php_property_proxy_object_new_ex( - php_property_proxy_get_class_entry(), proxy, - &proxy_obj TSRMLS_CC); - proxy_obj->parent = zend_object_store_get_object(object TSRMLS_CC); - zend_objects_store_add_ref_by_handle( - proxy_obj->parent->zv.handle TSRMLS_CC); - } - if (o && o != offset) { - zval_ptr_dtor(&o); - } - - debug_propro(-1, type == BP_VAR_R ? "dim_read" : "dim_read_ref", object, - offset, value TSRMLS_CC); - - return value; -} - -static int has_dimension(zval *object, zval *offset, int check_empty TSRMLS_DC) -{ - zval *proxied_value; - int exists = 0; - - debug_propro(1, "dim_exists", object, offset, NULL TSRMLS_CC); - - proxied_value = get_proxied_value(object TSRMLS_CC); - if (!proxied_value) { - exists = 0; - } else { - zval *o = offset; - - convert_to_string_ex(&o); - - if (Z_TYPE_P(proxied_value) == IS_ARRAY) { - zval **zentry; - ZEND_RESULT_CODE rv = zend_symtable_find(Z_ARRVAL_P(proxied_value), Z_STRVAL_P(o), Z_STRLEN_P(o) + 1, (void *) &zentry); - - if (SUCCESS != rv) { - exists = 0; - } else { - if (check_empty) { - exists = Z_TYPE_PP(zentry) != IS_NULL; - } else { - exists = 1; - } - } - } - - if (o != offset) { - zval_ptr_dtor(&o); - } - } - - debug_propro(-1, "dim_exists", object, offset, NULL TSRMLS_CC); - - return exists; -} - -static void write_dimension(zval *object, zval *offset, zval *value TSRMLS_DC) -{ - zval *proxied_value, *o = offset; - - debug_propro(1, "dim_write", object, offset, value TSRMLS_CC); - - proxied_value = get_proxied_value(object TSRMLS_CC); - - if (proxied_value) { - convert_to_array(proxied_value); - Z_ADDREF_P(proxied_value); - } else { - MAKE_STD_ZVAL(proxied_value); - array_init(proxied_value); - } - - if (Z_REFCOUNT_P(value) > 1) { - SEPARATE_ZVAL(&value); - } - Z_ADDREF_P(value); - - if (o) { - convert_to_string_ex(&o); - zend_symtable_update(Z_ARRVAL_P(proxied_value), Z_STRVAL_P(o), - Z_STRLEN_P(o) + 1, (void *) &value, sizeof(zval *), NULL); - } else { - zend_hash_next_index_insert(Z_ARRVAL_P(proxied_value), (void *) &value, - sizeof(zval *), NULL); - } - - if (o && o != offset) { - zval_ptr_dtor(&o); - } - - set_proxied_value(&object, proxied_value TSRMLS_CC); - - debug_propro(-1, "dim_write", object, offset, proxied_value TSRMLS_CC); - - zval_ptr_dtor(&proxied_value); -} - -static void unset_dimension(zval *object, zval *offset TSRMLS_DC) -{ - zval *proxied_value; - - debug_propro(1, "dim_unset", object, offset, NULL TSRMLS_CC); - - proxied_value = get_proxied_value(object TSRMLS_CC); - - if (proxied_value && Z_TYPE_P(proxied_value) == IS_ARRAY) { - zval *o = offset; - ZEND_RESULT_CODE rv; - - convert_to_string_ex(&o); - rv = zend_symtable_del(Z_ARRVAL_P(proxied_value), Z_STRVAL_P(o), - Z_STRLEN_P(o) + 1); - - if (SUCCESS == rv) { - set_proxied_value(&object, proxied_value TSRMLS_CC); - } - - if (o != offset) { - zval_ptr_dtor(&o); - } - } - - debug_propro(-1, "dim_unset", object, offset, proxied_value TSRMLS_CC); -} - -ZEND_BEGIN_ARG_INFO_EX(ai_propro_construct, 0, 0, 2) - ZEND_ARG_INFO(1, object) - ZEND_ARG_INFO(0, member) - ZEND_ARG_OBJ_INFO(0, parent, php\\PropertyProxy, 1) -ZEND_END_ARG_INFO(); -static PHP_METHOD(propro, __construct) { - zend_error_handling zeh; - zval *container, *parent = NULL; - char *member_str; - int member_len; - - zend_replace_error_handling(EH_THROW, NULL, &zeh TSRMLS_CC); - if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "zs|O!", - &container, &member_str, &member_len, &parent, - php_property_proxy_class_entry)) { - php_property_proxy_object_t *obj; - - obj = zend_object_store_get_object(getThis() TSRMLS_CC); - obj->proxy = php_property_proxy_init(container, member_str, - member_len TSRMLS_CC); - if (parent) { - zend_objects_store_add_ref(parent TSRMLS_CC); - obj->parent = zend_object_store_get_object(parent TSRMLS_CC); - } - } - zend_restore_error_handling(&zeh TSRMLS_CC); -} - -static const zend_function_entry php_property_proxy_method_entry[] = { - PHP_ME(propro, __construct, ai_propro_construct, ZEND_ACC_PUBLIC) - {0} -}; - -static PHP_MINIT_FUNCTION(propro) -{ - zend_class_entry ce = {0}; - - INIT_NS_CLASS_ENTRY(ce, "php", "PropertyProxy", - php_property_proxy_method_entry); - php_property_proxy_class_entry = zend_register_internal_class_ex(&ce, NULL, - NULL TSRMLS_CC); - php_property_proxy_class_entry->create_object = - php_property_proxy_object_new; - php_property_proxy_class_entry->ce_flags |= ZEND_ACC_FINAL_CLASS; - - memcpy(&php_property_proxy_object_handlers, zend_get_std_object_handlers(), - sizeof(zend_object_handlers)); - php_property_proxy_object_handlers.set = set_proxied_value; - php_property_proxy_object_handlers.get = get_proxied_value; - php_property_proxy_object_handlers.cast_object = cast_proxied_value; - php_property_proxy_object_handlers.read_dimension = read_dimension; - php_property_proxy_object_handlers.write_dimension = write_dimension; - php_property_proxy_object_handlers.has_dimension = has_dimension; - php_property_proxy_object_handlers.unset_dimension = unset_dimension; - - return SUCCESS; -} - -PHP_MINFO_FUNCTION(propro) -{ - php_info_print_table_start(); - php_info_print_table_header(2, "Property proxy support", "enabled"); - php_info_print_table_row(2, "Extension version", PHP_PROPRO_VERSION); - php_info_print_table_end(); -} - -static const zend_function_entry propro_functions[] = { - {0} -}; - -zend_module_entry propro_module_entry = { - STANDARD_MODULE_HEADER, - "propro", - propro_functions, - PHP_MINIT(propro), - NULL, - NULL, - NULL, - PHP_MINFO(propro), - PHP_PROPRO_VERSION, - STANDARD_MODULE_PROPERTIES -}; - -#ifdef COMPILE_DL_PROPRO -ZEND_GET_MODULE(propro) -#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 - */ diff --git a/php_propro_api.h b/php_propro_api.h deleted file mode 100644 index a2add4f..0000000 --- a/php_propro_api.h +++ /dev/null @@ -1,148 +0,0 @@ -/* - +--------------------------------------------------------------------+ - | PECL :: propro | - +--------------------------------------------------------------------+ - | 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) 2013 Michael Wallner | - +--------------------------------------------------------------------+ -*/ - -#ifndef PHP_PROPRO_API_H -#define PHP_PROPRO_API_H - -#include "php_propro.h" - -/** - * The internal property proxy. - * - * Container for the object/array holding the proxied property. - */ -struct php_property_proxy { - /** The container holding the property */ - zval *container; - /** The name of the proxied property */ - char *member_str; - /** The length of the name */ - size_t member_len; -}; -typedef struct php_property_proxy php_property_proxy_t; - -/** - * The userland object. - * - * Return an object instance of php\\PropertyProxy to make your C-struct - * member accessible by reference from PHP userland. - * - * Example: - * ~~~~~~~~~~{.c} - * static zval *my_read_prop(zval *object, zval *member, int type, zend_literal *key TSRMLS_DC) - * { - * my_object_t *obj = zend_object_store_get_object(object TSRMLS_CC); - * my_prophandler_t *handler; - * zval *return_value, *copy = my_cast(IS_STRING, member); - * - * if (SUCCESS == my_get_prophandler(Z_STRVAL_P(copy), Z_STRLEN_P(copy), &handler)) { - * ALLOC_ZVAL(return_value); - * Z_SET_REFCOUNT_P(return_value, 0); - * Z_UNSET_ISREF_P(return_value); - * - * if (type == BP_VAR_R) { - * handler->read(obj, return_value TSRMLS_CC); - * } else { - * // - * // This is the interesting part - * // - * php_property_proxy_t *proxy; - * zend_object_value proxy_ov; - * zend_class_entry *proxy_ce; - * - * proxy = php_property_proxy_init(object, Z_STRVAL_P(copy), Z_STRLEN_P(copy) TSRMLS_CC); - * proxy_ce = php_property_proxy_get_class_entry(); - * proxy_ov = php_property_proxy_object_new_ex(proxy_ce, proxy, NULL TSRMLS_CC); - * RETVAL_OBJVAL(proxy_ov, 0); - * } - * } else { - * zend_object_handlers *oh = zend_get_std_object_handlers(); - * return_value = oh->read_property(object, member, type, key TSRMLS_CC); - * } - * - * zval_ptr_dtor(©); - * - * return return_value; - * } - * ~~~~~~~~~~ - */ -struct php_property_proxy_object { - /** The std zend_object */ - zend_object zo; - /** The object value for easy zval creation */ - zend_object_value zv; - /** The actual property proxy */ - php_property_proxy_t *proxy; - /** A reference to any parent property proxy object */ - struct php_property_proxy_object *parent; -}; -typedef struct php_property_proxy_object php_property_proxy_object_t; - -/** - * Create a property proxy - * - * The property proxy will forward reads and writes to itself to the - * proxied property with name \a member_str of \a container. - * - * @param container the container holding the property - * @param member_str the name of the proxied property - * @param member_len the length of the name - * @return a new property proxy - */ -PHP_PROPRO_API php_property_proxy_t *php_property_proxy_init(zval *container, - const char *member_str, size_t member_len TSRMLS_DC); - -/** - * Destroy and free a property proxy. - * - * The destruction of the property proxy object calls this. - * - * @param proxy a pointer to the allocated property proxy - */ -PHP_PROPRO_API void php_property_proxy_free(php_property_proxy_t **proxy); - -/** - * Get the zend_class_entry of php\\PropertyProxy - * @return the class entry pointer - */ -PHP_PROPRO_API zend_class_entry *php_property_proxy_get_class_entry(void); - -/** - * Instantiate a new php\\PropertyProxy - * @param ce the property proxy or derived class entry - * @return the zval object value - */ -PHP_PROPRO_API zend_object_value php_property_proxy_object_new( - zend_class_entry *ce TSRMLS_DC); - -/** - * Instantiate a new php\\PropertyProxy with \a proxy - * @param ce the property proxy or derived class entry - * @param proxy the internal property proxy - * @param ptr a pointer to store the resulting property proxy object - * @return the zval object value - */ -PHP_PROPRO_API zend_object_value php_property_proxy_object_new_ex( - zend_class_entry *ce, php_property_proxy_t *proxy, - php_property_proxy_object_t **ptr TSRMLS_DC); - -#endif /* PHP_PROPRO_API_H */ - - -/* - * 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 - */ diff --git a/scripts/gen_travis_yml.php b/scripts/gen_travis_yml.php new file mode 100755 index 0000000..cc49a29 --- /dev/null +++ b/scripts/gen_travis_yml.php @@ -0,0 +1,34 @@ +#!/usr/bin/env php +# autogenerated file; do not edit +sudo: false +language: c + +addons: + apt: + packages: + - php5-cli + - php-pear + +env: + matrix: + ["5.4", "5.5", "5.6"], + "enable_debug", + "enable_maintainer_zts", +]); +foreach ($env as $e) { + printf(" - %s\n", $e); +} + +?> + +before_script: + - make -f travis/pecl/Makefile php + - make -f travis/pecl/Makefile ext PECL=propro + +script: + - make -f travis/pecl/Makefile test + diff --git a/src/php_propro_api.c b/src/php_propro_api.c new file mode 100644 index 0000000..d7232b3 --- /dev/null +++ b/src/php_propro_api.c @@ -0,0 +1,590 @@ +/* + +--------------------------------------------------------------------+ + | PECL :: propro | + +--------------------------------------------------------------------+ + | 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) 2013 Michael Wallner | + +--------------------------------------------------------------------+ +*/ + + +#ifdef HAVE_CONFIG_H +# include "config.h" +#endif + +#include +#include + +#include "php_propro_api.h" + +#if PHP_VERSION_ID < 50500 +#undef SUCCESS +#undef FAILURE +typedef enum { + SUCCESS = 0, + FAILURE = -1 +} ZEND_RESULT_CODE; +#endif + +#define DEBUG_PROPRO 0 + +#if PHP_VERSION_ID < 50400 +# define object_properties_init(o, ce) \ + zend_hash_copy(((zend_object *) o)->properties, &(ce->default_properties), \ + (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval*)) +#endif + +php_property_proxy_t *php_property_proxy_init(zval *container, + const char *member_str, size_t member_len TSRMLS_DC) +{ + php_property_proxy_t *proxy = ecalloc(1, sizeof(*proxy)); + + Z_ADDREF_P(container); + proxy->container = container; + proxy->member_str = estrndup(member_str, member_len); + proxy->member_len = member_len; + + return proxy; +} + +void php_property_proxy_free(php_property_proxy_t **proxy) +{ + if (*proxy) { + zval_ptr_dtor(&(*proxy)->container); + efree((*proxy)->member_str); + efree(*proxy); + *proxy = NULL; + } +} + +static zend_class_entry *php_property_proxy_class_entry; +static zend_object_handlers php_property_proxy_object_handlers; + +zend_class_entry *php_property_proxy_get_class_entry(void) +{ + return php_property_proxy_class_entry; +} + +zend_object_value php_property_proxy_object_new(zend_class_entry *ce TSRMLS_DC) +{ + return php_property_proxy_object_new_ex(ce, NULL, NULL TSRMLS_CC); +} + +static void php_property_proxy_object_free(void *object TSRMLS_DC) +{ + php_property_proxy_object_t *o = object; + +#if DEBUG_PROPRO + fprintf(stderr, "#PP %p free\n", o); +#endif + + if (o->proxy) { + php_property_proxy_free(&o->proxy); + } + if (o->parent) { + zend_objects_store_del_ref_by_handle_ex(o->parent->zv.handle, + o->parent->zv.handlers TSRMLS_CC); + o->parent = NULL; + } + zend_object_std_dtor((zend_object *) o TSRMLS_CC); + efree(o); +} + +zend_object_value php_property_proxy_object_new_ex(zend_class_entry *ce, + php_property_proxy_t *proxy, php_property_proxy_object_t **ptr TSRMLS_DC) +{ + php_property_proxy_object_t *o; + + o = ecalloc(1, sizeof(*o)); + zend_object_std_init((zend_object *) o, ce TSRMLS_CC); + object_properties_init((zend_object *) o, ce); + + if (ptr) { + *ptr = o; + } + o->proxy = proxy; + + o->zv.handle = zend_objects_store_put(o, NULL, + php_property_proxy_object_free, NULL TSRMLS_CC); + o->zv.handlers = &php_property_proxy_object_handlers; + +#if DEBUG_PROPRO + fprintf(stderr, "#PP %p init\n", o); +#endif + + return o->zv; +} + +#if DEBUG_PROPRO +/* we do not really care about TS when debugging */ +static int level = 1; +static const char space[] = " "; +static const char *inoutstr[] = {"< return",""," > enter"}; +static void _walk(php_property_proxy_object_t *obj TSRMLS_DC) +{ + if (obj) { + _walk(obj->parent TSRMLS_CC); + fprintf(stderr, ".%s", obj->proxy->member_str); + } +} + +static void debug_propro(int inout, const char *f, zval *object, zval *offset, + zval *value TSRMLS_DC) +{ + php_property_proxy_object_t *obj; + + obj = zend_object_store_get_object(object TSRMLS_CC); + fprintf(stderr, "#PP %p %s %s %s ", obj, &space[sizeof(space)-level], + inoutstr[inout+1], f); + + level += inout; + + _walk(obj TSRMLS_CC); + + if (*f++=='d' + && *f++=='i' + && *f++=='m' + ) { + char *offset_str = "[]"; + zval *o = offset; + + if (o) { + convert_to_string_ex(&o); + offset_str = Z_STRVAL_P(o); + } + + fprintf(stderr, ".%s", offset_str); + + if (o && o != offset) { + zval_ptr_dtor(&o); + } + } + if (value) { + const char *t[] = { + "NULL", + "int", + "float", + "bool", + "Array", + "Object", + "string", + "resource", + "const", + "const Array", + "callable" + }; + fprintf(stderr, " = (%s) ", t[Z_TYPE_P(value)&0xf]); + zend_print_flat_zval_r(value TSRMLS_CC); + } + + fprintf(stderr, "\n"); +} +#else +#define debug_propro(l, f, obj, off, val) +#endif + +static zval *get_parent_proxied_value(zval *object TSRMLS_DC); +static zval *get_proxied_value(zval *object TSRMLS_DC); +static zval *read_dimension(zval *object, zval *offset, int type TSRMLS_DC); +static ZEND_RESULT_CODE cast_proxied_value(zval *object, zval *return_value, + int type TSRMLS_DC); +static void write_dimension(zval *object, zval *offset, zval *value TSRMLS_DC); +static void set_proxied_value(zval **object, zval *value TSRMLS_DC); + +static zval *get_parent_proxied_value(zval *object TSRMLS_DC) +{ + zval *value = NULL; + php_property_proxy_object_t *obj; + + obj = zend_object_store_get_object(object TSRMLS_CC); + if (obj->proxy) { + if (obj->parent) { + zval *parent; + + MAKE_STD_ZVAL(parent); + parent->type = IS_OBJECT; + parent->value.obj = obj->parent->zv; + zend_objects_store_add_ref_by_handle( + obj->parent->zv.handle TSRMLS_CC); + value = get_proxied_value(parent TSRMLS_CC); + zval_ptr_dtor(&parent); + } + } + + return value; +} + +static zval *get_proxied_value(zval *object TSRMLS_DC) +{ + zval **hash_value, *value = NULL; + php_property_proxy_object_t *obj; + ZEND_RESULT_CODE rv; + + obj = zend_object_store_get_object(object TSRMLS_CC); + debug_propro(1, "get", object, NULL, NULL TSRMLS_CC); + + if (obj->proxy) { + if (obj->parent) { + zval *parent_value = get_parent_proxied_value(object TSRMLS_CC); + + if (parent_value && parent_value != obj->proxy->container) { + Z_ADDREF_P(parent_value); + zval_ptr_dtor(&obj->proxy->container); + obj->proxy->container = parent_value; + } + } + switch (Z_TYPE_P(obj->proxy->container)) { + case IS_OBJECT: + value = zend_read_property(Z_OBJCE_P(obj->proxy->container), + obj->proxy->container, obj->proxy->member_str, + obj->proxy->member_len, 0 TSRMLS_CC); + break; + + case IS_ARRAY: + rv = zend_symtable_find(Z_ARRVAL_P(obj->proxy->container), + obj->proxy->member_str, obj->proxy->member_len + 1, + (void *) &hash_value); + + if (SUCCESS == rv) { + value = *hash_value; + } + break; + } + } + + debug_propro(-1, "get", object, NULL, value TSRMLS_CC); + + return value; +} + +static ZEND_RESULT_CODE cast_proxied_value(zval *object, zval *return_value, + int type TSRMLS_DC) +{ + zval *proxied_value; + + if ((proxied_value = get_proxied_value(object TSRMLS_CC))) { + RETVAL_ZVAL(proxied_value, 1, 0); + if (Z_TYPE_P(proxied_value) != type) { + convert_to_explicit_type(return_value, type); + } + return SUCCESS; + } + + return FAILURE; +} + +static void set_proxied_value(zval **object, zval *value TSRMLS_DC) +{ + php_property_proxy_object_t *obj; + + obj = zend_object_store_get_object(*object TSRMLS_CC); + debug_propro(1, "set", *object, NULL, value TSRMLS_CC); + + if (obj->proxy) { + if (obj->parent) { + zval *parent_value = get_parent_proxied_value(*object TSRMLS_CC); + + if (parent_value && parent_value != obj->proxy->container) { + Z_ADDREF_P(parent_value); + zval_ptr_dtor(&obj->proxy->container); + obj->proxy->container = parent_value; + } + } + + switch (Z_TYPE_P(obj->proxy->container)) { + case IS_OBJECT: + zend_update_property(Z_OBJCE_P(obj->proxy->container), + obj->proxy->container, obj->proxy->member_str, + obj->proxy->member_len, value TSRMLS_CC); + break; + + case IS_ARRAY: + Z_ADDREF_P(value); + zend_symtable_update(Z_ARRVAL_P(obj->proxy->container), + obj->proxy->member_str, obj->proxy->member_len + 1, + (void *) &value, sizeof(zval *), NULL); + break; + } + + if (obj->parent) { + zval *zparent; + MAKE_STD_ZVAL(zparent); + zparent->type = IS_OBJECT; + zparent->value.obj = obj->parent->zv; + zend_objects_store_add_ref_by_handle( + obj->parent->zv.handle TSRMLS_CC); + set_proxied_value(&zparent, obj->proxy->container TSRMLS_CC); + zval_ptr_dtor(&zparent); + } + } + + debug_propro(-1, "set", *object, NULL, NULL TSRMLS_CC); +} + +static zval *read_dimension(zval *object, zval *offset, int type TSRMLS_DC) +{ + zval *value = NULL; + zval *proxied_value; + zval *o = offset; + + debug_propro(1, type == BP_VAR_R ? "dim_read" : "dim_read_ref", object, + offset, NULL TSRMLS_CC); + + proxied_value = get_proxied_value(object TSRMLS_CC); + convert_to_string_ex(&o); + + if (BP_VAR_R == type && proxied_value) { + if (Z_TYPE_P(proxied_value) == IS_ARRAY) { + zval **hash_value; + ZEND_RESULT_CODE rv = zend_symtable_find(Z_ARRVAL_P(proxied_value), + Z_STRVAL_P(o), Z_STRLEN_P(o), (void *) &hash_value); + + if (SUCCESS == rv) { + Z_ADDREF_PP(hash_value); + value = *hash_value; + } + } + } else { + php_property_proxy_t *proxy; + php_property_proxy_object_t *proxy_obj; + + if (proxied_value) { + convert_to_array(proxied_value); + Z_ADDREF_P(proxied_value); + } else { + MAKE_STD_ZVAL(proxied_value); + array_init(proxied_value); + set_proxied_value(&object, proxied_value TSRMLS_CC); + } + + proxy = php_property_proxy_init(proxied_value, Z_STRVAL_P(o), + Z_STRLEN_P(o) TSRMLS_CC); + zval_ptr_dtor(&proxied_value); + MAKE_STD_ZVAL(value); + Z_SET_REFCOUNT_P(value, 0); + value->type = IS_OBJECT; + value->value.obj = php_property_proxy_object_new_ex( + php_property_proxy_get_class_entry(), proxy, + &proxy_obj TSRMLS_CC); + proxy_obj->parent = zend_object_store_get_object(object TSRMLS_CC); + zend_objects_store_add_ref_by_handle( + proxy_obj->parent->zv.handle TSRMLS_CC); + } + if (o && o != offset) { + zval_ptr_dtor(&o); + } + + debug_propro(-1, type == BP_VAR_R ? "dim_read" : "dim_read_ref", object, + offset, value TSRMLS_CC); + + return value; +} + +static int has_dimension(zval *object, zval *offset, int check_empty TSRMLS_DC) +{ + zval *proxied_value; + int exists = 0; + + debug_propro(1, "dim_exists", object, offset, NULL TSRMLS_CC); + + proxied_value = get_proxied_value(object TSRMLS_CC); + if (!proxied_value) { + exists = 0; + } else { + zval *o = offset; + + convert_to_string_ex(&o); + + if (Z_TYPE_P(proxied_value) == IS_ARRAY) { + zval **zentry; + ZEND_RESULT_CODE rv = zend_symtable_find(Z_ARRVAL_P(proxied_value), Z_STRVAL_P(o), Z_STRLEN_P(o) + 1, (void *) &zentry); + + if (SUCCESS != rv) { + exists = 0; + } else { + if (check_empty) { + exists = Z_TYPE_PP(zentry) != IS_NULL; + } else { + exists = 1; + } + } + } + + if (o != offset) { + zval_ptr_dtor(&o); + } + } + + debug_propro(-1, "dim_exists", object, offset, NULL TSRMLS_CC); + + return exists; +} + +static void write_dimension(zval *object, zval *offset, zval *value TSRMLS_DC) +{ + zval *proxied_value, *o = offset; + + debug_propro(1, "dim_write", object, offset, value TSRMLS_CC); + + proxied_value = get_proxied_value(object TSRMLS_CC); + + if (proxied_value) { + convert_to_array(proxied_value); + Z_ADDREF_P(proxied_value); + } else { + MAKE_STD_ZVAL(proxied_value); + array_init(proxied_value); + } + + if (Z_REFCOUNT_P(value) > 1) { + SEPARATE_ZVAL(&value); + } + Z_ADDREF_P(value); + + if (o) { + convert_to_string_ex(&o); + zend_symtable_update(Z_ARRVAL_P(proxied_value), Z_STRVAL_P(o), + Z_STRLEN_P(o) + 1, (void *) &value, sizeof(zval *), NULL); + } else { + zend_hash_next_index_insert(Z_ARRVAL_P(proxied_value), (void *) &value, + sizeof(zval *), NULL); + } + + if (o && o != offset) { + zval_ptr_dtor(&o); + } + + set_proxied_value(&object, proxied_value TSRMLS_CC); + + debug_propro(-1, "dim_write", object, offset, proxied_value TSRMLS_CC); + + zval_ptr_dtor(&proxied_value); +} + +static void unset_dimension(zval *object, zval *offset TSRMLS_DC) +{ + zval *proxied_value; + + debug_propro(1, "dim_unset", object, offset, NULL TSRMLS_CC); + + proxied_value = get_proxied_value(object TSRMLS_CC); + + if (proxied_value && Z_TYPE_P(proxied_value) == IS_ARRAY) { + zval *o = offset; + ZEND_RESULT_CODE rv; + + convert_to_string_ex(&o); + rv = zend_symtable_del(Z_ARRVAL_P(proxied_value), Z_STRVAL_P(o), + Z_STRLEN_P(o) + 1); + + if (SUCCESS == rv) { + set_proxied_value(&object, proxied_value TSRMLS_CC); + } + + if (o != offset) { + zval_ptr_dtor(&o); + } + } + + debug_propro(-1, "dim_unset", object, offset, proxied_value TSRMLS_CC); +} + +ZEND_BEGIN_ARG_INFO_EX(ai_propro_construct, 0, 0, 2) + ZEND_ARG_INFO(1, object) + ZEND_ARG_INFO(0, member) + ZEND_ARG_OBJ_INFO(0, parent, php\\PropertyProxy, 1) +ZEND_END_ARG_INFO(); +static PHP_METHOD(propro, __construct) { + zend_error_handling zeh; + zval *container, *parent = NULL; + char *member_str; + int member_len; + + zend_replace_error_handling(EH_THROW, NULL, &zeh TSRMLS_CC); + if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "zs|O!", + &container, &member_str, &member_len, &parent, + php_property_proxy_class_entry)) { + php_property_proxy_object_t *obj; + + obj = zend_object_store_get_object(getThis() TSRMLS_CC); + obj->proxy = php_property_proxy_init(container, member_str, + member_len TSRMLS_CC); + if (parent) { + zend_objects_store_add_ref(parent TSRMLS_CC); + obj->parent = zend_object_store_get_object(parent TSRMLS_CC); + } + } + zend_restore_error_handling(&zeh TSRMLS_CC); +} + +static const zend_function_entry php_property_proxy_method_entry[] = { + PHP_ME(propro, __construct, ai_propro_construct, ZEND_ACC_PUBLIC) + {0} +}; + +static PHP_MINIT_FUNCTION(propro) +{ + zend_class_entry ce = {0}; + + INIT_NS_CLASS_ENTRY(ce, "php", "PropertyProxy", + php_property_proxy_method_entry); + php_property_proxy_class_entry = zend_register_internal_class_ex(&ce, NULL, + NULL TSRMLS_CC); + php_property_proxy_class_entry->create_object = + php_property_proxy_object_new; + php_property_proxy_class_entry->ce_flags |= ZEND_ACC_FINAL_CLASS; + + memcpy(&php_property_proxy_object_handlers, zend_get_std_object_handlers(), + sizeof(zend_object_handlers)); + php_property_proxy_object_handlers.set = set_proxied_value; + php_property_proxy_object_handlers.get = get_proxied_value; + php_property_proxy_object_handlers.cast_object = cast_proxied_value; + php_property_proxy_object_handlers.read_dimension = read_dimension; + php_property_proxy_object_handlers.write_dimension = write_dimension; + php_property_proxy_object_handlers.has_dimension = has_dimension; + php_property_proxy_object_handlers.unset_dimension = unset_dimension; + + return SUCCESS; +} + +PHP_MINFO_FUNCTION(propro) +{ + php_info_print_table_start(); + php_info_print_table_header(2, "Property proxy support", "enabled"); + php_info_print_table_row(2, "Extension version", PHP_PROPRO_VERSION); + php_info_print_table_end(); +} + +static const zend_function_entry propro_functions[] = { + {0} +}; + +zend_module_entry propro_module_entry = { + STANDARD_MODULE_HEADER, + "propro", + propro_functions, + PHP_MINIT(propro), + NULL, + NULL, + NULL, + PHP_MINFO(propro), + PHP_PROPRO_VERSION, + STANDARD_MODULE_PROPERTIES +}; + +#ifdef COMPILE_DL_PROPRO +ZEND_GET_MODULE(propro) +#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 + */ diff --git a/src/php_propro_api.h b/src/php_propro_api.h new file mode 100644 index 0000000..a2add4f --- /dev/null +++ b/src/php_propro_api.h @@ -0,0 +1,148 @@ +/* + +--------------------------------------------------------------------+ + | PECL :: propro | + +--------------------------------------------------------------------+ + | 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) 2013 Michael Wallner | + +--------------------------------------------------------------------+ +*/ + +#ifndef PHP_PROPRO_API_H +#define PHP_PROPRO_API_H + +#include "php_propro.h" + +/** + * The internal property proxy. + * + * Container for the object/array holding the proxied property. + */ +struct php_property_proxy { + /** The container holding the property */ + zval *container; + /** The name of the proxied property */ + char *member_str; + /** The length of the name */ + size_t member_len; +}; +typedef struct php_property_proxy php_property_proxy_t; + +/** + * The userland object. + * + * Return an object instance of php\\PropertyProxy to make your C-struct + * member accessible by reference from PHP userland. + * + * Example: + * ~~~~~~~~~~{.c} + * static zval *my_read_prop(zval *object, zval *member, int type, zend_literal *key TSRMLS_DC) + * { + * my_object_t *obj = zend_object_store_get_object(object TSRMLS_CC); + * my_prophandler_t *handler; + * zval *return_value, *copy = my_cast(IS_STRING, member); + * + * if (SUCCESS == my_get_prophandler(Z_STRVAL_P(copy), Z_STRLEN_P(copy), &handler)) { + * ALLOC_ZVAL(return_value); + * Z_SET_REFCOUNT_P(return_value, 0); + * Z_UNSET_ISREF_P(return_value); + * + * if (type == BP_VAR_R) { + * handler->read(obj, return_value TSRMLS_CC); + * } else { + * // + * // This is the interesting part + * // + * php_property_proxy_t *proxy; + * zend_object_value proxy_ov; + * zend_class_entry *proxy_ce; + * + * proxy = php_property_proxy_init(object, Z_STRVAL_P(copy), Z_STRLEN_P(copy) TSRMLS_CC); + * proxy_ce = php_property_proxy_get_class_entry(); + * proxy_ov = php_property_proxy_object_new_ex(proxy_ce, proxy, NULL TSRMLS_CC); + * RETVAL_OBJVAL(proxy_ov, 0); + * } + * } else { + * zend_object_handlers *oh = zend_get_std_object_handlers(); + * return_value = oh->read_property(object, member, type, key TSRMLS_CC); + * } + * + * zval_ptr_dtor(©); + * + * return return_value; + * } + * ~~~~~~~~~~ + */ +struct php_property_proxy_object { + /** The std zend_object */ + zend_object zo; + /** The object value for easy zval creation */ + zend_object_value zv; + /** The actual property proxy */ + php_property_proxy_t *proxy; + /** A reference to any parent property proxy object */ + struct php_property_proxy_object *parent; +}; +typedef struct php_property_proxy_object php_property_proxy_object_t; + +/** + * Create a property proxy + * + * The property proxy will forward reads and writes to itself to the + * proxied property with name \a member_str of \a container. + * + * @param container the container holding the property + * @param member_str the name of the proxied property + * @param member_len the length of the name + * @return a new property proxy + */ +PHP_PROPRO_API php_property_proxy_t *php_property_proxy_init(zval *container, + const char *member_str, size_t member_len TSRMLS_DC); + +/** + * Destroy and free a property proxy. + * + * The destruction of the property proxy object calls this. + * + * @param proxy a pointer to the allocated property proxy + */ +PHP_PROPRO_API void php_property_proxy_free(php_property_proxy_t **proxy); + +/** + * Get the zend_class_entry of php\\PropertyProxy + * @return the class entry pointer + */ +PHP_PROPRO_API zend_class_entry *php_property_proxy_get_class_entry(void); + +/** + * Instantiate a new php\\PropertyProxy + * @param ce the property proxy or derived class entry + * @return the zval object value + */ +PHP_PROPRO_API zend_object_value php_property_proxy_object_new( + zend_class_entry *ce TSRMLS_DC); + +/** + * Instantiate a new php\\PropertyProxy with \a proxy + * @param ce the property proxy or derived class entry + * @param proxy the internal property proxy + * @param ptr a pointer to store the resulting property proxy object + * @return the zval object value + */ +PHP_PROPRO_API zend_object_value php_property_proxy_object_new_ex( + zend_class_entry *ce, php_property_proxy_t *proxy, + php_property_proxy_object_t **ptr TSRMLS_DC); + +#endif /* PHP_PROPRO_API_H */ + + +/* + * 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 + */