2 * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
4 * This component and the accompanying materials are made available
5 * under the terms of the License "Eclipse Public License v1.0"
6 * which accompanies this distribution, and is available
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
9 * Initial Contributors:
10 * Nokia Corporation - initial contribution.
24 #if !defined(__UTF_H__)
27 #if !defined(__E32STD_H__)
34 Converts text between Unicode (UCS-2) and the two Unicode transformation
35 formats UTF-7 and UTF-8. There are no functions to convert directly between
38 Objects of this class do not need to be created because all the member functions
39 are static. The four functions are passed text in the second argument and
40 output the resulting text in the first argument. Sixteen-bit descriptors are
41 used to hold text encoded in UCS-2 (i.e. normal 16 bit Unicode), and eight-bit
42 descriptors are used to hold text encoded in either of the transformation
45 The conversion functions return the number of characters which were not converted
46 because the output descriptor was not long enough to hold all of the converted
47 text. This allows users of this class to perform partial conversions on an
48 input descriptor, handling the case when the input descriptor is truncated
49 mid way through a multi-byte character. The caller does not have to guess
50 how big to make the output descriptor for a given input descriptor- they
51 can simply do the conversion in a loop using a small output descriptor. The
52 ability to handle truncated descriptors is particularly useful if the caller
53 is receiving information in chunks from an external source.
57 /** Conversion error flags. At this stage there is only one error flag
58 - others may be added in the future. */
61 /** The input descriptor contains a single corrupt character. This
62 might occur when the input descriptor only contains some of the bytes
63 of a single multi-byte character. */
64 EErrorIllFormedInput=KErrCorrupt
67 /** Initial value for the state argument in a set of related calls to
68 ConvertToUnicode(). */
69 enum {KStateDefault=0};
71 // 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
72 IMPORT_C static TInt ConvertFromUnicodeToUtf8(TDes8& aUtf8, const TDesC16& aUnicode);
73 static TInt ConvertFromUnicodeToUtf8(TDes8& aUtf8, const TDesC16& aUnicode, TBool aGenerateJavaConformantUtf8);
74 IMPORT_C static TInt ConvertToUnicodeFromUtf8(TDes16& aUnicode, const TDesC8& aUtf8);
75 static TInt ConvertToUnicodeFromUtf8(TDes16& aUnicode, const TDesC8& aUtf8, TBool aGenerateJavaConformantUtf8);
76 static TInt ConvertToUnicodeFromUtf8(TDes16& aUnicode, const TDesC8& aUtf8, TBool aGenerateJavaConformantUtf8,
77 TInt& aNumberOfUnconvertibleCharacters, TInt& aIndexOfFirstByteOfFirstUnconvertibleCharacter);