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