Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
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 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #ifndef OOX_XLS_SHEETDATABUFFER_HXX
21 : #define OOX_XLS_SHEETDATABUFFER_HXX
22 :
23 : #include <list>
24 : #include <map>
25 : #include "richstring.hxx"
26 : #include "worksheethelper.hxx"
27 :
28 : namespace com { namespace sun { namespace star {
29 : namespace util { struct DateTime; }
30 : } } }
31 :
32 : namespace oox {
33 : namespace xls {
34 :
35 : /** Stores basic data about cell values and formatting. */
36 : struct CellModel
37 : {
38 : ::com::sun::star::table::CellAddress
39 : maCellAddr; /// The address of the current cell.
40 : sal_Int32 mnCellType; /// Data type of the cell value.
41 : sal_Int32 mnXfId; /// XF (cell formatting) identifier.
42 : bool mbShowPhonetic; /// True = show phonetic text.
43 :
44 : explicit CellModel();
45 : };
46 :
47 : /** Stores data about cell formulas. */
48 : struct CellFormulaModel
49 : {
50 : ::com::sun::star::table::CellRangeAddress
51 : maFormulaRef; /// Formula range for array/shared formulas and data tables.
52 : sal_Int32 mnFormulaType; /// Type of the formula (regular, array, shared, table).
53 : sal_Int32 mnSharedId; /// Identifier of a shared formula (OOXML only).
54 :
55 : explicit CellFormulaModel();
56 :
57 : /** Returns true, if the passed cell address is valid for an array formula. */
58 : bool isValidArrayRef( const ::com::sun::star::table::CellAddress& rCellAddr );
59 : /** Returns true, if the passed cell address is valid for a shared formula. */
60 : bool isValidSharedRef( const ::com::sun::star::table::CellAddress& rCellAddr );
61 : };
62 :
63 : /** Stores data about table operations. */
64 0 : struct DataTableModel
65 : {
66 : OUString maRef1; /// First reference cell for table operations.
67 : OUString maRef2; /// Second reference cell for table operations.
68 : bool mb2dTable; /// True = 2-dimensional data table.
69 : bool mbRowTable; /// True = row oriented data table.
70 : bool mbRef1Deleted; /// True = first reference cell deleted.
71 : bool mbRef2Deleted; /// True = second reference cell deleted.
72 :
73 : explicit DataTableModel();
74 : };
75 :
76 : /** Manages all cell blocks currently in use. */
77 0 : class CellBlockBuffer : public WorksheetHelper
78 : {
79 : public:
80 : explicit CellBlockBuffer( const WorksheetHelper& rHelper );
81 :
82 : /** Sets column span information for a row. */
83 : void setColSpans( sal_Int32 nRow, const ValueRangeSet& rColSpans );
84 :
85 : /** Inserts all cells of all open cell blocks into the Calc document. */
86 : void finalizeImport();
87 :
88 : private:
89 : typedef ::std::map< sal_Int32, ValueRangeVector > ColSpanVectorMap;
90 :
91 : ColSpanVectorMap maColSpans; /// Buffereed column spans, mapped by row index.
92 : sal_Int32 mnCurrRow; /// Current row index used for buffered cell import.
93 : };
94 :
95 :
96 : /** Manages the cell contents and cell formatting of a sheet.
97 : */
98 0 : class SheetDataBuffer : public WorksheetHelper
99 : {
100 : public:
101 : explicit SheetDataBuffer( const WorksheetHelper& rHelper );
102 :
103 : /** Sets column span information for a row. */
104 : void setColSpans( sal_Int32 nRow, const ValueRangeSet& rColSpans );
105 :
106 : /** Inserts a blank cell (with formatting) into the sheet. */
107 : void setBlankCell( const CellModel& rModel );
108 : /** Inserts a value cell into the sheet. */
109 : void setValueCell( const CellModel& rModel, double fValue );
110 : /** Inserts a simple string cell into the sheet. */
111 : void setStringCell( const CellModel& rModel, const OUString& rText );
112 : /** Inserts a rich-string cell into the sheet. */
113 : void setStringCell( const CellModel& rModel, const RichStringRef& rxString );
114 : /** Inserts a shared string cell into the sheet. */
115 : void setStringCell( const CellModel& rModel, sal_Int32 nStringId );
116 : /** Inserts a date/time cell into the sheet and adjusts number format. */
117 : void setDateTimeCell( const CellModel& rModel, const ::com::sun::star::util::DateTime& rDateTime );
118 : /** Inserts a boolean cell into the sheet and adjusts number format. */
119 : void setBooleanCell( const CellModel& rModel, bool bValue );
120 : /** Inserts an error cell from the passed error code into the sheet. */
121 : void setErrorCell( const CellModel& rModel, const OUString& rErrorCode );
122 : /** Inserts an error cell from the passed BIFF error code into the sheet. */
123 : void setErrorCell( const CellModel& rModel, sal_uInt8 nErrorCode );
124 : /** Inserts a formula cell into the sheet. */
125 : void setFormulaCell( const CellModel& rModel, const ApiTokenSequence& rTokens );
126 : /** Inserts a ISO 8601 date cell into the sheet. */
127 : void setDateCell( const CellModel& rModel, const OUString& rDateString );
128 :
129 : /** Inserts the passed token array as array formula. */
130 : void createArrayFormula(
131 : const ::com::sun::star::table::CellRangeAddress& rRange,
132 : const ApiTokenSequence& rTokens );
133 : /** Sets a multiple table operation to the passed range. */
134 : void createTableOperation(
135 : const ::com::sun::star::table::CellRangeAddress& rRange,
136 : const DataTableModel& rModel );
137 :
138 : /** Sets default cell formatting for the specified range of rows. */
139 : void setRowFormat( sal_Int32 nRow, sal_Int32 nXfId, bool bCustomFormat );
140 : /** Merges the cells in the passed cell range. */
141 : void setMergedRange( const ::com::sun::star::table::CellRangeAddress& rRange );
142 : /** Sets a standard number format (constant from com.sun.star.util.NumberFormat) to the specified cell. */
143 : void setStandardNumFmt(
144 : const ::com::sun::star::table::CellAddress& rCellAddr,
145 : sal_Int16 nStdNumFmt );
146 : /** Processes the cell formatting data of the passed cell.
147 : @param nNumFmtId If set, overrides number format of the cell XF. */
148 : void setCellFormat( const CellModel& rModel, sal_Int32 nNumFmtId = -1 );
149 :
150 :
151 : /** Final processing after the sheet has been imported. */
152 : void finalizeImport();
153 :
154 : private:
155 : struct XfIdRowRange;
156 :
157 : /** Sets the passed formula token array into a cell. */
158 : void setCellFormula(
159 : const ::com::sun::star::table::CellAddress& rCellAddr,
160 : const ApiTokenSequence& rTokens );
161 :
162 : /** Creates a formula token array representing the shared formula with the
163 : passed identifier. */
164 : ApiTokenSequence resolveSharedFormula( const BinAddress& rMapKey ) const;
165 :
166 : /** Inserts the passed array formula into the sheet. */
167 : void finalizeArrayFormula(
168 : const ::com::sun::star::table::CellRangeAddress& rRange,
169 : const ApiTokenSequence& rTokens ) const;
170 : /** Inserts the passed table operation into the sheet. */
171 : void finalizeTableOperation(
172 : const ::com::sun::star::table::CellRangeAddress& rRange, const DataTableModel& rModel );
173 :
174 : /** Writes all cell formatting attributes to the passed cell range list. (depreciates writeXfIdRangeProperties) */
175 : void applyCellMerging( const ::com::sun::star::table::CellRangeAddress& rRange );
176 : void addColXfStyle( sal_Int32 nXfId, sal_Int32 nFormatId, const ::com::sun::star::table::CellRangeAddress& rAddress, bool bProcessRowRange = false );
177 : private:
178 : /** Stores cell range address and formula token array of an array formula. */
179 : typedef ::std::pair< ::com::sun::star::table::CellRangeAddress, ApiTokenSequence > ArrayFormula;
180 : typedef ::std::list< ArrayFormula > ArrayFormulaList;
181 :
182 : /** Stores cell range address and settings of a table operation. */
183 : typedef ::std::pair< ::com::sun::star::table::CellRangeAddress, DataTableModel > TableOperation;
184 : typedef ::std::list< TableOperation > TableOperationList;
185 :
186 :
187 : /** Stores information about a range of rows with equal cell formatting. */
188 : struct XfIdRowRange
189 : {
190 : ValueRange maRowRange; /// Indexes of first and last row.
191 : sal_Int32 mnXfId; /// XF identifier for the row range.
192 :
193 : explicit XfIdRowRange();
194 : void set( sal_Int32 nRow, sal_Int32 nXfId );
195 : bool tryExpand( sal_Int32 nRow, sal_Int32 nXfId );
196 : };
197 :
198 : typedef ::std::pair< sal_Int32, sal_Int32 > XfIdNumFmtKey;
199 : typedef ::std::map< XfIdNumFmtKey, ApiCellRangeList > XfIdRangeListMap;
200 :
201 : typedef ::std::pair< sal_Int32, sal_Int32 > RowRange;
202 0 : struct RowRangeStyle
203 : {
204 : sal_Int32 mnStartRow;
205 : sal_Int32 mnEndRow;
206 : XfIdNumFmtKey mnNumFmt;
207 : };
208 : struct StyleRowRangeComp
209 : {
210 0 : bool operator() (const RowRangeStyle& lhs, const RowRangeStyle& rhs) const
211 : {
212 0 : return lhs.mnEndRow<rhs.mnStartRow;
213 : }
214 : };
215 : typedef ::std::set< RowRangeStyle, StyleRowRangeComp > RowStyles;
216 : typedef ::std::map< sal_Int32, RowStyles > ColStyles;
217 : /** Stores information about a merged cell range. */
218 : struct MergedRange
219 : {
220 : ::com::sun::star::table::CellRangeAddress
221 : maRange; /// The formatted cell range.
222 : sal_Int32 mnHorAlign; /// Horizontal alignment in the range.
223 :
224 : explicit MergedRange( const ::com::sun::star::table::CellRangeAddress& rRange );
225 : explicit MergedRange( const ::com::sun::star::table::CellAddress& rAddress, sal_Int32 nHorAlign );
226 : bool tryExpand( const ::com::sun::star::table::CellAddress& rAddress, sal_Int32 nHorAlign );
227 : };
228 : typedef ::std::list< MergedRange > MergedRangeList;
229 :
230 : ColStyles maStylesPerColumn; /// Stores cell styles by column ( in row ranges )
231 : CellBlockBuffer maCellBlocks; /// Manages all open cell blocks.
232 : ArrayFormulaList maArrayFormulas; /// All array formulas in the sheet.
233 : TableOperationList maTableOperations; /// All table operations in the sheet.
234 : SharedFormulaMap maSharedFormulas; /// Maps shared formula base address to defined name token index.
235 : ::com::sun::star::table::CellAddress
236 : maSharedFmlaAddr; /// Address of a cell containing a pending shared formula.
237 : BinAddress maSharedBaseAddr; /// Base address of the pending shared formula.
238 : XfIdRowRange maXfIdRowRange; /// Cached XF identifier for a range of rows.
239 : XfIdRangeListMap maXfIdRangeLists; /// Collected XF identifiers for cell rangelists.
240 : MergedRangeList maMergedRanges; /// Merged cell ranges.
241 : MergedRangeList maCenterFillRanges; /// Merged cell ranges from 'center across' or 'fill' alignment.
242 : bool mbPendingSharedFmla; /// True = maSharedFmlaAddr and maSharedBaseAddr are valid.
243 : std::map< sal_Int32, std::vector< ValueRange > > maXfIdRowRangeList; /// Cached XF identifiers for a ranges of rows, we try and process rowranges with the same XF id together
244 : };
245 :
246 : } // namespace xls
247 : } // namespace oox
248 :
249 : #endif
250 :
251 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
