1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef INCLUDED_SC_LOOKUPCACHE_HXX
#define INCLUDED_SC_LOOKUPCACHE_HXX
#include "address.hxx"
#include "global.hxx"
#include "formula/token.hxx"
#include <svl/listener.hxx>
#include <tools/string.hxx>
#include <hash_map>
class ScDocument;
/** Lookup cache for one range used with interpreter functions such as VLOOKUP
and MATCH. Caches query for a specific row and the resulting address looked
up, in case other lookups of the same query in the same row are to be
performed, which usually occur to obtain a different offset column of the
same query.
*/
class ScLookupCache : public SvtListener
{
public:
enum Result
{
NOT_CACHED, /// Query not found in cache.
CRITERIA_DIFFERENT, /// Different criteria for same query position exists.
NOT_AVAILABLE, /// Criteria not available in lookup range.
FOUND /// Criteria found.
};
enum QueryOp
{
UNKNOWN,
EQUAL,
LESS_EQUAL,
GREATER_EQUAL
};
class QueryCriteria
{
union
{
double mfVal;
const String * mpStr;
};
bool mbAlloc : 1;
bool mbString : 1;
QueryOp meOp : 2;
void deleteString()
{
if (mbAlloc && mbString)
delete mpStr;
}
// prevent usage
QueryCriteria();
QueryCriteria & operator=( const QueryCriteria & r );
public:
explicit QueryCriteria( const ScQueryEntry & rEntry ) :
mfVal(0.0), mbAlloc(false), mbString(false)
{
switch (rEntry.eOp)
{
case SC_EQUAL :
meOp = EQUAL;
break;
case SC_LESS_EQUAL :
meOp = LESS_EQUAL;
break;
case SC_GREATER_EQUAL :
meOp = GREATER_EQUAL;
break;
default:
meOp = UNKNOWN;
DBG_ERRORFILE( "ScLookupCache::QueryCriteria not prepared for this ScQueryOp");
}
if (rEntry.bQueryByString)
setString( rEntry.pStr);
else
setDouble( rEntry.nVal);
}
QueryCriteria( const QueryCriteria & r ) :
mfVal( r.mfVal),
mbAlloc( false),
mbString( false),
meOp( r.meOp)
{
if (r.mbString && r.mpStr)
{
mpStr = new String( *r.mpStr);
mbAlloc = mbString = true;
}
}
~QueryCriteria()
{
deleteString();
}
QueryOp getQueryOp() const { return meOp; }
void setDouble( double fVal )
{
deleteString();
mbAlloc = mbString = false;
mfVal = fVal;
}
void setString( const String * pStr )
{
deleteString();
mbAlloc = false;
mbString = true;
mpStr = pStr;
}
void setString( const String & rStr )
{
deleteString();
mbAlloc = mbString = true;
mpStr = new String( rStr);
}
bool operator==( const QueryCriteria & r ) const
{
return meOp == r.meOp && mbString == r.mbString &&
(mbString ? (*mpStr == *r.mpStr) : (mfVal == r.mfVal));
}
};
/// MUST be new'd because Notify() deletes.
ScLookupCache( ScDocument * pDoc, const ScRange & rRange );
virtual ~ScLookupCache();
/// Remove from document structure and delete (!) cache on modify hint.
virtual void Notify( SvtBroadcaster & rBC, const SfxHint & rHint );
/// @returns document address in o_rAddress if Result==FOUND
Result lookup( ScAddress & o_rResultAddress,
const QueryCriteria & rCriteria,
const ScAddress & rQueryAddress ) const;
/** Insert query and result.
@param bAvailable
Pass FALSE if the search didn't deliver a result. A subsequent
lookup() then will return Result::NOT_AVAILABLE.
@returns successful insertion.
*/
bool insert( const ScAddress & rResultAddress,
const QueryCriteria & rCriteria,
const ScAddress & rQueryAddress,
const bool bAvailable );
inline const ScRange& getRange() const { return maRange; }
struct Hash
{
size_t operator()( const ScRange & rRange ) const
{
// Lookups are performed on the first column.
return rRange.hashStartColumn();
}
};
private:
struct QueryKey
{
SCROW mnRow;
SCTAB mnTab;
QueryOp meOp : 2;
QueryKey( const ScAddress & rAddress, const QueryOp eOp ) :
mnRow( rAddress.Row()),
mnTab( rAddress.Tab()),
meOp( eOp)
{
}
bool operator==( const QueryKey & r ) const
{
return mnRow == r.mnRow && mnTab == r.mnTab && meOp == r.meOp && meOp != UNKNOWN;
}
struct Hash
{
size_t operator()( const QueryKey & r ) const
{
return (static_cast<size_t>(r.mnTab) << 24) ^
(static_cast<size_t>(r.meOp) << 22) ^
static_cast<size_t>(r.mnRow);
}
};
};
struct QueryCriteriaAndResult
{
QueryCriteria maCriteria;
ScAddress maAddress;
QueryCriteriaAndResult( const QueryCriteria & rCriteria, const ScAddress & rAddress ) :
maCriteria( rCriteria),
maAddress( rAddress)
{
}
~QueryCriteriaAndResult()
{
}
};
typedef ::std::hash_map< QueryKey, QueryCriteriaAndResult, QueryKey::Hash, ::std::equal_to< QueryKey > > QueryMap;
QueryMap maQueryMap;
ScRange maRange;
ScDocument * mpDoc;
// prevent usage
ScLookupCache( const ScLookupCache & );
ScLookupCache & operator=( const ScLookupCache & );
};
typedef ::std::hash_map< ScRange, ScLookupCache*, ScLookupCache::Hash, ::std::equal_to< ScRange > > ScLookupCacheMap;
#endif
|
