Changeset c8cb0d for ThirdParty

Timestamp:

Dec 26, 2025, 9:40:14 PM (5 weeks ago)

Author:

Frederik Heber <frederik.heber@…>

Branches:

Candidate_v1.7.1, stable

Children:

033646

Parents:

f2d5ce

git-author:

Frederik Heber <frederik.heber@…> (12/10/25 16:15:28)

git-committer:

Frederik Heber <frederik.heber@…> (12/26/25 21:40:14)

Message:

Streamlines channel creation in Observables.

• CodePatterns is now version 1.3.4.
• we no longer need to add the channels manually in the cstor of a class that derives from Observable. Instead, we just need to pass the maximum number of channels (as they are typically enumerated anyway) and they are generated and added.
• added mutex protection when inserting.
• adjusted class Relay to forward similar convenience cstors.
• adjusted all call sites in molecuilder.

Location:

ThirdParty

Files:

• CodePatterns/configure.ac (modified) (2 diffs)
• CodePatterns/src/CodePatterns/Observer/Observable.hpp (modified) (3 diffs)
• CodePatterns/src/CodePatterns/Observer/Relay.hpp (modified) (1 diff)
• CodePatterns/src/Observer/Observable.cpp (modified) (3 diffs)
• CodePatterns/src/Observer/Relay.cpp (modified) (1 diff)
• CodePatterns/src/Observer/unittests/stubs/ObserverStub.cpp (modified) (2 diffs)
• JobMarket/src/JobMarket/FragmentQueue.cpp (modified) (1 diff)

ThirdParty/CodePatterns/configure.ac

@@ -3 +3 @@
 
 AC_PREREQ([2.65])
