clang-tools 10.0.0

Public Attributes | List of all members
clang::clangd::ClangdServer::Options Struct Reference

`#include <ClangdServer.h>`

Collaboration diagram for clang::clangd::ClangdServer::Options:
[legend]

## Public Attributes
unsigned | AsyncThreadsCount = getDefaultAsyncThreadsCount()
| To process requests asynchronously, ClangdServer spawns worker threads. More...
ASTRetentionPolicy | RetentionPolicy
| AST caching policy. The default is to keep up to 3 ASTs in memory. More...
bool | StorePreamblesInMemory = true
| Cached preambles are potentially large. If false, store them on disk. More...
bool | BuildDynamicSymbolIndex = false
| If true, ClangdServer builds a dynamic in-memory index for symbols in opened files and uses the index to augment code completion results. More...
bool | HeavyweightDynamicSymbolIndex = true
| Use a heavier and faster in-memory index implementation. More...
bool | BackgroundIndex = false
| If true, ClangdServer automatically indexes files in the current project on background threads. More...
SymbolIndex * | StaticIndex = nullptr
| If set, use this index to augment code completion results. More...
ClangTidyOptionsBuilder | GetClangTidyOptions
| If set, enable clang-tidy in clangd and use to it get clang-tidy configurations for a particular file. More...
llvm::Optional< std::string > | WorkspaceRoot
| Clangd's workspace root. More...
llvm::Optional< std::string > | ResourceDir = llvm::None
| The resource directory is used to find internal headers, overriding defaults and -resource-dir compiler flag). More...
std::chrono::steady_clock::duration | UpdateDebounce
| Time to wait after a new file version before computing diagnostics. More...
bool | SuggestMissingIncludes = false
std::vector< std::string > | QueryDriverGlobs
| Clangd will execute compiler drivers matching one of these globs to fetch system include path. More...
bool | SemanticHighlighting = false
| Enable semantic highlighting features. More...
bool | CrossFileRename = false
| Enable cross-file rename feature. More...
std::function< bool(const Tweak &)> | TweakFilter
| Returns true if the tweak should be enabled. More...

## Detailed Description

Definition at line 82 of file ClangdServer.h.

## Member Data Documentation

## ◆ AsyncThreadsCount

unsigned clang::clangd::ClangdServer::Options::AsyncThreadsCount = getDefaultAsyncThreadsCount()

To process requests asynchronously, ClangdServer spawns worker threads.

If this is zero, no threads are spawned. All work is done on the calling thread, and callbacks are invoked before "async" functions return.

Definition at line 86 of file ClangdServer.h.

## ◆ BackgroundIndex

bool clang::clangd::ClangdServer::Options::BackgroundIndex = false

If true, ClangdServer automatically indexes files in the current project on background threads.

The index is stored in the project root.

Definition at line 101 of file ClangdServer.h.

## ◆ BuildDynamicSymbolIndex

bool clang::clangd::ClangdServer::Options::BuildDynamicSymbolIndex = false

If true, ClangdServer builds a dynamic in-memory index for symbols in opened files and uses the index to augment code completion results.

Definition at line 96 of file ClangdServer.h.

## ◆ CrossFileRename

bool clang::clangd::ClangdServer::Options::CrossFileRename = false

Enable cross-file rename feature.

Definition at line 138 of file ClangdServer.h.

## ◆ GetClangTidyOptions

ClangTidyOptionsBuilder clang::clangd::ClangdServer::Options::GetClangTidyOptions

If set, enable clang-tidy in clangd and use to it get clang-tidy configurations for a particular file.

Clangd supports only a small subset of ClangTidyOptions, these options (Checks, CheckOptions) are about which clang-tidy checks will be enabled.

Definition at line 111 of file ClangdServer.h.

## ◆ HeavyweightDynamicSymbolIndex

bool clang::clangd::ClangdServer::Options::HeavyweightDynamicSymbolIndex = true

Use a heavier and faster in-memory index implementation.

Definition at line 98 of file ClangdServer.h.

## ◆ QueryDriverGlobs

std::vector<std::string> clang::clangd::ClangdServer::Options::QueryDriverGlobs

Clangd will execute compiler drivers matching one of these globs to fetch system include path.

Definition at line 132 of file ClangdServer.h.

## ◆ ResourceDir

llvm::Optional<std::string> clang::clangd::ClangdServer::Options::ResourceDir = llvm::None

The resource directory is used to find internal headers, overriding defaults and -resource-dir compiler flag).

If None, ClangdServer calls CompilerInvocation::GetResourcePath() to obtain the standard resource directory.

Definition at line 122 of file ClangdServer.h.

## ◆ RetentionPolicy

ASTRetentionPolicy clang::clangd::ClangdServer::Options::RetentionPolicy

AST caching policy. The default is to keep up to 3 ASTs in memory.

Definition at line 89 of file ClangdServer.h.

## ◆ SemanticHighlighting

bool clang::clangd::ClangdServer::Options::SemanticHighlighting = false

Enable semantic highlighting features.

Definition at line 135 of file ClangdServer.h.

## ◆ StaticIndex

SymbolIndex* clang::clangd::ClangdServer::Options::StaticIndex = nullptr

If set, use this index to augment code completion results.

Definition at line 104 of file ClangdServer.h.

## ◆ StorePreamblesInMemory

bool clang::clangd::ClangdServer::Options::StorePreamblesInMemory = true

Cached preambles are potentially large. If false, store them on disk.

Definition at line 92 of file ClangdServer.h.

## ◆ SuggestMissingIncludes

bool clang::clangd::ClangdServer::Options::SuggestMissingIncludes = false

Definition at line 128 of file ClangdServer.h.

## ◆ TweakFilter

std::function<bool(const Tweak &)> clang::clangd::ClangdServer::Options::TweakFilter

Initial value:
= [](const Tweak &T) {
return !T.hidden();
}

Returns true if the tweak should be enabled.

Definition at line 141 of file ClangdServer.h.

## ◆ UpdateDebounce

std::chrono::steady_clock::duration clang::clangd::ClangdServer::Options::UpdateDebounce

Initial value:
=
std::chrono::milliseconds(500)

Time to wait after a new file version before computing diagnostics.

Definition at line 125 of file ClangdServer.h.

## ◆ WorkspaceRoot

llvm::Optional<std::string> clang::clangd::ClangdServer::Options::WorkspaceRoot

Clangd's workspace root.

Relevant for "workspace" operations not bound to a particular file. FIXME: If not set, should use the current working directory.

Definition at line 116 of file ClangdServer.h.

The documentation for this struct was generated from the following file:

- ClangdServer.h