GreatWksDBParser.hxx Source File documentation

GreatWksDBParser.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 GREAT_WKS_DB_PARSER
35 # define GREAT_WKS_DB_PARSER
36
37 #include <string>
38 #include <vector>
39
40 #include <librevenge/librevenge.h>
41
42 #include "MWAWCell.hxx"
43 #include "MWAWDebug.hxx"
44
45 #include "MWAWParser.hxx"
46
47 namespace GreatWksDBParserInternal
48 {
49 struct Block;
50 struct BlockHeader;
51 struct Field;
52 class Cell;
53 struct State;
54 class SubDocument;
55 }
56
57 class GreatWksDocument;
58
61 class GreatWksDBParser final : public MWAWSpreadsheetParser
62 {
63 friend class GreatWksDBParserInternal::SubDocument;
64 public:
66 GreatWksDBParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header);
68 ~GreatWksDBParser() final;
69
71 bool checkHeader(MWAWHeader *header, bool strict=false) final;
72
73 // the main parse function
74 void parse(librevenge::RVNGSpreadsheetInterface *documentInterface) final;
75
76 protected:
78 void init();
79
81 void createDocument(librevenge::RVNGSpreadsheetInterface *documentInterface);
82
84 bool sendDatabase();
85
86 // interface with the text parser
87
89 bool sendHF(int id);
90
91 protected:
93 bool createZones();
94
95 //
96 // low level
97 //
98
100 bool readDatabase();
101
103 bool readHeader();
105 bool readFields(MWAWEntry const &zone);
107 bool readField(GreatWksDBParserInternal::Field &field);
109 bool readFieldAuxis(MWAWEntry const &zon);
111 bool readFieldLinks(GreatWksDBParserInternal::Field &field);
113 bool readFieldRecords(GreatWksDBParserInternal::Field &field);
115 bool readFormLinks(MWAWEntry const &zone);
117 bool readForm(MWAWEntry const &zone);
119 bool readRowLinks(GreatWksDBParserInternal::Block &block);
121 bool readRowRecords(MWAWEntry const &zone);
123 bool readRecordList(GreatWksDBParserInternal::Block &block);
124
126 bool readFreeList(GreatWksDBParserInternal::Block &block);
127
129 bool readFormula(long endPos, std::vector<MWAWCellContent::FormulaInstruction> &formula);
133 bool readFormulaResult(long endPos, GreatWksDBParserInternal::Cell &cell, std::string &extra);
134
136 bool readIntList(MWAWEntry const &zone, std::vector<int> &list);
138 bool readSmallZone(MWAWEntry const &zone);
140 bool checkSmallZone(MWAWEntry &zone);
142 std::shared_ptr<GreatWksDBParserInternal::Block> createBlock(GreatWksDBParserInternal::BlockHeader &entry);
144 bool readBlock(GreatWksDBParserInternal::Block &block, int fieldSize);
145
146 // unknown zones
147
149 bool readZone12(MWAWEntry const &zone);
150
152 bool readBlockHeader2(GreatWksDBParserInternal::Block &block);
154 bool readBlockHeader(GreatWksDBParserInternal::BlockHeader &entry);
155
156 //
157 // data
158 //
159
161 std::shared_ptr<GreatWksDBParserInternal::State> m_state;
162
164 std::shared_ptr<GreatWksDocument> m_document;
165 };
166 #endif
167 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
GreatWksDBParserInternal
Internal: the structures of a GreatWksDBParser.
Definition: GreatWksDBParser.cxx:63
GreatWksDBParser::readZone12
bool readZone12(MWAWEntry const &zone)
try to read the small zone 12(unknown format, maybe some preferences)
Definition: GreatWksDBParser.cxx:2105
MWAWHeader
a function used by MWAWDocument to store the version of document
Definition: MWAWHeader.hxx:56
GreatWksDBParser::GreatWksDBParser
GreatWksDBParser(MWAWInputStreamPtr const &input, MWAWRSRCParserPtr const &rsrcParser, MWAWHeader *header)
constructor
Definition: GreatWksDBParser.cxx:502
GreatWksDBParser::readBlock
bool readBlock(GreatWksDBParserInternal::Block &block, int fieldSize)
try to read a unknown block, knowing the field size
Definition: GreatWksDBParser.cxx:1148
GreatWksDBParser
the main class to read a GreatWorks database file
Definition: GreatWksDBParser.hxx:61
MWAWParser.hxx
GreatWksDBParser::~GreatWksDBParser
~GreatWksDBParser() final
destructor
Definition: GreatWksDBParser.cxx:510
librevenge
Definition: MWAWDocument.hxx:56
GreatWksDBParser::readBlockHeader
bool readBlockHeader(GreatWksDBParserInternal::BlockHeader &entry)
try to read a big block entry
Definition: GreatWksDBParser.cxx:901
GreatWksDBParser::readSmallZone
bool readSmallZone(MWAWEntry const &zone)
try to read an unknown small zone, ie. a default reader: type, 0, size, N, dSz
Definition: GreatWksDBParser.cxx:2140
GreatWksDocument
the main class to read/store generic data of a GreatWorks document
Definition: GreatWksDocument.hxx:60
GreatWksDBParser::readRowRecords
bool readRowRecords(MWAWEntry const &zone)
try to read a list of records corresponding to a row
Definition: GreatWksDBParser.cxx:1212
GreatWksDBParser::readFields
bool readFields(MWAWEntry const &zone)
try to read the fields&#39; zone
Definition: GreatWksDBParser.cxx:1554
GreatWksDBParser::createDocument
void createDocument(librevenge::RVNGSpreadsheetInterface *documentInterface)
creates the listener which will be associated to the document
Definition: GreatWksDBParser.cxx:567
GreatWksDBParser::readBlockHeader2
bool readBlockHeader2(GreatWksDBParserInternal::Block &block)
try to read the 2th big zone (maybe a list of pointers, but I only see a list of 0:recordId ) ...
Definition: GreatWksDBParser.cxx:1116
GreatWksDBParser::readIntList
bool readIntList(MWAWEntry const &zone, std::vector< int > &list)
try to read a int&#39;s zone
Definition: GreatWksDBParser.cxx:1962
MWAWCellContent
small class use to define a sheet cell content
Definition: MWAWCell.hxx:375
GreatWksDBParser::m_state
std::shared_ptr< GreatWksDBParserInternal::State > m_state
the state
Definition: GreatWksDBParser.hxx:161
MWAWRSRCParserPtr
std::shared_ptr< MWAWRSRCParser > MWAWRSRCParserPtr
a smart pointer of MWAWRSRCParser
Definition: libmwaw_internal.hxx:557
GreatWksDBParser::readHeader
bool readHeader()
try to read the database header: list of zones, ...
Definition: GreatWksDBParser.cxx:772
GreatWksDBParser::checkSmallZone
bool checkSmallZone(MWAWEntry &zone)
check if a pointer correspond or not to a small zone entry, if so update the entry ...
Definition: GreatWksDBParser.cxx:1182
GreatWksDBParser::readField
bool readField(GreatWksDBParserInternal::Field &field)
try to read a field
Definition: GreatWksDBParser.cxx:1646
GreatWksDBParser::m_document
std::shared_ptr< GreatWksDocument > m_document
the document
Definition: GreatWksDBParser.hxx:164
GreatWksDBParser::readForm
bool readForm(MWAWEntry const &zone)
try to read a form zone
Definition: GreatWksDBParser.cxx:2045
GreatWksDBParser::readFormulaResult
bool readFormulaResult(long endPos, GreatWksDBParserInternal::Cell &cell, std::string &extra)
try to read a formula result in a row content zone
Definition: GreatWksDBParser.cxx:1479
GreatWksDBParser::createZones
bool createZones()
finds the different objects zones
Definition: GreatWksDBParser.cxx:610
GreatWksDBParser::readDatabase
bool readDatabase()
read the database block
Definition: GreatWksDBParser.cxx:725
GreatWksDBParser::readFieldLinks
bool readFieldLinks(GreatWksDBParserInternal::Field &field)
try to read a zone which links a field to zone record
Definition: GreatWksDBParser.cxx:1930
GreatWksDBParser::readRowLinks
bool readRowLinks(GreatWksDBParserInternal::Block &block)
try to read row record to small zone link (the 1th big zone)
Definition: GreatWksDBParser.cxx:1072
GreatWksDBParser::readFieldAuxis
bool readFieldAuxis(MWAWEntry const &zon)
try to read a field extra v2 zone ( small zone 13)
Definition: GreatWksDBParser.cxx:1734
MWAWDebug.hxx
MWAWInputStreamPtr
std::shared_ptr< MWAWInputStream > MWAWInputStreamPtr
a smart pointer of MWAWInputStream
Definition: libmwaw_internal.hxx:547
GreatWksDBParser::init
void init()
inits all internal variables
Definition: GreatWksDBParser.cxx:514
GreatWksDBParser::sendHF
bool sendHF(int id)
try to send the i^th header/footer
Definition: GreatWksDBParser.cxx:530
GreatWksDBParser::sendDatabase
bool sendDatabase()
try to send the main database
Definition: GreatWksDBParser.cxx:2179
GreatWksDBParserInternal::SubDocument
Internal: the subdocument of a GreatWksDBParser.
Definition: GreatWksDBParser.cxx:447
GreatWksDBParser::checkHeader
bool checkHeader(MWAWHeader *header, bool strict=false) final
checks if the document header is correct (or not)
Definition: GreatWksDBParser.cxx:2245
GreatWksDBParser::readFormLinks
bool readFormLinks(MWAWEntry const &zone)
try to read the list of form
Definition: GreatWksDBParser.cxx:1991
MWAWCell.hxx
Defines MWAWCell (cell content and format)
GreatWksDBParser::readRecordList
bool readRecordList(GreatWksDBParserInternal::Block &block)
try to read the record list (the 3th big zone)
Definition: GreatWksDBParser.cxx:993
GreatWksDBParser::readFieldRecords
bool readFieldRecords(GreatWksDBParserInternal::Field &field)
try to read a list of records corresponding to field
Definition: GreatWksDBParser.cxx:1809
MWAWEntry
basic class to store an entry in a file This contained :
Definition: MWAWEntry.hxx:46
GreatWksDBParser::parse
void parse(librevenge::RVNGSpreadsheetInterface *documentInterface) final
virtual function used to parse the input
Definition: GreatWksDBParser.cxx:538
MWAWSpreadsheetParser
virtual class which defines the ancestor of all spreadsheet zone parser
Definition: MWAWParser.hxx:282
GreatWksDBParser::readFormula
bool readFormula(long endPos, std::vector< MWAWCellContent::FormulaInstruction > &formula)
try to read a formula result in field definition
Definition: GreatWksDBParser.cxx:1419
GreatWksDBParser::createBlock
std::shared_ptr< GreatWksDBParserInternal::Block > createBlock(GreatWksDBParserInternal::BlockHeader &entry)
try to create a block corresponding to an entry
Definition: GreatWksDBParser.cxx:909
GreatWksDBParser::readFreeList
bool readFreeList(GreatWksDBParserInternal::Block &block)
try to read the free zone list: 0th big zone
Definition: GreatWksDBParser.cxx:1022