epoc32/include/app/imcvcodc.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 1999-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@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.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@4
    15
/**
williamr@4
    16
 * @file 
williamr@4
    17
 * @publishedAll
williamr@4
    18
 * @released
williamr@4
    19
 */
williamr@2
    20
williamr@2
    21
#if !defined(__IMCVCODC_H__)
williamr@2
    22
#define __IMCVCODC_H__
williamr@2
    23
williamr@2
    24
#include <s32buf.h>
williamr@2
    25
#include <s32stor.h>
williamr@2
    26
#include <txtrich.h>
williamr@2
    27
#include <miutatch.h>
williamr@2
    28
#include <miutconv.h>
williamr@2
    29
#include <miuthdr.h>
williamr@2
    30
#include <mentact.h>		// CMsgActive
williamr@2
    31
williamr@2
    32
#include <imcvdata.h>
williamr@2
    33
#include <imcvtext.h>
williamr@2
    34
#include <imutdll.h>
williamr@2
    35
williamr@2
    36
#define KBase64 _L("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=")
williamr@2
    37
#define KCharFormat _L("%c")
williamr@2
    38
williamr@2
    39
// Shared implementation code	
williamr@2
    40
//----------------------------------------------------------------------------------------
williamr@2
    41
class TImCodec
williamr@2
    42
//----------------------------------------------------------------------------------------
williamr@2
    43
/**
williamr@4
    44
@publishedAll
williamr@2
    45
@released
williamr@2
    46
*/
williamr@2
    47
	{
williamr@2
    48
protected:
williamr@2
    49
	// base64 and UU coding defines.
williamr@2
    50
	enum EMaskValues{ ESixBitMask = 0x3F, EEightBitMask = 0xFF };
williamr@2
    51
	enum EMaskShiftValues{ ESix = 6, EFour = 4, ETwo = 2, EZero = 0 };
williamr@2
    52
williamr@2
    53
public:
williamr@2
    54
	virtual TInt Encode( const TDesC8& aSrcString, TDes8& rDestString)=0 ;
williamr@2
    55
	virtual TBool Decode( const TDesC8& aInputLine, TDes8& rOutputLine)=0;
williamr@2
    56
williamr@2
    57
protected:
williamr@2
    58
	// TImCodec();
williamr@2
    59
	inline TBool IsDigit( TChar aChar );
williamr@2
    60
	};
williamr@2
    61
williamr@2
    62
williamr@2
    63
// Interface for sending file data.
williamr@2
    64
//----------------------------------------------------------------------------------------
williamr@2
    65
class TImFileCodec : public TImCodec
williamr@2
    66
//----------------------------------------------------------------------------------------
williamr@2
    67
/**
williamr@4
    68
@publishedAll
williamr@2
    69
@released
williamr@2
    70
*/
williamr@2
    71
	{
williamr@2
    72
public:
williamr@2
    73
	virtual TInt PrefixNextLineL( TDes8& rOutputLine, const TFileName& aName, TInt& rPaddingCount );
williamr@2
    74
	virtual TInt PostfixNextLine( TDes8& rOutputLine, TInt& rPaddingCount );
williamr@2
    75
	virtual void Initialise();
williamr@2
    76
williamr@2
    77
protected:
williamr@2
    78
	TInt iPrefixState;
williamr@2
    79
	TInt iPostfixState;
williamr@2
    80
	};	
williamr@2
    81
williamr@2
    82
// Dummy, just copies
williamr@2
    83
//----------------------------------------------------------------------------------------
williamr@2
    84
class TImCodecNull :  public TImFileCodec
williamr@2
    85
//----------------------------------------------------------------------------------------
williamr@2
    86
/**
williamr@4
    87
@publishedAll
williamr@2
    88
@released
williamr@2
    89
*/
williamr@2
    90
	{
williamr@2
    91
public:
williamr@2
    92
	TInt Encode( const TDesC8& aSrcString, TDes8& rDestString);
williamr@2
    93
	TBool Decode( const TDesC8& aInputLine, TDes8& rOutputLine);
williamr@2
    94
	};
williamr@2
    95
	
williamr@2
    96
// Quoted-printable encoding/decoding
williamr@2
    97
williamr@2
    98
//----------------------------------------------------------------------------------------
williamr@2
    99
class TImCodecQP : public TImFileCodec
williamr@2
   100
//----------------------------------------------------------------------------------------
williamr@2
   101
/**
williamr@4
   102
@publishedAll
williamr@2
   103
@released
williamr@2
   104
*/
williamr@2
   105
	{
williamr@2
   106
public:
williamr@2
   107
	IMPORT_C TImCodecQP();
williamr@2
   108
	IMPORT_C TInt Encode( const TDesC8& aSrcString, TDes8& rDestString);
williamr@2
   109
	IMPORT_C TBool Decode( const TDesC8& aInputLine, TDes8& rOutputLine);
williamr@2
   110
williamr@2
   111
	// Not to be used anymore..
williamr@2
   112
	IMPORT_C TInt EncodeRichText( const TDesC8& aInputLine, TDes8& rOutputLine);
williamr@2
   113
	IMPORT_C TInt DecodeRichText( const TDesC8& aSrcString, TDes& rDestString );
williamr@2
   114
williamr@2
   115
	// Functions which allow flexiblity. Can replace the '=' char or add characters..
williamr@2
   116
	// to what is defined as 'plain.
williamr@2
   117
	inline void AddPlainChar(const TDesC8&  aCharList );
williamr@2
   118
	inline void AddEncodeChar(const TDesC8&  aCharList );
williamr@2
   119
	inline void SetQPChar( TUint8 aChar);
williamr@2
   120
williamr@2
   121
	inline TUint8 ReplacementChar( TChar aControlChar );
williamr@2
   122
	inline TBool IsPlain( TChar aChar );
williamr@2
   123
williamr@2
   124
private:
williamr@2
   125
	TBool SmartBreak( TInt written, const TDesC8& pSource );
williamr@2
   126
	inline TBool IsBreakable( TChar aChar);
williamr@2
   127
	inline void AddSoftLineBreak(TDes8& aPtr, TInt& aPadding, TInt& aWritten);
williamr@2
   128
	inline void AddSoftLineBreak(const TUint8* apEnd, TUint8* aPtr, TInt& aPadding, TInt& aWritten);
williamr@2
   129
williamr@2
   130
private:
williamr@2
   131
	TUint8 iQPCharacter;
williamr@2
   132
	TPtrC8 iPlainCharList;  
williamr@2
   133
	TPtrC8 iEncodeCharList;  
williamr@2
   134
williamr@2
   135
	TInt iPaddingCount;
williamr@2
   136
	};
williamr@2
   137
williamr@2
   138
williamr@2
   139
williamr@2
   140
// Base64 coding/decoding
williamr@2
   141
williamr@2
   142
//----------------------------------------------------------------------------------------
williamr@2
   143
class TImCodecB64 : public TImFileCodec
williamr@2
   144
//----------------------------------------------------------------------------------------
williamr@2
   145
/**
williamr@2
   146
@publishedAll
williamr@2
   147
@released
williamr@2
   148
*/
williamr@2
   149
	{
williamr@2
   150
private:
williamr@2
   151
	// base64 coding defines
williamr@2
   152
	enum{ EPadChar = 64 };
williamr@2
   153
williamr@2
   154
public:
williamr@2
   155
	IMPORT_C TImCodecB64();
williamr@2
   156
	IMPORT_C TInt Encode( const TDesC8& aSrcString, TDes8& rDestString);
williamr@2
   157
	IMPORT_C TBool Decode( const TDesC8& aSrcString, TDes8& rDestString);
williamr@2
   158
 	IMPORT_C void  Initialise();
williamr@2
   159
williamr@2
   160
protected:
williamr@2
   161
	TInt DoEncode(const TDesC8& aSrcString, TDes8& rDestString, TBool aInsertLineBreaks);
williamr@2
   162
williamr@2
   163
private:
williamr@2
   164
	TInt iShiftStored;
williamr@2
   165
	TInt iMaskShiftStored;
williamr@2
   166
	};
williamr@2
   167
williamr@4
   168
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS  
williamr@4
   169
#include "cimconvertheader.h"
williamr@4
   170
#endif
williamr@2
   171
williamr@2
   172
// UU coding/decoding
williamr@2
   173
williamr@2
   174
//----------------------------------------------------------------------------------------
williamr@2
   175
class TImCodecUU : public TImFileCodec
williamr@2
   176
//----------------------------------------------------------------------------------------
williamr@2
   177
/**
williamr@2
   178
@publishedAll
williamr@2
   179
@released
williamr@2
   180
*/
williamr@2
   181
	{
williamr@2
   182
private:
williamr@2
   183
	// UU coding defines
williamr@2
   184
williamr@2
   185
	enum{ ESpace = 32, EBackQuote = 96 };
williamr@2
   186
williamr@2
   187
	enum TImBodyPostfix
williamr@2
   188
		{
williamr@2
   189
		EInvertedComma = 0,
williamr@2
   190
		EEndString,
williamr@2
   191
		EEndOfPostfix
williamr@2
   192
		};
williamr@2
   193
williamr@2
   194
public:
williamr@2
   195
	IMPORT_C TImCodecUU();
williamr@2
   196
	IMPORT_C TInt Encode( const TDesC8& aSrcString, TDes8& rDestString );
williamr@2
   197
	IMPORT_C TBool Decode( const TDesC8& aSrcString, TDes8& rDestString );
williamr@2
   198
	TInt PrefixNextLineL( TDes8& rOutputLine, const TFileName& aName, TInt& rPaddingCount );
williamr@2
   199
	TInt PostfixNextLine( TDes8& rOutputLine, TInt& rPaddingCount );
williamr@2
   200
private:
williamr@2
   201
	void AppendFilenameL( TDes8& rOutputLine, const TFileName& aName );
williamr@2
   202
	
williamr@2
   203
	};
williamr@2
   204
williamr@4
   205
#endif
williamr@2
   206