|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 2005-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 |
#ifndef __TXTWRITER_H__
|
|
sl@0
|
20 |
#define __TXTWRITER_H__
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#include <e32std.h>
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
//////////////////////////////////////////////////////////////////////////////////////////////
|
|
sl@0
|
25 |
//////////////////////////////////////////////////////////////////////////////////////////////
|
|
sl@0
|
26 |
// MTextWriter interface
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
/**
|
|
sl@0
|
29 |
MTextWriter class is an interface, implemented by TParagraphTextWriter and
|
|
sl@0
|
30 |
TLineTextWriter classes. It offers two functions:
|
|
sl@0
|
31 |
1) void WriteL(TText aChar) - to output a single character.
|
|
sl@0
|
32 |
2) void FlushL() - if the implementations have stored some of the incomming characters
|
|
sl@0
|
33 |
for further processing, they will be immediately flushed to the output.
|
|
sl@0
|
34 |
They are not supposed to be called directly. MTextWriter class, together with TSLBTransaltor,
|
|
sl@0
|
35 |
MOutputChar, TParagraphTextWriter and TLineTextWriter classes builds a framework, used for
|
|
sl@0
|
36 |
correct filtering of the 0x0D and 0x0A characters and translating them to line breaks or spaces,
|
|
sl@0
|
37 |
depending of the text file organisation.
|
|
sl@0
|
38 |
@internalComponent
|
|
sl@0
|
39 |
*/
|
|
sl@0
|
40 |
class MTextWriter
|
|
sl@0
|
41 |
{
|
|
sl@0
|
42 |
public:
|
|
sl@0
|
43 |
virtual void WriteL(TText aChar) = 0;
|
|
sl@0
|
44 |
virtual void FlushL()
|
|
sl@0
|
45 |
{
|
|
sl@0
|
46 |
}
|
|
sl@0
|
47 |
};
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
//////////////////////////////////////////////////////////////////////////////////////////////
|
|
sl@0
|
50 |
//////////////////////////////////////////////////////////////////////////////////////////////
|
|
sl@0
|
51 |
// MOutputChar interface
|
|
sl@0
|
52 |
|
|
sl@0
|
53 |
/**
|
|
sl@0
|
54 |
MOutputChar interface offers "void OutputCharL(TText aChar)" method, which gets as an input
|
|
sl@0
|
55 |
character, which may be a line break or something else, but not 0x0D or 0x0A characters, which
|
|
sl@0
|
56 |
were filtered earlier.
|
|
sl@0
|
57 |
@internalComponent
|
|
sl@0
|
58 |
*/
|
|
sl@0
|
59 |
class MOutputChar
|
|
sl@0
|
60 |
{
|
|
sl@0
|
61 |
public:
|
|
sl@0
|
62 |
virtual void OutputCharL(TText aChar) = 0;
|
|
sl@0
|
63 |
};
|
|
sl@0
|
64 |
|
|
sl@0
|
65 |
//////////////////////////////////////////////////////////////////////////////////////////////
|
|
sl@0
|
66 |
//////////////////////////////////////////////////////////////////////////////////////////////
|
|
sl@0
|
67 |
// TSLBTransaltor class
|
|
sl@0
|
68 |
|
|
sl@0
|
69 |
/**
|
|
sl@0
|
70 |
TSLBTransaltor class offers functionality for processing a stream of characters, filtering
|
|
sl@0
|
71 |
0x0D and 0x0A characters or (0x0D 0x0A) combination, and transating them to single line breaks.
|
|
sl@0
|
72 |
It sends translated characters for a further processing using MTextWriter::WriteL() call.
|
|
sl@0
|
73 |
The translation rules are:
|
|
sl@0
|
74 |
- 0x0D - line break;
|
|
sl@0
|
75 |
- 0x0A - line break;
|
|
sl@0
|
76 |
- 0x0D 0x0A - line break;
|
|
sl@0
|
77 |
@internalComponent
|
|
sl@0
|
78 |
*/
|
|
sl@0
|
79 |
class TSLBTransaltor
|
|
sl@0
|
80 |
{
|
|
sl@0
|
81 |
public:
|
|
sl@0
|
82 |
inline TSLBTransaltor(MTextWriter& aTextWriter);
|
|
sl@0
|
83 |
void ProcessL(TText aChar);
|
|
sl@0
|
84 |
void FlushL();
|
|
sl@0
|
85 |
private:
|
|
sl@0
|
86 |
MTextWriter& iTextWriter;
|
|
sl@0
|
87 |
TText iPrevChar;
|
|
sl@0
|
88 |
};
|
|
sl@0
|
89 |
|
|
sl@0
|
90 |
//////////////////////////////////////////////////////////////////////////////////////////////
|
|
sl@0
|
91 |
//////////////////////////////////////////////////////////////////////////////////////////////
|
|
sl@0
|
92 |
// TParagraphTextWriter class
|
|
sl@0
|
93 |
|
|
sl@0
|
94 |
/**
|
|
sl@0
|
95 |
TParagraphTextWriter class is a concrete implementation of MTextWriter interface.
|
|
sl@0
|
96 |
It is used to translate line breaks in the input sequence to paragraph delimiters.
|
|
sl@0
|
97 |
Every line break from the input is replaced with paragraph delimiter in the output.
|
|
sl@0
|
98 |
MOutputChar interface is used for the output.
|
|
sl@0
|
99 |
@internalComponent
|
|
sl@0
|
100 |
*/
|
|
sl@0
|
101 |
NONSHARABLE_CLASS(TParagraphTextWriter) : public MTextWriter
|
|
sl@0
|
102 |
{
|
|
sl@0
|
103 |
public:
|
|
sl@0
|
104 |
inline TParagraphTextWriter(MOutputChar& aOutputChar);
|
|
sl@0
|
105 |
virtual void WriteL(TText aChar);
|
|
sl@0
|
106 |
private:
|
|
sl@0
|
107 |
MOutputChar& iOutputChar;
|
|
sl@0
|
108 |
};
|
|
sl@0
|
109 |
|
|
sl@0
|
110 |
//////////////////////////////////////////////////////////////////////////////////////////////
|
|
sl@0
|
111 |
//////////////////////////////////////////////////////////////////////////////////////////////
|
|
sl@0
|
112 |
// TLineTextWriter class
|
|
sl@0
|
113 |
|
|
sl@0
|
114 |
/**
|
|
sl@0
|
115 |
TLineTextWriter class is a concrete implementation of MTextWriter interface.
|
|
sl@0
|
116 |
It is used to translate line breaks in the input sequence to paragraph delimiters or spaces.
|
|
sl@0
|
117 |
The translation rules are:
|
|
sl@0
|
118 |
- single line break - space;
|
|
sl@0
|
119 |
- double line break - paragraph delimiter;
|
|
sl@0
|
120 |
MOutputChar interface is used for the output.
|
|
sl@0
|
121 |
@internalComponent
|
|
sl@0
|
122 |
*/
|
|
sl@0
|
123 |
NONSHARABLE_CLASS(TLineTextWriter) : public MTextWriter
|
|
sl@0
|
124 |
{
|
|
sl@0
|
125 |
public:
|
|
sl@0
|
126 |
inline TLineTextWriter(MOutputChar& aOutputChar);
|
|
sl@0
|
127 |
virtual void WriteL(TText aChar);
|
|
sl@0
|
128 |
virtual void FlushL();
|
|
sl@0
|
129 |
private:
|
|
sl@0
|
130 |
MOutputChar& iOutputChar;
|
|
sl@0
|
131 |
TText iPrevChar;
|
|
sl@0
|
132 |
};
|
|
sl@0
|
133 |
|
|
sl@0
|
134 |
|
|
sl@0
|
135 |
#include "TxtWriter.inl"
|
|
sl@0
|
136 |
|
|
sl@0
|
137 |
#endif //__TXTWRITER_H__
|