[Scummvm-cvs-logs] SF.net SVN: scummvm:[55024] scummvm/trunk
Bluddy at users.sourceforge.net
Bluddy at users.sourceforge.net
Thu Dec 23 14:38:38 CET 2010
Revision: 55024
http://scummvm.svn.sourceforge.net/scummvm/?rev=55024&view=rev
Author: Bluddy
Date: 2010-12-23 13:38:37 +0000 (Thu, 23 Dec 2010)
Log Message:
-----------
PLUGINS: switched plugin manager to inheritance rather than #defines
The reason for this was that I found issues where the wrong functions were called in EngineManager for single plugin operation. Rather than inserting more messy #defines, I preferred to change the PluginManager to use virtual functions, which also makes EngineManager simpler.
Modified Paths:
--------------
scummvm/trunk/base/main.cpp
scummvm/trunk/base/plugins.cpp
scummvm/trunk/base/plugins.h
scummvm/trunk/engines/metaengine.h
scummvm/trunk/gui/launcher.cpp
Modified: scummvm/trunk/base/main.cpp
===================================================================
--- scummvm/trunk/base/main.cpp 2010-12-23 13:11:10 UTC (rev 55023)
+++ scummvm/trunk/base/main.cpp 2010-12-23 13:38:37 UTC (rev 55024)
@@ -107,11 +107,7 @@
printf("User picked target '%s' (gameid '%s')...\n", ConfMan.getActiveDomainName().c_str(), gameid.c_str());
printf("%s", " Looking for a plugin supporting this gameid... ");
-#if defined(ONE_PLUGIN_AT_A_TIME) && defined(DYNAMIC_MODULES)
- GameDescriptor game = EngineMan.findGameOnePluginAtATime(gameid, &plugin);
-#else
GameDescriptor game = EngineMan.findGame(gameid, &plugin);
-#endif
if (plugin == 0) {
printf("failed\n");
@@ -342,14 +338,9 @@
settings.erase("debugflags");
}
-#if defined(ONE_PLUGIN_AT_A_TIME) && defined(DYNAMIC_MODULES)
- // Only load non-engine plugins and first engine plugin initially in this case.
- PluginManager::instance().loadNonEnginePluginsAndEnumerate();
-#else
- // Load the plugins.
- PluginManager::instance().loadPlugins();
-#endif
-
+ PluginManager::instance().init();
+ PluginManager::instance().loadAllPlugins(); // load plugins for cached plugin manager
+
// If we received an invalid music parameter via command line we check this here.
// We can't check this before loading the music plugins.
// On the other hand we cannot load the plugins before we know the file paths (in case of external plugins).
@@ -463,11 +454,8 @@
// Clear the active config domain
ConfMan.setActiveDomain("");
- // PluginManager::instance().unloadPlugins();
+ PluginManager::instance().loadAllPlugins(); // only for cached manager
-#if !defined(ONE_PLUGIN_AT_A_TIME)
- PluginManager::instance().loadPlugins();
-#endif
} else {
GUI::displayErrorDialog(_("Could not find any engine capable of running the selected game"));
}
@@ -476,7 +464,7 @@
setupGraphics(system);
launcherDialog();
}
- PluginManager::instance().unloadPlugins();
+ PluginManager::instance().unloadAllPlugins();
PluginManager::destroy();
GUI::GuiManager::destroy();
Common::ConfigManager::destroy();
Modified: scummvm/trunk/base/plugins.cpp
===================================================================
--- scummvm/trunk/base/plugins.cpp 2010-12-23 13:11:10 UTC (rev 55023)
+++ scummvm/trunk/base/plugins.cpp 2010-12-23 13:38:37 UTC (rev 55024)
@@ -300,8 +300,20 @@
#pragma mark -
-DECLARE_SINGLETON(PluginManager);
+PluginManager *PluginManager::_instance = NULL;
+PluginManager &PluginManager::instance() {
+ if (_instance)
+ return *_instance;
+
+#if defined(ONE_PLUGIN_AT_A_TIME) && defined(DYNAMIC_MODULES)
+ _instance = new PluginManagerUncached();
+#else
+ _instance = new PluginManager();
+#endif
+ return *_instance;
+}
+
PluginManager::PluginManager() {
// Always add the static plugin provider.
addPluginProvider(new StaticPluginProvider());
@@ -309,7 +321,7 @@
PluginManager::~PluginManager() {
// Explicitly unload all loaded plugins
- unloadPlugins();
+ unloadAllPlugins();
// Delete the plugin providers
for (ProviderList::iterator pp = _providers.begin();
@@ -325,8 +337,8 @@
//
// This should only be run once
-void PluginManager::loadNonEnginePluginsAndEnumerate() {
- unloadPlugins();
+void PluginManagerUncached::init() {
+ unloadAllPlugins();
_allEnginePlugins.clear();
// We need to resize our pluginsInMem list to prevent fragmentation
@@ -359,7 +371,7 @@
}
}
-void PluginManager::loadFirstPlugin() {
+void PluginManagerUncached::loadFirstPlugin() {
unloadPluginsExcept(PLUGIN_TYPE_ENGINE, NULL, false);
// let's try to find one we can load
@@ -371,7 +383,7 @@
}
}
-bool PluginManager::loadNextPlugin() {
+bool PluginManagerUncached::loadNextPlugin() {
unloadPluginsExcept(PLUGIN_TYPE_ENGINE, NULL, false);
for (++_currentPlugin; _currentPlugin != _allEnginePlugins.end(); ++_currentPlugin) {
@@ -383,7 +395,7 @@
return false; // no more in list
}
-void PluginManager::loadPlugins() {
+void PluginManager::loadAllPlugins() {
for (ProviderList::iterator pp = _providers.begin();
pp != _providers.end();
++pp) {
@@ -392,7 +404,7 @@
}
}
-void PluginManager::unloadPlugins() {
+void PluginManager::unloadAllPlugins() {
for (int i = 0; i < PLUGIN_TYPE_MAX; i++)
unloadPluginsExcept((PluginType)i, NULL);
}
@@ -456,11 +468,12 @@
DECLARE_SINGLETON(EngineManager);
-GameDescriptor EngineManager::findGameOnePluginAtATime(const Common::String &gameName, const EnginePlugin **plugin) const {
+GameDescriptor EngineManager::findGame(const Common::String &gameName, const EnginePlugin **plugin) const {
GameDescriptor result;
+
PluginManager::instance().loadFirstPlugin();
do {
- result = findGame(gameName, plugin);
+ result = findGameInLoadedPlugins(gameName, plugin);
if (!result.gameid().empty()) {
break;
}
@@ -468,7 +481,10 @@
return result;
}
-GameDescriptor EngineManager::findGame(const Common::String &gameName, const EnginePlugin **plugin) const {
+/**
+ * Find the game within the plugins loaded in memory
+ **/
+GameDescriptor EngineManager::findGameInLoadedPlugins(const Common::String &gameName, const EnginePlugin **plugin) const {
// Find the GameDescriptor for this target
const EnginePlugin::List &plugins = getPlugins();
GameDescriptor result;
@@ -493,19 +509,15 @@
GameList candidates;
EnginePlugin::List plugins;
EnginePlugin::List::const_iterator iter;
-#if defined(ONE_PLUGIN_AT_A_TIME) && defined(DYNAMIC_MODULES)
PluginManager::instance().loadFirstPlugin();
do {
-#endif
plugins = getPlugins();
// Iterate over all known games and for each check if it might be
// the game in the presented directory.
for (iter = plugins.begin(); iter != plugins.end(); ++iter) {
candidates.push_back((**iter)->detectGames(fslist));
}
-#if defined(ONE_PLUGIN_AT_A_TIME) && defined(DYNAMIC_MODULES)
} while (PluginManager::instance().loadNextPlugin());
-#endif
return candidates;
}
Modified: scummvm/trunk/base/plugins.h
===================================================================
--- scummvm/trunk/base/plugins.h 2010-12-23 13:11:10 UTC (rev 55023)
+++ scummvm/trunk/base/plugins.h 2010-12-23 13:38:37 UTC (rev 55024)
@@ -298,35 +298,58 @@
* Singleton class which manages all plugins, including loading them,
* managing all Plugin class instances, and unloading them.
*/
-class PluginManager : public Common::Singleton<PluginManager> {
+class PluginManager {
+protected:
typedef Common::Array<PluginProvider *> ProviderList;
-private:
+
PluginList _pluginsInMem[PLUGIN_TYPE_MAX];
ProviderList _providers;
- PluginList _allEnginePlugins;
- PluginList::iterator _currentPlugin;
-
bool tryLoadPlugin(Plugin *plugin);
void addToPluginsInMemList(Plugin *plugin);
- friend class Common::Singleton<SingletonBaseType>;
- PluginManager();
+ static PluginManager *_instance;
+ PluginManager();
public:
- ~PluginManager();
+ virtual ~PluginManager();
+ static void createInstance(bool cached);
+ static void destroy() { delete _instance; }
+ static PluginManager &instance();
+
void addPluginProvider(PluginProvider *pp);
- void loadNonEnginePluginsAndEnumerate();
- void loadFirstPlugin();
- bool loadNextPlugin();
+ virtual void init() {}
+ virtual void loadFirstPlugin() {}
+ virtual bool loadNextPlugin() { return false; }
- void loadPlugins();
- void unloadPlugins();
+ virtual void loadAllPlugins();
+ void unloadAllPlugins();
+
void unloadPluginsExcept(PluginType type, const Plugin *plugin, bool deletePlugin = true);
const PluginList &getPlugins(PluginType t) { return _pluginsInMem[t]; }
};
+/**
+ * Uncached version of plugin manager
+ * Keeps only one dynamic plugin in memory at a time
+ **/
+class PluginManagerUncached : public PluginManager {
+protected:
+ friend class PluginManager;
+ PluginList _allEnginePlugins;
+ PluginList::iterator _currentPlugin;
+
+ PluginManagerUncached() {}
+
+public:
+ virtual void init();
+ virtual void loadFirstPlugin();
+ virtual bool loadNextPlugin();
+
+ virtual void loadAllPlugins() {} // we don't allow this
+};
+
#endif
Modified: scummvm/trunk/engines/metaengine.h
===================================================================
--- scummvm/trunk/engines/metaengine.h 2010-12-23 13:11:10 UTC (rev 55023)
+++ scummvm/trunk/engines/metaengine.h 2010-12-23 13:38:37 UTC (rev 55024)
@@ -231,7 +231,7 @@
friend class Common::Singleton<SingletonBaseType>;
public:
- GameDescriptor findGameOnePluginAtATime(const Common::String &gameName, const EnginePlugin **plugin = NULL) const;
+ GameDescriptor findGameInLoadedPlugins(const Common::String &gameName, const EnginePlugin **plugin = NULL) const;
GameDescriptor findGame(const Common::String &gameName, const EnginePlugin **plugin = NULL) const;
GameList detectGames(const Common::FSList &fslist) const;
const EnginePlugin::List &getPlugins() const;
Modified: scummvm/trunk/gui/launcher.cpp
===================================================================
--- scummvm/trunk/gui/launcher.cpp 2010-12-23 13:11:10 UTC (rev 55023)
+++ scummvm/trunk/gui/launcher.cpp 2010-12-23 13:38:37 UTC (rev 55024)
@@ -924,11 +924,7 @@
const EnginePlugin *plugin = 0;
-#if defined(ONE_PLUGIN_AT_A_TIME) && defined(DYNAMIC_MODULES)
- EngineMan.findGameOnePluginAtATime(gameId, &plugin);
-#else
EngineMan.findGame(gameId, &plugin);
-#endif
String target = _domains[item];
target.toLowercase();
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Scummvm-git-logs
mailing list