sc/inc/subtotalparam.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/.
 */

#pragma once

#include "global.hxx"
#include "tokenarray.hxx"
#include <memory>
#include <span>

namespace com::sun::star::sheet { struct SubTotalColumn; }
namespace com::sun::star::uno { template <class E> class Sequence; }

struct SC_DLLPUBLIC ScSubTotalParam
{
    SCCOL           nCol1 = 0;                  ///< selected area
    SCROW           nRow1 = 0;
    SCCOL           nCol2 = 0;
    SCROW           nRow2 = 0;
    sal_uInt16      nUserIndex = 0;             ///< index into list
    bool            bRemoveOnly:1     = false;
    bool            bReplace:1        = true;   ///< replace existing results
    bool            bPagebreak:1      = false;  ///< page break at change of group
    bool            bCaseSens:1       = false;
    bool            bDoSort:1         = true;   ///< presort
    bool            bSummaryBelow:1   = true;   ///< Summary below or above (default: below)
    bool            bAscending:1      = true;   ///< sort ascending
    bool            bUserDef:1        = false;  ///< sort user defined
    bool            bIncludePattern:1 = false;  ///< sort formats
    bool            bGroupedBy:1      = true;   ///< grouped by column
    bool            bHasHeader:1      = true;   ///< has header row

    struct SubtotalGroup
    {
        bool  bActive    = false; ///< active groups
        SCCOL nField     = 0;     ///< associated field
        SCCOL nSubTotals = 0;     ///< number of SubTotals
        SCCOL nCustFuncs = 0;     ///< number of Custom Functions
        SCCOL nSubLabels = 0;     ///< number of SubLabels

        using Pair = std::pair<SCCOL, ScSubTotalFunc>;
        using FuncPair = std::pair<SCCOL, std::unique_ptr<ScTokenArray>>;
        using LabelPair = std::pair<SCCOL, rtl::OUString>;
        // array of columns to be calculated, and associated functions
        std::unique_ptr<Pair[]> pSubTotals;
        std::unique_ptr<FuncPair[]> pCustFuncs; // custom functions
        std::unique_ptr<LabelPair[]> pSubLabels; // Total labels

        SubtotalGroup() = default;
        SubtotalGroup(const SubtotalGroup& r);

        SubtotalGroup& operator=(const SubtotalGroup& r);
        bool operator==(const SubtotalGroup& r) const;

        void AllocSubTotals(SCCOL n);
        void AllocCustFuncs(SCCOL n);
        void AllocSubLabels(SCCOL n);
        void SetSubtotals(const css::uno::Sequence<css::sheet::SubTotalColumn>& seq);
        //void SetCustFuncs(const css::uno::Sequence<css::sheet::SubTotalColumn>& seq);
        //void SetSublabels(const css::uno::Sequence<css::sheet::SubTotalColumn>& seq);

        // Totals
        std::span<Pair> subtotals() { return std::span(pSubTotals.get(), nSubTotals); }
        std::span<const Pair> subtotals() const { return std::span(pSubTotals.get(), nSubTotals); }
        SCCOL& col(SCCOL n) { return subtotals()[n].first; }
        SCCOL col(SCCOL n) const { return subtotals()[n].first; }
        ScSubTotalFunc func(SCCOL n) const { return subtotals()[n].second; }
        // Total Functions
        std::span<FuncPair> custfuncs() { return std::span(pCustFuncs.get(), nCustFuncs); }
        std::span<const FuncPair> custfuncs() const { return std::span(pCustFuncs.get(), nCustFuncs); }
        SCCOL& colcust(SCCOL n) { return custfuncs()[n].first; }
        SCCOL colcust(SCCOL n) const { return custfuncs()[n].first; }
        ScTokenArray* custToken(SCCOL n) const { return custfuncs()[n].second.get(); }
        // Labels
        std::span<LabelPair> sublabels() { return std::span(pSubLabels.get(), nSubLabels); }
        std::span<const LabelPair> sublabels() const { return std::span(pSubLabels.get(), nSubLabels); }
        SCCOL& collabels(SCCOL n) { return sublabels()[n].first; }
        SCCOL collabels(SCCOL n) const { return sublabels()[n].first; }
        rtl::OUString label(SCCOL n) const { return sublabels()[n].second; }
    };
    SubtotalGroup aGroups[MAXSUBTOTAL];

    ScSubTotalParam() = default;
    ScSubTotalParam(const ScSubTotalParam&) = default;

    ScSubTotalParam(ScSubTotalParam&&) noexcept = default;
    ScSubTotalParam& operator=(ScSubTotalParam&&) noexcept = default;

    ScSubTotalParam& operator=(const ScSubTotalParam&) = default;
    inline bool operator==(const ScSubTotalParam&) const = default;
    void SetSubTotals( sal_uInt16 nGroup,
                       const SCCOL* ptrSubTotals,
                       const ScSubTotalFunc* ptrFunctions,
                       sal_uInt16 nCount );
    void SetCustFuncs( sal_uInt16 nGroupIdx,
                       std::vector<std::pair<SCCOL, std::unique_ptr<ScTokenArray>>>& rColFuncs,
                       sal_uInt16 nCount );
    void SetSubLabels( sal_uInt16 nGroupIdx,
                       std::vector<std::pair<SCCOL, rtl::OUString>>& rColLabels,
                       sal_uInt16 nCount );
};

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