Quattro9.h Source File documentation

Quattro9.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
2 /* libwps
3 * Version: MPL 2.0 / LGPLv2.1+
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * Major Contributor(s):
10 * Copyright (C) 2006, 2007 Andrew Ziem
11 * Copyright (C) 2003-2005 William Lachance (william.lachance@sympatico.ca)
12 * Copyright (C) 2003 Marc Maurer (uwog@uwog.net)
13 *
14 * For minor contributions see the git repository.
15 *
16 * Alternatively, the contents of this file may be used under the terms
17 * of the GNU Lesser General Public License Version 2.1 or later
18 * (LGPLv2.1+), in which case the provisions of the LGPLv2.1+ are
19 * applicable instead of those above.
20 */
21
22 #ifndef QUATTRO_9_H
23 #define QUATTRO_9_H
24
25 #include <map>
26 #include <vector>
27
28 #include <librevenge-stream/librevenge-stream.h>
29 #include "libwps/libwps.h"
30
31 #include "libwps_internal.h"
32 #include "libwps_tools_win.h"
33
34 #include "WKSParser.h"
35 #include "WPSGraphicStyle.h"
36
37 namespace Quattro9ParserInternal
38 {
39 class SubDocument;
40 struct State;
41
42 struct TextEntry
43 {
45 TextEntry()
46 : m_entry()
47 , m_fontsList()
48 , m_posFontIdMap()
49 , m_flag(0)
50 , m_extra()
51 {
52 }
54 bool empty() const
55 {
56 return !m_entry.valid();
57 }
59 librevenge::RVNGString getString(std::shared_ptr<WPSStream> const &stream, libwps_tools_win::Font::Type type=libwps_tools_win::Font::WIN3_WEUROPE) const;
61 void send(std::shared_ptr<WPSStream> const &stream, WPSFont const &font, libwps_tools_win::Font::Type type, WKSContentListenerPtr &listener);
63 std::string getDebugString(std::shared_ptr<WPSStream> const &stream) const;
65 WPSEntry m_entry;
67 std::vector<WPSFont> m_fontsList;
69 std::map<int, int> m_posFontIdMap;
71 int m_flag;
73 std::string m_extra;
74 };
75 }
76
77 class Quattro9Graph;
78 class Quattro9Spreadsheet;
79
80 namespace QuattroFormulaInternal
81 {
82 class CellReference;
83 }
84
89 class Quattro9Parser final : public WKSParser
90 {
91 friend class Quattro9ParserInternal::SubDocument;
92 friend class Quattro9Graph;
93 friend class Quattro9Spreadsheet;
94
95 public:
97 Quattro9Parser(RVNGInputStreamPtr &input, WPSHeaderPtr &header,
98 libwps_tools_win::Font::Type encoding=libwps_tools_win::Font::UNKNOWN,
99 char const *password=nullptr);
101 ~Quattro9Parser() final;
103 void parse(librevenge::RVNGSpreadsheetInterface *documentInterface) final;
105 bool checkHeader(WPSHeader *header, bool strict=false);
106
107 protected:
109 int version() const;
113 libwps_tools_win::Font::Type getDefaultFontType() const;
115 bool getExternalFileName(int fId, librevenge::RVNGString &fName) const;
117 bool getField(int fId, librevenge::RVNGString &text,
118 QuattroFormulaInternal::CellReference &ref,
119 librevenge::RVNGString const &fileName) const;
120
121 //
122 // interface with Quattro9Spreadsheet
123 //
124
126 bool getFont(int id, WPSFont &font) const;
128 Vec2f getCellPosition(int sheetId, Vec2i const &cell) const;
129
130 //
131 // interface with Quattro9Graph
132 //
133
135 bool getColor(int id, WPSColor &color) const;
137 bool getPattern(int id, WPSGraphicStyle::Pattern &pattern) const;
139 bool sendPageGraphics(int sheetId) const;
140
141 //
142 //
143 //
144
146 std::shared_ptr<WKSContentListener> createListener(librevenge::RVNGSpreadsheetInterface *interface);
147
149 void sendHeaderFooter(bool header);
150
151 //
152 // low level
153 //
154
156 bool checkHeader(std::shared_ptr<WPSStream> stream, bool strict);
158 bool readZones();
160 bool readZone(std::shared_ptr<WPSStream> &stream);
161
163
165 bool readPString(std::shared_ptr<WPSStream> const &stream, long endPos, Quattro9ParserInternal::TextEntry &entry);
167 bool readFontNames(std::shared_ptr<WPSStream> const &stream);
169 bool readFontStyles(std::shared_ptr<WPSStream> const &stream);
171 bool readFilePositions(std::shared_ptr<WPSStream> const &stream, long (&filePos)[2]);
173 bool readDocumentFields(std::shared_ptr<WPSStream> const &stream);
175 bool readDocumentStrings(std::shared_ptr<WPSStream> const &stream);
176
178 bool readTextStyles(std::shared_ptr<WPSStream> const &stream, long endPos, Quattro9ParserInternal::TextEntry &entry);
180 bool readTextFontStyles(std::shared_ptr<WPSStream> const &stream, int dataSz, WPSFont &font);
181
183 void addDocumentStrings();
184
186
187
189
191 bool parseOLEStream(RVNGInputStreamPtr input, std::string const &avoid="");
193 bool readOleLinkInfo(std::shared_ptr<WPSStream> stream);
195 bool readOleBOlePart(std::shared_ptr<WPSStream> stream);
196
198
200 RVNGInputStreamPtr decodeStream(RVNGInputStreamPtr input, std::vector<uint8_t> const &key) const;
201
202 std::shared_ptr<WKSContentListener> m_listener;
203 std::shared_ptr<Quattro9ParserInternal::State> m_state;
206 std::shared_ptr<Quattro9Graph> m_graphParser;
208 std::shared_ptr<Quattro9Spreadsheet> m_spreadsheetParser;
209 };
210
211 #endif /* WPS4_H */
212 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
Quattro9ParserInternal::TextEntry::m_posFontIdMap
std::map< int, int > m_posFontIdMap
the position to font map(complex text)
Definition: Quattro9.h:69
WPSEntry::valid
bool valid(bool checkId=false) const
returns true if the zone length is positive
Definition: WPSEntry.h:87
Quattro9Parser::m_spreadsheetParser
std::shared_ptr< Quattro9Spreadsheet > m_spreadsheetParser
the spreadsheet manager
Definition: Quattro9.h:208
librevenge
Definition: WPSOLEStream.h:33
libwps_tools_win.h
Quattro9Parser::createListener
std::shared_ptr< WKSContentListener > createListener(librevenge::RVNGSpreadsheetInterface *interface)
creates the main listener
Definition: Quattro9.cpp:581
Quattro9Parser::Quattro9Parser
Quattro9Parser(RVNGInputStreamPtr &input, WPSHeaderPtr &header, libwps_tools_win::Font::Type encoding=libwps_tools_win::Font::UNKNOWN, char const *password=nullptr)
constructor
Definition: Quattro9.cpp:404
WPSFont
define the font properties
Definition: WPSFont.h:36
Quattro9Parser::sendHeaderFooter
void sendHeaderFooter(bool header)
send the header/footer
Definition: Quattro9.cpp:1741
Quattro9Parser::getDefaultFontType
libwps_tools_win::Font::Type getDefaultFontType() const
returns the default font type, ie.
Definition: Quattro9.cpp:422
libwps_tools_win::Font::Type
Type
enum Type
Definition: libwps_tools_win.h:46
Quattro9Parser::readOleBOlePart
bool readOleBOlePart(std::shared_ptr< WPSStream > stream)
try to read the BOlePart sub stream: a zone which contains 5 long
Definition: Quattro9.cpp:1785
Quattro9Parser::~Quattro9Parser
~Quattro9Parser() final
destructor
Definition: Quattro9.cpp:413
Quattro9ParserInternal::TextEntry::getString
librevenge::RVNGString getString(std::shared_ptr< WPSStream > const &stream, libwps_tools_win::Font::Type type=libwps_tools_win::Font::WIN3_WEUROPE) const
returns the string
Definition: Quattro9.cpp:280
Quattro9ParserInternal::TextEntry
Definition: Quattro9.h:42
WPSGraphicStyle.h
Quattro9Parser::getExternalFileName
bool getExternalFileName(int fId, librevenge::RVNGString &fName) const
returns the name of the fId file
Definition: Quattro9.cpp:427
WPSGraphicStyle
a structure used to define a picture style
Definition: WPSGraphicStyle.h:37
Quattro9ParserInternal::TextEntry::empty
bool empty() const
returns true if the string is empty
Definition: Quattro9.h:54
Quattro9Parser::readDocumentStrings
bool readDocumentStrings(std::shared_ptr< WPSStream > const &stream)
read a zone 407 which contains a list of stream
Definition: Quattro9.cpp:1628
Quattro9Parser::readFontStyles
bool readFontStyles(std::shared_ptr< WPSStream > const &stream)
read a font style zone: zone 7
Definition: Quattro9.cpp:1336
Quattro9Parser::parse
void parse(librevenge::RVNGSpreadsheetInterface *documentInterface) final
called by WPSDocument to parse the file
Definition: Quattro9.cpp:535
libwps_internal.h
Quattro9ParserInternal::TextEntry::getDebugString
std::string getDebugString(std::shared_ptr< WPSStream > const &stream) const
internal: returns a debug string
Definition: Quattro9.cpp:313
Quattro9Parser::getPattern
bool getPattern(int id, WPSGraphicStyle::Pattern &pattern) const
returns the pattern corresponding to a pattern id between 0 and 24
Definition: Quattro9.cpp:496
Quattro9Parser::getField
bool getField(int fId, librevenge::RVNGString &text, QuattroFormulaInternal::CellReference &ref, librevenge::RVNGString const &fileName) const
returns the text and cell of a field instruction
Definition: Quattro9.cpp:444
Quattro9Parser::readZone
bool readZone(std::shared_ptr< WPSStream > &stream)
try to read a zone
Definition: Quattro9.cpp:725
WPSHeader
Definition: WPSHeader.h:31
libwps_tools_win::Font::UNKNOWN
Definition: libwps_tools_win.h:63
Quattro9Parser::readFilePositions
bool readFilePositions(std::shared_ptr< WPSStream > const &stream, long(&filePos)[2])
read a zone which contains two files position (prev and next): zone 2,402,602,a02 ...
Definition: Quattro9.cpp:1690
RVNGInputStreamPtr
std::shared_ptr< librevenge::RVNGInputStream > RVNGInputStreamPtr
shared pointer to librevenge::RVNGInputStream
Definition: libwps_internal.h:87
Quattro9Parser::readZones
bool readZones()
finds the different zones in the main OLE stream (spreadsheet, chart, print, ...) ...
Definition: Quattro9.cpp:648
Quattro9Parser::m_graphParser
std::shared_ptr< Quattro9Graph > m_graphParser
the graph manager
Definition: Quattro9.h:206
Quattro9Parser::readPString
bool readPString(std::shared_ptr< WPSStream > const &stream, long endPos, Quattro9ParserInternal::TextEntry &entry)
try to read a string: length[2bytes], unknow[bytes] followed by the string
Definition: Quattro9.cpp:1258
Quattro9ParserInternal::TextEntry::send
void send(std::shared_ptr< WPSStream > const &stream, WPSFont const &font, libwps_tools_win::Font::Type type, WKSContentListenerPtr &listener)
sends the text to the main listener
Definition: Quattro9.cpp:322
Quattro9Parser::getColor
bool getColor(int id, WPSColor &color) const
returns the color corresponding to an id
Definition: Quattro9.cpp:491
libwps.h
Quattro9ParserInternal::TextEntry::TextEntry
TextEntry()
constructor
Definition: Quattro9.h:45
Quattro9Spreadsheet
This class parses Quattro9 Pro spreadsheet file.
Definition: Quattro9Spreadsheet.h:56
Quattro9Parser::readTextStyles
bool readTextStyles(std::shared_ptr< WPSStream > const &stream, long endPos, Quattro9ParserInternal::TextEntry &entry)
read a text entry style zone
Definition: Quattro9.cpp:1406
Quattro9Parser::getCellPosition
Vec2f getCellPosition(int sheetId, Vec2i const &cell) const
returns the beginning position of a cell
Definition: Quattro9.cpp:520
Quattro9ParserInternal::TextEntry::m_extra
std::string m_extra
extra data
Definition: Quattro9.h:73
WPSColor
the class to store a color
Definition: libwps_internal.h:280
Quattro9Parser
This class parses Quattro Pro WP spreadsheet: .qpw.
Definition: Quattro9.h:89
Quattro9Parser::readTextFontStyles
bool readTextFontStyles(std::shared_ptr< WPSStream > const &stream, int dataSz, WPSFont &font)
read a font style in a text entry zone
Definition: Quattro9.cpp:1459
Quattro9Parser::getFont
bool getFont(int id, WPSFont &font) const
returns the font corresponding to an id
Definition: Quattro9.cpp:509
libwps_tools_win
some Windows© classes and tools
Definition: libwps_tools_win.cpp:31
Quattro9Parser::checkHeader
bool checkHeader(WPSHeader *header, bool strict=false)
checks if the document header is correct (or not)
Definition: Quattro9.cpp:599
Quattro9ParserInternal::TextEntry::m_entry
WPSEntry m_entry
the text entry
Definition: Quattro9.h:65
Quattro9Parser::readOleLinkInfo
bool readOleLinkInfo(std::shared_ptr< WPSStream > stream)
try to read the link info sub stream
Definition: Quattro9.cpp:1755
Quattro9Parser::m_listener
std::shared_ptr< WKSContentListener > m_listener
Definition: Quattro9.h:202
Quattro9Parser::sendPageGraphics
bool sendPageGraphics(int sheetId) const
send the page graphic corresponding to a sheet
Definition: Quattro9.cpp:501
WKSContentListenerPtr
std::shared_ptr< WKSContentListener > WKSContentListenerPtr
shared pointer to WKSContentListener
Definition: libwps_internal.h:114
Quattro9Parser::m_state
std::shared_ptr< Quattro9ParserInternal::State > m_state
the listener (if set)
Definition: Quattro9.h:204
Quattro9Parser::version
int version() const
return the file version
Definition: Quattro9.cpp:417
WPSEntry
basic class to store an entry in a file This contained :
Definition: WPSEntry.h:38
Vec2< float >
Quattro9ParserInternal::SubDocument
Internal: the subdocument of a WPS4Parser.
Definition: Quattro9.cpp:60
Quattro9ParserInternal
Internal: namespace to define internal class of Quattro9Parser.
Definition: Quattro9.cpp:57
WPSStream
small structure use to store a stream and it debug file
Definition: WPSStream.h:29
Quattro9Parser::readFontNames
bool readFontNames(std::shared_ptr< WPSStream > const &stream)
read a font name zone: zone 6
Definition: Quattro9.cpp:1293
Quattro9ParserInternal::TextEntry::m_fontsList
std::vector< WPSFont > m_fontsList
the list of fonts
Definition: Quattro9.h:67
Quattro9Graph
This class parses Quattro9Pro graph file.
Definition: Quattro9Graph.h:52
QuattroFormulaInternal
namespace to regroup data used to read QuattroPro .wb1-3, .qpw formula
Definition: Quattro.h:45
Quattro9Parser::parseOLEStream
bool parseOLEStream(RVNGInputStreamPtr input, std::string const &avoid="")
try to parse the OLE stream(except the main stream)
Definition: Quattro9.cpp:675
Quattro9Parser::addDocumentStrings
void addDocumentStrings()
add the document strings to the spreadsheetParser
Definition: Quattro9.cpp:525
libwps_tools_win::Font::WIN3_WEUROPE
Definition: libwps_tools_win.h:52
WPSHeaderPtr
std::shared_ptr< WPSHeader > WPSHeaderPtr
shared pointer to WPSHeader
Definition: libwps_internal.h:109
WKSParser
Definition: WKSParser.h:33
WKSContentListener
Definition: WKSContentListener.h:53
Quattro9ParserInternal::TextEntry::m_flag
int m_flag
the flag
Definition: Quattro9.h:71
Quattro9Parser::readDocumentFields
bool readDocumentFields(std::shared_ptr< WPSStream > const &stream)
read a zone 406 which contains a list of fields
Definition: Quattro9.cpp:1522
WKSParser.h
Quattro9Parser::decodeStream
RVNGInputStreamPtr decodeStream(RVNGInputStreamPtr input, std::vector< uint8_t > const &key) const
try to decode a stream, if successful, replace the stream&#39;input by the new one
Definition: Quattro9.cpp:1809