SlsBitmapCache.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/.
 *
 * 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 .
 */
 
#pragma once
 
#include <vcl/bitmapex.hxx>
#include <mutex>
#include <memory>
 
class SdrPage;
 
namespace sd::slidesorter::cache
{
class CacheCompactor;
class BitmapCompressor;
 
class BitmapCache
{
public:
    typedef const SdrPage* CacheKey;
    class CacheEntry;
    class CacheBitmapContainer;
    typedef ::std::vector<CacheKey> CacheIndex;
 
    explicit BitmapCache();
 
    ~BitmapCache();
 
    void Clear();
 
    bool IsFull() const { return mbIsFull; }
 
    sal_Int32 GetSize() const { return mnNormalCacheSize; }
 
    bool HasBitmap(const CacheKey& rKey);
 
    bool BitmapIsUpToDate(const CacheKey& rKey);
 
    BitmapEx GetBitmap(const CacheKey& rKey);
 
    BitmapEx GetMarkedBitmap(const CacheKey& rKey);
 
    void ReleaseBitmap(const CacheKey& rKey);
 
    bool InvalidateBitmap(const CacheKey& rKey);
 
    void InvalidateCache();
 
    void SetBitmap(const CacheKey& rKey, const BitmapEx& rPreview, bool bIsPrecious);
 
    void SetMarkedBitmap(const CacheKey& rKey, const BitmapEx& rPreview);
 
    void SetPrecious(const CacheKey& rKey, bool bIsPrecious);
 
    void ReCalculateTotalCacheSize();
 
    void Recycle(const BitmapCache& rCache);
 
    CacheIndex GetCacheIndex() const;
 
    void Compress(const CacheKey& rKey, const std::shared_ptr<BitmapCompressor>& rpCompressor);
 
private:
    mutable std::mutex maMutex;
 
    std::unique_ptr<CacheBitmapContainer> mpBitmapContainer;
 
    sal_Int32 mnNormalCacheSize;
 
    sal_Int32 mnPreciousCacheSize;
 
    sal_Int32 mnCurrentAccessTime;
 
    sal_Int32 mnMaximalNormalCacheSize;
 
    ::std::unique_ptr<CacheCompactor> mpCacheCompactor;
 
    bool mbIsFull;
 
    enum CacheOperation
    {
        ADD,
        REMOVE
    };
    void UpdateCacheSize(std::unique_lock<std::mutex>& rGuard, const CacheEntry& rKey,
                         CacheOperation eOperation);
 
    void ReCalculateTotalCacheSize(std::unique_lock<std::mutex>& rGuard);
 
    void SetBitmap(std::unique_lock<std::mutex>& rGuard, const CacheKey& rKey,
                   const BitmapEx& rPreview, bool bIsPrecious);
};
 
} // end of namespace ::sd::slidesorter::cache
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */