plugin.h

Go to the documentation of this file.

/* -*- Mode: c++ -*- */
/*
 *  this is part of Spm
 *
 *  Copyright (c) 2005-2007 Guillaume Chevallereau
 *
 *  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 usefull 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., 
 *  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
 */
#ifndef __PLUGIN_H__
#define __PLUGIN_H__

#include "pluginDef.h"
#include "stepInterface.h"
#include "downloadInterface.h"
#include "installerInterface.h"
#include "pluginException.h"
#include <miniXml.h>

#define DownloadPlugin DownloadInterface 
#define StepPlugin StepInterface 
#define InstallerPlugin InstallerInterface

#include <string>
#include <util/object.h>
namespace Spm
{
  namespace Plugin
  {
    typedef void * plugin_td;
    typedef void * object_td;
    typedef Interface* (*GetModule)(std::map<std::string,std::string> options);
    typedef DownloadInterface* (*GetDownloadModule)(const Util::urlDetails & url);
    typedef Interface* (*GetTryModule)();
    typedef pluginDescription_t (*GetModuleDescription)();
    typedef InstallerInterface* (*GetInstallerModule)(Util::Compressed * compressed);
    class Plugin : public Util::Object
    {
      friend class PluginSystem;
      friend Plugin * convertXmlToPlugin (const miniXml::Element * pluginElement);
    private:
      std::string __version;
      std::string __description;
      boost::filesystem::path __path;
      std::string __author;
      license_e __license;
      bool __loaded;
      bool __enabled;
      pluginType_e __type;
      plugin_td __plugin;
      void open ()
        throw (PluginException);
      void close ();
      object_td getObject (const std::string & objectName)
        throw (PluginException);
      std::map<std::string,
               std::string> __pluginOptions;
      void setPluginOptions (const std::map<std::string, std::string> & options);

    public:
      Plugin ();
      Plugin (const boost::filesystem::path & aFile);
      
      static Plugin * isAPlugin (const boost::filesystem::path & aFile)
        throw (NotAPluginException);

      ~Plugin ();
      
      const std::string & getDescription ();
      
      const boost::filesystem::path & getPath ();

      pluginType_e getType ();

      const std::string & getDescription () const;
      
      const boost::filesystem::path & getPath () const;

      pluginType_e getType () const;

      const std::string & getVersion ();
      
      const std::string & getVersion () const;

      const std::string & getAuthor ();
      
      const std::string & getAuthor () const;

      const license_e & getLicense ();
      
      const license_e & getLicense () const;

      Interface * getObject (const std::map<std::string,std::string> & pOptions) 
        throw (NotActivePluginException,
               PluginException);

      Interface * getObject () 
        throw (NotActivePluginException,
               PluginException);

      DownloadInterface * getDownloaderObject (const Util::urlDetails & url) 
        throw (NotActivePluginException,
               PluginException);

      InstallerInterface * getObject (Util::Compressed * compressed)
        throw (NotActivePluginException,
               PluginException);
      
      bool isEnable ();
      bool isEnable () const;

      const std::map<std::string,
                     std::string> & getPluginOptions ();

      const std::map<std::string,
                     std::string> & getPluginOptions () const;

      void enable ();

      void disable ();

      bool operator< (const Plugin & p) const;
    };
  }
}
#endif

---