vcl/inc/graphic/Manager.hxx

   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
  10 #ifndef INCLUDED_VCL_INC_GRAPHIC_MANAGER_HXX
  11 #define INCLUDED_VCL_INC_GRAPHIC_MANAGER_HXX
  12
  13 #include <sal/types.h>
  14 #include <rtl/strbuf.hxx>
  15 #include <vcl/bitmapex.hxx>
  16 #include <vcl/animate/Animation.hxx>
  17 #include <vcl/vectorgraphicdata.hxx>
  18 #include <vcl/timer.hxx>
  19 #include <vcl/GraphicExternalLink.hxx>
  20 #include <vcl/gfxlink.hxx>
  21
  22 #include <memory>
  23 #include <mutex>
  24 #include <chrono>
  25 #include <o3tl/sorted_vector.hxx>
  26
  27 class ImpGraphic;
  28
  29 namespace vcl::graphic
  30 {
  31 class Manager final
  32 {
  33 private:
  34     std::mutex maMutex; // instead of SolarMutex because graphics can live past vcl main
  35     o3tl::sorted_vector<ImpGraphic*> m_pImpGraphicList;
  36     std::chrono::seconds mnAllowedIdleTime;
  37     bool mbSwapEnabled;
  38     bool mbReducingGraphicMemory;
  39     sal_Int64 mnMemoryLimit;
  40     sal_Int64 mnUsedSize;
  41     Timer maSwapOutTimer;
  42
  43     Manager();
  44
  45     void registerGraphic(const std::shared_ptr<ImpGraphic>& rImpGraphic);
  46     void loopGraphicsAndSwapOut(std::unique_lock<std::mutex>& rGuard, bool bDropAll);
  47
  48     DECL_LINK(SwapOutTimerHandler, Timer*, void);
  49
  50     static sal_Int64 getGraphicSizeBytes(const ImpGraphic* pImpGraphic);
  51     void reduceGraphicMemory(std::unique_lock<std::mutex>& rGuard, bool bDropAll = false);
  52
  53 public:
  54     static Manager& get();
  55
  56     void dropCache();
  57     void dumpState(rtl::OStringBuffer& rState);
  58
  59     void swappedIn(const ImpGraphic* pImpGraphic, sal_Int64 nSizeBytes);
  60     void swappedOut(const ImpGraphic* pImpGraphic, sal_Int64 nSizeBytes);
  61
  62     void changeExisting(const ImpGraphic* pImpGraphic, sal_Int64 nOldSize);
  63     void unregisterGraphic(ImpGraphic* pImpGraphic);
  64
  65     std::shared_ptr<ImpGraphic> copy(std::shared_ptr<ImpGraphic> const& pImpGraphic);
  66     std::shared_ptr<ImpGraphic> newInstance();
  67     std::shared_ptr<ImpGraphic> newInstance(const BitmapEx& rBitmapEx);
  68     std::shared_ptr<ImpGraphic> newInstance(std::shared_ptr<GfxLink> const& rLink,
  69                                             sal_Int32 nPageIndex = 0);
  70     std::shared_ptr<ImpGraphic>
  71     newInstance(const std::shared_ptr<VectorGraphicData>& rVectorGraphicDataPtr);
  72     std::shared_ptr<ImpGraphic> newInstance(const Animation& rAnimation);
  73     std::shared_ptr<ImpGraphic> newInstance(const GDIMetaFile& rMtf);
  74     std::shared_ptr<ImpGraphic> newInstance(const GraphicExternalLink& rGraphicLink);
  75 };
  76
  77 } // end namespace vcl::graphic
  78
  79 #endif // INCLUDED_VCL_INC_GRAPHIC_MANAGER_HXX
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */