Changeset e2e035e for src/Patterns/Observer/Observable.cpp

Timestamp:

Dec 13, 2011, 9:46:10 AM (14 years ago)

Author:

Frederik Heber <heber@…>

Children:

549b62

Parents:

bc2698

git-author:

Frederik Heber <heber@…> (12/01/11 10:20:57)

git-committer:

Frederik Heber <heber@…> (12/13/11 09:46:10)

Message:

Refactored all Observer stuff into own subfolder and split up into distinct modules.

• Observer/all.hpp is all that's needed.

File:

• src/Patterns/Observer/Observable.cpp (moved) (moved from src/Patterns/Observer.cpp ) (19 diffs)

src/Patterns/Observer/Observable.cpp

@@ -7 +7 @@
 
 /*
- * Observer.cpp
- *
- *  Created on: Jan 19, 2010
- *      Author: crueger
+ * Observable.cpp
+ *
+ *  Created on: Dec 1, 2011
+ *      Author: heber
  */
 
@@ -20 +20 @@
 #include "MemDebug.hpp"
 
-#include "Observer.hpp"
-
-#include <iostream>
-
 #include "Assert.hpp"
-#include "MemDebug.hpp"
-
-using namespace std;
-
-/****************** Static stuff for the observer mechanism ************/
+#include "Channels.hpp"
+#include "Notification.hpp"
+#include "Observable.hpp"
+
 
 // All infrastructure for the observer-pattern is bundled at a central place
@@ -39 +34 @@
 // See [Gamma et al, 1995] p. 297
 
-map<Observable*, int> Observable::depth;  //!< Map of Observables to the depth of the DAG of Observers
-map<Observable*,multimap<int,Observer*> > Observable::callTable; //!< Table for each Observable of all its Observers
+std::map<Observable*, int> Observable::depth;  //!< Map of Observables to the depth of the DAG of Observers
+std::map<Observable*,std::multimap<int,Observer*> > Observable::callTable; //!< Table for each Observable of all its Observers
 std::map<Observable*,std::set<Notification*> > Observable::notifications;
-set<Observable*> Observable::busyObservables; //!< Set of Observables that are currently busy notifying their sign-on'ed Observers
+std::set<Observable*> Observable::busyObservables; //!< Set of Observables that are currently busy notifying their sign-on'ed Observers
 Observable::ChannelMap Observable::NotificationChannels; //!< Map of Observables to their Channels.
 
@@ -59 +54 @@
   // by the STL and initialized to 0 (see STL documentation)
 #ifdef LOG_OBSERVER
-  observerLog().addMessage(depth[publisher]) << ">> Locking " << observerLog().getName(publisher) << endl;
+  observerLog().addMessage(depth[publisher]) << ">> Locking " << observerLog().getName(publisher) << std::endl;
 #endif
   depth[publisher]++;
@@ -80 +75 @@
   --depth[publisher];
 #ifdef LOG_OBSERVER
-  observerLog().addMessage(depth[publisher]) << "<< Unlocking " << observerLog().getName(publisher) << endl;
+  observerLog().addMessage(depth[publisher]) << "<< Unlocking " << observerLog().getName(publisher) << std::endl;
 #endif
   if(depth[publisher]){}
@@ -92 +87 @@
 
 void Observable::enque_notification_internal(Observable *publisher, Notification_ptr notification){
-  ASSERT(notification->owner==publisher,"Some object tried to send a notification it does not own");
   notifications[publisher].insert(notification);
 }
@@ -148 +142 @@
         observerLog().addMessage() << "-> Sending update from " << observerLog().getName(this)
                                    << " to " << observerLog().getName((*iter).second)
-                                   << " (priority=" << (*iter).first << ")"<< endl;
+                                   << " (priority=" << (*iter).first << ")"<< std::endl;
 #endif
         (*iter).second->update(this);
@@ -161 +155 @@
   for(notificationSet::iterator it = currentNotifications.begin();
       it != currentNotifications.end();++it){
-    (*it)->notifyAll();
+    (*it)->notifyAll(this);
   }
 
@@ -194 +188 @@
 #ifdef LOG_OBSERVER
       observerLog().addMessage() << "-* Update from " << observerLog().getName(publisher)
-                                 << " propagated by " << observerLog().getName(this) << endl;
+                                 << " propagated by " << observerLog().getName(this) << std::endl;
 #endif
       notifyAll();
