Changeset 5953 for branches/newapi

Timestamp:

12/11/07 07:45:58 (12 months ago)

Author:

erijo

Message:

Added properties to events

Location:

branches/newapi/licq

Files:

• licq/event/event.h (modified) (4 diffs)
• src/event/event.cpp (modified) (4 diffs)
• src/event/test/eventtest.cpp (modified) (1 diff)

branches/newapi/licq/licq/event/event.h

@@ -21 +21 @@
 #define LICQ_EVENT_H
 
+#include "licq/exception/invalidargumentexception.h"
 #include "licq/macros.h"
 
+#include <boost/any.hpp>
 #include <boost/noncopyable.hpp>
 #include <boost/shared_ptr.hpp>
@@ -50 +52 @@
   Id getId() const;
 
+  /**
+   * @returns True if the event has a property @a key; otherwise
+   * false.
+   */
+  bool hasProperty(const std::string& key) const;
+  
+  /**
+   * Sets the property @a key to @a value.
+   */
+  template<typename ValueType>
+  void setProperty(const std::string& key, const ValueType& value);
+
+  /**
+   * Fetches the value of the property @a key and stores it in @a
+   * value.
+   *
+   * @returns True if the event had a property @a key; otherwise
+   * false. @a value is only valid if getProperty returns true.
+   */
+  template<typename ValueType>
+  bool getProperty(const std::string& key, ValueType* value) const;
+
+  /**
+   * Fetches the value of the property @a key.
+   *
+   * @returns The property value.
+   *
+   * @throws Licq::InvalidArgumentException If @a key don't exists.
+   * @throws boost::bad_any_cast If the ValueType is wrong.
+   */
+  template<typename ValueType>
+  const ValueType& getProperty(const std::string& key) const;
+
+  /**
+   * Unsets the property @a key.
+   */
+  void unsetProperty(const std::string& key);
+
 protected:
   Event(const std::string& name);
@@ -59 +99 @@
   const Id myId;
 };
+
+template<>
+void Event::setProperty(const std::string& key, const boost::any& value);
+
+template<>
+bool Event::getProperty(const std::string& key, const boost::any** value) const;
+
+template<>
+const boost::any& Event::getProperty(const std::string& key) const;
 
 } // namespace Licq
@@ -72 +121 @@
 }
 
+template<typename ValueType>
+inline void Licq::Event::setProperty(const std::string& key,
+                                     const ValueType& value)
+{
+  setProperty(key, boost::any(value));
+}
+
+template<typename ValueType>
+inline bool Licq::Event::getProperty(const std::string& key,
+                                     ValueType* value) const
+{
+  const boost::any* any;
+  if (!getProperty(key, &any))
+    return false;
+
+  const ValueType* ptr = boost::any_cast<const ValueType>(any);
+  if (ptr == NULL)
+    return false;
+
+  *value = *ptr;
+  return true;
+}
+
+template<typename ValueType>
+inline const ValueType& Licq::Event::getProperty(const std::string& key) const
+{
+  const boost::any& any = getProperty<boost::any>(key);
+  return boost::any_cast<const ValueType&>(any);
+}
+
 #endif

branches/newapi/licq/src/event/event.cpp

@@ -21 +21 @@
 #include "licq/thread/mutex.h"
 #include "licq/thread/mutexlocker.h"
+#include "util/tr.h"
+
+#include <cassert>
+#include <map>
 
 static Licq::Event::Id NextEventId = 1;
@@ -33 +37 @@
 {
 
+typedef std::map<std::string, boost::any> Properties;
+
 class Event::Private
 {
@@ -40 +46 @@
     delete event;
   }
+
+  Properties myProperties;
 };
 
@@ -59 +67 @@
   delete myPrivate;
 }
+
+bool Licq::Event::hasProperty(const std::string& key) const
+{
+  return (myPrivate->myProperties.find(key) != myPrivate->myProperties.end());
+}
+
+template<>
+void Licq::Event::setProperty(const std::string& key, const boost::any& value)
+{
+  assert(!value.empty());
+  myPrivate->myProperties[key] = value;
+}
+
+template<>
+bool Licq::Event::getProperty(const std::string& key,
+                              const boost::any** value) const
+{
+  Properties::const_iterator prop = myPrivate->myProperties.find(key);
+  if (prop == myPrivate->myProperties.end())
+    return false;
+
+  *value = &prop->second;
+  return true;
+}
+
+template<>
+const boost::any& Licq::Event::getProperty(const std::string& key) const
+{
+  Properties::const_iterator prop = myPrivate->myProperties.find(key);
+  if (prop == myPrivate->myProperties.end())
+  {
+    throw InvalidArgumentException("Event::getProperty",
+                                   tr("no property named '%1%'") % key);
+  }
+
+  return prop->second;
+}
+
+void Licq::Event::unsetProperty(const std::string& key)
+{
+  myPrivate->myProperties.erase(key);
+}

branches/newapi/licq/src/event/test/eventtest.cpp

@@ -37 +37 @@
 }
 
+BOOST_AUTO_TEST_CASE(properties)
+{
+  boost::shared_ptr<Licq::Event> test = Licq::Event::create("test");
+
+  const int i = 42;
+  test->setProperty("i", i + 1);
+  test->setProperty("i", i);
+  BOOST_CHECK(test->hasProperty("i"));
+  
+  int j = 0;
+  BOOST_CHECK(test->getProperty("i", &j));
+  BOOST_CHECK_EQUAL(i, j);
+  BOOST_CHECK_EQUAL(test->getProperty<int>("i"), i);
+
+  float k = 0;
+  BOOST_CHECK(!test->getProperty("i", &k));
+  BOOST_CHECK_THROW(test->getProperty<float>("i"), boost::bad_any_cast);
+
+  test->unsetProperty("i");
+  BOOST_CHECK(!test->hasProperty("i"));
+  BOOST_CHECK(!test->getProperty<int>("i", &j));
+  BOOST_CHECK_THROW(test->getProperty<int>("i"), Licq::InvalidArgumentException);
+}
+
 BOOST_AUTO_TEST_SUITE_END()