Changeset 6945 for code/branches/presentation3/src/modules/questsystem/notifications

Timestamp:

May 20, 2010, 10:36:48 PM (14 years ago)

Author:

dafrick

Message:

A lot of cleanup, mostly increasing output levels, which means, that the console is no longer cluttered by lots and lots of Quest-stuff (the log file still is, but that should be ok…).
Also some possible bugs (or let's say pitfalls) removed, which have been around for a long time and didn't cause any problems so far. Now they never will.
Also, regarding my previous commit. Quests seem tu work just fine, even the second time the level is loaded, which is awesome.

Ergo: Questsystem/Notificationsystem segfault upon loading a level with Quests/Notifications in it twice is now officially resolved.

Location:

code/branches/presentation3/src/modules/questsystem/notifications

Files:

• Notification.cc (modified) (3 diffs)
• Notification.h (modified) (1 diff)
• NotificationManager.cc (modified) (4 diffs)
• NotificationManager.h (modified) (2 diffs)
• NotificationQueue.cc (modified) (4 diffs)
• NotificationQueue.h (modified) (1 diff)

code/branches/presentation3/src/modules/questsystem/notifications/Notification.cc

@@ -40 +40 @@
 {
 
+    CreateUnloadableFactory(Notification);
+    
     /**
     @brief
@@ -56 +58 @@
         The message of the Notification.
     */
-    Notification::Notification(const std::string & message) : BaseObject(NULL)
+    Notification::Notification(BaseObject* creator, const std::string & message) : BaseObject(creator)
     {
         this->message_ = message;
@@ -67 +69 @@
     Notification::~Notification()
     {
+        
     }
 

code/branches/presentation3/src/modules/questsystem/notifications/Notification.h

@@ -53 +53 @@
         public:
             Notification(BaseObject* creator);
-            Notification(const std::string & message);
+            Notification(BaseObject* creator, const std::string & message);
             virtual ~Notification();
 

code/branches/presentation3/src/modules/questsystem/notifications/NotificationManager.cc

@@ -118 +118 @@
     @brief
         Unregisters a Notification within the NotificationManager.
+    @param notification
+        A pointer to the Notification to be unregistered.
+    @param listener
+        A pointer to the NotificationListener the Notification is unregistered for.
     */
     void NotificationManager::unregisterNotification(Notification* notification, NotificationListener* listener)
@@ -124 +128 @@
         assert(listener);
 
+        // If the Notification was removed from the list of Notifications of the input NotificationListener, the counter for the Notification of the number of NotificationListeners it is present in is decremented.
         if(this->removeNotification(notification, *(this->notificationLists_.find(this->listenerList_.find(listener)->second)->second)))
             this->listenerCounter_[notification] = this->listenerCounter_[notification] - 1;
+
+        // If the Notification is no longer present in any of the NotificationListeners it can be removed from the map of all Notifications and be destroyed.
         if(this->listenerCounter_[notification] == (unsigned int) 0)
         {
             this->removeNotification(notification, this->allNotificationsList_);
+            this->listenerCounter_.erase(notification);
             notification->destroy();
         }
@@ -138 +146 @@
     @brief
         Helper method that removes an input notification form an input map.
+    @param notification
+        A pointer to the notification to be removed.
+    @param map
+        The map the notification should be removed from.
+    @return
+        Returns true if successful.
     */
     bool NotificationManager::removeNotification(Notification* notification, std::multimap<std::time_t, Notification*>& map)
     {
+        // Iterates through all items in the map until the Notification is found.
+        //TODO: Do more efficiently?
         for(std::multimap<std::time_t, Notification*>::iterator it = map.begin(); it != map.end(); it++)
         {
@@ -222 +238 @@
         this->listenerList_.erase(listener);
         this->notificationLists_.erase(identifier);
-        delete map;
+
+        // If the map is not the map of all notifications, delete it.
+        if(map != &this->allNotificationsList_)
+            delete map;
 
         COUT(4) << "NotificationListener unregistered with the NotificationManager." << std::endl;

code/branches/presentation3/src/modules/questsystem/notifications/NotificationManager.h

@@ -60 +60 @@
             virtual ~NotificationManager();
 
-            static const std::string ALL;
-            static const std::string NONE;
+            static const std::string ALL; //!< Static string to indicate a sender that sends to all NotificationListeners.
+            static const std::string NONE; //!< Static string to indicare a sender that sends to no specific NotificationListener.
 
             bool registerNotification(Notification* notification); //!< Registers a Notification within the NotificationManager.
@@ -99 +99 @@
             std::map<Notification*, unsigned int> listenerCounter_; //!< A container to store the number of NotificationListeners a Notification is registered with.
 
-            bool removeNotification(Notification* notification, std::multimap<std::time_t, Notification*>& map);
-
+            bool removeNotification(Notification* notification, std::multimap<std::time_t, Notification*>& map); //!< Helper method that removes an input notification form an input map.
 
     };

code/branches/presentation3/src/modules/questsystem/notifications/NotificationQueue.cc

@@ -124 +124 @@
         XMLPortParam(NotificationQueue, "position", setPosition, getPosition, xmlElement, mode);
 
-        COUT(3) << "NotificationQueue created." << std::endl;
+        COUT(3) << "NotificationQueue '" << this->getName() << "' created." << std::endl;
     }
 
@@ -179 +179 @@
         delete notifications;
 
-        COUT(3) << "NotificationQueue updated." << std::endl;
+        COUT(4) << "NotificationQueue '" << this->getName() << "' updated." << std::endl;
     }
 
@@ -202 +202 @@
         }
 
-        COUT(3) << "NotificationQueue updated. A new Notifications has been added." << std::endl;
+        COUT(4) << "NotificationQueue '" << this->getName() << "' updated. A new Notifications has been added." << std::endl;
     }
 
@@ -429 +429 @@
             return false;
 
+        // Unregister the NotificationQueue with the NotificationManager.
         NotificationManager::getInstance().unregisterNotification(container->notification, this);
         

code/branches/presentation3/src/modules/questsystem/notifications/NotificationQueue.h

@@ -71 +71 @@
 
         Creating a NotificationQueue through XML goes as follows:
+        Be aware that the NotificationQueue must be inside the <Level></Level> tags or bad things will happen.
         <NotificationQueue
             name = "SuperQueue" //Name of your OverlayQueue.