clang-tools  7.0.0
Public Attributes | List of all members
clang::clangd::SymbolCollector::Options Struct Reference

#include <SymbolCollector.h>

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

Public Attributes

std::string FallbackDir
 When symbol paths cannot be resolved to absolute paths (e.g. More...
 
std::vector< std::string > URISchemes = {"file"}
 Specifies URI schemes that can be used to generate URIs for file paths in symbols. More...
 
bool CollectIncludePath = false
 
const CanonicalIncludesIncludes = nullptr
 If set, this is used to map symbol #include path to a potentially different #include path. More...
 
bool CountReferences = false
 
SymbolOrigin Origin = SymbolOrigin::Unknown
 
bool CollectMacro = false
 Collect macros. More...
 

Detailed Description

Definition at line 39 of file SymbolCollector.h.

Member Data Documentation

◆ CollectIncludePath

bool clang::clangd::SymbolCollector::Options::CollectIncludePath = false

Definition at line 49 of file SymbolCollector.h.

◆ CollectMacro

bool clang::clangd::SymbolCollector::Options::CollectMacro = false

Collect macros.

Note that SymbolCollector must be run with preprocessor in order to collect macros. For example, indexTopLevelDecls will not index any macro even if this is true.

Definition at line 61 of file SymbolCollector.h.

◆ CountReferences

bool clang::clangd::SymbolCollector::Options::CountReferences = false

Definition at line 54 of file SymbolCollector.h.

◆ FallbackDir

std::string clang::clangd::SymbolCollector::Options::FallbackDir

When symbol paths cannot be resolved to absolute paths (e.g.

files in VFS that does not have absolute path), combine the fallback directory with symbols' paths to get absolute paths. This must be an absolute path.

Definition at line 44 of file SymbolCollector.h.

◆ Includes

const CanonicalIncludes* clang::clangd::SymbolCollector::Options::Includes = nullptr

If set, this is used to map symbol #include path to a potentially different #include path.

Definition at line 52 of file SymbolCollector.h.

◆ Origin

SymbolOrigin clang::clangd::SymbolCollector::Options::Origin = SymbolOrigin::Unknown

Definition at line 56 of file SymbolCollector.h.

◆ URISchemes

std::vector<std::string> clang::clangd::SymbolCollector::Options::URISchemes = {"file"}

Specifies URI schemes that can be used to generate URIs for file paths in symbols.

The list of schemes will be tried in order until a working scheme is found. If no scheme works, symbol location will be dropped.

Definition at line 48 of file SymbolCollector.h.


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