office-gobmx/sc/inc/columnspanset.hxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#pragma once

#include "address.hxx"

#include <optional>
#include <vector>
#include <mdds/flat_segment_tree.hpp>

class ScDocument;
class ScColumn;
class ScMarkData;
class ScRangeList;
struct ScSheetLimits;

namespace sc {

struct ColumnBlockConstPosition;
class SingleColumnSpanSet;

struct RowSpan
{
    SCROW mnRow1;
    SCROW mnRow2;

    RowSpan(SCROW nRow1, SCROW nRow2);
};

struct SC_DLLPUBLIC ColRowSpan
{
    SCCOLROW mnStart;
    SCCOLROW mnEnd;

    ColRowSpan(SCCOLROW nStart, SCCOLROW nEnd);
};

/**
 * Structure that stores segments of boolean flags per column, and perform
 * custom action on those segments.
 */
class ColumnSpanSet
{
public:
    typedef mdds::flat_segment_tree<SCROW, bool> ColumnSpansType;

private:
    struct ColumnType
    {
        ColumnSpansType maSpans;
        ColumnSpansType::const_iterator miPos;

        ColumnType(SCROW nStart, SCROW nEnd, bool bInit);
    };

    typedef std::vector<std::optional<ColumnType>> TableType;

    std::vector<TableType> maTables;

    ColumnType& getColumn(const ScDocument& rDoc, SCTAB nTab, SCCOL nCol);

public:
    class Action
    {
    public:
        virtual ~Action() = 0;
        virtual void startColumn(SCTAB nTab, SCCOL nCol);
        virtual void execute(const ScAddress& rPos, SCROW nLength, bool bVal) = 0;
    };

    class ColumnAction
    {
    public:
        virtual ~ColumnAction() = 0;
        virtual void startColumn(ScColumn* pCol) = 0;
        virtual void execute(SCROW nRow1, SCROW nRow2, bool bVal) = 0;
    };

    ColumnSpanSet();
    ColumnSpanSet(const ColumnSpanSet&) = delete;
    ColumnSpanSet& operator=(const ColumnSpanSet&) = delete;
    ColumnSpanSet(ColumnSpanSet&&) = default;
    ColumnSpanSet& operator=(ColumnSpanSet&&) = default;
    ~ColumnSpanSet();

    void set(const ScDocument& rDoc, SCTAB nTab, SCCOL nCol, SCROW nRow, bool bVal);
    void set(const ScDocument& rDoc, SCTAB nTab, SCCOL nCol, SCROW nRow1, SCROW nRow2, bool bVal);
    void set(const ScDocument& rDoc, const ScRange& rRange, bool bVal);

    void set(const ScDocument& rDoc, SCTAB nTab, SCCOL nCol, const SingleColumnSpanSet& rSingleSet, bool bVal );

    /**
     * Scan specified range in a specified sheet and mark all non-empty cells
     * with specified boolean value.
     */
    void scan(const ScDocument& rDoc, SCTAB nTab, SCCOL nCol1, SCROW nRow1, SCCOL nCol2, SCROW nRow2, bool bVal);

    void executeAction(ScDocument& rDoc, Action& ac) const;
    void executeColumnAction(ScDocument& rDoc, ColumnAction& ac) const;
};

/**
 * Keep track of spans in a single column only.
 */
class SingleColumnSpanSet
{
public:
    typedef mdds::flat_segment_tree<SCROW, bool> ColumnSpansType;

    typedef std::vector<RowSpan> SpansType;

    SingleColumnSpanSet(ScSheetLimits const &);

    /**
     * Scan an entire column and tag all non-empty cell positions.
     */
    void scan(const ScColumn& rColumn);

    /**
     * Scan a column between specified range, and tag all non-empty cell
     * positions.
     */
    void scan(const ScColumn& rColumn, SCROW nStart, SCROW nEnd);

    void scan(
        ColumnBlockConstPosition& rBlockPos, const ScColumn& rColumn, SCROW nStart, SCROW nEnd);

    /**
     * Scan all marked data and tag all marked segments in specified column.
     */
    void scan(const ScMarkData& rMark, SCTAB nTab, SCCOL nCol);

    void scan(const ScRangeList& rRanges, SCTAB nTab, SCCOL nCol);

    void set(SCROW nRow1, SCROW nRow2, bool bVal);

    void getRows(std::vector<SCROW> &rRows) const;

    void getSpans(SpansType& rSpans) const;

    void swap( SingleColumnSpanSet& r );

    /** Whether there isn't any row tagged. */
    bool empty() const;

private:
    ScSheetLimits const & mrSheetLimits;
    ColumnSpansType maSpans;
};

/**
 * Optimized ColumnSpanSet version that operates on a single ScRange.
 */
class RangeColumnSpanSet
{
public:
    RangeColumnSpanSet( const ScRange& spanRange )
         : range( spanRange ) {}
    void executeColumnAction(ScDocument& rDoc, sc::ColumnSpanSet::ColumnAction& ac) const;
private:
    ScRange range;
};


}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */