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

LocatorFilterEntry: Discourage the use of internalData

Browse Source 
Drop internalData from c'tor. The internalData is going to be
removed, soon. Drop also the icon arg from c'tor since
LocatorFilterEntry instances are usually created in non-main
thread, while operating on QIcon instances isn't really safe
in non-main thread. The use of QIcon inside this struct is
a subject to change in the future, in a way like it was done
in other parts of code that generated icons from non-main thread.

Change-Id: Ic6aa719a64e5fbd65883c54149796057c632780e
Reviewed-by: David Schulz <david.schulz@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
This commit is contained in:
Jarek Kobus
2023-03-21 00:07:22 +01:00
parent 79c8e60a22
commit a22e3acf28
12 changed files with 49 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/plugins/bookmarks/bookmarkfilter.cpp
View File

@@ -59,8 +59,8 @@ void BookmarkFilter::prepareSearch(const QString &entry)
const Bookmark *bookmark = m_manager->bookmarkForIndex(idx);
const QString filename = bookmark->filePath().fileName();
LocatorFilterEntry filterEntry(this,
QString("%1:%2").arg(filename).arg(bookmark->lineNumber()),
QVariant::fromValue(idx));
QString("%1:%2").arg(filename).arg(bookmark->lineNumber()));
filterEntry.internalData = QVariant::fromValue(idx);
if (!bookmark->note().isEmpty())
filterEntry.extraInfo = bookmark->note();
else if (!bookmark->lineText().isEmpty())

14
src/plugins/coreplugin/actionsfilter.cpp
View File

@@ -215,7 +215,9 @@ void ActionsFilter::collectEntriesForAction(QAction *action,
}
} else if (!text.isEmpty()) {
const ActionFilterEntryData data{action, {}};
LocatorFilterEntry filterEntry(this, text, QVariant::fromValue(data), action->icon());
LocatorFilterEntry filterEntry(this, text);
filterEntry.internalData = QVariant::fromValue(data);
filterEntry.displayIcon = action->icon();
filterEntry.extraInfo = path.join(" > ");
updateEntry(action, filterEntry);
}
@@ -241,8 +243,10 @@ void ActionsFilter::collectEntriesForCommands()
const QString identifier = command->id().toString();
const QStringList path = identifier.split(QLatin1Char('.'));
const ActionFilterEntryData data{action, command->id()};
LocatorFilterEntry filterEntry(this, text, QVariant::fromValue(data), action->icon());
const ActionFilterEntryData data{};
LocatorFilterEntry filterEntry(this, text);
filterEntry.internalData = QVariant::fromValue(ActionFilterEntryData{action, command->id()});
filterEntry.displayIcon = action->icon();
filterEntry.displayExtra = command->keySequence().toString(QKeySequence::NativeText);
if (path.size() >= 2)
filterEntry.extraInfo = path.mid(0, path.size() - 1).join(" > ");
@@ -260,7 +264,9 @@ void ActionsFilter::collectEntriesForLastTriggered()
if (!data.action || !m_enabledActions.contains(data.action))
continue;
const QString text = actionText(data.action);
LocatorFilterEntry filterEntry(this, text, QVariant::fromValue(data), data.action->icon());
LocatorFilterEntry filterEntry(this, text);
filterEntry.internalData = QVariant::fromValue(data);
filterEntry.displayIcon = data.action->icon();
updateEntry(data.action, filterEntry);
}
}

3
src/plugins/coreplugin/locator/commandlocator.cpp
View File

