Merge lp:~thomas-voss/properties-cpp/allow-for-dispatching-setter-and-getter-functors into lp:properties-cpp

[Thomas Voß]

Allow for dispatching setting and getting to functors.

Allow for dispatching setting and getting to functors.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:14
http://jenkins.qa.ubuntu.com/job/properties-cpp-ci/6/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/properties-cpp-trusty-amd64-ci/6
    SUCCESS: http://jenkins.qa.ubuntu.com/job/properties-cpp-trusty-armhf-ci/6
        deb: http://jenkins.qa.ubuntu.com/job/properties-cpp-trusty-armhf-ci/6/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/properties-cpp-trusty-i386-ci/6

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/properties-cpp-ci/6/rebuild

review: Approve (continuous-integration)

[lp:~thomas-voss/properties-cpp/allow-for-dispatching-setter-and-getter-functors]

15. By Thomas Voß on 2014-02-19

Add documentation and test-cases for dispatched get and set operations.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:15
http://jenkins.qa.ubuntu.com/job/properties-cpp-ci/7/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/properties-cpp-trusty-amd64-ci/7
    SUCCESS: http://jenkins.qa.ubuntu.com/job/properties-cpp-trusty-armhf-ci/7
        deb: http://jenkins.qa.ubuntu.com/job/properties-cpp-trusty-armhf-ci/7/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/properties-cpp-trusty-i386-ci/7

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/properties-cpp-ci/7/rebuild

review: Approve (continuous-integration)

[Jim Hodapp (jhodapp)]

Looks good, thanks for implementing this.

review: Approve (code)

=== modified file 'include/core/property.h'
--- include/core/property.h	2014-01-01 06:19:38 +0000
+++ include/core/property.h	2014-02-19 20:26:03 +0000
@@ -43,10 +43,23 @@
     typedef T ValueType;
 
     /**
+     * @brief Getter refers to the function type for dispatching get operations to.
+     */
+    typedef std::function<ValueType()> Getter;
+    
+    /**
+     * @brief Setter refers to the function type for dispatching set operations to.
+     */
+    typedef std::function<void(const ValueType&)> Setter;
+
+    /**
      * @brief Property creates a new instance of property and initializes the contained value.
      * @param t The initial value, defaults to Property<T>::default_value().
      */
-    inline explicit Property(const T& t = T{}) : value{t}
+    inline explicit Property(const T& t = T{})
+            : value{t},
+              getter{},
+              setter{}
     {
     }
 
@@ -129,6 +142,10 @@
         if (value != new_value)
         {
             value = new_value;
+
+            if (setter)
+                setter(value);
+
             signal_changed(value);
         }
     }
@@ -139,6 +156,9 @@
      */
     inline virtual const T& get() const
     {
+        if (getter)
+            mutable_get() = getter();
+        
         return value;
     }
 
@@ -171,6 +191,24 @@
         return false;
     }
 
+    /**
+     * @brief install takes the provided functor and installs it for dispatching all set operations.
+     * @param setter The functor to be invoked for set operations.
+     */
+    inline void install(const Setter& setter)
+    {
+        this->setter = setter;
+    }
+
+    /**
+     * @brief install takes the provided functor and installs it for dispatching all get operations.
+     * @param getter The functor to be invoked for get operations.
+     */
+    inline void install(const Getter& getter)
+    {
+        this->getter = getter;
+    }
+
     friend inline const Property<T>& operator|(const Property<T>& lhs, Property<T>& rhs)
     {
         rhs.connections.emplace(
@@ -190,6 +228,8 @@
 
   private:
     mutable T value;
+    Getter getter;
+    Setter setter;
     Signal<T> signal_changed;
     std::set<ScopedConnection> connections;
 };
 
=== modified file 'tests/properties_test.cpp'
--- tests/properties_test.cpp	2014-01-01 06:19:38 +0000
+++ tests/properties_test.cpp	2014-02-19 20:26:03 +0000
@@ -177,3 +177,34 @@
 
     EXPECT_EQ(42, p2.get());
 }
+
+TEST(Property, getter_is_invoked_for_get_operations)
+{
+    bool invoked = false;
+    auto getter = [&invoked]()
+    {
+        invoked = true;
+        return 42;
+    };
+
+    core::Property<int> prop;
+    prop.install(getter);
+
+    EXPECT_EQ(42, prop.get());
+    EXPECT_TRUE(invoked);
+}
+
+TEST(Property, setter_is_invoked_for_set_operations)
+{
+    int value = 0;
+    auto setter = [&value](int new_value)
+    {
+        value = new_value;
+    };
+
+    core::Property<int> prop;
+    prop.install(setter);
+
+    prop.set(42);
+    EXPECT_EQ(42, value);
+}