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 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
|
/*
* Copyright (c) 2013 - 2020 Jolla Ltd.
* Copyright (c) 2020 Open Mobile Platform LLC.
*
* You may use this file under the terms of the BSD license as follows:
*
* "Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Nemo Mobile nor the names of its contributors
* may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
*/
#ifndef SYNCHRONIZELISTS_H
#define SYNCHRONIZELISTS_H
// Helper utility to synchronize a cached list with some reference list with correct
// QAbstractItemModel signals and filtering.
// If the reference list is populated incrementally synchronizeList can be called multiple times with the
// same variables c and r to progressively synchronize the lists. After the final call completeSynchronizeList
// can be called to remove or append any items which remain unsynchronized.
// The Filtered variants allow the reference list to be filtered by a callback function to
// exclude unwanted items from the synchronized list.
template <typename T>
bool compareIdentity(const T &item, const T &reference)
{
return item == reference;
}
template <typename Agent, typename ReferenceList>
int insertRange(Agent *agent, int index, int count, const ReferenceList &source, int sourceIndex)
{
agent->insertRange(index, count, source, sourceIndex);
return count;
}
template <typename Agent>
int removeRange(Agent *agent, int index, int count)
{
agent->removeRange(index, count);
return 0;
}
template <typename Agent, typename ReferenceList>
int updateRange(Agent *agent, int index, int count, const ReferenceList &source, int sourceIndex)
{
Q_UNUSED(agent);
Q_UNUSED(index);
Q_UNUSED(source);
Q_UNUSED(sourceIndex);
return count;
}
template <typename Agent, typename CacheList, typename ReferenceList>
class SynchronizeList
{
typedef typename CacheList::const_reference CacheItem;
typedef typename ReferenceList::const_reference ReferenceItem;
public:
SynchronizeList(
Agent *agent,
const CacheList &cache,
int &c,
const ReferenceList &reference,
int &r)
: agent(agent), cache(cache), c(c), reference(reference), r(r)
{
int lastEqualC = c;
int lastEqualR = r;
for (; c < cache.count() && r < reference.count(); ++c, ++r) {
if (compareIdentity(cache.at(c), reference.at(r))) {
continue;
}
if (c > lastEqualC) {
lastEqualC += updateRange(agent, lastEqualC, c - lastEqualC, reference, lastEqualR);
c = lastEqualC;
lastEqualR = r;
}
bool match = false;
// Iterate through both the reference and cache lists in parallel looking for first
// point of commonality, when that is found resolve the differences and continue
// looking.
int count = 1;
for (; !match && c + count < cache.count() && r + count < reference.count(); ++count) {
CacheItem cacheItem = cache.at(c + count);
ReferenceItem referenceItem = reference.at(r + count);
for (int i = 0; i <= count; ++i) {
if (cacheMatch(i, count, referenceItem) || referenceMatch(i, count, cacheItem)) {
match = true;
break;
}
}
}
// Continue scanning the reference list if the cache has been exhausted.
for (int re = r + count; !match && re < reference.count(); ++re) {
ReferenceItem referenceItem = reference.at(re);
for (int i = 0; i < count; ++i) {
if (cacheMatch(i, re - r, referenceItem)) {
match = true;
break;
}
}
}
// Continue scanning the cache if the reference list has been exhausted.
for (int ce = c + count; !match && ce < cache.count(); ++ce) {
CacheItem cacheItem = cache.at(ce);
for (int i = 0; i < count; ++i) {
if (referenceMatch(i, ce - c, cacheItem)) {
match = true;
break;
}
}
}
if (!match)
return;
lastEqualC = c;
lastEqualR = r;
}
if (c > lastEqualC) {
updateRange(agent, lastEqualC, c - lastEqualC, reference, lastEqualR);
}
}
private:
// Tests if the cached contact id at i matches a referenceId.
// If there is a match removes all items traversed in the cache since the previous match
// and inserts any items in the reference set found to to not be in the cache.
bool cacheMatch(int i, int count, ReferenceItem referenceItem)
{
if (compareIdentity(cache.at(c + i), referenceItem)) {
if (i > 0)
c += removeRange(agent, c, i);
c += insertRange(agent, c, count, reference, r);
r += count;
return true;
} else {
return false;
}
}
// Tests if the reference contact id at i matches a cacheId.
// If there is a match inserts all items traversed in the reference set since the
// previous match and removes any items from the cache that were not found in the
// reference list.
bool referenceMatch(int i, int count, CacheItem cacheItem)
{
if (compareIdentity(reference.at(r + i), cacheItem)) {
c += removeRange(agent, c, count);
if (i > 0)
c += insertRange(agent, c, i, reference, r);
r += i;
return true;
} else {
return false;
}
}
Agent * const agent;
const CacheList &cache;
int &c;
const ReferenceList &reference;
int &r;
};
template <typename Agent, typename CacheList, typename ReferenceList>
void completeSynchronizeList(
Agent *agent,
const CacheList &cache,
int &cacheIndex,
const ReferenceList &reference,
int &referenceIndex)
{
if (cacheIndex < cache.count()) {
agent->removeRange(cacheIndex, cache.count() - cacheIndex);
}
if (referenceIndex < reference.count()) {
agent->insertRange(cache.count(), reference.count() - referenceIndex, reference, referenceIndex);
}
cacheIndex = 0;
referenceIndex = 0;
}
template <typename Agent, typename CacheList, typename ReferenceList>
void synchronizeList(
Agent *agent,
const CacheList &cache,
int &cacheIndex,
const ReferenceList &reference,
int &referenceIndex)
{
SynchronizeList<Agent, CacheList, ReferenceList>(
agent, cache, cacheIndex, reference, referenceIndex);
}
template <typename Agent, typename CacheList, typename ReferenceList>
void synchronizeList(Agent *agent, const CacheList &cache, const ReferenceList &reference)
{
int cacheIndex = 0;
int referenceIndex = 0;
synchronizeList(agent, cache, cacheIndex, reference, referenceIndex);
completeSynchronizeList(agent, cache, cacheIndex, reference, referenceIndex);
}
template <typename Agent, typename ReferenceList>
ReferenceList filterList(
Agent *agent,
const ReferenceList &reference)
{
ReferenceList filtered;
filtered.reserve(reference.count());
foreach (const typename ReferenceList::value_type &value, reference)
if (agent->filterValue(value))
filtered.append(value);
return filtered;
}
template <typename Agent, typename CacheList, typename ReferenceList>
void synchronizeFilteredList(
Agent *agent,
const CacheList &cache,
int &cacheIndex,
const ReferenceList &reference,
int &referenceIndex)
{
ReferenceList filtered = filterList(agent, reference);
synchronizeList(agent, cache, cacheIndex, filtered, referenceIndex);
}
template <typename Agent, typename CacheList, typename ReferenceList>
void synchronizeFilteredList(Agent *agent, const CacheList &cache, const ReferenceList &reference)
{
int cacheIndex = 0;
int referenceIndex = 0;
ReferenceList filtered = filterList(agent, reference);
synchronizeList(agent, cache, cacheIndex, filtered, referenceIndex);
completeSynchronizeList(agent, cache, cacheIndex, filtered, referenceIndex);
}
#endif
|