-AC_INIT([LibCodePatterns], [1.3.3], [heber@ins.uni-bonn.de], [libcodepatterns], [http://trac.ins.uni-bonn.de/projects/CodePatterns/])
+AC_INIT([LibCodePatterns], [1.3.4], [heber@ins.uni-bonn.de], [libcodepatterns], [http://trac.ins.uni-bonn.de/projects/CodePatterns/])
 AC_CONFIG_AUX_DIR([build-aux])
 AC_CONFIG_SRCDIR([src/codepatterns-config-main.cpp])
@@ -39 +39 @@
 # refer to the libtool manual, section "Updating library version information":
 # http://www.gnu.org/software/libtool/manual/html_node/Updating-version-info.html
-AC_SUBST([CODEPATTERNS_SO_VERSION], [12:2:1])
-AC_SUBST([CODEPATTERNS_API_VERSION], [1.3.3])
+AC_SUBST([CODEPATTERNS_SO_VERSION], [12:3:1])
+AC_SUBST([CODEPATTERNS_API_VERSION], [1.3.4])
 
 # Checks for libraries.

ThirdParty/CodePatterns/src/CodePatterns/Observer/Observable.hpp

@@ -51 +51 @@
   typedef std::vector<size_t> channels_t;
 
+  /** Constructor for class Observable.
+   */
   Observable(
       std::string _name,
       const channels_t &_channels = channels_t());
+
+  /** Convenience cstor which generates a number of notifications
+   * in channels.
+   */
+  Observable(
+      std::string _name,
+      const unsigned int _maximum_notification_types);
+
   virtual ~Observable();
 
@@ -137 +147 @@
 protected:
 
-  static void insertNotificationChannel( std::pair<Observable*, Channels *> _pair);
   static void eraseNotificationChannel(Observable * const _target);
   static bool isNotificationChannelPresent(const Observable * const _target);
@@ -143 +152 @@
   static Notification_ptr getNotificationChannel(const Observable * const _target, const size_t _no);
 
+  void createAndInsertNotificationChannel(const unsigned int _maximum_notification_types);
+
 private:
+  /**
+   * Private inserter for a notification channel.
+   * 
+   * Use \a createAndInsertNotificationChannel() instead.
+   */
+  static void insertNotificationChannel( std::pair<Observable*, Channels *> _pair);
 
   typedef std::map<Observable*, Channels *> ChannelMap;

ThirdParty/CodePatterns/src/CodePatterns/Observer/Relay.hpp

@@ -34 +34 @@
 public:
   Relay(std::string _name);
+  Relay(std::string _name, const channels_t &_channels);
+  Relay(std::string _name, const unsigned int _maximum_notification_types);
   virtual ~Relay();
 

ThirdParty/CodePatterns/src/Observer/Observable.cpp

@@ -383 +383 @@
 }
 
-/** Constructor for class Observable.
- */
 Observable::Observable(
     std::string name,
@@ -405 +403 @@
     insertNotificationChannel( std::make_pair(static_cast<Observable *>(this), OurChannel) );
   }
+}
+
+Observable::Observable(
+    std::string name,
+    const unsigned int _maximum_notification_types) :
+  Observer(Observer::BaseConstructor()),
+  graveyard_informer(&noop_informer)
+{
+#ifdef LOG_OBSERVER
+  observerLog().addName(this,name);
+  observerLog().addMessage() << "++ Creating Observable "
+      << observerLog().getName(static_cast<Observable *>(this));
+#endif
+  createAndInsertNotificationChannel(_maximum_notification_types);
 }
 
@@ -459 +471 @@
 }
 
+void Observable::createAndInsertNotificationChannel(const unsigned int _maximum_notification_types)
+{
+  boost::recursive_mutex::scoped_lock lock(GlobalObservableInfo::getInstance().getObservablesMapMutex());
+  Channels *OurChannel = new Channels;
+  // add instance for each notification type
+  for (size_t type = 0; type < _maximum_notification_types; ++type)
+    OurChannel->addChannel(type);
+  insertNotificationChannel( std::make_pair(static_cast<Observable *>(this), OurChannel) );
+}
+
 void Observable::eraseNotificationChannel(Observable * const _target)
 {

ThirdParty/CodePatterns/src/Observer/Relay.cpp

@@ -33 +33 @@
 Relay::Relay(std::string name) :
   Observable(name),
+  Updater(NULL)
+{
+#ifdef LOG_OBSERVER
+  observerLog().addName(this,name);
+  observerLog().addMessage() << "++ Creating Relay " << observerLog().getName(this);
+#endif
+}
+
+/** Constructor for class Relay.
+ */
+Relay::Relay(std::string name, const channels_t &_channels) :
+  Observable(name, _channels),
+  Updater(NULL)
+{
+#ifdef LOG_OBSERVER
+  observerLog().addName(this,name);
+  observerLog().addMessage() << "++ Creating Relay " << observerLog().getName(this);
+#endif
+}
+
+/** Constructor for class Relay.
+ */
+Relay::Relay(std::string name, const unsigned int _maximum_notification_types) :
+  Observable(name, _maximum_notification_types),
   Updater(NULL)
 {

ThirdParty/CodePatterns/src/Observer/unittests/stubs/ObserverStub.cpp

@@ -133 +133 @@
 
 NotificationObservable::NotificationObservable() :
-  Observable("NotificationObservable")
-{
-  Channels *OurChannel = new Channels();
-  Observable::insertNotificationChannel( std::make_pair(this, OurChannel) );
-  OurChannel->addChannel(Operation1Notify);
-  OurChannel->addChannel(Operation2Notify);
-}
+  Observable("NotificationObservable", { Operation1Notify, Operation2Notify })
+{}
 
 NotificationObservable::~NotificationObservable()
@@ -242 +237 @@
 
 RelayNotification::RelayNotification() :
-    Relay(std::string("RelayTest"))
-{
-  Channels *OurChannel = new Channels();
-  Observable::insertNotificationChannel( std::make_pair(this, OurChannel) );
-  OurChannel->addChannel(NotificationObservable::Operation1Notify);
-  OurChannel->addChannel(NotificationObservable::Operation2Notify);
-}
+    Relay(std::string("RelayTest"), { NotificationObservable::Operation1Notify, NotificationObservable::Operation2Notify })
+{}
 
 RelayNotification::~RelayNotification()

ThirdParty/JobMarket/src/JobMarket/FragmentQueue.cpp

@@ -48 +48 @@
  */
 FragmentQueue::FragmentQueue() :
-    Observable("FragmentQueue"),
+    Observable("FragmentQueue", NotificationType_MAX),
     doneJobs(0)
-{
-  // observable stuff
-  Channels *OurChannel = new Channels;
-  Observable::insertNotificationChannel( std::make_pair(static_cast<Observable *>(this), OurChannel) );
-  // add instance for each notification type
-  for (size_t type = 0; type < NotificationType_MAX; ++type)
-    OurChannel->addChannel(type);
-}
+{}
 
 /** Destructor for class FragmentQueue.