-/***************************************************************************
- * 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 *
- * 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 *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2009 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#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*> contextMenuActions(const KFileItemList& items) const;
- QList<QAction*> contextMenuActions(const QString& directory) const;
+ QList<QAction *> actions(const KFileItemList &items) const;
-signals:
+Q_SIGNALS:
/**
* Is emitted if an information message with the content \a msg
* should be shown.
*/
- void infoMessage(const QString& msg);
+ void infoMessage(const QString &msg);
/**
* Is emitted if an error message with the content \a msg
* should be shown.
*/
- void errorMessage(const QString& msg);
+ void errorMessage(const QString &msg);
/**
* Is emitted if an "operation completed" message with the content \a msg
* should be shown.
*/
- void operationCompletedMessage(const QString& msg);
+ void operationCompletedMessage(const QString &msg);
-private slots:
+private Q_SLOTS:
/**
* Invokes verifyDirectory() with a small delay. If delayedDirectoryVerification()
* is invoked before the delay has been exceeded, the delay will be reset. This
*/
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();
/**
* Is invoked if the thread m_updateItemStatesThread has been finished
- * and applys the item states.
+ * and applies the item states.
*/
void slotThreadFinished();
private:
- struct ItemState
- {
- QPersistentModelIndex index;
- KFileItem item;
- KVersionControlPlugin::VersionState version;
- };
+ typedef QPair<KFileItem, KVersionControlPlugin::ItemVersion> ItemState;
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:
+ void initPlugins();
+
bool m_pendingItemStatesUpdate;
- bool m_versionedDirectory;
bool m_silentUpdate; // if true, no messages will be send during the update
// of version states
+ QString m_localRepoRoot;
- QAbstractItemView* m_view;
- KDirLister* m_dirLister;
- DolphinModel* m_dolphinModel;
+ DolphinView *m_view;
+ KFileItemModel *m_model;
- QTimer* m_dirVerificationTimer;
+ QTimer *m_dirVerificationTimer;
- KVersionControlPlugin* m_plugin;
- UpdateItemStatesThread* m_updateItemStatesThread;
+ bool m_pluginsInitialized;
+ // directories have at most one plugin, this is the dectected current one.
+ KVersionControlPlugin *m_currentPlugin;
+ QList<KVersionControlPlugin *> m_plugins;
+ UpdateItemStatesThread *m_updateItemStatesThread;
friend class UpdateItemStatesThread;
};
#endif // REVISIONCONTROLOBSERVER_H
-
projects / dolphin.git / blobdiff