epoc32/include/app/vutil.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/vutil.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __VUTIL_H__
williamr@2
    17
#define __VUTIL_H__
williamr@2
    18
williamr@2
    19
// System includes
williamr@2
    20
#ifndef __E32BASE_H__
williamr@2
    21
#include <e32base.h>
williamr@2
    22
#endif
williamr@2
    23
#ifndef __F32FILE_H__
williamr@2
    24
#include <f32file.h>
williamr@2
    25
#endif
williamr@2
    26
#ifndef __CHARCONV_H__
williamr@2
    27
#include <charconv.h>
williamr@2
    28
#endif
williamr@2
    29
williamr@2
    30
williamr@2
    31
class Versit
williamr@2
    32
/** Provides Versit-specific encoding and character set identifiers. 
williamr@2
    33
@publishedAll
williamr@2
    34
@released
williamr@2
    35
*/
williamr@2
    36
	{
williamr@2
    37
public:
williamr@2
    38
	/** Versit-specific encoding identifiers. 
williamr@2
    39
	@publishedAll
williamr@2
    40
	@released
williamr@2
    41
	*/
williamr@2
    42
	enum TVersitEncoding
williamr@2
    43
		{
williamr@2
    44
		/** No encoding. */
williamr@2
    45
		ENoEncoding,
williamr@2
    46
		/** Quoted Printable encoding. */
williamr@2
    47
		EQuotedPrintableEncoding,
williamr@2
    48
		/** Base 64 encoding. */
williamr@2
    49
		EBase64Encoding,
williamr@2
    50
williamr@2
    51
		// Used internally - not to be used by versit clients
williamr@2
    52
		/** Eight bit encoding. */
williamr@2
    53
		EEightBitEncoding
williamr@2
    54
		};
williamr@2
    55
williamr@2
    56
	/** Versit-specific character set identifiers. These are used in the Versit API 
williamr@2
    57
	to represent foreign (non-Unicode) character sets for vCard and vCalendar 
williamr@2
    58
	properties. 
williamr@2
    59
	@publishedAll
williamr@2
    60
	@released */
williamr@2
    61
	enum TVersitCharSet
williamr@2
    62
		{
williamr@2
    63
		/** Unknown character set. */
williamr@2
    64
		EUnknownCharSet,
williamr@2
    65
		/** ASCII (7-bit).*/
williamr@2
    66
		EUSAsciiCharSet,	
williamr@2
    67
		/** UTF-8 Unicode transformation format. */
williamr@2
    68
		EUTF8CharSet,
williamr@2
    69
		/** UTF-7 Unicode transformation format. */
williamr@2
    70
		EUTF7CharSet,
williamr@2
    71
		/** ISO 8859-1 (8-bit). */
williamr@2
    72
		EISO88591CharSet,
williamr@2
    73
		/** ISO 8859-2 (8-bit). */
williamr@2
    74
		EISO88592CharSet,
williamr@2
    75
		/** ISO 8859-4 (8-bit). */
williamr@2
    76
		EISO88594CharSet,
williamr@2
    77
		/** ISO 8859-5 (8-bit). */
williamr@2
    78
		EISO88595CharSet,
williamr@2
    79
		/** ISO 8859-7 (8-bit). */
williamr@2
    80
		EISO88597CharSet,
williamr@2
    81
		/** ISO 8859-9 (8-bit). */
williamr@2
    82
		EISO88599CharSet,
williamr@2
    83
		/** ISO 8859-3 (8-bit). */
williamr@2
    84
		EISO88593CharSet,
williamr@2
    85
		/** ISO 8859-10 (8-bit). */
williamr@2
    86
		EISO885910CharSet,
williamr@2
    87
		/** GB 2312. */
williamr@2
    88
		EGB231280CharSet,
williamr@2
    89
		/** GBK. */
williamr@2
    90
		EGBKCharSet,
williamr@2
    91
		/** Big 5. */
williamr@2
    92
		EBIG5CharSet,
williamr@2
    93
		/** ISO-2022-JP. */
williamr@2
    94
		EISO2022JPCharSet,
williamr@2
    95
		/** EUC-JP. */
williamr@2
    96
		EEUCJPCharSet,
williamr@2
    97
		/** Shift JIS. */
williamr@2
    98
		EShiftJISCharSet,
williamr@2
    99
		/** JIS. */
williamr@2
   100
		EJISCharSet,
williamr@2
   101
		/** Must be first character set. */
williamr@2
   102
		EFirstCharSet=EUSAsciiCharSet,
williamr@2
   103
		/** Must be last character set. */
williamr@2
   104
		ELastCharSet=EJISCharSet
williamr@2
   105
		};
williamr@2
   106
williamr@2
   107
	class TEncodingAndCharset
williamr@2
   108
	/** Specifies an encoding, a character set and a character set converter. 
williamr@2
   109
	@publishedAll
williamr@2
   110
	@released */
williamr@2
   111
		{
williamr@2
   112
	public:
williamr@2
   113
		inline TEncodingAndCharset(TVersitEncoding aEncoding,TUint aCharSetId) :iEncoding(aEncoding), iCharSetId(aCharSetId) 
williamr@2
   114
		/** The C++ constructor initialises the encoding and character set.
williamr@2
   115
	
williamr@2
   116
		@param aEncoding An encoding.
williamr@2
   117
		@param aCharSetId A character set. */
williamr@2
   118
			{}
williamr@2
   119
	public:
williamr@2
   120
		/** An encoding. */
williamr@2
   121
		TVersitEncoding iEncoding;
williamr@2
   122
		/** A character set. */
williamr@2
   123
		TUint iCharSetId;
williamr@2
   124
		/** A character set converter. */
williamr@2
   125
		CCnvCharacterSetConverter* iConverter;
williamr@2
   126
		};
williamr@2
   127
	};
williamr@2
   128
williamr@2
   129
class CVersitUnicodeUtils : public CBase
williamr@2
   130
/** Versit Unicode utilities class. 
williamr@2
   131
williamr@2
   132
This enables conversion between Unicode and ISO character sets. 
williamr@2
   133
@publishedAll
williamr@2
   134
@released
williamr@2
   135
*/
williamr@2
   136
	{
williamr@2
   137
public:
williamr@2
   138
	IMPORT_C ~CVersitUnicodeUtils();
williamr@2
   139
	IMPORT_C HBufC8* NarrowL(const TDesC& aDesC);
williamr@2
   140
	IMPORT_C HBufC8* NarrowLC(const TDesC& aDesC);
williamr@2
   141
	IMPORT_C HBufC* WidenL(const TDesC8& aDesC8);
williamr@2
   142
	IMPORT_C HBufC* WidenLC(const TDesC8& aDesC8);
williamr@2
   143
	IMPORT_C void CreateConverterL();
williamr@2
   144
	CCnvCharacterSetConverter::TAvailability SetCurrentCharSetL(TUint aCharacterSet);
williamr@2
   145
williamr@2
   146
public:
williamr@2
   147
	inline CCnvCharacterSetConverter& CharacterSetConverter() const;
williamr@2
   148
	inline TUint ConvertStandardNameL(const TDesC8& aStandardNameOfCharacterSet);
williamr@2
   149
	inline HBufC8* StandardNameL(TUint aCharSetId);
williamr@2
   150
	TUint AutoDetectCharSetL(const TDesC8& aSample,const CArrayFix<CCnvCharacterSetConverter::SCharacterSet>* aAutoDetectCharSets);
williamr@2
   151
williamr@2
   152
private:
williamr@2
   153
	RFs iFsSession;
williamr@2
   154
	CCnvCharacterSetConverter* iUnicodeConverter;
williamr@2
   155
	TBool iFsConnected;
williamr@2
   156
	TUint iCurrentConverterCharSet;
williamr@2
   157
	CArrayFix<CCnvCharacterSetConverter::SCharacterSet>* iCharSetsAvailable;
williamr@2
   158
	};
williamr@2
   159
williamr@2
   160
williamr@2
   161
inline CCnvCharacterSetConverter& CVersitUnicodeUtils::CharacterSetConverter() const
williamr@2
   162
/** Returns the character set converter created in CreateConverterL().
williamr@2
   163
	
williamr@2
   164
@return A character set converter. */
williamr@2
   165
	{
williamr@2
   166
	return *iUnicodeConverter;
williamr@2
   167
	}
williamr@2
   168
inline TUint CVersitUnicodeUtils::ConvertStandardNameL(const TDesC8& aStandardNameOfCharacterSet)
williamr@2
   169
/** Returns the Symbian OS UID for a character set from its Internet-standard 
williamr@2
   170
name.
williamr@2
   171
	
williamr@2
   172
@param aStandardNameOfCharacterSet Internet-standard name of a character set 
williamr@2
   173
encoded in 8-bit ASCII.
williamr@2
   174
@return The Symbian OS UID of the specified character set. If the name is not 
williamr@2
   175
known, zero is returned. */
williamr@2
   176
	{
williamr@2
   177
	return iUnicodeConverter->ConvertStandardNameOfCharacterSetToIdentifierL(aStandardNameOfCharacterSet,iFsSession);
williamr@2
   178
	}
williamr@2
   179
inline HBufC8* CVersitUnicodeUtils::StandardNameL(TUint aCharSetId)
williamr@2
   180
/** Returns the Internet-standard name of a character set, from its Symbian OS UID. 
williamr@2
   181
williamr@2
   182
@param aCharSetId The Symbian OS UID of a character set.
williamr@2
   183
@return The Internet-standard name or MIME name of the specified character 
williamr@2
   184
set, or NULL if the UID is not known. The name is encoded in 8-bit ASCII. */
williamr@2
   185
	{
williamr@2
   186
	return iUnicodeConverter->ConvertCharacterSetIdentifierToStandardNameL(aCharSetId,iFsSession);
williamr@2
   187
	}
williamr@2
   188
williamr@2
   189
#endif