sc/source/filter/inc/tablebuffer.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 #pragma once
  21
  22 #include "autofilterbuffer.hxx"
  23 #include "tablecolumnsbuffer.hxx"
  24 #include "workbookhelper.hxx"
  25
  26 namespace oox::xls {
  27
  28 struct TableModel
  29 {
  30     ScRange             maRange;            /// Original (unchecked) range of the table.
  31     OUString            maProgName;         /// Programmatical name.
  32     OUString            maDisplayName;      /// Display name.
  33     sal_Int32           mnId;               /// Unique table identifier.
  34     sal_Int32           mnType;             /// Table type (worksheet, query, etc.).
  35     sal_Int32           mnHeaderRows;       /// Number of header rows.
  36     sal_Int32           mnTotalsRows;       /// Number of totals rows.
  37
  38     explicit            TableModel();
  39 };
  40
  41 class Table : public WorkbookHelper
  42 {
  43 public:
  44     explicit            Table( const WorkbookHelper& rHelper );
  45
  46     /** Imports a table definition from the passed attributes. */
  47     void                importTable( const AttributeList& rAttribs, sal_Int16 nSheet );
  48     /** Imports a table definition from a TABLE record. */
  49     void                importTable( SequenceInputStream& rStrm, sal_Int16 nSheet );
  50     /** Creates a new auto filter and stores it internally. */
  51     AutoFilter&  createAutoFilter() { return maAutoFilters.createAutoFilter(); }
  52     /** Creates a new tableColumns handler and stores it internally. */
  53     TableColumns&  createTableColumns() { return maTableColumns.createTableColumns(); }
  54
  55     /** Creates a database range from this tables. */
  56     void                finalizeImport();
  57     void                applyAutoFilters();
  58     void                applyTableColumns();
  59
  60     /** Returns the unique table identifier. */
  61     sal_Int32    getTableId() const { return maModel.mnId; }
  62     /** Returns the token index used in API token arrays (com.sun.star.sheet.FormulaToken). */
  63     sal_Int32    getTokenIndex() const { return mnTokenIndex; }
  64     /** Returns the original display name of the table. */
  65     const OUString& getDisplayName() const { return maModel.maDisplayName; }
  66
  67     /** Returns the original (unchecked) total range of the table. */
  68     const ScRange& getOriginalRange() const { return maModel.maRange; }
  69     /** Returns the cell range of this table. */
  70     const ScRange& getRange() const { return maDestRange; }
  71     /** Returns the number of columns of this table. */
  72     SCCOL        getWidth() const { return maDestRange.aEnd.Col() - maDestRange.aStart.Col() + 1; }
  73     /** Returns the number of rows of this table. */
  74     SCROW        getHeight() const { return maDestRange.aEnd.Row() - maDestRange.aStart.Row() + 1; }
  75     /** Returns the number of header rows in the table range. */
  76     sal_Int32    getHeaderRows() const { return maModel.mnHeaderRows; }
  77     /** Returns the number of totals rows in the table range. */
  78     sal_Int32    getTotalsRows() const { return maModel.mnTotalsRows; }
  79
  80 private:
  81     TableModel          maModel;
  82     AutoFilterBuffer    maAutoFilters;      /// Filter settings for this table.
  83     TableColumnsBuffer  maTableColumns;     /// Column names of this table.
  84     OUString            maDBRangeName;      /// Name of the database range in the Calc document.
  85     ScRange             maDestRange;        /// Validated range of the table in the worksheet.
  86     sal_Int32           mnTokenIndex;       /// Token index used in API token array.
  87 };
  88
  89 typedef std::shared_ptr< Table > TableRef;
  90
  91 class TableBuffer : public WorkbookHelper
  92 {
  93 public:
  94     explicit            TableBuffer( const WorkbookHelper& rHelper );
  95
  96     /** Creates a new empty table. */
  97     Table&              createTable();
  98
  99     /** Creates database ranges from all imported tables. */
 100     void                finalizeImport();
 101     /** Applies autofilters from created database range ( requires finalizeImport to have run before being called */
 102     void                applyAutoFilters();
 103     /** Applies columns names from created database range ( requires finalizeImport to have run before being called */
 104     void                applyTableColumns();
 105     /** Returns a table by its identifier. */
 106     TableRef            getTable( sal_Int32 nTableId ) const;
 107     /** Returns a table by its display name. */
 108     TableRef            getTable( const OUString& rDispName ) const;
 109
 110 private:
 111     /** Inserts the passed table into the maps according to its identifier and name. */
 112     void                insertTableToMaps( const TableRef& rxTable );
 113
 114 private:
 115     typedef RefVector< Table >           TableVector;
 116
 117     TableVector         maTables;
 118     RefMap< sal_Int32, Table >  maIdTables;
 119     RefMap< OUString, Table >   maNameTables;
 120 };
 121
 122 } // namespace oox::xls
 123
 124 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */