WKS4Spreadsheet.h Source File documentation

WKS4Spreadsheet.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 WKS4_SPREADSHEET_H
23#define WKS4_SPREADSHEET_H
24
25#include <ostream>
26#include <vector>
27
28#include <librevenge-stream/librevenge-stream.h>
29
30#include "libwps_internal.h"
31
32#include "WPSDebug.h"
33#include "WKSContentListener.h"
34
35namespace WKS4SpreadsheetInternal
36{
37class Cell;
38class SpreadSheet;
39struct State;
40}
41
42class WKS4Parser;
43
48 class WKS4Spreadsheet
49{
50public:
51 friend class WKS4Parser;
52
54 explicit WKS4Spreadsheet(WKS4Parser &parser);
56 ~WKS4Spreadsheet();
58 void setListener(WKSContentListenerPtr &listen)
59 {
60 m_listener = listen;
61 }
62
63protected:
65 bool checkFilePosition(long pos);
67 int version() const;
69 void resetInput(RVNGInputStreamPtr const &input);
70
72 int getNumSpreadsheets() const;
74 void sendSpreadsheet(int sId);
76 librevenge::RVNGString getSheetName(int id) const;
77
79 void sendCellContent(WKS4SpreadsheetInternal::Cell const &cell);
80
82
84 bool readReportOpen();
86 bool readReportClose();
87
89 bool readFilterOpen();
91 bool readFilterClose();
92
93 //
94 // low level
95 //
97
99 bool readCell();
101 bool readCellFormulaResult();
103 bool readSheetSize();
105 bool readColumnSize();
107 bool readHiddenColumns();
108
110 bool readMsWorksDOSFieldProperty();
112 bool readMsWorksDOSCellProperty();
114 bool readMsWorksDOSCellExtraProperty();
116 bool readMsWorksDOSPageBreak();
117
119 bool readMsWorksColumnSize();
121 bool readMsWorksRowSize();
123 bool readMsWorksPageBreak();
125 bool readMsWorksStyle();
126
127 /* reads a cell */
128 bool readCell(Vec2i actPos, WKSContentListener::FormulaInstruction &instr);
129 /* reads a formula */
130 bool readFormula(long endPos, Vec2i const &pos,
131 std::vector<WKSContentListener::FormulaInstruction> &formula, std::string &error);
132
133private:
134 WKS4Spreadsheet(WKS4Spreadsheet const &orig) = delete;
135 WKS4Spreadsheet &operator=(WKS4Spreadsheet const &orig) = delete;
137 libwps::DebugFile &ascii()
138 {
139 return m_asciiFile;
140 }
142 RVNGInputStreamPtr m_input;
143 std::shared_ptr<WKSContentListener> m_listener;
145 WKS4Parser &m_mainParser;
147 std::shared_ptr<WKS4SpreadsheetInternal::State> m_state;
149 libwps::DebugFile &m_asciiFile;
150};
151
152#endif /* WPS4_SPREADSHEET_H */
153/* vim:set shiftwidth=4 softtabstop=4 noexpandtab: */
WKSContentListener.h
WPSDebug.h
Vec2< int >
WKS4Parser
This class parses Microsoft Works spreadsheet or a database file.
Definition: WKS4.h:49
WKS4SpreadsheetInternal::Cell
a cellule of a WKS4 spreadsheet
Definition: WKS4Spreadsheet.cpp:187
WKS4Spreadsheet
This class parses Microsoft Works spreadsheet file.
Definition: WKS4Spreadsheet.h:49
WKS4Spreadsheet::m_asciiFile
libwps::DebugFile & m_asciiFile
the ascii file
Definition: WKS4Spreadsheet.h:149
WKS4Spreadsheet::~WKS4Spreadsheet
~WKS4Spreadsheet()
destructor
Definition: WKS4Spreadsheet.cpp:520
WKS4Spreadsheet::readMsWorksDOSPageBreak
bool readMsWorksDOSPageBreak()
reads a page break (in a dos file)
Definition: WKS4Spreadsheet.cpp:1372
WKS4Spreadsheet::readFilterClose
bool readFilterClose()
reads the filter's end zone 11:54
Definition: WKS4Spreadsheet.cpp:2204
WKS4Spreadsheet::readReportOpen
bool readReportOpen()
reads the report's header zone 17:54
Definition: WKS4Spreadsheet.cpp:2238
WKS4Spreadsheet::readMsWorksDOSCellExtraProperty
bool readMsWorksDOSCellExtraProperty()
reads the actual cell addendum properties ( contains at least the color)
Definition: WKS4Spreadsheet.cpp:1298
WKS4Spreadsheet::m_state
std::shared_ptr< WKS4SpreadsheetInternal::State > m_state
the internal state
Definition: WKS4Spreadsheet.h:147
WKS4Spreadsheet::setListener
void setListener(WKSContentListenerPtr &listen)
sets the listener
Definition: WKS4Spreadsheet.h:58
WKS4Spreadsheet::ascii
libwps::DebugFile & ascii()
returns the debug file
Definition: WKS4Spreadsheet.h:137
WKS4Spreadsheet::readMsWorksPageBreak
bool readMsWorksPageBreak()
reads a page break
Definition: WKS4Spreadsheet.cpp:768
WKS4Spreadsheet::readHiddenColumns
bool readHiddenColumns()
reads the list of hidden columns zone ( unused )
Definition: WKS4Spreadsheet.cpp:648
WKS4Spreadsheet::getNumSpreadsheets
int getNumSpreadsheets() const
returns the number of spreadsheet
Definition: WKS4Spreadsheet.cpp:548
WKS4Spreadsheet::checkFilePosition
bool checkFilePosition(long pos)
return true if the pos is in the file, update the file size if need
Definition: WKS4Spreadsheet.cpp:536
WKS4Spreadsheet::readMsWorksRowSize
bool readMsWorksRowSize()
reads the row size ( in ???)
Definition: WKS4Spreadsheet.cpp:731
WKS4Spreadsheet::WKS4Spreadsheet
WKS4Spreadsheet(WKS4Spreadsheet const &orig)=delete
WKS4Spreadsheet::getSheetName
librevenge::RVNGString getSheetName(int id) const
returns the name of the id's spreadsheet
Definition: WKS4Spreadsheet.cpp:553
WKS4Spreadsheet::m_listener
std::shared_ptr< WKSContentListener > m_listener
Definition: WKS4Spreadsheet.h:143
WKS4Spreadsheet::readFilterOpen
bool readFilterOpen()
reads the filter's header zone 10:54
Definition: WKS4Spreadsheet.cpp:2178
WKS4Spreadsheet::sendCellContent
void sendCellContent(WKS4SpreadsheetInternal::Cell const &cell)
send the cell data
Definition: WKS4Spreadsheet.cpp:2390
WKS4Spreadsheet::readFormula
bool readFormula(long endPos, Vec2i const &pos, std::vector< WKSContentListener::FormulaInstruction > &formula, std::string &error)
Definition: WKS4Spreadsheet.cpp:1904
WKS4Spreadsheet::operator=
WKS4Spreadsheet & operator=(WKS4Spreadsheet const &orig)=delete
WKS4Spreadsheet::sendSpreadsheet
void sendSpreadsheet(int sId)
send the sId'th spreadsheet
Definition: WKS4Spreadsheet.cpp:2340
WKS4Spreadsheet::readCellFormulaResult
bool readCellFormulaResult()
reads the result of a text formula
Definition: WKS4Spreadsheet.cpp:1745
WKS4Spreadsheet::readMsWorksDOSCellProperty
bool readMsWorksDOSCellProperty()
reads actualCell properties
Definition: WKS4Spreadsheet.cpp:1042
WKS4Spreadsheet::readReportClose
bool readReportClose()
reads the report's end zone 18:54
Definition: WKS4Spreadsheet.cpp:2306
WKS4Spreadsheet::readMsWorksStyle
bool readMsWorksStyle()
reads a style
Definition: WKS4Spreadsheet.cpp:798
WKS4Spreadsheet::readColumnSize
bool readColumnSize()
reads the column size ( in ??? )
Definition: WKS4Spreadsheet.cpp:602
WKS4Spreadsheet::readMsWorksDOSFieldProperty
bool readMsWorksDOSFieldProperty()
reads a field property
Definition: WKS4Spreadsheet.cpp:1211
WKS4Spreadsheet::m_input
RVNGInputStreamPtr m_input
the input
Definition: WKS4Spreadsheet.h:142
WKS4Spreadsheet::readSheetSize
bool readSheetSize()
reads sheet size
Definition: WKS4Spreadsheet.cpp:564
WKS4Spreadsheet::m_mainParser
WKS4Parser & m_mainParser
the listener (if set)
Definition: WKS4Spreadsheet.h:145
WKS4Spreadsheet::version
int version() const
return the file version
Definition: WKS4Spreadsheet.cpp:529
WKS4Spreadsheet::readCell
bool readCell()
reads a cell content data
Definition: WKS4Spreadsheet.cpp:1405
WKS4Spreadsheet::readMsWorksColumnSize
bool readMsWorksColumnSize()
reads the column size ( in ???)
Definition: WKS4Spreadsheet.cpp:692
WKS4Spreadsheet::resetInput
void resetInput(RVNGInputStreamPtr const &input)
reset the main input
Definition: WKS4Spreadsheet.cpp:524
libwps::DebugFile
Definition: WPSDebug.h:208
libwps_internal.h
WKSContentListenerPtr
std::shared_ptr< WKSContentListener > WKSContentListenerPtr
shared pointer to WKSContentListener
Definition: libwps_internal.h:114
RVNGInputStreamPtr
std::shared_ptr< librevenge::RVNGInputStream > RVNGInputStreamPtr
shared pointer to librevenge::RVNGInputStream
Definition: libwps_internal.h:87
WKS4SpreadsheetInternal
Definition: WKS4Spreadsheet.cpp:46
WKSContentListener::FormulaInstruction
small class use to define a formula instruction
Definition: WKSContentListener.h:58