clang-tools 19.0.0git
ClangdServer.cpp
Go to the documentation of this file.
1//===--- ClangdServer.cpp - Main clangd server code --------------*- C++-*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===-------------------------------------------------------------------===//
8
9#include "ClangdServer.h"
10#include "CodeComplete.h"
11#include "Config.h"
12#include "Diagnostics.h"
13#include "DumpAST.h"
14#include "FindSymbols.h"
15#include "Format.h"
16#include "HeaderSourceSwitch.h"
17#include "InlayHints.h"
18#include "ParsedAST.h"
19#include "Preamble.h"
20#include "Protocol.h"
22#include "SemanticSelection.h"
23#include "SourceCode.h"
24#include "TUScheduler.h"
25#include "XRefs.h"
26#include "clang-include-cleaner/Record.h"
27#include "index/FileIndex.h"
28#include "index/Merge.h"
29#include "index/StdLib.h"
30#include "refactor/Rename.h"
31#include "refactor/Tweak.h"
33#include "support/Context.h"
34#include "support/Logger.h"
35#include "support/MemoryTree.h"
37#include "support/Trace.h"
38#include "clang/Basic/Stack.h"
39#include "clang/Format/Format.h"
40#include "clang/Lex/Preprocessor.h"
41#include "clang/Tooling/CompilationDatabase.h"
42#include "clang/Tooling/Core/Replacement.h"
43#include "llvm/ADT/ArrayRef.h"
44#include "llvm/ADT/STLExtras.h"
45#include "llvm/ADT/StringRef.h"
46#include "llvm/Support/Error.h"
47#include "llvm/Support/Path.h"
48#include "llvm/Support/raw_ostream.h"
49#include <algorithm>
50#include <chrono>
51#include <future>
52#include <memory>
53#include <mutex>
54#include <optional>
55#include <string>
56#include <type_traits>
57#include <utility>
58#include <vector>
59
60namespace clang {
61namespace clangd {
62namespace {
63
64// Tracks number of times a tweak has been offered.
65static constexpr trace::Metric TweakAvailable(
66 "tweak_available", trace::Metric::Counter, "tweak_id");
67
68// Update the FileIndex with new ASTs and plumb the diagnostics responses.
69struct UpdateIndexCallbacks : public ParsingCallbacks {
70 UpdateIndexCallbacks(FileIndex *FIndex,
71 ClangdServer::Callbacks *ServerCallbacks,
72 const ThreadsafeFS &TFS, AsyncTaskRunner *Tasks,
73 bool CollectInactiveRegions)
74 : FIndex(FIndex), ServerCallbacks(ServerCallbacks), TFS(TFS),
75 Stdlib{std::make_shared<StdLibSet>()}, Tasks(Tasks),
76 CollectInactiveRegions(CollectInactiveRegions) {}
77
78 void onPreambleAST(
79 PathRef Path, llvm::StringRef Version, CapturedASTCtx ASTCtx,
80 std::shared_ptr<const include_cleaner::PragmaIncludes> PI) override {
81
82 if (!FIndex)
83 return;
84
85 auto &PP = ASTCtx.getPreprocessor();
86 auto &CI = ASTCtx.getCompilerInvocation();
87 if (auto Loc = Stdlib->add(CI.getLangOpts(), PP.getHeaderSearchInfo()))
88 indexStdlib(CI, std::move(*Loc));
89
90 // FIndex outlives the UpdateIndexCallbacks.
91 auto Task = [FIndex(FIndex), Path(Path.str()), Version(Version.str()),
92 ASTCtx(std::move(ASTCtx)), PI(std::move(PI))]() mutable {
93 trace::Span Tracer("PreambleIndexing");
94 FIndex->updatePreamble(Path, Version, ASTCtx.getASTContext(),
95 ASTCtx.getPreprocessor(), *PI);
96 };
97
98 if (Tasks) {
99 Tasks->runAsync("Preamble indexing for:" + Path + Version,
100 std::move(Task));
101 } else
102 Task();
103 }
104
105 void indexStdlib(const CompilerInvocation &CI, StdLibLocation Loc) {
106 // This task is owned by Tasks, which outlives the TUScheduler and
107 // therefore the UpdateIndexCallbacks.
108 // We must be careful that the references we capture outlive TUScheduler.
109 auto Task = [LO(CI.getLangOpts()), Loc(std::move(Loc)),
110 CI(std::make_unique<CompilerInvocation>(CI)),
111 // External values that outlive ClangdServer
112 TFS(&TFS),
113 // Index outlives TUScheduler (declared first)
114 FIndex(FIndex),
115 // shared_ptr extends lifetime
116 Stdlib(Stdlib),
117 // We have some FS implementations that rely on information in
118 // the context.
119 Ctx(Context::current().clone())]() mutable {
120 // Make sure we install the context into current thread.
121 WithContext C(std::move(Ctx));
122 clang::noteBottomOfStack();
123 IndexFileIn IF;
124 IF.Symbols = indexStandardLibrary(std::move(CI), Loc, *TFS);
125 if (Stdlib->isBest(LO))
126 FIndex->updatePreamble(std::move(IF));
127 };
128 if (Tasks)
129 // This doesn't have a semaphore to enforce -j, but it's rare.
130 Tasks->runAsync("IndexStdlib", std::move(Task));
131 else
132 Task();
133 }
134
135 void onMainAST(PathRef Path, ParsedAST &AST, PublishFn Publish) override {
136 if (FIndex)
137 FIndex->updateMain(Path, AST);
138
139 if (ServerCallbacks)
140 Publish([&]() {
141 ServerCallbacks->onDiagnosticsReady(Path, AST.version(),
142 AST.getDiagnostics());
143 if (CollectInactiveRegions) {
144 ServerCallbacks->onInactiveRegionsReady(Path,
146 }
147 });
148 }
149
150 void onFailedAST(PathRef Path, llvm::StringRef Version,
151 std::vector<Diag> Diags, PublishFn Publish) override {
152 if (ServerCallbacks)
153 Publish(
154 [&]() { ServerCallbacks->onDiagnosticsReady(Path, Version, Diags); });
155 }
156
157 void onFileUpdated(PathRef File, const TUStatus &Status) override {
158 if (ServerCallbacks)
159 ServerCallbacks->onFileUpdated(File, Status);
160 }
161
162 void onPreamblePublished(PathRef File) override {
163 if (ServerCallbacks)
164 ServerCallbacks->onSemanticsMaybeChanged(File);
165 }
166
167private:
168 FileIndex *FIndex;
169 ClangdServer::Callbacks *ServerCallbacks;
170 const ThreadsafeFS &TFS;
171 std::shared_ptr<StdLibSet> Stdlib;
172 AsyncTaskRunner *Tasks;
173 bool CollectInactiveRegions;
174};
175
176class DraftStoreFS : public ThreadsafeFS {
177public:
178 DraftStoreFS(const ThreadsafeFS &Base, const DraftStore &Drafts)
179 : Base(Base), DirtyFiles(Drafts) {}
180
181private:
182 llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> viewImpl() const override {
183 auto OFS = llvm::makeIntrusiveRefCnt<llvm::vfs::OverlayFileSystem>(
184 Base.view(std::nullopt));
185 OFS->pushOverlay(DirtyFiles.asVFS());
186 return OFS;
187 }
188
189 const ThreadsafeFS &Base;
190 const DraftStore &DirtyFiles;
191};
192
193} // namespace
194
197 Opts.UpdateDebounce = DebouncePolicy::fixed(/*zero*/ {});
198 Opts.StorePreamblesInMemory = true;
199 Opts.AsyncThreadsCount = 4; // Consistent!
200 return Opts;
201}
202
203ClangdServer::Options::operator TUScheduler::Options() const {
205 Opts.AsyncThreadsCount = AsyncThreadsCount;
206 Opts.RetentionPolicy = RetentionPolicy;
207 Opts.StorePreamblesInMemory = StorePreamblesInMemory;
208 Opts.UpdateDebounce = UpdateDebounce;
209 Opts.ContextProvider = ContextProvider;
210 Opts.PreambleThrottler = PreambleThrottler;
211 return Opts;
212}
213
215 const ThreadsafeFS &TFS, const Options &Opts,
217 : FeatureModules(Opts.FeatureModules), CDB(CDB), TFS(TFS),
218 DynamicIdx(Opts.BuildDynamicSymbolIndex ? new FileIndex() : nullptr),
219 ClangTidyProvider(Opts.ClangTidyProvider),
220 UseDirtyHeaders(Opts.UseDirtyHeaders),
221 LineFoldingOnly(Opts.LineFoldingOnly),
222 PreambleParseForwardingFunctions(Opts.PreambleParseForwardingFunctions),
223 ImportInsertions(Opts.ImportInsertions),
224 PublishInactiveRegions(Opts.PublishInactiveRegions),
225 WorkspaceRoot(Opts.WorkspaceRoot),
226 Transient(Opts.ImplicitCancellation ? TUScheduler::InvalidateOnUpdate
227 : TUScheduler::NoInvalidation),
228 DirtyFS(std::make_unique<DraftStoreFS>(TFS, DraftMgr)) {
229 if (Opts.AsyncThreadsCount != 0)
230 IndexTasks.emplace();
231 // Pass a callback into `WorkScheduler` to extract symbols from a newly
232 // parsed file and rebuild the file index synchronously each time an AST
233 // is parsed.
234 WorkScheduler.emplace(CDB, TUScheduler::Options(Opts),
235 std::make_unique<UpdateIndexCallbacks>(
236 DynamicIdx.get(), Callbacks, TFS,
237 IndexTasks ? &*IndexTasks : nullptr,
238 PublishInactiveRegions));
239 // Adds an index to the stack, at higher priority than existing indexes.
240 auto AddIndex = [&](SymbolIndex *Idx) {
241 if (this->Index != nullptr) {
242 MergedIdx.push_back(std::make_unique<MergedIndex>(Idx, this->Index));
243 this->Index = MergedIdx.back().get();
244 } else {
245 this->Index = Idx;
246 }
247 };
248 if (Opts.StaticIndex)
249 AddIndex(Opts.StaticIndex);
250 if (Opts.BackgroundIndex) {
252 BGOpts.ThreadPoolSize = std::max(Opts.AsyncThreadsCount, 1u);
254 if (Callbacks)
256 };
257 BGOpts.ContextProvider = Opts.ContextProvider;
258 BackgroundIdx = std::make_unique<BackgroundIndex>(
259 TFS, CDB,
261 [&CDB](llvm::StringRef File) { return CDB.getProjectInfo(File); }),
262 std::move(BGOpts));
263 AddIndex(BackgroundIdx.get());
264 }
265 if (DynamicIdx)
266 AddIndex(DynamicIdx.get());
267
268 if (Opts.FeatureModules) {
270 *this->WorkScheduler,
271 this->Index,
272 this->TFS,
273 };
274 for (auto &Mod : *Opts.FeatureModules)
275 Mod.initialize(F);
276 }
277}
278
280 // Destroying TUScheduler first shuts down request threads that might
281 // otherwise access members concurrently.
282 // (Nobody can be using TUScheduler because we're on the main thread).
283 WorkScheduler.reset();
284 // Now requests have stopped, we can shut down feature modules.
285 if (FeatureModules) {
286 for (auto &Mod : *FeatureModules)
287 Mod.stop();
288 for (auto &Mod : *FeatureModules)
289 Mod.blockUntilIdle(Deadline::infinity());
290 }
291}
292
293void ClangdServer::addDocument(PathRef File, llvm::StringRef Contents,
294 llvm::StringRef Version,
295 WantDiagnostics WantDiags, bool ForceRebuild) {
296 std::string ActualVersion = DraftMgr.addDraft(File, Version, Contents);
297 ParseOptions Opts;
298 Opts.PreambleParseForwardingFunctions = PreambleParseForwardingFunctions;
299 Opts.ImportInsertions = ImportInsertions;
300
301 // Compile command is set asynchronously during update, as it can be slow.
302 ParseInputs Inputs;
303 Inputs.TFS = &getHeaderFS();
304 Inputs.Contents = std::string(Contents);
305 Inputs.Version = std::move(ActualVersion);
306 Inputs.ForceRebuild = ForceRebuild;
307 Inputs.Opts = std::move(Opts);
308 Inputs.Index = Index;
309 Inputs.ClangTidyProvider = ClangTidyProvider;
310 Inputs.FeatureModules = FeatureModules;
311 bool NewFile = WorkScheduler->update(File, Inputs, WantDiags);
312 // If we loaded Foo.h, we want to make sure Foo.cpp is indexed.
313 if (NewFile && BackgroundIdx)
314 BackgroundIdx->boostRelated(File);
315}
316
318 llvm::function_ref<bool(llvm::StringRef File)> Filter) {
319 // Reparse only opened files that were modified.
320 for (const Path &FilePath : DraftMgr.getActiveFiles())
321 if (Filter(FilePath))
322 if (auto Draft = DraftMgr.getDraft(FilePath)) // else disappeared in race?
323 addDocument(FilePath, *Draft->Contents, Draft->Version,
325}
326
327std::shared_ptr<const std::string> ClangdServer::getDraft(PathRef File) const {
328 auto Draft = DraftMgr.getDraft(File);
329 if (!Draft)
330 return nullptr;
331 return std::move(Draft->Contents);
332}
333
334std::function<Context(PathRef)>
336 Callbacks *Publish) {
337 if (!Provider)
338 return [](llvm::StringRef) { return Context::current().clone(); };
339
340 struct Impl {
341 const config::Provider *Provider;
343 std::mutex PublishMu;
344
345 Impl(const config::Provider *Provider, ClangdServer::Callbacks *Publish)
346 : Provider(Provider), Publish(Publish) {}
347
348 Context operator()(llvm::StringRef File) {
349 config::Params Params;
350 // Don't reread config files excessively often.
351 // FIXME: when we see a config file change event, use the event timestamp?
352 Params.FreshTime =
353 std::chrono::steady_clock::now() - std::chrono::seconds(5);
354 llvm::SmallString<256> PosixPath;
355 if (!File.empty()) {
356 assert(llvm::sys::path::is_absolute(File));
357 llvm::sys::path::native(File, PosixPath, llvm::sys::path::Style::posix);
358 Params.Path = PosixPath.str();
359 }
360
361 llvm::StringMap<std::vector<Diag>> ReportableDiagnostics;
362 Config C = Provider->getConfig(Params, [&](const llvm::SMDiagnostic &D) {
363 // Create the map entry even for note diagnostics we don't report.
364 // This means that when the file is parsed with no warnings, we
365 // publish an empty set of diagnostics, clearing any the client has.
366 handleDiagnostic(D, !Publish || D.getFilename().empty()
367 ? nullptr
368 : &ReportableDiagnostics[D.getFilename()]);
369 });
370 // Blindly publish diagnostics for the (unopened) parsed config files.
371 // We must avoid reporting diagnostics for *the same file* concurrently.
372 // Source diags are published elsewhere, but those are different files.
373 if (!ReportableDiagnostics.empty()) {
374 std::lock_guard<std::mutex> Lock(PublishMu);
375 for (auto &Entry : ReportableDiagnostics)
376 Publish->onDiagnosticsReady(Entry.first(), /*Version=*/"",
377 Entry.second);
378 }
379 return Context::current().derive(Config::Key, std::move(C));
380 }
381
382 void handleDiagnostic(const llvm::SMDiagnostic &D,
383 std::vector<Diag> *ClientDiagnostics) {
384 switch (D.getKind()) {
385 case llvm::SourceMgr::DK_Error:
386 elog("config error at {0}:{1}:{2}: {3}", D.getFilename(), D.getLineNo(),
387 D.getColumnNo(), D.getMessage());
388 break;
389 case llvm::SourceMgr::DK_Warning:
390 log("config warning at {0}:{1}:{2}: {3}", D.getFilename(),
391 D.getLineNo(), D.getColumnNo(), D.getMessage());
392 break;
393 case llvm::SourceMgr::DK_Note:
394 case llvm::SourceMgr::DK_Remark:
395 vlog("config note at {0}:{1}:{2}: {3}", D.getFilename(), D.getLineNo(),
396 D.getColumnNo(), D.getMessage());
397 ClientDiagnostics = nullptr; // Don't emit notes as LSP diagnostics.
398 break;
399 }
400 if (ClientDiagnostics)
401 ClientDiagnostics->push_back(toDiag(D, Diag::ClangdConfig));
402 }
403 };
404
405 // Copyable wrapper.
406 return [I(std::make_shared<Impl>(Provider, Publish))](llvm::StringRef Path) {
407 return (*I)(Path);
408 };
409}
410
412 DraftMgr.removeDraft(File);
413 WorkScheduler->remove(File);
414}
415
417 const clangd::CodeCompleteOptions &Opts,
419 // Copy completion options for passing them to async task handler.
420 auto CodeCompleteOpts = Opts;
421 if (!CodeCompleteOpts.Index) // Respect overridden index.
422 CodeCompleteOpts.Index = Index;
423
424 auto Task = [Pos, CodeCompleteOpts, File = File.str(), CB = std::move(CB),
425 this](llvm::Expected<InputsAndPreamble> IP) mutable {
426 if (!IP)
427 return CB(IP.takeError());
428 if (auto Reason = isCancelled())
429 return CB(llvm::make_error<CancelledError>(Reason));
430
431 std::optional<SpeculativeFuzzyFind> SpecFuzzyFind;
432 if (!IP->Preamble) {
433 // No speculation in Fallback mode, as it's supposed to be much faster
434 // without compiling.
435 vlog("Build for file {0} is not ready. Enter fallback mode.", File);
436 } else if (CodeCompleteOpts.Index) {
437 SpecFuzzyFind.emplace();
438 {
439 std::lock_guard<std::mutex> Lock(CachedCompletionFuzzyFindRequestMutex);
440 SpecFuzzyFind->CachedReq = CachedCompletionFuzzyFindRequestByFile[File];
441 }
442 }
443 ParseInputs ParseInput{IP->Command, &getHeaderFS(), IP->Contents.str()};
444 // FIXME: Add traling new line if there is none at eof, workaround a crash,
445 // see https://github.com/clangd/clangd/issues/332
446 if (!IP->Contents.ends_with("\n"))
447 ParseInput.Contents.append("\n");
448 ParseInput.Index = Index;
449
450 CodeCompleteOpts.MainFileSignals = IP->Signals;
451 CodeCompleteOpts.AllScopes = Config::current().Completion.AllScopes;
452 // FIXME(ibiryukov): even if Preamble is non-null, we may want to check
453 // both the old and the new version in case only one of them matches.
455 File, Pos, IP->Preamble, ParseInput, CodeCompleteOpts,
456 SpecFuzzyFind ? &*SpecFuzzyFind : nullptr);
457 {
458 clang::clangd::trace::Span Tracer("Completion results callback");
459 CB(std::move(Result));
460 }
461 if (SpecFuzzyFind && SpecFuzzyFind->NewReq) {
462 std::lock_guard<std::mutex> Lock(CachedCompletionFuzzyFindRequestMutex);
463 CachedCompletionFuzzyFindRequestByFile[File] = *SpecFuzzyFind->NewReq;
464 }
465 // SpecFuzzyFind is only destroyed after speculative fuzzy find finishes.
466 // We don't want `codeComplete` to wait for the async call if it doesn't use
467 // the result (e.g. non-index completion, speculation fails), so that `CB`
468 // is called as soon as results are available.
469 };
470
471 // We use a potentially-stale preamble because latency is critical here.
472 WorkScheduler->runWithPreamble(
473 "CodeComplete", File,
474 (Opts.RunParser == CodeCompleteOptions::AlwaysParse)
477 std::move(Task));
478}
479
481 MarkupKind DocumentationFormat,
483
484 auto Action = [Pos, File = File.str(), CB = std::move(CB),
485 DocumentationFormat,
486 this](llvm::Expected<InputsAndPreamble> IP) mutable {
487 if (!IP)
488 return CB(IP.takeError());
489
490 const auto *PreambleData = IP->Preamble;
491 if (!PreambleData)
492 return CB(error("Failed to parse includes"));
493
494 ParseInputs ParseInput{IP->Command, &getHeaderFS(), IP->Contents.str()};
495 // FIXME: Add traling new line if there is none at eof, workaround a crash,
496 // see https://github.com/clangd/clangd/issues/332
497 if (!IP->Contents.ends_with("\n"))
498 ParseInput.Contents.append("\n");
499 ParseInput.Index = Index;
501 DocumentationFormat));
502 };
503
504 // Unlike code completion, we wait for a preamble here.
505 WorkScheduler->runWithPreamble("SignatureHelp", File, TUScheduler::Stale,
506 std::move(Action));
507}
508
509void ClangdServer::formatFile(PathRef File, std::optional<Range> Rng,
511 auto Code = getDraft(File);
512 if (!Code)
513 return CB(llvm::make_error<LSPError>("trying to format non-added document",
515 tooling::Range RequestedRange;
516 if (Rng) {
517 llvm::Expected<size_t> Begin = positionToOffset(*Code, Rng->start);
518 if (!Begin)
519 return CB(Begin.takeError());
520 llvm::Expected<size_t> End = positionToOffset(*Code, Rng->end);
521 if (!End)
522 return CB(End.takeError());
523 RequestedRange = tooling::Range(*Begin, *End - *Begin);
524 } else {
525 RequestedRange = tooling::Range(0, Code->size());
526 }
527
528 // Call clang-format.
529 auto Action = [File = File.str(), Code = std::move(*Code),
530 Ranges = std::vector<tooling::Range>{RequestedRange},
531 CB = std::move(CB), this]() mutable {
532 format::FormatStyle Style = getFormatStyleForFile(File, Code, TFS, true);
533 tooling::Replacements IncludeReplaces =
534 format::sortIncludes(Style, Code, Ranges, File);
535 auto Changed = tooling::applyAllReplacements(Code, IncludeReplaces);
536 if (!Changed)
537 return CB(Changed.takeError());
538
539 CB(IncludeReplaces.merge(format::reformat(
540 Style, *Changed,
541 tooling::calculateRangesAfterReplacements(IncludeReplaces, Ranges),
542 File)));
543 };
544 WorkScheduler->runQuick("Format", File, std::move(Action));
545}
546
548 StringRef TriggerText,
549 Callback<std::vector<TextEdit>> CB) {
550 auto Code = getDraft(File);
551 if (!Code)
552 return CB(llvm::make_error<LSPError>("trying to format non-added document",
554 llvm::Expected<size_t> CursorPos = positionToOffset(*Code, Pos);
555 if (!CursorPos)
556 return CB(CursorPos.takeError());
557 auto Action = [File = File.str(), Code = std::move(*Code),
558 TriggerText = TriggerText.str(), CursorPos = *CursorPos,
559 CB = std::move(CB), this]() mutable {
560 auto Style = getFormatStyleForFile(File, Code, TFS, false);
561 std::vector<TextEdit> Result;
562 for (const tooling::Replacement &R :
563 formatIncremental(Code, CursorPos, TriggerText, Style))
564 Result.push_back(replacementToEdit(Code, R));
565 return CB(Result);
566 };
567 WorkScheduler->runQuick("FormatOnType", File, std::move(Action));
568}
569
571 std::optional<std::string> NewName,
572 const RenameOptions &RenameOpts,
574 auto Action = [Pos, File = File.str(), CB = std::move(CB),
575 NewName = std::move(NewName),
576 RenameOpts](llvm::Expected<InputsAndAST> InpAST) mutable {
577 if (!InpAST)
578 return CB(InpAST.takeError());
579 // prepareRename is latency-sensitive: we don't query the index, as we
580 // only need main-file references
581 auto Results =
582 clangd::rename({Pos, NewName.value_or("__clangd_rename_placeholder"),
583 InpAST->AST, File, /*FS=*/nullptr,
584 /*Index=*/nullptr, RenameOpts});
585 if (!Results) {
586 // LSP says to return null on failure, but that will result in a generic
587 // failure message. If we send an LSP error response, clients can surface
588 // the message to users (VSCode does).
589 return CB(Results.takeError());
590 }
591 return CB(*Results);
592 };
593 WorkScheduler->runWithAST("PrepareRename", File, std::move(Action));
594}
595
596void ClangdServer::rename(PathRef File, Position Pos, llvm::StringRef NewName,
597 const RenameOptions &Opts,
599 auto Action = [File = File.str(), NewName = NewName.str(), Pos, Opts,
600 CB = std::move(CB),
601 this](llvm::Expected<InputsAndAST> InpAST) mutable {
602 // Tracks number of files edited per invocation.
603 static constexpr trace::Metric RenameFiles("rename_files",
605 if (!InpAST)
606 return CB(InpAST.takeError());
607 auto R = clangd::rename({Pos, NewName, InpAST->AST, File,
608 DirtyFS->view(std::nullopt), Index, Opts});
609 if (!R)
610 return CB(R.takeError());
611
612 if (Opts.WantFormat) {
613 auto Style = getFormatStyleForFile(File, InpAST->Inputs.Contents,
614 *InpAST->Inputs.TFS, false);
615 llvm::Error Err = llvm::Error::success();
616 for (auto &E : R->GlobalChanges)
617 Err =
618 llvm::joinErrors(reformatEdit(E.getValue(), Style), std::move(Err));
619
620 if (Err)
621 return CB(std::move(Err));
622 }
623 RenameFiles.record(R->GlobalChanges.size());
624 return CB(*R);
625 };
626 WorkScheduler->runWithAST("Rename", File, std::move(Action));
627}
628
629namespace {
630// May generate several candidate selections, due to SelectionTree ambiguity.
631// vector of pointers because GCC doesn't like non-copyable Selection.
632llvm::Expected<std::vector<std::unique_ptr<Tweak::Selection>>>
633tweakSelection(const Range &Sel, const InputsAndAST &AST,
634 llvm::vfs::FileSystem *FS) {
635 auto Begin = positionToOffset(AST.Inputs.Contents, Sel.start);
636 if (!Begin)
637 return Begin.takeError();
638 auto End = positionToOffset(AST.Inputs.Contents, Sel.end);
639 if (!End)
640 return End.takeError();
641 std::vector<std::unique_ptr<Tweak::Selection>> Result;
643 AST.AST.getASTContext(), AST.AST.getTokens(), *Begin, *End,
644 [&](SelectionTree T) {
645 Result.push_back(std::make_unique<Tweak::Selection>(
646 AST.Inputs.Index, AST.AST, *Begin, *End, std::move(T), FS));
647 return false;
648 });
649 assert(!Result.empty() && "Expected at least one SelectionTree");
650 return std::move(Result);
651}
652
653// Some fixes may perform local renaming, we want to convert those to clangd
654// rename commands, such that we can leverage the index for more accurate
655// results.
656std::optional<ClangdServer::CodeActionResult::Rename>
657tryConvertToRename(const Diag *Diag, const Fix &Fix) {
658 bool IsClangTidyRename = Diag->Source == Diag::ClangTidy &&
659 Diag->Name == "readability-identifier-naming" &&
660 !Fix.Edits.empty();
661 if (IsClangTidyRename && Diag->InsideMainFile) {
662 ClangdServer::CodeActionResult::Rename R;
663 R.NewName = Fix.Edits.front().newText;
664 R.FixMessage = Fix.Message;
665 R.Diag = {Diag->Range, Diag->Message};
666 return R;
667 }
668
669 return std::nullopt;
670}
671
672} // namespace
673
676 auto Action = [Params, CB = std::move(CB),
677 FeatureModules(this->FeatureModules)](
678 Expected<InputsAndAST> InpAST) mutable {
679 if (!InpAST)
680 return CB(InpAST.takeError());
681 auto KindAllowed =
682 [Only(Params.RequestedActionKinds)](llvm::StringRef Kind) {
683 if (Only.empty())
684 return true;
685 return llvm::any_of(Only, [&](llvm::StringRef Base) {
686 return Kind.consume_front(Base) &&
687 (Kind.empty() || Kind.starts_with("."));
688 });
689 };
690
691 CodeActionResult Result;
692 Result.Version = InpAST->AST.version().str();
693 if (KindAllowed(CodeAction::QUICKFIX_KIND)) {
694 auto FindMatchedDiag = [&InpAST](const DiagRef &DR) -> const Diag * {
695 for (const auto &Diag : InpAST->AST.getDiagnostics())
696 if (Diag.Range == DR.Range && Diag.Message == DR.Message)
697 return &Diag;
698 return nullptr;
699 };
700 for (const auto &DiagRef : Params.Diagnostics) {
701 if (const auto *Diag = FindMatchedDiag(DiagRef))
702 for (const auto &Fix : Diag->Fixes) {
703 if (auto Rename = tryConvertToRename(Diag, Fix)) {
704 Result.Renames.emplace_back(std::move(*Rename));
705 } else {
706 Result.QuickFixes.push_back({DiagRef, Fix});
707 }
708 }
709 }
710 }
711
712 // Collect Tweaks
713 auto Selections = tweakSelection(Params.Selection, *InpAST, /*FS=*/nullptr);
714 if (!Selections)
715 return CB(Selections.takeError());
716 // Don't allow a tweak to fire more than once across ambiguous selections.
717 llvm::DenseSet<llvm::StringRef> PreparedTweaks;
718 auto DeduplicatingFilter = [&](const Tweak &T) {
719 return KindAllowed(T.kind()) && Params.TweakFilter(T) &&
720 !PreparedTweaks.count(T.id());
721 };
722 for (const auto &Sel : *Selections) {
723 for (auto &T : prepareTweaks(*Sel, DeduplicatingFilter, FeatureModules)) {
724 Result.TweakRefs.push_back(TweakRef{T->id(), T->title(), T->kind()});
725 PreparedTweaks.insert(T->id());
726 TweakAvailable.record(1, T->id());
727 }
728 }
729 CB(std::move(Result));
730 };
731
732 WorkScheduler->runWithAST("codeAction", Params.File, std::move(Action),
733 Transient);
734}
735
736void ClangdServer::applyTweak(PathRef File, Range Sel, StringRef TweakID,
738 // Tracks number of times a tweak has been attempted.
739 static constexpr trace::Metric TweakAttempt(
740 "tweak_attempt", trace::Metric::Counter, "tweak_id");
741 // Tracks number of times a tweak has failed to produce edits.
742 static constexpr trace::Metric TweakFailed(
743 "tweak_failed", trace::Metric::Counter, "tweak_id");
744 TweakAttempt.record(1, TweakID);
745 auto Action = [File = File.str(), Sel, TweakID = TweakID.str(),
746 CB = std::move(CB),
747 this](Expected<InputsAndAST> InpAST) mutable {
748 if (!InpAST)
749 return CB(InpAST.takeError());
750 auto FS = DirtyFS->view(std::nullopt);
751 auto Selections = tweakSelection(Sel, *InpAST, FS.get());
752 if (!Selections)
753 return CB(Selections.takeError());
754 std::optional<llvm::Expected<Tweak::Effect>> Effect;
755 // Try each selection, take the first one that prepare()s.
756 // If they all fail, Effect will hold get the last error.
757 for (const auto &Selection : *Selections) {
758 auto T = prepareTweak(TweakID, *Selection, FeatureModules);
759 if (T) {
760 Effect = (*T)->apply(*Selection);
761 break;
762 }
763 Effect = T.takeError();
764 }
765 assert(Effect && "Expected at least one selection");
766 if (*Effect && (*Effect)->FormatEdits) {
767 // Format tweaks that require it centrally here.
768 for (auto &It : (*Effect)->ApplyEdits) {
769 Edit &E = It.second;
770 format::FormatStyle Style =
771 getFormatStyleForFile(File, E.InitialCode, TFS, false);
772 if (llvm::Error Err = reformatEdit(E, Style))
773 elog("Failed to format {0}: {1}", It.first(), std::move(Err));
774 }
775 } else {
776 TweakFailed.record(1, TweakID);
777 }
778 return CB(std::move(*Effect));
779 };
780 WorkScheduler->runWithAST("ApplyTweak", File, std::move(Action));
781}
782
784 Callback<std::vector<LocatedSymbol>> CB) {
785 auto Action = [Pos, CB = std::move(CB),
786 this](llvm::Expected<InputsAndAST> InpAST) mutable {
787 if (!InpAST)
788 return CB(InpAST.takeError());
789 CB(clangd::locateSymbolAt(InpAST->AST, Pos, Index));
790 };
791
792 WorkScheduler->runWithAST("Definitions", File, std::move(Action));
793}
794
796 PathRef Path, Callback<std::optional<clangd::Path>> CB) {
797 // We want to return the result as fast as possible, strategy is:
798 // 1) use the file-only heuristic, it requires some IO but it is much
799 // faster than building AST, but it only works when .h/.cc files are in
800 // the same directory.
801 // 2) if 1) fails, we use the AST&Index approach, it is slower but supports
802 // different code layout.
803 if (auto CorrespondingFile =
804 getCorrespondingHeaderOrSource(Path, TFS.view(std::nullopt)))
805 return CB(std::move(CorrespondingFile));
806 auto Action = [Path = Path.str(), CB = std::move(CB),
807 this](llvm::Expected<InputsAndAST> InpAST) mutable {
808 if (!InpAST)
809 return CB(InpAST.takeError());
810 CB(getCorrespondingHeaderOrSource(Path, InpAST->AST, Index));
811 };
812 WorkScheduler->runWithAST("SwitchHeaderSource", Path, std::move(Action));
813}
814
816 PathRef File, Position Pos, Callback<std::vector<DocumentHighlight>> CB) {
817 auto Action =
818 [Pos, CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
819 if (!InpAST)
820 return CB(InpAST.takeError());
821 CB(clangd::findDocumentHighlights(InpAST->AST, Pos));
822 };
823
824 WorkScheduler->runWithAST("Highlights", File, std::move(Action), Transient);
825}
826
828 Callback<std::optional<HoverInfo>> CB) {
829 auto Action = [File = File.str(), Pos, CB = std::move(CB),
830 this](llvm::Expected<InputsAndAST> InpAST) mutable {
831 if (!InpAST)
832 return CB(InpAST.takeError());
833 format::FormatStyle Style = getFormatStyleForFile(
834 File, InpAST->Inputs.Contents, *InpAST->Inputs.TFS, false);
835 CB(clangd::getHover(InpAST->AST, Pos, std::move(Style), Index));
836 };
837
838 WorkScheduler->runWithAST("Hover", File, std::move(Action), Transient);
839}
840
842 TypeHierarchyDirection Direction,
843 Callback<std::vector<TypeHierarchyItem>> CB) {
844 auto Action = [File = File.str(), Pos, Resolve, Direction, CB = std::move(CB),
845 this](Expected<InputsAndAST> InpAST) mutable {
846 if (!InpAST)
847 return CB(InpAST.takeError());
848 CB(clangd::getTypeHierarchy(InpAST->AST, Pos, Resolve, Direction, Index,
849 File));
850 };
851
852 WorkScheduler->runWithAST("TypeHierarchy", File, std::move(Action));
853}
854
856 const TypeHierarchyItem &Item,
857 Callback<std::optional<std::vector<TypeHierarchyItem>>> CB) {
858 WorkScheduler->run("typeHierarchy/superTypes", /*Path=*/"",
859 [=, CB = std::move(CB)]() mutable {
860 CB(clangd::superTypes(Item, Index));
861 });
862}
863
865 Callback<std::vector<TypeHierarchyItem>> CB) {
866 WorkScheduler->run(
867 "typeHierarchy/subTypes", /*Path=*/"",
868 [=, CB = std::move(CB)]() mutable { CB(clangd::subTypes(Item, Index)); });
869}
870
872 TypeHierarchyItem Item, int Resolve, TypeHierarchyDirection Direction,
873 Callback<std::optional<TypeHierarchyItem>> CB) {
874 WorkScheduler->run(
875 "Resolve Type Hierarchy", "", [=, CB = std::move(CB)]() mutable {
876 clangd::resolveTypeHierarchy(Item, Resolve, Direction, Index);
877 CB(Item);
878 });
879}
880
882 PathRef File, Position Pos, Callback<std::vector<CallHierarchyItem>> CB) {
883 auto Action = [File = File.str(), Pos,
884 CB = std::move(CB)](Expected<InputsAndAST> InpAST) mutable {
885 if (!InpAST)
886 return CB(InpAST.takeError());
887 CB(clangd::prepareCallHierarchy(InpAST->AST, Pos, File));
888 };
889 WorkScheduler->runWithAST("CallHierarchy", File, std::move(Action));
890}
891
893 const CallHierarchyItem &Item,
894 Callback<std::vector<CallHierarchyIncomingCall>> CB) {
895 WorkScheduler->run("Incoming Calls", "",
896 [CB = std::move(CB), Item, this]() mutable {
897 CB(clangd::incomingCalls(Item, Index));
898 });
899}
900
901void ClangdServer::inlayHints(PathRef File, std::optional<Range> RestrictRange,
902 Callback<std::vector<InlayHint>> CB) {
903 auto Action = [RestrictRange(std::move(RestrictRange)),
904 CB = std::move(CB)](Expected<InputsAndAST> InpAST) mutable {
905 if (!InpAST)
906 return CB(InpAST.takeError());
907 CB(clangd::inlayHints(InpAST->AST, std::move(RestrictRange)));
908 };
909 WorkScheduler->runWithAST("InlayHints", File, std::move(Action), Transient);
910}
911
913 // FIXME: Do nothing for now. This will be used for indexing and potentially
914 // invalidating other caches.
915}
916
918 llvm::StringRef Query, int Limit,
919 Callback<std::vector<SymbolInformation>> CB) {
920 WorkScheduler->run(
921 "getWorkspaceSymbols", /*Path=*/"",
922 [Query = Query.str(), Limit, CB = std::move(CB), this]() mutable {
923 CB(clangd::getWorkspaceSymbols(Query, Limit, Index,
924 WorkspaceRoot.value_or("")));
925 });
926}
927
929 Callback<std::vector<DocumentSymbol>> CB) {
930 auto Action =
931 [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
932 if (!InpAST)
933 return CB(InpAST.takeError());
934 CB(clangd::getDocumentSymbols(InpAST->AST));
935 };
936 WorkScheduler->runWithAST("DocumentSymbols", File, std::move(Action),
937 Transient);
938}
939
941 Callback<std::vector<FoldingRange>> CB) {
942 auto Code = getDraft(File);
943 if (!Code)
944 return CB(llvm::make_error<LSPError>(
945 "trying to compute folding ranges for non-added document",
947 auto Action = [LineFoldingOnly = LineFoldingOnly, CB = std::move(CB),
948 Code = std::move(*Code)]() mutable {
949 CB(clangd::getFoldingRanges(Code, LineFoldingOnly));
950 };
951 // We want to make sure folding ranges are always available for all the open
952 // files, hence prefer runQuick to not wait for operations on other files.
953 WorkScheduler->runQuick("FoldingRanges", File, std::move(Action));
954}
955
957 Callback<std::vector<LocatedSymbol>> CB) {
958 auto Action = [Pos, CB = std::move(CB),
959 this](llvm::Expected<InputsAndAST> InpAST) mutable {
960 if (!InpAST)
961 return CB(InpAST.takeError());
962 CB(clangd::findType(InpAST->AST, Pos, Index));
963 };
964 WorkScheduler->runWithAST("FindType", File, std::move(Action));
965}
966
968 PathRef File, Position Pos, Callback<std::vector<LocatedSymbol>> CB) {
969 auto Action = [Pos, CB = std::move(CB),
970 this](llvm::Expected<InputsAndAST> InpAST) mutable {
971 if (!InpAST)
972 return CB(InpAST.takeError());
973 CB(clangd::findImplementations(InpAST->AST, Pos, Index));
974 };
975
976 WorkScheduler->runWithAST("Implementations", File, std::move(Action));
977}
978
980 bool AddContainer,
982 auto Action = [Pos, Limit, AddContainer, CB = std::move(CB),
983 this](llvm::Expected<InputsAndAST> InpAST) mutable {
984 if (!InpAST)
985 return CB(InpAST.takeError());
986 CB(clangd::findReferences(InpAST->AST, Pos, Limit, Index, AddContainer));
987 };
988
989 WorkScheduler->runWithAST("References", File, std::move(Action));
990}
991
993 Callback<std::vector<SymbolDetails>> CB) {
994 auto Action =
995 [Pos, CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
996 if (!InpAST)
997 return CB(InpAST.takeError());
998 CB(clangd::getSymbolInfo(InpAST->AST, Pos));
999 };
1000
1001 WorkScheduler->runWithAST("SymbolInfo", File, std::move(Action));
1002}
1003
1005 const std::vector<Position> &Positions,
1006 Callback<std::vector<SelectionRange>> CB) {
1007 auto Action = [Positions, CB = std::move(CB)](
1008 llvm::Expected<InputsAndAST> InpAST) mutable {
1009 if (!InpAST)
1010 return CB(InpAST.takeError());
1011 std::vector<SelectionRange> Result;
1012 for (const auto &Pos : Positions) {
1013 if (auto Range = clangd::getSemanticRanges(InpAST->AST, Pos))
1014 Result.push_back(std::move(*Range));
1015 else
1016 return CB(Range.takeError());
1017 }
1018 CB(std::move(Result));
1019 };
1020 WorkScheduler->runWithAST("SemanticRanges", File, std::move(Action));
1021}
1022
1024 Callback<std::vector<DocumentLink>> CB) {
1025 auto Action =
1026 [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
1027 if (!InpAST)
1028 return CB(InpAST.takeError());
1029 CB(clangd::getDocumentLinks(InpAST->AST));
1030 };
1031 WorkScheduler->runWithAST("DocumentLinks", File, std::move(Action),
1032 Transient);
1033}
1034
1036 PathRef File, Callback<std::vector<HighlightingToken>> CB) {
1037
1038 auto Action = [CB = std::move(CB),
1039 PublishInactiveRegions = PublishInactiveRegions](
1040 llvm::Expected<InputsAndAST> InpAST) mutable {
1041 if (!InpAST)
1042 return CB(InpAST.takeError());
1043 // Include inactive regions in semantic highlighting tokens only if the
1044 // client doesn't support a dedicated protocol for being informed about
1045 // them.
1046 CB(clangd::getSemanticHighlightings(InpAST->AST, !PublishInactiveRegions));
1047 };
1048 WorkScheduler->runWithAST("SemanticHighlights", File, std::move(Action),
1049 Transient);
1050}
1051
1052void ClangdServer::getAST(PathRef File, std::optional<Range> R,
1053 Callback<std::optional<ASTNode>> CB) {
1054 auto Action =
1055 [R, CB(std::move(CB))](llvm::Expected<InputsAndAST> Inputs) mutable {
1056 if (!Inputs)
1057 return CB(Inputs.takeError());
1058 if (!R) {
1059 // It's safe to pass in the TU, as dumpAST() does not
1060 // deserialize the preamble.
1061 auto Node = DynTypedNode::create(
1062 *Inputs->AST.getASTContext().getTranslationUnitDecl());
1063 return CB(dumpAST(Node, Inputs->AST.getTokens(),
1064 Inputs->AST.getASTContext()));
1065 }
1066 unsigned Start, End;
1067 if (auto Offset = positionToOffset(Inputs->Inputs.Contents, R->start))
1068 Start = *Offset;
1069 else
1070 return CB(Offset.takeError());
1071 if (auto Offset = positionToOffset(Inputs->Inputs.Contents, R->end))
1072 End = *Offset;
1073 else
1074 return CB(Offset.takeError());
1075 bool Success = SelectionTree::createEach(
1076 Inputs->AST.getASTContext(), Inputs->AST.getTokens(), Start, End,
1077 [&](SelectionTree T) {
1078 if (const SelectionTree::Node *N = T.commonAncestor()) {
1079 CB(dumpAST(N->ASTNode, Inputs->AST.getTokens(),
1080 Inputs->AST.getASTContext()));
1081 return true;
1082 }
1083 return false;
1084 });
1085 if (!Success)
1086 CB(std::nullopt);
1087 };
1088 WorkScheduler->runWithAST("GetAST", File, std::move(Action));
1089}
1090
1091void ClangdServer::customAction(PathRef File, llvm::StringRef Name,
1093 WorkScheduler->runWithAST(Name, File, std::move(Action));
1094}
1095
1096void ClangdServer::diagnostics(PathRef File, Callback<std::vector<Diag>> CB) {
1097 auto Action =
1098 [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
1099 if (!InpAST)
1100 return CB(InpAST.takeError());
1101 return CB(InpAST->AST.getDiagnostics());
1102 };
1103
1104 WorkScheduler->runWithAST("Diagnostics", File, std::move(Action));
1105}
1106
1107llvm::StringMap<TUScheduler::FileStats> ClangdServer::fileStats() const {
1108 return WorkScheduler->fileStats();
1109}
1110
1111[[nodiscard]] bool
1112ClangdServer::blockUntilIdleForTest(std::optional<double> TimeoutSeconds) {
1113 // Order is important here: we don't want to block on A and then B,
1114 // if B might schedule work on A.
1115
1116#if defined(__has_feature) && \
1117 (__has_feature(address_sanitizer) || __has_feature(hwaddress_sanitizer) || \
1118 __has_feature(memory_sanitizer) || __has_feature(thread_sanitizer))
1119 if (TimeoutSeconds.has_value())
1120 (*TimeoutSeconds) *= 10;
1121#endif
1122
1123 // Nothing else can schedule work on TUScheduler, because it's not threadsafe
1124 // and we're blocking the main thread.
1125 if (!WorkScheduler->blockUntilIdle(timeoutSeconds(TimeoutSeconds)))
1126 return false;
1127 // TUScheduler is the only thing that starts background indexing work.
1128 if (IndexTasks && !IndexTasks->wait(timeoutSeconds(TimeoutSeconds)))
1129 return false;
1130
1131 // Unfortunately we don't have strict topological order between the rest of
1132 // the components. E.g. CDB broadcast triggers backrgound indexing.
1133 // This queries the CDB which may discover new work if disk has changed.
1134 //
1135 // So try each one a few times in a loop.
1136 // If there are no tricky interactions then all after the first are no-ops.
1137 // Then on the last iteration, verify they're idle without waiting.
1138 //
1139 // There's a small chance they're juggling work and we didn't catch them :-(
1140 for (std::optional<double> Timeout :
1141 {TimeoutSeconds, TimeoutSeconds, std::optional<double>(0)}) {
1142 if (!CDB.blockUntilIdle(timeoutSeconds(Timeout)))
1143 return false;
1144 if (BackgroundIdx && !BackgroundIdx->blockUntilIdleForTest(Timeout))
1145 return false;
1146 if (FeatureModules && llvm::any_of(*FeatureModules, [&](FeatureModule &M) {
1147 return !M.blockUntilIdle(timeoutSeconds(Timeout));
1148 }))
1149 return false;
1150 }
1151
1152 assert(WorkScheduler->blockUntilIdle(Deadline::zero()) &&
1153 "Something scheduled work while we're blocking the main thread!");
1154 return true;
1155}
1156
1157void ClangdServer::profile(MemoryTree &MT) const {
1158 if (DynamicIdx)
1159 DynamicIdx->profile(MT.child("dynamic_index"));
1160 if (BackgroundIdx)
1161 BackgroundIdx->profile(MT.child("background_index"));
1162 WorkScheduler->profile(MT.child("tuscheduler"));
1163}
1164} // namespace clangd
1165} // namespace clang
const Expr * E
BindArgumentKind Kind
llvm::SmallString< 256U > Name
FeatureModuleSet FeatureModules
const ParseInputs & ParseInput
size_t Offset
std::vector< CodeCompletionResult > Results
std::string Code
const Criteria C
SourceLocation Loc
FieldAction Action
size_t Pos
::clang::DynTypedNode Node
const google::protobuf::Message & M
Definition: Server.cpp:309
std::unique_ptr< CompilerInvocation > CI
WantDiagnostics WantDiags
static Factory createDiskBackedStorageFactory(std::function< std::optional< ProjectInfo >(PathRef)> GetProjectInfo)
Interface with hooks for users of ClangdServer to be notified of events.
Definition: ClangdServer.h:61
virtual void onBackgroundIndexProgress(const BackgroundQueue::Stats &Stats)
Called when background indexing tasks are enqueued/started/completed.
Definition: ClangdServer.h:78
virtual void onDiagnosticsReady(PathRef File, llvm::StringRef Version, llvm::ArrayRef< Diag > Diagnostics)
Called by ClangdServer when Diagnostics for File are ready.
Definition: ClangdServer.h:69
ClangdServer(const GlobalCompilationDatabase &CDB, const ThreadsafeFS &TFS, const Options &Opts, Callbacks *Callbacks=nullptr)
Creates a new ClangdServer instance.
void prepareRename(PathRef File, Position Pos, std::optional< std::string > NewName, const RenameOptions &RenameOpts, Callback< RenameResult > CB)
Test the validity of a rename operation.
void prepareCallHierarchy(PathRef File, Position Pos, Callback< std::vector< CallHierarchyItem > > CB)
Get information about call hierarchy for a given position.
void resolveTypeHierarchy(TypeHierarchyItem Item, int Resolve, TypeHierarchyDirection Direction, Callback< std::optional< TypeHierarchyItem > > CB)
Resolve type hierarchy item in the given direction.
void documentSymbols(StringRef File, Callback< std::vector< DocumentSymbol > > CB)
Retrieve the symbols within the specified file.
void workspaceSymbols(StringRef Query, int Limit, Callback< std::vector< SymbolInformation > > CB)
Retrieve the top symbols from the workspace matching a query.
void typeHierarchy(PathRef File, Position Pos, int Resolve, TypeHierarchyDirection Direction, Callback< std::vector< TypeHierarchyItem > > CB)
Get information about type hierarchy for a given position.
void formatFile(PathRef File, std::optional< Range > Rng, Callback< tooling::Replacements > CB)
Run formatting for the File with content Code.
void removeDocument(PathRef File)
Remove File from list of tracked files, schedule a request to free resources associated with it.
void addDocument(PathRef File, StringRef Contents, llvm::StringRef Version="null", WantDiagnostics WD=WantDiagnostics::Auto, bool ForceRebuild=false)
Add a File to the list of tracked C++ files or update the contents if File is already tracked.
void findDocumentHighlights(PathRef File, Position Pos, Callback< std::vector< DocumentHighlight > > CB)
Get document highlights for a given position.
static std::function< Context(PathRef)> createConfiguredContextProvider(const config::Provider *Provider, ClangdServer::Callbacks *)
Creates a context provider that loads and installs config.
void signatureHelp(PathRef File, Position Pos, MarkupKind DocumentationFormat, Callback< SignatureHelp > CB)
Provide signature help for File at Pos.
void findReferences(PathRef File, Position Pos, uint32_t Limit, bool AddContainer, Callback< ReferencesResult > CB)
Retrieve locations for symbol references.
void switchSourceHeader(PathRef Path, Callback< std::optional< clangd::Path > > CB)
Switch to a corresponding source file when given a header file, and vice versa.
void findType(PathRef File, Position Pos, Callback< std::vector< LocatedSymbol > > CB)
Retrieve symbols for types referenced at Pos.
void findImplementations(PathRef File, Position Pos, Callback< std::vector< LocatedSymbol > > CB)
Retrieve implementations for virtual method.
static Options optsForTest()
void subTypes(const TypeHierarchyItem &Item, Callback< std::vector< TypeHierarchyItem > > CB)
Get direct children of a type hierarchy item.
void semanticRanges(PathRef File, const std::vector< Position > &Pos, Callback< std::vector< SelectionRange > > CB)
Get semantic ranges around a specified position in a file.
void applyTweak(PathRef File, Range Sel, StringRef ID, Callback< Tweak::Effect > CB)
Apply the code tweak with a specified ID.
void semanticHighlights(PathRef File, Callback< std::vector< HighlightingToken > >)
void getAST(PathRef File, std::optional< Range > R, Callback< std::optional< ASTNode > > CB)
Describe the AST subtree for a piece of code.
void symbolInfo(PathRef File, Position Pos, Callback< std::vector< SymbolDetails > > CB)
Get symbol info for given position.
void onFileEvent(const DidChangeWatchedFilesParams &Params)
Called when an event occurs for a watched file in the workspace.
void superTypes(const TypeHierarchyItem &Item, Callback< std::optional< std::vector< TypeHierarchyItem > > > CB)
Get direct parents of a type hierarchy item.
void findHover(PathRef File, Position Pos, Callback< std::optional< HoverInfo > > CB)
Get code hover for a given position.
void formatOnType(PathRef File, Position Pos, StringRef TriggerText, Callback< std::vector< TextEdit > > CB)
Run formatting after TriggerText was typed at Pos in File with content Code.
void rename(PathRef File, Position Pos, llvm::StringRef NewName, const RenameOptions &Opts, Callback< RenameResult > CB)
Rename all occurrences of the symbol at the Pos in File to NewName.
void codeAction(const CodeActionInputs &Inputs, Callback< CodeActionResult > CB)
Surface code actions (quick-fixes for diagnostics, or available code tweaks) for a given range in a f...
void locateSymbolAt(PathRef File, Position Pos, Callback< std::vector< LocatedSymbol > > CB)
Find declaration/definition locations of symbol at a specified position.
void incomingCalls(const CallHierarchyItem &Item, Callback< std::vector< CallHierarchyIncomingCall > >)
Resolve incoming calls for a given call hierarchy item.
void inlayHints(PathRef File, std::optional< Range > RestrictRange, Callback< std::vector< InlayHint > >)
Resolve inlay hints for a given document.
void codeComplete(PathRef File, Position Pos, const clangd::CodeCompleteOptions &Opts, Callback< CodeCompleteResult > CB)
Run code completion for File at Pos.
void reparseOpenFilesIfNeeded(llvm::function_ref< bool(llvm::StringRef File)> Filter)
Requests a reparse of currently opened files using their latest source.
void foldingRanges(StringRef File, Callback< std::vector< FoldingRange > > CB)
Retrieve ranges that can be used to fold code within the specified file.
void documentLinks(PathRef File, Callback< std::vector< DocumentLink > > CB)
Get all document links in a file.
std::shared_ptr< const std::string > getDraft(PathRef File) const
Gets the contents of a currently tracked file.
A context is an immutable container for per-request data that must be propagated through layers that ...
Definition: Context.h:69
Context clone() const
Clone this context object.
Definition: Context.cpp:20
static const Context & current()
Returns the context for the current thread, creating it if needed.
Definition: Context.cpp:27
static Deadline infinity()
Definition: Threading.h:51
std::vector< Path > getActiveFiles() const
Definition: DraftStore.cpp:29
std::optional< Draft > getDraft(PathRef File) const
Definition: DraftStore.cpp:19
void removeDraft(PathRef File)
Remove the draft from the store.
Definition: DraftStore.cpp:86
std::string addDraft(PathRef File, llvm::StringRef Version, StringRef Contents)
Replace contents of the draft for File with Contents.
Definition: DraftStore.cpp:75
A FeatureModule contributes a vertical feature to clangd.
Definition: FeatureModule.h:56
This manages symbols from files and an in-memory index on all symbols.
Definition: FileIndex.h:109
Provides compilation arguments used for parsing C and C++ files.
PreambleThrottler controls which preambles can build at any given time.
Definition: TUScheduler.h:98
static bool createEach(ASTContext &AST, const syntax::TokenBuffer &Tokens, unsigned Begin, unsigned End, llvm::function_ref< bool(SelectionTree)> Func)
Definition: Selection.cpp:1055
Interface for symbol indexes that can be used for searching or matching symbols among a set of symbol...
Definition: Index.h:113
Handles running tasks for ClangdServer and managing the resources (e.g., preambles and ASTs) for open...
Definition: TUScheduler.h:213
@ StaleOrAbsent
Besides accepting stale preamble, this also allow preamble to be absent (not ready or failed to build...
Definition: TUScheduler.h:321
@ Stale
The preamble may be generated from an older version of the file.
Definition: TUScheduler.h:318
Wrapper for vfs::FileSystem for use in multithreaded programs like clangd.
Definition: ThreadsafeFS.h:26
llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > view(std::nullopt_t CWD) const
Obtain a vfs::FileSystem with an arbitrary initial working directory.
Definition: ThreadsafeFS.h:32
An interface base for small context-sensitive refactoring actions.
Definition: Tweak.h:46
A source of configuration fragments.
Config getConfig(const Params &, DiagnosticCallback) const
Build a config based on this provider.
Records an event whose duration is the lifetime of the Span object.
Definition: Trace.h:143
@ Changed
The file got changed.
std::vector< TypeHierarchyItem > subTypes(const TypeHierarchyItem &Item, const SymbolIndex *Index)
Returns direct children of a TypeHierarchyItem.
Definition: XRefs.cpp:2204
std::optional< std::vector< TypeHierarchyItem > > superTypes(const TypeHierarchyItem &Item, const SymbolIndex *Index)
Returns direct parents of a TypeHierarchyItem using SymbolIDs stored inside the item.
Definition: XRefs.cpp:2183
std::vector< CallHierarchyIncomingCall > incomingCalls(const CallHierarchyItem &Item, const SymbolIndex *Index)
Definition: XRefs.cpp:2250
std::vector< HighlightingToken > getSemanticHighlightings(ParsedAST &AST, bool IncludeInactiveRegionTokens)
llvm::Expected< std::unique_ptr< Tweak > > prepareTweak(StringRef ID, const Tweak::Selection &S, const FeatureModuleSet *Modules)
Definition: Tweak.cpp:91
ASTNode dumpAST(const DynTypedNode &N, const syntax::TokenBuffer &Tokens, const ASTContext &Ctx)
Definition: DumpAST.cpp:415
std::vector< DocumentHighlight > findDocumentHighlights(ParsedAST &AST, Position Pos)
Returns highlights for all usages of a symbol at Pos.
Definition: XRefs.cpp:1231
std::string Path
A typedef to represent a file path.
Definition: Path.h:26
llvm::Expected< std::vector< FoldingRange > > getFoldingRanges(ParsedAST &AST)
Returns a list of ranges whose contents might be collapsible in an editor.
std::vector< DocumentLink > getDocumentLinks(ParsedAST &AST)
Get all document links.
Definition: XRefs.cpp:839
std::vector< SymbolDetails > getSymbolInfo(ParsedAST &AST, Position Pos)
Get info about symbols at Pos.
Definition: XRefs.cpp:1593
void vlog(const char *Fmt, Ts &&... Vals)
Definition: Logger.h:72
llvm::Error reformatEdit(Edit &E, const format::FormatStyle &Style)
Formats the edits and code around it according to Style.
std::vector< LocatedSymbol > findType(ParsedAST &AST, Position Pos, const SymbolIndex *Index)
Returns symbols for types referenced at Pos.
Definition: XRefs.cpp:2064
llvm::Expected< RenameResult > rename(const RenameInputs &RInputs)
Renames all occurrences of the symbol.
Definition: Rename.cpp:1031
std::vector< TypeHierarchyItem > getTypeHierarchy(ParsedAST &AST, Position Pos, int ResolveLevels, TypeHierarchyDirection Direction, const SymbolIndex *Index, PathRef TUPath)
Get type hierarchy information at Pos.
Definition: XRefs.cpp:2139
llvm::Error error(std::error_code EC, const char *Fmt, Ts &&... Vals)
Definition: Logger.h:79
ReferencesResult findReferences(ParsedAST &AST, Position Pos, uint32_t Limit, const SymbolIndex *Index, bool AddContext)
Returns references of the symbol at a specified Pos.
Definition: XRefs.cpp:1376
llvm::unique_function< void(llvm::Expected< T >)> Callback
A Callback<T> is a void function that accepts Expected<T>.
Definition: Function.h:28
std::optional< HoverInfo > getHover(ParsedAST &AST, Position Pos, const format::FormatStyle &Style, const SymbolIndex *Index)
Get the hover information when hovering at Pos.
Definition: Hover.cpp:1283
std::vector< tooling::Replacement > formatIncremental(llvm::StringRef OriginalCode, unsigned OriginalCursor, llvm::StringRef InsertedText, format::FormatStyle Style)
Applies limited formatting around new InsertedText.
Definition: Format.cpp:277
std::vector< LocatedSymbol > locateSymbolAt(ParsedAST &AST, Position Pos, const SymbolIndex *Index)
Get definition of symbol at a specified Pos.
Definition: XRefs.cpp:760
llvm::Expected< SelectionRange > getSemanticRanges(ParsedAST &AST, Position Pos)
Returns the list of all interesting ranges around the Position Pos.
llvm::Expected< size_t > positionToOffset(llvm::StringRef Code, Position P, bool AllowColumnsBeyondLineLength)
Turn a [line, column] pair into an offset in Code.
Definition: SourceCode.cpp:173
llvm::Expected< std::vector< DocumentSymbol > > getDocumentSymbols(ParsedAST &AST)
Retrieves the symbols contained in the "main file" section of an AST in the same order that they appe...
std::optional< Path > getCorrespondingHeaderOrSource(PathRef OriginalFile, llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > VFS)
Given a header file, returns the best matching source file, and vice visa.
Diag toDiag(const llvm::SMDiagnostic &D, Diag::DiagSource Source)
std::vector< std::unique_ptr< Tweak > > prepareTweaks(const Tweak::Selection &S, llvm::function_ref< bool(const Tweak &)> Filter, const FeatureModuleSet *Modules)
Calls prepare() on all tweaks that satisfy the filter, returning those that can run on the selection.
Definition: Tweak.cpp:72
WantDiagnostics
Determines whether diagnostics should be generated for a file snapshot.
Definition: TUScheduler.h:53
@ Auto
Diagnostics must not be generated for this snapshot.
std::vector< LocatedSymbol > findImplementations(ParsedAST &AST, Position Pos, const SymbolIndex *Index)
Returns implementations at a specified Pos:
Definition: XRefs.cpp:1272
std::vector< InlayHint > inlayHints(ParsedAST &AST, std::optional< Range > RestrictRange)
Compute and return inlay hints for a file.
int isCancelled(const Context &Ctx)
If the current context is within a cancelled task, returns the reason.
void resolveTypeHierarchy(TypeHierarchyItem &Item, int ResolveLevels, TypeHierarchyDirection Direction, const SymbolIndex *Index)
Definition: XRefs.cpp:2213
std::vector< Range > getInactiveRegions(ParsedAST &AST)
Deadline timeoutSeconds(std::optional< double > Seconds)
Makes a deadline from a timeout in seconds. std::nullopt means wait forever.
Definition: Threading.cpp:113
CodeCompleteResult codeComplete(PathRef FileName, Position Pos, const PreambleData *Preamble, const ParseInputs &ParseInput, CodeCompleteOptions Opts, SpeculativeFuzzyFind *SpecFuzzyFind)
Gets code completions at a specified Pos in FileName.
llvm::StringRef PathRef
A typedef to represent a ref to file path.
Definition: Path.h:29
SignatureHelp signatureHelp(PathRef FileName, Position Pos, const PreambleData &Preamble, const ParseInputs &ParseInput, MarkupKind DocumentationFormat)
Get signature help at a specified Pos in FileName.
void elog(const char *Fmt, Ts &&... Vals)
Definition: Logger.h:61
TextEdit replacementToEdit(llvm::StringRef Code, const tooling::Replacement &R)
Definition: SourceCode.cpp:504
SymbolSlab indexStandardLibrary(llvm::StringRef HeaderSources, std::unique_ptr< CompilerInvocation > CI, const StdLibLocation &Loc, const ThreadsafeFS &TFS)
Definition: StdLib.cpp:198
std::vector< CallHierarchyItem > prepareCallHierarchy(ParsedAST &AST, Position Pos, PathRef TUPath)
Get call hierarchy information at Pos.
Definition: XRefs.cpp:2228
format::FormatStyle getFormatStyleForFile(llvm::StringRef File, llvm::StringRef Content, const ThreadsafeFS &TFS, bool FormatFile)
Choose the clang-format style we should apply to a certain file.
Definition: SourceCode.cpp:583
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
std::function< Context(PathRef)> ContextProvider
Definition: Background.h:147
std::function< void(BackgroundQueue::Stats)> OnProgress
Definition: Background.h:143
Represents programming constructs like functions or constructors in the context of call hierarchy.
Definition: Protocol.h:1569
std::vector< std::string > RequestedActionKinds
Requested kind of actions to return.
Definition: ClangdServer.h:367
std::vector< DiagRef > Diagnostics
Diagnostics attached to the code action request.
Definition: ClangdServer.h:370
std::function< bool(const Tweak &)> TweakFilter
Tweaks where Filter returns false will not be checked or included.
Definition: ClangdServer.h:373
static const llvm::StringLiteral QUICKFIX_KIND
Definition: Protocol.h:1070
@ AlwaysParse
Block until we can run the parser (e.g.
Definition: CodeComplete.h:115
Settings that express user/project preferences and control clangd behavior.
Definition: Config.h:44
bool AllScopes
Whether code completion includes results that are not visible in current scopes.
Definition: Config.h:133
static const Config & current()
Returns the Config of the current Context, or an empty configuration.
Definition: Config.cpp:17
struct clang::clangd::Config::@6 Completion
Configures code completion feature.
static DebouncePolicy fixed(clock::duration)
A policy that always returns the same duration, useful for tests.
clangd::Range Range
Definition: Diagnostics.h:66
A top-level diagnostic that may have Notes and Fixes.
Definition: Diagnostics.h:98
std::vector< Fix > Fixes
Alternative fixes for this diagnostic, one should be chosen.
Definition: Diagnostics.h:111
A set of edits generated for a single file.
Definition: SourceCode.h:189
Shared server facilities needed by the module to get its work done.
Definition: FeatureModule.h:76
Represents a single fix-it that editor can apply to fix the error.
Definition: Diagnostics.h:81
A tree that can be used to represent memory usage of nested components while preserving the hierarchy...
Definition: MemoryTree.h:30
MemoryTree & child(llvm::StringLiteral Name)
No copy of the Name.
Definition: MemoryTree.h:39
Information required to run clang, e.g. to parse AST or do code completion.
Definition: Compiler.h:48
The parsed preamble and associated data.
Definition: Preamble.h:95
PrecompiledPreamble Preamble
Definition: Preamble.h:105
Position start
The range's start position.
Definition: Protocol.h:187
Position end
The range's end position.
Definition: Protocol.h:190
Describes the context used to evaluate configuration fragments.
std::chrono::steady_clock::time_point FreshTime
Hint that stale data is OK to improve performance (e.g.
llvm::StringRef Path
Absolute path to a source file we're applying the config to.
Represents measurements of clangd events, e.g.
Definition: Trace.h:38
@ Counter
An aggregate number whose rate of change over time is meaningful.
Definition: Trace.h:46
@ Distribution
A distribution of values with a meaningful mean and count.
Definition: Trace.h:52
void record(double Value, llvm::StringRef Label="") const
Records a measurement for this metric to active tracer.
Definition: Trace.cpp:329