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 "MWAWDebug.hxx"
50 #include "MWAWInputStream.hxx"
51 #include "MWAWPosition.hxx"
52
53 #include "RagTime5StructManager.hxx"
54 #include "RagTime5ClusterManager.hxx"
55
56 namespace RagTime5SpreadsheetInternal
57 {
58 struct CellContent;
59 struct Sheet;
60 struct State;
61
62 class SubDocument;
63 }
64
65 class RagTime5Parser;
66 class RagTime5StructManager;
67 class RagTime5StyleManager;
68 class RagTime5Zone;
69
75 class RagTime5Spreadsheet
76 {
77 friend class RagTime5SpreadsheetInternal::SubDocument;
78 friend class RagTime5Parser;
79
80 public:
82 explicit RagTime5Spreadsheet(RagTime5Parser &parser);
84 virtual ~RagTime5Spreadsheet();
85
87 int version() const;
88
90 int numPages() const;
91
92 protected:
93
94 //
95 // send data
96 //
97
99 bool send(int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0);
101 bool send(RagTime5SpreadsheetInternal::Sheet &sheet,
102 MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0);
104 bool send(RagTime5SpreadsheetInternal::Sheet &sheet,
105 RagTime5SpreadsheetInternal::CellContent const &cell, int numRepeated,
106 MWAWSpreadsheetListenerPtr &listener);
108 void flushExtra();
109
110 // interface with main parser
111
113 std::shared_ptr<RagTime5ClusterManager::Cluster> readSpreadsheetCluster(RagTime5Zone &zone, int zoneType);
114
115 //
116 // Intermediate level
117 //
118
120 bool readSheetDimensions(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link);
122 bool readValuesTree(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link, int rootId, MWAWVec3i const &maxPos);
124 bool readCellBlocks(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link, bool unionBlock);
126 bool readCellRefPos(RagTime5Zone &zone, RagTime5ClusterManager::Link const &link);
127
128 //
129 // basic
130 //
131
132 //
133 // low level
134 //
135
136
137 private:
138 RagTime5Spreadsheet(RagTime5Spreadsheet const &orig) = delete;
139 RagTime5Spreadsheet &operator=(RagTime5Spreadsheet const &orig) = delete;
140
141 protected:
142 //
143 // data
144 //
146 RagTime5Parser &m_mainParser;
147
149 std::shared_ptr<RagTime5StructManager> m_structManager;
151 std::shared_ptr<RagTime5StyleManager> m_styleManager;
153 MWAWParserStatePtr m_parserState;
154
156 std::shared_ptr<RagTime5SpreadsheetInternal::State> m_state;
157 };
158 #endif
159 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:553
RagTime5Spreadsheet::m_styleManager
std::shared_ptr< RagTime5StyleManager > m_styleManager
the style manager
Definition: RagTime5Spreadsheet.hxx:151
libmwaw_internal.hxx
MWAWListenerPtr
std::shared_ptr< MWAWListener > MWAWListenerPtr
a smart pointer of MWAWListener
Definition: libmwaw_internal.hxx:549
MWAWSpreadsheetListenerPtr
std::shared_ptr< MWAWSpreadsheetListener > MWAWSpreadsheetListenerPtr
a smart pointer of MWAWSpreadsheetListener
Definition: libmwaw_internal.hxx:559
RagTime5SpreadsheetInternal::Sheet
internal: a structure used to store a sheet in RagTime5SpreadsheetInternal
Definition: RagTime5Spreadsheet.cxx:448
RagTime5SpreadsheetInternal::CellContent
a struct to store what a cell contains
Definition: RagTime5Spreadsheet.cxx:169
RagTime5Spreadsheet::m_mainParser
RagTime5Parser & m_mainParser
the parser
Definition: RagTime5Spreadsheet.hxx:146
RagTime5StructManager.hxx
RagTime5Spreadsheet::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: RagTime5Spreadsheet.hxx:153
RagTime5Spreadsheet::RagTime5Spreadsheet
RagTime5Spreadsheet(RagTime5Parser &parser)
constructor
Definition: RagTime5Spreadsheet.cxx:1380
RagTime5StyleManager
basic class used to read/store RagTime 5/6 styles
Definition: RagTime5StyleManager.hxx:60
RagTime5Spreadsheet::numPages
int numPages() const
returns the number of pages
Definition: RagTime5Spreadsheet.cxx:1398
RagTime5Spreadsheet::SubDocument
friend class RagTime5SpreadsheetInternal::SubDocument
Definition: RagTime5Spreadsheet.hxx:77
MWAWVec3< int >
RagTime5Zone
main zone in a RagTime v5-v6 document
Definition: RagTime5StructManager.hxx:48
RagTime5Spreadsheet::send
bool send(int zoneId, MWAWListenerPtr listener, MWAWPosition const &pos, int partId=0)
try to send the cluster zone
Definition: RagTime5Spreadsheet.cxx:1771
RagTime5Spreadsheet::readSheetDimensions
bool readSheetDimensions(RagTime5SpreadsheetInternal::Sheet &sheet, RagTime5Zone &zone, RagTime5ClusterManager::Link const &link)
try to read the spreadsheet dimensions
Definition: RagTime5Spreadsheet.cxx:1408
RagTime5Spreadsheet::version
int version() const
returns the file version
Definition: RagTime5Spreadsheet.cxx:1393
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:1592
RagTime5Spreadsheet
the main class to read the spreadsheet part of RagTime 56 file
Definition: RagTime5Spreadsheet.hxx:75
RagTime5Spreadsheet::~RagTime5Spreadsheet
virtual ~RagTime5Spreadsheet()
destructor
Definition: RagTime5Spreadsheet.cxx:1389
RagTime5SpreadsheetInternal
Internal: the structures of a RagTime5Spreadsheet.
Definition: RagTime5Spreadsheet.cxx:66
RagTime5Spreadsheet::flushExtra
void flushExtra()
sends the data which have not yet been sent to the listener
Definition: RagTime5Spreadsheet.cxx:1970
RagTime5Parser
the main class to read a RagTime v5 file
Definition: RagTime5Parser.hxx:73
MWAWInputStream.hxx
MWAWDebug.hxx
RagTime5Spreadsheet::readCellRefPos
bool readCellRefPos(RagTime5Zone &zone, RagTime5ClusterManager::Link const &link)
try to read the cell ref ??? zone
Definition: RagTime5Spreadsheet.cxx:1721
RagTime5Spreadsheet::m_state
std::shared_ptr< RagTime5SpreadsheetInternal::State > m_state
the state
Definition: RagTime5Spreadsheet.hxx:156
RagTime5Spreadsheet::m_structManager
std::shared_ptr< RagTime5StructManager > m_structManager
the structure manager
Definition: RagTime5Spreadsheet.hxx:149
RagTime5Spreadsheet::readSpreadsheetCluster
std::shared_ptr< RagTime5ClusterManager::Cluster > readSpreadsheetCluster(RagTime5Zone &zone, int zoneType)
try to read a spreadsheet cluster
Definition: RagTime5Spreadsheet.cxx:2739
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:1488
MWAWPosition.hxx
MWAWPosition
Class to define the position of an object (textbox, picture, ..) in the document. ...
Definition: MWAWPosition.hxx:47
RagTime5StructManager
basic class used to store RagTime 5/6 structures
Definition: RagTime5StructManager.hxx:170
RagTime5Spreadsheet::operator=
RagTime5Spreadsheet & operator=(RagTime5Spreadsheet const &orig)=delete
RagTime5ClusterManager.hxx
RagTime5ClusterManager::Link
a link to a small zone (or set of zones) in RagTime 5/6 documents
Definition: RagTime5ClusterManager.hxx:105