williamr@2: /*
williamr@2: * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2: * All rights reserved.
williamr@2: * This component and the accompanying materials are made available
williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2: * which accompanies this distribution, and is available
williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2: *
williamr@2: * Initial Contributors:
williamr@2: * Nokia Corporation - initial contribution.
williamr@2: *
williamr@2: * Contributors:
williamr@2: *
williamr@2: * Description:
williamr@2: * Name        : sipparameterheaderbase.h
williamr@2: * Part of     : SIP Codec
williamr@2: * Interface   : SDK API, SIP Codec API
williamr@2: * Version     : SIP/4.0
williamr@2: *
williamr@2: */
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: #ifndef CSIPPARAMETERHEADERBASE_H
williamr@2: #define CSIPPARAMETERHEADERBASE_H
williamr@2: 
williamr@2: //  INCLUDES
williamr@2: #include "sipheaderbase.h"
williamr@2: #include "_sipcodecdefs.h"
williamr@2: 
williamr@2: // FORWARD DECLARATIONS
williamr@2: class CSIPParamContainerBase;
williamr@2: 
williamr@2: // CLASS DECLARATION
williamr@2: /**
williamr@2: * @publishedAll
williamr@2: * @released
williamr@2: *
williamr@2: * A base class for SIP headers that have structure
williamr@2: *        "mandatory part"delimiter"parameters"
williamr@2: *
williamr@2: * This is an abstract class and cannot be instantiated.
williamr@2: *
williamr@2: *  @lib sipcodec.lib
williamr@2: */
williamr@2: class CSIPParameterHeaderBase : public CSIPHeaderBase
williamr@2:     {
williamr@2:     public:    // Constructors and destructor
williamr@2: 
williamr@2:         /**
williamr@2:         * Destructor, deletes the resources of CSIPParameterHeaderBase.
williamr@2:         */
williamr@2:         IMPORT_C virtual ~CSIPParameterHeaderBase();
williamr@2: 
williamr@2: 
williamr@2:     public: // New functions
williamr@2: 
williamr@2:         /**
williamr@2:         * Checks if a parameter is present
williamr@2:         * @param aName the name of the parameter
williamr@2:         * @return ETrue if present, otherwise EFalse
williamr@2:         */
williamr@2:         IMPORT_C TBool HasParam(RStringF aName) const;
williamr@2: 
williamr@2:         /**
williamr@2:         * Gets a parameter value
williamr@2:         * @pre HasParam(aName) == ETrue
williamr@2:         * @param aName the name of the parameter
williamr@2:         * @return the parameter value if present,
williamr@2:         *         otherwise a zero-length length value.
williamr@2:         */
williamr@2:         IMPORT_C RStringF ParamValue(RStringF aName) const;
williamr@2: 
williamr@2:         /**
williamr@2:         * Sets a parameter with a value. 
williamr@2:         * Takes copies of the name and value,
williamr@2:         * so if the RStringFs have been dynamically allocated,
williamr@2:         * they can be closed if necessary after the function returns.
williamr@2:         * @pre HasParam(aName) == EFalse
williamr@2:         * @param aName the name of the parameter
williamr@2:         * @param aValue the parameter value to set
williamr@2:         */
williamr@2:         IMPORT_C void SetParamL(RStringF aName, RStringF aValue);
williamr@2: 
williamr@2:         /**
williamr@2:         * Sets a parameter without a value
williamr@2:         * Takes copy of the name,
williamr@2:         * so if the RStringF has been dynamically allocated,
williamr@2:         * it can be closed if necessary after the function returns.
williamr@2:         * @pre HasParam(aName) == EFalse
williamr@2:         * @param aName the parameter name to set
williamr@2:         */
williamr@2:         IMPORT_C void SetParamL(RStringF aName);
williamr@2: 
williamr@2:         /**
williamr@2:         * Deletes a parameter
williamr@2:         * @param aName the parameter name to delete
williamr@2:         */
williamr@2:         IMPORT_C void DeleteParam(RStringF aName);
williamr@2: 
williamr@2:         /**
williamr@2:         * Gets the count of header parameters
williamr@2:         * @return count of header parameters
williamr@2:         */
williamr@2:         IMPORT_C TInt ParamCount() const;
williamr@2: 
williamr@2:         /**
williamr@2:         * Gets a header parameter name by index.
williamr@2:         * This function can be used when looping through
williamr@2:         * all the header parameters.
williamr@2:         * @param aIndex the index of the parameter
williamr@2:         * @param aName copy of the parameter name that must be 
williamr@2:         *        closed by the caller.       
williamr@2:         * @return KErrNotFound if aIndex is invalid. Otherwise EFalse.
williamr@2:         */
williamr@2:         IMPORT_C TInt Param(TInt aIndex, RStringF& aName) const;
williamr@2: 
williamr@2:     public: // From CSIPHeaderBase
williamr@2: 
williamr@2:         /**
williamr@2:         * From CSIPHeaderBase ToTextValueL
williamr@2:         */
williamr@2:         IMPORT_C HBufC8* ToTextValueL() const;
williamr@2: 
williamr@2: 
williamr@2:     protected: // Contructors
williamr@2: 
williamr@2:         CSIPParameterHeaderBase(const TChar& aSeparator);        
williamr@2: 
williamr@2:     protected: // New functions
williamr@2: 
williamr@2:         void ParseL(const TDesC8& aValue, 
williamr@2:         				  TBool aIgnoreParenthesis=ETrue, 
williamr@2:         				  TBool aSkipSeparatorsBeforeAt=EFalse);
williamr@2: 
williamr@2:     protected: // Virtual functions
williamr@2: 
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */    
williamr@2:         virtual TBool ParamInsertionAllowed() const;
williamr@2: 
williamr@2:     protected: // Pure virtual functions
williamr@2: 
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */
williamr@2:         virtual HBufC8* ToTextMandatoryPartLC() const = 0;
williamr@2:         
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */        
williamr@2:         virtual void ParseMandatoryPartL(const TDesC8& aMandatoryPart) = 0;
williamr@2:         
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */        
williamr@2:         virtual const CSIPParamContainerBase& Params() const = 0;
williamr@2:         
williamr@2:         /**
williamr@2:         * @internalComponent
williamr@2:         */        
williamr@2:         virtual CSIPParamContainerBase& Params() = 0;
williamr@2: 
williamr@2:     private: // Contructors
williamr@2: 
williamr@2:         CSIPParameterHeaderBase();
williamr@2: 
williamr@2:     private: // Data
williamr@2:     
williamr@2:         TChar iSeparator;
williamr@2: 
williamr@2:     private: // For testing purposes
williamr@2:     
williamr@2:         UNIT_TEST(CSIPParameterHeaderBaseTest)
williamr@2:     };
williamr@2: 
williamr@2: #endif // CSIPPARAMETERHEADERBASE_H
williamr@2: 
williamr@2: // End of File