MWAWParser.hxx Source File documentation

MWAWParser.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; c-default-style: "k&r"; indent-tabs-mode: nil; tab-width: 2; c-basic-offset: 2 -*- */
2
3 /* libmwaw
4 * Version: MPL 2.0 / LGPLv2+
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 2.0 (the "License"); you may not use this file except in compliance with
8 * the License or as specified alternatively below. You may obtain a copy of
9 * the License at http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * Major Contributor(s):
17 * Copyright (C) 2002 William Lachance (wrlach@gmail.com)
18 * Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
19 * Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
20 * Copyright (C) 2006, 2007 Andrew Ziem
21 * Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
22 *
23 *
24 * All Rights Reserved.
25 *
26 * For minor contributions see the git repository.
27 *
28 * Alternatively, the contents of this file may be used under the terms of
29 * the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
30 * in which case the provisions of the LGPLv2+ are applicable
31 * instead of those above.
32 */
33
34 #ifndef MWAW_PARSER_H
35 #define MWAW_PARSER_H
36
37 #include <ostream>
38 #include <string>
39 #include <vector>
40
41 #include "MWAWDebug.hxx"
42 #include "MWAWInputStream.hxx"
43
44 #include "MWAWEntry.hxx"
45 #include "MWAWHeader.hxx"
46 #include "MWAWPageSpan.hxx"
47
49 class MWAWParserState
50 {
51 public:
53 enum Type { Graphic, Presentation, Spreadsheet, Text };
55 MWAWParserState(Type type, MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
57 ~MWAWParserState();
59 MWAWListenerPtr getMainListener();
61 Type m_type;
63 MWAWDocument::Kind m_kind;
65 MWAWInputStreamPtr m_input;
67 MWAWHeader *m_header;
69 MWAWRSRCParserPtr m_rsrcParser;
71 MWAWPageSpan m_pageSpan;
72
74 MWAWFontConverterPtr m_fontConverter;
76 MWAWFontManagerPtr m_fontManager;
78 MWAWGraphicListenerPtr m_graphicListener;
80 MWAWListManagerPtr m_listManager;
82 MWAWPresentationListenerPtr m_presentationListener;
84 MWAWSpreadsheetListenerPtr m_spreadsheetListener;
86 MWAWTextListenerPtr m_textListener;
88 int m_version;
89
91 libmwaw::DebugFile m_asciiFile;
92
93 private:
94 MWAWParserState(MWAWParserState const &orig) = delete;
95 MWAWParserState &operator=(MWAWParserState const &orig) = delete;
96 };
97
99 class MWAWParser
100 {
101 public:
103 virtual ~MWAWParser();
105 virtual bool checkHeader(MWAWHeader *header, bool strict=false) = 0;
106
108 int version() const
109 {
110 return m_parserState->m_version;
111 }
113 MWAWParserStatePtr getParserState()
114 {
115 return m_parserState;
116 }
118 MWAWHeader *getHeader()
119 {
120 return m_parserState->m_header;
121 }
123 MWAWInputStreamPtr &getInput()
124 {
125 return m_parserState->m_input;
126 }
128 MWAWListenerPtr getMainListener();
130 MWAWGraphicListenerPtr &getGraphicListener()
131 {
132 return m_parserState->m_graphicListener;
133 }
135 MWAWPresentationListenerPtr &getPresentationListener()
136 {
137 return m_parserState->m_presentationListener;
138 }
140 MWAWSpreadsheetListenerPtr &getSpreadsheetListener()
141 {
142 return m_parserState->m_spreadsheetListener;
143 }
145 MWAWTextListenerPtr &getTextListener()
146 {
147 return m_parserState->m_textListener;
148 }
150 MWAWFontConverterPtr &getFontConverter()
151 {
152 return m_parserState->m_fontConverter;
153 }
155 MWAWFontManagerPtr &getFontManager()
156 {
157 return m_parserState->m_fontManager;
158 }
160 MWAWPageSpan const &getPageSpan() const
161 {
162 return m_parserState->m_pageSpan;
163 }
165 MWAWPageSpan &getPageSpan()
166 {
167 return m_parserState->m_pageSpan;
168 }
170 double getFormLength() const
171 {
172 return m_parserState->m_pageSpan.getFormLength();
173 }
175 double getFormWidth() const
176 {
177 return m_parserState->m_pageSpan.getFormWidth();
178 }
180 double getPageLength() const
181 {
182 return m_parserState->m_pageSpan.getPageLength();
183 }
185 double getPageWidth() const
186 {
187 return m_parserState->m_pageSpan.getPageWidth();
188 }
190 MWAWRSRCParserPtr &getRSRCParser()
191 {
192 return m_parserState->m_rsrcParser;
193 }
195 libmwaw::DebugFile &ascii()
196 {
197 return m_parserState->m_asciiFile;
198 }
199 protected:
201 MWAWParser(MWAWParserState::Type type, MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
203 explicit MWAWParser(MWAWParserStatePtr const &state) : m_parserState(state), m_asciiName("") { }
204
206 void setVersion(int vers)
207 {
208 m_parserState->m_version = vers;
209 }
211 void setGraphicListener(MWAWGraphicListenerPtr &listener);
213 void resetGraphicListener();
215 void setPresentationListener(MWAWPresentationListenerPtr &listener);
217 void resetPresentationListener();
219 void setSpreadsheetListener(MWAWSpreadsheetListenerPtr &listener);
221 void resetSpreadsheetListener();
223 void setTextListener(MWAWTextListenerPtr &listener);
225 void resetTextListener();
227 void setAsciiName(char const *name)
228 {
229 m_asciiName = name;
230 }
232 std::string const &asciiName() const
233 {
234 return m_asciiName;
235 }
236
237 private:
239 MWAWParser(const MWAWParser &) = delete;
241 MWAWParser &operator=(const MWAWParser &) = delete;
242
244 MWAWParserStatePtr m_parserState;
246 std::string m_asciiName;
247 };
248
250 class MWAWGraphicParser : public MWAWParser
251 {
252 public:
254 ~MWAWGraphicParser() override;
256 virtual void parse(librevenge::RVNGDrawingInterface *documentInterface) = 0;
257 protected:
259 MWAWGraphicParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header) : MWAWParser(MWAWParserState::Graphic, input, rsrcParser, header) {}
261 explicit MWAWGraphicParser(MWAWParserStatePtr const &state)
262 : MWAWParser(state) {}
263 };
264
266 class MWAWPresentationParser : public MWAWParser
267 {
268 public:
270 ~MWAWPresentationParser() override;
272 virtual void parse(librevenge::RVNGPresentationInterface *documentInterface) = 0;
273 protected:
275 MWAWPresentationParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header) : MWAWParser(MWAWParserState::Presentation, input, rsrcParser, header) {}
277 explicit MWAWPresentationParser(MWAWParserStatePtr const &state)
278 : MWAWParser(state) {}
279 };
280
282 class MWAWSpreadsheetParser : public MWAWParser
283 {
284 public:
286 ~MWAWSpreadsheetParser() override;
288 virtual void parse(librevenge::RVNGSpreadsheetInterface *documentInterface) = 0;
289 protected:
291 MWAWSpreadsheetParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header) : MWAWParser(MWAWParserState::Spreadsheet, input, rsrcParser, header) {}
293 explicit MWAWSpreadsheetParser(MWAWParserStatePtr const &state)
294 : MWAWParser(state) {}
295 };
296
298 class MWAWTextParser : public MWAWParser
299 {
300 public:
302 ~MWAWTextParser() override;
304 virtual void parse(librevenge::RVNGTextInterface *documentInterface) = 0;
305 protected:
307 MWAWTextParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header) : MWAWParser(MWAWParserState::Text, input, rsrcParser, header) {}
309 explicit MWAWTextParser(MWAWParserStatePtr const &state)
310 : MWAWParser(state) {}
311 };
312
313 #endif /* MWAWPARSER_H */
314 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWTextListenerPtr
std::shared_ptr< MWAWTextListener > MWAWTextListenerPtr
a smart pointer of MWAWTextListener
Definition: libmwaw_internal.hxx:563
MWAWParser::getSpreadsheetListener
MWAWSpreadsheetListenerPtr & getSpreadsheetListener()
returns the spreadsheet listener
Definition: MWAWParser.hxx:140
MWAWGraphicParser::~MWAWGraphicParser
~MWAWGraphicParser() override
destructor
Definition: MWAWParser.cxx:173
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:56
MWAWParser::MWAWParser
MWAWParser(MWAWParserStatePtr const &state)
constructor using a state
Definition: MWAWParser.hxx:203
MWAWParser::getTextListener
MWAWTextListenerPtr & getTextListener()
returns the text listener
Definition: MWAWParser.hxx:145
MWAWPresentationParser::parse
virtual void parse(librevenge::RVNGPresentationInterface *documentInterface)=0
virtual function used to parse the input
MWAWParser::setPresentationListener
void setPresentationListener(MWAWPresentationListenerPtr &listener)
sets the presentation listener
Definition: MWAWParser.cxx:136
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
MWAWParserState::m_kind
MWAWDocument::Kind m_kind
the document kind
Definition: MWAWParser.hxx:63
MWAWPresentationParser::MWAWPresentationParser
MWAWPresentationParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor (protected)
Definition: MWAWParser.hxx:275
MWAWParser::getFormLength
double getFormLength() const
returns the form length
Definition: MWAWParser.hxx:170
MWAWTextParser::MWAWTextParser
MWAWTextParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor (protected)
Definition: MWAWParser.hxx:307
MWAWPageSpan.hxx
MWAWPageSpan
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:95
MWAWParserState::m_spreadsheetListener
MWAWSpreadsheetListenerPtr m_spreadsheetListener
the spreadsheet listener
Definition: MWAWParser.hxx:84
MWAWEntry.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:549
MWAWParserState::m_header
MWAWHeader * m_header
the header
Definition: MWAWParser.hxx:67
MWAWSpreadsheetListenerPtr
std::shared_ptr< MWAWSpreadsheetListener > MWAWSpreadsheetListenerPtr
a smart pointer of MWAWSpreadsheetListener
Definition: libmwaw_internal.hxx:559
libmwaw::DebugFile
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:65
MWAWParser::setVersion
void setVersion(int vers)
sets the document&#39;s version
Definition: MWAWParser.hxx:206
MWAWSpreadsheetParser::MWAWSpreadsheetParser
MWAWSpreadsheetParser(MWAWParserStatePtr const &state)
constructor using a state
Definition: MWAWParser.hxx:293
MWAWParser::getRSRCParser
MWAWRSRCParserPtr & getRSRCParser()
returns the rsrc parser
Definition: MWAWParser.hxx:190
MWAWParser::getHeader
MWAWHeader * getHeader()
returns the header
Definition: MWAWParser.hxx:118
MWAWPresentationParser::~MWAWPresentationParser
~MWAWPresentationParser() override
destructor
Definition: MWAWParser.cxx:177
MWAWPresentationParser::MWAWPresentationParser
MWAWPresentationParser(MWAWParserStatePtr const &state)
constructor using a state
Definition: MWAWParser.hxx:277
MWAWParser::getGraphicListener
MWAWGraphicListenerPtr & getGraphicListener()
returns the graphic listener
Definition: MWAWParser.hxx:130
MWAWParser::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: MWAWParser.hxx:244
MWAWParserState::m_textListener
MWAWTextListenerPtr m_textListener
the text listener
Definition: MWAWParser.hxx:86
MWAWPresentationListenerPtr
std::shared_ptr< MWAWPresentationListener > MWAWPresentationListenerPtr
a smart pointer of MWAWPresentationListener
Definition: libmwaw_internal.hxx:555
MWAWSpreadsheetParser::parse
virtual void parse(librevenge::RVNGSpreadsheetInterface *documentInterface)=0
virtual function used to parse the input
MWAWParserState::operator=
MWAWParserState & operator=(MWAWParserState const &orig)=delete
MWAWParserState::~MWAWParserState
~MWAWParserState()
destructor
Definition: MWAWParser.cxx:71
MWAWGraphicListenerPtr
std::shared_ptr< MWAWGraphicListener > MWAWGraphicListenerPtr
a smart pointer of MWAWGraphicListener
Definition: libmwaw_internal.hxx:545
MWAWParser::asciiName
std::string const & asciiName() const
return the ascii file name
Definition: MWAWParser.hxx:232
MWAWParserState::Presentation
Definition: MWAWParser.hxx:53
MWAWParser::getMainListener
MWAWListenerPtr getMainListener()
returns the main listener
Definition: MWAWParser.cxx:120
MWAWParser::getFontConverter
MWAWFontConverterPtr & getFontConverter()
returns the font converter
Definition: MWAWParser.hxx:150
MWAWParser::setAsciiName
void setAsciiName(char const *name)
Debugging: change the default ascii file.
Definition: MWAWParser.hxx:227
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:557
MWAWParser::getFontManager
MWAWFontManagerPtr & getFontManager()
returns the font manager
Definition: MWAWParser.hxx:155
MWAWParserState
a class to define the parser state
Definition: MWAWParser.hxx:49
MWAWParser::resetSpreadsheetListener
void resetSpreadsheetListener()
resets the listener
Definition: MWAWParser.cxx:152
MWAWParserState::m_asciiFile
libmwaw::DebugFile m_asciiFile
the debug file
Definition: MWAWParser.hxx:91
MWAWParserState::m_version
int m_version
the actual version
Definition: MWAWParser.hxx:88
MWAWParser::resetPresentationListener
void resetPresentationListener()
resets the listener
Definition: MWAWParser.cxx:141
MWAWTextParser::~MWAWTextParser
~MWAWTextParser() override
destructor
Definition: MWAWParser.cxx:185
MWAWParser::ascii
libmwaw::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: MWAWParser.hxx:195
MWAWFontManagerPtr
std::shared_ptr< MWAWFontManager > MWAWFontManagerPtr
a smart pointer of MWAWFontManager
Definition: libmwaw_internal.hxx:543
MWAWSpreadsheetParser::~MWAWSpreadsheetParser
~MWAWSpreadsheetParser() override
destructor
Definition: MWAWParser.cxx:181
MWAWGraphicParser::MWAWGraphicParser
MWAWGraphicParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor (protected)
Definition: MWAWParser.hxx:259
MWAWParser::getParserState
MWAWParserStatePtr getParserState()
returns the parser state
Definition: MWAWParser.hxx:113
MWAWParserState::MWAWParserState
MWAWParserState(Type type, MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
Constructor.
Definition: MWAWParser.cxx:45
MWAWParser::getPresentationListener
MWAWPresentationListenerPtr & getPresentationListener()
returns the presentation listener
Definition: MWAWParser.hxx:135
MWAWParser::getFormWidth
double getFormWidth() const
returns the form width
Definition: MWAWParser.hxx:175
MWAWListManagerPtr
std::shared_ptr< MWAWListManager > MWAWListManagerPtr
a smart pointer of MWAWListManager
Definition: libmwaw_internal.hxx:551
MWAWParser::version
int version() const
returns the works version
Definition: MWAWParser.hxx:108
MWAWParserState::m_listManager
MWAWListManagerPtr m_listManager
the list manager
Definition: MWAWParser.hxx:80
MWAWParserState::Spreadsheet
Definition: MWAWParser.hxx:53
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:298
MWAWParserState::m_pageSpan
MWAWPageSpan m_pageSpan
the actual document size
Definition: MWAWParser.hxx:71
MWAWPresentationParser
virtual class which defines the ancestor of all presentation zone parser
Definition: MWAWParser.hxx:266
MWAWParser::setSpreadsheetListener
void setSpreadsheetListener(MWAWSpreadsheetListenerPtr &listener)
sets the spreadsheet listener
Definition: MWAWParser.cxx:147
MWAWParser::operator=
MWAWParser & operator=(const MWAWParser &)=delete
private operator=: forbidden
MWAWParser::getPageWidth
double getPageWidth() const
returns the page width (form width without margin )
Definition: MWAWParser.hxx:185
MWAWParser::MWAWParser
MWAWParser(MWAWParserState::Type type, MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor (protected)
Definition: MWAWParser.cxx:110
MWAWParser::setGraphicListener
void setGraphicListener(MWAWGraphicListenerPtr &listener)
sets the graphic listener
Definition: MWAWParser.cxx:125
MWAWParserState::m_fontManager
MWAWFontManagerPtr m_fontManager
the font manager
Definition: MWAWParser.hxx:76
MWAWGraphicParser
virtual class which defines the ancestor of all graphic zone parser
Definition: MWAWParser.hxx:250
MWAWParser::getPageSpan
MWAWPageSpan const & getPageSpan() const
returns the actual page dimension
Definition: MWAWParser.hxx:160
MWAWInputStream.hxx
MWAWDebug.hxx
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:547
MWAWDocument::Kind
Kind
an enum to define the kind of document
Definition: MWAWDocument.hxx:80
MWAWParser::~MWAWParser
virtual ~MWAWParser()
virtual destructor
Definition: MWAWParser.cxx:116
MWAWParser::getPageSpan
MWAWPageSpan & getPageSpan()
returns the actual page dimension
Definition: MWAWParser.hxx:165
MWAWParserState::Text
Definition: MWAWParser.hxx:53
MWAWParserState::Graphic
Definition: MWAWParser.hxx:53
MWAWParserState::Type
Type
the parser state type
Definition: MWAWParser.hxx:53
MWAWFontConverterPtr
std::shared_ptr< MWAWFontConverter > MWAWFontConverterPtr
a smart pointer of MWAWFontConverter
Definition: libmwaw_internal.hxx:539
MWAWGraphicParser::parse
virtual void parse(librevenge::RVNGDrawingInterface *documentInterface)=0
virtual function used to parse the input
MWAWGraphicParser::MWAWGraphicParser
MWAWGraphicParser(MWAWParserStatePtr const &state)
constructor using a state
Definition: MWAWParser.hxx:261
MWAWParserState::m_graphicListener
MWAWGraphicListenerPtr m_graphicListener
the graphic listener
Definition: MWAWParser.hxx:78
MWAWTextParser::MWAWTextParser
MWAWTextParser(MWAWParserStatePtr const &state)
constructor using a state
Definition: MWAWParser.hxx:309
MWAWParser::m_asciiName
std::string m_asciiName
the debug file name
Definition: MWAWParser.hxx:246
MWAWParser::getPageLength
double getPageLength() const
returns the page length (form length without margin )
Definition: MWAWParser.hxx:180
MWAWParserState::m_rsrcParser
MWAWRSRCParserPtr m_rsrcParser
the resource parser
Definition: MWAWParser.hxx:69
MWAWParser
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:99
MWAWParserState::m_presentationListener
MWAWPresentationListenerPtr m_presentationListener
the presentation listener
Definition: MWAWParser.hxx:82
MWAWParserState::m_type
Type m_type
the state type
Definition: MWAWParser.hxx:61
MWAWHeader.hxx
Defines MWAWHeader (document&#39;s type, version, kind)
MWAWParserState::m_fontConverter
MWAWFontConverterPtr m_fontConverter
the font converter
Definition: MWAWParser.hxx:74
MWAWParser::resetTextListener
void resetTextListener()
resets the listener
Definition: MWAWParser.cxx:163
MWAWParserState::m_input
MWAWInputStreamPtr m_input
the input
Definition: MWAWParser.hxx:65
MWAWParser::setTextListener
void setTextListener(MWAWTextListenerPtr &listener)
sets the text listener
Definition: MWAWParser.cxx:158
MWAWSpreadsheetParser
virtual class which defines the ancestor of all spreadsheet zone parser
Definition: MWAWParser.hxx:282
MWAWParser::checkHeader
virtual bool checkHeader(MWAWHeader *header, bool strict=false)=0
virtual function used to check if the document header is correct (or not)
MWAWSpreadsheetParser::MWAWSpreadsheetParser
MWAWSpreadsheetParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor (protected)
Definition: MWAWParser.hxx:291
MWAWTextParser::parse
virtual void parse(librevenge::RVNGTextInterface *documentInterface)=0
virtual function used to parse the input
MWAWParser::resetGraphicListener
void resetGraphicListener()
resets the listener
Definition: MWAWParser.cxx:130
MWAWParserState::getMainListener
MWAWListenerPtr getMainListener()
returns the main listener
Definition: MWAWParser.cxx:91
MWAWParser::getInput
MWAWInputStreamPtr & getInput()
returns the actual input
Definition: MWAWParser.hxx:123