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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "cppeditor_global.h"
#include <utils/filepath.h>
#include <QIcon>
#include <QSharedPointer>
#include <QMetaType>
#include <functional>
namespace CppEditor {
class CPPEDITOR_EXPORT IndexItem
{
Q_DISABLE_COPY(IndexItem)
IndexItem() = default;
public:
enum ItemType {
Enum = 1 << 0,
Class = 1 << 1,
Function = 1 << 2,
Declaration = 1 << 3,
All = Enum | Class | Function | Declaration
};
public:
using Ptr = QSharedPointer<IndexItem>;
static Ptr create(const QString &symbolName,
const QString &symbolType,
const QString &symbolScope,
ItemType type,
const QString &fileName,
int line,
int column,
const QIcon &icon,
bool isFunctionDefinition);
static Ptr create(const QString &fileName, int sizeHint);
QString scopedSymbolName() const
{
return m_symbolScope.isEmpty()
? m_symbolName
: m_symbolScope + QLatin1String("::") + m_symbolName;
}
bool unqualifiedNameAndScope(const QString &defaultName, QString *name, QString *scope) const;
QString representDeclaration() const;
QString shortNativeFilePath() const;
QString symbolName() const { return m_symbolName; }
QString symbolType() const { return m_symbolType; }
QString symbolScope() const { return m_symbolScope; }
const Utils::FilePath &filePath() const { return m_filePath; }
QIcon icon() const { return m_icon; }
ItemType type() const { return m_type; }
int line() const { return m_line; }
int column() const { return m_column; }
bool isFunctionDefinition() const { return m_isFuncDef; }
void addChild(IndexItem::Ptr childItem) { m_children.append(childItem); }
void squeeze();
enum VisitorResult {
Break, /// terminates traversal
Continue, /// continues traversal with the next sibling
Recurse, /// continues traversal with the children
};
using Visitor = std::function<VisitorResult (const IndexItem::Ptr &)>;
VisitorResult visitAllChildren(Visitor callback) const
{
VisitorResult result = Recurse;
for (const IndexItem::Ptr &child : std::as_const(m_children)) {
result = callback(child);
switch (result) {
case Break:
return Break;
case Continue:
continue;
case Recurse:
if (!child->m_children.isEmpty()) {
result = child->visitAllChildren(callback);
if (result == Break)
return Break;
}
}
}
return result;
}
private:
QString m_symbolName; // as found in the code, therefore might be qualified
QString m_symbolType;
QString m_symbolScope;
Utils::FilePath m_filePath;
QIcon m_icon;
ItemType m_type = All;
int m_line = 0;
int m_column = 0;
bool m_isFuncDef = false;
QVector<IndexItem::Ptr> m_children;
};
} // CppEditor namespace
Q_DECLARE_METATYPE(CppEditor::IndexItem::Ptr)
|
