Merged very early alpha-version of Dolphin 2.0

Dolphin 2.0 will get a new view-engine with the
following improvements:
- Better performance
- Animated transitions
- No clipped filenames due to dynamic item-sizes
- Grouping support for all view-modes
- Non-rectangular selection areas
- Simplified code for better maintenance

More details will be provided in a blog-entry during
the next days.

Please note that the code is in a very
early alpha-stage and although the most tricky parts
have been implemented already very basic things like
drag and drop or selections have not been pushed yet.
Those things are rather trivial to implement but this
still will take some time.

1 files changed, 192 insertions, 0 deletions

diff --git a/src/kitemviews/kfileitemmodel.h b/src/kitemviews/kfileitemmodel.h
new file mode 100644
index 000000000..e6c89d744
--- /dev/null
+++ b/src/kitemviews/kfileitemmodel.h
@@ -0,0 +1,192 @@
+/***************************************************************************
+ *   Copyright (C) 2011 by Peter Penz <[email protected]>             *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
+ ***************************************************************************/
+
+#ifndef KFILEITEMMODEL_H
+#define KFILEITEMMODEL_H
+
+#include <libdolphin_export.h>
+#include <KFileItemList>
+#include <KUrl>
+#include <kitemviews/kitemmodelbase.h>
+
+#include <QHash>
+
+class KDirLister;
+class QTimer;
+
+/**
+ * @brief KItemModelBase implementation for KFileItems.
+ *
+ * KFileItemModel is connected with one KDirLister. Each time the KDirLister
+ * emits new items, removes items or changes items the model gets synchronized.
+ *
+ * KFileItemModel supports sorting and grouping of items. Additional roles that
+ * are not part of KFileItem can be added with KFileItemModel::setData().
+ *
+ * Also the recursive expansion of sub-directories is supported by
+ * KFileItemModel::setExpanded().
+ */
+class LIBDOLPHINPRIVATE_EXPORT KFileItemModel : public KItemModelBase
+{
+    Q_OBJECT
+
+public:
+    explicit KFileItemModel(KDirLister* dirLister, QObject* parent = 0);
+    virtual ~KFileItemModel();
+
+    virtual int count() const;
+    virtual QHash<QByteArray, QVariant> data(int index) const;
+    virtual bool setData(int index, const QHash<QByteArray, QVariant> &values);
+
+    /**
+     * @return True
+     * @reimp
+     */
+    virtual bool supportsGrouping() const;
+
+    /**
+     * @return True
+     * @reimp
+     */
+    virtual bool supportsSorting() const;
+
+    /**
+     * @return The file-item for the index \a index. If the index is in a valid
+     *         range it is assured that the file-item is not null. The runtime
+     *         complexity of this call is O(1).
+     */
+    KFileItem fileItem(int index) const;
+
+    /**
+     * @return The index for the file-item \a item. -1 is returned if no file-item
+     *         is found or if the file-item is null. The runtime
+     *         complexity of this call is O(1).
+     */
+    int index(const KFileItem& item) const;
+
+    /**
+     * Clears all items of the model.
+     */
+    void clear();
+
+    // TODO: "name" + "isDir" is default in ctor
+    void setRoles(const QSet<QByteArray>& roles);
+    QSet<QByteArray> roles() const;
+
+    bool setExpanded(int index, bool expanded);
+    bool isExpanded(int index) const;
+    bool isExpandable(int index) const;
+
+protected:
+    virtual void onGroupRoleChanged(const QByteArray& current, const QByteArray& previous);
+    virtual void onSortRoleChanged(const QByteArray& current, const QByteArray& previous);
+
+private slots:
+    void slotCompleted();
+    void slotCanceled();
+    void slotNewItems(const KFileItemList& items);
+    void slotItemsDeleted(const KFileItemList& items);
+    void slotClear();
+    void slotClear(const KUrl& url);
+
+    void dispatchPendingItems();
+
+private:
+    void insertItems(const KFileItemList& items);
+    void removeItems(const KFileItemList& items);
+
+    void removeExpandedItems();
+
+    enum Role {
+        NoRole,
+        NameRole,
+        SizeRole,
+        DateRole,
+        PermissionsRole,
+        OwnerRole,
+        GroupRole,
+        TypeRole,
+        DestinationRole,
+        PathRole,
+        IsDirRole,
+        IsExpandedRole,
+        ExpansionLevelRole,
+        RolesCount // Mandatory last entry
+    };
+
+    void resetRoles();
+
+    Role roleIndex(const QByteArray& role) const;
+
+    QHash<QByteArray, QVariant> retrieveData(const KFileItem& item) const;
+
+    bool lessThan(const KFileItem& a, const KFileItem& b) const;
+    void sort(const KFileItemList::iterator& start, const KFileItemList::iterator& end);
+    int stringCompare(const QString& a, const QString& b) const;
+
+    /**
+     * Compares the expansion level of both items. The "expansion level" is defined
+     * by the number of parent directories. However simply comparing just the numbers
+     * is not sufficient, it is also important to check the hierarchy for having
+     * a correct order like shown in a tree.
+     */
+    int expansionLevelsCompare(const KFileItem& a, const KFileItem& b) const;
+
+    /**
+     * Helper method for expansionLevelCompare().
+     */
+    QString subPath(const KFileItem& item,
+                    const QString& itemPath,
+                    int start,
+                    bool* isDir) const;
+
+    bool useMaximumUpdateInterval() const;
+
+private:
+    QWeakPointer<KDirLister> m_dirLister;
+
+    bool m_naturalSorting;
+    bool m_sortFoldersFirst;
+
+    Role m_groupRole;
+    Role m_sortRole;
+    Qt::CaseSensitivity m_caseSensitivity;
+
+    KFileItemList m_sortedItems;   // Allows O(1) access for KFileItemModel::fileItem(int index)
+    QHash<KFileItem, int> m_items; // Allows O(1) access for KFileItemModel::index(const KFileItem& item)
+    QList<QHash<QByteArray, QVariant> > m_data;
+
+    bool m_requestRole[RolesCount];
+
+    QTimer* m_minimumUpdateIntervalTimer;
+    QTimer* m_maximumUpdateIntervalTimer;
+    KFileItemList m_pendingItemsToInsert;
+    KFileItemList m_pendingItemsToDelete;
+
+    // Stores the smallest expansion level of the root-URL. Is required to calculate
+    // the "expansionLevel" role in an efficient way. A value < 0 indicates that
+    // it has not been initialized yet.
+    mutable int m_rootExpansionLevel;
+
+    friend class KFileItemModelTest; // For unit testing
+};
+
+#endif
+
+