blob: 4c195df6f893c4737fbc2a9f18e34c4f28ee6291 [file] [log] [blame]
//===--- ClangdLSPServer.h - LSP server --------------------------*- C++-*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "ClangdServer.h"
#include "DraftStore.h"
#include "FindSymbols.h"
#include "GlobalCompilationDatabase.h"
#include "LSPBinder.h"
#include "Protocol.h"
#include "Transport.h"
#include "support/Context.h"
#include "support/MemoryTree.h"
#include "support/Path.h"
#include "support/Threading.h"
#include "clang/Tooling/Core/Replacement.h"
#include "llvm/ADT/Optional.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/Support/JSON.h"
#include <chrono>
#include <cstddef>
#include <memory>
namespace clang {
namespace clangd {
class SymbolIndex;
/// This class exposes ClangdServer's capabilities via Language Server Protocol.
/// MessageHandler binds the implemented LSP methods (e.g. onInitialize) to
/// corresponding JSON-RPC methods ("initialize").
/// The server also supports $/cancelRequest (MessageHandler provides this).
class ClangdLSPServer : private ClangdServer::Callbacks,
private LSPBinder::RawOutgoing {
struct Options : ClangdServer::Options {
/// Supplies configuration (overrides ClangdServer::ContextProvider).
config::Provider *ConfigProvider = nullptr;
/// Look for compilation databases, rather than using compile commands
/// set via LSP (extensions) only.
bool UseDirBasedCDB = true;
/// The offset-encoding to use, or None to negotiate it over LSP.
llvm::Optional<OffsetEncoding> Encoding;
/// If set, periodically called to release memory.
/// Consider malloc_trim(3)
std::function<void()> MemoryCleanup = nullptr;
/// Per-feature options. Generally ClangdServer lets these vary
/// per-request, but LSP allows limited/no customizations.
clangd::CodeCompleteOptions CodeComplete;
clangd::RenameOptions Rename;
/// Returns true if the tweak should be enabled.
std::function<bool(const Tweak &)> TweakFilter = [](const Tweak &T) {
return !T.hidden(); // only enable non-hidden tweaks.
/// Enable preview of InlayHints feature.
bool InlayHints = false;
/// Limit the number of references returned (0 means no limit).
size_t ReferencesLimit = 0;
ClangdLSPServer(Transport &Transp, const ThreadsafeFS &TFS,
const ClangdLSPServer::Options &Opts);
/// The destructor blocks on any outstanding background tasks.
/// Run LSP server loop, communicating with the Transport provided in the
/// constructor. This method must not be executed more than once.
/// \return Whether we shut down cleanly with a 'shutdown' -> 'exit' sequence.
bool run();
/// Profiles resource-usage.
void profile(MemoryTree &MT) const;
// Implement ClangdServer::Callbacks.
void onDiagnosticsReady(PathRef File, llvm::StringRef Version,
std::vector<Diag> Diagnostics) override;
void onFileUpdated(PathRef File, const TUStatus &Status) override;
void onBackgroundIndexProgress(const BackgroundQueue::Stats &Stats) override;
void onSemanticsMaybeChanged(PathRef File) override;
// LSP methods. Notifications have signature void(const Params&).
// Calls have signature void(const Params&, Callback<Response>).
void onInitialize(const InitializeParams &, Callback<llvm::json::Value>);
void onInitialized(const InitializedParams &);
void onShutdown(const NoParams &, Callback<std::nullptr_t>);
void onSync(const NoParams &, Callback<std::nullptr_t>);
void onDocumentDidOpen(const DidOpenTextDocumentParams &);
void onDocumentDidChange(const DidChangeTextDocumentParams &);
void onDocumentDidClose(const DidCloseTextDocumentParams &);
void onDocumentDidSave(const DidSaveTextDocumentParams &);
void onAST(const ASTParams &, Callback<llvm::Optional<ASTNode>>);
void onDocumentOnTypeFormatting(const DocumentOnTypeFormattingParams &,
void onDocumentRangeFormatting(const DocumentRangeFormattingParams &,
void onDocumentFormatting(const DocumentFormattingParams &,
// The results are serialized 'vector<DocumentSymbol>' if
// SupportsHierarchicalDocumentSymbol is true and 'vector<SymbolInformation>'
// otherwise.
void onDocumentSymbol(const DocumentSymbolParams &,
void onFoldingRange(const FoldingRangeParams &,
void onCodeAction(const CodeActionParams &, Callback<llvm::json::Value>);
void onCompletion(const CompletionParams &, Callback<CompletionList>);
void onSignatureHelp(const TextDocumentPositionParams &,
void onGoToDeclaration(const TextDocumentPositionParams &,
void onGoToDefinition(const TextDocumentPositionParams &,
void onGoToImplementation(const TextDocumentPositionParams &,
void onReference(const ReferenceParams &, Callback<std::vector<Location>>);
void onSwitchSourceHeader(const TextDocumentIdentifier &,
void onDocumentHighlight(const TextDocumentPositionParams &,
void onFileEvent(const DidChangeWatchedFilesParams &);
void onWorkspaceSymbol(const WorkspaceSymbolParams &,
void onPrepareRename(const TextDocumentPositionParams &,
void onRename(const RenameParams &, Callback<WorkspaceEdit>);
void onHover(const TextDocumentPositionParams &,
void onTypeHierarchy(const TypeHierarchyParams &,
void onResolveTypeHierarchy(const ResolveTypeHierarchyItemParams &,
void onPrepareCallHierarchy(const CallHierarchyPrepareParams &,
void onCallHierarchyIncomingCalls(
const CallHierarchyIncomingCallsParams &,
void onCallHierarchyOutgoingCalls(
const CallHierarchyOutgoingCallsParams &,
void onInlayHints(const InlayHintsParams &, Callback<std::vector<InlayHint>>);
void onChangeConfiguration(const DidChangeConfigurationParams &);
void onSymbolInfo(const TextDocumentPositionParams &,
void onSelectionRange(const SelectionRangeParams &,
void onDocumentLink(const DocumentLinkParams &,
void onSemanticTokens(const SemanticTokensParams &, Callback<SemanticTokens>);
void onSemanticTokensDelta(const SemanticTokensDeltaParams &,
/// This is a clangd extension. Provides a json tree representing memory usage
/// hierarchy.
void onMemoryUsage(const NoParams &, Callback<MemoryTree>);
void onCommand(const ExecuteCommandParams &, Callback<llvm::json::Value>);
/// Implement commands.
void onCommandApplyEdit(const WorkspaceEdit &, Callback<llvm::json::Value>);
void onCommandApplyTweak(const TweakArgs &, Callback<llvm::json::Value>);
/// Outgoing LSP calls.
LSPBinder::OutgoingNotification<ShowMessageParams> ShowMessage;
LSPBinder::OutgoingNotification<PublishDiagnosticsParams> PublishDiagnostics;
LSPBinder::OutgoingNotification<FileStatus> NotifyFileStatus;
LSPBinder::OutgoingMethod<WorkDoneProgressCreateParams, std::nullptr_t>
LSPBinder::OutgoingMethod<NoParams, std::nullptr_t> SemanticTokensRefresh;
void applyEdit(WorkspaceEdit WE, llvm::json::Value Success,
Callback<llvm::json::Value> Reply);
void bindMethods(LSPBinder &, const ClientCapabilities &Caps);
std::vector<Fix> getFixes(StringRef File, const clangd::Diagnostic &D);
/// Checks if completion request should be ignored. We need this due to the
/// limitation of the LSP. Per LSP, a client sends requests for all "trigger
/// character" we specify, but for '>' and ':' we need to check they actually
/// produce '->' and '::', respectively.
bool shouldRunCompletion(const CompletionParams &Params) const;
void applyConfiguration(const ConfigurationSettings &Settings);
/// Runs profiling and exports memory usage metrics if tracing is enabled and
/// profiling hasn't happened recently.
void maybeExportMemoryProfile();
PeriodicThrottler ShouldProfile;
/// Run the MemoryCleanup callback if it's time.
/// This method is thread safe.
void maybeCleanupMemory();
PeriodicThrottler ShouldCleanupMemory;
/// Since initialization of CDBs and ClangdServer is done lazily, the
/// following context captures the one used while creating ClangdLSPServer and
/// passes it to above mentioned object instances to make sure they share the
/// same state.
Context BackgroundContext;
/// Used to indicate that the 'shutdown' request was received from the
/// Language Server client.
bool ShutdownRequestReceived = false;
/// Used to indicate the ClangdLSPServer is being destroyed.
std::atomic<bool> IsBeingDestroyed = {false};
std::mutex FixItsMutex;
typedef std::map<clangd::Diagnostic, std::vector<Fix>, LSPDiagnosticCompare>
/// Caches FixIts per file and diagnostics
llvm::StringMap<DiagnosticToReplacementMap> FixItsMap;
// Last semantic-tokens response, for incremental requests.
std::mutex SemanticTokensMutex;
llvm::StringMap<SemanticTokens> LastSemanticTokens;
// Most code should not deal with Transport, callMethod, notify directly.
// Use LSPBinder to handle incoming and outgoing calls.
clangd::Transport &Transp;
class MessageHandler;
std::unique_ptr<MessageHandler> MsgHandler;
std::mutex TranspWriter;
void callMethod(StringRef Method, llvm::json::Value Params,
Callback<llvm::json::Value> CB) override;
void notify(StringRef Method, llvm::json::Value Params) override;
LSPBinder::RawHandlers Handlers;
const ThreadsafeFS &TFS;
/// Options used for diagnostics.
ClangdDiagnosticOptions DiagOpts;
/// The supported kinds of the client.
SymbolKindBitset SupportedSymbolKinds;
/// The supported completion item kinds of the client.
CompletionItemKindBitset SupportedCompletionItemKinds;
/// Whether the client supports CodeAction response objects.
bool SupportsCodeAction = false;
/// From capabilities of textDocument/documentSymbol.
bool SupportsHierarchicalDocumentSymbol = false;
/// Whether the client supports showing file status.
bool SupportFileStatus = false;
/// Which kind of markup should we use in textDocument/hover responses.
MarkupKind HoverContentFormat = MarkupKind::PlainText;
/// Whether the client supports offsets for parameter info labels.
bool SupportsOffsetsInSignatureHelp = false;
std::mutex BackgroundIndexProgressMutex;
enum class BackgroundIndexProgress {
// Client doesn't support reporting progress. No transitions possible.
// The queue is idle, and the client has no progress bar.
// Can transition to Creating when we have some activity.
// We've requested the client to create a progress bar.
// Meanwhile, the state is buffered in PendingBackgroundIndexProgress.
// The client has a progress bar, and we can send it updates immediately.
} BackgroundIndexProgressState = BackgroundIndexProgress::Unsupported;
// The progress to send when the progress bar is created.
// Only valid in state Creating.
BackgroundQueue::Stats PendingBackgroundIndexProgress;
/// LSP extension: skip WorkDoneProgressCreate, just send progress streams.
bool BackgroundIndexSkipCreate = false;
Options Opts;
// The CDB is created by the "initialize" LSP method.
std::unique_ptr<GlobalCompilationDatabase> BaseCDB;
// CDB is BaseCDB plus any commands overridden via LSP extensions.
llvm::Optional<OverlayCDB> CDB;
// The ClangdServer is created by the "initialize" LSP method.
llvm::Optional<ClangdServer> Server;
} // namespace clangd
} // namespace clang