Changeset 11016

Timestamp:

Jan 2, 2016, 4:06:30 PM (9 years ago)

Author:

landauf

Message:

Added config value to PluginManager to define whether a dereferenced plugin should be completely unloaded (i.e. the shared library is closed) or merely deactivated (i.e. the library remains in the process, but Identifiers and other framework components are removed).
This option is true by default on tardis machines because there it seems impossible to completely unload a shared library due to the use of STB_GNU_UNIQUE which prevents that dlclose() unloads the library. This caused errors when a plugin should have been reloaded, e.g. when the pong level was restarted.

Location:

code/trunk

Files:

• cmake/LibraryConfigTardis.cmake (modified) (1 diff)
• src/SpecialConfig.h.in (modified) (1 diff)
• src/libraries/core/module/PluginManager.cc (modified) (4 diffs)
• src/libraries/core/module/PluginManager.h (modified) (3 diffs)

code/trunk/cmake/LibraryConfigTardis.cmake

@@ -34 +34 @@
 IF(TARDIS)
   MESSAGE(STATUS "Running on D-ITET isg.ee Tardis Computer. Using customized paths.")
+
+  SET(DO_NOT_UNLOAD_PLUGINS ON)
 
 #  SET(CMAKE_C_COMPILER "gcc-4.1.1")

code/trunk/src/SpecialConfig.h.in

@@ -51 +51 @@
 
 #cmakedefine ORXONOX_USE_WINMAIN            ///< Whether or not the console window is started as well
+
+#cmakedefine DO_NOT_UNLOAD_PLUGINS          ///< If defined then plugins are not unloaded (but merely deactivated) when the reference count drops to zero.
 
 // Handle default ConfigValues

code/trunk/src/libraries/core/module/PluginManager.cc

@@ -34 +34 @@
 #include "Plugin.h"
 #include "PluginReference.h"
+#include "core/CoreIncludes.h"
 #include "core/ApplicationPaths.h"
 #include "core/command/ConsoleCommandIncludes.h"
+#include "core/config/ConfigValueIncludes.h"
 #include "core/object/Context.h"
+
+#ifdef DO_NOT_UNLOAD_PLUGINS
+#  define MERELY_DEACTIVATE_PLUGINS true
+#else
+#  define MERELY_DEACTIVATE_PLUGINS false
+#endif
 
 namespace orxonox
@@ -48 +56 @@
     PluginManager* PluginManager::singletonPtr_s  = 0;
 
+    RegisterAbstractClass(PluginManager).inheritsFrom<Configurable>();
+
     PluginManager::PluginManager()
     {
+        RegisterObject(PluginManager);
+
         ModifyConsoleCommand("PluginManager", __CC_PluginManager_load_name).setObject(this);
         ModifyConsoleCommand("PluginManager", __CC_PluginManager_unload_name).setObject(this);
+
+        this->setConfigValues();
     }
 
@@ -63 +77 @@
         for (std::map<std::string, Plugin*>::iterator it = this->plugins_.begin(); it != this->plugins_.end(); ++it)
             delete it->second;
+    }
+
+    void PluginManager::setConfigValues()
+    {
+        SetConfigValue(bMerelyDeactivatePlugins_, MERELY_DEACTIVATE_PLUGINS);
     }
 
@@ -99 +118 @@
         Plugin* plugin = this->plugins_[name];
         if (plugin != NULL)
-            plugin->dereference(false);
+            plugin->dereference(this->bMerelyDeactivatePlugins_);
         else
             orxout(internal_warning) << "Cannot find plugin with name " << name << endl;

code/trunk/src/libraries/core/module/PluginManager.h

@@ -35 +35 @@
 #include <string>
 #include "util/Singleton.h"
+#include "core/config/Configurable.h"
 
 namespace orxonox
 {
-    class _CoreExport PluginManager : public Singleton<PluginManager>
+    class _CoreExport PluginManager : public Singleton<PluginManager>, public Configurable
     {
         friend class Singleton<PluginManager>;
@@ -45 +46 @@
             PluginManager();
             ~PluginManager();
+
+            void setConfigValues();
 
             void findPlugins();
@@ -58 +61 @@
             std::map<std::string, Plugin*> plugins_;
             std::map<std::string, PluginReference*> references_; // references that were created by console command
+            bool bMerelyDeactivatePlugins_;
 
             static PluginManager* singletonPtr_s;