sc/inc/segmenttree.hxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the Collabora Office 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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#pragma once

#include "types.hxx"
#include <rtl/string.hxx>

#include <memory>

class ScFlatBoolSegmentsImpl;

class ScFlatBoolRowSegments
{
public:
    struct RangeData
    {
        SCROW mnRow1;
        SCROW mnRow2;
        bool mbValue;
    };

    class ForwardIterator
    {
    public:
        explicit ForwardIterator(ScFlatBoolRowSegments& rSegs);

        [[nodiscard]] bool getValue(SCROW nPos, bool& rVal);
        SCROW getLastPos() const { return mnLastPos; }

    private:
        ScFlatBoolRowSegments& mrSegs;

        SCROW mnCurPos;
        SCROW mnLastPos;
        bool mbCurValue;
    };

    class RangeIterator
    {
    public:
        explicit RangeIterator(ScFlatBoolRowSegments const& rSegs);
        bool getFirst(RangeData& rRange);
        bool getNext(RangeData& rRange);

    private:
        ScFlatBoolRowSegments const& mrSegs;
    };

    ScFlatBoolRowSegments(SCROW nMaxRow);
    ScFlatBoolRowSegments(const ScFlatBoolRowSegments& r);
    ~ScFlatBoolRowSegments();

    bool setTrue(SCROW nRow1, SCROW nRow2);
    bool setFalse(SCROW nRow1, SCROW nRow2);
    bool getRangeData(SCROW nRow, RangeData& rData) const;
    bool getRangeDataLeaf(SCROW nRow, RangeData& rData);
    void removeSegment(SCROW nRow1, SCROW nRow2);
    void insertSegment(SCROW nRow, SCROW nSize);

    SCROW findLastTrue() const;

    // Builds internal data (so that it doesn't build them while used in threads).
    void makeReady();

    OString dumpAsString();

private:
    ::std::unique_ptr<ScFlatBoolSegmentsImpl> mpImpl;
};

class ScFlatBoolColSegments
{
public:
    struct RangeData
    {
        SCCOL mnCol1;
        SCCOL mnCol2;
        bool mbValue;
    };
    ScFlatBoolColSegments(SCCOL nMaxCol);
    ScFlatBoolColSegments(const ScFlatBoolColSegments& r);
    ~ScFlatBoolColSegments();

    bool setTrue(SCCOL nCol1, SCCOL nCol2);
    bool setFalse(SCCOL nCol1, SCCOL nCol2);
    bool getRangeData(SCCOL nCol, RangeData& rData);
    void removeSegment(SCCOL nCol1, SCCOL nCol2);
    void insertSegment(SCCOL nCol, SCCOL nSize);

    // Builds internal data (so that it doesn't build them while used in threads).
    void makeReady();

    OString dumpAsString();

private:
    ::std::unique_ptr<ScFlatBoolSegmentsImpl> mpImpl;
};

class ScFlatUInt16SegmentsImpl;

class ScFlatUInt16RowSegments
{
public:
    struct RangeData
    {
        SCROW mnRow1;
        SCROW mnRow2;
        sal_uInt16 mnValue;
    };

    class ForwardIterator
    {
    public:
        explicit ForwardIterator(ScFlatUInt16RowSegments& rSegs);

        bool getValue(SCROW nPos, sal_uInt16& rVal);
        SCROW getLastPos() const { return mnLastPos; }

    private:
        ScFlatUInt16RowSegments& mrSegs;

        SCROW mnCurPos;
        SCROW mnLastPos;
        sal_uInt16 mnCurValue;
    };

    ScFlatUInt16RowSegments(SCROW nMaxRow, sal_uInt16 nDefault);
    ScFlatUInt16RowSegments(const ScFlatUInt16RowSegments& r);
    ~ScFlatUInt16RowSegments();

    void setValue(SCROW nRow1, SCROW nRow2, sal_uInt16 nValue);
    void setValueIf(SCROW nRow1, SCROW nRow2, sal_uInt16 nValue,
                    const std::function<bool(sal_uInt16)>& rPredicate);
    sal_uInt16 getValue(SCROW nRow);
    sal_uInt64 getSumValue(SCROW nRow1, SCROW nRow2);
    bool getRangeData(SCROW nRow, RangeData& rData);
    void removeSegment(SCROW nRow1, SCROW nRow2);
    void insertSegment(SCROW nRow, SCROW nSize);

    SCROW findLastTrue(sal_uInt16 nValue) const;

    void enableTreeSearch(bool bEnable);

    // Builds internal data (so that it doesn't build them while used in threads).
    void makeReady();

    OString dumpAsString();

private:
    ::std::unique_ptr<ScFlatUInt16SegmentsImpl> mpImpl;
};

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