contentstorage/caclient/src/caiconcache.cpp
author hgs
Fri, 30 Apr 2010 15:22:08 +0300
changeset 93 82b66994846c
parent 87 9d806967057c
child 98 d2f833ab7940
permissions -rw-r--r--
201017
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
87
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
 * Copyright (c)2008 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
 * All rights reserved.
hgs
parents:
diff changeset
     4
 * This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
 * under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
 * which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
 *
hgs
parents:
diff changeset
     9
 * Initial Contributors:
hgs
parents:
diff changeset
    10
 * Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
 *
hgs
parents:
diff changeset
    12
 * Contributors:
hgs
parents:
diff changeset
    13
 *
hgs
parents:
diff changeset
    14
 * Description:  ?Description
hgs
parents:
diff changeset
    15
 *
hgs
parents:
diff changeset
    16
 */
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#include <QCoreApplication>
hgs
parents:
diff changeset
    19
#include "caiconcache.h"
hgs
parents:
diff changeset
    20
#include "caservice.h"
hgs
parents:
diff changeset
    21
#include "caentry.h"
hgs
parents:
diff changeset
    22
#include "caobjectadapter.h"
hgs
parents:
diff changeset
    23
#include "caclienttest_global.h"
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
// Constants
hgs
parents:
diff changeset
    26
static const int maxCost = 250;
hgs
parents:
diff changeset
    27
static const QChar separator = '*';
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
QSharedPointer<CaIconCache> CaIconCache::mInstance(0);
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
/*!
93
hgs
parents: 87
diff changeset
    32
 \class CaIconCache
hgs
parents: 87
diff changeset
    33
 \brief This class provides icon caching mechanism
hgs
parents: 87
diff changeset
    34
 Class implements singleton design patern. Use cache() method
hgs
parents: 87
diff changeset
    35
 to get an instance of CaIconCache
hgs
parents: 87
diff changeset
    36
 */
hgs
parents: 87
diff changeset
    37
hgs
parents: 87
diff changeset
    38
/*!
hgs
parents: 87
diff changeset
    39
 \var CaIconCache::mCache
hgs
parents: 87
diff changeset
    40
 Own.
hgs
parents: 87
diff changeset
    41
 */
hgs
parents: 87
diff changeset
    42
hgs
parents: 87
diff changeset
    43
/*!
hgs
parents: 87
diff changeset
    44
 \var CaIconCache::mService
hgs
parents: 87
diff changeset
    45
 Not own.
hgs
parents: 87
diff changeset
    46
 */
hgs
parents: 87
diff changeset
    47
hgs
parents: 87
diff changeset
    48
/*!
hgs
parents: 87
diff changeset
    49
 \var CaIconCache::mNotifier
hgs
parents: 87
diff changeset
    50
 Own.
87
hgs
parents:
diff changeset
    51
 */
hgs
parents:
diff changeset
    52
hgs
parents:
diff changeset
    53
/*!
hgs
parents:
diff changeset
    54
 Returns an instance of CaIconCache
hgs
parents:
diff changeset
    55
 \retval CaIconCache instance
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
 */
hgs
parents:
diff changeset
    58
CaIconCache *CaIconCache::cache()
hgs
parents:
diff changeset
    59
{
hgs
parents:
diff changeset
    60
    if (!mInstance.data()) {
hgs
parents:
diff changeset
    61
        mInstance = QSharedPointer<CaIconCache>(new CaIconCache());
hgs
parents:
diff changeset
    62
        mInstance->setParent(QCoreApplication::instance());
hgs
parents:
diff changeset
    63
    }
hgs
parents:
diff changeset
    64
    return mInstance.data();
hgs
parents:
diff changeset
    65
}
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
/*!
hgs
parents:
diff changeset
    68
Destructor
hgs
parents:
diff changeset
    69
 */
hgs
parents:
diff changeset
    70
CaIconCache::~CaIconCache()
hgs
parents:
diff changeset
    71
{
hgs
parents:
diff changeset
    72
    CACLIENTTEST_FUNC_ENTRY("CaIconCache::~CaIconCache");
hgs
parents:
diff changeset
    73
    mCache.clear();
hgs
parents:
diff changeset
    74
    delete mNotifier;
hgs
parents:
diff changeset
    75
    CACLIENTTEST_FUNC_EXIT("CaIconCache::~CaIconCache");
hgs
parents:
diff changeset
    76
}
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
/*!
hgs
parents:
diff changeset
    79
Constructor
hgs
parents:
diff changeset
    80
 */
hgs
parents:
diff changeset
    81
CaIconCache::CaIconCache(QObject *parent): QObject(parent),
hgs
parents:
diff changeset
    82
    mCache(), mService(CaService::instance()), mNotifier(0)
hgs
parents:
diff changeset
    83
{
hgs
parents:
diff changeset
    84
    mCache.setMaxCost(maxCost);
hgs
parents:
diff changeset
    85
    CaNotifierFilter filter;
hgs
parents:
diff changeset
    86
    mNotifier = mService->createNotifier(filter);
hgs
parents:
diff changeset
    87
    connect(mNotifier, SIGNAL(entryChanged(const CaEntry &,ChangeType)),
hgs
parents:
diff changeset
    88
            this, SLOT(remove(const CaEntry &,ChangeType)));
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
}
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
/*!
hgs
parents:
diff changeset
    93
 Checks if icon is already cached
hgs
parents:
diff changeset
    94
 \param entry an entry
hgs
parents:
diff changeset
    95
 \param size size of an icon
hgs
parents:
diff changeset
    96
 \retval true if icon exist in cache
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
 */
hgs
parents:
diff changeset
    99
bool CaIconCache::exist(const CaEntry &entry, const QSize &size)
hgs
parents:
diff changeset
   100
{
hgs
parents:
diff changeset
   101
    CACLIENTTEST_FUNC_ENTRY("CaIconCache::exist");
hgs
parents:
diff changeset
   102
    bool result(false);
hgs
parents:
diff changeset
   103
    result = mCache.contains(key(entry,size));
hgs
parents:
diff changeset
   104
    CACLIENTTEST_FUNC_EXIT("CaIconCache::exist");
hgs
parents:
diff changeset
   105
    return result;
hgs
parents:
diff changeset
   106
}
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
/*!
hgs
parents:
diff changeset
   109
 Returns an icon from a cache
hgs
parents:
diff changeset
   110
 \param entry an entry
hgs
parents:
diff changeset
   111
 \param size size of an icon
hgs
parents:
diff changeset
   112
 \retval icon
hgs
parents:
diff changeset
   113
hgs
parents:
diff changeset
   114
 */
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
HbIcon CaIconCache::icon(const CaEntry &entry, const QSize &size)
hgs
parents:
diff changeset
   117
{
hgs
parents:
diff changeset
   118
    CACLIENTTEST_FUNC_ENTRY("CaIconCache::icon");
hgs
parents:
diff changeset
   119
    HbIcon icon;
hgs
parents:
diff changeset
   120
    icon = *mCache.object(key(entry,size));
hgs
parents:
diff changeset
   121
    CACLIENTTEST_FUNC_EXIT("CaIconCache::icon");
hgs
parents:
diff changeset
   122
    return icon;
hgs
parents:
diff changeset
   123
}
hgs
parents:
diff changeset
   124
hgs
parents:
diff changeset
   125
/*!
hgs
parents:
diff changeset
   126
 Insert an icon to a cache
hgs
parents:
diff changeset
   127
 \param entry an entry
hgs
parents:
diff changeset
   128
 \param size size of an icon
hgs
parents:
diff changeset
   129
 \param icon icon to be cached
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
 */
hgs
parents:
diff changeset
   132
void CaIconCache::insert(const CaEntry &entry, const QSize &size,
hgs
parents:
diff changeset
   133
                         const HbIcon &icon)
hgs
parents:
diff changeset
   134
{
hgs
parents:
diff changeset
   135
    CACLIENTTEST_FUNC_ENTRY("CaIconCache::insert");
hgs
parents:
diff changeset
   136
    mCache.insert(key(entry,size),new HbIcon(icon));
hgs
parents:
diff changeset
   137
    CACLIENTTEST_FUNC_EXIT("CaIconCache::insert");
hgs
parents:
diff changeset
   138
}
hgs
parents:
diff changeset
   139
hgs
parents:
diff changeset
   140
/*!
hgs
parents:
diff changeset
   141
 Removes icon from a cache
hgs
parents:
diff changeset
   142
 \param entry an entry
hgs
parents:
diff changeset
   143
 \param changeTypa indicates if entry was updated, removed or added
hgs
parents:
diff changeset
   144
 */
hgs
parents:
diff changeset
   145
void CaIconCache::remove(const CaEntry &entry, ChangeType changeType)
hgs
parents:
diff changeset
   146
{
hgs
parents:
diff changeset
   147
    CACLIENTTEST_FUNC_ENTRY("CaIconCache::remove");
hgs
parents:
diff changeset
   148
    if (changeType != AddChangeType) {
hgs
parents:
diff changeset
   149
        QString entryKey = key(entry);
hgs
parents:
diff changeset
   150
        entryKey.append(separator);
hgs
parents:
diff changeset
   151
        QList<QString> keys = mCache.keys();
hgs
parents:
diff changeset
   152
        foreach(QString cacheKey,keys) {
hgs
parents:
diff changeset
   153
            if (cacheKey.contains(entryKey)) {
hgs
parents:
diff changeset
   154
                mCache.remove(cacheKey);
hgs
parents:
diff changeset
   155
            }
hgs
parents:
diff changeset
   156
        }
hgs
parents:
diff changeset
   157
    }
hgs
parents:
diff changeset
   158
    CACLIENTTEST_FUNC_EXIT("CaIconCache::remove");
hgs
parents:
diff changeset
   159
}
hgs
parents:
diff changeset
   160
hgs
parents:
diff changeset
   161
/*!
hgs
parents:
diff changeset
   162
 Generates a key
hgs
parents:
diff changeset
   163
 \param entry an entry
hgs
parents:
diff changeset
   164
 \return key
hgs
parents:
diff changeset
   165
 */
hgs
parents:
diff changeset
   166
hgs
parents:
diff changeset
   167
QString CaIconCache::key(const CaEntry &entry, const QSize &size)
hgs
parents:
diff changeset
   168
{
hgs
parents:
diff changeset
   169
    QString key;
hgs
parents:
diff changeset
   170
    if (!entry.iconDescription().filename().isEmpty()) {
hgs
parents:
diff changeset
   171
        key.append(entry.iconDescription().filename());
hgs
parents:
diff changeset
   172
    } else {
hgs
parents:
diff changeset
   173
        key.append(separator);
hgs
parents:
diff changeset
   174
        key.append(entry.id());
hgs
parents:
diff changeset
   175
    }
hgs
parents:
diff changeset
   176
    if (size.isValid()) {
hgs
parents:
diff changeset
   177
        key.append(separator);
hgs
parents:
diff changeset
   178
        key.append(size.height());
hgs
parents:
diff changeset
   179
        key.append(separator);
hgs
parents:
diff changeset
   180
        key.append(size.width());
hgs
parents:
diff changeset
   181
    }
hgs
parents:
diff changeset
   182
    return key;
hgs
parents:
diff changeset
   183
}