interface.h

Go to the documentation of this file.

/* -*- Mode: c++ -*- */
/*
 *  this is part of Spm
 *
 *  Copyright (c) 2005 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 <string>
#include <map>
#include "pluginDef.h"

namespace Spm
{
  namespace Plugin
  {
    typedef enum {GPL = 0,
                  LGPL = 1,
                  BSD = 2,
                  NOT_FREE = 3} license_e;
    typedef enum {INITIALIZATION,
                  RUNNING,
                  ENDED,
                  FAILED} state_e;
    const int OPTION_NO_VALUE = 0;
    const int OPTION_VALUE_NOT_MANDATORY = 1;
    const int OPTION_VALUE_MANDATORY = 2;

    typedef struct 
    {
      std::string __pluginName;
      std::string __pluginDescription;
      std::string __pluginAuthor;
      std::string __pluginVersion;
      license_e __pluginLicense;
      pluginType_e __pluginType;
      std::map<std::string,
               std::pair<std::string,
                         int> > __interfaceOptions;
    } pluginDescription_t;

    class Interface
    {
      friend class Plugin;
    protected :
      pluginDescription_t __description;
      std::map<std::string,
               std::string> pluginOptions;
      state_e currentState;

      Interface ()
      {
      }

    public :

      Interface (const std::map<std::string, std::string> & pOptions)
      {
        for (std::map<std::string,std::string>::const_iterator itMap = pOptions.begin ();
             itMap != pOptions.end ();
             itMap++)
          pluginOptions[itMap->first] = itMap->second;
      }

      virtual ~Interface (){};
      
      virtual bool handle (const std::string & uri) = 0;

      inline const pluginDescription_t & getDescription ()
      {
        return __description;
      }

      state_e getState ()
      {
        return currentState;
      }

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

#endif

---