sc/inc/compressedarray.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_COMPRESSEDARRAY_HXX
  21 #define INCLUDED_SC_INC_COMPRESSEDARRAY_HXX
  22
  23 #include <cstddef>
  24 #include <memory>
  25
  26 #include "scdllapi.h"
  27
  28 /** Compressed array of row (or column) entries, e.g. heights, flags, ...
  29
  30     The array stores ranges of values such that equal consecutive values occupy only
  31     one entry. Initially it consists of one DataEntry with an implied start
  32     row/column of 0 and an end row/column of access type maximum value.
  33
  34     typename A := access type, e.g. SCROW or SCCOL, must be a POD.
  35
  36     typename D := data type, e.g. sal_uInt16 or sal_uInt8 or whatever, may also be a
  37     struct or class.
  38
  39     D::operator==() and D::operator=() must be implemented. Force template
  40     instantiation for a specific type in source/core/data/compressedarray.cxx
  41
  42     TODO: Currently the allocated memory never shrinks, must manually invoke
  43     Resize() if needed.
  44  */
  45
  46 template< typename A, typename D > class ScCompressedArray
  47 {
  48 public:
  49     class Iterator
  50     {
  51         friend ScCompressedArray;
  52         const ScCompressedArray& mrArray;
  53         size_t             mnIndex = 0;
  54         A                  mnRegion = 0;
  55         Iterator(const ScCompressedArray& rArray) : mrArray(rArray) {}
  56         Iterator(const ScCompressedArray& rArray, size_t nIndex, A nRegion) : mrArray(rArray), mnIndex(nIndex), mnRegion(nRegion) {}
  57     public:
  58         void operator++();
  59         Iterator operator+(size_t) const;
  60         const D & operator*() const { return mrArray.pData[mnIndex].aValue; }
  61     };
  62     struct DataEntry
  63     {
  64         A   nEnd;           // start is end of previous entry + 1
  65         D   aValue;
  66             DataEntry() {}  //! uninitialized
  67     };
  68
  69     /** Construct with nMaxAccess=MAXROW, for example. */
  70                                 ScCompressedArray( A nMaxAccess,
  71                                         const D& rValue );
  72     virtual                     ~ScCompressedArray();
  73     void                        Reset( const D& rValue );
  74     void                        SetValue( A nPos, const D& rValue );
  75     void                        SetValue( A nStart, A nEnd, const D& rValue );
  76     [[nodiscard]]
  77     const D&                    GetValue( A nPos ) const;
  78     [[nodiscard]]
  79     A                           GetLastPos() const { return pData[nCount-1].nEnd; }
  80
  81     /** Get value for a row, and it's region end row */
  82     [[nodiscard]]
  83     const D&                    GetValue( A nPos, size_t& nIndex, A& nEnd ) const;
  84
  85     /** Get next value and it's region end row. If nIndex<nCount, nIndex is
  86         incremented first. If the resulting nIndex>=nCount, the value of the
  87         last entry is returned again. */
  88     [[nodiscard]]
  89     const D&                    GetNextValue( size_t& nIndex, A& nEnd ) const;
  90
  91     /** Insert rows before nStart and copy value for inserted rows from
  92         nStart-1, return that value. */
  93     const D&                    Insert( A nStart, size_t nCount );
  94     void                        InsertPreservingSize( A nStart, size_t nCount, const D& rFillValue );
  95
  96     void                        Remove( A nStart, size_t nCount );
  97     void                        RemovePreservingSize( A nStart, size_t nCount, const D& rFillValue );
  98
  99     /** Copy rArray.nStart+nSourceDy to this.nStart */
 100     void                        CopyFrom( const ScCompressedArray& rArray,
 101                                     A nStart, A nEnd )
 102                                 { CopyFrom(rArray, nStart, nEnd, nStart); }
 103     void                        CopyFrom( const ScCompressedArray& rArray,
 104                                     A nDestStart, A nDestEnd, A nSrcStart );
 105
 106     // methods public for the coupled array sum methods
 107     /** Obtain index into entries for nPos */
 108     SC_DLLPUBLIC size_t                      Search( A nPos ) const;
 109
 110     Iterator                    begin() const { return Iterator(*this); }
 111
 112 protected:
 113     size_t                      nCount;
 114     size_t                      nLimit;
 115     std::unique_ptr<DataEntry[]> pData;
 116     A                           nMaxAccess;
 117 };
 118
 119 template< typename A, typename D >
 120 void ScCompressedArray<A,D>::Reset( const D& rValue )
 121 {
 122     // Create a temporary copy in case we got a reference passed that points to
 123     // a part of the array to be reallocated.
 124     D aTmpVal( rValue);
 125     nCount = nLimit = 1;
 126     pData.reset(new DataEntry[1]);
 127     pData[0].aValue = aTmpVal;
 128     pData[0].nEnd = nMaxAccess;
 129 }
 130
 131 template< typename A, typename D >
 132 void ScCompressedArray<A,D>::SetValue( A nPos, const D& rValue )
 133 {
 134     SetValue( nPos, nPos, rValue);
 135 }
 136
 137 template< typename A, typename D >
 138 const D& ScCompressedArray<A,D>::GetValue( A nPos ) const
 139 {
 140     size_t nIndex = Search( nPos);
 141     return pData[nIndex].aValue;
 142 }
 143
 144 template< typename A, typename D >
 145 const D& ScCompressedArray<A,D>::GetValue( A nPos, size_t& nIndex, A& nEnd ) const
 146 {
 147     nIndex = Search( nPos);
 148     nEnd = pData[nIndex].nEnd;
 149     return pData[nIndex].aValue;
 150 }
 151
 152 template< typename A, typename D >
 153 const D& ScCompressedArray<A,D>::GetNextValue( size_t& nIndex, A& nEnd ) const
 154 {
 155     if (nIndex < nCount)
 156         ++nIndex;
 157     size_t nEntry = (nIndex < nCount ? nIndex : nCount-1);
 158     nEnd = pData[nEntry].nEnd;
 159     return pData[nEntry].aValue;
 160 }
 161
 162 //  ScBitMaskCompressedArray
 163 /** The data type represents bits, manageable by bitwise operations.
 164  */
 165
 166 template< typename A, typename D > class ScBitMaskCompressedArray final : public ScCompressedArray<A,D>
 167 {
 168 public:
 169                                 ScBitMaskCompressedArray( A nMaxAccessP,
 170                                         const D& rValue )
 171                                     : ScCompressedArray<A,D>( nMaxAccessP, rValue )
 172                                     {}
 173     void                        AndValue( A nPos, const D& rValueToAnd );
 174     void                        OrValue( A nPos, const D& rValueToOr );
 175     void                        AndValue( A nStart, A nEnd, const D& rValueToAnd );
 176     void                        OrValue( A nStart, A nEnd, const D& rValueToOr );
 177
 178     /** Copy values from rArray and bitwise AND them with rValueToAnd. */
 179     void                        CopyFromAnded(
 180                                     const ScBitMaskCompressedArray& rArray,
 181                                     A nStart, A nEnd, const D& rValueToAnd );
 182
 183     /** Return the last row where an entry meets the condition:
 184         ((aValue & rBitMask) != 0), start searching at 0. If no entry
 185         meets this condition, ::std::numeric_limits<A>::max() is returned. */
 186     A                           GetLastAnyBitAccess( const D& rBitMask ) const;
 187 };
 188
 189 template< typename A, typename D >
 190 void ScBitMaskCompressedArray<A,D>::AndValue( A nPos, const D& rValueToAnd )
 191 {
 192     const D& rValue = this->GetValue( nPos);
 193     if ((rValue & rValueToAnd) != rValue)
 194         this->SetValue( nPos, rValue & rValueToAnd);
 195 }
 196
 197 template< typename A, typename D >
 198 void ScBitMaskCompressedArray<A,D>::OrValue( A nPos, const D& rValueToOr )
 199 {
 200     const D& rValue = this->GetValue( nPos);
 201     if ((rValue | rValueToOr) != rValue)
 202         this->SetValue( nPos, rValue | rValueToOr);
 203 }
 204
 205 #endif // INCLUDED_SC_INC_COMPRESSEDARRAY_HXX
 206
 207 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */