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

ClangCodeModel: Allow more than one in-flight "follow symbol"

Browse Source 
The original code was written with only the interactive case in mind, but
nowadays we also start "follow symbol" operations internally as part of
e.g. quickfixes.

Change-Id: I95928297fab16f9b0469bfd66ad687447b902fd9
Reviewed-by: David Schulz <david.schulz@qt.io>
This commit is contained in:
Christian Kandeler
2024-05-24 13:52:27 +02:00
parent b0354eaf16
commit 0e301004b8
10 changed files with 71 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
src/plugins/clangcodemodel/clangdclient.cpp
View File

@@ -349,7 +349,7 @@ public:
ClangdClient * const q;
const CppEditor::ClangdSettings::Data settings;
ClangdFollowSymbol *followSymbol = nullptr;
QList<ClangdFollowSymbol *> followSymbolOps;
ClangdSwitchDeclDef *switchDeclDef = nullptr;
ClangdFindLocalReferences *findLocalRefs = nullptr;
std::optional<QVersionNumber> versionNumber;
@@ -501,8 +501,8 @@ ClangdClient::ClangdClient(Project *project, const Utils::FilePath &jsonDbDir, c
ClangdClient::~ClangdClient()
{
if (d->followSymbol)
d->followSymbol->clear();
for (ClangdFollowSymbol * const followSymbol : std::as_const(d->followSymbolOps))
followSymbol->clear();
delete d;
}
@@ -990,7 +990,7 @@ MessageId ClangdClient::requestSymbolInfo(const Utils::FilePath &filePath, const
#ifdef WITH_TESTS
ClangdFollowSymbol *ClangdClient::currentFollowSymbolOperation()
{
return d->followSymbol;
return d->followSymbolOps.isEmpty() ? nullptr : d->followSymbolOps.first();
}
#endif
@@ -1005,8 +1005,20 @@ void ClangdClient::followSymbol(TextDocument *document,
{
QTC_ASSERT(documentOpen(document), openDocument(document));
if (d->followSymbol)
d->followSymbol->cancel();
const ClangdFollowSymbol::Origin origin
= CppEditor::CppCodeModelSettings::isInteractiveFollowSymbol()
? ClangdFollowSymbol::Origin::User
: ClangdFollowSymbol::Origin::Code;
if (origin == ClangdFollowSymbol::Origin::User) {
for (auto it = d->followSymbolOps.begin(); it != d->followSymbolOps.end(); ) {
if ((*it)->isInteractive()) {
(*it)->cancel();
it = d->followSymbolOps.erase(it);
} else {
++it;
}
}
}
const QTextCursor adjustedCursor = d->adjustedCursor(cursor, document);
if (followTo == FollowTo::SymbolDef && !resolveTarget) {
@@ -1020,14 +1032,13 @@ void ClangdClient::followSymbol(TextDocument *document,
qCDebug(clangdLog) << "follow symbol requested" << document->filePath()
<< adjustedCursor.blockNumber() << adjustedCursor.positionInBlock();
auto clangdFollowSymbol = new ClangdFollowSymbol(this, adjustedCursor, editorWidget, document,
callback, followTo, openInSplit);
auto clangdFollowSymbol = new ClangdFollowSymbol(this, origin, adjustedCursor, editorWidget,
document, callback, followTo, openInSplit);
connect(clangdFollowSymbol, &ClangdFollowSymbol::done, this, [this, clangdFollowSymbol] {
clangdFollowSymbol->deleteLater();
if (clangdFollowSymbol == d->followSymbol)
d->followSymbol = nullptr;
d->followSymbolOps.removeOne(clangdFollowSymbol);
});
d->followSymbol = clangdFollowSymbol;
d->followSymbolOps << clangdFollowSymbol;
}
void ClangdClient::switchDeclDef(TextDocument *document, const QTextCursor &cursor,

18
src/plugins/clangcodemodel/clangdfollowsymbol.cpp
View File

@@ -73,10 +73,10 @@ private:
class ClangdFollowSymbol::Private
{
public:
Private(ClangdFollowSymbol *q, ClangdClient *client, const QTextCursor &cursor,
Private(ClangdFollowSymbol *q, ClangdClient *client, Origin origin, const QTextCursor &cursor,
CppEditorWidget *editorWidget, const FilePath &filePath, const LinkHandler &callback,
bool openInSplit)
: q(q), client(client), cursor(cursor), editorWidget(editorWidget),
: q(q), client(client), origin(origin), cursor(cursor), editorWidget(editorWidget),
uri(client->hostPathToServerUri(filePath)), callback(callback),
virtualFuncAssistProvider(q),
docRevision(editorWidget ? editorWidget->textDocument()->document()->revision() : -1),
@@ -94,6 +94,7 @@ public:
ClangdFollowSymbol * const q;
ClangdClient * const client;
const Origin origin;
const QTextCursor cursor;
const QPointer<CppEditor::CppEditorWidget> editorWidget;
const DocumentUri uri;
@@ -117,11 +118,11 @@ public:
bool done = false;
};
ClangdFollowSymbol::ClangdFollowSymbol(ClangdClient *client, const QTextCursor &cursor,
CppEditorWidget *editorWidget, TextDocument *document, const LinkHandler &callback,
FollowTo followTo, bool openInSplit)
ClangdFollowSymbol::ClangdFollowSymbol(ClangdClient *client, Origin origin,
const QTextCursor &cursor, CppEditorWidget *editorWidget, TextDocument *document,
const LinkHandler &callback, FollowTo followTo, bool openInSplit)
: QObject(client),
d(new Private(this, client, cursor, editorWidget, document->filePath(), callback,
d(new Private(this, client, origin, cursor, editorWidget, document->filePath(), callback,
openInSplit))
{
// Abort if the user does something else with the document in the meantime.
@@ -193,6 +194,11 @@ void ClangdFollowSymbol::clear()
d->pendingGotoDefRequests.clear();
}
bool ClangdFollowSymbol::isInteractive() const
{
return d->origin == Origin::User;
}
void ClangdFollowSymbol::emitDone(const Link &link)
{
if (d->done)

6
src/plugins/clangcodemodel/clangdfollowsymbol.h
View File

@@ -23,7 +23,9 @@ class ClangdFollowSymbol : public QObject
{
Q_OBJECT
public:
ClangdFollowSymbol(ClangdClient *client, const QTextCursor &cursor,
enum class Origin { User, Code };
ClangdFollowSymbol(ClangdClient *client, Origin origin, const QTextCursor &cursor,
CppEditor::CppEditorWidget *editorWidget,
TextEditor::TextDocument *document, const Utils::LinkHandler &callback,
FollowTo followTo, bool openInSplit);
@@ -31,6 +33,8 @@ public:
void cancel();
void clear();
bool isInteractive() const;
signals:
void done();

11
src/plugins/cppeditor/cppcodemodelsettings.cpp
View File

@@ -83,6 +83,7 @@ bool operator==(const CppEditor::CppCodeModelSettings &s1,
&& s1.useBuiltinPreprocessor == s2.useBuiltinPreprocessor
&& s1.indexerFileSizeLimitInMb == s2.indexerFileSizeLimitInMb
&& s1.m_categorizeFindReferences == s2.m_categorizeFindReferences
&& s1.interactiveFollowSymbol == s2.interactiveFollowSymbol
&& s1.ignoreFiles == s2.ignoreFiles && s1.ignorePattern == s2.ignorePattern;
}
@@ -204,6 +205,16 @@ void CppCodeModelSettings::setCategorizeFindReferences(bool categorize)
globalInstance().m_categorizeFindReferences = categorize;
}
bool CppCodeModelSettings::isInteractiveFollowSymbol()
{
return globalInstance().interactiveFollowSymbol;
}
void CppCodeModelSettings::setInteractiveFollowSymbol(bool interactive)
{
globalInstance().interactiveFollowSymbol = interactive;
}
CppCodeModelProjectSettings::CppCodeModelProjectSettings(ProjectExplorer::Project *project)
: m_project(project)
{

16
src/plugins/cppeditor/cppcodemodelsettings.h
View File

@@ -55,6 +55,9 @@ public:
static bool categorizeFindReferences();
static void setCategorizeFindReferences(bool categorize);
static bool isInteractiveFollowSymbol();
static void setInteractiveFollowSymbol(bool interactive);
QString ignorePattern;
PCHUsage pchUsage = PchUse_BuildSystem;
int indexerFileSizeLimitInMb = 5;
@@ -63,7 +66,10 @@ public:
bool useBuiltinPreprocessor = true;
bool ignoreFiles = false;
bool enableIndexing = true;
bool m_categorizeFindReferences = false; // Ephemeral!
// Ephemeral!
bool m_categorizeFindReferences = false;
bool interactiveFollowSymbol = true;
private:
CppCodeModelSettings(Utils::QtcSettings *s) { fromSettings(s); }
@@ -76,6 +82,14 @@ private:
namespace Internal {
void setupCppCodeModelSettingsPage();
void setupCppCodeModelProjectSettingsPanel();
class NonInteractiveFollowSymbolMarker
{
public:
NonInteractiveFollowSymbolMarker() { CppCodeModelSettings::setInteractiveFollowSymbol(false); }
~NonInteractiveFollowSymbolMarker() { CppCodeModelSettings::setInteractiveFollowSymbol(true); }
};
} // namespace Internal
} // namespace CppEditor

1
src/plugins/cppeditor/cppeditorwidget.cpp
View File

@@ -623,6 +623,7 @@ void CppEditorWidget::renameUsages(const QString &replacement, QTextCursor curso
const CursorInEditor cursorInEditor{cursor, textDocument()->filePath(), this, textDocument()};
CppModelManager::globalRename(cursorInEditor, replacement);
};
NonInteractiveFollowSymbolMarker niMarker;
CppModelManager::followSymbol(CursorInEditor{cursor,
textDocument()->filePath(),
this,

1
src/plugins/cppeditor/quickfixes/createdeclarationfromuse.cpp
View File

@@ -370,6 +370,7 @@ private:
if (!link.hasValidTarget())
collectOperations(interface, result);
};
NonInteractiveFollowSymbolMarker niMarker;
CppModelManager::followSymbol(cursorInEditor, followSymbolFallback, false, false,
FollowSymbolMode::Exact,
CppModelManager::Backend::Builtin);

1
src/plugins/cppeditor/quickfixes/moveclasstoownfile.cpp
View File

@@ -294,6 +294,7 @@ private:
// Force queued execution, as the built-in editor can run the callback synchronously.
const auto followSymbol = [cursorInEditor, callback] {
NonInteractiveFollowSymbolMarker niMarker;
CppModelManager::followSymbol(
cursorInEditor, callback, true, false, FollowSymbolMode::Exact);
};

2
src/plugins/cppeditor/quickfixes/rewritecomment.cpp
View File

@@ -246,6 +246,8 @@ private:
(const Link &link) {
moveComments(link, symbolLoc, comments);
};
NonInteractiveFollowSymbolMarker niMarker;
CppCodeModelSettings::setInteractiveFollowSymbol(false);
CppModelManager::followSymbol(cursorInEditor, callback, true, false,
FollowSymbolMode::Exact);
}

1
src/plugins/cppeditor/quickfixes/synchronizememberfunctionorder.cpp
View File

@@ -120,6 +120,7 @@ private:
// Force queued execution, as the built-in editor can run the callback synchronously.
const auto followSymbol = [cursorInEditor, callback] {
NonInteractiveFollowSymbolMarker niMarker;
CppModelManager::followSymbol(
cursorInEditor, callback, true, false, FollowSymbolMode::Exact);
};