sl@0: // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file WSPEncoder.h
sl@0:  @publishedAll
sl@0:  @deprecated
sl@0: */
sl@0: 
sl@0: #ifndef __WSPENCODER_H__
sl@0: #define __WSPENCODER_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <f32file.h>		// RFs
sl@0: #include <badesca.h>		// arrays etc.
sl@0: #include <stringpool.h>
sl@0: 
sl@0: /**
sl@0: enum CodecPanic
sl@0: @publishedAll
sl@0: @deprecated
sl@0: */
sl@0: enum TWspCodecPanic
sl@0: 	{
sl@0: 	/**  Due to failure to call StartValueLength function */
sl@0: 	EWspCodecPanicStartValueLengthNotCalled=0,
sl@0: 	/** Due to failure to call EndValueLength matching a call to StartValueLength */
sl@0: 	EWspCodecPanicEndValueLengthNotCalled,
sl@0: 	/** Due to failure to call StartHeaderL function */
sl@0: 	EWspCodecPanicStartHeaderLNotCalled,
sl@0: 	/** Due to StartHeaderL function being called twice without EndHeaderL */
sl@0: 	EWspCodecPanicStartHeaderCalledTwice,
sl@0: 	/** Due to parameter Token not having the top bit set */
sl@0: 	EWspCodecPanicInvalidToken
sl@0: 	};
sl@0:  
sl@0: /** 
sl@0: This class can be used to encode one header field at a time,
sl@0: with all its values and parameters.
sl@0: 
sl@0: It has no knowledge of encoding the BNF of a particular header field, but
sl@0: the functions provided can be used in combination, producing an 8-bit buffer 
sl@0: containing the encoded header.
sl@0: 
sl@0: Intended usage would be to call a series of functions. The first one being StartHeader,
sl@0: The final one being EndHeader, which would return a buffer containing 
sl@0: the complete encoded header field.
sl@0: eg:
sl@0: 	encoder->StartHeaderL();
sl@0: 	encoder->AddLongIntL();
sl@0: 	encoder->AddTextStringL();
sl@0: 	HBufC8* output = encoder->EndHeaderL();
sl@0: @publishedAll
sl@0: @deprecated
sl@0: */
sl@0: class CWspHeaderEncoder : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static CWspHeaderEncoder* NewL();
sl@0: 
sl@0: 	IMPORT_C static CWspHeaderEncoder* NewLC();
sl@0: 
sl@0: 
sl@0:     IMPORT_C virtual ~CWspHeaderEncoder(); 
sl@0: 
sl@0: 	IMPORT_C void StartHeaderL(TUint8 aToken);	
sl@0: 
sl@0: 
sl@0: 	IMPORT_C void StartHeaderL(const TDesC8& aString);	
sl@0: 
sl@0: 	IMPORT_C void StartHeaderL(const RStringF aString);	
sl@0: 
sl@0: 
sl@0: 	IMPORT_C HBufC8* EndHeaderL();
sl@0: 
sl@0: 
sl@0: 
sl@0: 	IMPORT_C void AddIntegerL(const TUint aInt);
sl@0: 
sl@0: 	
sl@0: 	IMPORT_C void AddShortIntL(const TUint8 aValue);
sl@0: 
sl@0: 	IMPORT_C void AddShortLengthL(const TUint8 aValue);
sl@0: 
sl@0: 
sl@0: 	IMPORT_C void AddLongIntL(const TUint32 aValue);
sl@0: 	
sl@0: 	
sl@0: 	IMPORT_C void AddUintVarL(const TUint aInt);
sl@0: 
sl@0: 	
sl@0: 	IMPORT_C void AddTextStringL(const RString& aText);
sl@0: 
sl@0: 	IMPORT_C void AddTextStringL(const TDesC8& aText);
sl@0: 
sl@0: 	IMPORT_C void AddDateL(const TDateTime aDate);
sl@0: 
sl@0: 	IMPORT_C void AddTokenL(const TUint8 aToken);
sl@0: 
sl@0: 	IMPORT_C void AddTokenTextL(const TDesC8& aTokenText);
sl@0: 
sl@0: 	IMPORT_C void AddDataL(const TDesC8& aData);
sl@0: 
sl@0: 
sl@0: 
sl@0: 	IMPORT_C void StartValueLengthL();
sl@0: 
sl@0: 	IMPORT_C void EndValueLengthL();
sl@0: 
sl@0: private:
sl@0: 
sl@0: 	CWspHeaderEncoder();
sl@0: 
sl@0: 	void Init();
sl@0: 
sl@0: 
sl@0: 	void ConstructL();
sl@0: 
sl@0: private:
sl@0: 	/**
sl@0: 	Array for storing the partial encoded header.
sl@0: 	Each time StartValueLength is called a new array
sl@0: 	element is used. When EndValueLength is called,
sl@0: 	the array is decremented, data from the last 
sl@0: 	element being added to the one before.
sl@0: 	*/
sl@0: 	RPointerArray<CDesC8Array> iArray;
sl@0: 
sl@0: 	/**
sl@0: 	Value incremented as the encoded header increases in size.
sl@0: 	Used to allocate the buffer for storing the final	
sl@0: 	encoded header, output when EndHeader is called.
sl@0: 	*/
sl@0: 	TInt iTotalLength;
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: Class encapsulating primitive encoding methods which are defined in the WSP standard.
sl@0: Input will be encoded and returned in an 8 bit buffer.
sl@0: @publishedAll
sl@0: @deprecated
sl@0: */
sl@0: class TWspPrimitiveEncoder
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C static TUint8  ShortInt(const TUint8 aValue);
sl@0: 
sl@0: 	IMPORT_C static HBufC8* LongIntL(const TUint32 aValue);
sl@0: 
sl@0: 	IMPORT_C static HBufC8* UintVarL(const TUint32 aInt);
sl@0: 
sl@0: 	IMPORT_C static HBufC8* TextStringL(const RString aText);
sl@0: 
sl@0: 	IMPORT_C static HBufC8* TextStringL(const TDesC8& aText);
sl@0: 
sl@0: 	IMPORT_C static HBufC8* DateL(const TDateTime aDate);
sl@0: 	};
sl@0: 
sl@0: #endif	// __WSPENCODER_H__