ZWrtParser.hxx Source File documentation

ZWrtParser.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 Z_WRT_PARSER
35# define Z_WRT_PARSER
36
37#include <string>
38#include <vector>
39
40#include <librevenge/librevenge.h>
41
42#include "MWAWDebug.hxx"
43#include "MWAWInputStream.hxx"
44
45#include "MWAWParser.hxx"
46
47namespace ZWrtParserInternal
48{
49class SubDocument;
50struct State;
51}
52
53class ZWrtText;
54
56 struct ZWField {
58 ZWField()
59 : m_pos()
60 {
61 }
63 bool getString(MWAWInputStreamPtr &input, std::string &str) const;
65 bool getBool(MWAWInputStreamPtr &input, bool &val) const;
67 bool getInt(MWAWInputStreamPtr &input, int &val) const;
69 bool getFloat(MWAWInputStreamPtr &input, float &val) const;
71 bool getIntList(MWAWInputStreamPtr &input, std::vector<int> &val) const;
72
74 bool getDebugString(MWAWInputStreamPtr &input, std::string &str) const;
75
77 MWAWEntry m_pos;
78};
79
82 class ZWrtParser final : public MWAWTextParser
83{
84 friend class ZWrtParserInternal::SubDocument;
85 friend class ZWrtText;
86public:
88 ZWrtParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
90 ~ZWrtParser() final;
91
93 bool checkHeader(MWAWHeader *header, bool strict=false) final;
94
95 // the main parse function
96 void parse(librevenge::RVNGTextInterface *documentInterface) final;
97
98protected:
100 void init();
101
103 void createDocument(librevenge::RVNGTextInterface *documentInterface);
104
106 MWAWVec2f getPageLeftTop() const;
108 void newPage(int number);
109
110 // interface with the text parser
111
113 bool sendHeaderFooter(bool header);
114
115protected:
117 bool createZones();
118
120 bool readBarState(MWAWEntry const &entry);
122 bool readHTMLPref(MWAWEntry const &entry);
124 bool readPrintInfo(MWAWEntry const &entry);
126 bool readCPRT(MWAWEntry const &entry);
128 bool readSectionRange(MWAWEntry const &entry);
130 bool readWindowPos(MWAWEntry const &entry);
131
133 bool readUnknownZone(MWAWEntry const &entry);
134
136 bool readCPos(MWAWEntry const &entry);
138 bool readSLen(MWAWEntry const &entry);
139
141 bool getFieldList(MWAWEntry const &entry, std::vector<ZWField> &list);
142
144 MWAWInputStreamPtr rsrcInput();
145
147 libmwaw::DebugFile &rsrcAscii();
148
149 //
150 // data
151 //
152
154 std::shared_ptr<ZWrtParserInternal::State> m_state;
155
157 std::shared_ptr<ZWrtText> m_textParser;
158};
159#endif
160// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWParser.hxx
MWAWEntry
basic class to store an entry in a file This contained :
Definition MWAWEntry.hxx:47
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition MWAWHeader.hxx:57
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition MWAWParser.hxx:299
MWAWVec2< float >
ZWrtParserInternal::SubDocument
Internal: the subdocument of a ZWrtParser.
Definition ZWrtParser.cxx:84
ZWrtParser
the main class to read a ZWrite file
Definition ZWrtParser.hxx:83
ZWrtParser::sendHeaderFooter
bool sendHeaderFooter(bool header)
try to send the header/footer
Definition ZWrtParser.cxx:180
ZWrtParser::readWindowPos
bool readWindowPos(MWAWEntry const &entry)
read the window position
Definition ZWrtParser.cxx:658
ZWrtParser::init
void init()
inits all internal variables
Definition ZWrtParser.cxx:145
ZWrtParser::newPage
void newPage(int number)
adds a new page
Definition ZWrtParser.cxx:192
ZWrtParser::readSLen
bool readSLen(MWAWEntry const &entry)
read a section length ?
Definition ZWrtParser.cxx:782
ZWrtParser::ZWrtParser
ZWrtParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition ZWrtParser.cxx:133
ZWrtParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition ZWrtParser.cxx:208
ZWrtParser::getFieldList
bool getFieldList(MWAWEntry const &entry, std::vector< ZWField > &list)
returns a list of field
Definition ZWrtParser.cxx:905
ZWrtParser::readPrintInfo
bool readPrintInfo(MWAWEntry const &entry)
read a PrintInfo block
Definition ZWrtParser.cxx:353
ZWrtParser::m_textParser
std::shared_ptr< ZWrtText > m_textParser
the text parser
Definition ZWrtParser.hxx:157
ZWrtParser::readCPRT
bool readCPRT(MWAWEntry const &entry)
try to read a xml printinfo zone
Definition ZWrtParser.cxx:462
ZWrtParser::m_state
std::shared_ptr< ZWrtParserInternal::State > m_state
the state
Definition ZWrtParser.hxx:154
ZWrtParser::getPageLeftTop
MWAWVec2f getPageLeftTop() const
returns the page left top point ( in inches)
Definition ZWrtParser.cxx:171
ZWrtParser::readCPos
bool readCPos(MWAWEntry const &entry)
read a cursor position in a section?
Definition ZWrtParser.cxx:732
ZWrtParser::rsrcAscii
libmwaw::DebugFile & rsrcAscii()
a DebugFile used to write what we recognize when we parse the document in rsrc
Definition ZWrtParser.cxx:163
ZWrtParser::readHTMLPref
bool readHTMLPref(MWAWEntry const &entry)
read the html export pref
Definition ZWrtParser.cxx:538
ZWrtParser::readSectionRange
bool readSectionRange(MWAWEntry const &entry)
read the section range block
Definition ZWrtParser.cxx:604
ZWrtParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition ZWrtParser.cxx:235
ZWrtParser::readBarState
bool readBarState(MWAWEntry const &entry)
read the bar state
Definition ZWrtParser.cxx:492
ZWrtParser::rsrcInput
MWAWInputStreamPtr rsrcInput()
return the input input
Definition ZWrtParser.cxx:158
ZWrtParser::readUnknownZone
bool readUnknownZone(MWAWEntry const &entry)
read a unknown block
Definition ZWrtParser.cxx:834
ZWrtParser::createZones
bool createZones()
finds the different objects zones
Definition ZWrtParser.cxx:276
ZWrtParser::~ZWrtParser
~ZWrtParser() final
destructor
Definition ZWrtParser.cxx:141
ZWrtParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition ZWrtParser.cxx:880
ZWrtText
the main class to read the text part of ZWrite Text file
Definition ZWrtText.hxx:59
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition libmwaw_internal.hxx:561
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition libmwaw_internal.hxx:551
ZWrtParserInternal
Internal: the structures of a ZWrtParser.
Definition ZWrtParser.cxx:56
libmwaw
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition libmwaw_internal.cxx:51
librevenge
Definition MWAWDocument.hxx:57
ZWField
a structure to store a field of a ZWrite file
Definition ZWrtParser.hxx:56
ZWField::getFloat
bool getFloat(MWAWInputStreamPtr &input, float &val) const
returns the float corresponding to a field
Definition ZWrtParser.cxx:1018
ZWField::ZWField
ZWField()
constructor
Definition ZWrtParser.hxx:58
ZWField::getIntList
bool getIntList(MWAWInputStreamPtr &input, std::vector< int > &val) const
returns a list of int corresponding to a field
Definition ZWrtParser.cxx:1032
ZWField::getDebugString
bool getDebugString(MWAWInputStreamPtr &input, std::string &str) const
returns a debug string corresponding to a field ( replacing \n by ##[0d], ...)
Definition ZWrtParser.cxx:950
ZWField::m_pos
MWAWEntry m_pos
the field position in the rsrc data file
Definition ZWrtParser.hxx:77
ZWField::getInt
bool getInt(MWAWInputStreamPtr &input, int &val) const
returns the int corresponding to a field
Definition ZWrtParser.cxx:989
ZWField::getString
bool getString(MWAWInputStreamPtr &input, std::string &str) const
returns the string corresponding to a field
Definition ZWrtParser.cxx:932
ZWField::getBool
bool getBool(MWAWInputStreamPtr &input, bool &val) const
returns the boolean corresponding to a field ( T or F )
Definition ZWrtParser.cxx:968