sd/source/ui/slidesorter/cache/SlsQueueProcessor.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 "SlsQueueProcessor.hxx"
  21 #include "SlsCacheConfiguration.hxx"
  22 #include "SlsRequestQueue.hxx"
  23 #include "SlsBitmapCache.hxx"
  24
  25 #include <sdpage.hxx>
  26 #include <comphelper/profilezone.hxx>
  27
  28 namespace sd { namespace slidesorter { namespace cache {
  29
  30 //=====  QueueProcessor  ======================================================
  31
  32 QueueProcessor::QueueProcessor (
  33     RequestQueue& rQueue,
  34     const std::shared_ptr<BitmapCache>& rpCache,
  35     const Size& rPreviewSize,
  36     const bool bDoSuperSampling,
  37     const SharedCacheContext& rpCacheContext)
  38     : maMutex(),
  39       maTimer(),
  40       maPreviewSize(rPreviewSize),
  41       mbDoSuperSampling(bDoSuperSampling),
  42       mpCacheContext(rpCacheContext),
  43       mrQueue(rQueue),
  44       mpCache(rpCache),
  45       maBitmapFactory(),
  46       mbIsPaused(false)
  47 {
  48     maTimer.SetInvokeHandler (LINK(this,QueueProcessor,ProcessRequestHdl));
  49     maTimer.SetTimeout (10);
  50     maTimer.SetDebugName ("sd::QueueProcessor maTimer");
  51 }
  52
  53 QueueProcessor::~QueueProcessor()
  54 {
  55 }
  56
  57 void QueueProcessor::Start (int nPriorityClass)
  58 {
  59     if (mbIsPaused)
  60         return;
  61     if ( ! maTimer.IsActive())
  62     {
  63         if (nPriorityClass == 0)
  64             maTimer.SetTimeout (10);
  65         else
  66             maTimer.SetTimeout (100);
  67         maTimer.Start();
  68     }
  69 }
  70
  71 void QueueProcessor::Stop()
  72 {
  73     if (maTimer.IsActive())
  74         maTimer.Stop();
  75 }
  76
  77 void QueueProcessor::Pause()
  78 {
  79     mbIsPaused = true;
  80 }
  81
  82 void QueueProcessor::Resume()
  83 {
  84     mbIsPaused = false;
  85     if ( ! mrQueue.IsEmpty())
  86         Start(mrQueue.GetFrontPriorityClass());
  87 }
  88
  89 void QueueProcessor::SetPreviewSize (
  90     const Size& rPreviewSize,
  91     const bool bDoSuperSampling)
  92 {
  93     maPreviewSize = rPreviewSize;
  94     mbDoSuperSampling = bDoSuperSampling;
  95 }
  96
  97 IMPL_LINK_NOARG(QueueProcessor, ProcessRequestHdl, Timer *, void)
  98 {
  99     ProcessRequests();
 100 }
 101
 102 void QueueProcessor::ProcessRequests()
 103 {
 104     assert(mpCacheContext.get()!=nullptr);
 105
 106     // Never process more than one request at a time in order to prevent the
 107     // lock up of the edit view.
 108     if ( ! mrQueue.IsEmpty()
 109         && ! mbIsPaused
 110         &&  mpCacheContext->IsIdle())
 111     {
 112         CacheKey aKey = nullptr;
 113         RequestPriorityClass ePriorityClass (NOT_VISIBLE);
 114         {
 115             ::osl::MutexGuard aGuard (mrQueue.GetMutex());
 116
 117             if ( ! mrQueue.IsEmpty())
 118             {
 119                 // Get the request with the highest priority from the queue.
 120                 ePriorityClass = mrQueue.GetFrontPriorityClass();
 121                 aKey = mrQueue.GetFront();
 122                 mrQueue.PopFront();
 123             }
 124         }
 125
 126         if (aKey != nullptr)
 127             ProcessOneRequest(aKey, ePriorityClass);
 128     }
 129
 130     // Schedule the processing of the next element(s).
 131     {
 132         ::osl::MutexGuard aGuard (mrQueue.GetMutex());
 133         if ( ! mrQueue.IsEmpty())
 134             Start(mrQueue.GetFrontPriorityClass());
 135         else
 136         {
 137             comphelper::ProfileZone aZone("QueueProcessor finished processing all elements");
 138         }
 139     }
 140 }
 141
 142 void QueueProcessor::ProcessOneRequest (
 143     CacheKey aKey,
 144     const RequestPriorityClass ePriorityClass)
 145 {
 146     try
 147     {
 148         ::osl::MutexGuard aGuard (maMutex);
 149
 150         // Create a new preview bitmap and store it in the cache.
 151         if (mpCache != nullptr && mpCacheContext.get() != nullptr)
 152         {
 153             const SdPage* pSdPage = dynamic_cast<const SdPage*>(mpCacheContext->GetPage(aKey));
 154             if (pSdPage != nullptr)
 155             {
 156                 const BitmapEx aPreview (
 157                     maBitmapFactory.CreateBitmap(*pSdPage, maPreviewSize, mbDoSuperSampling));
 158                 mpCache->SetBitmap (pSdPage, aPreview, ePriorityClass!=NOT_VISIBLE);
 159
 160                 // Initiate a repaint of the new preview.
 161                 mpCacheContext->NotifyPreviewCreation(aKey);
 162             }
 163         }
 164     }
 165     catch (css::uno::RuntimeException &)
 166     {
 167         OSL_FAIL("RuntimeException caught in QueueProcessor");
 168     }
 169     catch (css::uno::Exception &)
 170     {
 171         OSL_FAIL("Exception caught in QueueProcessor");
 172     }
 173 }
 174
 175 void QueueProcessor::SetBitmapCache (
 176     const std::shared_ptr<BitmapCache>& rpCache)
 177 {
 178     mpCache = rpCache;
 179 }
 180
 181 } } } // end of namespace ::sd::slidesorter::cache
 182
 183 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */