sd/source/ui/sidebar/MasterPageContainerQueue.cxx

   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 #include "MasterPageContainerQueue.hxx"
  21
  22 #include <tools/IdleDetection.hxx>
  23
  24 #include <set>
  25
  26 namespace sd { namespace sidebar {
  27
  28 const sal_Int32 MasterPageContainerQueue::snDelayedCreationTimeout (15);
  29 const sal_Int32 MasterPageContainerQueue::snDelayedCreationTimeoutWhenNotIdle (100);
  30 const sal_Int32 MasterPageContainerQueue::snMasterPagePriorityBoost (5);
  31 const sal_Int32 MasterPageContainerQueue::snWaitForMoreRequestsPriorityThreshold (-10);
  32 sal_uInt32 MasterPageContainerQueue::snWaitForMoreRequestsCount(15);
  33
  34 //===== MasterPageContainerQueue::PreviewCreationRequest ======================
  35
  36 class MasterPageContainerQueue::PreviewCreationRequest
  37 {
  38 public:
  39     PreviewCreationRequest (const SharedMasterPageDescriptor& rpDescriptor, int nPriority)
  40         : mpDescriptor(rpDescriptor),
  41           mnPriority(nPriority)
  42     {}
  43     SharedMasterPageDescriptor mpDescriptor;
  44     int mnPriority;
  45     class Compare
  46     {
  47     public:
  48         bool operator() (const PreviewCreationRequest& r1,const PreviewCreationRequest& r2) const
  49         {
  50             if (r1.mnPriority != r2.mnPriority)
  51             {
  52                 // Prefer requests with higher priority.
  53                 return r1.mnPriority > r2.mnPriority;
  54             }
  55             else
  56             {
  57                 // Prefer tokens that have been earlier created (those with lower
  58                 // value).
  59                 return r1.mpDescriptor->maToken < r2.mpDescriptor->maToken;
  60             }
  61         }
  62     };
  63     class CompareToken
  64     {
  65     public:
  66         MasterPageContainer::Token maToken;
  67         explicit CompareToken(MasterPageContainer::Token aToken) : maToken(aToken) {}
  68         bool operator() (const PreviewCreationRequest& rRequest) const
  69             { return maToken==rRequest.mpDescriptor->maToken; }
  70     };
  71 };
  72
  73 //===== MasterPageContainerQueue::RequestQueue ================================
  74
  75 class MasterPageContainerQueue::RequestQueue
  76     : public ::std::set<PreviewCreationRequest,PreviewCreationRequest::Compare>
  77 {
  78 public:
  79     RequestQueue() {}
  80 };
  81
  82 //===== MasterPageContainerQueue ==============================================
  83
  84 MasterPageContainerQueue* MasterPageContainerQueue::Create (
  85     const std::weak_ptr<ContainerAdapter>& rpContainer)
  86 {
  87     MasterPageContainerQueue* pQueue = new MasterPageContainerQueue(rpContainer);
  88     pQueue->LateInit();
  89     return pQueue;
  90 }
  91
  92 MasterPageContainerQueue::MasterPageContainerQueue (
  93     const std::weak_ptr<ContainerAdapter>& rpContainer)
  94     : mpWeakContainer(rpContainer),
  95       mpRequestQueue(new RequestQueue()),
  96       maDelayedPreviewCreationTimer(),
  97       mnRequestsServedCount(0)
  98 {
  99 }
 100
 101 MasterPageContainerQueue::~MasterPageContainerQueue()
 102 {
 103     maDelayedPreviewCreationTimer.Stop();
 104     while ( ! mpRequestQueue->empty())
 105         mpRequestQueue->erase(mpRequestQueue->begin());
 106 }
 107
 108 void MasterPageContainerQueue::LateInit()
 109 {
 110     // Set up the timer for the delayed creation of preview bitmaps.
 111     maDelayedPreviewCreationTimer.SetTimeout (snDelayedCreationTimeout);
 112     maDelayedPreviewCreationTimer.SetInvokeHandler(
 113         LINK(this,MasterPageContainerQueue,DelayedPreviewCreation) );
 114 }
 115
 116 bool MasterPageContainerQueue::RequestPreview (const SharedMasterPageDescriptor& rpDescriptor)
 117 {
 118     bool bSuccess (false);
 119     if (rpDescriptor.get() != nullptr
 120         && rpDescriptor->maLargePreview.GetSizePixel().Width() == 0)
 121     {
 122         sal_Int32 nPriority (CalculatePriority(rpDescriptor));
 123
 124         // Add a new or replace an existing request.
 125         RequestQueue::iterator iRequest (::std::find_if(
 126             mpRequestQueue->begin(),
 127             mpRequestQueue->end(),
 128             PreviewCreationRequest::CompareToken(rpDescriptor->maToken)));
 129         // When a request for the same token exists then the lowest of the
 130         // two priorities is used.
 131         if (iRequest != mpRequestQueue->end())
 132             if (iRequest->mnPriority < nPriority)
 133             {
 134                 mpRequestQueue->erase(iRequest);
 135                 iRequest = mpRequestQueue->end();
 136             }
 137
 138         // Add a new request when none exists (or has just been erased).
 139         if (iRequest == mpRequestQueue->end())
 140         {
 141             mpRequestQueue->insert(PreviewCreationRequest(rpDescriptor,nPriority));
 142             maDelayedPreviewCreationTimer.Start();
 143             bSuccess = true;
 144         }
 145     }
 146     return bSuccess;
 147 }
 148
 149 sal_Int32 MasterPageContainerQueue::CalculatePriority (
 150     const SharedMasterPageDescriptor& rpDescriptor)
 151 {
 152     sal_Int32 nPriority;
 153
 154     // The cost is used as a starting value.
 155     int nCost (0);
 156     if (rpDescriptor->mpPreviewProvider.get() != nullptr)
 157     {
 158         nCost = rpDescriptor->mpPreviewProvider->GetCostIndex();
 159         if (rpDescriptor->mpPreviewProvider->NeedsPageObject())
 160             if (rpDescriptor->mpPageObjectProvider.get() != nullptr)
 161                 nCost += rpDescriptor->mpPageObjectProvider->GetCostIndex();
 162     }
 163
 164     // Its negative value is used so that requests with a low cost are
 165     // preferred over those with high costs.
 166     nPriority = -nCost;
 167
 168     // Add a term that introduces an order based on the appearance in the
 169     // AllMasterPagesSelector.
 170     nPriority -= rpDescriptor->maToken / 3;
 171
 172     // Process requests for the CurrentMasterPagesSelector first.
 173     if (rpDescriptor->meOrigin == MasterPageContainer::MASTERPAGE)
 174         nPriority += snMasterPagePriorityBoost;
 175
 176     return nPriority;
 177 }
 178
 179 IMPL_LINK(MasterPageContainerQueue, DelayedPreviewCreation, Timer*, pTimer, void)
 180 {
 181     bool bIsShowingFullScreenShow (false);
 182     bool bWaitForMoreRequests (false);
 183
 184     do
 185     {
 186         if (mpRequestQueue->empty())
 187             break;
 188
 189         // First check whether the system is idle.
 190         tools::IdleState nIdleState (tools::IdleDetection::GetIdleState(nullptr));
 191         if (nIdleState != tools::IdleState::Idle)
 192         {
 193             if (nIdleState & tools::IdleState::FullScreenShowActive)
 194                 bIsShowingFullScreenShow = true;
 195             break;
 196         }
 197
 198         PreviewCreationRequest aRequest (*mpRequestQueue->begin());
 199
 200         // Check if the request should really be processed right now.
 201         // Reasons to not do it are when its cost is high and not many other
 202         // requests have been inserted into the queue that would otherwise
 203         // be processed first.
 204         if (aRequest.mnPriority < snWaitForMoreRequestsPriorityThreshold
 205             && (mnRequestsServedCount+mpRequestQueue->size() < snWaitForMoreRequestsCount))
 206         {
 207             // Wait for more requests before this one is processed.  Note
 208             // that the queue processing is not started anew when this
 209             // method is left.  That is done when the next request is
 210             // inserted.
 211             bWaitForMoreRequests = true;
 212             break;
 213         }
 214
 215         mpRequestQueue->erase(mpRequestQueue->begin());
 216
 217         if (aRequest.mpDescriptor.get() != nullptr)
 218         {
 219             mnRequestsServedCount += 1;
 220             if ( ! mpWeakContainer.expired())
 221             {
 222                 std::shared_ptr<ContainerAdapter> pContainer (mpWeakContainer);
 223                 if (pContainer.get() != nullptr)
 224                     pContainer->UpdateDescriptor(aRequest.mpDescriptor,false,true,true);
 225             }
 226         }
 227     }
 228     while (false);
 229
 230     if (mpRequestQueue->size() > 0 && ! bWaitForMoreRequests)
 231     {
 232         int nTimeout (snDelayedCreationTimeout);
 233         if (bIsShowingFullScreenShow)
 234             nTimeout = snDelayedCreationTimeoutWhenNotIdle;
 235         maDelayedPreviewCreationTimer.SetTimeout(nTimeout);
 236         pTimer->Start();
 237     }
 238 }
 239
 240 bool MasterPageContainerQueue::HasRequest (MasterPageContainer::Token aToken) const
 241 {
 242     RequestQueue::iterator iRequest (::std::find_if(
 243         mpRequestQueue->begin(),
 244         mpRequestQueue->end(),
 245         PreviewCreationRequest::CompareToken(aToken)));
 246     return (iRequest != mpRequestQueue->end());
 247 }
 248
 249 bool MasterPageContainerQueue::IsEmpty() const
 250 {
 251     return mpRequestQueue->empty();
 252 }
 253
 254 void MasterPageContainerQueue::ProcessAllRequests()
 255 {
 256     snWaitForMoreRequestsCount = 0;
 257     if (mpRequestQueue->size() > 0)
 258         maDelayedPreviewCreationTimer.Start();
 259 }
 260
 261 } } // end of namespace sd::sidebar
 262
 263 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */