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
54 class ClarisWksDocument;
55
57 class ClarisWksDbaseContent
58 {
59 public:
60 struct Record;
61
63 ClarisWksDbaseContent(ClarisWksDocument &document, bool spreadsheet);
65 ~ClarisWksDbaseContent();
67 bool readContent();
68
70 bool getExtrema(MWAWVec2i &min, MWAWVec2i &max) const;
72 bool getRecordList(std::vector<int> &list) const;
74 bool getColumnList(int row, std::vector<int> &list) const;
75
77 bool get(MWAWVec2i const &pos, Record &data) const;
79 bool send(MWAWVec2i const &pos);
81 void setDatabaseFormats(std::vector<ClarisWksStyleManager::CellFormat> const &format);
83 struct Record {
85 Record() : m_style(-1), m_format(), m_hAlign(MWAWCell::HALIGN_DEFAULT), m_fileFormat(0),
86 m_content(), m_valueType(MWAWCellContent::C_UNKNOWN), m_hasNaNValue(false), m_backgroundColor(MWAWColor::white()), m_font(3,9), m_borders(0)
87 {
88 }
90 void updateFormulaCells(MWAWVec2i const &removeDelta);
92 int m_style;
94 MWAWCell::Format m_format;
96 MWAWCell::HorizontalAlignment m_hAlign;
98 int m_fileFormat;
100 MWAWCellContent m_content;
102 MWAWCellContent::Type m_valueType;
104 bool m_hasNaNValue;
106 MWAWColor m_backgroundColor;
108 MWAWFont m_font;
110 int m_borders;
111 };
112 protected:
114 struct Column {
116 Column() : m_idRecordMap()
117 {
118 }
120 std::map<int,Record> m_idRecordMap;
121 };
122
124 bool readColumnList();
126 bool readColumn(int c);
128 bool readRecordList(MWAWVec2i const &where, Column &col);
130 bool readRecordSS(MWAWVec2i const &where, long pos, Record &record);
132 bool readRecordSSV1(MWAWVec2i const &where, long pos, Record &record);
134 bool readRecordDB(MWAWVec2i const &where, long pos, Record &record);
135
137 void send(double val, bool isNotaNumber, ClarisWksStyleManager::CellFormat const &format);
138
139 //
140 // low level
141 //
142
144 bool readCellInFormula(MWAWVec2i const &pos, MWAWCellContent::FormulaInstruction &instr);
146 bool readString(long endPos, std::string &res);
148 bool readNumber(long endPos, double &res, bool &isNan);
150 bool readFormula(MWAWVec2i const &cPos, long endPos,
151 std::vector<MWAWCellContent::FormulaInstruction> &formula, std::string &error);
153 void updateCellPositionsSet() const;
154
156 int m_version;
158 bool m_isSpreadsheet;
159
161 ClarisWksDocument &m_document;
163 MWAWParserStatePtr m_parserState;
164
166 std::map<int, Column> m_idColumnMap;
168 mutable std::set<MWAWVec2i> m_positionSet;
170 std::vector<ClarisWksStyleManager::CellFormat> m_dbFormatList;
171 };
172 #endif
173 // vim: set filetype=cpp tabstop=2 shiftwidth=2 cindent autoindent smartindent noexpandtab:
174
175
MWAWCellContent::FormulaInstruction
small class use to define a formula instruction
Definition: MWAWCell.hxx:359
ClarisWksDbaseContent::send
bool send(MWAWVec2i const &pos)
try to send a cell content to the listener
Definition: ClarisWksDbaseContent.cxx:1107
MWAWCellContent::Type
Type
the different types of cell&#39;s field
Definition: MWAWCell.hxx:390
ClarisWksDbaseContent::Column
struct which stores a column in ClarisWksDbaseContent
Definition: ClarisWksDbaseContent.hxx:114
ClarisWksDbaseContent::readRecordSS
bool readRecordSS(MWAWVec2i const &where, long pos, Record &record)
try to read a spreadsheet record
Definition: ClarisWksDbaseContent.cxx:721
ClarisWksDbaseContent::readContent
bool readContent()
try to read the record structure
Definition: ClarisWksDbaseContent.cxx:168
ClarisWksDbaseContent::Record::m_fileFormat
int m_fileFormat
the format ( in a v1-3 spreadsheet)
Definition: ClarisWksDbaseContent.hxx:98
ClarisWksDbaseContent::Column::Column
Column()
constructor
Definition: ClarisWksDbaseContent.hxx:116
ClarisWksDbaseContent::m_parserState
MWAWParserStatePtr m_parserState
the parser state
Definition: ClarisWksDbaseContent.hxx:163
ClarisWksDbaseContent::Record::m_format
MWAWCell::Format m_format
the format
Definition: ClarisWksDbaseContent.hxx:94
ClarisWksDbaseContent::getColumnList
bool getColumnList(int row, std::vector< int > &list) const
returns the list of filled columns
Definition: ClarisWksDbaseContent.cxx:150
ClarisWksDbaseContent::readRecordDB
bool readRecordDB(MWAWVec2i const &where, long pos, Record &record)
try to read a database record
Definition: ClarisWksDbaseContent.cxx:985
ClarisWksDbaseContent::m_dbFormatList
std::vector< ClarisWksStyleManager::CellFormat > m_dbFormatList
the databse format
Definition: ClarisWksDbaseContent.hxx:170
MWAWEntry.hxx
libmwaw_internal.hxx
MWAWCell::Format
a structure uses to define the format of a cell content
Definition: MWAWCell.hxx:60
ClarisWksDbaseContent::Column::m_idRecordMap
std::map< int, Record > m_idRecordMap
a map line (or record id) to record
Definition: ClarisWksDbaseContent.hxx:120
ClarisWksDbaseContent::Record::m_backgroundColor
MWAWColor m_backgroundColor
the background color
Definition: ClarisWksDbaseContent.hxx:106
ClarisWksDbaseContent::readColumnList
bool readColumnList()
try to read the columns list structure(CTAB)
Definition: ClarisWksDbaseContent.cxx:233
ClarisWksDbaseContent::readNumber
bool readNumber(long endPos, double &res, bool &isNan)
try to read a number
Definition: ClarisWksDbaseContent.cxx:1242
ClarisWksDbaseContent::ClarisWksDbaseContent
ClarisWksDbaseContent(ClarisWksDocument &document, bool spreadsheet)
constructor
Definition: ClarisWksDbaseContent.cxx:59
ClarisWksDbaseContent::m_idColumnMap
std::map< int, Column > m_idColumnMap
a map col id to column
Definition: ClarisWksDbaseContent.hxx:166
MWAWCell::HorizontalAlignment
HorizontalAlignment
the default horizontal alignment.
Definition: MWAWCell.hxx:116
MWAWCell
a structure used to define a cell and its format
Definition: MWAWCell.hxx:52
MWAWColor
the class to store a color
Definition: libmwaw_internal.hxx:196
MWAWCellContent
small class use to define a sheet cell content
Definition: MWAWCell.hxx:355
ClarisWksStyleManager.hxx
ClarisWksDbaseContent::m_isSpreadsheet
bool m_isSpreadsheet
a bool to know if this is a spreadsheet or a database
Definition: ClarisWksDbaseContent.hxx:158
MWAWFont
Class to store font.
Definition: MWAWFont.hxx:43
ClarisWksDbaseContent::Record::m_hasNaNValue
bool m_hasNaNValue
a flag to know if a double result is nan or not
Definition: ClarisWksDbaseContent.hxx:104
ClarisWksDocument
main document information used to create a ClarisWorks file
Definition: ClarisWksDocument.hxx:73
ClarisWksDbaseContent::Record::m_content
MWAWCellContent m_content
the content
Definition: ClarisWksDbaseContent.hxx:100
ClarisWksDbaseContent
small structure used to parse main content of a spreadsheet/database zone
Definition: ClarisWksDbaseContent.hxx:57
MWAWFont.hxx
ClarisWksDbaseContent::Record::m_font
MWAWFont m_font
the font ( in v1-3 spreadsheet)
Definition: ClarisWksDbaseContent.hxx:108
ClarisWksDbaseContent::getRecordList
bool getRecordList(std::vector< int > &list) const
returns the list of filled record/row
Definition: ClarisWksDbaseContent.cxx:127
ClarisWksDbaseContent::getExtrema
bool getExtrema(MWAWVec2i &min, MWAWVec2i &max) const
returns the dimension of the read data
Definition: ClarisWksDbaseContent.cxx:82
ClarisWksDbaseContent::Record::m_hAlign
MWAWCell::HorizontalAlignment m_hAlign
the cell alignment : by default nothing
Definition: ClarisWksDbaseContent.hxx:96
ClarisWksDbaseContent::updateCellPositionsSet
void updateCellPositionsSet() const
update the position set
Definition: ClarisWksDbaseContent.cxx:111
ClarisWksDbaseContent::Record
struct which stores a record in ClarisWksDbaseContent
Definition: ClarisWksDbaseContent.hxx:83
ClarisWksDbaseContent::readString
bool readString(long endPos, std::string &res)
try to read a string
Definition: ClarisWksDbaseContent.cxx:1227
ClarisWksDbaseContent::Record::updateFormulaCells
void updateFormulaCells(MWAWVec2i const &removeDelta)
update the formula cell (removing delta to each position)
Definition: ClarisWksDbaseContent.cxx:1452
ClarisWksDbaseContent::readColumn
bool readColumn(int c)
try to read the column structure(COLM): a list of chnk
Definition: ClarisWksDbaseContent.cxx:299
ClarisWksStyleManager::CellFormat
the CELL structure a structure related to number/date format
Definition: ClarisWksStyleManager.hxx:149
ClarisWksDbaseContent::Record::m_borders
int m_borders
the border in v1-3 spreadsheet
Definition: ClarisWksDbaseContent.hxx:110
ClarisWksDbaseContent::readRecordList
bool readRecordList(MWAWVec2i const &where, Column &col)
try to read a list of records(CHNK)
Definition: ClarisWksDbaseContent.cxx:352
ClarisWksDbaseContent::readRecordSSV1
bool readRecordSSV1(MWAWVec2i const &where, long pos, Record &record)
try to read a spreadsheet record(v1-v3)
Definition: ClarisWksDbaseContent.cxx:431
ClarisWksDbaseContent::m_version
int m_version
the file version
Definition: ClarisWksDbaseContent.hxx:156
ClarisWksDbaseContent::m_document
ClarisWksDocument & m_document
the document
Definition: ClarisWksDbaseContent.hxx:161
MWAWCell.hxx
Defines MWAWCell (cell content and format)
MWAWParserStatePtr
shared_ptr< MWAWParserState > MWAWParserStatePtr
a smart pointer of MWAWParserState
Definition: libmwaw_internal.hxx:523
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:1269
ClarisWksDbaseContent::~ClarisWksDbaseContent
~ClarisWksDbaseContent()
destructor
Definition: ClarisWksDbaseContent.cxx:69
ClarisWksDbaseContent::setDatabaseFormats
void setDatabaseFormats(std::vector< ClarisWksStyleManager::CellFormat > const &format)
set the field format ( for database )
Definition: ClarisWksDbaseContent.cxx:73
ClarisWksDbaseContent::m_positionSet
std::set< MWAWVec2i > m_positionSet
a set of cell position (sorted by row)
Definition: ClarisWksDbaseContent.hxx:168
ClarisWksDbaseContent::readCellInFormula
bool readCellInFormula(MWAWVec2i const &pos, MWAWCellContent::FormulaInstruction &instr)
reads a cell
Definition: ClarisWksDbaseContent.cxx:1189
MWAWVec2< int >
ClarisWksDbaseContent::Record::m_valueType
MWAWCellContent::Type m_valueType
the type of the content value ( original or result of a formula )
Definition: ClarisWksDbaseContent.hxx:102
ClarisWksDbaseContent::Record::m_style
int m_style
the style if known
Definition: ClarisWksDbaseContent.hxx:92
ClarisWksDbaseContent::Record::Record
Record()
contructor
Definition: ClarisWksDbaseContent.hxx:85