include/core/Plugin.h

   1 // Copyright 2008 Brian Caine
   2
   3 // This file is part of Potpourri.
   4
   5 // Potpourri is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9
  10 // Potpourri is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTIBILITY of FITNESS FOR A PARTICULAR PURPOSE. See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with Potpourri. If not, see <http://www.gnu.org/licenses/>.
  17
  18
  19 // NOTES:
  20
  21 // A plugin system
  22
  23 #ifndef __PLUGIN_H
  24 #define __PLUGIN_H
  25
  26 #include <string>
  27 #include <vector>
  28 #include <dlfcn.h>
  29
  30 #include "Variant.h"
  31
  32 namespace fragrant
  33 {
  34   const std::string PLUGIN_FUNC_NAME = "loadPluginPayload";
  35   const std::string PLUGIN_INFO_NAME = "queryPlugin";
  36
  37   enum PluginType
  38     {
  39       PT_Audio,
  40       PT_Graphics,
  41       PT_Input,
  42       PT_Media,
  43       PT_Script,
  44       PT_UI
  45     };
  46
  47   struct PluginData
  48     {
  49       std::string name;
  50       PluginType type;
  51       std::string version;
  52       std::vector<std::string> authors;
  53       std::vector<std::string> requirements;
  54     };
  55
  56   typedef PluginData (*plugin_query)();
  57   typedef Variant* (*plugin_payload)();
  58
  59   class Plugin
  60     {
  61       public:
  62         Plugin(std::string sofile);
  63         ~Plugin();
  64
  65         PluginData getData();
  66         std::string getDataString();
  67         fragrant::Variant* getPayload();
  68
  69       private:
  70         PluginData data;
  71
  72         void* lib;
  73         plugin_payload payload;
  74         fragrant::Variant* payload_v;
  75     };
  76 }
  77
  78 extern "C"
  79 {
  80   fragrant::PluginData queryPlugin();
  81   fragrant::Variant* loadPluginPayload();
  82 }
  83
  84 #endif