sc/inc/dpsave.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SC_INC_DPSAVE_HXX
  21 #define INCLUDED_SC_INC_DPSAVE_HXX
  22
  23 #include <memory>
  24 #include <vector>
  25
  26 #include <com/sun/star/sheet/DataPilotFieldOrientation.hpp>
  27 #include <rtl/ustring.hxx>
  28 #include <sal/types.h>
  29 #include <tools/long.hxx>
  30
  31 #include "scdllapi.h"
  32 #include "calcmacros.hxx"
  33
  34 #include <unordered_map>
  35 #include <unordered_set>
  36 #include <optional>
  37
  38 namespace com::sun::star::sheet {
  39     class XDimensionsSupplier;
  40     struct DataPilotFieldReference;
  41     struct DataPilotFieldSortInfo;
  42     struct DataPilotFieldAutoShowInfo;
  43     struct DataPilotFieldLayoutInfo;
  44 }
  45
  46 class ScDPDimensionSaveData;
  47 class ScDPTableData;
  48 enum class ScGeneralFunction;
  49
  50 // classes to save Data Pilot settings
  51
  52 class ScDPSaveMember
  53 {
  54 private:
  55     OUString aName;
  56     std::optional<OUString> mpLayoutName; // custom name to be displayed in the table.
  57     sal_uInt16 nVisibleMode;
  58     sal_uInt16 nShowDetailsMode;
  59
  60 public:
  61     ScDPSaveMember(const OUString& rName);
  62     ScDPSaveMember(const ScDPSaveMember& r);
  63     ~ScDPSaveMember();
  64
  65     bool operator== ( const ScDPSaveMember& r ) const;
  66
  67     const OUString& GetName() const
  68         { return aName; }
  69
  70     SC_DLLPUBLIC bool HasIsVisible() const;
  71     SC_DLLPUBLIC void SetIsVisible(bool bSet);
  72     bool GetIsVisible() const
  73         { return bool(nVisibleMode); }
  74
  75     SC_DLLPUBLIC bool HasShowDetails() const;
  76     SC_DLLPUBLIC void SetShowDetails(bool bSet);
  77     bool GetShowDetails() const
  78         { return bool(nShowDetailsMode); }
  79
  80     void SetName( const OUString& rNew ); // used if the source member was renamed (groups)
  81
  82     SC_DLLPUBLIC void SetLayoutName( const OUString& rName );
  83     SC_DLLPUBLIC const std::optional<OUString> & GetLayoutName() const;
  84     void RemoveLayoutName();
  85
  86     void WriteToSource( const css::uno::Reference<css::uno::XInterface>& xMember,
  87                             sal_Int32 nPosition );
  88
  89 #if DUMP_PIVOT_TABLE
  90     void Dump(int nIndent = 0) const;
  91 #endif
  92 };
  93
  94 class SC_DLLPUBLIC ScDPSaveDimension
  95 {
  96 private:
  97     OUString aName;
  98     std::optional<OUString> mpLayoutName;
  99     std::optional<OUString> mpSubtotalName;
 100     bool bIsDataLayout;
 101     bool bDupFlag;
 102     css::sheet::DataPilotFieldOrientation nOrientation;
 103     ScGeneralFunction nFunction; // for data dimensions
 104     tools::Long nUsedHierarchy;
 105     sal_uInt16 nShowEmptyMode; //! at level
 106     bool bRepeatItemLabels; //! at level
 107     bool bSubTotalDefault; //! at level
 108     std::vector<ScGeneralFunction> maSubTotalFuncs;
 109     std::unique_ptr<css::sheet::DataPilotFieldReference> pReferenceValue;
 110     std::unique_ptr<css::sheet::DataPilotFieldSortInfo> pSortInfo; // (level)
 111     std::unique_ptr<css::sheet::DataPilotFieldAutoShowInfo> pAutoShowInfo; // (level)
 112     std::unique_ptr<css::sheet::DataPilotFieldLayoutInfo> pLayoutInfo; // (level)
 113
 114 public:
 115     typedef std::unordered_set<OUString> MemberSetType;
 116     typedef std::vector<ScDPSaveMember*> MemberList;
 117
 118 private:
 119     std::unordered_map<OUString, std::unique_ptr<ScDPSaveMember>> maMemberHash;
 120     MemberList maMemberList;
 121
 122 public:
 123     ScDPSaveDimension(const OUString& rName, bool bDataLayout);
 124     ScDPSaveDimension(const ScDPSaveDimension& r);
 125     ~ScDPSaveDimension();
 126
 127     bool operator== ( const ScDPSaveDimension& r ) const;
 128
 129     const MemberList& GetMembers() const
 130         { return maMemberList; }
 131
 132     void AddMember(std::unique_ptr<ScDPSaveMember> pMember);
 133
 134     void SetDupFlag(bool bSet)
 135         { bDupFlag = bSet; }
 136
 137     bool GetDupFlag() const
 138         { return bDupFlag; }
 139
 140     const OUString& GetName() const
 141         { return aName; }
 142
 143     bool IsDataLayout() const
 144         { return bIsDataLayout; }
 145
 146     void SetName( const OUString& rNew ); // used if the source dim was renamed (groups)
 147
 148     void SetOrientation(css::sheet::DataPilotFieldOrientation nNew);
 149     void SetSubTotals(std::vector<ScGeneralFunction> const & rFuncs);
 150     tools::Long GetSubTotalsCount() const
 151         { return maSubTotalFuncs.size(); }
 152
 153     ScGeneralFunction GetSubTotalFunc(tools::Long nIndex) const
 154         { return maSubTotalFuncs[nIndex]; }
 155
 156     bool HasShowEmpty() const;
 157     void SetShowEmpty(bool bSet);
 158     bool GetShowEmpty() const
 159         { return bool(nShowEmptyMode); }
 160
 161     void SetRepeatItemLabels(bool bSet);
 162     bool GetRepeatItemLabels() const
 163         { return bRepeatItemLabels; }
 164
 165     void SetFunction(ScGeneralFunction nNew);
 166     ScGeneralFunction GetFunction() const
 167         { return nFunction; }
 168
 169     void SetUsedHierarchy(tools::Long nNew);
 170     tools::Long GetUsedHierarchy() const
 171         { return nUsedHierarchy; }
 172
 173     void SetLayoutName(const OUString& rName);
 174     const std::optional<OUString> & GetLayoutName() const;
 175     void RemoveLayoutName();
 176     void SetSubtotalName(const OUString& rName);
 177     const std::optional<OUString> & GetSubtotalName() const;
 178     void RemoveSubtotalName();
 179
 180     bool IsMemberNameInUse(const OUString& rName) const;
 181
 182     const css::sheet::DataPilotFieldReference* GetReferenceValue() const
 183         { return pReferenceValue.get(); }
 184
 185     void SetReferenceValue(const css::sheet::DataPilotFieldReference* pNew);
 186
 187     const css::sheet::DataPilotFieldSortInfo* GetSortInfo() const
 188         { return pSortInfo.get(); }
 189
 190     void SetSortInfo(const css::sheet::DataPilotFieldSortInfo* pNew);
 191     const css::sheet::DataPilotFieldAutoShowInfo* GetAutoShowInfo() const
 192         { return pAutoShowInfo.get(); }
 193
 194     void SetAutoShowInfo(const css::sheet::DataPilotFieldAutoShowInfo* pNew);
 195     const css::sheet::DataPilotFieldLayoutInfo* GetLayoutInfo() const
 196         { return pLayoutInfo.get(); }
 197
 198     void SetLayoutInfo(const css::sheet::DataPilotFieldLayoutInfo* pNew);
 199
 200     void SetCurrentPage( const OUString* pPage ); // NULL = no selection (all)
 201     OUString GetCurrentPage() const; // only for ODF compatibility
 202
 203     css::sheet::DataPilotFieldOrientation GetOrientation() const
 204         { return nOrientation; }
 205
 206     ScDPSaveMember* GetExistingMemberByName(const OUString& rName);
 207
 208     /**
 209      * Get a member object by its name.  If one doesn't exist, create a new
 210      * object and return it.  This class manages the life cycle of all member
 211      * objects belonging to it, so <i>don't delete the returned instance.</i>
 212      *
 213      * @param rName member name
 214      *
 215      * @return pointer to the member object.
 216      */
 217     ScDPSaveMember* GetMemberByName(const OUString& rName);
 218
 219     void SetMemberPosition( const OUString& rName, sal_Int32 nNewPos );
 220
 221     void WriteToSource( const css::uno::Reference<css::uno::XInterface>& xDim );
 222
 223     void UpdateMemberVisibility(const std::unordered_map< OUString, bool>& rData);
 224
 225     bool HasInvisibleMember() const;
 226
 227     void RemoveObsoleteMembers(const MemberSetType& rMembers);
 228
 229 #if DUMP_PIVOT_TABLE
 230     void Dump(int nIndent = 0) const;
 231 #endif
 232 };
 233
 234 class ScDPSaveData
 235 {
 236     typedef std::unordered_map<OUString, size_t> DupNameCountType;
 237 public:
 238     typedef std::unordered_map<OUString, size_t> DimOrderType;
 239     typedef std::vector<std::unique_ptr<ScDPSaveDimension>> DimsType;
 240
 241 private:
 242     DimsType m_DimList;
 243     DupNameCountType maDupNameCounts; /// keep track of number of duplicates in each name.
 244     std::unique_ptr<ScDPDimensionSaveData> pDimensionData; // settings that create new dimensions
 245     sal_uInt16 nColumnGrandMode;
 246     sal_uInt16 nRowGrandMode;
 247     sal_uInt16 nIgnoreEmptyMode;
 248     sal_uInt16 nRepeatEmptyMode;
 249     bool bFilterButton; // not passed to DataPilotSource
 250     bool bDrillDown; // not passed to DataPilotSource
 251
 252     /** if true, all dimensions already have all of their member instances
 253      *  created. */
 254     bool mbDimensionMembersBuilt;
 255
 256     std::optional<OUString> mpGrandTotalName;
 257     mutable std::unique_ptr<DimOrderType> mpDimOrder; // dimension order for row and column dimensions, to traverse result tree.
 258
 259 public:
 260     SC_DLLPUBLIC ScDPSaveData();
 261     ScDPSaveData(const ScDPSaveData& r);
 262     SC_DLLPUBLIC ~ScDPSaveData();
 263
 264     ScDPSaveData& operator= ( const ScDPSaveData& r );
 265
 266     bool operator== ( const ScDPSaveData& r ) const;
 267
 268     SC_DLLPUBLIC void SetGrandTotalName(const OUString& rName);
 269     SC_DLLPUBLIC const std::optional<OUString> & GetGrandTotalName() const;
 270
 271     const DimsType& GetDimensions() const { return m_DimList; }
 272
 273     /**
 274      * Get sort order map to sort row and column dimensions in order of
 275      * appearance. Row dimensions get sorted before column dimensions.  This
 276      * is used to traverse result tree, which is structured following this
 277      * order.
 278      */
 279     const DimOrderType& GetDimensionSortOrder() const;
 280
 281     /**
 282      * Get all dimensions in a given orientation.  The order represents the
 283      * actual order of occurrence.  The returned list also includes data
 284      * layout dimension.
 285      *
 286      * @param eOrientation orientation
 287      * @param rDims (out) list of dimensions for specified orientation
 288      */
 289     SC_DLLPUBLIC void GetAllDimensionsByOrientation(
 290         css::sheet::DataPilotFieldOrientation eOrientation,
 291         std::vector<const ScDPSaveDimension*>& rDims) const;
 292
 293     void AddDimension(ScDPSaveDimension* pDim);
 294
 295     /**
 296      * Get a dimension object by its name.  <i>If one doesn't exist for the
 297      * given name, it creates a new one.</i>
 298      *
 299      * @param rName dimension name
 300      *
 301      * @return pointer to the dimension object.  The ScDPSaveData instance
 302      *         manages its life cycle; hence the caller must
 303      *         <i>not</i> delete this object.
 304      */
 305     SC_DLLPUBLIC ScDPSaveDimension* GetDimensionByName(const OUString& rName);
 306     SC_DLLPUBLIC ScDPSaveDimension* GetDataLayoutDimension();
 307     SC_DLLPUBLIC ScDPSaveDimension* GetExistingDataLayoutDimension() const;
 308
 309     ScDPSaveDimension* DuplicateDimension(const OUString& rName);
 310     SC_DLLPUBLIC ScDPSaveDimension& DuplicateDimension(const ScDPSaveDimension& rDim);
 311
 312     SC_DLLPUBLIC ScDPSaveDimension* GetExistingDimensionByName(const OUString& rName) const;
 313     SC_DLLPUBLIC ScDPSaveDimension* GetNewDimensionByName(const OUString& rName);
 314
 315     void RemoveDimensionByName(const OUString& rName);
 316
 317     ScDPSaveDimension* GetInnermostDimension(css::sheet::DataPilotFieldOrientation nOrientation);
 318     ScDPSaveDimension* GetFirstDimension(css::sheet::DataPilotFieldOrientation eOrientation);
 319     SC_DLLPUBLIC tools::Long GetDataDimensionCount() const;
 320
 321     void SetPosition( ScDPSaveDimension* pDim, tools::Long nNew );
 322     SC_DLLPUBLIC void SetColumnGrand( bool bSet );
 323     bool GetColumnGrand() const
 324         { return bool(nColumnGrandMode); }
 325
 326     SC_DLLPUBLIC void SetRowGrand( bool bSet );
 327     bool GetRowGrand() const
 328         { return bool(nRowGrandMode); }
 329
 330     SC_DLLPUBLIC void SetIgnoreEmptyRows( bool bSet );
 331     bool GetIgnoreEmptyRows() const
 332         { return bool(nIgnoreEmptyMode); }
 333
 334     SC_DLLPUBLIC void SetRepeatIfEmpty( bool bSet );
 335     bool GetRepeatIfEmpty() const
 336         { return bool(nRepeatEmptyMode); }
 337
 338     SC_DLLPUBLIC void SetFilterButton( bool bSet );
 339     bool GetFilterButton() const
 340         { return bFilterButton; }
 341
 342     SC_DLLPUBLIC void SetDrillDown( bool bSet );
 343     bool GetDrillDown() const
 344         { return bDrillDown; }
 345
 346     void WriteToSource( const css::uno::Reference<css::sheet::XDimensionsSupplier>& xSource );
 347     bool IsEmpty() const;
 348
 349     const ScDPDimensionSaveData* GetExistingDimensionData() const
 350         { return pDimensionData.get(); }
 351
 352     void RemoveAllGroupDimensions( const OUString& rSrcDimName, std::vector<OUString>* pDeletedNames = nullptr );
 353
 354     SC_DLLPUBLIC ScDPDimensionSaveData* GetDimensionData(); // create if not there
 355     SC_DLLPUBLIC void SetDimensionData( const ScDPDimensionSaveData* pNew ); // copied
 356     void BuildAllDimensionMembers(ScDPTableData* pData);
 357     void SyncAllDimensionMembers(ScDPTableData* pData);
 358
 359     /**
 360      * Check whether a dimension has one or more invisible members.
 361      *
 362      * @param rDimName dimension name
 363      */
 364     SC_DLLPUBLIC bool HasInvisibleMember(const OUString& rDimName) const;
 365
 366 #if DUMP_PIVOT_TABLE
 367     void Dump() const;
 368 #endif
 369
 370 private:
 371     void CheckDuplicateName(ScDPSaveDimension& rDim);
 372     void RemoveDuplicateNameCount(const OUString& rName);
 373
 374     /**
 375      * Append a new original dimension. Not to be called to insert a duplicate
 376      * dimension.
 377      *
 378      * @param rName Dimension name. The name must be the original dimension
 379      *              name; not a duplicate dimension name.
 380      * @param bDataLayout true if this is a data layout dimension, false
 381      *                    otherwise.
 382      *
 383      * @return pointer to the new dimension just inserted.
 384      */
 385     ScDPSaveDimension* AppendNewDimension(const OUString& rName, bool bDataLayout);
 386
 387     void DimensionsChanged();
 388 };
 389
 390 #endif
 391
 392 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */