sc/inc/columnspanset.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
  10 #pragma once
  11
  12 #include "address.hxx"
  13
  14 #include <vector>
  15 #include <mdds/flat_segment_tree.hpp>
  16
  17 class ScDocument;
  18 class ScColumn;
  19 class ScMarkData;
  20 class ScRangeList;
  21 struct ScSheetLimits;
  22
  23 namespace sc {
  24
  25 struct ColumnBlockConstPosition;
  26 class SingleColumnSpanSet;
  27
  28 struct RowSpan
  29 {
  30     SCROW mnRow1;
  31     SCROW mnRow2;
  32
  33     RowSpan(SCROW nRow1, SCROW nRow2);
  34 };
  35
  36 struct SC_DLLPUBLIC ColRowSpan
  37 {
  38     SCCOLROW mnStart;
  39     SCCOLROW mnEnd;
  40
  41     ColRowSpan(SCCOLROW nStart, SCCOLROW nEnd);
  42 };
  43
  44 /**
  45  * Structure that stores segments of boolean flags per column, and perform
  46  * custom action on those segments.
  47  */
  48 class ColumnSpanSet
  49 {
  50 public:
  51     typedef mdds::flat_segment_tree<SCROW, bool> ColumnSpansType;
  52
  53 private:
  54     struct ColumnType
  55     {
  56         ColumnSpansType maSpans;
  57         ColumnSpansType::const_iterator miPos;
  58
  59         ColumnType(SCROW nStart, SCROW nEnd, bool bInit);
  60     };
  61
  62     typedef std::vector<std::unique_ptr<ColumnType>> TableType;
  63
  64     std::vector<TableType> maTables;
  65
  66     ColumnType& getColumn(const ScDocument& rDoc, SCTAB nTab, SCCOL nCol);
  67
  68 public:
  69     class Action
  70     {
  71     public:
  72         virtual ~Action() = 0;
  73         virtual void startColumn(SCTAB nTab, SCCOL nCol);
  74         virtual void execute(const ScAddress& rPos, SCROW nLength, bool bVal) = 0;
  75     };
  76
  77     class ColumnAction
  78     {
  79     public:
  80         virtual ~ColumnAction() = 0;
  81         virtual void startColumn(ScColumn* pCol) = 0;
  82         virtual void execute(SCROW nRow1, SCROW nRow2, bool bVal) = 0;
  83     };
  84
  85     ColumnSpanSet();
  86     ColumnSpanSet(const ColumnSpanSet&) = delete;
  87     ColumnSpanSet& operator=(const ColumnSpanSet&) = delete;
  88     ColumnSpanSet(ColumnSpanSet&&) = default;
  89     ColumnSpanSet& operator=(ColumnSpanSet&&) = default;
  90     ~ColumnSpanSet();
  91
  92     void set(const ScDocument& rDoc, SCTAB nTab, SCCOL nCol, SCROW nRow, bool bVal);
  93     void set(const ScDocument& rDoc, SCTAB nTab, SCCOL nCol, SCROW nRow1, SCROW nRow2, bool bVal);
  94     void set(const ScDocument& rDoc, const ScRange& rRange, bool bVal);
  95
  96     void set(const ScDocument& rDoc, SCTAB nTab, SCCOL nCol, const SingleColumnSpanSet& rSingleSet, bool bVal );
  97
  98     /**
  99      * Scan specified range in a specified sheet and mark all non-empty cells
 100      * with specified boolean value.
 101      */
 102     void scan(const ScDocument& rDoc, SCTAB nTab, SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2, bool bVal);
 103
 104     void executeAction(ScDocument& rDoc, Action& ac) const;
 105     void executeColumnAction(ScDocument& rDoc, ColumnAction& ac) const;
 106 };
 107
 108 /**
 109  * Keep track of spans in a single column only.
 110  */
 111 class SingleColumnSpanSet
 112 {
 113 public:
 114     typedef mdds::flat_segment_tree<SCROW, bool> ColumnSpansType;
 115
 116     typedef std::vector<RowSpan> SpansType;
 117
 118     SingleColumnSpanSet(ScSheetLimits const &);
 119
 120     /**
 121      * Scan an entire column and tag all non-empty cell positions.
 122      */
 123     void scan(const ScColumn& rColumn);
 124
 125     /**
 126      * Scan a column between specified range, and tag all non-empty cell
 127      * positions.
 128      */
 129     void scan(const ScColumn& rColumn, SCROW nStart, SCROW nEnd);
 130
 131     void scan(
 132         ColumnBlockConstPosition& rBlockPos, const ScColumn& rColumn, SCROW nStart, SCROW nEnd);
 133
 134     /**
 135      * Scan all marked data and tag all marked segments in specified column.
 136      */
 137     void scan(const ScMarkData& rMark, SCTAB nTab, SCCOL nCol);
 138
 139     void scan(const ScRangeList& rRanges, SCTAB nTab, SCCOL nCol);
 140
 141     void set(SCROW nRow1, SCROW nRow2, bool bVal);
 142
 143     void getRows(std::vector<SCROW> &rRows) const;
 144
 145     void getSpans(SpansType& rSpans) const;
 146
 147     void swap( SingleColumnSpanSet& r );
 148
 149     /** Whether there isn't any row tagged. */
 150     bool empty() const;
 151
 152 private:
 153     ScSheetLimits const & mrSheetLimits;
 154     ColumnSpansType maSpans;
 155 };
 156
 157 /**
 158  * Optimized ColumnSpanSet version that operates on a single ScRange.
 159  */
 160 class RangeColumnSpanSet
 161 {
 162 public:
 163     RangeColumnSpanSet( const ScRange& spanRange )
 164          : range( spanRange ) {}
 165     void executeColumnAction(ScDocument& rDoc, sc::ColumnSpanSet::ColumnAction& ac) const;
 166 private:
 167     ScRange range;
 168 };
 169
 170
 171 }
 172
 173 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */