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
|
/* -*- 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 "MasterPageContainerQueue.hxx"
#include "MasterPageContainerProviders.hxx"
#include <tools/IdleDetection.hxx>
#include <set>
namespace sd::sidebar {
const sal_Int32 MasterPageContainerQueue::snDelayedCreationTimeout (15);
const sal_Int32 MasterPageContainerQueue::snDelayedCreationTimeoutWhenNotIdle (100);
const sal_Int32 MasterPageContainerQueue::snMasterPagePriorityBoost (5);
const sal_Int32 MasterPageContainerQueue::snWaitForMoreRequestsPriorityThreshold (-10);
sal_uInt32 MasterPageContainerQueue::snWaitForMoreRequestsCount(15);
//===== MasterPageContainerQueue::PreviewCreationRequest ======================
class MasterPageContainerQueue::PreviewCreationRequest
{
public:
PreviewCreationRequest (const SharedMasterPageDescriptor& rpDescriptor, int nPriority)
: mpDescriptor(rpDescriptor),
mnPriority(nPriority)
{}
SharedMasterPageDescriptor mpDescriptor;
int mnPriority;
class Compare
{
public:
bool operator() (const PreviewCreationRequest& r1,const PreviewCreationRequest& r2) const
{
if (r1.mnPriority != r2.mnPriority)
{
// Prefer requests with higher priority.
return r1.mnPriority > r2.mnPriority;
}
else
{
// Prefer tokens that have been earlier created (those with lower
// value).
return r1.mpDescriptor->maToken < r2.mpDescriptor->maToken;
}
}
};
class CompareToken
{
public:
MasterPageContainer::Token maToken;
explicit CompareToken(MasterPageContainer::Token aToken) : maToken(aToken) {}
bool operator() (const PreviewCreationRequest& rRequest) const
{ return maToken==rRequest.mpDescriptor->maToken; }
};
};
//===== MasterPageContainerQueue::RequestQueue ================================
class MasterPageContainerQueue::RequestQueue
: public ::std::set<PreviewCreationRequest,PreviewCreationRequest::Compare>
{
public:
RequestQueue() {}
};
//===== MasterPageContainerQueue ==============================================
MasterPageContainerQueue* MasterPageContainerQueue::Create (
const std::weak_ptr<ContainerAdapter>& rpContainer)
{
MasterPageContainerQueue* pQueue = new MasterPageContainerQueue(rpContainer);
pQueue->LateInit();
return pQueue;
}
MasterPageContainerQueue::MasterPageContainerQueue (
const std::weak_ptr<ContainerAdapter>& rpContainer)
: mpWeakContainer(rpContainer),
mpRequestQueue(new RequestQueue()),
maDelayedPreviewCreationTimer(),
mnRequestsServedCount(0)
{
}
MasterPageContainerQueue::~MasterPageContainerQueue()
{
maDelayedPreviewCreationTimer.Stop();
while ( ! mpRequestQueue->empty())
mpRequestQueue->erase(mpRequestQueue->begin());
}
void MasterPageContainerQueue::LateInit()
{
// Set up the timer for the delayed creation of preview bitmaps.
maDelayedPreviewCreationTimer.SetTimeout (snDelayedCreationTimeout);
maDelayedPreviewCreationTimer.SetInvokeHandler(
LINK(this,MasterPageContainerQueue,DelayedPreviewCreation) );
}
bool MasterPageContainerQueue::RequestPreview (const SharedMasterPageDescriptor& rpDescriptor)
{
bool bSuccess (false);
if (rpDescriptor
&& rpDescriptor->maLargePreview.GetSizePixel().Width() == 0)
{
sal_Int32 nPriority (CalculatePriority(rpDescriptor));
// Add a new or replace an existing request.
RequestQueue::iterator iRequest (::std::find_if(
mpRequestQueue->begin(),
mpRequestQueue->end(),
PreviewCreationRequest::CompareToken(rpDescriptor->maToken)));
// When a request for the same token exists then the lowest of the
// two priorities is used.
if (iRequest != mpRequestQueue->end())
if (iRequest->mnPriority < nPriority)
{
mpRequestQueue->erase(iRequest);
iRequest = mpRequestQueue->end();
}
// Add a new request when none exists (or has just been erased).
if (iRequest == mpRequestQueue->end())
{
mpRequestQueue->insert(PreviewCreationRequest(rpDescriptor,nPriority));
maDelayedPreviewCreationTimer.Start();
bSuccess = true;
}
}
return bSuccess;
}
sal_Int32 MasterPageContainerQueue::CalculatePriority (
const SharedMasterPageDescriptor& rpDescriptor)
{
sal_Int32 nPriority;
// The cost is used as a starting value.
int nCost (0);
if (rpDescriptor->mpPreviewProvider != nullptr)
{
nCost = rpDescriptor->mpPreviewProvider->GetCostIndex();
if (rpDescriptor->mpPreviewProvider->NeedsPageObject())
if (rpDescriptor->mpPageObjectProvider != nullptr)
nCost += rpDescriptor->mpPageObjectProvider->GetCostIndex();
}
// Its negative value is used so that requests with a low cost are
// preferred over those with high costs.
nPriority = -nCost;
// Add a term that introduces an order based on the appearance in the
// AllMasterPagesSelector.
nPriority -= rpDescriptor->maToken / 3;
// Process requests for the CurrentMasterPagesSelector first.
if (rpDescriptor->meOrigin == MasterPageContainer::MASTERPAGE)
nPriority += snMasterPagePriorityBoost;
return nPriority;
}
IMPL_LINK(MasterPageContainerQueue, DelayedPreviewCreation, Timer*, pTimer, void)
{
bool bIsShowingFullScreenShow (false);
bool bWaitForMoreRequests (false);
do
{
if (mpRequestQueue->empty())
break;
// First check whether the system is idle.
tools::IdleState nIdleState (tools::IdleDetection::GetIdleState(nullptr));
if (nIdleState != tools::IdleState::Idle)
{
if (nIdleState & tools::IdleState::FullScreenShowActive)
bIsShowingFullScreenShow = true;
break;
}
PreviewCreationRequest aRequest (*mpRequestQueue->begin());
// Check if the request should really be processed right now.
// Reasons to not do it are when its cost is high and not many other
// requests have been inserted into the queue that would otherwise
// be processed first.
if (aRequest.mnPriority < snWaitForMoreRequestsPriorityThreshold
&& (mnRequestsServedCount+mpRequestQueue->size() < snWaitForMoreRequestsCount))
{
// Wait for more requests before this one is processed. Note
// that the queue processing is not started anew when this
// method is left. That is done when the next request is
// inserted.
bWaitForMoreRequests = true;
break;
}
mpRequestQueue->erase(mpRequestQueue->begin());
if (aRequest.mpDescriptor)
{
mnRequestsServedCount += 1;
if ( ! mpWeakContainer.expired())
{
std::shared_ptr<ContainerAdapter> pContainer (mpWeakContainer);
if (pContainer != nullptr)
pContainer->UpdateDescriptor(aRequest.mpDescriptor,false,true,true);
}
}
}
while (false);
if (!mpRequestQueue->empty() && ! bWaitForMoreRequests)
{
int nTimeout (snDelayedCreationTimeout);
if (bIsShowingFullScreenShow)
nTimeout = snDelayedCreationTimeoutWhenNotIdle;
maDelayedPreviewCreationTimer.SetTimeout(nTimeout);
pTimer->Start();
}
}
bool MasterPageContainerQueue::HasRequest (MasterPageContainer::Token aToken) const
{
return std::any_of(
mpRequestQueue->begin(),
mpRequestQueue->end(),
PreviewCreationRequest::CompareToken(aToken));
}
bool MasterPageContainerQueue::IsEmpty() const
{
return mpRequestQueue->empty();
}
void MasterPageContainerQueue::ProcessAllRequests()
{
snWaitForMoreRequestsCount = 0;
if (!mpRequestQueue->empty())
maDelayedPreviewCreationTimer.Start();
}
} // end of namespace sd::sidebar
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
