STOFFParser.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 /* libstaroffice
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 STOFF_PARSER_H
35 #define STOFF_PARSER_H
36 
37 #include <ostream>
38 #include <string>
39 #include <vector>
40 
41 #include "STOFFDebug.hxx"
42 #include "STOFFInputStream.hxx"
43 
44 #include "STOFFEntry.hxx"
45 #include "STOFFHeader.hxx"
46 #include "STOFFPageSpan.hxx"
47 
50 {
51 public:
63  int m_version;
70 
79 
82 
83 private:
86 };
87 
90 {
91 public:
93  virtual ~STOFFParser();
95  virtual bool checkHeader(STOFFHeader *header, bool strict=false) = 0;
96 
98  int version() const
99  {
100  return m_parserState->m_version;
101  }
104  {
105  return m_parserState;
106  }
109  {
110  return m_parserState->m_header;
111  }
114  {
115  return m_parserState->m_input;
116  }
118  STOFFPageSpan const &getPageSpan() const
119  {
120  return m_parserState->m_pageSpan;
121  }
124  {
125  return m_parserState->m_pageSpan;
126  }
129  {
130  return m_parserState->m_graphicListener;
131  }
134  {
135  return m_parserState->m_spreadsheetListener;
136  }
139  {
140  return m_parserState->m_textListener;
141  }
144  {
145  return m_parserState->m_asciiFile;
146  }
147 protected:
151  explicit STOFFParser(STOFFParserStatePtr &state) : m_parserState(state), m_asciiName("") { }
152 
154  void setVersion(int vers)
155  {
156  m_parserState->m_version = vers;
157  }
161  void resetGraphicListener();
167  void setTextListener(STOFFTextListenerPtr &listener);
169  void resetTextListener();
171  void setAsciiName(char const *name)
172  {
173  m_asciiName = name;
174  }
176  std::string const &asciiName() const
177  {
178  return m_asciiName;
179  }
180 
181 private:
183  STOFFParser(const STOFFParser &);
186 
190  std::string m_asciiName;
191 };
192 
195 {
196 public:
198  virtual void parse(librevenge::RVNGTextInterface *documentInterface) = 0;
199 protected:
201  STOFFTextParser(STOFFInputStreamPtr &input, STOFFHeader *header) : STOFFParser(STOFFParserState::Text, input, header) {}
203  explicit STOFFTextParser(STOFFParserStatePtr &state) : STOFFParser(state) {}
205  ~STOFFTextParser() override;
206 };
207 
210 {
211 public:
213  virtual void parse(librevenge::RVNGDrawingInterface *documentInterface);
215  virtual void parse(librevenge::RVNGPresentationInterface *documentInterface);
216 protected:
218  STOFFGraphicParser(STOFFInputStreamPtr &input, STOFFHeader *header) : STOFFParser(STOFFParserState::Graphic, input, header) {}
222  ~STOFFGraphicParser() override;
223 };
224 
227 {
228 public:
230  virtual void parse(librevenge::RVNGSpreadsheetInterface *documentInterface) = 0;
231 protected:
233  STOFFSpreadsheetParser(STOFFInputStreamPtr &input, STOFFHeader *header) : STOFFParser(STOFFParserState::Spreadsheet, input, header) {}
237  ~STOFFSpreadsheetParser() override;
238 };
239 
240 #endif /* STOFFPARSER_H */
241 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
Type
the parser state type
Definition: STOFFParser.hxx:53
STOFFPageSpan & getPageSpan()
returns the actual page dimension
Definition: STOFFParser.hxx:123
a function used by STOFFDocument to store the version of document
Definition: STOFFHeader.hxx:56
virtual ~STOFFParser()
virtual destructor
Definition: STOFFParser.cxx:74
void setTextListener(STOFFTextListenerPtr &listener)
sets the text listener
Definition: STOFFParser.cxx:100
STOFFPageSpan m_pageSpan
the actual document size
Definition: STOFFParser.hxx:69
std::shared_ptr< STOFFTextListener > STOFFTextListenerPtr
a smart pointer of STOFFTextListener
Definition: libstaroffice_internal.hxx:497
Definition: STOFFDebug.hxx:210
STOFFParserState(Type type, STOFFInputStreamPtr &input, STOFFHeader *header)
Constructor.
Definition: STOFFParser.cxx:43
STOFFGraphicParser(STOFFInputStreamPtr &input, STOFFHeader *header)
constructor (protected)
Definition: STOFFParser.hxx:218
STOFFHeader * m_header
the header
Definition: STOFFParser.hxx:67
virtual void parse(librevenge::RVNGDrawingInterface *documentInterface)
virtual function used to parse the input
Definition: STOFFParser.cxx:115
STOFFParserStatePtr m_parserState
the parser state
Definition: STOFFParser.hxx:188
Definition: STOFFParser.hxx:53
std::shared_ptr< STOFFInputStream > STOFFInputStreamPtr
a smart pointer of STOFFInputStream
Definition: libstaroffice_internal.hxx:485
virtual class which defines the ancestor of all graphic/presentation zone parser
Definition: STOFFParser.hxx:209
STOFFGraphicListenerPtr m_graphicListener
the graphic listener
Definition: STOFFParser.hxx:74
STOFFSpreadsheetListenerPtr m_spreadsheetListener
the spreadsheet listener
Definition: STOFFParser.hxx:76
a class to define the parser state
Definition: STOFFParser.hxx:49
STOFFParserState & operator=(STOFFParserState const &orig)
std::string m_asciiName
the debug file name
Definition: STOFFParser.hxx:190
std::shared_ptr< STOFFParserState > STOFFParserStatePtr
a smart pointer of STOFFParserState
Definition: libstaroffice_internal.hxx:491
libstoff::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: STOFFParser.hxx:143
Defines STOFFHeader (document's type, version, kind)
STOFFTextParser(STOFFParserStatePtr &state)
constructor using a state
Definition: STOFFParser.hxx:203
virtual void parse(librevenge::RVNGTextInterface *documentInterface)=0
virtual function used to parse the input
void resetTextListener()
resets the text listener
Definition: STOFFParser.cxx:105
void resetGraphicListener()
resets the graphic listener
Definition: STOFFParser.cxx:83
Definition: STOFFParser.hxx:53
STOFFPageSpan const & getPageSpan() const
returns the actual page dimension
Definition: STOFFParser.hxx:118
std::shared_ptr< STOFFSpreadsheetListener > STOFFSpreadsheetListenerPtr
a smart pointer of STOFFSpreadsheetListener
Definition: libstaroffice_internal.hxx:493
STOFFSpreadsheetParser(STOFFInputStreamPtr &input, STOFFHeader *header)
constructor (protected)
Definition: STOFFParser.hxx:233
void setAsciiName(char const *name)
Debugging: change the default ascii file.
Definition: STOFFParser.hxx:171
virtual bool checkHeader(STOFFHeader *header, bool strict=false)=0
virtual function used to check if the document header is correct (or not)
libstoff::DebugFile m_asciiFile
the debug file
Definition: STOFFParser.hxx:81
STOFFGraphicParser(STOFFParserStatePtr &state)
constructor using a state
Definition: STOFFParser.hxx:220
STOFFParser & operator=(const STOFFParser &)
private operator=: forbidden
virtual class which defines the ancestor of all text zone parser
Definition: STOFFParser.hxx:194
STOFFParserStatePtr getParserState()
returns the parser state
Definition: STOFFParser.hxx:103
STOFFHeader * getHeader()
returns the header
Definition: STOFFParser.hxx:108
~STOFFTextParser() override
destructor
Definition: STOFFParser.cxx:129
STOFFTextParser(STOFFInputStreamPtr &input, STOFFHeader *header)
constructor (protected)
Definition: STOFFParser.hxx:201
void setGraphicListener(STOFFGraphicListenerPtr &listener)
sets the graphic listener
Definition: STOFFParser.cxx:78
virtual void parse(librevenge::RVNGSpreadsheetInterface *documentInterface)=0
virtual function used to parse the input
Definition: STOFFParser.hxx:53
void resetSpreadsheetListener()
resets the spreadsheet listener
Definition: STOFFParser.cxx:94
void setVersion(int vers)
sets the document's version
Definition: STOFFParser.hxx:154
std::shared_ptr< STOFFGraphicListener > STOFFGraphicListenerPtr
a smart pointer of STOFFGraphicListener
Definition: libstaroffice_internal.hxx:481
int version() const
returns the works version
Definition: STOFFParser.hxx:98
STOFFListManagerPtr m_listManager
the list manager
Definition: STOFFParser.hxx:72
Definition: STOFFParser.hxx:53
STOFFTextListenerPtr m_textListener
the text listener
Definition: STOFFParser.hxx:78
~STOFFGraphicParser() override
destructor
Definition: STOFFParser.cxx:111
Type m_type
the state type
Definition: STOFFParser.hxx:59
Kind
an enum to define the kind of document
Definition: STOFFDocument.hxx:66
int m_version
the actual version
Definition: STOFFParser.hxx:63
STOFFInputStreamPtr & getInput()
returns the actual input
Definition: STOFFParser.hxx:113
STOFFSpreadsheetParser(STOFFParserStatePtr &state)
constructor using a state
Definition: STOFFParser.hxx:235
STOFFSpreadsheetListenerPtr & getSpreadsheetListener()
returns the spreadsheet listener
Definition: STOFFParser.hxx:133
STOFFGraphicListenerPtr & getGraphicListener()
returns the graphic listener
Definition: STOFFParser.hxx:128
A class which defines the page properties.
Definition: STOFFPageSpan.hxx:75
~STOFFParserState()
destructor
Definition: STOFFParser.cxx:63
void setSpreadsheetListener(STOFFSpreadsheetListenerPtr &listener)
sets the spreadsheet listener
Definition: STOFFParser.cxx:89
virtual class which defines the ancestor of all spreadsheet zone parser
Definition: STOFFParser.hxx:226
STOFFParser(STOFFParserStatePtr &state)
constructor using a state
Definition: STOFFParser.hxx:151
std::shared_ptr< STOFFListManager > STOFFListManagerPtr
a smart pointer of STOFFListManager
Definition: libstaroffice_internal.hxx:489
std::string const & asciiName() const
return the ascii file name
Definition: STOFFParser.hxx:176
STOFFTextListenerPtr & getTextListener()
returns the text listener
Definition: STOFFParser.hxx:138
virtual class which defines the ancestor of all main zone parser
Definition: STOFFParser.hxx:89
STOFFInputStreamPtr m_input
the input
Definition: STOFFParser.hxx:65
~STOFFSpreadsheetParser() override
destructor
Definition: STOFFParser.cxx:125
STOFFParser(STOFFParserState::Type type, STOFFInputStreamPtr input, STOFFHeader *header)
constructor (protected)
Definition: STOFFParser.cxx:67
STOFFDocument::Kind m_kind
the document kind
Definition: STOFFParser.hxx:61

Generated on Sun Mar 24 2019 23:33:12 for libstaroffice by doxygen 1.8.15