studio/src/extension_system/iplugin_spec.h

   1 // Object Viewer Qt - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
   2 // Copyright (C) 2010-2011  Dzmitry KAMIAHIN (dnk-88) <dnk-88@tut.by>
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2010  Winch Gate Property Limited
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 #ifndef IPLUGINSPEC_H
  21 #define IPLUGINSPEC_H
  22
  23 #include <QtCore/QString>
  24
  25 namespace ExtensionSystem
  26 {
  27 class IPlugin;
  28 class IPluginManager;
  29
  30 /**
  31 @struct State
  32 @details The plugin goes through several steps while being loaded.
  33 The state gives a hint on what went wrong in case of an error.
  34 */
  35 struct State
  36 {
  37         enum List
  38         {
  39                 Invalid = 1,
  40                 Read,
  41                 Resolved,
  42                 Loaded,
  43                 Initialized,
  44                 Running,
  45                 Stopped,
  46                 Deleted
  47         };
  48 };
  49
  50 /**
  51 @interface IPluginSpec
  52 @brief Interface for plugin spec contains the information of the plugins and
  53 information about the plugin's current state.
  54 @details The plugin spec is also filled with more information as the plugin
  55 goes through its loading process (see State).
  56 If an error occurs, the plugin spec is the place to look for the error details.
  57 */
  58 class IPluginSpec
  59 {
  60 public:
  61         virtual ~IPluginSpec() {}
  62
  63         virtual QString name() const = 0;
  64         virtual QString version() const = 0;
  65         virtual QString vendor() const = 0;
  66         virtual QString description() const = 0;
  67
  68         virtual QString location() const = 0;
  69         virtual QString filePath() const = 0;
  70         virtual QString fileName() const = 0;
  71
  72         virtual IPlugin *plugin() const = 0;
  73
  74         // state
  75         virtual int state() const = 0;
  76         virtual bool hasError() const = 0;
  77         virtual QString errorString() const = 0;
  78
  79         /// Enables/disables load this plugin after restart the program
  80         virtual void setEnabled(bool enabled) = 0;
  81         virtual bool isEnabled() const = 0;
  82 };
  83
  84 } // namespace ExtensionSystem
  85
  86 #endif // IPLUGINSPEC_H
  87