stanzaextension.h

/*
  Copyright (c) 2006-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 STANZAEXTENSION_H__
#define STANZAEXTENSION_H__

#include "macros.h"

#include <string>

namespace gloox
{

  class Tag;
  class Stanza;

  enum StanzaExtensionType
  {
    ExtNone,                        
    ExtVCardUpdate,                 
    ExtOOB,                         
    ExtGPGSigned,                   
    ExtGPGEncrypted,                
    ExtReceipt,                     
    ExtDelay,                       
    ExtAMP,                         
    ExtError,                       
    ExtCaps,                        
    ExtChatState,                   
    ExtMessageEvent,                
    ExtDataForm,                    
    ExtNickname,                    
    ExtResourceBind,                
    ExtSessionCreation,             
    ExtVersion,                     
    ExtXHtmlIM,                     
    ExtDiscoInfo,                   
    ExtDiscoItems,                  
    ExtAdhocCommand,                
    ExtPrivateXML,                  
    ExtRoster,                      
    ExtFeatureNeg,                  
    ExtIBB,                         
    ExtNonSaslAuth,                 
    ExtMUC,                         
    ExtMUCOwner,                    
    ExtMUCAdmin,                    
    ExtMUCUser,                     
    ExtMUCUnique,                   
    ExtPing,                        
    ExtSearch,                      
    ExtRegistration,                
    ExtJingle,                      
    ExtVCard,                       
    ExtPrivacy,                     
    ExtLastActivity,                
    ExtFlexOffline,                 
    ExtSI,                          
    ExtS5BQuery,                    
    ExtPubSub,                      
    ExtPubSubOwner,                 
    ExtPubSubEvent,                 
    ExtSHIM,                        
    ExtAttention,                   
    ExtForward,                     
    ExtCarbons,                     
    ExtUser                         
  };

  class GLOOX_API StanzaExtension
  {
    public:
      StanzaExtension( int type ) : m_valid( false ), m_extensionType( type ) {}

      virtual ~StanzaExtension() {}

      virtual Stanza* embeddedStanza() const { return 0; }

      virtual Tag* embeddedTag() const { return 0; }

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

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

      virtual Tag* tag() const = 0;

      virtual StanzaExtension* clone() const = 0;

      int extensionType() const { return m_extensionType; }

    protected:
      bool m_valid;

    private:
      int m_extensionType;

  };

}

#endif // STANZAEXTENSION_H__