sammccall created this revision.
sammccall added a reviewer: kadircet.
Herald added subscribers: usaxena95, arphaman.
sammccall requested review of this revision.
Herald added subscribers: cfe-commits, MaskRay, ilya-biryukov.
Herald added a project: clang.
Capability is in upcoming 3.17:
https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/
(This is also useful for C++ embedders)
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D98414
Files:
clang-tools-extra/clangd/ClangdLSPServer.cpp
clang-tools-extra/clangd/ClangdServer.cpp
clang-tools-extra/clangd/ClangdServer.h
clang-tools-extra/clangd/Protocol.cpp
clang-tools-extra/clangd/Protocol.h
Index: clang-tools-extra/clangd/Protocol.h
===================================================================
--- clang-tools-extra/clangd/Protocol.h
+++ clang-tools-extra/clangd/Protocol.h
@@ -475,6 +475,10 @@
/// window.implicitWorkDoneProgressCreate
bool ImplicitProgressCreation = false;
+ /// Whether the client claims to cancel stale requests.
+ /// general.staleRequestSupport.cancel
+ bool CancelsStaleRequests = false;
+
/// Whether the client implementation supports a refresh request sent from the
/// server to the client.
bool SemanticTokenRefreshSupport = false;
Index: clang-tools-extra/clangd/Protocol.cpp
===================================================================
--- clang-tools-extra/clangd/Protocol.cpp
+++ clang-tools-extra/clangd/Protocol.cpp
@@ -414,6 +414,12 @@
if (auto Implicit = Window->getBoolean("implicitWorkDoneProgressCreate"))
R.ImplicitProgressCreation = *Implicit;
}
+ if (auto *General = O->getObject("general")) {
+ if (auto *StaleRequestSupport = General->getObject("staleRequestSupport")) {
+ if (auto Cancel = StaleRequestSupport->getBoolean("cancel"))
+ R.CancelsStaleRequests = *Cancel;
+ }
+ }
if (auto *OffsetEncoding = O->get("offsetEncoding")) {
R.offsetEncoding.emplace();
if (!fromJSON(*OffsetEncoding, *R.offsetEncoding,
Index: clang-tools-extra/clangd/ClangdServer.h
===================================================================
--- clang-tools-extra/clangd/ClangdServer.h
+++ clang-tools-extra/clangd/ClangdServer.h
@@ -146,6 +146,12 @@
/*RebuildRatio=*/1,
};
+ /// Cancel certain requests if the file changes before they begin running.
+ /// This is useful for "transient" actions like enumerateTweaks that were
+ /// likely implicitly generated, and avoids redundant work if clients forget
+ /// to cancel. Clients that always cancel stale requests should clear this.
+ bool ImplicitCancellation = true;
+
/// Clangd will execute compiler drivers matching one of these globs to
/// fetch system include path.
std::vector<std::string> QueryDriverGlobs;
@@ -391,6 +397,8 @@
llvm::Optional<std::string> WorkspaceRoot;
llvm::Optional<TUScheduler> WorkScheduler;
+ // Invalidation policy used for actions that we assume are "transient".
+ TUScheduler::ASTActionInvalidation Transient;
// Store of the current versions of the open documents.
// Only written from the main thread (despite being threadsafe).
Index: clang-tools-extra/clangd/ClangdServer.cpp
===================================================================
--- clang-tools-extra/clangd/ClangdServer.cpp
+++ clang-tools-extra/clangd/ClangdServer.cpp
@@ -150,6 +150,8 @@
DynamicIdx(Opts.BuildDynamicSymbolIndex ? new FileIndex() : nullptr),
ClangTidyProvider(Opts.ClangTidyProvider),
WorkspaceRoot(Opts.WorkspaceRoot),
+ Transient(Opts.ImplicitCancellation ? TUScheduler::InvalidateOnUpdate
+ : TUScheduler::NoInvalidation),
DirtyFS(std::make_unique<DraftStoreFS>(TFS, DraftMgr)) {
// Pass a callback into `WorkScheduler` to extract symbols from a newly
// parsed file and rebuild the file index synchronously each time an AST
@@ -592,7 +594,7 @@
};
WorkScheduler->runWithAST("EnumerateTweaks", File, std::move(Action),
- TUScheduler::InvalidateOnUpdate);
+ Transient);
}
void ClangdServer::applyTweak(PathRef File, Range Sel, StringRef TweakID,
@@ -682,8 +684,7 @@
CB(clangd::findDocumentHighlights(InpAST->AST, Pos));
};
- WorkScheduler->runWithAST("Highlights", File, std::move(Action),
- TUScheduler::InvalidateOnUpdate);
+ WorkScheduler->runWithAST("Highlights", File, std::move(Action), Transient);
}
void ClangdServer::findHover(PathRef File, Position Pos,
@@ -697,8 +698,7 @@
CB(clangd::getHover(InpAST->AST, Pos, std::move(Style), Index));
};
- WorkScheduler->runWithAST("Hover", File, std::move(Action),
- TUScheduler::InvalidateOnUpdate);
+ WorkScheduler->runWithAST("Hover", File, std::move(Action), Transient);
}
void ClangdServer::typeHierarchy(PathRef File, Position Pos, int Resolve,
@@ -770,7 +770,7 @@
CB(clangd::getDocumentSymbols(InpAST->AST));
};
WorkScheduler->runWithAST("DocumentSymbols", File, std::move(Action),
- TUScheduler::InvalidateOnUpdate);
+ Transient);
}
void ClangdServer::foldingRanges(llvm::StringRef File,
@@ -782,7 +782,7 @@
CB(clangd::getFoldingRanges(InpAST->AST));
};
WorkScheduler->runWithAST("FoldingRanges", File, std::move(Action),
- TUScheduler::InvalidateOnUpdate);
+ Transient);
}
void ClangdServer::findImplementations(
@@ -849,7 +849,7 @@
CB(clangd::getDocumentLinks(InpAST->AST));
};
WorkScheduler->runWithAST("DocumentLinks", File, std::move(Action),
- TUScheduler::InvalidateOnUpdate);
+ Transient);
}
void ClangdServer::semanticHighlights(
@@ -861,7 +861,7 @@
CB(clangd::getSemanticHighlightings(InpAST->AST));
};
WorkScheduler->runWithAST("SemanticHighlights", File, std::move(Action),
- TUScheduler::InvalidateOnUpdate);
+ Transient);
}
void ClangdServer::getAST(PathRef File, Range R,
Index: clang-tools-extra/clangd/ClangdLSPServer.cpp
===================================================================
--- clang-tools-extra/clangd/ClangdLSPServer.cpp
+++ clang-tools-extra/clangd/ClangdLSPServer.cpp
@@ -519,6 +519,7 @@
if (Params.capabilities.WorkDoneProgress)
BackgroundIndexProgressState = BackgroundIndexProgress::Empty;
BackgroundIndexSkipCreate = Params.capabilities.ImplicitProgressCreation;
+ Opts.ImplicitCancellation = !Params.capabilities.CancelsStaleRequests;
llvm::json::Object ServerCaps{
{"textDocumentSync",
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
