Changeset 2c11c1 for src/Patterns/Observer/ObserverLog.hpp

Timestamp:

Dec 13, 2011, 10:45:00 AM (14 years ago)

Author:

Frederik Heber <heber@…>

Children:

d85532

Parents:

40f2e6

git-author:

Frederik Heber <heber@…> (12/02/11 13:05:49)

git-committer:

Frederik Heber <heber@…> (12/13/11 10:45:00)

Message:

Modified ObserverLog: Singleton and both output to screen and internal Log.

• ObserverLog can now either be printed concurrently or later requested as string (e.g. on exit as has been done before). This should ease debugging Observer code.
• enable/disableLogging() (dis)activate printing to screen.
• ObserverLog is now a true singleton.

Details:

• Implemented helper class ObserverLog::Log which is returned as boost::shared_ptr on addMessage() and can be streamed to.
• On dstor the logged message is appended with endl, placed into ObserverLog's internal log and printed on screen if enableLogging().
• NOTE: streaming std::endl is not working, and not necessary.

File:

• src/Patterns/Observer/ObserverLog.hpp (modified) (3 diffs)

src/Patterns/Observer/ObserverLog.hpp

@@ -14 +14 @@
 #endif
 
+#include <boost/shared_ptr.hpp>
 #include <map>
 #include <set>
+#include <iosfwd>
+#include <string>
 #include <sstream>
-#include <string>
 
 #include "Observable.hpp"
 #include "Observer.hpp"
-
+#include "Singleton.hpp"
 
 /**
@@ -28 +30 @@
  * TODO: make this conditional dependent on compiler Flag.
  */
-class ObserverLog{
+class ObserverLog : public Singleton<ObserverLog> {
   friend class Observable;
   friend class Observer;
+  friend class Relay;
   template <typename> friend class Cacheable;
+  friend class Singleton<ObserverLog>;
 public:
-  ObserverLog();
-  ~ObserverLog();
   std::string getLog();                        // get everything that has been logged
   std::string getName(void*);                  // get the name of an actor
   bool isObservable(void*);
+  void disableLogging();
+  void enableLogging();
+
+  /** tiny helper class to allow for both capturing and printing of messages.
+   *
+   */
+  class Log {
+  public:
+    Log(ObserverLog *_callback_ref);
+    ~Log();
+
+    std::stringstream log;                      // the internal stream that later gets appended
+    ObserverLog *callback_ref;                  // internal stringstream to capture messages
+  };
+
 private:
+  ObserverLog();
+  ~ObserverLog();
   int count;                                   // number to reference each actor in this framework
   std::map<void*,std::string> names;           // List of names assigned to actors
@@ -46 +65 @@
   void deleteName(void*);                      // delete the name of an Actor
   void deleteObservable(void*);
-  std::stringstream &addMessage(int depth=0);  // Add a Message to the logging
-  std::stringstream log;                       // The internal log object
+  boost::shared_ptr<ObserverLog::Log> addMessage(int depth=0);       // Add a Message to the logging
+  std::stringstream log;
+  static std::ostream *nullstream;             // stream that is not displayed
+  static std::ostream *outstream;              // stream that is currently used
 };
 
 ObserverLog &observerLog();
 
-
+template <class T>
+boost::shared_ptr<ObserverLog::Log> operator<<(boost::shared_ptr<ObserverLog::Log> L, const T msg)
+{
+  L->log << msg;
+  return L;
+}
 
 #endif /* OBSERVERLOG_HPP_ */