GUIImageCache.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef GUIIMAGECACHE_H
#define GUIIMAGECACHE_H
 
#include "eC_String.h"
#include "GUIImageResource.h"
#include "GUIImageCacheReplacementPolicy.h"
 
class CGUIImageCacheReplacementManager;
 
#define GETIMGCACHE (CGUIImageCache::GetInstance())
 
// Uncomment for lots of debug messages
//#define GUI_IMAGECACHE_DEBUG
class CGUIImageCache
{
    friend class CGUIResourceManager; 
    friend class CGUIBackgroundImageLoaderThread; 
    friend class CGfxWrap; 
 
public:
    static void CreateInstance(eC_UInt uiSize = 100 * 1024 * 1024, 
        ReplacementPolicyType_t eUsed = IC_REPLACEMENT_POLICY_LRU, ReplacementPolicyType_t eFree = IC_REPLACEMENT_POLICY_LRU);
 
    static inline CGUIImageCache* GetInstance()
    {
        return ms_pInstance;
    }
 
    static void DeleteInstance();
 
#ifdef GUILIANI_STREAM_GUI
    virtual eC_Bool ReadCacheSettingsFromFile(const eC_String& kPath) =0;
 
    void SetReadResolutionAppendix(const eC_String& kAppendString)
    {
        m_kAppendString = kAppendString;
    }
 
#endif //GUILIANI_STREAM_GUI
 
    eC_Bool SetCacheSizeLimit(eC_UInt uiCacheSizeLimit);
 
    virtual eC_UInt GetCurrentMemoryUsage() const=0;
 
    inline eC_UInt GetCacheSizeLimit() const { return m_uiCacheSizeLimit; }
 
    virtual eC_UInt GetImageSize(const ImageResource_t& eImageID) const=0;
 
    virtual void SetFreeReplacementPolicy(CGUIImageCacheReplacementPolicy* pPolicy);
 
    virtual void SetUsedReplacementPolicy(CGUIImageCacheReplacementPolicy* pPolicy);
 
protected:
    static void NotifyImageAccess(const ImageResource_t& eImageID)
    {
        if (ms_pInstance != NULL)
        {
            ms_pInstance->NotifyImageAccessInternal(eImageID);
        }
    }
 
    virtual eC_Bool FreeSpace(eC_UInt uiSpaceToFree) =0;
 
    virtual eC_Bool LoadImg(const eC_String& kPath, const ImageResource_t& eImageID)=0;
 
    virtual eC_Bool PreloadImg(const eC_String& psPath, const ImageResource_t& eImageID)=0;
 
    virtual void MarkAsUsed(const ImageResource_t& eImageID) =0;
 
    virtual void MarkAsFree(const ImageResource_t& eImageID) =0;
 
    virtual eC_Bool UnloadSpecificImage(const ImageResource_t& eImageID) =0;
 
    virtual void CopyCacheContents(CGUIImageCacheReplacementPolicy* pOldPolicy, CGUIImageCacheReplacementPolicy* pNewPolicy) =0;
 
    virtual void NotifyImageAccessInternal(const ImageResource_t& eImageID)=0;
 
    virtual ~CGUIImageCache();
 
    static CGUIImageCache* ms_pInstance;
 
    eC_UInt m_uiCacheSizeLimit;
 
    eC_String m_kAppendString;
 
    CGUIImageCacheReplacementPolicy* m_pFreeReplacementPolicy;
 
    CGUIImageCacheReplacementPolicy* m_pUsedReplacementPolicy;
 
    CGUIImageCacheReplacementManager* m_pFreeListManager;
 
    CGUIImageCacheReplacementManager* m_pUsedListManager;
};
#endif //GUIIMAGECACHE_H