Merge lp:~uriboni/unity-2d/unity-2d-exclude-filter-proxy-model into lp:unity-2d

[Ugo Riboni]

Add a new proxy model class that excludes items matching the regexp instead of including them.

Add a new proxy model class that has all the features of QSortFilterProxyModelQML but excludes items matching the regexp instead of including them.

This is useful because generally speaking it's pretty hard to use a regular expression to exclude something. That's for example why tools like grep have the -v option to reverse the normal matching behavior.

This class is currently used only by another project but I thought having it in unity-2d would make things easier for everyone when they face a similar task.

[Alberto Mardegan (mardy)]

The code looks fine, but I'd rather add a boolean property (invertMatch) to the existing model than add a subclass.
Hopefully most of the code you wrote for the tests can be reused.

review: Needs Fixing

[lp:~uriboni/unity-2d/unity-2d-exclude-filter-proxy-model]

688. By Ugo Riboni on 2011-09-07

Simplify the code by replacing ExcludeSortFilterProxyModel with QSortFilterProxyModel::invertMatch()

[Ugo Riboni (uriboni)]

I updated the MR following your suggestion.

[Alberto Mardegan (mardy)]

Great Ugo! Only one nitpick on the format of the comment in line 40: it starts with "//", and finishes with "*/".

[lp:~uriboni/unity-2d/unity-2d-exclude-filter-proxy-model]

689. By Ugo Riboni on 2011-09-07

FIx typo in a comment

[Alberto Mardegan (mardy)]

Thanks a lot! :-)

review: Approve

=== modified file 'libunity-2d-private/src/qsortfilterproxymodelqml.cpp'
--- libunity-2d-private/src/qsortfilterproxymodelqml.cpp	2011-07-29 13:49:34 +0000
+++ libunity-2d-private/src/qsortfilterproxymodelqml.cpp	2011-09-07 13:37:35 +0000
@@ -17,8 +17,10 @@
 #include "qsortfilterproxymodelqml.h"
 #include <debug_p.h>
 
-QSortFilterProxyModelQML::QSortFilterProxyModelQML(QObject *parent) :
-    QSortFilterProxyModel(parent), m_limit(-1)
+QSortFilterProxyModelQML::QSortFilterProxyModelQML(QObject *parent)
+    : QSortFilterProxyModel(parent)
+    , m_limit(-1)
+    , m_invertMatch(false)
 {
     connect(this, SIGNAL(modelReset()), SIGNAL(countChanged()));
     connect(this, SIGNAL(rowsInserted(QModelIndex,int,int)), SIGNAL(countChanged()));
@@ -189,4 +191,32 @@
     }
 }
 
+bool
+QSortFilterProxyModelQML::invertMatch() const
+{
+    return m_invertMatch;
+}
+
+void
+QSortFilterProxyModelQML::setInvertMatch(bool invertMatch)
+{
+    if (invertMatch != m_invertMatch) {
+        m_invertMatch = invertMatch;
+        Q_EMIT invertMatchChanged(invertMatch);
+    }
+}
+
+bool
+QSortFilterProxyModelQML::filterAcceptsRow(int sourceRow,
+                                           const QModelIndex &sourceParent) const
+{
+    // If there's no regexp set, always accept all rows indepenently of the invertMatch setting
+    if (filterRegExp().isEmpty()) {
+        return true;
+    }
+
+    bool result = QSortFilterProxyModel::filterAcceptsRow(sourceRow, sourceParent);
+    return (m_invertMatch) ? !result : result;
+}
+
 #include "qsortfilterproxymodelqml.moc"

=== modified file 'libunity-2d-private/src/qsortfilterproxymodelqml.h'
--- libunity-2d-private/src/qsortfilterproxymodelqml.h	2011-07-29 13:49:34 +0000
+++ libunity-2d-private/src/qsortfilterproxymodelqml.h	2011-09-07 13:37:35 +0000
@@ -27,6 +27,7 @@
     Q_PROPERTY(int limit READ limit WRITE setLimit NOTIFY limitChanged)
     Q_PROPERTY(int totalCount READ totalCount NOTIFY totalCountChanged)
     Q_PROPERTY(int count READ count NOTIFY countChanged)
+    Q_PROPERTY(bool invertMatch READ invertMatch WRITE setInvertMatch NOTIFY invertMatchChanged)
 
 public:
     explicit QSortFilterProxyModelQML(QObject *parent = 0);
@@ -34,15 +35,18 @@
     Q_INVOKABLE QVariantMap get(int row);
     Q_INVOKABLE int count();
     int rowCount(const QModelIndex &parent = QModelIndex()) const;
+    virtual bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const;
 
     /* getters */
     QObject* sourceModelQObject() const;
     int limit() const;
     int totalCount() const;
+    bool invertMatch() const;
 
     /* setters */
     void setSourceModelQObject(QObject *model);
     void setLimit(int limit);
+    void setInvertMatch(bool invertMatch);
 
     Q_SLOT void setRoleNames(const QHash<int,QByteArray> &roleNames);
 
@@ -50,10 +54,12 @@
     void limitChanged();
     void totalCountChanged();
     void countChanged();
+    void invertMatchChanged(bool);
     void roleNamesChanged(const QHash<int,QByteArray> &);
 
 private:
     int m_limit;
+    bool m_invertMatch;
 };
 
 #endif // QSORTFILTERPROXYMODELQML_H

=== modified file 'libunity-2d-private/tests/qsortfilterproxymodeltest.cpp'
--- libunity-2d-private/tests/qsortfilterproxymodeltest.cpp	2011-07-26 16:50:34 +0000
+++ libunity-2d-private/tests/qsortfilterproxymodeltest.cpp	2011-09-07 13:37:35 +0000
@@ -67,6 +67,13 @@
         return true;
     }
 
+    bool appendRows(QStringList &rows, const QModelIndex &parent=QModelIndex()) {
+        beginInsertRows(parent, rowCount(), rowCount() + rows.count() - 1);
+        m_list.append(rows);
+        endInsertRows();
+        return true;
+    }
+
     bool removeRows(int row, int count, const QModelIndex &parent=QModelIndex()) {
         beginRemoveRows(parent, row, row+count-1);
         for (int i=0; i<count; i++) {
@@ -376,6 +383,48 @@
         //QCOMPARE(spyOnRowsInserted.count(), 0);
         //QCOMPARE(spyOnCountChanged.count(), 0);
     }
+
+    void testInvertMatch() {
+        QSortFilterProxyModelQML proxy;
+        MockListModel model;
+
+        proxy.setSourceModelQObject(&model);
+        proxy.setDynamicSortFilter(true);
+
+        QStringList rows;
+        rows << "a/foobar/b" << "foobar" << "foobarbaz" << "hello";
+        model.appendRows(rows);
+
+        // Check that without a filterRegExp all rows are accepted regardless of invertMatch
+        QCOMPARE(model.rowCount(), rows.count());
+        QCOMPARE(proxy.rowCount(), rows.count());
+        for (int i=0; i<rows.count(); i++) {
+            QCOMPARE(proxy.index(i, 0).data().toString(), model.index(i, 0).data().toString());
+        }
+        proxy.setInvertMatch(true);
+        QCOMPARE(model.rowCount(), rows.count());
+        QCOMPARE(proxy.rowCount(), rows.count());
+        for (int i=0; i<rows.count(); i++) {
+            QCOMPARE(proxy.index(i, 0).data().toString(), model.index(i, 0).data().toString());
+        }
+
+
+        // Test non-anchored regexp with invertMatch active
+        proxy.setFilterRegExp("foobar");
+        QCOMPARE(proxy.rowCount(), 1);
+        QCOMPARE(proxy.index(0, 0).data().toString(), rows.last());
+
+        // Test anchored regexp with invertMatch active
+        proxy.setFilterRegExp("^foobar$");
+        QCOMPARE(proxy.rowCount(), 3);
+        QCOMPARE(proxy.index(0, 0).data().toString(), rows.at(0));
+        QCOMPARE(proxy.index(1, 0).data().toString(), rows.at(2));
+        QCOMPARE(proxy.index(2, 0).data().toString(), rows.at(3));
+
+        // Test regexp with OR and invertMatch active
+        proxy.setFilterRegExp("foobar|hello");
+        QCOMPARE(proxy.count(), 0);
+    }
 };
 
 QTEST_MAIN(QSortFilterProxyModelTest)