sc/source/filter/inc/sheetdatabuffer.hxx

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