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
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <cache/SlsPageCacheManager.hxx>
#include "SlsBitmapCache.hxx"
#include <view/SlideSorterView.hxx>
#include <model/SlideSorterModel.hxx>
#include <deque>
#include <map>
#include <memory>
namespace {
/** Collection of data that is stored for all active preview caches.
*/
class CacheDescriptor
{
public:
::sd::slidesorter::cache::PageCacheManager::DocumentKey mpDocument;
Size const maPreviewSize;
CacheDescriptor(
::sd::slidesorter::cache::PageCacheManager::DocumentKey const & pDocument,
const Size& rPreviewSize)
:mpDocument(pDocument),maPreviewSize(rPreviewSize)
{}
/// Test for equality with respect to all members.
class Equal {public: bool operator() (
const CacheDescriptor& rDescriptor1, const CacheDescriptor& rDescriptor2) const {
return rDescriptor1.mpDocument==rDescriptor2.mpDocument
&& rDescriptor1.maPreviewSize==rDescriptor2.maPreviewSize;
} };
/// Hash function that takes all members into account.
class Hash {public: size_t operator() (const CacheDescriptor& rDescriptor) const {
return reinterpret_cast<size_t>(rDescriptor.mpDocument.get()) + rDescriptor.maPreviewSize.Width();
} };
};
/** Collection of data that is stored for the inactive, recently used
caches.
*/
class RecentlyUsedCacheDescriptor
{
public:
Size maPreviewSize;
std::shared_ptr< ::sd::slidesorter::cache::BitmapCache> mpCache;
RecentlyUsedCacheDescriptor(
const Size& rPreviewSize,
const std::shared_ptr< ::sd::slidesorter::cache::BitmapCache>& rpCache)
:maPreviewSize(rPreviewSize),mpCache(rpCache)
{}
};
/** The list of recently used caches is organized as queue. When elements
are added the list is shortened to the maximally allowed number of
elements by removing the least recently used elements.
*/
typedef ::std::deque<RecentlyUsedCacheDescriptor> RecentlyUsedQueue;
/** Compare the caches by preview size. Those that match the given size
come first, then, regardless of the given size, the largest ones before
the smaller ones.
*/
class BestFittingCacheComparer
{
public:
explicit BestFittingCacheComparer (const Size& rPreferredSize)
: maPreferredSize(rPreferredSize)
{}
bool operator()(const ::sd::slidesorter::cache::PageCacheManager::BestFittingPageCaches::value_type& rElement1,
const ::sd::slidesorter::cache::PageCacheManager::BestFittingPageCaches::value_type& rElement2)
{
if (rElement2.first == maPreferredSize)
return false;
else if (rElement1.first == maPreferredSize)
return true;
else
return (rElement1.first.Width()*rElement1.first.Height()
> rElement2.first.Width()*rElement2.first.Height());
}
private:
Size const maPreferredSize;
};
} // end of anonymous namespace
namespace sd { namespace slidesorter { namespace cache {
/** Container for the active caches.
*/
class PageCacheManager::PageCacheContainer
: public std::unordered_map<CacheDescriptor,
std::shared_ptr<BitmapCache>,
CacheDescriptor::Hash,
CacheDescriptor::Equal>
{
public:
PageCacheContainer() {}
/** Compare entries in the cache container with respect to the cache
address only.
*/
class CompareWithCache { public:
explicit CompareWithCache(const std::shared_ptr<BitmapCache>& rpCache)
: mpCache(rpCache) {}
bool operator () (const PageCacheContainer::value_type& rValue) const
{ return rValue.second == mpCache; }
private:
std::shared_ptr<BitmapCache> mpCache;
};
};
/** The recently used caches are stored in one queue for each document.
*/
class PageCacheManager::RecentlyUsedPageCaches
{
public:
typedef DocumentKey key_type;
typedef RecentlyUsedQueue mapped_type;
typedef std::pair<const key_type,mapped_type> value_type;
typedef std::map<key_type,mapped_type>::iterator iterator;
private:
std::map<key_type,mapped_type> maMap;
public:
RecentlyUsedPageCaches () {};
iterator end() { return maMap.end(); }
void clear() { maMap.clear(); }
iterator find(const key_type& key) { return maMap.find(key); }
template<class... Args>
std::pair<iterator,bool> emplace(Args&&... args) { return maMap.emplace(std::forward<Args>(args)...); }
};
class PageCacheManager::Deleter
{
public:
void operator() (PageCacheManager* pObject) { delete pObject; }
};
//===== PageCacheManager ====================================================
std::weak_ptr<PageCacheManager> PageCacheManager::mpInstance;
std::shared_ptr<PageCacheManager> PageCacheManager::Instance()
{
std::shared_ptr<PageCacheManager> pInstance;
::osl::MutexGuard aGuard (::osl::Mutex::getGlobalMutex());
pInstance = mpInstance.lock();
if (pInstance.get() == nullptr)
{
pInstance = std::shared_ptr<PageCacheManager>(
new PageCacheManager(),
PageCacheManager::Deleter());
mpInstance = pInstance;
}
return pInstance;
}
PageCacheManager::PageCacheManager()
: mpPageCaches(new PageCacheContainer()),
mpRecentlyUsedPageCaches(new RecentlyUsedPageCaches())
{
}
PageCacheManager::~PageCacheManager()
{
}
std::shared_ptr<BitmapCache> PageCacheManager::GetCache (
const DocumentKey& pDocument,
const Size& rPreviewSize)
{
std::shared_ptr<BitmapCache> pResult;
// Look for the cache in the list of active caches.
CacheDescriptor aKey (pDocument, rPreviewSize);
PageCacheContainer::iterator iCache (mpPageCaches->find(aKey));
if (iCache != mpPageCaches->end())
pResult = iCache->second;
// Look for the cache in the list of recently used caches.
if (pResult.get() == nullptr)
pResult = GetRecentlyUsedCache(pDocument, rPreviewSize);
// Create the cache when no suitable one does exist.
if (pResult.get() == nullptr)
pResult.reset(new BitmapCache());
// The cache may be newly created and thus empty or is old and may
// contain previews that are not up-to-date. Recycle previews from
// other caches to fill in the holes.
Recycle(pResult, pDocument,rPreviewSize);
// Put the new (or old) cache into the container.
if (pResult.get() != nullptr)
mpPageCaches->emplace(aKey, pResult);
return pResult;
}
void PageCacheManager::Recycle (
const std::shared_ptr<BitmapCache>& rpCache,
const DocumentKey& pDocument,
const Size& rPreviewSize)
{
BestFittingPageCaches aCaches;
// Add bitmap caches from active caches.
PageCacheContainer::iterator iActiveCache;
for (iActiveCache=mpPageCaches->begin(); iActiveCache!=mpPageCaches->end(); ++iActiveCache)
{
if (iActiveCache->first.mpDocument == pDocument)
aCaches.emplace_back(
iActiveCache->first.maPreviewSize, iActiveCache->second);
}
// Add bitmap caches from recently used caches.
RecentlyUsedPageCaches::iterator iQueue (mpRecentlyUsedPageCaches->find(pDocument));
if (iQueue != mpRecentlyUsedPageCaches->end())
{
RecentlyUsedQueue::const_iterator iRecentCache;
for (iRecentCache=iQueue->second.begin();iRecentCache!=iQueue->second.end();++iRecentCache)
aCaches.emplace_back(
iRecentCache->maPreviewSize, iRecentCache->mpCache);
}
::std::sort(aCaches.begin(), aCaches.end(), BestFittingCacheComparer(rPreviewSize));
BestFittingPageCaches::const_iterator iBestCache;
for (iBestCache=aCaches.begin(); iBestCache!=aCaches.end(); ++iBestCache)
{
rpCache->Recycle(*iBestCache->second);
}
}
void PageCacheManager::ReleaseCache (const std::shared_ptr<BitmapCache>& rpCache)
{
PageCacheContainer::iterator iCache (::std::find_if(
mpPageCaches->begin(),
mpPageCaches->end(),
PageCacheContainer::CompareWithCache(rpCache)));
if (iCache != mpPageCaches->end())
{
assert(iCache->second == rpCache);
PutRecentlyUsedCache(iCache->first.mpDocument,iCache->first.maPreviewSize,rpCache);
mpPageCaches->erase(iCache);
}
}
std::shared_ptr<BitmapCache> PageCacheManager::ChangeSize (
const std::shared_ptr<BitmapCache>& rpCache,
const Size&,
const Size& rNewPreviewSize)
{
std::shared_ptr<BitmapCache> pResult;
if (rpCache.get() != nullptr)
{
// Look up the given cache in the list of active caches.
PageCacheContainer::iterator iCacheToChange (::std::find_if(
mpPageCaches->begin(),
mpPageCaches->end(),
PageCacheContainer::CompareWithCache(rpCache)));
if (iCacheToChange != mpPageCaches->end())
{
assert(iCacheToChange->second == rpCache);
// Now, we can change the preview size of the existing one by
// removing the cache from the list and re-insert it with the
// updated size.
const ::sd::slidesorter::cache::PageCacheManager::DocumentKey aKey (
iCacheToChange->first.mpDocument);
mpPageCaches->erase(iCacheToChange);
mpPageCaches->emplace(
CacheDescriptor(aKey,rNewPreviewSize),
rpCache);
pResult = rpCache;
}
else
{
assert(iCacheToChange != mpPageCaches->end());
}
}
return pResult;
}
bool PageCacheManager::InvalidatePreviewBitmap (
const DocumentKey& pDocument,
const SdrPage* pKey)
{
bool bHasChanged (false);
if (pDocument!=nullptr)
{
// Iterate over all caches that are currently in use and invalidate
// the previews in those that belong to the document.
PageCacheContainer::iterator iCache;
for (iCache=mpPageCaches->begin(); iCache!=mpPageCaches->end(); ++iCache)
if (iCache->first.mpDocument == pDocument)
bHasChanged |= iCache->second->InvalidateBitmap(pKey);
// Invalidate the previews in the recently used caches belonging to
// the given document.
RecentlyUsedPageCaches::iterator iQueue (mpRecentlyUsedPageCaches->find(pDocument));
if (iQueue != mpRecentlyUsedPageCaches->end())
{
RecentlyUsedQueue::const_iterator iCache2;
for (iCache2=iQueue->second.begin(); iCache2!=iQueue->second.end(); ++iCache2)
bHasChanged |= iCache2->mpCache->InvalidateBitmap(pKey);
}
}
return bHasChanged;
}
void PageCacheManager::InvalidateAllPreviewBitmaps (const DocumentKey& pDocument)
{
if (pDocument == nullptr)
return;
// Iterate over all caches that are currently in use and invalidate the
// previews in those that belong to the document.
PageCacheContainer::iterator iCache;
for (iCache=mpPageCaches->begin(); iCache!=mpPageCaches->end(); ++iCache)
if (iCache->first.mpDocument == pDocument)
iCache->second->InvalidateCache();
// Invalidate the previews in the recently used caches belonging to the
// given document.
RecentlyUsedPageCaches::iterator iQueue (mpRecentlyUsedPageCaches->find(pDocument));
if (iQueue != mpRecentlyUsedPageCaches->end())
{
RecentlyUsedQueue::const_iterator iCache2;
for (iCache2=iQueue->second.begin(); iCache2!=iQueue->second.end(); ++iCache2)
iCache2->mpCache->InvalidateCache();
}
}
void PageCacheManager::InvalidateAllCaches()
{
// Iterate over all caches that are currently in use and invalidate
// them.
PageCacheContainer::iterator iCache;
for (iCache=mpPageCaches->begin(); iCache!=mpPageCaches->end(); ++iCache)
iCache->second->InvalidateCache();
// Remove all recently used caches, there is not much sense in storing
// invalidated and unused caches.
mpRecentlyUsedPageCaches->clear();
}
void PageCacheManager::ReleasePreviewBitmap (const SdrPage* pPage)
{
PageCacheContainer::iterator iCache;
for (iCache=mpPageCaches->begin(); iCache!=mpPageCaches->end(); ++iCache)
iCache->second->ReleaseBitmap(pPage);
}
std::shared_ptr<BitmapCache> PageCacheManager::GetRecentlyUsedCache (
const DocumentKey& pDocument,
const Size& rPreviewSize)
{
std::shared_ptr<BitmapCache> pCache;
// Look for the cache in the list of recently used caches.
RecentlyUsedPageCaches::iterator iQueue (mpRecentlyUsedPageCaches->find(pDocument));
if (iQueue != mpRecentlyUsedPageCaches->end())
{
RecentlyUsedQueue::iterator iCache;
for (iCache=iQueue->second.begin(); iCache!= iQueue->second.end(); ++iCache)
if (iCache->maPreviewSize == rPreviewSize)
{
pCache = iCache->mpCache;
iQueue->second.erase(iCache);
break;
}
}
return pCache;
}
void PageCacheManager::PutRecentlyUsedCache(
DocumentKey const & pDocument,
const Size& rPreviewSize,
const std::shared_ptr<BitmapCache>& rpCache)
{
// Look up the list of recently used caches for the given document.
RecentlyUsedPageCaches::iterator iQueue (mpRecentlyUsedPageCaches->find(pDocument));
if (iQueue == mpRecentlyUsedPageCaches->end())
iQueue = mpRecentlyUsedPageCaches->emplace(
pDocument, RecentlyUsedQueue()
).first;
if (iQueue != mpRecentlyUsedPageCaches->end())
{
iQueue->second.push_front(RecentlyUsedCacheDescriptor(rPreviewSize,rpCache));
// Shorten the list of recently used caches to the allowed maximal length.
while (iQueue->second.size() > mnMaximalRecentlyCacheCount)
iQueue->second.pop_back();
}
}
} } } // end of namespace ::sd::slidesorter::cache
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|