clang-tools  11.0.0git
Classes | Public Member Functions | Static Public Member Functions | List of all members
clang::clangd::ClangdServer Class Reference

Manages a collection of source files and derived data (ASTs, indexes), and provides language-aware features such as code completion. More...

#include <ClangdServer.h>

Classes

class  Callbacks
 Interface with hooks for users of ClangdServer to be notified of events. More...
 
struct  Options
 
struct  TweakRef
 

Public Member Functions

 ClangdServer (const GlobalCompilationDatabase &CDB, const ThreadsafeFS &TFS, const Options &Opts, Callbacks *Callbacks=nullptr)
 Creates a new ClangdServer instance. More...
 
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. More...
 
void removeDocument (PathRef File)
 Remove File from list of tracked files, schedule a request to free resources associated with it. More...
 
void codeComplete (PathRef File, Position Pos, const clangd::CodeCompleteOptions &Opts, Callback< CodeCompleteResult > CB)
 Run code completion for File at Pos. More...
 
void signatureHelp (PathRef File, Position Pos, Callback< SignatureHelp > CB)
 Provide signature help for File at Pos. More...
 
void locateSymbolAt (PathRef File, Position Pos, Callback< std::vector< LocatedSymbol >> CB)
 Find declaration/definition locations of symbol at a specified position. More...
 
void switchSourceHeader (PathRef Path, Callback< llvm::Optional< clangd::Path >> CB)
 Switch to a corresponding source file when given a header file, and vice versa. More...
 
void findDocumentHighlights (PathRef File, Position Pos, Callback< std::vector< DocumentHighlight >> CB)
 Get document highlights for a given position. More...
 
void findHover (PathRef File, Position Pos, Callback< llvm::Optional< HoverInfo >> CB)
 Get code hover for a given position. More...
 
void typeHierarchy (PathRef File, Position Pos, int Resolve, TypeHierarchyDirection Direction, Callback< llvm::Optional< TypeHierarchyItem >> CB)
 Get information about type hierarchy for a given position. More...
 
void resolveTypeHierarchy (TypeHierarchyItem Item, int Resolve, TypeHierarchyDirection Direction, Callback< llvm::Optional< TypeHierarchyItem >> CB)
 Resolve type hierarchy item in the given direction. More...
 
void workspaceSymbols (StringRef Query, int Limit, Callback< std::vector< SymbolInformation >> CB)
 Retrieve the top symbols from the workspace matching a query. More...
 
void documentSymbols (StringRef File, Callback< std::vector< DocumentSymbol >> CB)
 Retrieve the symbols within the specified file. More...
 
void findReferences (PathRef File, Position Pos, uint32_t Limit, Callback< ReferencesResult > CB)
 Retrieve locations for symbol references. More...
 
void formatRange (PathRef File, StringRef Code, Range Rng, Callback< tooling::Replacements > CB)
 Run formatting for Rng inside File with content Code. More...
 
void formatFile (PathRef File, StringRef Code, Callback< tooling::Replacements > CB)
 Run formatting for the whole File with content Code. More...
 
void formatOnType (PathRef File, StringRef Code, Position Pos, StringRef TriggerText, Callback< std::vector< TextEdit >> CB)
 Run formatting after TriggerText was typed at Pos in File with content Code. More...
 
void prepareRename (PathRef File, Position Pos, const RenameOptions &RenameOpts, Callback< llvm::Optional< Range >> CB)
 Test the validity of a rename operation. More...
 
void rename (PathRef File, Position Pos, llvm::StringRef NewName, const RenameOptions &Opts, Callback< FileEdits > CB)
 Rename all occurrences of the symbol at the Pos in File to NewName. More...
 
void enumerateTweaks (PathRef File, Range Sel, Callback< std::vector< TweakRef >> CB)
 Enumerate the code tweaks available to the user at a specified point. More...
 
void applyTweak (PathRef File, Range Sel, StringRef ID, Callback< Tweak::Effect > CB)
 Apply the code tweak with a specified ID. More...
 
void dumpAST (PathRef File, llvm::unique_function< void(std::string)> Callback)
 Only for testing purposes. More...
 
void onFileEvent (const DidChangeWatchedFilesParams &Params)
 Called when an event occurs for a watched file in the workspace. More...
 
void symbolInfo (PathRef File, Position Pos, Callback< std::vector< SymbolDetails >> CB)
 Get symbol info for given position. More...
 
void semanticRanges (PathRef File, const std::vector< Position > &Pos, Callback< std::vector< SelectionRange >> CB)
 Get semantic ranges around a specified position in a file. More...
 
void documentLinks (PathRef File, Callback< std::vector< DocumentLink >> CB)
 Get all document links in a file. More...
 
void semanticHighlights (PathRef File, Callback< std::vector< HighlightingToken >>)
 
llvm::StringMap< TUScheduler::FileStatsfileStats () const
 Returns estimated memory usage and other statistics for each of the currently open files. More...
 
LLVM_NODISCARD bool blockUntilIdleForTest (llvm::Optional< double > TimeoutSeconds=10)
 

Static Public Member Functions

static Options optsForTest ()
 

Detailed Description

Manages a collection of source files and derived data (ASTs, indexes), and provides language-aware features such as code completion.

The primary client is ClangdLSPServer which exposes these features via the Language Server protocol. ClangdServer may also be embedded directly, though its API is not stable over time.

ClangdServer should be used from a single thread. Many potentially-slow operations have asynchronous APIs and deliver their results on another thread. Such operations support cancellation: if the caller sets up a cancelable context, many operations will notice cancellation and fail early. (ClangdLSPServer uses this to implement $/cancelRequest).

Definition at line 63 of file ClangdServer.h.

Constructor & Destructor Documentation

◆ ClangdServer()

clang::clangd::ClangdServer::ClangdServer ( const GlobalCompilationDatabase CDB,
const ThreadsafeFS TFS,
const Options Opts,
Callbacks Callbacks = nullptr 
)

Creates a new ClangdServer instance.

ClangdServer uses CDB to obtain compilation arguments for parsing. Note that ClangdServer only obtains compilation arguments once for each newly added file (i.e., when processing a first call to addDocument) and reuses those arguments for subsequent reparses. However, ClangdServer will check if compilation arguments changed on calls to forceReparse().

Definition at line 133 of file ClangdServer.cpp.

Member Function Documentation

◆ addDocument()

void clang::clangd::ClangdServer::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.

Also schedules parsing of the AST for it on a separate thread. When the parsing is complete, DiagConsumer passed in constructor will receive onDiagnosticsReady callback. Version identifies this snapshot and is propagated to ASTs, preambles, diagnostics etc built from it.

Definition at line 189 of file ClangdServer.cpp.

◆ applyTweak()

void clang::clangd::ClangdServer::applyTweak ( PathRef  File,
Range  Sel,
StringRef  ID,
Callback< Tweak::Effect CB 
)

Apply the code tweak with a specified ID.

Definition at line 486 of file ClangdServer.cpp.

References Action, clang::clangd::trace::Metric::Counter, E, FormatStyle(), clang::clangd::prepareTweak(), and clang::clangd::tweakSelection().

◆ blockUntilIdleForTest()

LLVM_NODISCARD bool clang::clangd::ClangdServer::blockUntilIdleForTest ( llvm::Optional< double >  TimeoutSeconds = 10)

◆ codeComplete()

void clang::clangd::ClangdServer::codeComplete ( PathRef  File,
Position  Pos,
const clangd::CodeCompleteOptions Opts,
Callback< CodeCompleteResult CB 
)

Run code completion for File at Pos.

Request is processed asynchronously.

This method should only be called for currently tracked files. However, it is safe to call removeDocument for File after this method returns, even while returned future is not yet ready. A version of codeComplete that runs Callback on the processing thread when codeComplete results become available.

Definition at line 218 of file ClangdServer.cpp.

◆ documentLinks()

void clang::clangd::ClangdServer::documentLinks ( PathRef  File,
Callback< std::vector< DocumentLink >>  CB 
)

◆ documentSymbols()

void clang::clangd::ClangdServer::documentSymbols ( StringRef  File,
Callback< std::vector< DocumentSymbol >>  CB 
)

Retrieve the symbols within the specified file.

Definition at line 665 of file ClangdServer.cpp.

References Action, clang::clangd::getDocumentSymbols(), clang::clangd::TUScheduler::InvalidateOnUpdate, and clang::clangd::TUScheduler::runWithAST().

◆ dumpAST()

void clang::clangd::ClangdServer::dumpAST ( PathRef  File,
llvm::unique_function< void(std::string)>  Callback 
)

Only for testing purposes.

