Add an extension to QPixmapCache to get rid of strings.

This commit add a new API to add/find/remove pixmaps into QPixmapCache.
This new extension is based on a key that the cache give you during
the insertion. This key is internally a int which makes all operations
in the cache much more faster that the string approach.
Auto-tests has been extended as well and a benchmark has been added to
compare both approach. I also depecrate the find method for the
string API to have a method pointer based and not reference based like
the Qt policy says.

Reviewed-by: bnilsen
Reviewed-by: andreas
Followed-deeply-by: trond

4 files changed, 479 insertions, 12 deletions

diff --git a/tests/auto/qpixmapcache/tst_qpixmapcache.cpp b/tests/auto/qpixmapcache/tst_qpixmapcache.cpp
index 1f515ff..405ac34 100644
--- a/tests/auto/qpixmapcache/tst_qpixmapcache.cpp
+++ b/tests/auto/qpixmapcache/tst_qpixmapcache.cpp
@@ -44,9 +44,7 @@
 
 
 #include <qpixmapcache.h>
-
-
-
+#include "../../../src/gui/image/qpixmapcache_p.h"
 
 
 //TESTED_CLASS=
@@ -68,10 +66,21 @@ private slots:
     void setCacheLimit();
     void find();
     void insert();
+    void replace();
     void remove();
     void clear();
+    void pixmapKey();
 };
 
+static QPixmapCache::KeyData* getPrivate(QPixmapCache::Key &key)
+{
+    return (*reinterpret_cast<QPixmapCache::KeyData**>(&key));
+}
+
+static QPixmapCache::KeyData** getPrivateRef(QPixmapCache::Key &key)
+{
+    return (reinterpret_cast<QPixmapCache::KeyData**>(&key));
+}
 
 static int originalCacheLimit;
 
@@ -119,6 +128,72 @@ void tst_QPixmapCache::setCacheLimit()
     QVERIFY(QPixmapCache::find("P1") != 0);
 
     delete p1;
+
+    //The int part of the API
+    p1 = new QPixmap(2, 3);
+    QPixmapCache::Key key = QPixmapCache::insert(*p1);
+    QVERIFY(QPixmapCache::find(key, p1) != 0);
+    delete p1;
+
+    QPixmapCache::setCacheLimit(0);
+    QVERIFY(QPixmapCache::find(key, p1) == 0);
+
+    p1 = new QPixmap(2, 3);
+    QPixmapCache::setCacheLimit(1000);
+    QPixmapCache::replace(key, *p1);
+    QVERIFY(QPixmapCache::find(key, p1) == 0);
+
+    delete p1;
+
+    //Let check if keys are released when the pixmap cache is
+    //full or has been flushed.
+    QPixmapCache::clear();
+    p1 = new QPixmap(2, 3);
+    key = QPixmapCache::insert(*p1);
+    QVERIFY(QPixmapCache::find(key, p1) != 0);
+    QPixmapCache::setCacheLimit(0);
+    QVERIFY(QPixmapCache::find(key, p1) == 0);
+    QPixmapCache::setCacheLimit(1000);
+    key = QPixmapCache::insert(*p1);
+    QCOMPARE(getPrivate(key)->isValid, true);
+    QCOMPARE(getPrivate(key)->key, 1);
+
+    delete p1;
+
+    //Let check if removing old entries doesn't let you get
+    // wrong pixmaps
+    QPixmapCache::clear();
+    QPixmap p2;
+    p1 = new QPixmap(2, 3);
+    key = QPixmapCache::insert(*p1);
+    QVERIFY(QPixmapCache::find(key, &p2) != 0);
+    //we flush the cache
+    QPixmapCache::setCacheLimit(0);
+    QPixmapCache::setCacheLimit(1000);
+    QPixmapCache::Key key2 = QPixmapCache::insert(*p1);
+    QCOMPARE(getPrivate(key2)->key, 2);
+    QVERIFY(QPixmapCache::find(key, &p2) == 0);
+    QVERIFY(QPixmapCache::find(key2, &p2) != 0);
+    QCOMPARE(p2, *p1);
+
+    delete p1;
+
+    //Here we simulate the flushing when the app is idle
+    /*QPixmapCache::clear();
+    QPixmapCache::setCacheLimit(originalCacheLimit);
+    p1 = new QPixmap(300, 300);
+    key = QPixmapCache::insert(*p1);
+    QCOMPARE(getPrivate(key)->key, 1);
+    key2 = QPixmapCache::insert(*p1);
+    key2 = QPixmapCache::insert(*p1);
+    QPixmapCache::Key key3 = QPixmapCache::insert(*p1);
+    QTest::qWait(32000);
+    key2 = QPixmapCache::insert(*p1);
+    QCOMPARE(getPrivate(key2)->key, 1);
+    //This old key is not valid anymore after the flush
+    QCOMPARE(getPrivate(key)->isValid, false);
+    QVERIFY(QPixmapCache::find(key, &p2) == 0);
+    delete p1;*/
 }
 
 void tst_QPixmapCache::find()
@@ -137,6 +212,28 @@ void tst_QPixmapCache::find()
     QPixmap *p3 = QPixmapCache::find("P1");
     QVERIFY(p3);
     QCOMPARE(p1, *p3);
+
+    //The int part of the API
+    QPixmapCache::Key key = QPixmapCache::insert(p1);
+
+    QVERIFY(QPixmapCache::find(key, &p2));
+    QCOMPARE(p2.width(), 10);
+    QCOMPARE(p2.height(), 10);
+    QCOMPARE(p1, p2);
+
+    QPixmapCache::clear();
+
+    key = QPixmapCache::insert(p1);
+
+    //The int part of the API
+    // make sure it doesn't explode
+    QList<QPixmapCache::Key> keys;
+    for (int i = 0; i < 40000; ++i)
+        QPixmapCache::insert(p1);
+
+    //at that time the first key has been erase because no more place in the cache
+    QVERIFY(QPixmapCache::find(key, &p1) == 0);
+    QCOMPARE(getPrivate(key)->isValid, false);
 }
 
 void tst_QPixmapCache::insert()
@@ -152,18 +249,22 @@ void tst_QPixmapCache::insert()
         QPixmapCache::insert("0", p1);
 
     // ditto
-    for (int j = 0; j < 20000; ++j)
+    for (int j = 0; j < 40000; ++j)
         QPixmapCache::insert(QString::number(j), p1);
 
     int num = 0;
-    for (int k = 0; k < 20000; ++k) {
+    for (int k = 0; k < 40000; ++k) {
         if (QPixmapCache::find(QString::number(k)))
             ++num;
     }
 
+    if (QPixmapCache::find("0"))
+        ++num;
+
     int estimatedNum = (1024 * QPixmapCache::cacheLimit())
                        / ((p1.width() * p1.height() * p1.depth()) / 8);
-    QVERIFY(estimatedNum - 1 <= num <= estimatedNum + 1);
+
+    QVERIFY(num <= estimatedNum);
     QPixmap p3;
     QPixmapCache::insert("null", p3);
 
@@ -176,6 +277,50 @@ void tst_QPixmapCache::insert()
     QPixmapCache::insert("custom", c2);
     //We have deleted the old pixmap in the cache for the same key
     QVERIFY(c1.isDetached());
+
+    //The int part of the API
+    // make sure it doesn't explode
+    QList<QPixmapCache::Key> keys;
+    for (int i = 0; i < 40000; ++i)
+        keys.append(QPixmapCache::insert(p1));
+
+    num = 0;
+    for (int k = 0; k < 40000; ++k) {
+        if (QPixmapCache::find(keys.at(k), &p2))
+            ++num;
+    }
+
+    estimatedNum = (1024 * QPixmapCache::cacheLimit())
+                       / ((p1.width() * p1.height() * p1.depth()) / 8);
+    QVERIFY(num <= estimatedNum);
+    QPixmapCache::insert(p3);
+
+}
+
+void tst_QPixmapCache::replace()
+{
+    //The int part of the API
+    QPixmap p1(10, 10);
+    p1.fill(Qt::red);
+
+    QPixmap p2(10, 10);
+    p2.fill(Qt::yellow);
+
+    QPixmapCache::Key key = QPixmapCache::insert(p1);
+
+    QPixmap p3;
+    QVERIFY(QPixmapCache::find(key, &p3) == 1);
+
+    QPixmapCache::replace(key,p2);
+
+    QVERIFY(QPixmapCache::find(key, &p3) == 1);
+
+    QCOMPARE(p3.width(), 10);
+    QCOMPARE(p3.height(), 10);
+    QCOMPARE(p3, p2);
+
+    //Broken keys
+    QCOMPARE(QPixmapCache::replace(QPixmapCache::Key(), p2), false);
 }
 
 void tst_QPixmapCache::remove()
@@ -198,6 +343,40 @@ void tst_QPixmapCache::remove()
 
     QPixmapCache::remove("green");
     QVERIFY(QPixmapCache::find("green") == 0);
+
+    //The int part of the API
+    QPixmapCache::clear();
+    p1.fill(Qt::red);
+    QPixmapCache::Key key = QPixmapCache::insert(p1);
+    p1.fill(Qt::yellow);
+
+    QVERIFY(QPixmapCache::find(key, &p2));
+    QVERIFY(p1.toImage() != p2.toImage());
+    QVERIFY(p1.toImage() == p1.toImage()); // sanity check
+
+    QPixmapCache::remove(key);
+    QVERIFY(QPixmapCache::find(key, &p1) == 0);
+
+    //Broken key
+    QPixmapCache::remove(QPixmapCache::Key());
+    QVERIFY(QPixmapCache::find(QPixmapCache::Key(), &p1) == 0);
+
+    //Test if keys are release
+    QPixmapCache::clear();
+    key = QPixmapCache::insert(p1);
+    QCOMPARE(getPrivate(key)->key, 1);
+    QPixmapCache::remove(key);
+    key = QPixmapCache::insert(p1);
+    QCOMPARE(getPrivate(key)->key, 1);
+
+    //We mix both part of the API
+    QPixmapCache::clear();
+    p1.fill(Qt::red);
+    QPixmapCache::insert("red", p1);
+    key = QPixmapCache::insert(p1);
+    QPixmapCache::remove(key);
+    QVERIFY(QPixmapCache::find(key, &p1) == 0);
+    QVERIFY(QPixmapCache::find("red") != 0);
 }
 
 void tst_QPixmapCache::clear()
@@ -205,12 +384,11 @@ void tst_QPixmapCache::clear()
     QPixmap p1(10, 10);
     p1.fill(Qt::red);
 
-    for (int i = 0; i < 20000; ++i) {
+    for (int i = 0; i < 20000; ++i)
         QVERIFY(QPixmapCache::find("x" + QString::number(i)) == 0);
-    }
-    for (int j = 0; j < 20000; ++j) {
+
+    for (int j = 0; j < 20000; ++j)
         QPixmapCache::insert(QString::number(j), p1);
-    }
 
     int num = 0;
     for (int k = 0; k < 20000; ++k) {
@@ -221,10 +399,68 @@ void tst_QPixmapCache::clear()
 
     QPixmapCache::clear();
 
-    for (int k = 0; k < 20000; ++k) {
+    for (int k = 0; k < 20000; ++k)
         QVERIFY(QPixmapCache::find(QString::number(k)) == 0);
+
+    //The int part of the API
+    QPixmap p2(10, 10);
+    p2.fill(Qt::red);
+
+    QList<QPixmapCache::Key> keys;
+    for (int k = 0; k < 20000; ++k)
+        keys.append(QPixmapCache::insert(p2));
+
+    QPixmapCache::clear();
+
+    for (int k = 0; k < 20000; ++k) {
+        QVERIFY(QPixmapCache::find(keys.at(k), &p1) == 0);
+        QCOMPARE(getPrivate(keys[k])->isValid, false);
     }
 }
 
+void tst_QPixmapCache::pixmapKey()
+{
+    QPixmapCache::Key key;
+    //Default constructed keys have no d pointer unless
+    //we use them
+    QVERIFY(!getPrivate(key));
+    //Let's put a d pointer
+    QPixmapCache::KeyData** keyd = getPrivateRef(key);
+    *keyd = new QPixmapCache::KeyData;
+    QCOMPARE(getPrivate(key)->ref, 1);
+    QPixmapCache::Key key2;
+    //Let's put a d pointer
+    QPixmapCache::KeyData** key2d = getPrivateRef(key2);
+    *key2d = new QPixmapCache::KeyData;
+    QCOMPARE(getPrivate(key2)->ref, 1);
+    key = key2;
+    QCOMPARE(getPrivate(key2)->ref, 2);
+    QCOMPARE(getPrivate(key)->ref, 2);
+    QPixmapCache::Key key3;
+    //Let's put a d pointer
+    QPixmapCache::KeyData** key3d = getPrivateRef(key3);
+    *key3d = new QPixmapCache::KeyData;
+    QPixmapCache::Key key4 = key3;
+    QCOMPARE(getPrivate(key3)->ref, 2);
+    QCOMPARE(getPrivate(key4)->ref, 2);
+    key4 = key;
+    QCOMPARE(getPrivate(key4)->ref, 3);
+    QCOMPARE(getPrivate(key3)->ref, 1);
+    QPixmapCache::Key key5(key3);
+    QCOMPARE(getPrivate(key3)->ref, 2);
+    QCOMPARE(getPrivate(key5)->ref, 2);
+
+    //let test default constructed keys
+    QPixmapCache::Key key6;
+    QVERIFY(!getPrivate(key6));
+    QPixmapCache::Key key7;
+    QVERIFY(!getPrivate(key7));
+    key6 = key7;
+    QVERIFY(!getPrivate(key6));
+    QVERIFY(!getPrivate(key7));
+    QPixmapCache::Key key8(key7);
+    QVERIFY(!getPrivate(key8));
+}
+
 QTEST_MAIN(tst_QPixmapCache)
 #include "tst_qpixmapcache.moc"
diff --git a/tests/benchmarks/qgraphicsview/tst_qgraphicsview.cpp b/tests/benchmarks/qgraphicsview/tst_qgraphicsview.cpp
index a293de4..a06e033 100644
--- a/tests/benchmarks/qgraphicsview/tst_qgraphicsview.cpp
+++ b/tests/benchmarks/qgraphicsview/tst_qgraphicsview.cpp
@@ -705,7 +705,6 @@ public:
         QGraphicsPixmapItem::paint(painter,option,widget);
         //We just want to wait, and we don't want to process the event loop with qWait
         QTest::qSleep(3);
-
     }
 protected:
     void advance(int i)
diff --git a/tests/benchmarks/qpixmapcache/qpixmapcache.pro b/tests/benchmarks/qpixmapcache/qpixmapcache.pro
new file mode 100644
index 0000000..e0d7543
--- /dev/null
+++ b/tests/benchmarks/qpixmapcache/qpixmapcache.pro
@@ -0,0 +1,6 @@
+load(qttest_p4)
+TEMPLATE = app
+TARGET = tst_qpixmapcache
+TEMPLATE = app
+# Input
+SOURCES += tst_qpixmapcache.cpp
diff --git a/tests/benchmarks/qpixmapcache/tst_qpixmapcache.cpp b/tests/benchmarks/qpixmapcache/tst_qpixmapcache.cpp
new file mode 100644
index 0000000..f3c1134
--- /dev/null
+++ b/tests/benchmarks/qpixmapcache/tst_qpixmapcache.cpp
@@ -0,0 +1,226 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Qt Software Information (qt-info@nokia.com)
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** No Commercial Usage
+** This file contains pre-release code and may not be distributed.
+** You may use this file in accordance with the terms and conditions
+** contained in the either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain
+** additional rights. These rights are described in the Nokia Qt LGPL
+** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
+** package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at qt-sales@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <qtest.h>
+#include <QPixmapCache>
+//TESTED_FILES=
+
+class tst_QPixmapCache : public QObject
+{
+    Q_OBJECT
+
+public:
+    tst_QPixmapCache();
+    virtual ~tst_QPixmapCache();
+
+public slots:
+    void init();
+    void cleanup();
+
+private slots:
+    void insert_data();
+    void insert();
+    void find_data();
+    void find();
+    void styleUseCaseComplexKey();
+    void styleUseCaseComplexKey_data();
+};
+
+tst_QPixmapCache::tst_QPixmapCache()
+{
+}
+
+tst_QPixmapCache::~tst_QPixmapCache()
+{
+}
+
+void tst_QPixmapCache::init()
+{
+}
+
+void tst_QPixmapCache::cleanup()
+{
+}
+
+void tst_QPixmapCache::insert_data()
+{
+    QTest::addColumn<bool>("cacheType");
+    QTest::newRow("QPixmapCache") << true;
+    QTest::newRow("QPixmapCache (int API)") << false;
+}
+
+QList<QPixmapCache::Key> keys;
+
+void tst_QPixmapCache::insert()
+{
+    QFETCH(bool, cacheType);
+    QPixmap p;
+    if (cacheType) {
+        QBENCHMARK {
+            for (int i = 0 ; i <= 10000 ; i++)
+            {
+                QString tmp;
+                tmp.sprintf("my-key-%d", i);
+                QPixmapCache::insert(tmp, p);
+            }
+        }
+    } else {
+        QBENCHMARK {
+            for (int i = 0 ; i <= 10000 ; i++)
+                keys.append(QPixmapCache::insert(p));
+        }
+    }
+}
+
+void tst_QPixmapCache::find_data()
+{
+    QTest::addColumn<bool>("cacheType");
+    QTest::newRow("QPixmapCache") << true;
+    QTest::newRow("QPixmapCache (int API)") << false;
+}
+
+void tst_QPixmapCache::find()
+{
+    QFETCH(bool, cacheType);
+    QPixmap p;
+    if (cacheType) {
+        QBENCHMARK {
+            QString tmp;
+            for (int i = 0 ; i <= 10000 ; i++)
+            {
+                tmp.sprintf("my-key-%d", i);
+                QPixmapCache::find(tmp, p);
+            }
+        }
+    } else {
+        QBENCHMARK {
+            for (int i = 0 ; i <= 10000 ; i++)
+                QPixmapCache::find(keys.at(i), &p);
+        }
+    }
+
+}
+
+void tst_QPixmapCache::styleUseCaseComplexKey_data()
+{
+    QTest::addColumn<bool>("cacheType");
+    QTest::newRow("QPixmapCache") << true;
+    QTest::newRow("QPixmapCache (int API)") << false;
+}
+
+struct styleStruct {
+    QString key;
+    uint state;
+    uint direction;
+    uint complex;
+    uint palette;
+    int width;
+    int height;
+    bool operator==(const styleStruct &str) const
+    {
+        return str.key == key && str.state == state && str.direction == direction
+                && str.complex == complex && str.palette == palette && str.width == width
+                && str.height == height;
+    }
+};
+
+uint qHash(const styleStruct &myStruct)
+{
+    return qHash(myStruct.state);
+}
+
+void tst_QPixmapCache::styleUseCaseComplexKey()
+{
+    QFETCH(bool, cacheType);
+    QPixmap p;
+    if (cacheType) {
+        QBENCHMARK {
+            for (int i = 0 ; i <= 10000 ; i++)
+            {
+                QString tmp;
+                tmp.sprintf("%s-%d-%d-%d-%d-%d-%d", QString("my-progressbar-%1").arg(i).toLatin1().constData(), 5, 3, 0, 358, 100, 200);
+                QPixmapCache::insert(tmp, p);
+            }
+
+            for (int i = 0 ; i <= 10000 ; i++)
+            {
+                QString tmp;
+                tmp.sprintf("%s-%d-%d-%d-%d-%d-%d", QString("my-progressbar-%1").arg(i).toLatin1().constData(), 5, 3, 0, 358, 100, 200);
+                QPixmapCache::find(tmp, p);
+            }
+        }
+    } else {
+        QHash<styleStruct, QPixmapCache::Key> hash;
+        QBENCHMARK {
+            for (int i = 0 ; i <= 10000 ; i++)
+            {
+                styleStruct myStruct;
+                myStruct.key = QString("my-progressbar-%1").arg(i);
+                myStruct.key = 5;
+                myStruct.key = 4;
+                myStruct.key = 3;
+                myStruct.palette = 358;
+                myStruct.width = 100;
+                myStruct.key = 200;
+                QPixmapCache::Key key = QPixmapCache::insert(p);
+                hash.insert(myStruct, key);
+            }
+            for (int i = 0 ; i <= 10000 ; i++)
+            {
+                styleStruct myStruct;
+                myStruct.key = QString("my-progressbar-%1").arg(i);
+                myStruct.key = 5;
+                myStruct.key = 4;
+                myStruct.key = 3;
+                myStruct.palette = 358;
+                myStruct.width = 100;
+                myStruct.key = 200;
+                QPixmapCache::Key key = hash.value(myStruct);
+                QPixmapCache::find(key, &p);
+            }
+        }
+    }
+
+}
+
+
+QTEST_MAIN(tst_QPixmapCache)
+#include "tst_qpixmapcache.moc"