@@ -77,7 +77,8 @@ QList<LocatorFilterEntry> CommandLocator::matchesFor(QFutureInterface<LocatorFil
const QString text = Utils::stripAccelerator(pair.second);
const int index = text.indexOf(entry, 0, entryCaseSensitivity);
if (index >= 0) {
LocatorFilterEntry filterEntry(this, text, QVariant(pair.first));
LocatorFilterEntry filterEntry(this, text);
filterEntry.internalData = QVariant(pair.first);
filterEntry.highlightInfo = {index, int(entry.length())};
if (index == 0)

5
src/plugins/coreplugin/locator/externaltoolsfilter.cpp
View File

@@ -66,7 +66,8 @@ void ExternalToolsFilter::prepareSearch(const QString &entry)
}
if (index >= 0) {
LocatorFilterEntry filterEntry(this, tool->displayName(), QVariant::fromValue(tool));
LocatorFilterEntry filterEntry(this, tool->displayName());
filterEntry.internalData = QVariant::fromValue(tool);
filterEntry.extraInfo = tool->description();
filterEntry.highlightInfo = LocatorFilterEntry::HighlightInfo(index, entry.length(), hDataType);
@@ -78,7 +79,7 @@ void ExternalToolsFilter::prepareSearch(const QString &entry)
goodEntries.append(filterEntry);
}
}
LocatorFilterEntry configEntry(this, "Configure External Tool...", {});
LocatorFilterEntry configEntry(this, "Configure External Tool...");
configEntry.extraInfo = "Opens External Tool settings";
m_results = {};
m_results << bestEntries << betterEntries << goodEntries << configEntry;

9
src/plugins/coreplugin/locator/ilocatorfilter.h
View File

@@ -72,14 +72,9 @@ public:
LocatorFilterEntry() = default;
LocatorFilterEntry(ILocatorFilter *fromFilter,
const QString &name,
const QVariant &data = {},
std::optional<QIcon> icon = std::nullopt)
LocatorFilterEntry(ILocatorFilter *fromFilter, const QString &name)
: filter(fromFilter)
, displayName(name)
, internalData(data)
, displayIcon(icon)
{}
/* backpointer to creating filter */
@@ -93,7 +88,7 @@ public:
/* additional tooltip */
QString toolTip;
/* can be used by the filter to save more information about the entry */
QVariant internalData;
QVariant internalData; // DON'T USE IN NEW CODE, IT'S GOING TO BE REMOVED, SOON...
/* icon to display along with the entry */
std::optional<QIcon> displayIcon;
/* file path, if the entry is related to a file, is used e.g. for resolving a file icon */

16
src/plugins/coreplugin/locator/javascriptfilter.cpp
View File

