summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorEmiel Bruijntjes <emiel.bruijntjes@copernica.com>2014-03-13 15:48:29 +0100
committerEmiel Bruijntjes <emiel.bruijntjes@copernica.com>2014-03-13 15:48:29 +0100
commit1a8c587f3a67db2e5c38cc525b29800e86f27936 (patch)
tree38b0a17b046d2cfdd76a5e03bfb97fddfbcaceed /include
parente45c7c392add8fdcd0d8fe06bbb790cea2f865f0 (diff)
magic methods no longer are virtual, so that more signatures are acceptable. added support for __callStatic()
Diffstat (limited to 'include')
-rw-r--r--include/base.h24
-rw-r--r--include/callstatic.h64
-rw-r--r--include/class.h228
-rw-r--r--include/classbase.h121
-rw-r--r--include/interface.h53
5 files changed, 379 insertions, 111 deletions
diff --git a/include/base.h b/include/base.h
index d0e7e71..6cf75df 100644
--- a/include/base.h
+++ b/include/base.h
@@ -121,7 +121,7 @@ public:
* @param key
* @return bool
*/
- virtual bool __isset(const Php::Value &key);
+ bool __isset(const Php::Value &key) const;
/**
* Overridable method that is called to set a new property
@@ -132,7 +132,7 @@ public:
* @param key
* @param value
*/
- virtual void __set(const Php::Value &key, const Php::Value &value);
+ void __set(const Php::Value &key, const Php::Value &value) const;
/**
* Retrieve a property
@@ -143,7 +143,7 @@ public:
* @param key
* @return value
*/
- virtual Php::Value __get(const Php::Value &key);
+ Php::Value __get(const Php::Value &key) const;
/**
* Remove a member
@@ -153,7 +153,7 @@ public:
*
* @param key
*/
- virtual void __unset(const Php::Value &key);
+ void __unset(const Php::Value &key) const;
/**
* Call a method
@@ -166,7 +166,7 @@ public:
* @param params The parameters that were passed to the function
* @return Value The return value
*/
- virtual Value __call(const char *method, Parameters &params);
+ Php::Value __call(const char *method, Php::Parameters &params) const;
/**
* Call the class as if it was a function
@@ -177,7 +177,7 @@ public:
* @param params The parameters that were passed to the function
* @return Value The return value
*/
- virtual Value __invoke(Parameters &params);
+ Php::Value __invoke(Php::Parameters &params) const;
/**
* Cast the object to a string
@@ -187,7 +187,7 @@ public:
*
* @return Value The object as a string
*/
- virtual Value __toString();
+ Php::Value __toString() const;
/**
* Cast the object to an integer
@@ -197,7 +197,7 @@ public:
*
* @return int Integer value
*/
- virtual long __toInteger();
+ Php::Value __toInteger() const;
/**
* Cast the object to a float
@@ -207,7 +207,7 @@ public:
*
* @return double Floating point value
*/
- virtual double __toFloat();
+ Php::Value __toFloat() const;
/**
* Cast the object to a boolean
@@ -217,17 +217,17 @@ public:
*
* @return bool
*/
- virtual bool __toBool();
+ Value __toBool() const;
/**
- * Comparison operator
+ * Compare the object with a different object
*
* Check how a different object compares to this object
*
* @param that Object to compare with
* @return int
*/
- bool operator<(const Base &that) const;
+ int __compare(const Base &base) const;
private:
diff --git a/include/callstatic.h b/include/callstatic.h
new file mode 100644
index 0000000..3979ef3
--- /dev/null
+++ b/include/callstatic.h
@@ -0,0 +1,64 @@
+/**
+ * CallStatic.h
+ *
+ * Class that performs a lot of C++11 magic to find out if the __callStatic()
+ * method was implemented by the user, and if it was, calls it
+ *
+ */
+
+namespace Php {
+
+/**
+ * SFINAE test to check if the __callStatic method is defined
+ *
+ * This type trait checks if the __callStatic method is defined in class T
+ *
+ * @see http://stackoverflow.com/questions/257288/is-it-possible-to-write-a-c-template-to-check-for-a-functions-existence
+ */
+template <typename T>
+class HasCallStatic
+{
+ typedef char one;
+ typedef long two;
+
+ template <typename C> static one test( decltype(&C::__callStatic) ) ;
+ template <typename C> static two test(...);
+
+public:
+ static const bool value = sizeof(test<T>(0)) == sizeof(char);
+};
+
+/**
+ * Function that only exists if the class T has a __callStatic method
+ * @param name Name of the function
+ * @param params Parameters passed to the function
+ * @return Value
+ */
+template<typename T>
+typename std::enable_if<HasCallStatic<T>::value, Value >::type
+callStatic(const char *name, Parameters &params)
+{
+ // call the __callStatic() function
+ return T::__callStatic(name, params);
+}
+
+/**
+ * Function that only exists if the class T does not have a __callStatic method
+ * @param name Name of the function
+ * @param params Parameters passed to the function
+ * @return Value
+ */
+template<typename T>
+typename std::enable_if<!HasCallStatic<T>::value >::type
+callStatic(const char *name, Parameters &params)
+{
+ std::cout << "has NO call static" << std::endl;
+
+ return nullptr;
+}
+
+/**
+ * End namespace
+ */
+}
+
diff --git a/include/class.h b/include/class.h
index bb05fdd..6fd938c 100644
--- a/include/class.h
+++ b/include/class.h
@@ -25,6 +25,23 @@ extern struct _zend_class_entry *zend_ce_arrayaccess;
//extern struct _zend_class_entry *zend_ce_serializable;
/**
+ * SFINAE test to check if the __callStatic method is defined
+ * @see http://stackoverflow.com/questions/257288/is-it-possible-to-write-a-c-template-to-check-for-a-functions-existence
+ */
+template <typename T>
+class HasCallStatic
+{
+ typedef char one;
+ typedef long two;
+
+ template <typename C> static one test( decltype(&C::__callStatic) ) ;
+ template <typename C> static two test(...);
+
+public:
+ static const bool value = sizeof(test<T>(0)) == sizeof(char);
+};
+
+/**
* Set up namespace
*/
namespace Php {
@@ -217,8 +234,217 @@ private:
// check if the templated class overrides from the Serializable class
return std::is_base_of<Serializable,T>::value;
}
+
+ /**
+ * Call a method
+ * @param base Object to call on
+ * @param name Name of the method
+ * @param params
+ * @return Value
+ */
+ virtual Value call(Base *base, const char *name, Parameters &params) const override
+ {
+ // cast to the user object
+ T *object = (T *)base;
+
+ // call the method on the base object
+ return base->__call(name, params);
+ }
+
+ /**
+ * SFINAE test to check if the __callStatic method is defined
+ *
+ * This type trait checks if the __callStatic method is defined in class T
+ *
+ * @see http://stackoverflow.com/questions/257288/is-it-possible-to-write-a-c-template-to-check-for-a-functions-existence
+ */
+ template <typename X>
+ class HasCallStatic
+ {
+ typedef char one;
+ typedef long two;
+
+ template <typename C> static one test( decltype(&C::__callStatic) ) ;
+ template <typename C> static two test(...);
+
+ public:
+ static const bool value = sizeof(test<X>(0)) == sizeof(char);
+ };
+
+ /**
+ * Function that only exists if the class T has a __callStatic method
+ * @param name Name of the function
+ * @param params Parameters passed to the function
+ * @return Value
+ */
+ template<typename X>
+ typename std::enable_if<HasCallStatic<X>::value, Value >::type
+ static maybeCallStatic(const char *name, Parameters &params)
+ {
+ // call the __callStatic() function
+ return X::__callStatic(name, params);
+ }
+
+ /**
+ * Function that only exists if the class T does not have a __callStatic method
+ * @param name Name of the function
+ * @param params Parameters passed to the function
+ * @return Value
+ */
+ template<typename X>
+ typename std::enable_if<!HasCallStatic<X>::value, Value >::type
+ static maybeCallStatic(const char *name, Parameters &params)
+ {
+ // this is not implemented
+ notImplemented();
+
+ // unreachable
+ return nullptr;
+ }
+
+ /**
+ * Call a the __callStatic() function
+ * @param name Name of the function
+ * @param params Parameters passed to the function
+ * @return Value
+ */
+ virtual Value callStatic(const char *name, Parameters &params) const override
+ {
+ return maybeCallStatic<T>(name, params);
+ }
+
+ /**
+ * Call the __invoke() method
+ * @param base Object to call it on
+ * @param params Parameters to pass
+ * @return Value
+ */
+ virtual Value invoke(Base *object, Parameters &params) const override
+ {
+ // cast to actual object
+ T *obj = (T *)object;
+
+ // pass on
+ return obj->__invoke(params);
+ }
+
+ /**
+ * Cast to string function
+ * @param base
+ * @return Value
+ */
+ virtual Value toString(Base *base) const override
+ {
+ // cast to actual object
+ T *obj = (T *)base;
+
+ // pass on
+ return obj->__toString().setType(Type::String);
+ }
+
+ /**
+ * Cast to integer function
+ * @param base
+ * @return Value
+ */
+ virtual Value toInteger(Base *base) const override
+ {
+ // cast to actual object
+ T *obj = (T *)base;
+
+ // pass on
+ return obj->__toInteger().setType(Type::Numeric);
+ }
+
+ /**
+ * Cast to float function
+ * @param base
+ * @return Value
+ */
+ virtual Value toFloat(Base *base) const override
+ {
+ // cast to actual object
+ T *obj = (T *)base;
+
+ // pass on
+ return obj->__toFloat().setType(Type::Float);
+ }
+
+ /**
+ * Cast to bool function
+ * @param base
+ * @return Value
+ */
+ virtual Value toBool(Base *base) const override
+ {
+ // cast to actual object
+ T *obj = (T *)base;
+
+ // pass on
+ return obj->__toBool().setType(Type::Bool);
+ }
+
+ /**
+ * Function to retrieve a property
+ * @param base
+ * @param name
+ * @param value
+ * @return Value
+ */
+ virtual Value get(Base *base, const Value &name) const override
+ {
+ // cast to actual object
+ T *obj = (T *)base;
+
+ // pass on
+ return obj->__get(name);
+ }
/**
+ * Function to set/overwrite a property
+ * @param base
+ * @param name
+ * @param value
+ */
+ virtual void set(Base *base, const Value &name, const Value &value) const override
+ {
+ // cast to actual object
+ T *obj = (T *)base;
+
+ // pass on
+ obj->__set(name, value);
+ }
+
+ /**
+ * Function to remove a property
+ * @param base
+ * @param name
+ */
+ virtual void unset(Base *base, const Value &name) const override
+ {
+ // cast to actual object
+ T *obj = (T *)base;
+
+ // pass on
+ obj->__unset(name);
+ }
+
+ /**
+ * Function to check if a property is set
+ * @param base
+ * @param name
+ * @return bool
+ */
+ virtual bool callIsset(Base *base, const Value &name) const override
+ {
+ // cast to actual object
+ T *obj = (T *)base;
+
+ // pass on
+ return obj->__isset(name);
+ }
+
+ /**
* Compare two objects
* @param object1
* @param object2
@@ -237,7 +463,7 @@ private:
// they must be identical
return 0;
}
-
+
/**
* Namespaces have access to the private base class
*/
diff --git a/include/classbase.h b/include/classbase.h
index b4312dd..d19a1b2 100644
--- a/include/classbase.h
+++ b/include/classbase.h
@@ -107,17 +107,32 @@ public:
virtual ~ClassBase();
/**
- * Construct a new instance of the object
- * @return Base
+ * Initialize the class, given its name
+ *
+ * The module functions are registered on module startup, but classes are
+ * initialized afterwards. The Zend engine is a strange thing. Nevertheless,
+ * this means that this method is called after the module is already available.
+ * This function will inform the Zend engine about the existence of the
+ * class.
+ *
+ * @param ns Namespace name
*/
- virtual Base* construct() const = 0;
-
+ void initialize(const std::string &ns);
+
+protected:
/**
- * Create a clone of an object
- * @param orig
+ * Construct a new instance of the object, or to clone the object
* @return Base
*/
- virtual Base *clone(Base *orig) const = 0;
+ virtual Base* construct() const { return nullptr; }
+ virtual Base *clone(Base *orig) const { return nullptr; }
+
+ /**
+ * Methods to check if a certain interface is overridden
+ * @return bool
+ */
+ virtual bool traversable() const { return false; }
+ virtual bool serializable() const { return false; }
/**
* Compare two objects
@@ -125,36 +140,51 @@ public:
* @param object2
* @return int
*/
- virtual int compare(Base *object1, Base *object2) const = 0;
-
+ virtual int callCompare(Base *object1, Base *object2) const { return 1; }
+
/**
- * Is this a traversable class?
- * @return bool
+ * Call the __call(), __invoke() or __callStatic() method
+ * @param base Object to call on
+ * @param name Name of the method
+ * @param params Parameters to pass to the method
+ * @return Value
*/
- virtual bool traversable() const = 0;
-
+ virtual Value callCall(Base *base, const char *name, Parameters &params) const { return nullptr; }
+ virtual Value callInvoke(Base *base, Parameters &params) const { return nullptr; }
+ virtual Value callCallStatic(const char *name, Parameters &params) const { return nullptr; }
+
/**
- * Is this a serializable class?
- * @return bool
+ * Casting functions
+ * @param base
+ * @return Value
*/
- virtual bool serializable() const = 0;
+ virtual Value callToString(Base *base) const { return Value(Type::String); }
+ virtual Value callToInteger(Base *base) const { return Value(Type::Numeric); }
+ virtual Value callToFloat(Base *base) const { return Value(Type::Float); }
+ virtual Value callToBool(Base *base) const { return Value(Type::Bool); }
/**
- * Initialize the class, given its name
- *
- * The module functions are registered on module startup, but classes are
- * initialized afterwards. The Zend engine is a strange thing. Nevertheless,
- * this means that this method is called after the module is already available.
- * This function will inform the Zend engine about the existence of the
- * class.
- *
- * @param ns Namespace name
+ * Function to get and set properties
+ * @param base
+ * @param name
+ * @param value
+ * @return Value
*/
- void initialize(const std::string &ns);
+ virtual Value callGet(Base *base, const Value &name) const { return nullptr; }
+ virtual void callSet(Base *base, const Value &name, const Value &value) const {}
+ virtual void callUnset(Base *base, const Value &name) const {}
+ virtual bool callIsset(Base *base, const Value &name) const { return false; }
+
protected:
/**
+ * Function that can be called by a derived method when a certain function
+ * is not implemented
+ */
+ static void notImplemented();
+
+ /**
* Add a method to the class
*
* The method will be accessible as one of the class methods in your PHP
@@ -268,19 +298,24 @@ private:
const struct _zend_function_entry *entries();
/**
- * Static member functions to clone objects based on this class
+ * Static member functions to create or clone objects based on this class
+ * @param entry Pointer to class information
* @param val The object to be cloned
* @return zend_object_value Object info
*/
+ static struct _zend_object_value createObject(struct _zend_class_entry *entry);
static struct _zend_object_value cloneObject(struct _zval_struct *val);
/**
- * Function that is called when an instance of the class needs to be created.
- * This function will create the C++ class, and the PHP object
- * @param entry Pointer to the class information
- * @return zend_object_value The newly created object
+ * Static member function that get called when a method or object is called
+ * @param ht ??
+ * @param return_value Zval holding the variable to store the return value in
+ * @param return_value_ptr Pointer to the same zval
+ * @param this_ptr Object being called
+ * @param return_value_used Is the return value used or not?
*/
- static struct _zend_object_value createObject(struct _zend_class_entry *entry);
+ static void callMethod(int ht, struct _zval_struct *return_value, struct _zval_struct **return_value_ptr, struct _zval_struct *this_ptr, int return_value_used);
+ static void callInvoke(int ht, struct _zval_struct *return_value, struct _zval_struct **return_value_ptr, struct _zval_struct *this_ptr, int return_value_used);
/**
* Function that is used to count the number of elements in the object
@@ -382,29 +417,25 @@ private:
static void unsetProperty(struct _zval_struct *object, struct _zval_struct *member);
/**
- * Method that is called when a undefined method is invoked
+ * Method that returns information about the function signature of a undefined method
+ * @param object_ptr
* @param method
- * @param ht
- * @param return_value
- * @param return_value_ptr
- * @param this_ptr
- * @param return_value_used
- * @param tsrm_ls
- * @return integer
+ * @param method_len
+ * @param key
+ * @return zend_function
*/
- static int callMethod(const char *method, int ht, struct _zval_struct *return_value, struct _zval_struct **return_value_ptr, struct _zval_struct *this_ptr, int return_value_used);
- static int callMethod(char *method, int ht, struct _zval_struct *return_value, struct _zval_struct **return_value_ptr, struct _zval_struct *this_ptr, int return_value_used);
+ static union _zend_function *getMethod(struct _zval_struct **object_ptr, char *method, int method_len, const struct _zend_literal *key);
+ static union _zend_function *getMethod(struct _zval_struct **object_ptr, char *method, int method_len);
/**
- * Method that returns information about the function signature of a undefined method
+ * Method that returns information about the function signature of an undefined static method
* @param object_ptr
* @param method
* @param method_len
* @param key
* @return zend_function
*/
- static union _zend_function *getMethod(struct _zval_struct **object_ptr, char *method, int method_len, const struct _zend_literal *key);
- static union _zend_function *getMethod(struct _zval_struct **object_ptr, char *method, int method_len);
+ static union _zend_function *getStaticMethod(struct _zend_class_entry *entry, char* method, int method_len);
/**
* Method that returns information about the __invoke() method
diff --git a/include/interface.h b/include/interface.h
index f7ef387..b0469f4 100644
--- a/include/interface.h
+++ b/include/interface.h
@@ -40,59 +40,6 @@ public:
private:
/**
- * Construct a new instance of the object
- * @return Base
- */
- virtual Base* construct() const override
- {
- // this does not occur for interfaces
- return nullptr;
- }
-
- /**
- * Construct a clone of the object
- * @param orig
- * @return Base
- */
- virtual Base* clone(Base *orig) const override
- {
- // this does not occur for interfaces
- return nullptr;
- }
-
- /**
- * Is this a traversable interface?
- * @return bool
- */
- virtual bool traversable() const override
- {
- // interfaces are never traversed
- return false;
- }
-
- /**
- * Compare two objects
- * @param object1
- * @param object2
- * @return int
- */
- virtual int compare(Base *object1, Base *object2) const override
- {
- // this is never called for interfaces
- return 0;
- }
-
- /**
- * Is this a serializable class?
- * @return bool
- */
- virtual bool serializable() const override
- {
- // not called for interfaces
- return false;
- }
-
- /**
* Namespaces have access to the private base class
*/
friend class Namespace;