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 "stepInterface.h"
#include "downloadInterface.h"
#include "installerInterface.h"
#include "infoInterface.h"
#include "pluginException.h"

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

#include <util/object.h>
namespace miniXml
{
  class Element;
}
namespace Spm
{
  namespace Plugin
  {
    class Plugin : public Util::Object
    {
      friend class PluginManager;
      friend Plugin * convertXmlToPlugin (const miniXml::Element * pluginElement);
      friend struct equalDownloaderHandler;
      friend struct equalInstallerHandlerByUrl;
      friend struct equalInstallerHandlerByCompressed;
    private:
      typedef void * plugin_td;
      typedef void * object_td;
      miniXml::ustring version_;
      miniXml::ustring description_;
      boost::filesystem::path path_;
      miniXml::ustring author_;
      license_e license_;
      bool loaded_;
      bool enabled_;
      pluginType_e type_;
      plugin_td plugin_;
      std::map<miniXml::ustring,
               miniXml::ustring> pluginOptions_;
      void open ()
        throw (PluginException);
      void close ();
      object_td getObject (const miniXml::ustring & objectName)
        throw (PluginException);

      void setPluginOptions (const std::map<miniXml::ustring, miniXml::ustring> & options);
      Plugin ();
      Plugin (const boost::filesystem::path & aFile);
      ~Plugin ();
      
      Interface * getObject (const Util::PropertyList & pOptions) 
        throw (NotActivePluginException,
               PluginException);
      Interface * getObject () 
        throw (NotActivePluginException,
               PluginException);
      DownloadInterface * getDownloaderObject (const Util::urlDetails & url) 
        throw (NotActivePluginException,
               PluginException);
      InstallerInterface * getObject (Util::Compressed * compressed,
                                      const Util::PropertyList & pOptions);
      InfoInterface * getInfoObject (const miniXml::ustring & url);
      int handle (Util::Compressed * compressed,
                  const Util::PropertyList & pOptions);
      int handle (const miniXml::ustring & url,
                  const Util::PropertyList & pOptions);

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

      pluginType_e getType ();

      const miniXml::ustring & getDescription () const;
      
      const boost::filesystem::path & getPath () const;

      pluginType_e getType () const;

      const miniXml::ustring & getVersion ();
      
      const miniXml::ustring & getVersion () const;

      const miniXml::ustring & getAuthor ();
      
      const miniXml::ustring & getAuthor () const;

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

      
      bool enabled ();
      bool enabled () const;

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

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

      void enable ();

      void disable ();

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

---