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: // This file contains the API definition for escape enoding functionality
sl@0: // and UNICODE/UTF8 conversion. Escape encoding is performed as specified
sl@0: // by RFC2396.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file EscapeUtils.h
sl@0:  @publishedAll
sl@0:  @released
sl@0: */
sl@0: 
sl@0: #ifndef __ESCAPEUTILS_H__
sl@0: #define __ESCAPEUTILS_H__
sl@0: 
sl@0: // System includes
sl@0: //
sl@0: #include <e32base.h>
sl@0: #include <uriutilscommon.h>
sl@0: 
sl@0: 
sl@0: /**
sl@0: Comments : Provides an API to allow data to be escape encoded and decoded. 
sl@0: Also provide an API for converting a UNICODE data (16-bit descriptor) into 
sl@0: UTF8 data (8-bit descriptor) and vice-verse.
sl@0: @publishedAll
sl@0: @released
sl@0: @since 6.0
sl@0: */
sl@0: class EscapeUtils
sl@0: 	{
sl@0: public:	// Enums
sl@0: 
sl@0: /**
sl@0: 	enum	TEscapeMode
sl@0: 	Enum defining escaping modes. Each mode has a different set of reserved characters.
sl@0: 	These are based on various uri components, as decribed in RFC2396.
sl@0:  */
sl@0: 	enum TEscapeMode
sl@0: 		{
sl@0: 		/** Default mode, which has no reserved characters 	*/
sl@0: 		EEscapeNormal	= 0,
sl@0: 		/** Mode specifying reserved characters in a uri query - ;/?:@&=+$,[] 	*/ 
sl@0: 		EEscapeQuery,
sl@0: 		/** Mode specifying reserved characters in a uri path - /;=?[]  */
sl@0: 		EEscapePath,
sl@0: 		/** Mode specifying reserved characters in a uri authority - /;:@?[]  */
sl@0: 		EEscapeAuth,
sl@0: 		/** Mode specifying reserved characters in a URL ;/?:@&=+$[]!\'()~  */
sl@0: 		EEscapeUrlEncoded
sl@0: 		};
sl@0: 
sl@0: public:	// Methods
sl@0: 
sl@0: 	IMPORT_C static HBufC8* EscapeEncodeL(const TDesC8& aData, TEscapeMode aMode);
sl@0: 
sl@0: 	IMPORT_C static HBufC16* EscapeEncodeL(const TDesC16& aData, TEscapeMode aMode);
sl@0: 
sl@0: 	IMPORT_C static HBufC8* EscapeEncodeL(const TDesC8& aData, const TDesC8& aReservedChars);
sl@0: 
sl@0: 	IMPORT_C static HBufC16* EscapeEncodeL(const TDesC16& aData, const TDesC16& aReservedChars);
sl@0: 
sl@0: 	IMPORT_C static HBufC8* EscapeDecodeL(const TDesC8& aData);
sl@0: 
sl@0: 	IMPORT_C static HBufC16* EscapeDecodeL(const TDesC16& aData);
sl@0: 
sl@0: 	IMPORT_C static HBufC8* ConvertFromUnicodeToUtf8L(const TDesC& aData);
sl@0: 
sl@0: 	IMPORT_C static HBufC* ConvertToUnicodeFromUtf8L(const TDesC8& aData);
sl@0: 
sl@0: 	IMPORT_C static TBool IsExcludedChar(TChar aChar);
sl@0: 
sl@0: 	IMPORT_C static TBool IsEscapeTriple(const TDesC8& aData, TInt& aHexValue);
sl@0: 
sl@0: 	IMPORT_C static TBool IsEscapeTriple(const TDesC16& aData, TInt& aHexValue);
sl@0: 
sl@0: 	IMPORT_C static HBufC8* SpecificEscapeEncodeL ( const TDesC8& aData, const TDesC8& aCharsToEscape );
sl@0: 
sl@0: 	static HBufC8*  ReEscapeEncodeL(const TDesC8& aData);
sl@0: 
sl@0: private: // Dummy Method
sl@0: 
sl@0: 	IMPORT_C static HBufC8* DummyForwardingFunctionForCompatibility( const TDesC8& aData, const TDesC8& aCharsToEscape );
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #endif	// __ESCAPEUTILS_H__