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
152
153
154
155
|
/*
* KDevelop Class Browser
*
* Copyright 2009 Lior Mualem <lior.m.kde@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_DOCUMENTCLASSESFOLDER_H
#define KDEVPLATFORM_DOCUMENTCLASSESFOLDER_H
#include "classmodelnode.h"
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/member.hpp>
#include <boost/multi_index/ordered_index.hpp>
namespace ClassModelNodes {
class StaticNamespaceFolderNode;
/// This folder displays all the classes that relate to a list of documents.
class DocumentClassesFolder
: public QObject
, public DynamicFolderNode
{
Q_OBJECT
public:
DocumentClassesFolder(const QString& a_displayName, NodesModelInterface* a_model);
public: // Operations
/// Find a class node in the lists by its id.
ClassNode* findClassNode(const KDevelop::IndexedQualifiedIdentifier& a_id);
protected: // Documents list handling.
/// Parse a single document for classes and add them to the list.
void parseDocument(const KDevelop::IndexedString& a_file);
/// Re-parse the given document - remove old declarations and add new declarations.
bool updateDocument(const KDevelop::IndexedString& a_file);
/// Close and remove all the nodes related to the specified document.
void closeDocument(const KDevelop::IndexedString& a_file);
/// Returns a list of documents we have monitored.
QSet<KDevelop::IndexedString> allOpenDocuments() const;
protected: // Overridables
/// Override this to filter the found classes.
virtual bool isClassFiltered(const KDevelop::QualifiedIdentifier&) { return false; }
public: // Node overrides
void nodeCleared() override;
void populateNode() override;
bool hasChildren() const override { return true; }
private Q_SLOTS:
// Files update.
void updateChangedFiles();
private: // File updates related.
/// List of updated files we check this list when update timer expires.
QSet<KDevelop::IndexedString> m_updatedFiles;
/// Timer for batch updates.
QTimer* m_updateTimer;
private: // Opened class identifiers container definition.
// An opened class item.
struct OpenedFileClassItem
{
OpenedFileClassItem();
OpenedFileClassItem(const KDevelop::IndexedString& a_file,
const KDevelop::IndexedQualifiedIdentifier& a_classIdentifier,
ClassNode* a_nodeItem);
/// The file this class declaration comes from.
KDevelop::IndexedString file;
/// The identifier for this class.
KDevelop::IndexedQualifiedIdentifier classIdentifier;
/// An existing node item. It maybe 0 - meaning the class node is currently hidden.
ClassNode* nodeItem;
};
// Index definitions.
struct FileIndex {};
struct ClassIdentifierIndex {};
// Member types definitions.
using FileMember = boost::multi_index::member<
OpenedFileClassItem,
KDevelop::IndexedString,
& OpenedFileClassItem::file>;
using ClassIdentifierMember = boost::multi_index::member<
OpenedFileClassItem,
KDevelop::IndexedQualifiedIdentifier,
& OpenedFileClassItem::classIdentifier>;
// Container definition.
using OpenFilesContainer = boost::multi_index::multi_index_container<
OpenedFileClassItem,
boost::multi_index::indexed_by<
boost::multi_index::ordered_non_unique<
boost::multi_index::tag<FileIndex>,
FileMember
>,
boost::multi_index::ordered_unique<
boost::multi_index::tag<ClassIdentifierIndex>,
ClassIdentifierMember
>
>
>;
// Iterators definition.
using FileIterator = OpenFilesContainer::index_iterator<FileIndex>::type;
using ClassIdentifierIterator = OpenFilesContainer::index_iterator<ClassIdentifierIndex>::type;
/// Maps all displayed classes and their referenced files.
OpenFilesContainer m_openFilesClasses;
/// Holds a set of open files.
QSet<KDevelop::IndexedString> m_openFiles;
private:
using NamespacesMap = QMap<KDevelop::IndexedQualifiedIdentifier, StaticNamespaceFolderNode*>;
/// Holds a map between an identifier and a namespace folder we hold.
NamespacesMap m_namespaces;
/// Recursively create a namespace folder for the specified identifier if it doesn't
/// exist, cache it and return it (or just return it from the cache).
StaticNamespaceFolderNode* namespaceFolder(const KDevelop::QualifiedIdentifier& a_identifier);
/// Removes the given namespace identifier recursively if it's empty.
void removeEmptyNamespace(const KDevelop::QualifiedIdentifier& a_identifier);
/// Remove a single class node from the lists.
void removeClassNode(ClassNode* a_node);
};
} // namespace ClassModelNodes
#endif // KDEVPLATFORM_DOCUMENTCLASSESFOLDER_H
|
