Lotus.h Source File documentation

Lotus.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 LOTUS_H
23 #define LOTUS_H
24
25 #include <vector>
26
27 #include <librevenge-stream/librevenge-stream.h>
28 #include "libwps_internal.h"
29 #include "libwps_tools_win.h"
30 #include "WPSDebug.h"
31
32 #include "WKSParser.h"
33
34 namespace LotusParserInternal
35 {
36 class SubDocument;
37 struct State;
38 }
39
40 class LotusGraph;
41 class LotusSpreadsheet;
42 class LotusStyleManager;
43 class WPSOLE1Parser;
44
45 /* .wk3: a spreadsheet is composed in two files
46 + a wk3 file which contains the spreadsheet data
47 + a fm3 file which contains the different formatings
48
49 .wk4: the file contains three parts:
50 + the wk3 previous file
51 + the fm3 file
52 + an unknown part, which may code the file structure,
53
54 Normally the wk3 and the fm3 are a sequence of small zones,
55 but picture seems to be appeared at random position inside the
56 fm3 part (and even inside some structure fm3 structures...)
57
58 search for .ole and OLE1
59
60 */
61
66 class LotusParser : public WKSParser
67 {
68 friend class LotusParserInternal::SubDocument;
69 friend class LotusGraph;
70 friend class LotusSpreadsheet;
71 friend class LotusStyleManager;
72 public:
74 LotusParser(RVNGInputStreamPtr &input, WPSHeaderPtr &header,
75 libwps_tools_win::Font::Type encoding=libwps_tools_win::Font::UNKNOWN,
76 char const *password=0);
78 ~LotusParser();
80 void parse(librevenge::RVNGSpreadsheetInterface *documentInterface);
82 bool checkHeader(WPSHeader *header, bool strict=false);
83
84 protected:
86 int version() const;
87
88 //
89 // interface
90 //
91
93 bool getFont(int id, WPSFont &font, libwps_tools_win::Font::Type &type) const;
97 libwps_tools_win::Font::Type getDefaultFontType() const;
98
99 //
100 // interface with LotusGraph
101 //
102
104 bool hasGraphics(int sheetId) const;
106 void sendGraphics(int sheetId);
107
108 //
109 // interface with LotusSpreadsheet
110 //
111
113 bool getLeftTopPosition(Vec2i const &cell, int spreadsheet, Vec2f &pos) const;
114
115 //
116 // interface with WPSOLE1Parser
117 //
118
120 bool updateEmbeddedObject(int id, WPSEmbeddedObject &object) const;
121
123 bool createZones();
125 bool createListener(librevenge::RVNGSpreadsheetInterface *interface);
126
127 //
128 // low level
129 //
130
132 bool parseFormatStream();
133
135 bool checkHeader(shared_ptr<WPSStream> stream, bool mainStream, bool strict);
137 bool readZones(shared_ptr<WPSStream> stream);
139 bool readDataZone(shared_ptr<WPSStream> stream);
141 bool readZone(shared_ptr<WPSStream> stream);
143 bool readZone1(shared_ptr<WPSStream> stream);
145 bool readSheetZone(shared_ptr<WPSStream> stream);
147 bool readZone4(shared_ptr<WPSStream> stream);
149 bool readChartZone(shared_ptr<WPSStream> stream);
151 bool readRefZone(shared_ptr<WPSStream> stream);
153 bool readZone7(shared_ptr<WPSStream> stream);
155 bool readZone8(shared_ptr<WPSStream> stream);
157 bool readVersionZone(shared_ptr<WPSStream> stream);
159 bool readZoneV3(shared_ptr<WPSStream> stream);
161
163 bool readMacFontName(shared_ptr<WPSStream> stream, long endPos);
165 bool readFMTStyleName(shared_ptr<WPSStream> stream);
167 bool readLinkZone(shared_ptr<WPSStream> stream);
169 bool readDocumentInfoMac(shared_ptr<WPSStream> stream, long endPos);
170
172
174 bool readChartDefinition(shared_ptr<WPSStream> stream);
176 bool readChartName(shared_ptr<WPSStream> stream);
177
179
181 static RVNGInputStreamPtr decodeStream(RVNGInputStreamPtr input, long endPos, std::vector<uint8_t> const &key);
183 static std::vector<uint8_t> retrievePasswordKeys(std::vector<uint8_t> const &fileKeys);
184
185 shared_ptr<WKSContentListener> m_listener;
186 shared_ptr<LotusParserInternal::State> m_state;
189 shared_ptr<LotusStyleManager> m_styleManager;
191 shared_ptr<LotusGraph> m_graphParser;
193 shared_ptr<LotusSpreadsheet> m_spreadsheetParser;
195 shared_ptr<WPSOLE1Parser> m_ole1Parser;
196 };
197
198 #endif /* LOTUS_H */
199 /* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
LotusStyleManager::m_state
shared_ptr< LotusStyleManagerInternal::State > m_state
the internal state
Definition: LotusStyleManager.h:148
libwps_tools_win.h
WPSFont
define the font properties
Definition: WPSFont.h:36
LotusStyleManager::LotusParser
friend class LotusParser
Definition: LotusStyleManager.h:50
LotusStyleManager::version
int version() const
return the file version
Definition: LotusStyleManager.cpp:574
libwps_tools_win::Font::Type
Type
enum Type
Definition: libwps_tools_win.h:46
LotusGraph
This class parses Microsoft Works graph file.
Definition: LotusGraph.h:54
LotusParser
This class parses a WK2..WK4 Lotus spreadsheet.
Definition: Lotus.h:66
WPSOLE1Parser
a class used to parse a container which is used by Lotus123 (and also by RagTime).
Definition: WPSOLE1Parser.h:49
WPSHeaderPtr
shared_ptr< WPSHeader > WPSHeaderPtr
shared pointer to WPSHeader
Definition: libwps_internal.h:110
LotusParser::m_ole1Parser
shared_ptr< WPSOLE1Parser > m_ole1Parser
the ole1 parser
Definition: Lotus.h:195
LotusParserInternal::SubDocument
Internal: the subdocument of a LotusParser.
Definition: Lotus.cpp:70
libwps_internal.h
WPSHeader
Definition: WPSHeader.h:31
LotusStyleManager
This class parses the Lotus style.
Definition: LotusStyleManager.h:47
libwps_tools_win::Font::UNKNOWN
Definition: libwps_tools_win.h:61
LotusParserInternal
Internal: namespace to define internal class of LotusParser.
Definition: Lotus.cpp:56
LotusParser::m_styleManager
shared_ptr< LotusStyleManager > m_styleManager
the style manager
Definition: Lotus.h:189
RVNGInputStreamPtr
shared_ptr< librevenge::RVNGInputStream > RVNGInputStreamPtr
shared pointer to librevenge::RVNGInputStream
Definition: libwps_internal.h:88
LotusSpreadsheet
This class parses Microsoft Works spreadsheet file.
Definition: LotusSpreadsheet.h:52
WPSEmbeddedObject
small class use to define a embedded object
Definition: libwps_internal.h:438
Vec2< int >
WPSDebug.h
LotusParser::m_listener
shared_ptr< WKSContentListener > m_listener
Definition: Lotus.h:185
WKSParser
Definition: WKSParser.h:33
LotusParser::m_graphParser
shared_ptr< LotusGraph > m_graphParser
the graph manager
Definition: Lotus.h:191
LotusParser::m_spreadsheetParser
shared_ptr< LotusSpreadsheet > m_spreadsheetParser
the spreadsheet manager
Definition: Lotus.h:193
WKSParser.h