pluginSystem.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_SYSTEM_H__
#define __PLUGIN_SYSTEM_H__

#include "plugin.h"
#include "pluginDef.h"
#include "pluginException.h"
#include <map>
#include <list>
#include <string>
#include <ctime>
#include <boost/shared_ptr.hpp>

namespace Spm
{
  namespace Core
  {
    class PackageSystem;
  }

  namespace Plugin
  {
    class PluginSystem 
    {
    private :
      friend class InstallerInterface;
      friend class Core::PackageSystem;
      std::string __user;
      std::list<boost::filesystem::path> __pluginDirs;
      std::list<Plugin *> __plugins;
      boost::signal<void (Plugin *)> __newPlugin;
      boost::signal<void (boost::filesystem::path)> __newPluginDirectory;
      PluginSystem (const std::string & userName);
      void readRegistryFile ();
      void writeRegistryFile ();
      void checkPluginDirs ();
      static std::map<std::string,
                      boost::shared_ptr<PluginSystem> > __instances;
      boost::shared_ptr<PluginSystem> __systemPluginSystem;
      miniXml::Document * xmlRegistry;
      void addPluginDir (const boost::filesystem::path & dir);

      void addPlugin (const boost::filesystem::path & file);

      InstallerPlugin * getInstaller (const std::string & url)
        throw (NoPluginHandlerException);

    public :
      typedef std::list<Plugin *>::iterator iterator;
      typedef std::list<Plugin *>::const_iterator const_iterator;
      typedef std::list<Plugin *>::reverse_iterator reverse_iterator;
      typedef std::list<Plugin *>::const_reverse_iterator const_reverse_iterator;
      
      ~PluginSystem ();
      static boost::shared_ptr<PluginSystem> create (const std::string & user);
      
      void add (const boost::filesystem::path & path);

      const std::list<Plugin *> & getPlugins ();

      const Plugin * getPlugin (const std::string & pluginName)
        throw (NoPluginException);

      Plugin * getRefPlugin (const std::string & pluginName)
        throw (NoPluginException);      

      StepPlugin * getStep (const std::string & pluginName,
                            const std::map<std::string,std::string> & pOptions)
        throw (NoPluginException);

      DownloadPlugin * getDownloader (const std::string & uri)
        throw (NoPluginHandlerException);

      InstallerPlugin * getInstaller (Util::Compressed * compressed)    
        throw (NoPluginHandlerException);

      boost::signal<void (Plugin *)> & signalNewPlugin ();
      boost::signal<void (boost::filesystem::path)> & signalNewPluginDirectory ();

      inline iterator begin ()
      {
        return __plugins.begin ();
      }

      inline const_iterator begin () const
      {
        return __plugins.begin ();
      }

      inline reverse_iterator rbegin ()
      {
        return __plugins.rbegin ();
      }

      inline const_reverse_iterator rbegin () const
      {
        return __plugins.rbegin ();
      }

      inline iterator end ()
      {
        return __plugins.end ();
      }

      inline const_iterator end () const
      {
        return __plugins.end ();
      }

      inline reverse_iterator rend ()
      {
        return __plugins.rend ();
      }

      inline const_reverse_iterator rend () const
      {
        return __plugins.rend ();
      }
    };

    struct equalPluginByName : public std::binary_function<Plugin *, std::string, bool>
    {
      bool operator() (Plugin * p,
                       const std::string & pluginName) const;
    };
  }
}
#endif

---