MoreParser.hxx Source File documentation

MoreParser.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 MORE_PARSER
35 # define MORE_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 MoreParserInternal
48 {
49 class SubDocument;
50 struct State;
51 }
52
53 class MoreText;
54
57 namespace MoreStruct
58 {
59 struct Pattern {
61 Pattern()
62 : m_frontColor(MWAWColor::black())
63 , m_backColor(MWAWColor::white())
64 {
65 for (auto &val : m_pattern) val=0;
66 }
68 friend std::ostream &operator<<(std::ostream &o, Pattern const &pat);
70 unsigned char m_pattern[8];
72 MWAWColor m_frontColor;
74 MWAWColor m_backColor;
75 };
76 }
77
80 class MoreParser final : public MWAWTextParser
81 {
82 friend class MoreParserInternal::SubDocument;
83 friend class MoreText;
84 public:
86 MoreParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
88 ~MoreParser() final;
89
91 bool checkHeader(MWAWHeader *header, bool strict=false) final;
92
93 // the main parse function
94 void parse(librevenge::RVNGTextInterface *documentInterface) final;
95
96 protected:
98 void init();
99
101 void createDocument(librevenge::RVNGTextInterface *documentInterface);
102
104 MWAWVec2f getPageLeftTop() const;
106 void newPage(int number);
108 bool getColor(int id, MWAWColor &col) const;
109
110 // interface with the text parser
111
112 protected:
114 bool createZones();
115
117 bool readZonesList();
118
120 bool readPrintInfo(MWAWEntry const &entry);
121
123 bool readDocumentInfo(MWAWEntry const &entry);
124
126 bool readSlideList(MWAWEntry const &entry);
127
129 bool readSlide(MWAWEntry const &entry);
130
132 bool readGraphic(MWAWEntry const &entry);
133
135 bool readUnknown9(MWAWEntry const &entry);
136
138 bool readColors(long endPos);
139
141 bool readPattern(long endPos, MoreStruct::Pattern &pattern);
142
144 bool readBackside(long endPos, std::string &extra);
145
147 bool readFreePos(MWAWEntry const &entry);
148
150 bool readUnkn9Sub(long endPos);
151
152 //
153 // low level
154 //
155
157 bool checkAndStore(MWAWEntry const &entry);
158
160 bool checkAndFindSize(MWAWEntry &entry);
161
163 MWAWInputStreamPtr rsrcInput();
164
166 libmwaw::DebugFile &rsrcAscii();
167
168 //
169 // data
170 //
171
173 std::shared_ptr<MoreParserInternal::State> m_state;
174
176 std::shared_ptr<MoreText> m_textParser;
177 };
178 #endif
179 // 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
MoreStruct::Pattern::operator<<
friend std::ostream & operator<<(std::ostream &o, Pattern const &pat)
operator<<
Definition: MoreParser.cxx:1280
MoreParser::readSlideList
bool readSlideList(MWAWEntry const &entry)
read the list of slide definitions
Definition: MoreParser.cxx:774
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:551
MoreStruct::Pattern::Pattern
Pattern()
constructor
Definition: MoreParser.hxx:61
MWAWTextParser
virtual class which defines the ancestor of all text zone parser
Definition: MWAWParser.hxx:298
MoreParser::readUnknown9
bool readUnknown9(MWAWEntry const &entry)
read a unknown zone ( block 9 )
Definition: MoreParser.cxx:974
MoreParserInternal::SubDocument::~SubDocument
~SubDocument() final
destructor
Definition: MoreParser.cxx:112
MoreParserInternal::State::m_typeEntryMap
std::multimap< std::string, MWAWEntry > m_typeEntryMap
a map type -> entry
Definition: MoreParser.cxx:76
MoreParser::~MoreParser
~MoreParser() final
destructor
Definition: MoreParser.cxx:151
MoreStruct::operator<<
std::ostream & operator<<(std::ostream &o, Pattern const &pat)
Definition: MoreParser.cxx:1280
MoreText
the main class to read the text part of More Text file
Definition: MoreText.hxx:64
MWAWDocument::MWAW_T_MORE
@ MWAW_T_MORE
More (v2-3): retrieve the organization part but not the slide/tree parts.
Definition: MWAWDocument.hxx:129
MWAWPageSpan::setPageSpan
void setPageSpan(const int pageSpan)
set the page span ( default 1)
Definition: MWAWPageSpan.hxx:268
MoreParser::readBackside
bool readBackside(long endPos, std::string &extra)
read a backside ( some sub zone of block 9)
Definition: MoreParser.cxx:1102
MWAWHeaderFooter::HEADER
@ HEADER
Definition: MWAWPageSpan.hxx:48
MWAW_DEBUG_MSG
#define MWAW_DEBUG_MSG(M)
Definition: libmwaw_internal.hxx:129
MWAWVec2f
MWAWVec2< float > MWAWVec2f
MWAWVec2 of float.
Definition: libmwaw_internal.hxx:842
libmwaw::DebugFile::addDelimiter
void addDelimiter(long pos, char c)
adds a not breaking delimiter in position pos
Definition: MWAWDebug.cxx:73
MoreStruct::Pattern::m_backColor
MWAWColor m_backColor
the back color
Definition: MoreParser.hxx:74
MWAWEntry::isParsed
bool isParsed() const
a flag to know if the entry was parsed or not
Definition: MWAWEntry.hxx:121
MWAWTextListener
This class contents the main functions needed to create a Word processing Document.
Definition: MWAWTextListener.hxx:64
MoreStruct::Pattern::m_pattern
unsigned char m_pattern[8]
the pattern
Definition: MoreParser.hxx:70
libmwaw::DebugFile::open
bool open(std::string const &filename)
opens/creates a file to store a result
Definition: MWAWDebug.cxx:46
MoreParser
the main class to read a More file
Definition: MoreParser.hxx:80
MoreParserInternal::State::setDefaultColorList
void setDefaultColorList(int version)
set the default color map
Definition: MoreParser.cxx:84
MWAWPageSpan::setMarginBottom
void setMarginBottom(const double marginBottom)
set the page bottom margin
Definition: MWAWPageSpan.hxx:208
MoreParser::readPrintInfo
bool readPrintInfo(MWAWEntry const &entry)
read a PrintInfo zone ( first block )
Definition: MoreParser.cxx:459
MWAWFontConverter.hxx
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192
MoreParser::readDocumentInfo
bool readDocumentInfo(MWAWEntry const &entry)
read a docinfo zone ( second block )
Definition: MoreParser.cxx:512
MWAWSubDocumentPtr
std::shared_ptr< MWAWSubDocument > MWAWSubDocumentPtr
a smart pointer of MWAWSubDocument
Definition: libmwaw_internal.hxx:565
MWAWParser::version
int version() const
returns the works version
Definition: MWAWParser.hxx:108
MWAWPrinter.hxx
MoreParserInternal::SubDocument
Internal: the subdocument of a MoreParser.
Definition: MoreParser.cxx:103
MWAWPageSpan::setMarginLeft
void setMarginLeft(const double marginLeft)
set the page left margin
Definition: MWAWPageSpan.hxx:193
MWAWColor::str
std::string str() const
print the color in the form #rrggbb
Definition: libmwaw_internal.cxx:232
MoreParser::MoreParser
MoreParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: MoreParser.cxx:143
MoreParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition: MoreParser.cxx:249
MWAWHeaderFooter::m_subDocument
MWAWSubDocumentPtr m_subDocument
the document data
Definition: MWAWPageSpan.hxx:92
libmwaw::PrinterInfo
the AppleŠ printer information : TPrint
Definition: MWAWPrinter.hxx:82
MoreStruct::Pattern
Definition: MoreParser.hxx:59
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
MoreParser::readSlide
bool readSlide(MWAWEntry const &entry)
read a slide definitions
Definition: MoreParser.cxx:835
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
MWAWParser::ascii
libmwaw::DebugFile & ascii()
a DebugFile used to write what we recognize when we parse the document
Definition: MWAWParser.hxx:195
MoreParser::newPage
void newPage(int number)
adds a new page
Definition: MoreParser.cxx:220
MWAWHeaderFooter
a class which stores the header/footer data
Definition: MWAWPageSpan.hxx:44
MoreParser::createZones
bool createZones()
finds the different objects zones
Definition: MoreParser.cxx:322
MoreParser::m_textParser
std::shared_ptr< MoreText > m_textParser
the text parser
Definition: MoreParser.hxx:176
MoreStruct::Pattern::m_frontColor
MWAWColor m_frontColor
the front color
Definition: MoreParser.hxx:72
MoreParser::getColor
bool getColor(int id, MWAWColor &col) const
return the color which corresponds to an id (if possible)
Definition: MoreParser.cxx:233
MoreParserInternal::State::m_actPage
int m_actPage
the actual page
Definition: MoreParser.cxx:81
MWAWSubDocument.hxx
MoreParserInternal::SubDocument::SubDocument
SubDocument(MoreParser &pars, MWAWInputStreamPtr const &input)
Definition: MoreParser.cxx:106
MWAWPageSpan::setFormLength
void setFormLength(const double formLength)
set the total page length
Definition: MWAWPageSpan.hxx:178
MoreParser::readFreePos
bool readFreePos(MWAWEntry const &entry)
read the list of free file position
Definition: MoreParser.cxx:627
MoreParserInternal::State::State
State()
constructor
Definition: MoreParser.cxx:64
MoreParser::rsrcAscii
libmwaw::DebugFile & rsrcAscii()
a DebugFile used to write what we recognize when we parse the document in rsrc
Definition: MoreParser.cxx:173
libmwaw::SubDocumentType
SubDocumentType
Definition: libmwaw_internal.hxx:188
MWAWPageSpan::setBackgroundColor
void setBackgroundColor(MWAWColor color=MWAWColor::white())
set the background color
Definition: MWAWPageSpan.hxx:258
libmwaw::DebugFile::reset
void reset()
writes the current file and reset to zero
Definition: MWAWDebug.hxx:93
MoreStruct
a namespace used to define basic structures in a More file
Definition: MoreParser.cxx:1278
MWAWEntry::setType
void setType(std::string const &newType)
sets the type of the entry: BTEP,FDPP, BTEC, FDPC, PLC , TEXT, ...
Definition: MWAWEntry.hxx:132
MWAWParser::setTextListener
void setTextListener(MWAWTextListenerPtr &listener)
sets the text listener
Definition: MWAWParser.cxx:158
MWAWParser::setAsciiName
void setAsciiName(char const *name)
Debugging: change the default ascii file.
Definition: MWAWParser.hxx:227
MWAWParagraph.hxx
libmwaw::DebugFile::skipZone
void skipZone(long beginPos, long endPos)
skips the file zone defined by beginPos-endPos
Definition: MWAWDebug.hxx:113
MWAWRSRCParser.hxx
MWAWVec2::y
T y() const
second element
Definition: libmwaw_internal.hxx:673
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
MWAWPageSpan::setFormWidth
void setFormWidth(const double formWidth)
set the total page width
Definition: MWAWPageSpan.hxx:183
MWAWPosition.hxx
MWAWParser::getFormLength
double getFormLength() const
returns the form length
Definition: MWAWParser.hxx:170
MoreParser::readPattern
bool readPattern(long endPos, MoreStruct::Pattern &pattern)
read a pattern ( some sub zone of block 9)
Definition: MoreParser.cxx:1148
MWAWVec2::x
T x() const
first element
Definition: libmwaw_internal.hxx:668
MoreParser::checkAndFindSize
bool checkAndFindSize(MWAWEntry &entry)
check if the entry is valid defined by the begin pos points to a zone: dataSz data
Definition: MoreParser.cxx:201
MoreText.hxx
MoreParser.hxx
MWAWEntry::setBegin
void setBegin(long off)
sets the begin offset
Definition: MWAWEntry.hxx:67
MWAWColor::isBlack
bool isBlack() const
return true if the color is black
Definition: libmwaw_internal.hxx:284
MWAWParser::asciiName
const std::string & asciiName() const
return the ascii file name
Definition: MWAWParser.hxx:232
MWAWParser::setVersion
void setVersion(int vers)
sets the document's version
Definition: MWAWParser.hxx:206
MoreParser::init
void init()
inits all internal variables
Definition: MoreParser.cxx:155
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
MWAWPictData.hxx
MWAWListener::PageBreak
@ PageBreak
Definition: MWAWListener.hxx:58
libmwaw::DebugFile::setStream
void setStream(MWAWInputStreamPtr const &ip)
resets the input
Definition: MWAWDebug.hxx:81
MWAWPict::MWAW_R_BAD
@ MWAW_R_BAD
Definition: MWAWPict.hxx:73
MWAWVec2< float >
libmwaw::ParseException
Definition: libmwaw_internal.hxx:143
MWAWDebug.hxx
MoreParser::readColors
bool readColors(long endPos)
read a color zone ( beginning of block 9 )
Definition: MoreParser.cxx:1061
MoreParserInternal::State::m_backgroundColor
MWAWColor m_backgroundColor
the organization back page color
Definition: MoreParser.cxx:78
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
MWAWParser::getFormWidth
double getFormWidth() const
returns the form width
Definition: MWAWParser.hxx:175
MWAWEntry::setLength
void setLength(long l)
sets the zone size
Definition: MWAWEntry.hxx:72
MoreParserInternal
Internal: the structures of a MoreParser.
Definition: MoreParser.cxx:58
MoreParserInternal::SubDocument::operator!=
bool operator!=(MWAWSubDocument const &doc) const final
operator!=
Definition: MoreParser.cxx:115
MoreParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: MoreParser.cxx:720
MWAWPageSpan::setMarginTop
void setMarginTop(const double marginTop)
set the page top margin
Definition: MWAWPageSpan.hxx:203
libmwaw::PrinterInfo::read
bool read(MWAWInputStreamPtr input)
reads the struture in a file
Definition: MWAWPrinter.cxx:235
MWAWHeaderFooter::FOOTER
@ FOOTER
Definition: MWAWPageSpan.hxx:48
MoreParserInternal::State::m_numPages
int m_numPages
the number of page of the final document
Definition: MoreParser.cxx:81
MoreParser::MoreText
friend class MoreText
Definition: MoreParser.hxx:83
MWAWParser::getParserState
MWAWParserStatePtr getParserState()
returns the parser state
Definition: MWAWParser.hxx:113
MWAWHeader.hxx
MoreParser::readZonesList
bool readZonesList()
read the list of zones ( v2-3) : first 0x80 bytes
Definition: MoreParser.cxx:391
MWAWPictData::check
static ReadResult check(MWAWInputStreamPtr const &input, int size, MWAWBox2f &box)
checks if the data pointed by input is known
Definition: MWAWPictData.hxx:100
MWAWEntry::end
long end() const
returns the end offset
Definition: MWAWEntry.hxx:88
MWAWHeaderFooter::ALL
@ ALL
Definition: MWAWPageSpan.hxx:50
MoreParser::m_state
std::shared_ptr< MoreParserInternal::State > m_state
the state
Definition: MoreParser.hxx:173
MoreParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition: MoreParser.cxx:278
MWAWParser::getInput
MWAWInputStreamPtr & getInput()
returns the actual input
Definition: MWAWParser.hxx:123
MWAWTextListener.hxx
MoreParserInternal::State
Internal: the state of a MoreParser.
Definition: MoreParser.cxx:62
MoreParser::checkAndStore
bool checkAndStore(MWAWEntry const &entry)
check if the entry is valid, if so store it in the list of entry
Definition: MoreParser.cxx:187
MoreParser::rsrcInput
MWAWInputStreamPtr rsrcInput()
return the input input
Definition: MoreParser.cxx:168
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
MWAWPageSpan::setHeaderFooter
void setHeaderFooter(MWAWHeaderFooter const &headerFooter)
add a header/footer on some page
Definition: MWAWPageSpan.cxx:227
MoreParser::readGraphic
bool readGraphic(MWAWEntry const &entry)
read a graphic ( in a slide )
Definition: MoreParser.cxx:920
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
libmwaw
namespace used to regroup all libwpd functions, enumerations which we have redefined for internal usa...
Definition: libmwaw_internal.cxx:50
MWAWInputStream.hxx
MWAWColor::isWhite
bool isWhite() const
return true if the color is white
Definition: libmwaw_internal.hxx:289
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
MWAWPageSpan::setMargins
void setMargins(double margin, int wh=libmwaw::LeftBit|libmwaw::RightBit|libmwaw::TopBit|libmwaw::BottomBit)
set all the margins
Definition: MWAWPageSpan.hxx:213
MWAWBox2< float >
MoreParserInternal::State::m_colorList
std::vector< MWAWColor > m_colorList
a list colorId -> color
Definition: MoreParser.cxx:80
MoreParser::getPageLeftTop
MWAWVec2f getPageLeftTop() const
returns the page left top point ( in inches)
Definition: MoreParser.cxx:181
MoreParser::readUnkn9Sub
bool readUnkn9Sub(long endPos)
read the last subzone find in a block 9 ( unknown meaning)
Definition: MoreParser.cxx:1174
MWAWVec2i
MWAWVec2< int > MWAWVec2i
MWAWVec2 of int.
Definition: libmwaw_internal.hxx:838
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
MWAWParser::resetTextListener
void resetTextListener()
resets the listener
Definition: MWAWParser.cxx:163
MoreParserInternal::SubDocument::parse
void parse(MWAWListenerPtr &listener, libmwaw::SubDocumentType type) final
the parser function
Definition: MoreParser.cxx:128