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

1 files changed, 247 insertions, 11 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"