RagTime5Spreadsheet.hxx Source File documentation

RagTime5Spreadsheet.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/*
35 * Parser to RagTime 5-6 document ( spreadsheet part )
36 *
37 */
38#ifndef RAGTIME5_SPREADSHEET
39# define RAGTIME5_SPREADSHEET
40
41#include <string>
42#include <map>
43#include <vector>
44
45#include <librevenge/librevenge.h>
46
47#include "libmwaw_internal.hxx"
48
49#include "MWAWCell.hxx"
50#include "MWAWDebug.hxx"
51#include "MWAWInputStream.hxx"
52#include "MWAWPosition.hxx"
53
54#include "RagTime5StructManager.hxx"
55#include "RagTime5ClusterManager.hxx"
56
57namespace RagTime5SpreadsheetInternal
58{
59struct CellContent;
60struct Sheet;
61struct State;
62
63class SubDocument;
64}
65
66class RagTime5Document;
67class RagTime5Formula;
68class RagTime5StructManager;
69class RagTime5StyleManager;
70class RagTime5Zone;
71
77 class RagTime5Spreadsheet
78{
79 friend class RagTime5SpreadsheetInternal::SubDocument;
80 friend class RagTime5Document;
81 friend class RagTime5Formula;
82
83public:
85 explicit RagTime5Spreadsheet(RagTime5Document &doc);
87 virtual ~RagTime5Spreadsheet();
88
90 int version() const;
91
93 int numPages() const;
94
96 bool getFormulaRef(int sheetId, int refId, MWAWCellContent::FormulaInstruction &instruction) const;
97
98protected:
99
100 //
101 // send data
102 //
103
105 bool send(int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0);
107 bool send(RagTime5SpreadsheetInternal::Sheet &sheet,
108 MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0);
110 bool send(RagTime5SpreadsheetInternal::Sheet &sheet, int plane,
111 RagTime5SpreadsheetInternal::CellContent const &cell, int numRepeated,
112 MWAWSpreadsheetListenerPtr &listener);
114 std::vector<int> getSheetIdList() const;
116 void flushExtra(bool onlyCheck=false);
117
118 // interface with main parser
119
121 std::shared_ptr<RagTime5ClusterManager::Cluster> readSpreadsheetCluster(RagTime5Zone &zone, int zoneType);
123 void parseSpreadsheetFormulas();
125 void storeFormula(int sheetId, std::map<int, std::vector<MWAWCellContent::FormulaInstruction> > const &idToFormula);
126
127 //
128 // Intermediate level
129 //
130
132 bool readSheetDimensions(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link);
134 bool readValuesTree(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link, int rootId, MWAWVec3i const &maxPos);
136 bool readCellBlocks(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link, bool unionBlock);
138 bool readCellRefPos(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link);
139
140 //
141 // basic
142 //
143
144 //
145 // low level
146 //
147
148public:
150 static std::string printType(unsigned long fileType)
151 {
152 return RagTime5StructManager::printType(fileType);
153 }
154
155private:
156 RagTime5Spreadsheet(RagTime5Spreadsheet const &orig) = delete;
157 RagTime5Spreadsheet &operator=(RagTime5Spreadsheet const &orig) = delete;
158
159protected:
160 //
161 // data
162 //
164 RagTime5Document &m_document;
165
167 std::shared_ptr<RagTime5StructManager> m_structManager;
169 std::shared_ptr<RagTime5StyleManager> m_styleManager;
171 MWAWParserStatePtr m_parserState;
172
174 std::shared_ptr<RagTime5SpreadsheetInternal::State> m_state;
175};
176#endif
177// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWCell.hxx
Defines MWAWCell (cell content and format)
MWAWDebug.hxx
MWAWInputStream.hxx
MWAWPosition.hxx
RagTime5ClusterManager.hxx
RagTime5StructManager.hxx
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document.
Definition: MWAWPosition.hxx:48
MWAWVec3< int >
RagTime5Document
the main class to read a RagTime v5 file
Definition: RagTime5Document.hxx:77
RagTime5Formula
the main class to read the formula part of RagTime 56 file
Definition: RagTime5Formula.hxx:74
RagTime5Spreadsheet
the main class to read the spreadsheet part of RagTime 56 file
Definition: RagTime5Spreadsheet.hxx:78
RagTime5Spreadsheet::readSheetDimensions
bool readSheetDimensions(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link)
try to read the spreadsheet dimensions
Definition: RagTime5Spreadsheet.cxx:1514
RagTime5Spreadsheet::SubDocument
friend class RagTime5SpreadsheetInternal::SubDocument
Definition: RagTime5Spreadsheet.hxx:79
RagTime5Spreadsheet::send
bool send(int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0)
try to send the cluster zone
Definition: RagTime5Spreadsheet.cxx:1920
RagTime5Spreadsheet::m_styleManager
std::shared_ptr< RagTime5StyleManager > m_styleManager
the style manager
Definition: RagTime5Spreadsheet.hxx:169
RagTime5Spreadsheet::version
int version() const
returns the file version
Definition: RagTime5Spreadsheet.cxx:1454
RagTime5Spreadsheet::readSpreadsheetCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readSpreadsheetCluster(RagTime5Zone &zone, int zoneType)
try to read a spreadsheet cluster
Definition: RagTime5Spreadsheet.cxx:3142
RagTime5Spreadsheet::readValuesTree
bool readValuesTree(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link, int rootId, MWAWVec3i const &maxPos)
try to read a spreadsheet tree of values
Definition: RagTime5Spreadsheet.cxx:1719
RagTime5Spreadsheet::m_document
RagTime5Document & m_document
the parser
Definition: RagTime5Spreadsheet.hxx:164
RagTime5Spreadsheet::m_state
std::shared_ptr< RagTime5SpreadsheetInternal::State > m_state
the state
Definition: RagTime5Spreadsheet.hxx:174
RagTime5Spreadsheet::getFormulaRef
bool getFormulaRef(int sheetId, int refId, MWAWCellContent::FormulaInstruction &instruction) const
returns a formula instruction corresponding to a sheetId and refId
Definition: RagTime5Spreadsheet.cxx:1472
RagTime5Spreadsheet::~RagTime5Spreadsheet
virtual ~RagTime5Spreadsheet()
destructor
Definition: RagTime5Spreadsheet.cxx:1450
RagTime5Spreadsheet::RagTime5Spreadsheet
RagTime5Spreadsheet(RagTime5Spreadsheet const &orig)=delete
RagTime5Spreadsheet::flushExtra
void flushExtra(bool onlyCheck=false)
sends the data which have not yet been sent to the listener
Definition: RagTime5Spreadsheet.cxx:2149
RagTime5Spreadsheet::operator=
RagTime5Spreadsheet & operator=(RagTime5Spreadsheet const &orig)=delete
RagTime5Spreadsheet::storeFormula
void storeFormula(int sheetId, std::map< int, std::vector< MWAWCellContent::FormulaInstruction > > const &idToFormula)
store the formula corresponding to a sheetId
Definition: RagTime5Spreadsheet.cxx:1499
RagTime5Spreadsheet::parseSpreadsheetFormulas
void parseSpreadsheetFormulas()
parses all the formula structure linked to a spreadsheet
Definition: RagTime5Spreadsheet.cxx:1489
RagTime5Spreadsheet::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Spreadsheet.hxx:167
RagTime5Spreadsheet::numPages
int numPages() const
returns the number of pages
Definition: RagTime5Spreadsheet.cxx:1459
RagTime5Spreadsheet::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Spreadsheet.hxx:171
RagTime5Spreadsheet::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5Spreadsheet.hxx:150
RagTime5Spreadsheet::getSheetIdList
std::vector< int > getSheetIdList() const
return the sheet data id list
Definition: RagTime5Spreadsheet.cxx:1464
RagTime5Spreadsheet::readCellBlocks
bool readCellBlocks(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link, bool unionBlock)
try to read a spreadsheet referenced/union zones
Definition: RagTime5Spreadsheet.cxx:1597
RagTime5Spreadsheet::readCellRefPos
bool readCellRefPos(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link)
try to read the cell ref to value zone
Definition: RagTime5Spreadsheet.cxx:1848
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:175
RagTime5StructManager::printType
static std::string printType(unsigned long fileType)
debug: print a file type
Definition: RagTime5StructManager.cxx:94
RagTime5StyleManager
basic class used to read/store RagTime 5/6 styles
Definition: RagTime5StyleManager.hxx:61
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:51
libmwaw_internal.hxx
MWAWSpreadsheetListenerPtr
std::shared_ptr< MWAWSpreadsheetListener > MWAWSpreadsheetListenerPtr
a smart pointer of MWAWSpreadsheetListener
Definition: libmwaw_internal.hxx:563
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:553
RagTime5SpreadsheetInternal
Internal: the structures of a RagTime5Spreadsheet.
Definition: RagTime5Spreadsheet.cxx:69
MWAWCellContent::FormulaInstruction
small class use to define a formula instruction
Definition: MWAWCell.hxx:397
RagTime5ClusterManager::Link
a link to a small zone (or set of zones) in RagTime 5/6 documents
Definition: RagTime5ClusterManager.hxx:113
RagTime5SpreadsheetInternal::CellContent
a struct to store what a cell contains
Definition: RagTime5Spreadsheet.cxx:172
RagTime5SpreadsheetInternal::Sheet
internal: a structure used to store a sheet in RagTime5SpreadsheetInternal
Definition: RagTime5Spreadsheet.cxx:462