feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

LocatorFilter classes: Use more linkForEditor

Browse Source 
Limit the usage of ambiguous internalData.

Change-Id: Ice67884b9fb2ff303939cd5998c6e80453e82530
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Jarek Kobus
2023-02-22 19:51:22 +01:00
parent 34fd28327d
commit 215f79f580
11 changed files with 61 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/libs/utils/link.h
View File

@@ -17,7 +17,8 @@ namespace Utils {
class QTCREATOR_UTILS_EXPORT Link
{
public:
Link(const FilePath &filePath = FilePath(), int line = 0, int column = 0)
Link() = default;
Link(const FilePath &filePath, int line = 0, int column = 0)
: targetFilePath(filePath)
, targetLine(line)
, targetColumn(column)
@@ -48,8 +49,8 @@ public:
int linkTextEnd = -1;
FilePath targetFilePath;
int targetLine;
int targetColumn;
int targetLine = 0;
int targetColumn = 0;
};
using LinkHandler = std::function<void(const Link &)>;
@@ -58,3 +59,12 @@ using Links = QList<Link>;
} // namespace Utils
Q_DECLARE_METATYPE(Utils::Link)
namespace std {
template<> struct hash<Utils::Link>
{
size_t operator()(const Utils::Link &fn) const { return qHash(fn); }
};
} // std

49
src/plugins/clangcodemodel/clangdlocatorfilters.cpp
View File

@@ -6,25 +6,20 @@
#include "clangdclient.h"
#include "clangmodelmanagersupport.h"
#include <coreplugin/editormanager/editormanager.h>
#include <cppeditor/cppeditorconstants.h>
#include <cppeditor/cppeditortr.h>
#include <cppeditor/cpplocatorfilter.h>
#include <cppeditor/cppmodelmanager.h>
#include <cppeditor/indexitem.h>
#include <languageclient/languageclientutils.h>
#include <languageclient/locatorfilter.h>
#include <projectexplorer/projectmanager.h>
#include <utils/link.h>
#include <utils/algorithm.h>
#include <QHash>
#include <set>
#include <tuple>
using namespace Core;
using namespace LanguageClient;
using namespace LanguageServerProtocol;
@@ -159,33 +154,27 @@ QList<LocatorFilterEntry> ClangGlobalSymbolFilter::matchesFor(
QList<LocatorFilterEntry> matches = m_cppFilter->matchesFor(future, entry);
const QList<LocatorFilterEntry> lspMatches = m_lspFilter->matchesFor(future, entry);
if (!lspMatches.isEmpty()) {
std::set<std::tuple<FilePath, int, int>> locations;
QSet<Link> locations;
for (const auto &entry : std::as_const(matches)) {
const CppEditor::IndexItem::Ptr item
= qvariant_cast<CppEditor::IndexItem::Ptr>(entry.internalData);
locations.insert(std::make_tuple(item->filePath(), item->line(), item->column()));
QTC_ASSERT(entry.linkForEditor, continue);
locations.insert(*entry.linkForEditor);
}
for (const auto &entry : lspMatches) {
if (!entry.internalData.canConvert<Link>())
continue;
const auto link = qvariant_cast<Link>(entry.internalData);
if (locations.find(std::make_tuple(link.targetFilePath, link.targetLine,
link.targetColumn)) == locations.cend()) {
QTC_ASSERT(entry.linkForEditor, continue);
if (!locations.contains(*entry.linkForEditor))
matches << entry; // TODO: Insert sorted?
}
}
}
return matches;
}
void ClangGlobalSymbolFilter::accept(const LocatorFilterEntry &selection, QString *newText,
int *selectionStart, int *selectionLength) const
{
if (qvariant_cast<CppEditor::IndexItem::Ptr>(selection.internalData))
m_cppFilter->accept(selection, newText, selectionStart, selectionLength);
else
m_lspFilter->accept(selection, newText, selectionStart, selectionLength);
Q_UNUSED(newText)
Q_UNUSED(selectionStart)
Q_UNUSED(selectionLength)
EditorManager::openEditor(selection);
}
@@ -236,6 +225,8 @@ private:
static_cast<SymbolKind>(info.kind()), info.name(),
info.detail().value_or(QString()));
entry.internalData = QVariant::fromValue(info);
const Position pos = info.range().start();
entry.linkForEditor = {m_currentFilePath, pos.line() + 1, pos.character()};
entry.extraInfo = parent.extraInfo;
if (!entry.extraInfo.isEmpty())
entry.extraInfo.append("::");
@@ -289,19 +280,13 @@ private:
}
if (definitions.size() == 1
&& declarations.size() + definitions.size() == duplicates.size()) {
for (const LocatorFilterEntry &decl : std::as_const(declarations))
for (const LocatorFilterEntry &decl : std::as_const(declarations)) {
Utils::erase(allMatches, [&decl](const LocatorFilterEntry &e) {
return e.internalData == decl.internalData;
});
}
}
}
// The base implementation expects the position in the internal data.
for (LocatorFilterEntry &e : allMatches) {
const Position pos = qvariant_cast<DocumentSymbol>(e.internalData).range().start();
e.internalData = QVariant::fromValue(Utils::LineColumn(pos.line(), pos.character()));
}
return allMatches;
}
@@ -362,8 +347,10 @@ QList<LocatorFilterEntry> ClangdCurrentDocumentFilter::matchesFor(
void ClangdCurrentDocumentFilter::accept(const LocatorFilterEntry &selection, QString *newText,
int *selectionStart, int *selectionLength) const
{
QTC_ASSERT(d->activeFilter, return);
d->activeFilter->accept(selection, newText, selectionStart, selectionLength);
Q_UNUSED(newText)
Q_UNUSED(selectionStart)
Q_UNUSED(selectionLength)
EditorManager::openEditor(selection);
}
} // namespace Internal

