WriteNowParser.hxx Source File documentation

WriteNowParser.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/* libmwaw
3* Version: MPL 2.0 / LGPLv2+
4*
5* The contents of this file are subject to the Mozilla Public License Version
6* 2.0 (the "License"); you may not use this file except in compliance with
7* the License or as specified alternatively below. You may obtain a copy of
8* the License at http://www.mozilla.org/MPL/
9*
10* Software distributed under the License is distributed on an "AS IS" basis,
11* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12* for the specific language governing rights and limitations under the
13* License.
14*
15* Major Contributor(s):
16* Copyright (C) 2002 William Lachance (wrlach@gmail.com)
17* Copyright (C) 2002,2004 Marc Maurer (uwog@uwog.net)
18* Copyright (C) 2004-2006 Fridrich Strba (fridrich.strba@bluewin.ch)
19* Copyright (C) 2006, 2007 Andrew Ziem
20* Copyright (C) 2011, 2012 Alonso Laurent (alonso@loria.fr)
21*
22*
23* All Rights Reserved.
24*
25* For minor contributions see the git repository.
26*
27* Alternatively, the contents of this file may be used under the terms of
28* the GNU Lesser General Public License Version 2 or later (the "LGPLv2+"),
29* in which case the provisions of the LGPLv2+ are applicable
30* instead of those above.
31*/
32
33/*
34 * parser for WriteNow 3.0 and 4.0
35 *
36 * Note: WriteNow 2.0 seems very different
37 */
38#ifndef WRITE_NOW_PARSER
39# define WRITE_NOW_PARSER
40
41#include <list>
42#include <string>
43#include <vector>
44
45#include "MWAWDebug.hxx"
46#include "MWAWEntry.hxx"
47#include "MWAWInputStream.hxx"
48#include "MWAWPosition.hxx"
49
50#include "MWAWParser.hxx"
51
52namespace WriteNowParserInternal
53{
54struct State;
55class SubDocument;
56}
57
58struct WriteNowEntry;
59struct WriteNowEntryManager;
60
61class WriteNowText;
62
68 class WriteNowParser final : public MWAWTextParser
69{
70 friend class WriteNowText;
71 friend class WriteNowParserInternal::SubDocument;
72
73public:
75 WriteNowParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
77 ~WriteNowParser() final;
78
80 bool checkHeader(MWAWHeader *header, bool strict=false) final;
81
82 // the main parse function
83 void parse(librevenge::RVNGTextInterface *documentInterface) final;
84
85protected:
87 void init();
88
90 void createDocument(librevenge::RVNGTextInterface *documentInterface);
91
93 bool createZones();
94
96 void getColumnInfo(int &numColumns, int &width) const;
97
99 void newPage(int number);
100
101 /*
102 * interface with WriteNowText
103 */
105 bool getColor(int colId, MWAWColor &col) const;
106
108 void sendFootnote(WriteNowEntry const &entry);
109
111 bool sendGraphic(int gId, MWAWBox2i const &bdbox);
112
113 /*
114 * interface with subdocument
115 */
116
118 void send(WriteNowEntry const &entry);
119
120 //
121 // low level
122 //
123
125 bool readDocEntries();
126
128 bool readDocEntriesV2();
129
133 bool parseGraphicZone(WriteNowEntry const &entry);
134
136 bool readColorMap(WriteNowEntry const &entry);
137
139 bool readPrintInfo(WriteNowEntry const &entry);
140
142 bool readGenericUnkn(WriteNowEntry const &entry);
143
145 bool sendPicture(WriteNowEntry const &entry, MWAWBox2i const &bdbox);
146
148 WriteNowEntry readEntry();
149
151 bool checkIfPositionValid(long pos);
152
153protected:
154 //
155 // data
156 //
158 std::shared_ptr<WriteNowParserInternal::State> m_state;
159
161 std::shared_ptr<WriteNowEntryManager> m_entryManager;
162
164 std::shared_ptr<WriteNowText> m_textParser;
165};
166#endif
167// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWDebug.hxx
MWAWEntry.hxx
MWAWInputStream.hxx
MWAWParser.hxx
MWAWPosition.hxx
MWAWBox2< int >
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
WriteNowParserInternal::SubDocument
Internal: the subdocument of a WriteNowParser.
Definition WriteNowParser.cxx:92
WriteNowParser
the main class to read a WriteNow file
Definition WriteNowParser.hxx:69
WriteNowParser::readEntry
WriteNowEntry readEntry()
read a file entry
Definition WriteNowParser.cxx:1002
WriteNowParser::m_textParser
std::shared_ptr< WriteNowText > m_textParser
the text parser
Definition WriteNowParser.hxx:164
WriteNowParser::sendGraphic
bool sendGraphic(int gId, MWAWBox2i const &bdbox)
try to send the graphic zone
Definition WriteNowParser.cxx:219
WriteNowParser::parseGraphicZone
bool parseGraphicZone(WriteNowEntry const &entry)
try to read the graphic zone (unknown + list of entries ) and to create the graphic data zone
Definition WriteNowParser.cxx:554
WriteNowParser::readPrintInfo
bool readPrintInfo(WriteNowEntry const &entry)
try to read the print info zone
Definition WriteNowParser.cxx:828
WriteNowParser::send
void send(WriteNowEntry const &entry)
try to send an entry
Definition WriteNowParser.cxx:214
WriteNowParser::readDocEntries
bool readDocEntries()
try to read the document entries zone v3-v4
Definition WriteNowParser.cxx:388
WriteNowParser::init
void init()
inits all internal variables
Definition WriteNowParser.cxx:158
WriteNowParser::createZones
bool createZones()
finds the different objects zones
Definition WriteNowParser.cxx:328
WriteNowParser::~WriteNowParser
~WriteNowParser() final
destructor
Definition WriteNowParser.cxx:154
WriteNowParser::sendFootnote
void sendFootnote(WriteNowEntry const &entry)
try to send a footnote entry
Definition WriteNowParser.cxx:206
WriteNowParser::readDocEntriesV2
bool readDocEntriesV2()
try to read the document entries zone v2
Definition WriteNowParser.cxx:477
WriteNowParser::createDocument
void createDocument(librevenge::RVNGTextInterface *documentInterface)
creates the listener which will be associated to the document
Definition WriteNowParser.cxx:280
WriteNowParser::m_entryManager
std::shared_ptr< WriteNowEntryManager > m_entryManager
the list of entry
Definition WriteNowParser.hxx:161
WriteNowParser::getColumnInfo
void getColumnInfo(int &numColumns, int &width) const
returns the columns information
Definition WriteNowParser.cxx:175
WriteNowParser::parse
void parse(librevenge::RVNGTextInterface *documentInterface) final
virtual function used to parse the input
Definition WriteNowParser.cxx:238
WriteNowParser::m_state
std::shared_ptr< WriteNowParserInternal::State > m_state
the state
Definition WriteNowParser.hxx:158
WriteNowParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition WriteNowParser.cxx:1028
WriteNowParser::getColor
bool getColor(int colId, MWAWColor &col) const
returns the color which corresponds to colId
Definition WriteNowParser.cxx:197
WriteNowParser::readColorMap
bool readColorMap(WriteNowEntry const &entry)
try to read the colormap zone
Definition WriteNowParser.cxx:721
WriteNowParser::checkIfPositionValid
bool checkIfPositionValid(long pos)
check if a position is inside the file
Definition WriteNowParser.cxx:988
WriteNowParser::sendPicture
bool sendPicture(WriteNowEntry const &entry, MWAWBox2i const &bdbox)
try to send a picture to the listener
Definition WriteNowParser.cxx:634
WriteNowParser::newPage
void newPage(int number)
adds a new page
Definition WriteNowParser.cxx:184
WriteNowParser::readGenericUnkn
bool readGenericUnkn(WriteNowEntry const &entry)
try to read the last generic zones
Definition WriteNowParser.cxx:904
WriteNowParser::WriteNowParser
WriteNowParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition WriteNowParser.cxx:145
WriteNowText
the main class to read the text part of writenow file
Definition WriteNowText.hxx:82
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
WriteNowParserInternal
Internal: the structures of a WriteNowParser.
Definition WriteNowParser.cxx:56
librevenge
Definition MWAWDocument.hxx:57
MWAWColor
the class to store a color
Definition libmwaw_internal.hxx:192
WriteNowEntryManager
the manager of the entries
Definition WriteNowEntry.hxx:106
WriteNowEntry
class to store entry in a WriteNow document
Definition WriteNowEntry.hxx:48