jingleplugin.h

/*
  Copyright (c) 2008-2013 by Jakob Schroeter <js@camaya.net>
  This file is part of the gloox library. http://camaya.net/gloox

  This software is distributed under a license. The full license
  agreement can be found in the file LICENSE in this distribution.
  This software may not be copied, modified, sold or distributed
  other than expressed in the named license agreement.

  This software is distributed without any warranty.
*/


#ifndef JINGLEPLUGIN_H__
#define JINGLEPLUGIN_H__

#include "macros.h"
#include "util.h"

#include <string>
#include <list>

namespace gloox
{

  class Tag;

  namespace Jingle
  {

    class Plugin;
    class PluginFactory;

    enum JinglePluginType
    {
      PluginNone,                   
      PluginContent,                
      PluginFileTransfer,           
      PluginICEUDP,                 
      PluginReason,                 
      PluginUser                    
    };

    typedef std::list<const Plugin*> PluginList;

    class GLOOX_API Plugin
    {

      friend class PluginFactory;

      public:
        Plugin( JinglePluginType type ) : m_factory( 0 ), m_pluginType( type ) {}

        virtual ~Plugin() { util::clearList( m_plugins ) ; }

        void addPlugin( const Plugin* plugin ) { if( plugin ) m_plugins.push_back( plugin ); }

        const Plugin* findPlugin( int type ) const
        {
          PluginList::const_iterator it = m_plugins.begin();
          for( ; it != m_plugins.end() && (*it)->pluginType() != type; ++it ) ;
          return it != m_plugins.end() ? (*it) : 0;
        }

        template< class T >
        inline const T* findPlugin( int type ) const
        {
          return static_cast<const T*>( findPlugin( type ) );
        }

        const PluginList& plugins() const { return m_plugins; }

        virtual const StringList features() const { return StringList(); }

        virtual const std::string& filterString() const = 0;

        virtual Tag* tag() const = 0;

        virtual Plugin* newInstance( const Tag* tag ) const = 0;

        virtual Plugin* clone() const = 0;

        JinglePluginType pluginType() const { return m_pluginType; }

      protected:
        PluginList m_plugins;
        PluginFactory* m_factory;

      private:
        void setFactory( PluginFactory* factory ) { m_factory = factory; }

        JinglePluginType m_pluginType;

    };

  }

}

#endif // JINGLEPLUGIN_H__