source: code/trunk/src/libraries/core/module/PluginManager.cc @ 12130

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Fabian 'x3n' Landau
 *   Co-authors:
 *      ...
 *
 */

#include "PluginManager.h"

#include "SpecialConfig.h"
#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
{
    static const std::string __CC_PluginManager_load_name  = "load";
    static const std::string __CC_PluginManager_unload_name  = "unload";

    SetConsoleCommand("PluginManager", __CC_PluginManager_load_name, &PluginManager::loadPlugin);
    SetConsoleCommand("PluginManager", __CC_PluginManager_unload_name, &PluginManager::unloadPlugin);

    PluginManager* PluginManager::singletonPtr_s  = nullptr;

    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();
    }

    PluginManager::~PluginManager()
    {
        ModifyConsoleCommand("PluginManager", __CC_PluginManager_load_name).setObject(nullptr);
        ModifyConsoleCommand("PluginManager", __CC_PluginManager_unload_name).setObject(nullptr);

        for (const auto& mapEntry : this->references_)
            delete mapEntry.second;
        for (const auto& mapEntry : this->plugins_)
            delete mapEntry.second;
    }

    void PluginManager::setConfigValues()
    {
        SetConfigValue(bMerelyDeactivatePlugins_, MERELY_DEACTIVATE_PLUGINS).callback(this, &PluginManager::changedConfigValue);
    }

    void PluginManager::changedConfigValue()
    {
        if (this->bMerelyDeactivatePlugins_)
        {
            orxout(internal_warning) << "Orxonox is configured to NOT completely unload plugins."
                " This means that it's not possible to re-compile and reload a plugin at runtime." << endl;
        }
    }

    void PluginManager::findPlugins()
    {
        const std::map<std::string, std::string>& pluginPaths = ApplicationPaths::getInstance().getPluginPaths();
        for (const std::pair<std::string, std::string>& pluginPath : pluginPaths)
        {
            const std::string& name = pluginPath.first;
            const std::string& libraryName = pluginPath.second;

            orxout(internal_info) << "Found plugin with name '" << name << "' in module " << libraryName << endl;
            this->plugins_[name] = new Plugin(name, libraryName);
        }
    }

    void PluginManager::referencePlugin(const std::string& name)
    {
        Plugin* plugin = this->plugins_[name];
        if (plugin != nullptr)
            plugin->reference();
        else
            orxout(internal_warning) << "Cannot find plugin with name " << name << endl;
    }

    void PluginManager::dereferencePlugin(const std::string& name)
    {
        Plugin* plugin = this->plugins_[name];
        if (plugin != nullptr)
            plugin->dereference(this->bMerelyDeactivatePlugins_);
        else
            orxout(internal_warning) << "Cannot find plugin with name " << name << endl;
    }

    /**
     * @brief Console command to manually load a plugin. The plugin stays loaded until @ref unloadPlugin is called.
     */
    void PluginManager::loadPlugin(const std::string& name)
    {
        if (this->references_[name] == nullptr)
        {
            this->references_[name] = new PluginReference(name);
        }
        else
            orxout(internal_warning) << "Plugin " << name << " is already loaded" << endl;
    }

    /**
     * @brief Console command to unload a plugin if it was previously loaded manually by calling @ref loadPlugin.
     * Does not unload the plugin immediately if it is still used by another @ref PluginReference (e.g. by a @ref Level).
     */
    void PluginManager::unloadPlugin(const std::string& name)
    {
        PluginReference* reference = this->references_[name];
        if (reference != nullptr)
        {
            this->references_[name] = nullptr;
            delete reference;
        }
        else
            orxout(internal_warning) << "Plugin " << name << " is already unloaded" << endl;
    }
}