diff options
author | Piotr Dziwiński <piotrdz@gmail.com> | 2012-08-12 10:15:19 -0700 |
---|---|---|
committer | Piotr Dziwiński <piotrdz@gmail.com> | 2012-08-12 10:15:19 -0700 |
commit | 50deedb6cbc927f6c7d6c3c5e9134d11c20782ae (patch) | |
tree | 8eb3fbd914cfea11660534b296bfddcffcc5f7b4 /src/plugins/plugininterface.h | |
parent | bc24b9f9e516e657fcc0034808e010287fc2e393 (diff) | |
parent | 62b545128f37746c343760e464872655b5523c6f (diff) | |
download | colobot-50deedb6cbc927f6c7d6c3c5e9134d11c20782ae.tar.gz colobot-50deedb6cbc927f6c7d6c3c5e9134d11c20782ae.tar.bz2 colobot-50deedb6cbc927f6c7d6c3c5e9134d11c20782ae.zip |
Merge pull request #36 from Erihel/dev
Merge of new features: plugins and INI profile, changes from dev-graphics
Diffstat (limited to 'src/plugins/plugininterface.h')
-rw-r--r-- | src/plugins/plugininterface.h | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/src/plugins/plugininterface.h b/src/plugins/plugininterface.h new file mode 100644 index 0000000..b8adddc --- /dev/null +++ b/src/plugins/plugininterface.h @@ -0,0 +1,65 @@ +// * This file is part of the COLOBOT source code +// * Copyright (C) 2012, Polish Portal of Colobot (PPC) +// * +// * 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 3 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, see http://www.gnu.org/licenses/. + +// plugininterface.h + +/** + * @file plugin/plugininterface.h + * @brief Generic plugin interface + */ + +#pragma once + +#include <string> + +#define PLUGIN_INTERFACE(class_type) \ + static class_type* Plugin##class_type; \ + extern "C" void InstallPluginEntry() { Plugin##class_type = new class_type(); Plugin##class_type->InstallPlugin(); } \ + extern "C" bool UninstallPluginEntry(std::string &reason) { bool result = Plugin##class_type->UninstallPlugin(reason); \ + if (!result) \ + return false; \ + delete Plugin##class_type; \ + return true; } \ + extern "C" CPluginInterface* GetPluginInterfaceEntry() { return static_cast<CPluginInterface*>(Plugin##class_type); } + + +/** +* @class CPluginInterface +* +* @brief Generic plugin interface. All plugins that will be managed by plugin manager have to derive from this class. +* +*/ +class CPluginInterface { + public: + /** Function to get plugin name or description + * @return returns plugin name + */ + virtual std::string PluginName() = 0; + + /** Function to get plugin version. 1 means version 0.01, 2 means 0.02 etc. + * @return number indicating plugin version + */ + virtual int PluginVersion() = 0; + + /** Function to initialize plugin + */ + virtual void InstallPlugin() = 0; + + /** Function called before removing plugin + */ + virtual bool UninstallPlugin(std::string &) = 0; +}; + |