1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*
* Copyright (c) 2004, Nate Nielsen
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the
* above copyright notice, this list of conditions and
* the following disclaimer in the documentation and/or
* other materials provided with the distribution.
* * The names of contributors to this software may not be
* used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*
*
* CONTRIBUTORS
* Nate Nielsen <nielsen@memberwebs.com>
*
*/
#ifndef __XMLCOMPOSEHELPERS_H__
#define __XMLCOMPOSEHELPERS_H__
#include "usuals.h"
#include "reference.h"
#include "sablo.h"
#include "rtfformatting.h"
class XmlComposer;
/*
* Destination
*
* A destination is a small class that handles the character data found
* in the RTF document. Depending on the current context in the RTF
* different destinations are used.
*/
class Destination :
public Instance
{
public:
// This is called when the Destination is first used
virtual void initialize() {};
// Called when data arrives at destination
virtual void charData(wstring data) {};
// Called when the Destination goes out of scope
virtual void done() {};
protected:
XmlComposer* m_composer;
friend class XmlComposer;
};
/*
* Analyser
*
* An analyser is a small class that handles the RTF control words.
* Depending on the current context in the RTF different analysers
* are used.
*/
class Analyser :
public Instance
{
public:
// This is called when the Analyser is first used
virtual void initialize() {};
// Called when a control word is seen
virtual void controlWord(const string& cw, int flags, int param) {};
// Called when a group is seen within this scope
virtual void groupStart() {};
// Called when a group ends within this scope
virtual void groupEnd() {};
// Called when when this analyser goes out of scope
virtual void done() {};
protected:
XmlComposer* m_composer;
friend class XmlComposer;
};
class Level;
// Reference counted pointers
typedef Reference<Destination> DestinationPtr;
typedef Reference<Analyser> AnalyserPtr;
typedef Reference<Level> LevelPtr;
/*
* Level
*
* A level is a combination of a Destination, Analyser, XML Element and
* some other options. They're used in a stack to push and pop these as
* RTF groups are found.
*
* About the stack:
* Not each level has it's own options. If a certain option isn't found
* in the current level the previous one is looked up. That's what all
* the 'deep' stuff is about below:
*
* get* methods:
* When 'deep' is set look to previous levels for the given object if not
* found at the current level. When not set returns object in current level
* or null when none exists here.
*
* set* methods:
* When 'deep' is set then replace the object currently being used at it's
* own level. So if get* would return an object from a previous level, with
* deep set to true it would replace that object in the given level. When
* not set, then the object is set in the current level.
*/
class Level :
public Instance
{
public:
Level();
virtual ~Level();
LevelPtr getPrevious();
LevelPtr pushLevel();
// The current XML Element
// TODO: Add deep semantics here
DOM::Element getElement(bool deep = true);
void setElement(DOM::Element element, bool deep = false);
// The current Analyser
AnalyserPtr getAnalyser(bool deep = true);
void setAnalyser(AnalyserPtr analyser, bool deep = false);
// The current Destination
DestinationPtr getDestination(bool deep = true);
void setDestination(DestinationPtr destination, bool deep = false);
// The current formatting options
RtfFormatting& getFormatting();
void setTextProperties(RtfFormatting& textProperties);
protected:
// Constructor for stacking levels
Level(const Level& level);
LevelPtr m_previous; // The previous level
DOM::Element m_element; // XML Element for this level
RtfFormatting m_text; // Formatting options for this level
DestinationPtr m_destination; // Destination for this level
AnalyserPtr m_analyser; // Analyser for this level
};
#endif //__XMLCOMPOSEHELPERS_H__
|
