1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
|
/*
* KDevelop Problem Reporter
*
* Copyright 2010 Dmitry Risenberg <dmitry.risenberg@gmail.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library 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 KDEVPLATFORM_PLUGIN_WATCHEDDOCUMENTSET_H
#define KDEVPLATFORM_PLUGIN_WATCHEDDOCUMENTSET_H
#include <QObject>
#include <QSet>
#include <serialization/indexedstring.h>
#include <shell/shellexport.h>
#include "problemconstants.h"
namespace KDevelop {
class IDocument;
class IProject;
class ProjectFileItem;
class Path;
class WatchedDocumentSetPrivate;
/**
* Helper class that tracks set of documents and notifies its owner whenever this set changes. Derived classes implement different tracking strategies.
*/
class KDEVPLATFORMSHELL_EXPORT WatchedDocumentSet : public QObject
{
Q_OBJECT
public:
using DocumentSet = QSet<IndexedString>;
explicit WatchedDocumentSet(QObject* parent);
~WatchedDocumentSet() override;
bool showImports() const;
void setShowImports(bool showImports);
virtual DocumentSet get() const;
virtual DocumentSet imports() const;
virtual void setCurrentDocument(const IndexedString& url);
virtual ProblemScope scope() const = 0;
Q_SIGNALS:
void changed();
protected:
const QScopedPointer<class WatchedDocumentSetPrivate> d_ptr;
Q_DECLARE_PRIVATE(WatchedDocumentSet)
};
/**
* Tracks a document that is current at any given moment.
* When a new file is activated, it becomes tracked instead of the old one.
*/
class CurrentDocumentSet : public WatchedDocumentSet
{
Q_OBJECT
public:
explicit CurrentDocumentSet(const IndexedString& document, QObject* parent);
void setCurrentDocument(const IndexedString& url) override;
ProblemScope scope() const override;
};
/**
* Tracks all open documents.
*/
class OpenDocumentSet : public WatchedDocumentSet
{
Q_OBJECT
public:
explicit OpenDocumentSet(QObject* parent);
ProblemScope scope() const override;
private Q_SLOTS:
void documentClosed(IDocument* doc);
void documentCreated(IDocument* doc);
};
/**
* Tracks documents that are in the same project as the current file.
* If current file is not in any project, none are tracked.
*/
class ProjectSet : public WatchedDocumentSet
{
Q_OBJECT
public:
explicit ProjectSet(QObject* parent);
protected:
void trackProjectFiles(const IProject* project);
protected Q_SLOTS:
void fileAdded(ProjectFileItem*);
void fileRemoved(ProjectFileItem* file);
void fileRenamed(const Path& oldFile, ProjectFileItem* newFile);
};
/**
* Tracks files in all open projects.
*/
class CurrentProjectSet : public ProjectSet
{
Q_OBJECT
public:
explicit CurrentProjectSet(const IndexedString& document, QObject* parent);
void setCurrentDocument(const IndexedString& url) override;
ProblemScope scope() const override;
private:
void setCurrentDocumentInternal(const IndexedString& url); // to avoid virtual in constructor
IProject* m_currentProject;
};
class AllProjectSet : public ProjectSet
{
Q_OBJECT
public:
explicit AllProjectSet(QObject* parent);
ProblemScope scope() const override;
};
class BypassSet : public WatchedDocumentSet
{
Q_OBJECT
public:
explicit BypassSet(QObject* parent);
ProblemScope scope() const override;
};
}
#endif // KDEVPLATFORM_PLUGIN_WATCHEDDOCUMENTSET_H
|