ClarisWksDbaseContent.hxx Source File documentation

ClarisWksDbaseContent.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 * The main database content used by Claris Works parser to store spreedsheet/Databese
36 *
37 */
38#ifndef CLARIS_WKS_DBASE_CONTENT
39# define CLARIS_WKS_DBASE_CONTENT
40
41#include <iostream>
42#include <map>
43#include <set>
44#include <vector>
45
46#include "libmwaw_internal.hxx"
47
48#include "MWAWCell.hxx"
49#include "MWAWEntry.hxx"
50#include "MWAWFont.hxx"
51
52#include "ClarisWksStyleManager.hxx"
53
54class ClarisWksDocument;
55
57 class ClarisWksDbaseContent
58{
59public:
60 struct Record;
61
63 ClarisWksDbaseContent(ClarisWksDocument &document, bool spreadsheet);
65 ~ClarisWksDbaseContent();
67 bool readContent();
69 bool readFormula(MWAWVec2i const &cPos, long endPos,
70 std::vector<MWAWCellContent::FormulaInstruction> &formula, std::string &error);
71
73 bool getExtrema(MWAWVec2i &min, MWAWVec2i &max) const;
75 bool getRecordList(std::vector<int> &list) const;
77 bool getColumnList(int row, std::vector<int> &list) const;
78
80 bool get(MWAWVec2i const &pos, Record &data) const;
82 bool send(MWAWVec2i const &pos);
84 void setDatabaseFormats(std::vector<ClarisWksStyleManager::CellFormat> const &format);
86 struct Record {
88 Record()
89 : m_style(-1)
90 , m_format()
91 , m_hAlign(MWAWCell::HALIGN_DEFAULT)
92 , m_fileFormat(0)
93 , m_content()
94 , m_valueType(MWAWCellContent::C_UNKNOWN)
95 , m_hasNaNValue(false)
96 , m_backgroundColor(MWAWColor::white())
97 , m_font(3,9)
98 , m_borders(0)
99 , m_posToFontMap()
100 {
101 }
103 void updateFormulaCells(MWAWVec2i const &removeDelta);
105 int m_style;
107 MWAWCell::Format m_format;
109 MWAWCell::HorizontalAlignment m_hAlign;
111 int m_fileFormat;
113 MWAWCellContent m_content;
115 MWAWCellContent::Type m_valueType;
117 bool m_hasNaNValue;
119 MWAWColor m_backgroundColor;
121 MWAWFont m_font;
123 int m_borders;
125 std::map<int, MWAWFont> m_posToFontMap;
126 };
127protected:
129 struct Column {
131 Column()
132 : m_idRecordMap()
133 {
134 }
136 std::map<int,Record> m_idRecordMap;
137 };
138
140 bool readColumnList();
142 bool readColumn(int c);
144 bool readRecordList(MWAWVec2i const &where, Column &col);
146 bool readRecordSS(MWAWVec2i const &where, long pos, Record &record);
148 bool readRecordSSV1(MWAWVec2i const &where, long pos, Record &record);
150 bool readRecordDB(MWAWVec2i const &where, long pos, Record &record);
151
153 void send(double val, bool isNotaNumber, ClarisWksStyleManager::CellFormat const &format);
154
155 //
156 // low level
157 //
158
160 bool readCellInFormula(MWAWVec2i const &pos, MWAWCellContent::FormulaInstruction &instr);
162 bool readString(long endPos, std::string &res);
164 bool readNumber(long endPos, double &res, bool &isNan);
166 void updateCellPositionsSet() const;
167
169 int m_version;
171 bool m_isSpreadsheet;
172
174 ClarisWksDocument &m_document;
176 MWAWParserStatePtr m_parserState;
177
179 std::map<int, Column> m_idColumnMap;
181 mutable std::set<MWAWVec2i> m_positionSet;
183 std::vector<ClarisWksStyleManager::CellFormat> m_dbFormatList;
184};
185#endif
186// vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
187
188
ClarisWksStyleManager.hxx
MWAWCell.hxx
Defines MWAWCell (cell content and format)
MWAWEntry.hxx
MWAWFont.hxx
ClarisWksDbaseContent
small structure used to parse main content of a spreadsheet/database zone
Definition: ClarisWksDbaseContent.hxx:58
ClarisWksDbaseContent::readRecordSSV1
bool readRecordSSV1(MWAWVec2i const &where, long pos, Record &record)
try to read a spreadsheet record(v1-v3)
Definition: ClarisWksDbaseContent.cxx:431
ClarisWksDbaseContent::readColumnList
bool readColumnList()
try to read the columns list structure(CTAB)
Definition: ClarisWksDbaseContent.cxx:233
ClarisWksDbaseContent::m_idColumnMap
std::map< int, Column > m_idColumnMap
a map col id to column
Definition: ClarisWksDbaseContent.hxx:179
ClarisWksDbaseContent::m_positionSet
std::set< MWAWVec2i > m_positionSet
a set of cell position (sorted by row)
Definition: ClarisWksDbaseContent.hxx:181
ClarisWksDbaseContent::getRecordList
bool getRecordList(std::vector< int > &list) const
returns the list of filled record/row
Definition: ClarisWksDbaseContent.cxx:129
ClarisWksDbaseContent::m_version
int m_version
the file version
Definition: ClarisWksDbaseContent.hxx:169
ClarisWksDbaseContent::readString
bool readString(long endPos, std::string &res)
try to read a string
Definition: ClarisWksDbaseContent.cxx:1264
ClarisWksDbaseContent::getColumnList
bool getColumnList(int row, std::vector< int > &list) const
returns the list of filled columns
Definition: ClarisWksDbaseContent.cxx:150
ClarisWksDbaseContent::readColumn
bool readColumn(int c)
try to read the column structure(COLM): a list of chnk
Definition: ClarisWksDbaseContent.cxx:299
ClarisWksDbaseContent::readFormula
bool readFormula(MWAWVec2i const &cPos, long endPos, std::vector< MWAWCellContent::FormulaInstruction > &formula, std::string &error)
read to read a formula
Definition: ClarisWksDbaseContent.cxx:1306
ClarisWksDbaseContent::getExtrema
bool getExtrema(MWAWVec2i &min, MWAWVec2i &max) const
returns the dimension of the read data
Definition: ClarisWksDbaseContent.cxx:88
ClarisWksDbaseContent::m_isSpreadsheet
bool m_isSpreadsheet
a bool to know if this is a spreadsheet or a database
Definition: ClarisWksDbaseContent.hxx:171
ClarisWksDbaseContent::m_document
ClarisWksDocument & m_document
the document
Definition: ClarisWksDbaseContent.hxx:174
ClarisWksDbaseContent::m_dbFormatList
std::vector< ClarisWksStyleManager::CellFormat > m_dbFormatList
the databse format
Definition: ClarisWksDbaseContent.hxx:183
ClarisWksDbaseContent::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: ClarisWksDbaseContent.hxx:176
ClarisWksDbaseContent::setDatabaseFormats
void setDatabaseFormats(std::vector< ClarisWksStyleManager::CellFormat > const &format)
set the field format ( for database )
Definition: ClarisWksDbaseContent.cxx:79
ClarisWksDbaseContent::ClarisWksDbaseContent
ClarisWksDbaseContent(ClarisWksDocument &document, bool spreadsheet)
constructor
Definition: ClarisWksDbaseContent.cxx:59
ClarisWksDbaseContent::readNumber
bool readNumber(long endPos, double &res, bool &isNan)
try to read a number
Definition: ClarisWksDbaseContent.cxx:1279
ClarisWksDbaseContent::readCellInFormula
bool readCellInFormula(MWAWVec2i const &pos, MWAWCellContent::FormulaInstruction &instr)
reads a cell
Definition: ClarisWksDbaseContent.cxx:1226
ClarisWksDbaseContent::readRecordSS
bool readRecordSS(MWAWVec2i const &where, long pos, Record &record)
try to read a spreadsheet record
Definition: ClarisWksDbaseContent.cxx:721
ClarisWksDbaseContent::readRecordList
bool readRecordList(MWAWVec2i const &where, Column &col)
try to read a list of records(CHNK)
Definition: ClarisWksDbaseContent.cxx:352
ClarisWksDbaseContent::~ClarisWksDbaseContent
~ClarisWksDbaseContent()
destructor
Definition: ClarisWksDbaseContent.cxx:75
ClarisWksDbaseContent::get
bool get(MWAWVec2i const &pos, Record &data) const
retrieves the cell data
Definition: ClarisWksDbaseContent.cxx:1116
ClarisWksDbaseContent::readContent
bool readContent()
try to read the record structure
Definition: ClarisWksDbaseContent.cxx:168
ClarisWksDbaseContent::send
bool send(MWAWVec2i const &pos)
try to send a cell content to the listener
Definition: ClarisWksDbaseContent.cxx:1140
ClarisWksDbaseContent::updateCellPositionsSet
void updateCellPositionsSet() const
update the position set
Definition: ClarisWksDbaseContent.cxx:115
ClarisWksDbaseContent::readRecordDB
bool readRecordDB(MWAWVec2i const &where, long pos, Record &record)
try to read a database record
Definition: ClarisWksDbaseContent.cxx:985
ClarisWksDocument
main document information used to create a ClarisWorks file
Definition: ClarisWksDocument.hxx:74
MWAWCellContent
small class use to define a sheet cell content
Definition: MWAWCell.hxx:394
MWAWCellContent::Type
Type
the different types of cell's field
Definition: MWAWCell.hxx:433
MWAWCell
a structure used to define a cell and its format
Definition: MWAWCell.hxx:53
MWAWCell::HorizontalAlignment
HorizontalAlignment
the default horizontal alignment.
Definition: MWAWCell.hxx:128
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:44
MWAWVec2< int >
libmwaw_internal.hxx
MWAWParserStatePtr
std::shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:557
ClarisWksDbaseContent::Column
struct which stores a column in ClarisWksDbaseContent
Definition: ClarisWksDbaseContent.hxx:129
ClarisWksDbaseContent::Column::Column
Column()
constructor
Definition: ClarisWksDbaseContent.hxx:131
ClarisWksDbaseContent::Column::m_idRecordMap
std::map< int, Record > m_idRecordMap
a map line (or record id) to record
Definition: ClarisWksDbaseContent.hxx:136
ClarisWksDbaseContent::Record
struct which stores a record in ClarisWksDbaseContent
Definition: ClarisWksDbaseContent.hxx:86
ClarisWksDbaseContent::Record::m_hAlign
MWAWCell::HorizontalAlignment m_hAlign
the cell alignment : by default nothing
Definition: ClarisWksDbaseContent.hxx:109
ClarisWksDbaseContent::Record::m_font
MWAWFont m_font
the font ( in v1-3 spreadsheet)
Definition: ClarisWksDbaseContent.hxx:121
ClarisWksDbaseContent::Record::m_fileFormat
int m_fileFormat
the format ( in a v1-3 spreadsheet)
Definition: ClarisWksDbaseContent.hxx:111
ClarisWksDbaseContent::Record::m_borders
int m_borders
the border in v1-3 spreadsheet
Definition: ClarisWksDbaseContent.hxx:123
ClarisWksDbaseContent::Record::m_valueType
MWAWCellContent::Type m_valueType
the type of the content value ( original or result of a formula )
Definition: ClarisWksDbaseContent.hxx:115
ClarisWksDbaseContent::Record::m_backgroundColor
MWAWColor m_backgroundColor
the background color
Definition: ClarisWksDbaseContent.hxx:119
ClarisWksDbaseContent::Record::m_hasNaNValue
bool m_hasNaNValue
a flag to know if a double result is nan or not
Definition: ClarisWksDbaseContent.hxx:117
ClarisWksDbaseContent::Record::m_style
int m_style
the style if known
Definition: ClarisWksDbaseContent.hxx:105
ClarisWksDbaseContent::Record::Record
Record()
contructor
Definition: ClarisWksDbaseContent.hxx:88
ClarisWksDbaseContent::Record::updateFormulaCells
void updateFormulaCells(MWAWVec2i const &removeDelta)
update the formula cell (removing delta to each position)
Definition: ClarisWksDbaseContent.cxx:1505
ClarisWksDbaseContent::Record::m_posToFontMap
std::map< int, MWAWFont > m_posToFontMap
map id to font ( in database)
Definition: ClarisWksDbaseContent.hxx:125
ClarisWksDbaseContent::Record::m_format
MWAWCell::Format m_format
the format
Definition: ClarisWksDbaseContent.hxx:107
ClarisWksDbaseContent::Record::m_content
MWAWCellContent m_content
the content
Definition: ClarisWksDbaseContent.hxx:113
ClarisWksStyleManager::CellFormat
the CELL structure a structure related to number/date format
Definition: ClarisWksStyleManager.hxx:151
MWAWCellContent::FormulaInstruction
small class use to define a formula instruction
Definition: MWAWCell.hxx:397
MWAWCell::Format
a structure uses to define the format of a cell content
Definition: MWAWCell.hxx:60
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:192