[config.w32] Warn that propro was discontinued
[m6w6/ext-propro] / php_propro.h
index d5a544090905b97eb2c11bc2a69696aed855380e..4fc39c564021b9953303f869501942a1394ea332 100644 (file)
 #ifndef PHP_PROPRO_H
 #define PHP_PROPRO_H
 
-#ifndef DOXYGEN
-
 extern zend_module_entry propro_module_entry;
 #define phpext_propro_ptr &propro_module_entry
 
-#define PHP_PROPRO_VERSION "2.0.0dev"
+#define PHP_PROPRO_VERSION "2.1.0"
 
 #ifdef PHP_WIN32
 #      define PHP_PROPRO_API __declspec(dllexport)
@@ -34,104 +32,6 @@ extern zend_module_entry propro_module_entry;
 
 #define PHP_PROPRO_PTR(zo) (void*)(((char*)(zo))-(zo)->handlers->offset)
 
-#endif /* DOXYGEN */
-
-/**
- * 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 */
-       zend_string *member;
-};
-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(&copy);
- *
- *     return return_value;
- * }
- * ~~~~~~~~~~
- */
-struct php_property_proxy_object {
-       /** The actual property proxy */
-       php_property_proxy_t *proxy;
-       /** Any parent property proxy object */
-       zval parent;
-       /** The std zend_object */
-       zend_object zo;
-};
-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 the name of the proxied property
- * @return a new property proxy
- */
-PHP_PROPRO_API php_property_proxy_t *php_property_proxy_init(zval *container,
-               zend_string *member);
-
-/**
- * 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);
-
 #endif /* PHP_PROPRO_H */