sc/inc/lookupcache.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_LOOKUPCACHE_HXX
  21 #define INCLUDED_SC_INC_LOOKUPCACHE_HXX
  22
  23 #include "address.hxx"
  24 #include <svl/listener.hxx>
  25
  26 #include <unordered_map>
  27
  28 class ScDocument;
  29 struct ScQueryEntry;
  30
  31 /** Lookup cache for one range used with interpreter functions such as VLOOKUP
  32     and MATCH. Caches query for a specific row and the resulting address looked
  33     up, in case other lookups of the same query in the same row are to be
  34     performed, which usually occur to obtain a different offset column of the
  35     same query.
  36  */
  37
  38 class ScLookupCache : public SvtListener
  39 {
  40 public:
  41
  42     enum Result
  43     {
  44         NOT_CACHED,         /// Query not found in cache.
  45         CRITERIA_DIFFERENT, /// Different criteria for same query position exists.
  46         NOT_AVAILABLE,      /// Criteria not available in lookup range.
  47         FOUND               /// Criteria found.
  48     };
  49
  50     enum QueryOp
  51     {
  52         UNKNOWN,
  53         EQUAL,
  54         LESS_EQUAL,
  55         GREATER_EQUAL
  56     };
  57
  58     class QueryCriteria
  59     {
  60         union
  61         {
  62             double          mfVal;
  63             const OUString *mpStr;
  64         };
  65         bool                mbAlloc;
  66         bool                mbString;
  67         QueryOp             meOp;
  68
  69         void deleteString()
  70         {
  71             if (mbAlloc && mbString)
  72                 delete mpStr;
  73         }
  74
  75         QueryCriteria & operator=( const QueryCriteria & r ) = delete;
  76
  77     public:
  78
  79         explicit QueryCriteria( const ScQueryEntry & rEntry );
  80         QueryCriteria( const QueryCriteria & r );
  81         ~QueryCriteria();
  82
  83         QueryOp getQueryOp() const { return meOp; }
  84
  85         void setDouble( double fVal )
  86         {
  87             deleteString();
  88             mbAlloc = mbString = false;
  89             mfVal = fVal;
  90         }
  91
  92         void setString( const OUString & rStr )
  93         {
  94             deleteString();
  95             mbAlloc = mbString = true;
  96             mpStr = new OUString( rStr);
  97         }
  98
  99         bool operator==( const QueryCriteria & r ) const
 100         {
 101             return meOp == r.meOp && mbString == r.mbString &&
 102                 (mbString ? (*mpStr == *r.mpStr) : (mfVal == r.mfVal));
 103         }
 104
 105     };
 106
 107     /// MUST be new'd because Notify() deletes.
 108                             ScLookupCache( ScDocument * pDoc, const ScRange & rRange );
 109     virtual                 ~ScLookupCache() override;
 110     /// Remove from document structure and delete (!) cache on modify hint.
 111     virtual void Notify( const SfxHint& rHint ) override;
 112
 113     /// @returns document address in o_rAddress if Result==FOUND
 114             Result          lookup( ScAddress & o_rResultAddress,
 115                                     const QueryCriteria & rCriteria,
 116                                     const ScAddress & rQueryAddress ) const;
 117
 118     /** Insert query and result.
 119         @param bAvailable
 120             Pass sal_False if the search didn't deliver a result. A subsequent
 121             lookup() then will return Result::NOT_AVAILABLE.
 122         @returns successful insertion.
 123       */
 124             bool            insert( const ScAddress & rResultAddress,
 125                                     const QueryCriteria & rCriteria,
 126                                     const ScAddress & rQueryAddress,
 127                                     const bool bAvailable );
 128
 129     const ScRange&  getRange() const { return maRange; }
 130
 131     struct Hash
 132     {
 133         size_t operator()( const ScRange & rRange ) const
 134         {
 135             // Lookups are performed on the first column.
 136             return rRange.hashStartColumn();
 137         }
 138     };
 139
 140 private:
 141
 142     struct QueryKey
 143     {
 144         SCROW           mnRow;
 145         SCTAB           mnTab;
 146         QueryOp         meOp;
 147
 148         QueryKey( const ScAddress & rAddress, const QueryOp eOp ) :
 149             mnRow( rAddress.Row()),
 150             mnTab( rAddress.Tab()),
 151             meOp( eOp)
 152         {
 153         }
 154
 155         bool operator==( const QueryKey & r ) const
 156         {
 157             return mnRow == r.mnRow && mnTab == r.mnTab && meOp == r.meOp && meOp != UNKNOWN;
 158         }
 159
 160         struct Hash
 161         {
 162             size_t operator()( const QueryKey & r ) const
 163             {
 164                 return (static_cast<size_t>(r.mnTab) << 24) ^
 165                     (static_cast<size_t>(r.meOp) << 22) ^
 166                     static_cast<size_t>(r.mnRow);
 167             }
 168         };
 169     };
 170
 171     struct QueryCriteriaAndResult
 172     {
 173         QueryCriteria   maCriteria;
 174         ScAddress       maAddress;
 175
 176         QueryCriteriaAndResult( const QueryCriteria & rCriteria, const ScAddress & rAddress ) :
 177             maCriteria( rCriteria),
 178             maAddress( rAddress)
 179         {
 180         }
 181     };
 182
 183     std::unordered_map< QueryKey, QueryCriteriaAndResult, QueryKey::Hash > maQueryMap;
 184     ScRange         maRange;
 185     ScDocument *    mpDoc;
 186
 187     ScLookupCache( const ScLookupCache & ) = delete;
 188     ScLookupCache & operator=( const ScLookupCache & ) = delete;
 189
 190 };
 191
 192 #endif
 193
 194 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */