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