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
47 namespace ZWrtParserInternal
48 {
49 class SubDocument;
50 struct State;
51 }
52
53 class 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;
86 public:
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
98 protected:
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
115 protected:
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:
MWAWTextListenerPtr
std::shared_ptr< MWAWTextListener > MWAWTextListenerPtr
a smart pointer of MWAWTextListener
Definition: libmwaw_internal.hxx:567
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
ZWrtParser::readWindowPos
bool readWindowPos(MWAWEntry const &entry)
read the window position
Definition: ZWrtParser.cxx:658
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:298
ZWrtParserInternal::State
Internal: the state of a ZWrtParser.
Definition: ZWrtParser.cxx:59
ZWrtParserInternal::State::State
State()
constructor
Definition: ZWrtParser.cxx:61
ZWField::ZWField
ZWField()
constructor
Definition: ZWrtParser.hxx:58
ZWrtParser::ZWrtParser
ZWrtParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: ZWrtParser.cxx:133
MWAWPageSpan::setPageSpan
void setPageSpan(const int pageSpan)
set the page span ( default 1)
Definition: MWAWPageSpan.hxx:268
MWAWHeaderFooter::HEADER
@ HEADER
Definition: MWAWPageSpan.hxx:48
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
ZWField
a structure to store a field of a ZWrite file
Definition: ZWrtParser.hxx:56
MWAWVec2f
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:842
ZWrtParser::m_textParser
std::shared_ptr< ZWrtText > m_textParser
the text parser
Definition: ZWrtParser.hxx:157
ZWField::getBool
bool getBool(MWAWInputStreamPtr &input, bool &val) const
returns the boolean corresponding to a field ( T or F )
Definition: ZWrtParser.cxx:968
ZWField::m_pos
MWAWEntry m_pos
the field position in the rsrc data file
Definition: ZWrtParser.hxx:77
ZWrtParser::init
void init()
inits all internal variables
Definition: ZWrtParser.cxx:145
MWAWTextListener
This class contents the main functions needed to create a Word processing Document.
Definition: MWAWTextListener.hxx:64
MWAWEntry::id
int id() const
returns the id
Definition: MWAWEntry.hxx:164
MWAWPageSpan::setMarginBottom
void setMarginBottom(const double marginBottom)
set the page bottom margin
Definition: MWAWPageSpan.hxx:208
ZWrtParserInternal::State::m_headerUsed
bool m_headerUsed
true if the header is used
Definition: ZWrtParser.cxx:74
ZWrtParser::readHTMLPref
bool readHTMLPref(MWAWEntry const &entry)
read the html export pref
Definition: ZWrtParser.cxx:538
MWAWFontConverter.hxx
ZWField::getString
bool getString(MWAWInputStreamPtr &input, std::string &str) const
returns the string corresponding to a field
Definition: ZWrtParser.cxx:932
ZWrtParserInternal::State::m_footerUsed
bool m_footerUsed
true if the footer is used
Definition: ZWrtParser.cxx:76
ZWrtParserInternal::SubDocument::operator!=
bool operator!=(MWAWSubDocument const &doc) const final
operator!=
Definition: ZWrtParser.cxx:96
ZWField::getFloat
bool getFloat(MWAWInputStreamPtr &input, float &val) const
returns the float corresponding to a field
Definition: ZWrtParser.cxx:1018
ZWrtParserInternal::SubDocument::parse
void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType type) final
the parser function
Definition: ZWrtParser.cxx:113
MWAWPrinter.hxx
MWAWPageSpan::setMarginLeft
void setMarginLeft(const double marginLeft)
set the page left margin
Definition: MWAWPageSpan.hxx:193
ZWrtParser::readSectionRange
bool readSectionRange(MWAWEntry const &entry)
read the section range block
Definition: ZWrtParser.cxx:604
MWAWHeaderFooter::m_subDocument
MWAWSubDocumentPtr m_subDocument
the document data
Definition: MWAWPageSpan.hxx:92
ZWrtParser
the main class to read a ZWrite file
Definition: ZWrtParser.hxx:82
MWAWEntry::setParsed
void setParsed(bool ok=true) const
sets the flag m_parsed to true or false
Definition: MWAWEntry.hxx:126
MWAWParser::getTextListener
MWAWTextListenerPtr & getTextListener()
returns the text listener
Definition: MWAWParser.hxx:145
libmwaw::DebugFile::addNote
void addNote(char const *note)
adds a note in the file, in actual position
Definition: MWAWDebug.cxx:59
MWAWSubDocument
abstract class used to store a subdocument (with a comparison function)
Definition: MWAWSubDocument.hxx:41
MWAWEntry::type
const std::string & type() const
returns the type of the entry
Definition: MWAWEntry.hxx:137
ZWrtParserInternal::State::m_headerHeight
int m_headerHeight
the header height if known
Definition: ZWrtParser.cxx:77
MWAWHeaderFooter
a class which stores the header/footer data
Definition: MWAWPageSpan.hxx:44
ZWrtParserInternal
Internal: the structures of a ZWrtParser.
Definition: ZWrtParser.cxx:55
MWAWSubDocument.hxx
ZWrtParser::ZWrtText
friend class ZWrtText
Definition: ZWrtParser.hxx:85
libmwaw::SubDocumentType
SubDocumentType
Definition: libmwaw_internal.hxx:188
ZWrtParserInternal::SubDocument::~SubDocument
~SubDocument() final
destructor
Definition: ZWrtParser.cxx:93
ZWrtParser::sendHeaderFooter
bool sendHeaderFooter(bool header)
try to send the header/footer
Definition: ZWrtParser.cxx:180
MWAWParser::setTextListener
void setTextListener(MWAWTextListenerPtr &listener)
sets the text listener
Definition: MWAWParser.cxx:158
ZWField::getIntList
bool getIntList(MWAWInputStreamPtr &input, std::vector< int > &val) const
returns a list of int corresponding to a field
Definition: ZWrtParser.cxx:1032
MWAWParser::setAsciiName
void setAsciiName(char const *name)
Debugging: change the default ascii file.
Definition: MWAWParser.hxx:227
libmwaw::DebugFile::skipZone
void skipZone(long beginPos, long endPos)
skips the file zone defined by beginPos-endPos
Definition: MWAWDebug.hxx:113
MWAWRSRCParser.hxx
MWAWParser::getRSRCParser
MWAWRSRCParserPtr & getRSRCParser()
returns the rsrc parser
Definition: MWAWParser.hxx:190
MWAWParser::getPageSpan
const MWAWPageSpan & getPageSpan() const
returns the actual page dimension
Definition: MWAWParser.hxx:160
libmwaw::Debug::dumpFile
bool dumpFile(librevenge::RVNGBinaryData &data, char const *fileName)
a debug function to store in a datafile in the current directory WARNING: this function erase the fil...
Definition: MWAWDebug.cxx:193
MWAWPosition.hxx
MWAWEntry::setEnd
void setEnd(long off)
sets the end offset
Definition: MWAWEntry.hxx:77
ZWField::getInt
bool getInt(MWAWInputStreamPtr &input, int &val) const
returns the int corresponding to a field
Definition: ZWrtParser.cxx:989
MWAWEntry::setBegin
void setBegin(long off)
sets the begin offset
Definition: MWAWEntry.hxx:67
ZWrtParser::rsrcInput
MWAWInputStreamPtr rsrcInput()
return the input input
Definition: ZWrtParser.cxx:158
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
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:561
MWAWEntry::length
long length() const
returns the length of the zone
Definition: MWAWEntry.hxx:93
ZWrtText
the main class to read the text part of ZWrite Text file
Definition: ZWrtText.hxx:58
ZWrtParser::readBarState
bool readBarState(MWAWEntry const &entry)
read the bar state
Definition: ZWrtParser.cxx:492
MWAWListener::PageBreak
@ PageBreak
Definition: MWAWListener.hxx:58
MWAWVec2< float >
ZWrtParser::newPage
void newPage(int number)
adds a new page
Definition: ZWrtParser.cxx:192
libmwaw::ParseException
Definition: libmwaw_internal.hxx:143
MWAWDebug.hxx
ZWrtParser.hxx
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:56
MWAWEntry::begin
long begin() const
returns the begin offset
Definition: MWAWEntry.hxx:83
ZWrtParser::getPageLeftTop
MWAWVec2f getPageLeftTop() const
returns the page left top point ( in inches)
Definition: ZWrtParser.cxx:171
MWAWPageSpan::setMarginTop
void setMarginTop(const double marginTop)
set the page top margin
Definition: MWAWPageSpan.hxx:203
MWAWHeaderFooter::FOOTER
@ FOOTER
Definition: MWAWPageSpan.hxx:48
ZWrtParser::m_state
std::shared_ptr< ZWrtParserInternal::State > m_state
the state
Definition: ZWrtParser.hxx:154
ZWrtParserInternal::State::m_numPages
int m_numPages
the number of page of the final document
Definition: ZWrtParser.cxx:71
MWAWParser::getParserState
MWAWParserStatePtr getParserState()
returns the parser state
Definition: MWAWParser.hxx:113
ZWrtParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: ZWrtParser.cxx:880
MWAWHeader.hxx
ZWrtParser::createZones
bool createZones()
finds the different objects zones
Definition: ZWrtParser.cxx:276
MWAWEntry::end
long end() const
returns the end offset
Definition: MWAWEntry.hxx:88
MWAWHeaderFooter::ALL
@ ALL
Definition: MWAWPageSpan.hxx:50
ZWrtParser::getFieldList
bool getFieldList(MWAWEntry const &entry, std::vector< ZWField > &list)
returns a list of field
Definition: ZWrtParser.cxx:905
ZWrtParserInternal::SubDocument::m_isHeader
int m_isHeader
true if we need to send the parser
Definition: ZWrtParser.cxx:110
MWAWParser::getInput
MWAWInputStreamPtr & getInput()
returns the actual input
Definition: MWAWParser.hxx:123
ZWrtParserInternal::SubDocument
Internal: the subdocument of a ZWrtParser.
Definition: ZWrtParser.cxx:83
MWAWTextListener.hxx
ZWrtParser::readSLen
bool readSLen(MWAWEntry const &entry)
read a section length ?
Definition: ZWrtParser.cxx:782
MWAWSubDocument::m_parser
MWAWParser * m_parser
the main zone parser
Definition: MWAWSubDocument.hxx:75
ZWrtParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: ZWrtParser.cxx:235
libmwaw::DebugFile::addPos
void addPos(long pos)
adds a new position in the file
Definition: MWAWDebug.cxx:53
MWAWPageSpan::setMarginRight
void setMarginRight(const double marginRight)
set the page right margin
Definition: MWAWPageSpan.hxx:198
MWAWEntry::valid
bool valid() const
returns true if the zone length is positive
Definition: MWAWEntry.hxx:99
ZWrtParser::readCPRT
bool readCPRT(MWAWEntry const &entry)
try to read a xml printinfo zone
Definition: ZWrtParser.cxx:462
MWAWPageSpan::setHeaderFooter
void setHeaderFooter(MWAWHeaderFooter const &headerFooter)
add a header/footer on some page
Definition: MWAWPageSpan.cxx:227
ZWrtParser::readUnknownZone
bool readUnknownZone(MWAWEntry const &entry)
read a unknown block
Definition: ZWrtParser.cxx:834
ZWrtParserInternal::State::m_footerHeight
int m_footerHeight
the footer height if known
Definition: ZWrtParser.cxx:78
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
ZWrtParserInternal::State::m_actPage
int m_actPage
the actual page
Definition: ZWrtParser.cxx:71
libmwaw
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libmwaw_internal.cxx:50
ZWrtText.hxx
MWAWInputStream.hxx
ZWrtParser::readCPos
bool readCPos(MWAWEntry const &entry)
read a cursor position in a section?
Definition: ZWrtParser.cxx:732
MWAWHeader::reset
void reset(MWAWDocument::Type type, int vers, Kind kind=MWAWDocument::MWAW_K_TEXT)
resets the data
Definition: MWAWHeader.hxx:84
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
librevenge
Definition: MWAWDocument.hxx:56
ZWrtParserInternal::SubDocument::SubDocument
SubDocument(ZWrtParser &pars, MWAWInputStreamPtr const &input, bool header)
Definition: ZWrtParser.cxx:86
MWAWPageSpan::setMargins
void setMargins(double margin, int wh=libmwaw::LeftBit|libmwaw::RightBit|libmwaw::TopBit|libmwaw::BottomBit)
set all the margins
Definition: MWAWPageSpan.hxx:213
ZWrtParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: ZWrtParser.cxx:208
ZWrtParser::~ZWrtParser
~ZWrtParser() final
destructor
Definition: ZWrtParser.cxx:141
ZWrtParser::readPrintInfo
bool readPrintInfo(MWAWEntry const &entry)
read a PrintInfo block
Definition: ZWrtParser.cxx:353
libmwaw::DebugStream
std::stringstream DebugStream
a basic stream (if debug_with_files is not defined, does nothing)
Definition: MWAWDebug.hxx:61
MWAWParser.hxx
MWAWPageSpan
A class which defines the page properties.
Definition: MWAWPageSpan.hxx:98
MWAWDocument::MWAW_T_ZWRITE
@ MWAW_T_ZWRITE
Z-Write (v1.3)
Definition: MWAWDocument.hxx:159
MWAWParser::resetTextListener
void resetTextListener()
resets the listener
Definition: MWAWParser.cxx:163
ZWrtParser::rsrcAscii
libmwaw::DebugFile & rsrcAscii()
a DebugFile used to write what we recognize when we parse the document in rsrc
Definition: ZWrtParser.cxx:163