sl@0: /*
sl@0: * Copyright (c) 1997-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: 
sl@0: #if !defined(__UTF_H__)
sl@0: #define __UTF_H__
sl@0: 
sl@0: #if !defined(__E32STD_H__)
sl@0: #include <e32std.h>
sl@0: #endif
sl@0: 
sl@0: 
sl@0: class CnvUtfConverter
sl@0: /** 
sl@0: Converts text between Unicode (UCS-2) and the two Unicode transformation 
sl@0: formats UTF-7 and UTF-8. There are no functions to convert directly between 
sl@0: UTF-7 and UTF-8.
sl@0: 
sl@0: Objects of this class do not need to be created because all the member functions 
sl@0: are static. The four functions are passed text in the second argument and 
sl@0: output the resulting text in the first argument. Sixteen-bit descriptors are 
sl@0: used to hold text encoded in UCS-2 (i.e. normal 16 bit Unicode), and eight-bit 
sl@0: descriptors are used to hold text encoded in either of the transformation 
sl@0: formats.
sl@0: 
sl@0: The conversion functions return the number of characters which were not converted 
sl@0: because the output descriptor was not long enough to hold all of the converted 
sl@0: text. This allows users of this class to perform partial conversions on an 
sl@0: input descriptor, handling the case when the input descriptor is truncated 
sl@0: mid way through a multi-byte character. The caller does not have to guess 
sl@0: how big to make the output descriptor for a given input descriptor- they 
sl@0: can simply do the conversion in a loop using a small output descriptor. The 
sl@0: ability to handle truncated descriptors is particularly useful if the caller 
sl@0: is receiving information in chunks from an external source. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	/** Conversion error flags. At this stage there is only one error flag 
sl@0: 	- others may be added in the future. */
sl@0: 	enum TError
sl@0: 		{
sl@0:  		/** The input descriptor contains a single corrupt character. This 
sl@0:  		might occur when the input descriptor only contains some of the bytes 
sl@0:  		of a single multi-byte character. */
sl@0: 		EErrorIllFormedInput=KErrCorrupt
sl@0: 		};
sl@0: 	 
sl@0: 	 /** Initial value for the state argument in a set of related calls to
sl@0: 	ConvertToUnicode(). */
sl@0: 	enum {KStateDefault=0}; 
sl@0: public:
sl@0: 	// the conversion functions return either one of the TError values above, or the number of unconverted elements left at the end of the input descriptor
sl@0: 	IMPORT_C static TInt ConvertFromUnicodeToUtf7(TDes8& aUtf7, const TDesC16& aUnicode, TBool aEncodeOptionalDirectCharactersInBase64);
sl@0: 	static TInt ConvertFromUnicodeToUtf7(TDes8& aUtf7, const TDesC16& aUnicode, TBool aIsImapUtf7, TBool aEncodeOptionalDirectCharactersInBase64);
sl@0: 	IMPORT_C static TInt ConvertFromUnicodeToUtf8(TDes8& aUtf8, const TDesC16& aUnicode);
sl@0: 	static TInt ConvertFromUnicodeToUtf8(TDes8& aUtf8, const TDesC16& aUnicode, TBool aGenerateJavaConformantUtf8);
sl@0: 	IMPORT_C static TInt ConvertToUnicodeFromUtf7(TDes16& aUnicode, const TDesC8& aUtf7, TInt& aState);
sl@0: 	static TInt ConvertToUnicodeFromUtf7(TDes16& aUnicode, const TDesC8& aUtf7, TBool aIsImapUtf7, TInt& aState);
sl@0: 	IMPORT_C static TInt ConvertToUnicodeFromUtf8(TDes16& aUnicode, const TDesC8& aUtf8);
sl@0: 	static TInt ConvertToUnicodeFromUtf8(TDes16& aUnicode, const TDesC8& aUtf8, TBool aGenerateJavaConformantUtf8);
sl@0: 	static TInt ConvertToUnicodeFromUtf8(TDes16& aUnicode, const TDesC8& aUtf8, TBool aGenerateJavaConformantUtf8,
sl@0: 			TInt& aNumberOfUnconvertibleCharacters, TInt& aIndexOfFirstByteOfFirstUnconvertibleCharacter);
sl@0: 
sl@0: 	IMPORT_C static HBufC8* ConvertFromUnicodeToUtf7L(const TDesC16& aUnicode,TBool aEncodeOptionalDirectCharactersInBase64);
sl@0: 	IMPORT_C static HBufC8* ConvertFromUnicodeToUtf8L(const TDesC16& aUnicode);
sl@0: 	IMPORT_C static HBufC16* ConvertToUnicodeFromUtf7L(const TDesC8& aUtf7); 
sl@0: 	IMPORT_C static HBufC16* ConvertToUnicodeFromUtf8L(const TDesC8& aUtf8);
sl@0: 
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #endif
sl@0: