For VCS-plugin interface added pure virtual function outOfVersionControlActions()

[dolphin.git] / src / views / versioncontrol / versioncontrolobserver.h

diff --git a/src/views/versioncontrol/versioncontrolobserver.h b/src/views/versioncontrol/versioncontrolobserver.h
index ecf78d05f2f255e1c493887146e77acf50072352..648c9d6fdfd126b9fce238f8cd8302f9ae3a9483 100644 (file)
--- a/src/views/versioncontrol/versioncontrolobserver.h
+++ b/src/views/versioncontrol/versioncontrolobserver.h
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2009 by Peter Penz <peter.penz@gmx.at>                  *
+ *   Copyright (C) 2009 by Peter Penz <peter.penz19@gmail.com>             *
  *                                                                         *
  *   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  *
@@ -20,43 +20,49 @@
 #ifndef VERSIONCONTROLOBSERVER_H
 #define VERSIONCONTROLOBSERVER_H
 
-#include <libdolphin_export.h>
+#include "dolphin_export.h"
+
+#include "kversioncontrolplugin.h"
 
 #include <KFileItem>
-#include <kversioncontrolplugin.h>
+
 #include <QList>
-#include <QMutex>
 #include <QObject>
-#include <QPersistentModelIndex>
 #include <QString>
+#include <QUrl>
 
-class DolphinModel;
-class KDirLister;
 class KFileItemList;
-class QAbstractItemView;
+class KFileItemModel;
+class KItemRangeList;
 class QAction;
 class QTimer;
 class UpdateItemStatesThread;
 
+class DolphinView;
+
 /**
  * @brief Observes all version control plugins.
  *
- * The item view gets updated automatically if the currently shown
- * directory is under version control.
+ * The items of the directory-model get updated automatically if the currently
+ * shown directory is under version control.
  *
  * @see VersionControlPlugin
  */
-class LIBDOLPHINPRIVATE_EXPORT VersionControlObserver : public QObject
+class DOLPHIN_EXPORT VersionControlObserver : public QObject
 {
     Q_OBJECT
 
 public:
-    VersionControlObserver(QAbstractItemView* view);
-    virtual ~VersionControlObserver();
+    explicit VersionControlObserver(QObject* parent = nullptr);
+    ~VersionControlObserver() override;
+
+    void setModel(KFileItemModel* model);
+    KFileItemModel* model() const;
+    void setView(DolphinView* view);
+    DolphinView* view() const;
+
+    QList<QAction*> actions(const KFileItemList& items) const;
 
-    QList<QAction*> contextMenuActions(const KFileItemList& items) const;
-    QList<QAction*> contextMenuActions(const QString& directory) const;
-    
 signals:
     /**
      * Is emitted if an information message with the content \a msg
@@ -75,7 +81,7 @@ signals:
      * should be shown.
      */
     void operationCompletedMessage(const QString& msg);
-    
+
 private slots:
     /**
      * Invokes verifyDirectory() with a small delay. If delayedDirectoryVerification()
@@ -90,7 +96,13 @@ private slots:
      * delayedDirectoryVerification() it and assures that the verification of
      * the directory is done silently without information messages.
      */
-    void silentDirectoryVerification();    
+    void silentDirectoryVerification();
+
+    /**
+     * Invokes delayedDirectoryVerification() only if the itemsChanged() signal has not
+     * been triggered by the VCS plugin itself.
+     */
+    void slotItemsChanged(const KItemRangeList& itemRanges, const QSet<QByteArray>& roles);
 
     void verifyDirectory();
 
@@ -99,47 +111,54 @@ private slots:
      * and applys the item states.
      */
     void slotThreadFinished();
-    
+
 private:
-    struct ItemState
-    {
-        QPersistentModelIndex index;
-        KFileItem item;
-        KVersionControlPlugin::VersionState version;
-    };
+    typedef QPair<KFileItem, KVersionControlPlugin::ItemVersion> ItemState;
+    typedef QPair<KVersionControlPlugin*, QString> VCSPlugin;
 
     void updateItemStates();
 
     /**
-     * Adds recursively all items from the directory \p parentIndex into
-     * the list \p itemStates.
+     * It creates a item state list for every expanded directory and stores
+     * this list together with the directory url in the \a itemStates map.
+     *
+     * @itemStates      A map of item state lists for every expanded directory
+     *                  and its items, where the "key" is the directory url and
+     *                  the "value" is a list of ItemStates for every item
+     *                  within this directory.
+     * @firstIndex      The index to start the processing from, this is needed
+     *                  because this function is recursively called.
+     *
+     * @return          The number of (recursive) processed items.
      */
-    void addDirectory(const QModelIndex& parentIndex, QList<ItemState>& itemStates);
+    int createItemStatesList(QMap<QString, QVector<ItemState> >& itemStates,
+                             const int firstIndex = 0);
 
     /**
      * Returns a matching plugin for the given directory.
      * 0 is returned, if no matching plugin has been found.
      */
-    KVersionControlPlugin* searchPlugin(const KUrl& directory) const;
+    KVersionControlPlugin* searchPlugin(const QUrl& directory);
 
     /**
      * Returns true, if the directory contains a version control information.
      */
-    bool isVersioned() const;
+    bool isVersionControlled() const;
 
 private:
     bool m_pendingItemStatesUpdate;
     bool m_versionedDirectory;
     bool m_silentUpdate; // if true, no messages will be send during the update
                          // of version states
-    
-    QAbstractItemView* m_view;
-    KDirLister* m_dirLister;
-    DolphinModel* m_dolphinModel;
-    
+
+    DolphinView* m_view;
+    KFileItemModel* m_model;
+
     QTimer* m_dirVerificationTimer;
 
+    bool m_pluginsInitialized;
     KVersionControlPlugin* m_plugin;
+    QList<VCSPlugin> m_plugins;
     UpdateItemStatesThread* m_updateItemStatesThread;
 
     friend class UpdateItemStatesThread;