From: Michael Wallner Date: Tue, 1 Sep 2015 09:35:11 +0000 (+0200) Subject: administrativa X-Git-Tag: release-1.0.2RC1~14 X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=4d686aad68d77375518ed1255abe61d5208d7f8a;p=m6w6%2Fext-propro administrativa --- diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..f6d1a5e --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +package.xml merge=touch +php_propro.h merge=touch diff --git a/config.m4 b/config.m4 index 925eebb..1a4965e 100644 --- a/config.m4 +++ b/config.m4 @@ -2,6 +2,6 @@ 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_INSTALL_HEADERS(ext/propro, php_propro.h php_propro_api.h) PHP_NEW_EXTENSION(propro, php_propro.c, $ext_shared) fi diff --git a/php_propro.h b/php_propro.h index 669529b..7d7acd4 100644 --- a/php_propro.h +++ b/php_propro.h @@ -13,8 +13,6 @@ #ifndef PHP_PROPRO_H #define PHP_PROPRO_H -#ifndef DOXYGEN - extern zend_module_entry propro_module_entry; #define phpext_propro_ptr &propro_module_entry @@ -32,127 +30,7 @@ extern zend_module_entry propro_module_entry; # include #endif -#endif - -/** - * 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); +#include "php_propro_api.h" #endif /* PHP_PROPRO_H */ diff --git a/php_propro_api.h b/php_propro_api.h new file mode 100644 index 0000000..a2add4f --- /dev/null +++ b/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 + */