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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "helpindexfilter.h"
#include "helpmanager.h"
#include "helptr.h"
#include "localhelpmanager.h"
#include <coreplugin/icore.h>
#include <coreplugin/helpmanager.h>
#include <extensionsystem/pluginmanager.h>
#include <utils/utilsicons.h>
#include <QHelpEngine>
#include <QHelpFilterEngine>
#include <QHelpLink>
#include <QIcon>
using namespace Core;
using namespace Help;
using namespace Help::Internal;
HelpIndexFilter::HelpIndexFilter()
{
setId("HelpIndexFilter");
setDisplayName(Tr::tr("Help Index"));
setDefaultIncludedByDefault(false);
setDefaultShortcutString("?");
m_icon = Utils::Icons::BOOKMARK.icon();
connect(Core::HelpManager::Signals::instance(), &Core::HelpManager::Signals::setupFinished,
this, &HelpIndexFilter::invalidateCache);
connect(Core::HelpManager::Signals::instance(),
&Core::HelpManager::Signals::documentationChanged,
this,
&HelpIndexFilter::invalidateCache);
connect(HelpManager::instance(), &HelpManager::collectionFileChanged,
this, &HelpIndexFilter::invalidateCache);
}
HelpIndexFilter::~HelpIndexFilter() = default;
bool HelpIndexFilter::updateCache(QFutureInterface<LocatorFilterEntry> &future,
const QStringList &cache, const QString &entry)
{
const Qt::CaseSensitivity cs = caseSensitivity(entry);
QStringList bestKeywords;
QStringList worseKeywords;
bestKeywords.reserve(cache.size());
worseKeywords.reserve(cache.size());
for (const QString &keyword : cache) {
if (future.isCanceled())
return false;
if (keyword.startsWith(entry, cs))
bestKeywords.append(keyword);
else if (keyword.contains(entry, cs))
worseKeywords.append(keyword);
}
bestKeywords << worseKeywords;
m_lastIndicesCache = bestKeywords;
m_lastEntry = entry;
return true;
}
QList<LocatorFilterEntry> HelpIndexFilter::matchesFor(QFutureInterface<LocatorFilterEntry> &future, const QString &entry)
{
if (m_needsUpdate.exchange(false)) {
QStringList indices;
QMetaObject::invokeMethod(this, [this] { return allIndices(); },
Qt::BlockingQueuedConnection, &indices);
m_allIndicesCache = indices;
// force updating the cache taking the m_allIndicesCache
m_lastIndicesCache = QStringList();
m_lastEntry = QString();
}
const QStringList cacheBase = m_lastEntry.isEmpty() || !entry.contains(m_lastEntry)
? m_allIndicesCache : m_lastIndicesCache;
if (!updateCache(future, cacheBase, entry))
return QList<LocatorFilterEntry>();
const Qt::CaseSensitivity cs = caseSensitivity(entry);
QList<LocatorFilterEntry> entries;
for (const QString &keyword : std::as_const(m_lastIndicesCache)) {
const int index = keyword.indexOf(entry, 0, cs);
LocatorFilterEntry filterEntry(this, keyword, QVariant(), m_icon);
filterEntry.highlightInfo = {index, int(entry.length())};
entries.append(filterEntry);
}
return entries;
}
void HelpIndexFilter::accept(const LocatorFilterEntry &selection,
QString *newText, int *selectionStart, int *selectionLength) const
{
Q_UNUSED(newText)
Q_UNUSED(selectionStart)
Q_UNUSED(selectionLength)
const QString &key = selection.displayName;
const QMultiMap<QString, QUrl> links = LocalHelpManager::linksForKeyword(key);
emit linksActivated(links, key);
}
void HelpIndexFilter::refresh(QFutureInterface<void> &future)
{
Q_UNUSED(future)
invalidateCache();
}
QStringList HelpIndexFilter::allIndices() const
{
LocalHelpManager::setupGuiHelpEngine();
return LocalHelpManager::filterEngine()->indices(QString());
}
void HelpIndexFilter::invalidateCache()
{
m_needsUpdate = true;
}
|
