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 
48 class WPXDocumentInterface;
49 
52 {
53 public:
54  // Constructor
58 
60  int m_version;
67 
74 
77 
78 private:
79  MWAWParserState(MWAWParserState const &orig);
81 };
82 
88 {
89 public:
91  virtual ~MWAWParser();
93  virtual void parse(WPXDocumentInterface *documentInterface) = 0;
95  virtual bool checkHeader(MWAWHeader *header, bool strict=false) = 0;
96 
98  int version() const {
99  return m_parserState->m_version;
100  }
102  void setVersion(int vers) {
103  m_parserState->m_version = vers;
104  }
105 
106 protected:
108  MWAWParser(MWAWInputStreamPtr input, MWAWRSRCParserPtr rsrcParser, MWAWHeader *header);
111 
114  return m_parserState;
115  }
118  return m_parserState->m_header;
119  }
122  return m_parserState->m_input;
123  }
126  return m_parserState->m_listener;
127  }
129  MWAWPageSpan const &getPageSpan() const {
130  return m_pageSpan;
131  }
134  return m_pageSpan;
135  }
137  double getFormLength() const {
138  return m_pageSpan.getFormLength();
139  }
141  double getFormWidth() const {
142  return m_pageSpan.getFormWidth();
143  }
145  double getPageLength() const {
146  return m_pageSpan.getPageLength();
147  }
149  double getPageWidth() const {
150  return m_pageSpan.getPageWidth();
151  }
154  return m_parserState->m_rsrcParser;
155  }
157  void setListener(MWAWContentListenerPtr &listener);
159  void resetListener();
162  return m_parserState->m_fontConverter;
163  }
165  void setFontConverter(MWAWFontConverterPtr fontConverter);
168  return m_parserState->m_asciiFile;
169  }
171  void setAsciiName(char const *name) {
172  m_asciiName = name;
173  }
175  std::string const &asciiName() const {
176  return m_asciiName;
177  }
178 
179 private:
181  MWAWParser(const MWAWParser &);
183  MWAWParser &operator=(const MWAWParser &);
184 
190  std::string m_asciiName;
191 };
192 
193 #endif /* MWAWPARSER_H */
194 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
a function used by MWAWDocument to store the version of document and the input
Definition: MWAWHeader.hxx:47
virtual void parse(WPXDocumentInterface *documentInterface)=0
virtual function used to parse the input
std::string const & asciiName() const
return the ascii file name
Definition: MWAWParser.hxx:175
MWAWParserState & operator=(MWAWParserState const &orig)
double getPageWidth() const
returns the page width (form width without margin )
Definition: MWAWParser.hxx:149
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:95
MWAWParserState(MWAWInputStreamPtr input, MWAWRSRCParserPtr rsrcParser, MWAWHeader *header)
Definition: MWAWParser.cxx:40
MWAWHeader * m_header
the header
Definition: MWAWParser.hxx:64
MWAWContentListenerPtr & getListener()
returns the listener
Definition: MWAWParser.hxx:125
an interface used to insert comment in a binary file, written in ascii form (if debug_with_files is n...
Definition: MWAWDebug.hxx:67
void setVersion(int vers)
sets the works version
Definition: MWAWParser.hxx:102
MWAWRSRCParserPtr & getRSRCParser()
returns the rsrc parser
Definition: MWAWParser.hxx:153
MWAWPageSpan const & getPageSpan() const
returns the actual page dimension
Definition: MWAWParser.hxx:129
double getFormLength() const
returns the form length
Definition: MWAWParser.hxx:137
MWAWHeader * getHeader()
returns the header
Definition: MWAWParser.hxx:117
void resetListener()
resets the listener
Definition: MWAWParser.cxx:83
MWAWParserStatePtr m_parserState
the parser state
Definition: MWAWParser.hxx:186
void setListener(MWAWContentListenerPtr &listener)
sets the listener
Definition: MWAWParser.cxx:78
MWAWParser(MWAWInputStreamPtr input, MWAWRSRCParserPtr rsrcParser, MWAWHeader *header)
constructor (protected)
Definition: MWAWParser.cxx:68
MWAWParser & operator=(const MWAWParser &)
private operator=: forbidden
MWAWParser(MWAWParserStatePtr state)
constructor using a state
Definition: MWAWParser.hxx:110
~MWAWParserState()
destructor
Definition: MWAWParser.cxx:49
MWAWFontConverterPtr & getFontConverter()
returns the font converter
Definition: MWAWParser.hxx:161
double getPageLength() const
returns the page length (form width without margin )
Definition: MWAWPageSpan.hxx:140
void setAsciiName(char const *name)
Debugging: change the default ascii file.
Definition: MWAWParser.hxx:171
a class to define the parser state
Definition: MWAWParser.hxx:51
shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:340
libmwaw::DebugFile m_asciiFile
the debug file
Definition: MWAWParser.hxx:76
int m_version
the actual version
Definition: MWAWParser.hxx:60
double getFormWidth() const
returns the page width
Definition: MWAWPageSpan.hxx:116
libmwaw::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: MWAWParser.hxx:167
MWAWParserStatePtr getParserState()
returns the parser state
Definition: MWAWParser.hxx:113
MWAWListManagerPtr m_listManager
the list manager
Definition: MWAWParser.hxx:71
int version() const
returns the works version
Definition: MWAWParser.hxx:98
double getPageLength() const
returns the page length (form length without margin )
Definition: MWAWParser.hxx:145
double getFormLength() const
returns the page length
Definition: MWAWPageSpan.hxx:112
shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:336
virtual ~MWAWParser()
virtual destructor
Definition: MWAWParser.cxx:74
MWAWPageSpan & getPageSpan()
returns the actual page dimension
Definition: MWAWParser.hxx:133
shared_ptr< MWAWFontConverter > MWAWFontConverterPtr
a smart pointer of MWAWFontConverter
Definition: libmwaw_internal.hxx:334
shared_ptr< MWAWContentListener > MWAWContentListenerPtr
a smart pointer of MWAWContentListener
Definition: libmwaw_internal.hxx:330
double getFormWidth() const
returns the form width
Definition: MWAWParser.hxx:141
std::string m_asciiName
the debug file name
Definition: MWAWParser.hxx:190
MWAWRSRCParserPtr m_rsrcParser
the resource parser
Definition: MWAWParser.hxx:66
shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:342
void setFontConverter(MWAWFontConverterPtr fontConverter)
sets the font convertor
Definition: MWAWParser.cxx:89
double getPageWidth() const
returns the page width (form width without margin )
Definition: MWAWPageSpan.hxx:144
virtual class which defines the ancestor of all main zone parser
Definition: MWAWParser.hxx:87
MWAWPageSpan m_pageSpan
the actual document size
Definition: MWAWParser.hxx:188
MWAWFontConverterPtr m_fontConverter
the fonct converter
Definition: MWAWParser.hxx:69
MWAWInputStreamPtr m_input
the input
Definition: MWAWParser.hxx:62
virtual bool checkHeader(MWAWHeader *header, bool strict=false)=0
virtual function used to check if the document header is correct (or not)
MWAWContentListenerPtr m_listener
the listener
Definition: MWAWParser.hxx:73
shared_ptr< MWAWListManager > MWAWListManagerPtr
a smart pointer of MWAWListManager
Definition: libmwaw_internal.hxx:338
MWAWInputStreamPtr & getInput()
returns the actual input
Definition: MWAWParser.hxx:121

Generated on Tue Jun 24 2014 16:46:27 for libmwaw by doxygen 1.8.5