25
src/plugins/cmakeprojectmanager/cmakelocatorfilter.cpp
View File

@@ -58,17 +58,13 @@ void CMakeTargetLocatorFilter::prepareSearch(const QString &entry)
if (index >= 0) {
const FilePath path = target.backtrace.isEmpty() ? cmakeProject->projectFilePath()
: target.backtrace.last().path;
const int line = target.backtrace.isEmpty() ? -1 : target.backtrace.last().line;
const int line = target.backtrace.isEmpty() ? 0 : target.backtrace.last().line;
QVariantMap extraData;
extraData.insert("project", cmakeProject->projectFilePath().toString());
extraData.insert("line", line);
extraData.insert("file", path.toString());
LocatorFilterEntry filterEntry(this, target.title, extraData);
LocatorFilterEntry filterEntry(this, target.title);
filterEntry.linkForEditor = {path, line};
filterEntry.extraInfo = path.shortNativePath();
filterEntry.highlightInfo = {index, int(entry.length())};
filterEntry.filePath = path;
filterEntry.filePath = cmakeProject->projectFilePath();
m_result.append(filterEntry);
}
@@ -111,8 +107,7 @@ void BuildCMakeTargetLocatorFilter::accept(const LocatorFilterEntry &selection,
Q_UNUSED(selectionStart)
Q_UNUSED(selectionLength)
const QVariantMap extraData = selection.internalData.toMap();
const FilePath projectPath = FilePath::fromString(extraData.value("project").toString());
const FilePath projectPath = selection.filePath;
// Get the project containing the target selected
const auto cmakeProject = qobject_cast<CMakeProject *>(
@@ -160,15 +155,7 @@ void OpenCMakeTargetLocatorFilter::accept(const LocatorFilterEntry &selection,
Q_UNUSED(newText)
Q_UNUSED(selectionStart)
Q_UNUSED(selectionLength)
const QVariantMap extraData = selection.internalData.toMap();
const int line = extraData.value("line").toInt();
const auto file = FilePath::fromVariant(extraData.value("file"));
if (line >= 0)
EditorManager::openEditorAt({file, line}, {}, EditorManager::AllowExternalEditor);
else
EditorManager::openEditor(file, {}, EditorManager::AllowExternalEditor);
EditorManager::openEditor(selection);
}
} // CMakeProjectManager::Internal

4
src/plugins/coreplugin/locator/locatorsearchutils.cpp
View File

@@ -10,7 +10,7 @@
void Core::Internal::runSearch(QFutureInterface<Core::LocatorFilterEntry> &future,
const QList<ILocatorFilter *> &filters, const QString &searchText)
{
std::unordered_set<Utils::FilePath> addedCache;
std::unordered_set<Utils::Link> addedCache;
const bool checkDuplicates = (filters.size() > 1);
const auto duplicatesRemoved = [&](const QList<LocatorFilterEntry> &entries) {
if (!checkDuplicates)
@@ -19,7 +19,7 @@ void Core::Internal::runSearch(QFutureInterface<Core::LocatorFilterEntry> &futur
results.reserve(entries.size());
for (const LocatorFilterEntry &entry : entries) {
const auto &link = entry.linkForEditor;
if (!link || addedCache.emplace(link->targetFilePath).second)
if (!link || addedCache.emplace(*link).second)
results.append(entry);
}
return results;

8
src/plugins/cppeditor/cppcurrentdocumentfilter.cpp
View File

@@ -86,6 +86,7 @@ QList<LocatorFilterEntry> CppCurrentDocumentFilter::matchesFor(
}
LocatorFilterEntry filterEntry(this, name, id, info->icon());
filterEntry.linkForEditor = {info->filePath(), info->line(), info->column()};
filterEntry.extraInfo = extraInfo;
if (match.hasMatch()) {
filterEntry.highlightInfo = highlightInfo(match);
@@ -127,13 +128,13 @@ QList<LocatorFilterEntry> CppCurrentDocumentFilter::matchesFor(
}
if (definitions.size() == 1
&& declarations.size() + definitions.size() == duplicates.size()) {
for (const LocatorFilterEntry &decl : std::as_const(declarations))
for (const LocatorFilterEntry &decl : std::as_const(declarations)) {
Utils::erase(betterEntries, [&decl](const LocatorFilterEntry &e) {
return e.internalData == decl.internalData;
});
}
}
}
return betterEntries;
}
@@ -143,8 +144,7 @@ void CppCurrentDocumentFilter::accept(const LocatorFilterEntry &selection, QStri
Q_UNUSED(newText)
Q_UNUSED(selectionStart)
Q_UNUSED(selectionLength)
IndexItem::Ptr info = qvariant_cast<IndexItem::Ptr>(selection.internalData);
EditorManager::openEditorAt({info->filePath(), info->line(), info->column()});
EditorManager::openEditor(selection);
}
void CppCurrentDocumentFilter::onDocumentUpdated(Document::Ptr doc)

7
src/plugins/cppeditor/cpplocatorfilter.cpp
View File

@@ -33,6 +33,7 @@ LocatorFilterEntry CppLocatorFilter::filterEntryFromIndexItem(IndexItem::Ptr inf
{
const QVariant id = QVariant::fromValue(info);
LocatorFilterEntry filterEntry(this, info->scopedSymbolName(), id, info->icon());
filterEntry.linkForEditor = {info->filePath(), info->line(), info->column()};
if (info->type() == IndexItem::Class || info->type() == IndexItem::Enum)
filterEntry.extraInfo = info->shortNativeFilePath();
else
@@ -121,9 +122,7 @@ void CppLocatorFilter::accept(const LocatorFilterEntry &selection,
Q_UNUSED(newText)
Q_UNUSED(selectionStart)
Q_UNUSED(selectionLength)
IndexItem::Ptr info = qvariant_cast<IndexItem::Ptr>(selection.internalData);
EditorManager::openEditorAt({info->filePath(), info->line(), info->column()}, {},
EditorManager::AllowExternalEditor);
EditorManager::openEditor(selection);
}
CppClassesFilter::CppClassesFilter(CppLocatorData *locatorData)
@@ -141,6 +140,7 @@ LocatorFilterEntry CppClassesFilter::filterEntryFromIndexItem(IndexItem::Ptr inf
{
const QVariant id = QVariant::fromValue(info);
LocatorFilterEntry filterEntry(this, info->symbolName(), id, info->icon());
filterEntry.linkForEditor = {info->filePath(), info->line(), info->column()};
filterEntry.extraInfo = info->symbolScope().isEmpty()
? info->shortNativeFilePath()
: info->symbolScope();
@@ -173,6 +173,7 @@ LocatorFilterEntry CppFunctionsFilter::filterEntryFromIndexItem(IndexItem::Ptr i
}
LocatorFilterEntry filterEntry(this, name + info->symbolType(), id, info->icon());
filterEntry.linkForEditor = {info->filePath(), info->line(), info->column()};
filterEntry.extraInfo = extraInfo;
return filterEntry;

9
src/plugins/cppeditor/cppmodelmanager.cpp
View File

@@ -572,12 +572,9 @@ void CppModelManager::findUnusedFunctions(const FilePath &folder)
return entry.displayName.startsWith(prefix); })) {
continue;
}
Link link;
if (entry.internalData.canConvert<Link>())
link = qvariant_cast<Link>(entry.internalData);
else if (const auto item = qvariant_cast<IndexItem::Ptr>(entry.internalData))
link = Link(item->filePath(), item->line(), item->column());
if (!entry.linkForEditor)
continue;
const Link link = *entry.linkForEditor;
if (link.hasValidTarget() && link.targetFilePath.isReadableFile()
&& (folder.isEmpty() || link.targetFilePath.isChildOf(folder))
&& ProjectManager::projectForFile(link.targetFilePath)) {

26
src/plugins/languageclient/locatorfilter.cpp
View File

@@ -96,7 +96,7 @@ static LocatorFilterEntry generateLocatorEntry(const SymbolInformation &info,
if (std::optional<QString> container = info.containerName())
entry.extraInfo = container.value_or(QString());
entry.displayIcon = symbolIcon(info.kind());
entry.internalData = QVariant::fromValue(info.location().toLink(pathMapper));
entry.linkForEditor = info.location().toLink(pathMapper);
return entry;
}
@@ -127,7 +127,7 @@ LocatorFilterEntry DocumentLocatorFilter::generateLocatorEntry(const DocumentSym
entry.extraInfo = detail.value_or(QString());
entry.displayIcon = symbolIcon(info.kind());
const Position &pos = info.range().start();
entry.internalData = QVariant::fromValue(Utils::LineColumn(pos.line(), pos.character()));
entry.linkForEditor = {m_currentFilePath, pos.line() + 1, pos.character()};
return entry;
}
@@ -150,7 +150,7 @@ QList<LocatorFilterEntry> DocumentLocatorFilter::generateLocatorEntries(
template<class T>
QList<LocatorFilterEntry> DocumentLocatorFilter::generateEntries(const QList<T> &list,
const QString &filter)
const QString &filter)
{
QList<LocatorFilterEntry> entries;
FuzzyMatcher::CaseSensitivity caseSensitivity
@@ -169,6 +169,7 @@ QList<LocatorFilterEntry> DocumentLocatorFilter::generateEntries(const QList<T>
void DocumentLocatorFilter::prepareSearch(const QString &/*entry*/)
{
QMutexLocker locker(&m_mutex);
m_currentFilePath = m_pathMapper ? m_currentUri.toFilePath(m_pathMapper) : Utils::FilePath();
if (m_symbolCache && !m_currentSymbols.has_value()) {
locker.unlock();
m_symbolCache->requestSymbols(m_currentUri, Schedule::Now);
@@ -208,17 +209,8 @@ void DocumentLocatorFilter::accept(const LocatorFilterEntry &selection,
int * /*selectionStart*/,
int * /*selectionLength*/) const
{
if (selection.internalData.canConvert<Utils::LineColumn>()) {
QTC_ASSERT(m_pathMapper, return);
auto lineColumn = qvariant_cast<Utils::LineColumn>(selection.internalData);
const Utils::Link link(m_currentUri.toFilePath(m_pathMapper),
lineColumn.line + 1,
lineColumn.column);
EditorManager::openEditorAt(link, {}, EditorManager::AllowExternalEditor);
} else if (selection.internalData.canConvert<Utils::Link>()) {
EditorManager::openEditorAt(qvariant_cast<Utils::Link>(selection.internalData), {},
EditorManager::AllowExternalEditor);
}
if (selection.linkForEditor)
EditorManager::openEditor(selection);
}
WorkspaceLocatorFilter::WorkspaceLocatorFilter()
@@ -299,7 +291,6 @@ QList<LocatorFilterEntry> WorkspaceLocatorFilter::matchesFor(
locker.relock();
}
if (!m_filterKinds.isEmpty()) {
m_results = Utils::filtered(m_results, [&](const SymbolInfoWithPathMapper &info) {
return m_filterKinds.contains(SymbolKind(info.symbol.kind()));
@@ -316,10 +307,7 @@ void WorkspaceLocatorFilter::accept(const LocatorFilterEntry &selection,
int * /*selectionStart*/,
int * /*selectionLength*/) const
{
if (selection.internalData.canConvert<Utils::Link>()) {
EditorManager::openEditorAt(qvariant_cast<Utils::Link>(selection.internalData), {},
EditorManager::AllowExternalEditor);
}
EditorManager::openEditor(selection);
}
void WorkspaceLocatorFilter::handleResponse(Client *client,

1
src/plugins/languageclient/locatorfilter.h
View File

@@ -42,6 +42,7 @@ protected:
QPointer<DocumentSymbolCache> m_symbolCache;
LanguageServerProtocol::DocumentUri m_currentUri;
Utils::FilePath m_currentFilePath;
private:
void updateSymbols(const LanguageServerProtocol::DocumentUri &uri,

4
src/plugins/modeleditor/elementtasks.cpp
View File

@@ -136,10 +136,8 @@ void ElementTasks::openClassDefinition(const qmt::MElement *element)
CppEditor::IndexItem::Ptr info = qvariant_cast<CppEditor::IndexItem::Ptr>(entry.internalData);
if (info->scopedSymbolName() != qualifiedClassName)
continue;
if (EditorManager::instance()->openEditorAt(
{info->filePath(), info->line(), info->column()})) {
if (EditorManager::openEditor(entry))
return;
}
}
}
}

4
src/plugins/qmljstools/qmljsfunctionfilter.cpp
View File

@@ -52,6 +52,7 @@ QList<LocatorFilterEntry> FunctionFilter::matchesFor(QFutureInterface<LocatorFil
if (match.hasMatch()) {
QVariant id = QVariant::fromValue(info);
LocatorFilterEntry filterEntry(this, info.displayName, id/*, info.icon*/);
filterEntry.linkForEditor = {info.fileName, info.line, info.column};
filterEntry.extraInfo = info.extraInfo;
filterEntry.highlightInfo = highlightInfo(match);
@@ -78,6 +79,5 @@ void FunctionFilter::accept(const LocatorFilterEntry &selection,
Q_UNUSED(newText)
Q_UNUSED(selectionStart)
Q_UNUSED(selectionLength)
const LocatorData::Entry entry = qvariant_cast<LocatorData::Entry>(selection.internalData);
EditorManager::openEditorAt({entry.fileName, entry.line, entry.column});
EditorManager::openEditor(selection);
}