|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#if !defined(__UTF_H__)
|
|
sl@0
|
20 |
#define __UTF_H__
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#if !defined(__E32STD_H__)
|
|
sl@0
|
23 |
#include <e32std.h>
|
|
sl@0
|
24 |
#endif
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
class CnvUtfConverter
|
|
sl@0
|
28 |
/**
|
|
sl@0
|
29 |
Converts text between Unicode (UCS-2) and the two Unicode transformation
|
|
sl@0
|
30 |
formats UTF-7 and UTF-8. There are no functions to convert directly between
|
|
sl@0
|
31 |
UTF-7 and UTF-8.
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
Objects of this class do not need to be created because all the member functions
|
|
sl@0
|
34 |
are static. The four functions are passed text in the second argument and
|
|
sl@0
|
35 |
output the resulting text in the first argument. Sixteen-bit descriptors are
|
|
sl@0
|
36 |
used to hold text encoded in UCS-2 (i.e. normal 16 bit Unicode), and eight-bit
|
|
sl@0
|
37 |
descriptors are used to hold text encoded in either of the transformation
|
|
sl@0
|
38 |
formats.
|
|
sl@0
|
39 |
|
|
sl@0
|
40 |
The conversion functions return the number of characters which were not converted
|
|
sl@0
|
41 |
because the output descriptor was not long enough to hold all of the converted
|
|
sl@0
|
42 |
text. This allows users of this class to perform partial conversions on an
|
|
sl@0
|
43 |
input descriptor, handling the case when the input descriptor is truncated
|
|
sl@0
|
44 |
mid way through a multi-byte character. The caller does not have to guess
|
|
sl@0
|
45 |
how big to make the output descriptor for a given input descriptor- they
|
|
sl@0
|
46 |
can simply do the conversion in a loop using a small output descriptor. The
|
|
sl@0
|
47 |
ability to handle truncated descriptors is particularly useful if the caller
|
|
sl@0
|
48 |
is receiving information in chunks from an external source.
|
|
sl@0
|
49 |
@publishedAll
|
|
sl@0
|
50 |
@released
|
|
sl@0
|
51 |
*/
|
|
sl@0
|
52 |
{
|
|
sl@0
|
53 |
public:
|
|
sl@0
|
54 |
/** Conversion error flags. At this stage there is only one error flag
|
|
sl@0
|
55 |
- others may be added in the future. */
|
|
sl@0
|
56 |
enum TError
|
|
sl@0
|
57 |
{
|
|
sl@0
|
58 |
/** The input descriptor contains a single corrupt character. This
|
|
sl@0
|
59 |
might occur when the input descriptor only contains some of the bytes
|
|
sl@0
|
60 |
of a single multi-byte character. */
|
|
sl@0
|
61 |
EErrorIllFormedInput=KErrCorrupt
|
|
sl@0
|
62 |
};
|
|
sl@0
|
63 |
|
|
sl@0
|
64 |
/** Initial value for the state argument in a set of related calls to
|
|
sl@0
|
65 |
ConvertToUnicode(). */
|
|
sl@0
|
66 |
enum {KStateDefault=0};
|
|
sl@0
|
67 |
public:
|
|
sl@0
|
68 |
// 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
|
69 |
IMPORT_C static TInt ConvertFromUnicodeToUtf7(TDes8& aUtf7, const TDesC16& aUnicode, TBool aEncodeOptionalDirectCharactersInBase64);
|
|
sl@0
|
70 |
static TInt ConvertFromUnicodeToUtf7(TDes8& aUtf7, const TDesC16& aUnicode, TBool aIsImapUtf7, TBool aEncodeOptionalDirectCharactersInBase64);
|
|
sl@0
|
71 |
IMPORT_C static TInt ConvertFromUnicodeToUtf8(TDes8& aUtf8, const TDesC16& aUnicode);
|
|
sl@0
|
72 |
static TInt ConvertFromUnicodeToUtf8(TDes8& aUtf8, const TDesC16& aUnicode, TBool aGenerateJavaConformantUtf8);
|
|
sl@0
|
73 |
IMPORT_C static TInt ConvertToUnicodeFromUtf7(TDes16& aUnicode, const TDesC8& aUtf7, TInt& aState);
|
|
sl@0
|
74 |
static TInt ConvertToUnicodeFromUtf7(TDes16& aUnicode, const TDesC8& aUtf7, TBool aIsImapUtf7, TInt& aState);
|
|
sl@0
|
75 |
IMPORT_C static TInt ConvertToUnicodeFromUtf8(TDes16& aUnicode, const TDesC8& aUtf8);
|
|
sl@0
|
76 |
static TInt ConvertToUnicodeFromUtf8(TDes16& aUnicode, const TDesC8& aUtf8, TBool aGenerateJavaConformantUtf8);
|
|
sl@0
|
77 |
static TInt ConvertToUnicodeFromUtf8(TDes16& aUnicode, const TDesC8& aUtf8, TBool aGenerateJavaConformantUtf8,
|
|
sl@0
|
78 |
TInt& aNumberOfUnconvertibleCharacters, TInt& aIndexOfFirstByteOfFirstUnconvertibleCharacter);
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
IMPORT_C static HBufC8* ConvertFromUnicodeToUtf7L(const TDesC16& aUnicode,TBool aEncodeOptionalDirectCharactersInBase64);
|
|
sl@0
|
81 |
IMPORT_C static HBufC8* ConvertFromUnicodeToUtf8L(const TDesC16& aUnicode);
|
|
sl@0
|
82 |
IMPORT_C static HBufC16* ConvertToUnicodeFromUtf7L(const TDesC8& aUtf7);
|
|
sl@0
|
83 |
IMPORT_C static HBufC16* ConvertToUnicodeFromUtf8L(const TDesC8& aUtf8);
|
|
sl@0
|
84 |
|
|
sl@0
|
85 |
|
|
sl@0
|
86 |
};
|
|
sl@0
|
87 |
|
|
sl@0
|
88 |
#endif
|
|
sl@0
|
89 |
|