Manager.hxx

Go to the documentation of this file.

/* -*- 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/.
 */

#ifndef INCLUDED_VCL_INC_GRAPHIC_MANAGER_HXX
#define INCLUDED_VCL_INC_GRAPHIC_MANAGER_HXX

#include <sal/types.h>
#include <rtl/ustring.hxx>
#include <vcl/bitmapex.hxx>
#include <vcl/animate/Animation.hxx>
#include <vcl/vectorgraphicdata.hxx>
#include <vcl/timer.hxx>
#include <vcl/GraphicExternalLink.hxx>
#include <vcl/gfxlink.hxx>

#include <memory>
#include <mutex>
#include <chrono>
#include <o3tl/sorted_vector.hxx>

class ImpGraphic;

namespace vcl::graphic
{
class Manager final
{
private:
    std::mutex maMutex; // instead of SolarMutex because graphics can live past vcl main
    o3tl::sorted_vector<ImpGraphic*> m_pImpGraphicList;
    std::chrono::seconds mnAllowedIdleTime;
    bool mbSwapEnabled;
    bool mbReducingGraphicMemory;
    sal_Int64 mnMemoryLimit;
    sal_Int64 mnUsedSize;
    Timer maSwapOutTimer;

    Manager();

    void registerGraphic(const std::shared_ptr<ImpGraphic>& rImpGraphic);
    void loopGraphicsAndSwapOut(std::unique_lock<std::mutex>& rGuard);

    DECL_LINK(SwapOutTimerHandler, Timer*, void);

    static sal_Int64 getGraphicSizeBytes(const ImpGraphic* pImpGraphic);
    void reduceGraphicMemory(std::unique_lock<std::mutex>& rGuard);

public:
    static Manager& get();

    void swappedIn(const ImpGraphic* pImpGraphic, sal_Int64 nSizeBytes);
    void swappedOut(const ImpGraphic* pImpGraphic, sal_Int64 nSizeBytes);

    void changeExisting(const ImpGraphic* pImpGraphic, sal_Int64 nOldSize);
    void unregisterGraphic(ImpGraphic* pImpGraphic);

    std::shared_ptr<ImpGraphic> copy(std::shared_ptr<ImpGraphic> const& pImpGraphic);
    std::shared_ptr<ImpGraphic> newInstance();
    std::shared_ptr<ImpGraphic> newInstance(const BitmapEx& rBitmapEx);
    std::shared_ptr<ImpGraphic> newInstance(std::shared_ptr<GfxLink> const& rLink,
                                            sal_Int32 nPageIndex = 0);
    std::shared_ptr<ImpGraphic>
    newInstance(const std::shared_ptr<VectorGraphicData>& rVectorGraphicDataPtr);
    std::shared_ptr<ImpGraphic> newInstance(const Animation& rAnimation);
    std::shared_ptr<ImpGraphic> newInstance(const GDIMetaFile& rMtf);
    std::shared_ptr<ImpGraphic> newInstance(const GraphicExternalLink& rGraphicLink);
};

} // end namespace vcl::graphic

#endif // INCLUDED_VCL_INC_GRAPHIC_MANAGER_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */