//===--- SyncAPI.cpp - Sync version of ClangdServer's API --------*- C++-*-===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// #include "SyncAPI.h" #include "index/Index.h" namespace clang { namespace clangd { void runAddDocument(ClangdServer &Server, PathRef File, llvm::StringRef Contents, llvm::StringRef Version, WantDiagnostics WantDiags, bool ForceRebuild) { Server.addDocument(File, Contents, Version, WantDiags, ForceRebuild); if (!Server.blockUntilIdleForTest()) llvm_unreachable("not idle after addDocument"); } namespace { /// A helper that waits for async callbacks to fire and exposes their result in /// the output variable. Intended to be used in the following way: /// T Result; /// someAsyncFunc(Param1, Param2, /*Callback=*/capture(Result)); template struct CaptureProxy { CaptureProxy(llvm::Optional &Target) : Target(&Target) { assert(!Target.hasValue()); } CaptureProxy(const CaptureProxy &) = delete; CaptureProxy &operator=(const CaptureProxy &) = delete; // We need move ctor to return a value from the 'capture' helper. CaptureProxy(CaptureProxy &&Other) : Target(Other.Target) { Other.Target = nullptr; } CaptureProxy &operator=(CaptureProxy &&) = delete; operator llvm::unique_function() && { assert(!Future.valid() && "conversion to callback called multiple times"); Future = Promise.get_future(); return [Promise = std::move(Promise)](T Value) mutable { Promise.set_value(std::make_shared(std::move(Value))); }; } ~CaptureProxy() { if (!Target) return; assert(Future.valid() && "conversion to callback was not called"); assert(!Target->hasValue()); Target->emplace(std::move(*Future.get())); } private: llvm::Optional *Target; // Using shared_ptr to workaround compilation errors with MSVC. // MSVC only allows default-constructible and copyable objects as future<> // arguments. std::promise> Promise; std::future> Future; }; template CaptureProxy capture(llvm::Optional &Target) { return CaptureProxy(Target); } } // namespace llvm::Expected runCodeComplete(ClangdServer &Server, PathRef File, Position Pos, clangd::CodeCompleteOptions Opts) { llvm::Optional> Result; Server.codeComplete(File, Pos, Opts, capture(Result)); return std::move(*Result); } llvm::Expected runSignatureHelp(ClangdServer &Server, PathRef File, Position Pos) { llvm::Optional> Result; Server.signatureHelp(File, Pos, capture(Result)); return std::move(*Result); } llvm::Expected> runLocateSymbolAt(ClangdServer &Server, PathRef File, Position Pos) { llvm::Optional>> Result; Server.locateSymbolAt(File, Pos, capture(Result)); return std::move(*Result); } llvm::Expected> runFindDocumentHighlights(ClangdServer &Server, PathRef File, Position Pos) { llvm::Optional>> Result; Server.findDocumentHighlights(File, Pos, capture(Result)); return std::move(*Result); } llvm::Expected runRename(ClangdServer &Server, PathRef File, Position Pos, llvm::StringRef NewName, const RenameOptions &RenameOpts) { llvm::Optional> Result; Server.rename(File, Pos, NewName, RenameOpts, capture(Result)); return std::move(*Result); } llvm::Expected runPrepareRename(ClangdServer &Server, PathRef File, Position Pos, llvm::Optional NewName, const RenameOptions &RenameOpts) { llvm::Optional> Result; Server.prepareRename(File, Pos, NewName, RenameOpts, capture(Result)); return std::move(*Result); } llvm::Expected runFormatFile(ClangdServer &Server, PathRef File, StringRef Code) { llvm::Optional> Result; Server.formatFile(File, Code, capture(Result)); return std::move(*Result); } SymbolSlab runFuzzyFind(const SymbolIndex &Index, llvm::StringRef Query) { FuzzyFindRequest Req; Req.Query = std::string(Query); Req.AnyScope = true; return runFuzzyFind(Index, Req); } SymbolSlab runFuzzyFind(const SymbolIndex &Index, const FuzzyFindRequest &Req) { SymbolSlab::Builder Builder; Index.fuzzyFind(Req, [&](const Symbol &Sym) { Builder.insert(Sym); }); return std::move(Builder).build(); } RefSlab getRefs(const SymbolIndex &Index, SymbolID ID) { RefsRequest Req; Req.IDs = {ID}; RefSlab::Builder Slab; Index.refs(Req, [&](const Ref &S) { Slab.insert(ID, S); }); return std::move(Slab).build(); } llvm::Expected> runSemanticRanges(ClangdServer &Server, PathRef File, const std::vector &Pos) { llvm::Optional>> Result; Server.semanticRanges(File, Pos, capture(Result)); return std::move(*Result); } llvm::Expected> runSwitchHeaderSource(ClangdServer &Server, PathRef File) { llvm::Optional>> Result; Server.switchSourceHeader(File, capture(Result)); return std::move(*Result); } llvm::Error runCustomAction(ClangdServer &Server, PathRef File, llvm::function_ref Action) { llvm::Error Result = llvm::Error::success(); Notification Done; Server.customAction(File, "Custom", [&](llvm::Expected AST) { if (!AST) Result = AST.takeError(); else Action(*AST); Done.notify(); }); Done.wait(); return Result; } } // namespace clangd } // namespace clang