From d56db5f4e4a8e0d572bf3d682619bb25aebe4120 Mon Sep 17 00:00:00 2001
From: erihel <erihel@gmail.com>
Date: Thu, 19 Jul 2012 19:19:21 +0200
Subject: * Chaned plugin interface * Added plugin class for plugin loading *
 Added plugin loading test

---
 src/plugins/plugininterface.h | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 src/plugins/plugininterface.h

(limited to 'src/plugins/plugininterface.h')

diff --git a/src/plugins/plugininterface.h b/src/plugins/plugininterface.h
new file mode 100644
index 0000000..bf4e040
--- /dev/null
+++ b/src/plugins/plugininterface.h
@@ -0,0 +1,37 @@
+// * 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
+
+
+#pragma once
+
+
+#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" void UninstallPluginEntry() { Plugin##class_type->UninstallPlugin(); delete Plugin##class_type; } \
+    extern "C" CPluginInterface* GetPluginInterfaceEntry() { return static_cast<CPluginInterface*>(Plugin##class_type); }
+
+
+class CPluginInterface {
+    public:
+        virtual char* PluginName() = 0;
+        virtual int PluginVersion() = 0;
+        virtual void InstallPlugin() = 0;
+        virtual void UninstallPlugin() = 0;
+};
+
-- 
cgit v1.2.3-1-g7c22


From 62b545128f37746c343760e464872655b5523c6f Mon Sep 17 00:00:00 2001
From: erihel <erihel@gmail.com>
Date: Sun, 12 Aug 2012 18:37:11 +0200
Subject: * Final changes to plugin interface * Added doxygen comments to
 plugin manager and plugin loader

---
 src/plugins/plugininterface.h | 34 +++++++++++++++++++++++++++++++---
 1 file changed, 31 insertions(+), 3 deletions(-)

(limited to 'src/plugins/plugininterface.h')

diff --git a/src/plugins/plugininterface.h b/src/plugins/plugininterface.h
index bf4e040..b8adddc 100644
--- a/src/plugins/plugininterface.h
+++ b/src/plugins/plugininterface.h
@@ -16,22 +16,50 @@
 
 // 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" void UninstallPluginEntry() { Plugin##class_type->UninstallPlugin(); delete Plugin##class_type; } \
+    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:
-        virtual char* PluginName() = 0;
+        /** 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;
-        virtual void UninstallPlugin() = 0;
+
+        /** Function called before removing plugin
+         */
+        virtual bool UninstallPlugin(std::string &) = 0;
 };
 
-- 
cgit v1.2.3-1-g7c22