@@ -201 +195 @@
 #ifdef LOG_OBSERVER
       observerLog().addMessage() << "-| Update from " <<  observerLog().getName(publisher)
-                                 << " not propagated by " << observerLog().getName(this) << endl;
+                                 << " not propagated by " << observerLog().getName(this) << std::endl;
 #endif
     }
@@ -214 +208 @@
 void Observable::signOn(Observer *target,int priority) const
 {
-  ASSERT(priority>=-20 && priority<=+20, "Priority out of range [-20:+20] when signing on Observer");
-#ifdef LOG_OBSERVER
-  observerLog().addMessage() << "@@ Signing on " << observerLog().getName(target) << " to " << observerLog().getName(const_cast<Observable *>(this)) << endl;
+  ASSERT(priority>=-20 && priority<=+20,
+      "Priority out of range [-20:+20] when signing on Observer");
+#ifdef LOG_OBSERVER
+  observerLog().addMessage() << "@@ Signing on " << observerLog().getName(target) << " to " << observerLog().getName(const_cast<Observable *>(this)) << std::endl;
 #endif
   bool res = false;
@@ -226 +221 @@
   }
   if(!res)
-    callees.insert(pair<int,Observer*>(priority,target));
+    callees.insert(std::pair<int,Observer*>(priority,target));
 }
 
