diff -r 000000000000 -r e4d67989cc36 genericservices/httputils/inc/EscapeUtils.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/genericservices/httputils/inc/EscapeUtils.h Tue Feb 02 02:01:42 2010 +0200 @@ -0,0 +1,100 @@ +// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies). +// All rights reserved. +// This component and the accompanying materials are made available +// under the terms of "Eclipse Public License v1.0" +// which accompanies this distribution, and is available +// at the URL "http://www.eclipse.org/legal/epl-v10.html". +// +// Initial Contributors: +// Nokia Corporation - initial contribution. +// +// Contributors: +// +// Description: +// This file contains the API definition for escape enoding functionality +// and UNICODE/UTF8 conversion. Escape encoding is performed as specified +// by RFC2396. +// +// + +/** + @file EscapeUtils.h + @publishedAll + @released +*/ + +#ifndef __ESCAPEUTILS_H__ +#define __ESCAPEUTILS_H__ + +// System includes +// +#include +#include + + +/** +Comments : Provides an API to allow data to be escape encoded and decoded. +Also provide an API for converting a UNICODE data (16-bit descriptor) into +UTF8 data (8-bit descriptor) and vice-verse. +@publishedAll +@released +@since 6.0 +*/ +class EscapeUtils + { +public: // Enums + +/** + enum TEscapeMode + Enum defining escaping modes. Each mode has a different set of reserved characters. + These are based on various uri components, as decribed in RFC2396. + */ + enum TEscapeMode + { + /** Default mode, which has no reserved characters */ + EEscapeNormal = 0, + /** Mode specifying reserved characters in a uri query - ;/?:@&=+$,[] */ + EEscapeQuery, + /** Mode specifying reserved characters in a uri path - /;=?[] */ + EEscapePath, + /** Mode specifying reserved characters in a uri authority - /;:@?[] */ + EEscapeAuth, + /** Mode specifying reserved characters in a URL ;/?:@&=+$[]!\'()~ */ + EEscapeUrlEncoded + }; + +public: // Methods + + IMPORT_C static HBufC8* EscapeEncodeL(const TDesC8& aData, TEscapeMode aMode); + + IMPORT_C static HBufC16* EscapeEncodeL(const TDesC16& aData, TEscapeMode aMode); + + IMPORT_C static HBufC8* EscapeEncodeL(const TDesC8& aData, const TDesC8& aReservedChars); + + IMPORT_C static HBufC16* EscapeEncodeL(const TDesC16& aData, const TDesC16& aReservedChars); + + IMPORT_C static HBufC8* EscapeDecodeL(const TDesC8& aData); + + IMPORT_C static HBufC16* EscapeDecodeL(const TDesC16& aData); + + IMPORT_C static HBufC8* ConvertFromUnicodeToUtf8L(const TDesC& aData); + + IMPORT_C static HBufC* ConvertToUnicodeFromUtf8L(const TDesC8& aData); + + IMPORT_C static TBool IsExcludedChar(TChar aChar); + + IMPORT_C static TBool IsEscapeTriple(const TDesC8& aData, TInt& aHexValue); + + IMPORT_C static TBool IsEscapeTriple(const TDesC16& aData, TInt& aHexValue); + + IMPORT_C static HBufC8* SpecificEscapeEncodeL ( const TDesC8& aData, const TDesC8& aCharsToEscape ); + + static HBufC8* ReEscapeEncodeL(const TDesC8& aData); + +private: // Dummy Method + + IMPORT_C static HBufC8* DummyForwardingFunctionForCompatibility( const TDesC8& aData, const TDesC8& aCharsToEscape ); + + }; + +#endif // __ESCAPEUTILS_H__