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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://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 https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include <coreplugin/id.h>
#include <utils/optional.h>
#include <QVariant>
#include <QFutureInterface>
#include <QIcon>
namespace Core {
class ILocatorFilter;
struct LocatorFilterEntry
{
struct HighlightInfo {
enum DataType {
DisplayName,
ExtraInfo
};
HighlightInfo(int startIndex, int length, DataType type = DataType::DisplayName)
: starts{startIndex}
, lengths{length}
, dataType(type)
{}
HighlightInfo(QVector<int> startIndex, QVector<int> length, DataType type = DataType::DisplayName)
: starts(startIndex)
, lengths(length)
, dataType(type)
{}
QVector<int> starts;
QVector<int> lengths;
DataType dataType;
};
LocatorFilterEntry() = default;
LocatorFilterEntry(ILocatorFilter *fromFilter, const QString &name, const QVariant &data,
Utils::optional<QIcon> icon = Utils::nullopt)
: filter(fromFilter)
, displayName(name)
, internalData(data)
, displayIcon(icon)
{}
bool operator==(const LocatorFilterEntry &other) const {
if (internalData.canConvert(QVariant::String))
return (internalData.toString() == other.internalData.toString());
return internalData.constData() == other.internalData.constData();
}
/* backpointer to creating filter */
ILocatorFilter *filter = nullptr;
/* displayed string */
QString displayName;
/* extra information displayed in light-gray in a second column (optional) */
QString extraInfo;
/* can be used by the filter to save more information about the entry */
QVariant internalData;
/* icon to display along with the entry */
Utils::optional<QIcon> displayIcon;
/* file name, if the entry is related to a file, is used e.g. for resolving a file icon */
QString fileName;
/* highlighting support */
HighlightInfo highlightInfo{0, 0};
static bool compareLexigraphically(const Core::LocatorFilterEntry &lhs,
const Core::LocatorFilterEntry &rhs)
{
return lhs.displayName < rhs.displayName;
}
};
class CORE_EXPORT ILocatorFilter : public QObject
{
Q_OBJECT
public:
enum class MatchLevel {
Best = 0,
Better,
Good,
Normal,
Count
};
enum Priority {Highest = 0, High = 1, Medium = 2, Low = 3};
ILocatorFilter(QObject *parent = nullptr);
~ILocatorFilter() override;
static const QList<ILocatorFilter *> allLocatorFilters();
Id id() const;
Id actionId() const;
QString displayName() const;
Priority priority() const;
QString shortcutString() const;
void setShortcutString(const QString &shortcut);
virtual void prepareSearch(const QString &entry);
virtual QList<LocatorFilterEntry> matchesFor(QFutureInterface<LocatorFilterEntry> &future, const QString &entry) = 0;
virtual void accept(LocatorFilterEntry selection,
QString *newText, int *selectionStart, int *selectionLength) const = 0;
virtual void refresh(QFutureInterface<void> &future) = 0;
virtual QByteArray saveState() const;
virtual void restoreState(const QByteArray &state);
virtual bool openConfigDialog(QWidget *parent, bool &needsRefresh);
bool isConfigurable() const;
bool isIncludedByDefault() const;
void setIncludedByDefault(bool includedByDefault);
bool isHidden() const;
bool isEnabled() const;
static Qt::CaseSensitivity caseSensitivity(const QString &str);
static QRegularExpression createRegExp(const QString &text,
Qt::CaseSensitivity caseSensitivity = Qt::CaseInsensitive);
LocatorFilterEntry::HighlightInfo highlightInfo(const QRegularExpressionMatch &match,
LocatorFilterEntry::HighlightInfo::DataType dataType = LocatorFilterEntry::HighlightInfo::DisplayName);
static QString msgConfigureDialogTitle();
static QString msgPrefixLabel();
static QString msgPrefixToolTip();
static QString msgIncludeByDefault();
static QString msgIncludeByDefaultToolTip();
public slots:
void setEnabled(bool enabled);
protected:
void setHidden(bool hidden);
void setId(Id id);
void setPriority(Priority priority);
void setDisplayName(const QString &displayString);
void setConfigurable(bool configurable);
private:
Id m_id;
QString m_shortcut;
Priority m_priority = Medium;
QString m_displayName;
bool m_includedByDefault = false;
bool m_hidden = false;
bool m_enabled = true;
bool m_isConfigurable = true;
};
} // namespace Core
|
