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/Logger.h"
34#include "support/MemoryTree.h"
36#include "support/Trace.h"
37#include "clang/Basic/Stack.h"
38#include "clang/Format/Format.h"
39#include "clang/Lex/Preprocessor.h"
40#include "clang/Tooling/CompilationDatabase.h"
41#include "clang/Tooling/Core/Replacement.h"
42#include "llvm/ADT/ArrayRef.h"
43#include "llvm/ADT/STLExtras.h"
44#include "llvm/ADT/StringRef.h"
45#include "llvm/Support/Error.h"
46#include "llvm/Support/Path.h"
47#include "llvm/Support/raw_ostream.h"
48#include <algorithm>
49#include <chrono>
50#include <future>
51#include <memory>
52#include <mutex>
53#include <optional>
54#include <string>
55#include <type_traits>
56#include <utility>
57#include <vector>
58
59namespace clang {
60namespace clangd {
61namespace {
62
63// Tracks number of times a tweak has been offered.
64static constexpr trace::Metric TweakAvailable(
65 "tweak_available", trace::Metric::Counter, "tweak_id");
66
67// Update the FileIndex with new ASTs and plumb the diagnostics responses.
68struct UpdateIndexCallbacks : public ParsingCallbacks {
69 UpdateIndexCallbacks(FileIndex *FIndex,
70 ClangdServer::Callbacks *ServerCallbacks,
71 const ThreadsafeFS &TFS, AsyncTaskRunner *Tasks,
72 bool CollectInactiveRegions)
73 : FIndex(FIndex), ServerCallbacks(ServerCallbacks), TFS(TFS),
74 Stdlib{std::make_shared<StdLibSet>()}, Tasks(Tasks),
75 CollectInactiveRegions(CollectInactiveRegions) {}
76
77 void onPreambleAST(
78 PathRef Path, llvm::StringRef Version, CapturedASTCtx ASTCtx,
79 std::shared_ptr<const include_cleaner::PragmaIncludes> PI) override {
80
81 if (!FIndex)
82 return;
83
84 auto &PP = ASTCtx.getPreprocessor();
85 auto &CI = ASTCtx.getCompilerInvocation();
86 if (auto Loc = Stdlib->add(CI.getLangOpts(), PP.getHeaderSearchInfo()))
87 indexStdlib(CI, std::move(*Loc));
88
89 // FIndex outlives the UpdateIndexCallbacks.
90 auto Task = [FIndex(FIndex), Path(Path.str()), Version(Version.str()),
91 ASTCtx(std::move(ASTCtx)), PI(std::move(PI))]() mutable {
92 trace::Span Tracer("PreambleIndexing");
93 FIndex->updatePreamble(Path, Version, ASTCtx.getASTContext(),
94 ASTCtx.getPreprocessor(), *PI);
95 };
96
97 if (Tasks) {
98 Tasks->runAsync("Preamble indexing for:" + Path + Version,
99 std::move(Task));
100 } else
101 Task();
102 }
103
104 void indexStdlib(const CompilerInvocation &CI, StdLibLocation Loc) {
105 // This task is owned by Tasks, which outlives the TUScheduler and
106 // therefore the UpdateIndexCallbacks.
107 // We must be careful that the references we capture outlive TUScheduler.
108 auto Task = [LO(CI.getLangOpts()), Loc(std::move(Loc)),
109 CI(std::make_unique<CompilerInvocation>(CI)),
110 // External values that outlive ClangdServer
111 TFS(&TFS),
112 // Index outlives TUScheduler (declared first)
113 FIndex(FIndex),
114 // shared_ptr extends lifetime
115 Stdlib(Stdlib)]() mutable {
116 clang::noteBottomOfStack();
117 IndexFileIn IF;
118 IF.Symbols = indexStandardLibrary(std::move(CI), Loc, *TFS);
119 if (Stdlib->isBest(LO))
120 FIndex->updatePreamble(std::move(IF));
121 };
122 if (Tasks)
123 // This doesn't have a semaphore to enforce -j, but it's rare.
124 Tasks->runAsync("IndexStdlib", std::move(Task));
125 else
126 Task();
127 }
128
129 void onMainAST(PathRef Path, ParsedAST &AST, PublishFn Publish) override {
130 if (FIndex)
131 FIndex->updateMain(Path, AST);
132
133 if (ServerCallbacks)
134 Publish([&]() {
135 ServerCallbacks->onDiagnosticsReady(Path, AST.version(),
136 AST.getDiagnostics());
137 if (CollectInactiveRegions) {
138 ServerCallbacks->onInactiveRegionsReady(Path,
140 }
141 });
142 }
143
144 void onFailedAST(PathRef Path, llvm::StringRef Version,
145 std::vector<Diag> Diags, PublishFn Publish) override {
146 if (ServerCallbacks)
147 Publish(
148 [&]() { ServerCallbacks->onDiagnosticsReady(Path, Version, Diags); });
149 }
150
151 void onFileUpdated(PathRef File, const TUStatus &Status) override {
152 if (ServerCallbacks)
153 ServerCallbacks->onFileUpdated(File, Status);
154 }
155
156 void onPreamblePublished(PathRef File) override {
157 if (ServerCallbacks)
158 ServerCallbacks->onSemanticsMaybeChanged(File);
159 }
160
161private:
162 FileIndex *FIndex;
163 ClangdServer::Callbacks *ServerCallbacks;
164 const ThreadsafeFS &TFS;
165 std::shared_ptr<StdLibSet> Stdlib;
166 AsyncTaskRunner *Tasks;
167 bool CollectInactiveRegions;
168};
169
170class DraftStoreFS : public ThreadsafeFS {
171public:
172 DraftStoreFS(const ThreadsafeFS &Base, const DraftStore &Drafts)
173 : Base(Base), DirtyFiles(Drafts) {}
174
175private:
176 llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> viewImpl() const override {
177 auto OFS = llvm::makeIntrusiveRefCnt<llvm::vfs::OverlayFileSystem>(
178 Base.view(std::nullopt));
179 OFS->pushOverlay(DirtyFiles.asVFS());
180 return OFS;
181 }
182
183 const ThreadsafeFS &Base;
184 const DraftStore &DirtyFiles;
185};
186
187} // namespace
188
191 Opts.UpdateDebounce = DebouncePolicy::fixed(/*zero*/ {});
192 Opts.StorePreamblesInMemory = true;
193 Opts.AsyncThreadsCount = 4; // Consistent!
194 return Opts;
195}
196
197ClangdServer::Options::operator TUScheduler::Options() const {
199 Opts.AsyncThreadsCount = AsyncThreadsCount;
200 Opts.RetentionPolicy = RetentionPolicy;
201 Opts.StorePreamblesInMemory = StorePreamblesInMemory;
202 Opts.UpdateDebounce = UpdateDebounce;
203 Opts.ContextProvider = ContextProvider;
204 Opts.PreambleThrottler = PreambleThrottler;
205 return Opts;
206}
207
209 const ThreadsafeFS &TFS, const Options &Opts,
211 : FeatureModules(Opts.FeatureModules), CDB(CDB), TFS(TFS),
212 DynamicIdx(Opts.BuildDynamicSymbolIndex ? new FileIndex() : nullptr),
213 ClangTidyProvider(Opts.ClangTidyProvider),
214 UseDirtyHeaders(Opts.UseDirtyHeaders),
215 LineFoldingOnly(Opts.LineFoldingOnly),
216 PreambleParseForwardingFunctions(Opts.PreambleParseForwardingFunctions),
217 ImportInsertions(Opts.ImportInsertions),
218 PublishInactiveRegions(Opts.PublishInactiveRegions),
219 WorkspaceRoot(Opts.WorkspaceRoot),
220 Transient(Opts.ImplicitCancellation ? TUScheduler::InvalidateOnUpdate
221 : TUScheduler::NoInvalidation),
222 DirtyFS(std::make_unique<DraftStoreFS>(TFS, DraftMgr)) {
223 if (Opts.AsyncThreadsCount != 0)
224 IndexTasks.emplace();
225 // Pass a callback into `WorkScheduler` to extract symbols from a newly
226 // parsed file and rebuild the file index synchronously each time an AST
227 // is parsed.
228 WorkScheduler.emplace(CDB, TUScheduler::Options(Opts),
229 std::make_unique<UpdateIndexCallbacks>(
230 DynamicIdx.get(), Callbacks, TFS,
231 IndexTasks ? &*IndexTasks : nullptr,
232 PublishInactiveRegions));
233 // Adds an index to the stack, at higher priority than existing indexes.
234 auto AddIndex = [&](SymbolIndex *Idx) {
235 if (this->Index != nullptr) {
236 MergedIdx.push_back(std::make_unique<MergedIndex>(Idx, this->Index));
237 this->Index = MergedIdx.back().get();
238 } else {
239 this->Index = Idx;
240 }
241 };
242 if (Opts.StaticIndex)
243 AddIndex(Opts.StaticIndex);
244 if (Opts.BackgroundIndex) {
246 BGOpts.ThreadPoolSize = std::max(Opts.AsyncThreadsCount, 1u);
248 if (Callbacks)
250 };
251 BGOpts.ContextProvider = Opts.ContextProvider;
252 BackgroundIdx = std::make_unique<BackgroundIndex>(
253 TFS, CDB,
255 [&CDB](llvm::StringRef File) { return CDB.getProjectInfo(File); }),
256 std::move(BGOpts));
257 AddIndex(BackgroundIdx.get());
258 }
259 if (DynamicIdx)
260 AddIndex(DynamicIdx.get());
261
262 if (Opts.FeatureModules) {
264 *this->WorkScheduler,
265 this->Index,
266 this->TFS,
267 };
268 for (auto &Mod : *Opts.FeatureModules)
269 Mod.initialize(F);
270 }
271}
272
274 // Destroying TUScheduler first shuts down request threads that might
275 // otherwise access members concurrently.
276 // (Nobody can be using TUScheduler because we're on the main thread).
277 WorkScheduler.reset();
278 // Now requests have stopped, we can shut down feature modules.
279 if (FeatureModules) {
280 for (auto &Mod : *FeatureModules)
281 Mod.stop();
282 for (auto &Mod : *FeatureModules)
283 Mod.blockUntilIdle(Deadline::infinity());
284 }
285}
286
287void ClangdServer::addDocument(PathRef File, llvm::StringRef Contents,
288 llvm::StringRef Version,
289 WantDiagnostics WantDiags, bool ForceRebuild) {
290 std::string ActualVersion = DraftMgr.addDraft(File, Version, Contents);
291 ParseOptions Opts;
292 Opts.PreambleParseForwardingFunctions = PreambleParseForwardingFunctions;
293 Opts.ImportInsertions = ImportInsertions;
294
295 // Compile command is set asynchronously during update, as it can be slow.
296 ParseInputs Inputs;
297 Inputs.TFS = &getHeaderFS();
298 Inputs.Contents = std::string(Contents);
299 Inputs.Version = std::move(ActualVersion);
300 Inputs.ForceRebuild = ForceRebuild;
301 Inputs.Opts = std::move(Opts);
302 Inputs.Index = Index;
303 Inputs.ClangTidyProvider = ClangTidyProvider;
304 Inputs.FeatureModules = FeatureModules;
305 bool NewFile = WorkScheduler->update(File, Inputs, WantDiags);
306 // If we loaded Foo.h, we want to make sure Foo.cpp is indexed.
307 if (NewFile && BackgroundIdx)
308 BackgroundIdx->boostRelated(File);
309}
310
312 llvm::function_ref<bool(llvm::StringRef File)> Filter) {
313 // Reparse only opened files that were modified.
314 for (const Path &FilePath : DraftMgr.getActiveFiles())
315 if (Filter(FilePath))
316 if (auto Draft = DraftMgr.getDraft(FilePath)) // else disappeared in race?
317 addDocument(FilePath, *Draft->Contents, Draft->Version,
319}
320
321std::shared_ptr<const std::string> ClangdServer::getDraft(PathRef File) const {
322 auto Draft = DraftMgr.getDraft(File);
323 if (!Draft)
324 return nullptr;
325 return std::move(Draft->Contents);
326}
327
328std::function<Context(PathRef)>
330 Callbacks *Publish) {
331 if (!Provider)
332 return [](llvm::StringRef) { return Context::current().clone(); };
333
334 struct Impl {
335 const config::Provider *Provider;
337 std::mutex PublishMu;
338
339 Impl(const config::Provider *Provider, ClangdServer::Callbacks *Publish)
340 : Provider(Provider), Publish(Publish) {}
341
342 Context operator()(llvm::StringRef File) {
343 config::Params Params;
344 // Don't reread config files excessively often.
345 // FIXME: when we see a config file change event, use the event timestamp?
346 Params.FreshTime =
347 std::chrono::steady_clock::now() - std::chrono::seconds(5);
348 llvm::SmallString<256> PosixPath;
349 if (!File.empty()) {
350 assert(llvm::sys::path::is_absolute(File));
351 llvm::sys::path::native(File, PosixPath, llvm::sys::path::Style::posix);
352 Params.Path = PosixPath.str();
353 }
354
355 llvm::StringMap<std::vector<Diag>> ReportableDiagnostics;
356 Config C = Provider->getConfig(Params, [&](const llvm::SMDiagnostic &D) {
357 // Create the map entry even for note diagnostics we don't report.
358 // This means that when the file is parsed with no warnings, we
359 // publish an empty set of diagnostics, clearing any the client has.
360 handleDiagnostic(D, !Publish || D.getFilename().empty()
361 ? nullptr
362 : &ReportableDiagnostics[D.getFilename()]);
363 });
364 // Blindly publish diagnostics for the (unopened) parsed config files.
365 // We must avoid reporting diagnostics for *the same file* concurrently.
366 // Source diags are published elsewhere, but those are different files.
367 if (!ReportableDiagnostics.empty()) {
368 std::lock_guard<std::mutex> Lock(PublishMu);
369 for (auto &Entry : ReportableDiagnostics)
370 Publish->onDiagnosticsReady(Entry.first(), /*Version=*/"",
371 Entry.second);
372 }
373 return Context::current().derive(Config::Key, std::move(C));
374 }
375
376 void handleDiagnostic(const llvm::SMDiagnostic &D,
377 std::vector<Diag> *ClientDiagnostics) {
378 switch (D.getKind()) {
379 case llvm::SourceMgr::DK_Error:
380 elog("config error at {0}:{1}:{2}: {3}", D.getFilename(), D.getLineNo(),
381 D.getColumnNo(), D.getMessage());
382 break;
383 case llvm::SourceMgr::DK_Warning:
384 log("config warning at {0}:{1}:{2}: {3}", D.getFilename(),
385 D.getLineNo(), D.getColumnNo(), D.getMessage());
386 break;
387 case llvm::SourceMgr::DK_Note:
388 case llvm::SourceMgr::DK_Remark:
389 vlog("config note at {0}:{1}:{2}: {3}", D.getFilename(), D.getLineNo(),
390 D.getColumnNo(), D.getMessage());
391 ClientDiagnostics = nullptr; // Don't emit notes as LSP diagnostics.
392 break;
393 }
394 if (ClientDiagnostics)
395 ClientDiagnostics->push_back(toDiag(D, Diag::ClangdConfig));
396 }
397 };
398
399 // Copyable wrapper.
400 return [I(std::make_shared<Impl>(Provider, Publish))](llvm::StringRef Path) {
401 return (*I)(Path);
402 };
403}
404
406 DraftMgr.removeDraft(File);
407 WorkScheduler->remove(File);
408}
409
411 const clangd::CodeCompleteOptions &Opts,
413 // Copy completion options for passing them to async task handler.
414 auto CodeCompleteOpts = Opts;
415 if (!CodeCompleteOpts.Index) // Respect overridden index.
416 CodeCompleteOpts.Index = Index;
417
418 auto Task = [Pos, CodeCompleteOpts, File = File.str(), CB = std::move(CB),
419 this](llvm::Expected<InputsAndPreamble> IP) mutable {
420 if (!IP)
421 return CB(IP.takeError());
422 if (auto Reason = isCancelled())
423 return CB(llvm::make_error<CancelledError>(Reason));
424
425 std::optional<SpeculativeFuzzyFind> SpecFuzzyFind;
426 if (!IP->Preamble) {
427 // No speculation in Fallback mode, as it's supposed to be much faster
428 // without compiling.
429 vlog("Build for file {0} is not ready. Enter fallback mode.", File);
430 } else if (CodeCompleteOpts.Index) {
431 SpecFuzzyFind.emplace();
432 {
433 std::lock_guard<std::mutex> Lock(CachedCompletionFuzzyFindRequestMutex);
434 SpecFuzzyFind->CachedReq = CachedCompletionFuzzyFindRequestByFile[File];
435 }
436 }
437 ParseInputs ParseInput{IP->Command, &getHeaderFS(), IP->Contents.str()};
438 // FIXME: Add traling new line if there is none at eof, workaround a crash,
439 // see https://github.com/clangd/clangd/issues/332
440 if (!IP->Contents.ends_with("\n"))
441 ParseInput.Contents.append("\n");
442 ParseInput.Index = Index;
443
444 CodeCompleteOpts.MainFileSignals = IP->Signals;
445 CodeCompleteOpts.AllScopes = Config::current().Completion.AllScopes;
446 // FIXME(ibiryukov): even if Preamble is non-null, we may want to check
447 // both the old and the new version in case only one of them matches.
449 File, Pos, IP->Preamble, ParseInput, CodeCompleteOpts,
450 SpecFuzzyFind ? &*SpecFuzzyFind : nullptr);
451 {
452 clang::clangd::trace::Span Tracer("Completion results callback");
453 CB(std::move(Result));
454 }
455 if (SpecFuzzyFind && SpecFuzzyFind->NewReq) {
456 std::lock_guard<std::mutex> Lock(CachedCompletionFuzzyFindRequestMutex);
457 CachedCompletionFuzzyFindRequestByFile[File] = *SpecFuzzyFind->NewReq;
458 }
459 // SpecFuzzyFind is only destroyed after speculative fuzzy find finishes.
460 // We don't want `codeComplete` to wait for the async call if it doesn't use
461 // the result (e.g. non-index completion, speculation fails), so that `CB`
462 // is called as soon as results are available.
463 };
464
465 // We use a potentially-stale preamble because latency is critical here.
466 WorkScheduler->runWithPreamble(
467 "CodeComplete", File,
468 (Opts.RunParser == CodeCompleteOptions::AlwaysParse)
471 std::move(Task));
472}
473
475 MarkupKind DocumentationFormat,
477
478 auto Action = [Pos, File = File.str(), CB = std::move(CB),
479 DocumentationFormat,
480 this](llvm::Expected<InputsAndPreamble> IP) mutable {
481 if (!IP)
482 return CB(IP.takeError());
483
484 const auto *PreambleData = IP->Preamble;
485 if (!PreambleData)
486 return CB(error("Failed to parse includes"));
487
488 ParseInputs ParseInput{IP->Command, &getHeaderFS(), IP->Contents.str()};
489 // FIXME: Add traling new line if there is none at eof, workaround a crash,
490 // see https://github.com/clangd/clangd/issues/332
491 if (!IP->Contents.ends_with("\n"))
492 ParseInput.Contents.append("\n");
493 ParseInput.Index = Index;
495 DocumentationFormat));
496 };
497
498 // Unlike code completion, we wait for a preamble here.
499 WorkScheduler->runWithPreamble("SignatureHelp", File, TUScheduler::Stale,
500 std::move(Action));
501}
502
503void ClangdServer::formatFile(PathRef File, std::optional<Range> Rng,
505 auto Code = getDraft(File);
506 if (!Code)
507 return CB(llvm::make_error<LSPError>("trying to format non-added document",
509 tooling::Range RequestedRange;
510 if (Rng) {
511 llvm::Expected<size_t> Begin = positionToOffset(*Code, Rng->start);
512 if (!Begin)
513 return CB(Begin.takeError());
514 llvm::Expected<size_t> End = positionToOffset(*Code, Rng->end);
515 if (!End)
516 return CB(End.takeError());
517 RequestedRange = tooling::Range(*Begin, *End - *Begin);
518 } else {
519 RequestedRange = tooling::Range(0, Code->size());
520 }
521
522 // Call clang-format.
523 auto Action = [File = File.str(), Code = std::move(*Code),
524 Ranges = std::vector<tooling::Range>{RequestedRange},
525 CB = std::move(CB), this]() mutable {
526 format::FormatStyle Style = getFormatStyleForFile(File, Code, TFS);
527 tooling::Replacements IncludeReplaces =
528 format::sortIncludes(Style, Code, Ranges, File);
529 auto Changed = tooling::applyAllReplacements(Code, IncludeReplaces);
530 if (!Changed)
531 return CB(Changed.takeError());
532
533 CB(IncludeReplaces.merge(format::reformat(
534 Style, *Changed,
535 tooling::calculateRangesAfterReplacements(IncludeReplaces, Ranges),
536 File)));
537 };
538 WorkScheduler->runQuick("Format", File, std::move(Action));
539}
540
542 StringRef TriggerText,
543 Callback<std::vector<TextEdit>> CB) {
544 auto Code = getDraft(File);
545 if (!Code)
546 return CB(llvm::make_error<LSPError>("trying to format non-added document",
548 llvm::Expected<size_t> CursorPos = positionToOffset(*Code, Pos);
549 if (!CursorPos)
550 return CB(CursorPos.takeError());
551 auto Action = [File = File.str(), Code = std::move(*Code),
552 TriggerText = TriggerText.str(), CursorPos = *CursorPos,
553 CB = std::move(CB), this]() mutable {
554 auto Style = format::getStyle(format::DefaultFormatStyle, File,
555 format::DefaultFallbackStyle, Code,
556 TFS.view(/*CWD=*/std::nullopt).get());
557 if (!Style)
558 return CB(Style.takeError());
559
560 std::vector<TextEdit> Result;
561 for (const tooling::Replacement &R :
562 formatIncremental(Code, CursorPos, TriggerText, *Style))
563 Result.push_back(replacementToEdit(Code, R));
564 return CB(Result);
565 };
566 WorkScheduler->runQuick("FormatOnType", File, std::move(Action));
567}
568
570 std::optional<std::string> NewName,
571 const RenameOptions &RenameOpts,
573 auto Action = [Pos, File = File.str(), CB = std::move(CB),
574 NewName = std::move(NewName),
575 RenameOpts](llvm::Expected<InputsAndAST> InpAST) mutable {
576 if (!InpAST)
577 return CB(InpAST.takeError());
578 // prepareRename is latency-sensitive: we don't query the index, as we
579 // only need main-file references
580 auto Results =
581 clangd::rename({Pos, NewName.value_or("__clangd_rename_placeholder"),
582 InpAST->AST, File, /*FS=*/nullptr,
583 /*Index=*/nullptr, RenameOpts});
584 if (!Results) {
585 // LSP says to return null on failure, but that will result in a generic
586 // failure message. If we send an LSP error response, clients can surface
587 // the message to users (VSCode does).
588 return CB(Results.takeError());
589 }
590 return CB(*Results);
591 };
592 WorkScheduler->runWithAST("PrepareRename", File, std::move(Action));
593}
594
595void ClangdServer::rename(PathRef File, Position Pos, llvm::StringRef NewName,
596 const RenameOptions &Opts,
598 auto Action = [File = File.str(), NewName = NewName.str(), Pos, Opts,
599 CB = std::move(CB),
600 this](llvm::Expected<InputsAndAST> InpAST) mutable {
601 // Tracks number of files edited per invocation.
602 static constexpr trace::Metric RenameFiles("rename_files",
604 if (!InpAST)
605 return CB(InpAST.takeError());
606 auto R = clangd::rename({Pos, NewName, InpAST->AST, File,
607 DirtyFS->view(std::nullopt), Index, Opts});
608 if (!R)
609 return CB(R.takeError());
610
611 if (Opts.WantFormat) {
612 auto Style = getFormatStyleForFile(File, InpAST->Inputs.Contents,
613 *InpAST->Inputs.TFS);
614 llvm::Error Err = llvm::Error::success();
615 for (auto &E : R->GlobalChanges)
616 Err =
617 llvm::joinErrors(reformatEdit(E.getValue(), Style), std::move(Err));
618
619 if (Err)
620 return CB(std::move(Err));
621 }
622 RenameFiles.record(R->GlobalChanges.size());
623 return CB(*R);
624 };
625 WorkScheduler->runWithAST("Rename", File, std::move(Action));
626}
627
628// May generate several candidate selections, due to SelectionTree ambiguity.
629// vector of pointers because GCC doesn't like non-copyable Selection.
630static llvm::Expected<std::vector<std::unique_ptr<Tweak::Selection>>>
632 llvm::vfs::FileSystem *FS) {
633 auto Begin = positionToOffset(AST.Inputs.Contents, Sel.start);
634 if (!Begin)
635 return Begin.takeError();
636 auto End = positionToOffset(AST.Inputs.Contents, Sel.end);
637 if (!End)
638 return End.takeError();
639 std::vector<std::unique_ptr<Tweak::Selection>> Result;
641 AST.AST.getASTContext(), AST.AST.getTokens(), *Begin, *End,
642 [&](SelectionTree T) {
643 Result.push_back(std::make_unique<Tweak::Selection>(
644 AST.Inputs.Index, AST.AST, *Begin, *End, std::move(T), FS));
645 return false;
646 });
647 assert(!Result.empty() && "Expected at least one SelectionTree");
648 return std::move(Result);
649}
650
653 auto Action = [Params, CB = std::move(CB),
654 FeatureModules(this->FeatureModules)](
655 Expected<InputsAndAST> InpAST) mutable {
656 if (!InpAST)
657 return CB(InpAST.takeError());
658 auto KindAllowed =
659 [Only(Params.RequestedActionKinds)](llvm::StringRef Kind) {
660 if (Only.empty())
661 return true;
662 return llvm::any_of(Only, [&](llvm::StringRef Base) {
663 return Kind.consume_front(Base) &&
664 (Kind.empty() || Kind.starts_with("."));
665 });
666 };
667
668 CodeActionResult Result;
669 Result.Version = InpAST->AST.version().str();
670 if (KindAllowed(CodeAction::QUICKFIX_KIND)) {
671 auto FindMatchedFixes =
672 [&InpAST](const DiagRef &DR) -> llvm::ArrayRef<Fix> {
673 for (const auto &Diag : InpAST->AST.getDiagnostics())
674 if (Diag.Range == DR.Range && Diag.Message == DR.Message)
675 return Diag.Fixes;
676 return {};
677 };
678 for (const auto &Diag : Params.Diagnostics)
679 for (const auto &Fix : FindMatchedFixes(Diag))
680 Result.QuickFixes.push_back({Diag, Fix});
681 }
682
683 // Collect Tweaks
684 auto Selections = tweakSelection(Params.Selection, *InpAST, /*FS=*/nullptr);
685 if (!Selections)
686 return CB(Selections.takeError());
687 // Don't allow a tweak to fire more than once across ambiguous selections.
688 llvm::DenseSet<llvm::StringRef> PreparedTweaks;
689 auto DeduplicatingFilter = [&](const Tweak &T) {
690 return KindAllowed(T.kind()) && Params.TweakFilter(T) &&
691 !PreparedTweaks.count(T.id());
692 };
693 for (const auto &Sel : *Selections) {
694 for (auto &T : prepareTweaks(*Sel, DeduplicatingFilter, FeatureModules)) {
695 Result.TweakRefs.push_back(TweakRef{T->id(), T->title(), T->kind()});
696 PreparedTweaks.insert(T->id());
697 TweakAvailable.record(1, T->id());
698 }
699 }
700 CB(std::move(Result));
701 };
702
703 WorkScheduler->runWithAST("codeAction", Params.File, std::move(Action),
704 Transient);
705}
706
707void ClangdServer::applyTweak(PathRef File, Range Sel, StringRef TweakID,
709 // Tracks number of times a tweak has been attempted.
710 static constexpr trace::Metric TweakAttempt(
711 "tweak_attempt", trace::Metric::Counter, "tweak_id");
712 // Tracks number of times a tweak has failed to produce edits.
713 static constexpr trace::Metric TweakFailed(
714 "tweak_failed", trace::Metric::Counter, "tweak_id");
715 TweakAttempt.record(1, TweakID);
716 auto Action = [File = File.str(), Sel, TweakID = TweakID.str(),
717 CB = std::move(CB),
718 this](Expected<InputsAndAST> InpAST) mutable {
719 if (!InpAST)
720 return CB(InpAST.takeError());
721 auto FS = DirtyFS->view(std::nullopt);
722 auto Selections = tweakSelection(Sel, *InpAST, FS.get());
723 if (!Selections)
724 return CB(Selections.takeError());
725 std::optional<llvm::Expected<Tweak::Effect>> Effect;
726 // Try each selection, take the first one that prepare()s.
727 // If they all fail, Effect will hold get the last error.
728 for (const auto &Selection : *Selections) {
729 auto T = prepareTweak(TweakID, *Selection, FeatureModules);
730 if (T) {
731 Effect = (*T)->apply(*Selection);
732 break;
733 }
734 Effect = T.takeError();
735 }
736 assert(Effect && "Expected at least one selection");
737 if (*Effect && (*Effect)->FormatEdits) {
738 // Format tweaks that require it centrally here.
739 for (auto &It : (*Effect)->ApplyEdits) {
740 Edit &E = It.second;
741 format::FormatStyle Style =
742 getFormatStyleForFile(File, E.InitialCode, TFS);
743 if (llvm::Error Err = reformatEdit(E, Style))
744 elog("Failed to format {0}: {1}", It.first(), std::move(Err));
745 }
746 } else {
747 TweakFailed.record(1, TweakID);
748 }
749 return CB(std::move(*Effect));
750 };
751 WorkScheduler->runWithAST("ApplyTweak", File, std::move(Action));
752}
753
754void ClangdServer::locateSymbolAt(PathRef File, Position Pos,
755 Callback<std::vector<LocatedSymbol>> CB) {
756 auto Action = [Pos, CB = std::move(CB),
757 this](llvm::Expected<InputsAndAST> InpAST) mutable {
758 if (!InpAST)
759 return CB(InpAST.takeError());
760 CB(clangd::locateSymbolAt(InpAST->AST, Pos, Index));
761 };
762
763 WorkScheduler->runWithAST("Definitions", File, std::move(Action));
764}
765
766void ClangdServer::switchSourceHeader(
767 PathRef Path, Callback<std::optional<clangd::Path>> CB) {
768 // We want to return the result as fast as possible, strategy is:
769 // 1) use the file-only heuristic, it requires some IO but it is much
770 // faster than building AST, but it only works when .h/.cc files are in
771 // the same directory.
772 // 2) if 1) fails, we use the AST&Index approach, it is slower but supports
773 // different code layout.
774 if (auto CorrespondingFile =
775 getCorrespondingHeaderOrSource(Path, TFS.view(std::nullopt)))
776 return CB(std::move(CorrespondingFile));
777 auto Action = [Path = Path.str(), CB = std::move(CB),
778 this](llvm::Expected<InputsAndAST> InpAST) mutable {
779 if (!InpAST)
780 return CB(InpAST.takeError());
781 CB(getCorrespondingHeaderOrSource(Path, InpAST->AST, Index));
782 };
783 WorkScheduler->runWithAST("SwitchHeaderSource", Path, std::move(Action));
784}
785
786void ClangdServer::findDocumentHighlights(
787 PathRef File, Position Pos, Callback<std::vector<DocumentHighlight>> CB) {
788 auto Action =
789 [Pos, CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
790 if (!InpAST)
791 return CB(InpAST.takeError());
792 CB(clangd::findDocumentHighlights(InpAST->AST, Pos));
793 };
794
795 WorkScheduler->runWithAST("Highlights", File, std::move(Action), Transient);
796}
797
798void ClangdServer::findHover(PathRef File, Position Pos,
799 Callback<std::optional<HoverInfo>> CB) {
800 auto Action = [File = File.str(), Pos, CB = std::move(CB),
801 this](llvm::Expected<InputsAndAST> InpAST) mutable {
802 if (!InpAST)
803 return CB(InpAST.takeError());
804 format::FormatStyle Style = getFormatStyleForFile(
805 File, InpAST->Inputs.Contents, *InpAST->Inputs.TFS);
806 CB(clangd::getHover(InpAST->AST, Pos, std::move(Style), Index));
807 };
808
809 WorkScheduler->runWithAST("Hover", File, std::move(Action), Transient);
810}
811
812void ClangdServer::typeHierarchy(PathRef File, Position Pos, int Resolve,
813 TypeHierarchyDirection Direction,
814 Callback<std::vector<TypeHierarchyItem>> CB) {
815 auto Action = [File = File.str(), Pos, Resolve, Direction, CB = std::move(CB),
816 this](Expected<InputsAndAST> InpAST) mutable {
817 if (!InpAST)
818 return CB(InpAST.takeError());
819 CB(clangd::getTypeHierarchy(InpAST->AST, Pos, Resolve, Direction, Index,
820 File));
821 };
822
823 WorkScheduler->runWithAST("TypeHierarchy", File, std::move(Action));
824}
825
826void ClangdServer::superTypes(
827 const TypeHierarchyItem &Item,
828 Callback<std::optional<std::vector<TypeHierarchyItem>>> CB) {
829 WorkScheduler->run("typeHierarchy/superTypes", /*Path=*/"",
830 [=, CB = std::move(CB)]() mutable {
831 CB(clangd::superTypes(Item, Index));
832 });
833}
834
835void ClangdServer::subTypes(const TypeHierarchyItem &Item,
836 Callback<std::vector<TypeHierarchyItem>> CB) {
837 WorkScheduler->run(
838 "typeHierarchy/subTypes", /*Path=*/"",
839 [=, CB = std::move(CB)]() mutable { CB(clangd::subTypes(Item, Index)); });
840}
841
842void ClangdServer::resolveTypeHierarchy(
843 TypeHierarchyItem Item, int Resolve, TypeHierarchyDirection Direction,
844 Callback<std::optional<TypeHierarchyItem>> CB) {
845 WorkScheduler->run(
846 "Resolve Type Hierarchy", "", [=, CB = std::move(CB)]() mutable {
847 clangd::resolveTypeHierarchy(Item, Resolve, Direction, Index);
848 CB(Item);
849 });
850}
851
852void ClangdServer::prepareCallHierarchy(
853 PathRef File, Position Pos, Callback<std::vector<CallHierarchyItem>> CB) {
854 auto Action = [File = File.str(), Pos,
855 CB = std::move(CB)](Expected<InputsAndAST> InpAST) mutable {
856 if (!InpAST)
857 return CB(InpAST.takeError());
858 CB(clangd::prepareCallHierarchy(InpAST->AST, Pos, File));
859 };
860 WorkScheduler->runWithAST("CallHierarchy", File, std::move(Action));
861}
862
863void ClangdServer::incomingCalls(
864 const CallHierarchyItem &Item,
865 Callback<std::vector<CallHierarchyIncomingCall>> CB) {
866 WorkScheduler->run("Incoming Calls", "",
867 [CB = std::move(CB), Item, this]() mutable {
868 CB(clangd::incomingCalls(Item, Index));
869 });
870}
871
872void ClangdServer::inlayHints(PathRef File, std::optional<Range> RestrictRange,
873 Callback<std::vector<InlayHint>> CB) {
874 auto Action = [RestrictRange(std::move(RestrictRange)),
875 CB = std::move(CB)](Expected<InputsAndAST> InpAST) mutable {
876 if (!InpAST)
877 return CB(InpAST.takeError());
878 CB(clangd::inlayHints(InpAST->AST, std::move(RestrictRange)));
879 };
880 WorkScheduler->runWithAST("InlayHints", File, std::move(Action), Transient);
881}
882
883void ClangdServer::onFileEvent(const DidChangeWatchedFilesParams &Params) {
884 // FIXME: Do nothing for now. This will be used for indexing and potentially
885 // invalidating other caches.
886}
887
888void ClangdServer::workspaceSymbols(
889 llvm::StringRef Query, int Limit,
890 Callback<std::vector<SymbolInformation>> CB) {
891 WorkScheduler->run(
892 "getWorkspaceSymbols", /*Path=*/"",
893 [Query = Query.str(), Limit, CB = std::move(CB), this]() mutable {
894 CB(clangd::getWorkspaceSymbols(Query, Limit, Index,
895 WorkspaceRoot.value_or("")));
896 });
897}
898
899void ClangdServer::documentSymbols(llvm::StringRef File,
900 Callback<std::vector<DocumentSymbol>> CB) {
901 auto Action =
902 [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
903 if (!InpAST)
904 return CB(InpAST.takeError());
905 CB(clangd::getDocumentSymbols(InpAST->AST));
906 };
907 WorkScheduler->runWithAST("DocumentSymbols", File, std::move(Action),
908 Transient);
909}
910
911void ClangdServer::foldingRanges(llvm::StringRef File,
912 Callback<std::vector<FoldingRange>> CB) {
913 auto Code = getDraft(File);
914 if (!Code)
915 return CB(llvm::make_error<LSPError>(
916 "trying to compute folding ranges for non-added document",
917 ErrorCode::InvalidParams));
918 auto Action = [LineFoldingOnly = LineFoldingOnly, CB = std::move(CB),
919 Code = std::move(*Code)]() mutable {
920 CB(clangd::getFoldingRanges(Code, LineFoldingOnly));
921 };
922 // We want to make sure folding ranges are always available for all the open
923 // files, hence prefer runQuick to not wait for operations on other files.
924 WorkScheduler->runQuick("FoldingRanges", File, std::move(Action));
925}
926
927void ClangdServer::findType(llvm::StringRef File, Position Pos,
928 Callback<std::vector<LocatedSymbol>> CB) {
929 auto Action = [Pos, CB = std::move(CB),
930 this](llvm::Expected<InputsAndAST> InpAST) mutable {
931 if (!InpAST)
932 return CB(InpAST.takeError());
933 CB(clangd::findType(InpAST->AST, Pos, Index));
934 };
935 WorkScheduler->runWithAST("FindType", File, std::move(Action));
936}
937
938void ClangdServer::findImplementations(
939 PathRef File, Position Pos, Callback<std::vector<LocatedSymbol>> CB) {
940 auto Action = [Pos, CB = std::move(CB),
941 this](llvm::Expected<InputsAndAST> InpAST) mutable {
942 if (!InpAST)
943 return CB(InpAST.takeError());
944 CB(clangd::findImplementations(InpAST->AST, Pos, Index));
945 };
946
947 WorkScheduler->runWithAST("Implementations", File, std::move(Action));
948}
949
950void ClangdServer::findReferences(PathRef File, Position Pos, uint32_t Limit,
951 bool AddContainer,
953 auto Action = [Pos, Limit, AddContainer, CB = std::move(CB),
954 this](llvm::Expected<InputsAndAST> InpAST) mutable {
955 if (!InpAST)
956 return CB(InpAST.takeError());
957 CB(clangd::findReferences(InpAST->AST, Pos, Limit, Index, AddContainer));
958 };
959
960 WorkScheduler->runWithAST("References", File, std::move(Action));
961}
962
963void ClangdServer::symbolInfo(PathRef File, Position Pos,
964 Callback<std::vector<SymbolDetails>> CB) {
965 auto Action =
966 [Pos, CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
967 if (!InpAST)
968 return CB(InpAST.takeError());
969 CB(clangd::getSymbolInfo(InpAST->AST, Pos));
970 };
971
972 WorkScheduler->runWithAST("SymbolInfo", File, std::move(Action));
973}
974
975void ClangdServer::semanticRanges(PathRef File,
976 const std::vector<Position> &Positions,
977 Callback<std::vector<SelectionRange>> CB) {
978 auto Action = [Positions, CB = std::move(CB)](
979 llvm::Expected<InputsAndAST> InpAST) mutable {
980 if (!InpAST)
981 return CB(InpAST.takeError());
982 std::vector<SelectionRange> Result;
983 for (const auto &Pos : Positions) {
984 if (auto Range = clangd::getSemanticRanges(InpAST->AST, Pos))
985 Result.push_back(std::move(*Range));
986 else
987 return CB(Range.takeError());
988 }
989 CB(std::move(Result));
990 };
991 WorkScheduler->runWithAST("SemanticRanges", File, std::move(Action));
992}
993
994void ClangdServer::documentLinks(PathRef File,
995 Callback<std::vector<DocumentLink>> CB) {
996 auto Action =
997 [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
998 if (!InpAST)
999 return CB(InpAST.takeError());
1000 CB(clangd::getDocumentLinks(InpAST->AST));
1001 };
1002 WorkScheduler->runWithAST("DocumentLinks", File, std::move(Action),
1003 Transient);
1004}
1005
1006void ClangdServer::semanticHighlights(
1007 PathRef File, Callback<std::vector<HighlightingToken>> CB) {
1008
1009 auto Action = [CB = std::move(CB),
1010 PublishInactiveRegions = PublishInactiveRegions](
1011 llvm::Expected<InputsAndAST> InpAST) mutable {
1012 if (!InpAST)
1013 return CB(InpAST.takeError());
1014 // Include inactive regions in semantic highlighting tokens only if the
1015 // client doesn't support a dedicated protocol for being informed about
1016 // them.
1017 CB(clangd::getSemanticHighlightings(InpAST->AST, !PublishInactiveRegions));
1018 };
1019 WorkScheduler->runWithAST("SemanticHighlights", File, std::move(Action),
1020 Transient);
1021}
1022
1023void ClangdServer::getAST(PathRef File, std::optional<Range> R,
1024 Callback<std::optional<ASTNode>> CB) {
1025 auto Action =
1026 [R, CB(std::move(CB))](llvm::Expected<InputsAndAST> Inputs) mutable {
1027 if (!Inputs)
1028 return CB(Inputs.takeError());
1029 if (!R) {
1030 // It's safe to pass in the TU, as dumpAST() does not
1031 // deserialize the preamble.
1032 auto Node = DynTypedNode::create(
1033 *Inputs->AST.getASTContext().getTranslationUnitDecl());
1034 return CB(dumpAST(Node, Inputs->AST.getTokens(),
1035 Inputs->AST.getASTContext()));
1036 }
1037 unsigned Start, End;
1038 if (auto Offset = positionToOffset(Inputs->Inputs.Contents, R->start))
1039 Start = *Offset;
1040 else
1041 return CB(Offset.takeError());
1042 if (auto Offset = positionToOffset(Inputs->Inputs.Contents, R->end))
1043 End = *Offset;
1044 else
1045 return CB(Offset.takeError());
1046 bool Success = SelectionTree::createEach(
1047 Inputs->AST.getASTContext(), Inputs->AST.getTokens(), Start, End,
1048 [&](SelectionTree T) {
1049 if (const SelectionTree::Node *N = T.commonAncestor()) {
1050 CB(dumpAST(N->ASTNode, Inputs->AST.getTokens(),
1051 Inputs->AST.getASTContext()));
1052 return true;
1053 }
1054 return false;
1055 });
1056 if (!Success)
1057 CB(std::nullopt);
1058 };
1059 WorkScheduler->runWithAST("GetAST", File, std::move(Action));
1060}
1061
1062void ClangdServer::customAction(PathRef File, llvm::StringRef Name,
1064 WorkScheduler->runWithAST(Name, File, std::move(Action));
1065}
1066
1067void ClangdServer::diagnostics(PathRef File, Callback<std::vector<Diag>> CB) {
1068 auto Action =
1069 [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
1070 if (!InpAST)
1071 return CB(InpAST.takeError());
1072 return CB(InpAST->AST.getDiagnostics());
1073 };
1074
1075 WorkScheduler->runWithAST("Diagnostics", File, std::move(Action));
1076}
1077
1078llvm::StringMap<TUScheduler::FileStats> ClangdServer::fileStats() const {
1079 return WorkScheduler->fileStats();
1080}
1081
1082[[nodiscard]] bool
1083ClangdServer::blockUntilIdleForTest(std::optional<double> TimeoutSeconds) {
1084 // Order is important here: we don't want to block on A and then B,
1085 // if B might schedule work on A.
1086
1087#if defined(__has_feature) && \
1088 (__has_feature(address_sanitizer) || __has_feature(hwaddress_sanitizer) || \
1089 __has_feature(memory_sanitizer) || __has_feature(thread_sanitizer))
1090 if (TimeoutSeconds.has_value())
1091 (*TimeoutSeconds) *= 10;
1092#endif
1093
1094 // Nothing else can schedule work on TUScheduler, because it's not threadsafe
1095 // and we're blocking the main thread.
1096 if (!WorkScheduler->blockUntilIdle(timeoutSeconds(TimeoutSeconds)))
1097 return false;
1098 // TUScheduler is the only thing that starts background indexing work.
1099 if (IndexTasks && !IndexTasks->wait(timeoutSeconds(TimeoutSeconds)))
1100 return false;
1101
1102 // Unfortunately we don't have strict topological order between the rest of
1103 // the components. E.g. CDB broadcast triggers backrgound indexing.
1104 // This queries the CDB which may discover new work if disk has changed.
1105 //
1106 // So try each one a few times in a loop.
1107 // If there are no tricky interactions then all after the first are no-ops.
1108 // Then on the last iteration, verify they're idle without waiting.
1109 //
1110 // There's a small chance they're juggling work and we didn't catch them :-(
1111 for (std::optional<double> Timeout :
1112 {TimeoutSeconds, TimeoutSeconds, std::optional<double>(0)}) {
1113 if (!CDB.blockUntilIdle(timeoutSeconds(Timeout)))
1114 return false;
1115 if (BackgroundIdx && !BackgroundIdx->blockUntilIdleForTest(Timeout))
1116 return false;
1117 if (FeatureModules && llvm::any_of(*FeatureModules, [&](FeatureModule &M) {
1118 return !M.blockUntilIdle(timeoutSeconds(Timeout));
1119 }))
1120 return false;
1121 }
1122
1123 assert(WorkScheduler->blockUntilIdle(Deadline::zero()) &&
1124 "Something scheduled work while we're blocking the main thread!");
1125 return true;
1126}
1127
1128void ClangdServer::profile(MemoryTree &MT) const {
1129 if (DynamicIdx)
1130 DynamicIdx->profile(MT.child("dynamic_index"));
1131 if (BackgroundIdx)
1132 BackgroundIdx->profile(MT.child("background_index"));
1133 WorkScheduler->profile(MT.child("tuscheduler"));
1134}
1135} // namespace clangd
1136} // 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 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.
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.
static Options optsForTest()
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 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.
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:2203
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:2182
std::vector< CallHierarchyIncomingCall > incomingCalls(const CallHierarchyItem &Item, const SymbolIndex *Index)
Definition: XRefs.cpp:2249
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
format::FormatStyle getFormatStyleForFile(llvm::StringRef File, llvm::StringRef Content, const ThreadsafeFS &TFS)
Choose the clang-format style we should apply to a certain file.
Definition: SourceCode.cpp:583
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:1592
static llvm::Expected< std::vector< std::unique_ptr< Tweak::Selection > > > tweakSelection(const Range &Sel, const InputsAndAST &AST, llvm::vfs::FileSystem *FS)
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:2063
llvm::Expected< RenameResult > rename(const RenameInputs &RInputs)
Renames all occurrences of the symbol.
Definition: Rename.cpp:1022
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:2138
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:1375
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:1278
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:2212
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:2227
===– 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:1568
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:132
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:185
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:94
PrecompiledPreamble Preamble
Definition: Preamble.h:100
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