@@ -235 +230 @@
 void Observable::signOff(Observer *target) const
 {
-  ASSERT(callTable.count(const_cast<Observable *>(this)),"SignOff called for an Observable without Observers.");
-#ifdef LOG_OBSERVER
-  observerLog().addMessage() << "** Signing off " << observerLog().getName(target) << " from " << observerLog().getName(const_cast<Observable *>(this)) << endl;
+  ASSERT(callTable.count(const_cast<Observable *>(this)),
+      "SignOff called for an Observable without Observers.");
+#ifdef LOG_OBSERVER
+  observerLog().addMessage() << "** Signing off " << observerLog().getName(target) << " from " << observerLog().getName(const_cast<Observable *>(this)) << std::endl;
 #endif
   callees_t &callees = callTable[const_cast<Observable *>(this)];
@@ -258 +254 @@
 void Observable::signOn(Observer *target, Notification_ptr notification) const
 {
-  ASSERT(notification->owner==this,
-         "Trying to sign on for a notification that is not provided by this object");
-
   notification->addObserver(target);
 }
@@ -266 +259 @@
 void Observable::signOff(Observer *target, Notification_ptr notification) const
 {
-  ASSERT(notification->owner==this,
-         "Trying to sign off from a notification that is not provided by this object");
-
   notification->removeObserver(target);
 }
@@ -279 +269 @@
 Notification_ptr Observable::getChannel(size_t no) const
 {
-  ChannelMap::iterator iter = NotificationChannels.find(const_cast<Observable *>(this));
+  const ChannelMap::const_iterator iter = NotificationChannels.find(const_cast<Observable * const>(this));
   ASSERT(iter != NotificationChannels.end(),
       "Observable::getChannel() - we do not have a channel in NotificationChannels.");
@@ -297 +287 @@
 /** Constructor for class Observable.
  */
-Observable::Observable(string name) :
+Observable::Observable(std::string name) :
   Observer(Observer::BaseConstructor())
 {
 #ifdef LOG_OBSERVER
   observerLog().addName(this,name);
-  observerLog().addMessage() << "++ Creating Observable " << observerLog().getName(this) << endl;
+  observerLog().addMessage() << "++ Creating Observable " << observerLog().getName(this) << std::endl;
 #endif
 }
@@ -312 +302 @@
 {
 #ifdef LOG_OBSERVER
-  observerLog().addMessage() << "-- Destroying Observable " << observerLog().getName(this) << endl;
+  observerLog().addMessage() << "-- Destroying Observable " << observerLog().getName(this) << std::endl;
 #endif
   if(callTable.count(this)) {
@@ -324 +314 @@
   }
 }
-
-/** Constructor for class Observer.
- */
-Observer::Observer(string name)
-{
-#ifdef LOG_OBSERVER
-  observerLog().addName(this,name);
-  observerLog().addMessage() << "++ Creating Observer " << observerLog().getName(this) << endl;
-#endif
-}
-
-/**
- * Base Constructor for class Observer
- *
- * only called from Observable Constructor
- */
-Observer::Observer(Observer::BaseConstructor){
-#ifdef LOG_OBSERVER
-  observerLog().addObservable(this);
-#endif
-}
-
-/** Destructor for class Observer.
- */
-Observer::~Observer()
-{
-#ifdef LOG_OBSERVER
-  if(!observerLog().isObservable(this)){
-    observerLog().addMessage() << "-- Destroying Observer " << observerLog().getName(this) << endl;
-  }
-#endif
-}
-
-/**
- * Method for specialized notifications.
- * Most Observers wont need or use this, so it is implemented
- * empty in the base case;
- */
-void Observer::recieveNotification(Observable *publisher, Notification_ptr notification){
-  ASSERT(0,"Notification received by object that did not sign on for it.");
-}
-
-Notification::Notification(Observable *_owner) :
-    owner(_owner), channelno(-1)
-{}
-
-Notification::Notification(Observable *_owner, size_t _channelno) :
-    owner(_owner), channelno(_channelno)
-{}
-
-Notification::~Notification(){}
-
-void Notification::addObserver(Observer *target){
-  targets.insert(target);
-}
-
-void Notification::removeObserver(Observer *target){
-  targets.erase(target);
-}
-
-void Notification::notifyAll(){
-  for(std::set<Observer*>::iterator it=targets.begin();
-      it!=targets.end();++it){
-    (*it)->recieveNotification(owner,this);
-  }
-}
-
-Channels::Channels(Observable *_owner) :
-  owner(_owner)
-{}
-
-Channels::~Channels()
-{
-  // free all present Notifications
-  for(NotificationTypetoRefMap::iterator iter = ChannelMap.begin();
-      !ChannelMap.empty(); iter = ChannelMap.begin()) {
-    delete iter->second;
-    ChannelMap.erase(iter);
-  }
-}
-
-void Channels::addChannel(size_t no)
-{
-  NotificationTypetoRefMap::const_iterator iter = ChannelMap.find(no);
-  ASSERT(iter == ChannelMap.end(),
-      "Channels::addChannel() - channel "+toString(int(no))+" is already present in ChannelMap.");
-  ChannelMap.insert( std::make_pair(no, new Notification(owner, no)) );
-}
-
-void Channels::removeChannel(size_t no)
-{
-  NotificationTypetoRefMap::iterator iter = ChannelMap.find(no);
-  ASSERT(iter != ChannelMap.end(),
-      "Channels::removeChannel() - channel "+toString(int(no))+" not present in ChannelMap.");
-  delete iter->second;
-  ChannelMap.erase(iter);
-}
-
-Notification_ptr Channels::getChannel(size_t no) const
-{
-  NotificationTypetoRefMap::const_iterator iter = ChannelMap.find(no);
-  ASSERT(iter != ChannelMap.end(),
-      "Channels::getChannel() - channel "+toString(int(no))+" not present in ChannelMap.");
-  return iter->second;
-}
-
-size_t Channels::getType(Notification_ptr channel) const
-{
-  return channel->getChannelNo();
-}
-
-
-#ifdef LOG_OBSERVER
-
-/************************* Methods to do logging of the Observer Mechanism *********/
-
-// The log needs to exist fairly early, so we make it construct on first use,
-// and never destroy it
-ObserverLog &observerLog(){
-  // yes, this memory is never freed... we need it around for the whole programm,
-  // so no freeing is possible
-  static ObserverLog *theLog = Memory::ignore(new ObserverLog());
-  return *theLog;
-}
-
-
-ObserverLog::ObserverLog() :
-  count (0)
-{}
-
-ObserverLog::~ObserverLog(){}
-
-string ObserverLog::getLog(){return log.str();}
-
-std::string ObserverLog::getName(void* obj){
-  return names[obj];
-}
-
-bool ObserverLog::isObservable(void* obj){
-  return observables.count(obj);
-}
-
-void ObserverLog::addName(void* obj , string name){
-  stringstream sstr;
-  sstr << name << "_" << count++;
-  names[obj] = sstr.str();
-}
-
-void ObserverLog::addObservable(void* obj){
-  observables.insert(obj);
-}
-
-void ObserverLog::deleteName(void* obj){
-  names.erase(obj);
-}
-
-void ObserverLog::deleteObservable(void* obj){
-  observables.erase(obj);
-}
-
-stringstream &ObserverLog::addMessage(int depth){
-  for(int i=depth;i--;)
-    log << "  ";
-  return log;
-}
-
-#endif