interface.h

Go to the documentation of this file.

/* -*- Mode: c++ -*- */
/*
 *  this is part of Spm
 *
 *  Copyright (c) 2005-2008 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 __INTERFACE_H__
#define __INTERFACE_H__

#include <map>
#include <util/propertyList.h>
#include <boost/tuple/tuple.hpp>

namespace Spm
{
  namespace Plugin
  {
    typedef enum 
      {
        GPL = 0,
        LGPL = 1,
        BSD = 2,
        NOT_FREE = 3
      } license_e;
    typedef enum 
      {
        INTERFACE_TYPE,
        DOWNLOAD_TYPE,
        STEP_TYPE,
        INSTALLER_TYPE,
        INFO_TYPE,
      } pluginType_e;

    const int OPTION_NO_VALUE = 0;
    const int OPTION_VALUE_NOT_MANDATORY = 1;
    const int OPTION_VALUE_MANDATORY = 2;

    typedef struct 
    {
      miniXml::ustring pluginName_; 
      miniXml::ustring pluginDescription_; 
      miniXml::ustring pluginAuthor_; 
      miniXml::ustring pluginVersion_; 
      license_e pluginLicense_; 
      pluginType_e pluginType_; 
      std::map<miniXml::ustring,
               boost::tuple<miniXml::ustring, 
                            int, 
                            Util::PropertyList::propertyType_e> > options_; 
    } pluginDescription_t;

    class Interface
    {
    public :
      friend class Plugin;
      typedef enum {INITIALIZATION,
                    RUNNING,
                    ENDED,
                    FAILED} state_e;
    protected :
      pluginDescription_t description_;
      //mutable boost::recursive_mutex mutex_;
      Util::PropertyList options_;
      state_e currentState_;

      Interface ()
      {
      }

      Interface (const Util::PropertyList & pList) : options_(pList),
                                                     currentState_(INITIALIZATION)
      {
      }

      virtual void initInfo () = 0;

    public :
      virtual ~Interface (){};
      
      inline const pluginDescription_t & getDescription ()
      {
        return description_;
      }

      state_e getState ()
      {
        return currentState_;
      }

      state_e getState () const
      {
        return currentState_;
      }
    };
  }
}

#endif

---