@@ -52,17 +52,25 @@ QList<LocatorFilterEntry> JavaScriptFilter::matchesFor(
QList<LocatorFilterEntry> entries;
if (entry.trimmed().isEmpty()) {
entries.append({this, Tr::tr("Reset Engine"), QVariant::fromValue(EngineAction::Reset)});
LocatorFilterEntry entry{this, Tr::tr("Reset Engine")};
entry.internalData = QVariant::fromValue(EngineAction::Reset);
entries.append(entry);
} else {
const QString result = m_engine->evaluate(entry).toString();
if (m_aborted) {
const QString message = entry + " = " + Tr::tr("Engine aborted after timeout.");
entries.append({this, message, QVariant::fromValue(EngineAction::Abort)});
LocatorFilterEntry entry(this, message);
entry.internalData = QVariant::fromValue(EngineAction::Abort);
entries.append(entry);
} else {
const QString expression = entry + " = " + result;
entries.append({this, expression});
entries.append({this, Tr::tr("Copy to clipboard: %1").arg(result), result});
entries.append({this, Tr::tr("Copy to clipboard: %1").arg(expression), expression});
LocatorFilterEntry resultEntry(this, Tr::tr("Copy to clipboard: %1").arg(result));
resultEntry.internalData = result;
entries.append(resultEntry);
LocatorFilterEntry expressionEntry(this, Tr::tr("Copy to clipboard: %1").arg(expression));
resultEntry.internalData = expression;
entries.append(expressionEntry);
}
}

7
src/plugins/coreplugin/locator/locatorfiltersfilter.cpp
View File

@@ -60,10 +60,9 @@ QList<LocatorFilterEntry> LocatorFiltersFilter::matchesFor(QFutureInterface<Loca
for (int i = 0; i < m_filterShortcutStrings.size(); ++i) {
if (future.isCanceled())
break;
LocatorFilterEntry filterEntry(this,
m_filterShortcutStrings.at(i),
i,
m_icon);
LocatorFilterEntry filterEntry(this, m_filterShortcutStrings.at(i));
filterEntry.internalData = i;
filterEntry.displayIcon = m_icon;
filterEntry.extraInfo = m_filterDisplayNames.at(i);
filterEntry.toolTip = m_filterDescriptions.at(i);
filterEntry.displayExtra = m_filterKeyboardShortcuts.at(i);

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

@@ -87,7 +87,8 @@ QList<LocatorFilterEntry> CppCurrentDocumentFilter::matchesFor(
}
}
LocatorFilterEntry filterEntry(this, name, {}, info->icon());
LocatorFilterEntry filterEntry(this, name);
filterEntry.displayIcon = info->icon();
filterEntry.linkForEditor = {info->filePath(), info->line(), info->column()};
filterEntry.extraInfo = extraInfo;
if (match.hasMatch()) {

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

@@ -25,7 +25,8 @@ CppLocatorFilter::CppLocatorFilter()
LocatorFilterEntry CppLocatorFilter::filterEntryFromIndexItem(IndexItem::Ptr info)
{
LocatorFilterEntry filterEntry(this, info->scopedSymbolName(), {}, info->icon());
LocatorFilterEntry filterEntry(this, info->scopedSymbolName());
filterEntry.displayIcon = info->icon();
filterEntry.linkForEditor = {info->filePath(), info->line(), info->column()};
if (info->type() == IndexItem::Class || info->type() == IndexItem::Enum)
filterEntry.extraInfo = info->shortNativeFilePath();
@@ -120,7 +121,8 @@ CppClassesFilter::CppClassesFilter()
LocatorFilterEntry CppClassesFilter::filterEntryFromIndexItem(IndexItem::Ptr info)
{
LocatorFilterEntry filterEntry(this, info->symbolName(), {}, info->icon());
LocatorFilterEntry filterEntry(this, info->symbolName());
filterEntry.displayIcon = info->icon();
filterEntry.linkForEditor = {info->filePath(), info->line(), info->column()};
filterEntry.extraInfo = info->symbolScope().isEmpty()
? info->shortNativeFilePath()
@@ -148,7 +150,8 @@ LocatorFilterEntry CppFunctionsFilter::filterEntryFromIndexItem(IndexItem::Ptr i
extraInfo.append(" (" + info->filePath().fileName() + ')');
}
LocatorFilterEntry filterEntry(this, name + info->symbolType(), {}, info->icon());
LocatorFilterEntry filterEntry(this, name + info->symbolType());
filterEntry.displayIcon = info->icon();
filterEntry.linkForEditor = {info->filePath(), info->line(), info->column()};
filterEntry.extraInfo = extraInfo;

3
src/plugins/help/helpindexfilter.cpp
View File

@@ -78,7 +78,8 @@ QList<LocatorFilterEntry> HelpIndexFilter::matchesFor(QFutureInterface<LocatorFi
QList<LocatorFilterEntry> entries;
for (const QString &keyword : std::as_const(m_lastIndicesCache)) {
const int index = keyword.indexOf(entry, 0, cs);
LocatorFilterEntry filterEntry(this, keyword, {}, m_icon);
LocatorFilterEntry filterEntry(this, keyword);
filterEntry.displayIcon = m_icon;
filterEntry.highlightInfo = {index, int(entry.length())};
entries.append(filterEntry);
}

3
src/plugins/macros/macrolocatorfilter.cpp
View File

@@ -50,7 +50,8 @@ QList<Core::LocatorFilterEntry> MacroLocatorFilter::matchesFor(QFutureInterface<
}
if (index >= 0) {
Core::LocatorFilterEntry filterEntry(this, displayName, {}, m_icon);
Core::LocatorFilterEntry filterEntry(this, displayName);
filterEntry.displayIcon = m_icon;
filterEntry.extraInfo = description;
filterEntry.highlightInfo = Core::LocatorFilterEntry::HighlightInfo(index, entry.length(), hDataType);

4
src/plugins/texteditor/linenumberfilter.cpp
View File

@@ -64,7 +64,9 @@ QList<LocatorFilterEntry> LineNumberFilter::matchesFor(QFutureInterface<LocatorF
text = Tr::tr("Line %1").arg(line);
else
text = Tr::tr("Column %1").arg(column);
value.append(LocatorFilterEntry(this, text, QVariant::fromValue(data)));
LocatorFilterEntry entry(this, text);
entry.internalData = QVariant::fromValue(data);
value.append(entry);
}
return value;
}