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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef CPPTOOLS_INDEXITEM_H
#define CPPTOOLS_INDEXITEM_H
#include "cpptools_global.h"
#include <QIcon>
#include <QSharedPointer>
#include <QMetaType>
#include <functional>
namespace CppTools {
class CPPTOOLS_EXPORT IndexItem
{
Q_DISABLE_COPY(IndexItem)
IndexItem() {}
public:
enum ItemType {
Enum = 1 << 0,
Class = 1 << 1,
Function = 1 << 2,
Declaration = 1 << 3,
All = Enum | Class | Function | Declaration
};
public:
typedef QSharedPointer<IndexItem> Ptr;
static Ptr create(const QString &symbolName,
const QString &symbolType,
const QString &symbolScope,
ItemType type,
const QString &fileName,
int line,
int column,
const QIcon &icon);
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; }
QString fileName() const { return m_fileName; }
QIcon icon() const { return m_icon; }
ItemType type() const { return m_type; }
int line() const { return m_line; }
int column() const { return m_column; }
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
};
typedef std::function<VisitorResult (const IndexItem::Ptr &)> Visitor;
VisitorResult visitAllChildren(Visitor callback) const
{
VisitorResult result = Recurse;
foreach (const IndexItem::Ptr &child, 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;
QString m_fileName;
QIcon m_icon;
ItemType m_type;
int m_line;
int m_column;
QVector<IndexItem::Ptr> m_children;
};
} // CppTools namespace
Q_DECLARE_METATYPE(CppTools::IndexItem::Ptr)
#endif // CPPTOOLS_INDEXITEM_H
|