Waits until all requests to worker thread are finished and dumps AST for File. File must be in the list of added documents.

Definition at line 527 of file ClangdServer.cpp.

References Action.

◆ enumerateTweaks()

void clang::clangd::ClangdServer::enumerateTweaks ( PathRef  File,
Range  Sel,
Callback< std::vector< TweakRef >>  CB 
)

Enumerate the code tweaks available to the user at a specified point.

Definition at line 453 of file ClangdServer.cpp.

References Action, clang::clangd::trace::Metric::Counter, and clang::clangd::tweakSelection().

◆ fileStats()

llvm::StringMap< TUScheduler::FileStats > clang::clangd::ClangdServer::fileStats ( ) const

Returns estimated memory usage and other statistics for each of the currently open files.

Overall memory usage of clangd may be significantly more than reported here, as this metric does not account (at least) for:

  • memory occupied by static and dynamic index,
  • memory required for in-flight requests, FIXME: those metrics might be useful too, we should add them.

Definition at line 744 of file ClangdServer.cpp.

References clang::clangd::Context::clone(), clang::clangd::Context::current(), clang::clangd::Context::derive(), clang::clangd::elog(), clang::clangd::TUScheduler::fileStats(), clang::clangd::config::Provider::getConfig(), clang::clangd::Config::Key, clang::clangd::log(), and clang::clangd::config::Params::Path.

◆ findDocumentHighlights()

void clang::clangd::ClangdServer::findDocumentHighlights ( PathRef  File,
Position  Pos,
Callback< std::vector< DocumentHighlight >>  CB 
)

Get document highlights for a given position.

Definition at line 600 of file ClangdServer.cpp.

References Action, clang::clangd::findDocumentHighlights(), clang::clangd::TUScheduler::InvalidateOnUpdate, Pos, and clang::clangd::TUScheduler::runWithAST().

◆ findHover()

void clang::clangd::ClangdServer::findHover ( PathRef  File,
Position  Pos,
Callback< llvm::Optional< HoverInfo >>  CB 
)

Get code hover for a given position.

Definition at line 613 of file ClangdServer.cpp.

References Action, FormatStyle(), and Pos.

◆ findReferences()

void clang::clangd::ClangdServer::findReferences ( PathRef  File,
Position  Pos,
uint32_t  Limit,
Callback< ReferencesResult CB 
)

Retrieve locations for symbol references.

Definition at line 677 of file ClangdServer.cpp.

◆ formatFile()

void clang::clangd::ClangdServer::formatFile ( PathRef  File,
StringRef  Code,
Callback< tooling::Replacements >  CB 
)

Run formatting for the whole File with content Code.

Definition at line 320 of file ClangdServer.cpp.

References Range.

◆ formatOnType()

void clang::clangd::ClangdServer::formatOnType ( PathRef  File,
StringRef  Code,
Position  Pos,
StringRef  TriggerText,
Callback< std::vector< TextEdit >>  CB 
)

Run formatting after TriggerText was typed at Pos in File with content Code.

Definition at line 326 of file ClangdServer.cpp.

References Action, and clang::clangd::positionToOffset().

◆ formatRange()

void clang::clangd::ClangdServer::formatRange ( PathRef  File,
StringRef  Code,
Range  Rng,
Callback< tooling::Replacements >  CB 
)

Run formatting for Rng inside File with content Code.

Definition at line 308 of file ClangdServer.cpp.

◆ locateSymbolAt()

void clang::clangd::ClangdServer::locateSymbolAt ( PathRef  File,
Position  Pos,
Callback< std::vector< LocatedSymbol >>  CB 
)

Find declaration/definition locations of symbol at a specified position.

Definition at line 547 of file ClangdServer.cpp.

References Action, clang::clangd::locateSymbolAt(), Pos, and clang::clangd::TUScheduler::runWithAST().

◆ onFileEvent()

void clang::clangd::ClangdServer::onFileEvent ( const DidChangeWatchedFilesParams Params)

Called when an event occurs for a watched file in the workspace.

Definition at line 649 of file ClangdServer.cpp.

◆ optsForTest()

ClangdServer::Options clang::clangd::ClangdServer::optsForTest ( )
static

Definition at line 113 of file ClangdServer.cpp.

◆ prepareRename()

void clang::clangd::ClangdServer::prepareRename ( PathRef  File,
Position  Pos,
const RenameOptions RenameOpts,
Callback< llvm::Optional< Range >>  CB 
)

Test the validity of a rename operation.

Definition at line 350 of file ClangdServer.cpp.

References Action, Pos, and RenameOpts.

◆ removeDocument()

void clang::clangd::ClangdServer::removeDocument ( PathRef  File)

Remove File from list of tracked files, schedule a request to free resources associated with it.

Pending diagnostics for closed files may not be delivered, even if requested with WantDiags::Auto or WantDiags::Yes. An empty set of diagnostics will be delivered, with Version = "".

Definition at line 216 of file ClangdServer.cpp.

References clang::clangd::TUScheduler::remove().

◆ rename()

void clang::clangd::ClangdServer::rename ( PathRef  File,
Position  Pos,
llvm::StringRef  NewName,
const RenameOptions Opts,
Callback< FileEdits CB 
)

Rename all occurrences of the symbol at the Pos in File to NewName.

If WantFormat is false, the final TextEdit will be not formatted, embedders could use this method to get all occurrences of the symbol (e.g. highlighting them in prepare stage).

Definition at line 390 of file ClangdServer.cpp.

◆ resolveTypeHierarchy()

void clang::clangd::ClangdServer::resolveTypeHierarchy ( TypeHierarchyItem  Item,
int  Resolve,
TypeHierarchyDirection  Direction,
Callback< llvm::Optional< TypeHierarchyItem >>  CB 
)

Resolve type hierarchy item in the given direction.

Definition at line 642 of file ClangdServer.cpp.

References clang::clangd::resolveTypeHierarchy().

◆ semanticHighlights()

void clang::clangd::ClangdServer::semanticHighlights ( PathRef  File,
Callback< std::vector< HighlightingToken >>  CB 
)

◆ semanticRanges()

void clang::clangd::ClangdServer::semanticRanges ( PathRef  File,
const std::vector< Position > &  Pos,
Callback< std::vector< SelectionRange >>  CB 
)

Get semantic ranges around a specified position in a file.

Definition at line 701 of file ClangdServer.cpp.

References Action.

◆ signatureHelp()

void clang::clangd::ClangdServer::signatureHelp ( PathRef  File,
Position  Pos,
Callback< SignatureHelp CB 
)

Provide signature help for File at Pos.

This method should only be called for tracked files.

Definition at line 283 of file ClangdServer.cpp.

References Action, ParseInput, Pos, clang::clangd::PreambleData::Preamble, clang::clangd::TUScheduler::runWithPreamble(), clang::clangd::signatureHelp(), and clang::clangd::TUScheduler::Stale.

◆ switchSourceHeader()

void clang::clangd::ClangdServer::switchSourceHeader ( PathRef  Path,
Callback< llvm::Optional< clangd::Path >>  CB 
)

Switch to a corresponding source file when given a header file, and vice versa.

Definition at line 559 of file ClangdServer.cpp.

References Action, Code, FormatStyle(), clang::clangd::getCorrespondingHeaderOrSource(), clang::clangd::None, clang::clangd::TUScheduler::runWithAST(), and clang::clangd::ThreadsafeFS::view().

◆ symbolInfo()

void clang::clangd::ClangdServer::symbolInfo ( PathRef  File,
Position  Pos,
Callback< std::vector< SymbolDetails >>  CB 
)

Get symbol info for given position.

Clangd extension - not part of official LSP.

Definition at line 689 of file ClangdServer.cpp.

References Action, clang::clangd::getSymbolInfo(), Pos, and clang::clangd::TUScheduler::runWithAST().

◆ typeHierarchy()

void clang::clangd::ClangdServer::typeHierarchy ( PathRef  File,
Position  Pos,
int  Resolve,
TypeHierarchyDirection  Direction,
Callback< llvm::Optional< TypeHierarchyItem >>  CB 
)

Get information about type hierarchy for a given position.

Definition at line 628 of file ClangdServer.cpp.

References Action, clang::clangd::getTypeHierarchy(), Pos, and clang::clangd::TUScheduler::runWithAST().

◆ workspaceSymbols()

void clang::clangd::ClangdServer::workspaceSymbols ( StringRef  Query,
int  Limit,
Callback< std::vector< SymbolInformation >>  CB 
)

Retrieve the top symbols from the workspace matching a query.

Definition at line 654 of file ClangdServer.cpp.


The documentation for this class was generated from the following files: