clang-tools  7.0.0
Classes | Public Attributes | List of all members
clang::clangd::Symbol Struct Reference

#include <Index.h>

Collaboration diagram for clang::clangd::Symbol:
[legend]

Classes

struct  Details
 Optional symbol details that are not required to be set. More...
 

Public Attributes

SymbolID ID
 
index::SymbolInfo SymInfo
 
llvm::StringRef Name
 
llvm::StringRef Scope
 
SymbolLocation Definition
 
SymbolLocation CanonicalDeclaration
 
unsigned References = 0
 
bool IsIndexedForCodeCompletion = false
 Whether or not this symbol is meant to be used for the code completion. More...
 
SymbolOrigin Origin = SymbolOrigin::Unknown
 Where this symbol came from. Usually an index provides a constant value. More...
 
llvm::StringRef Signature
 A brief description of the symbol that can be appended in the completion candidate list. More...
 
llvm::StringRef CompletionSnippetSuffix
 What to insert when completing this symbol, after the symbol name. More...
 
const DetailsDetail = nullptr
 

Detailed Description

Definition at line 164 of file Index.h.

Member Data Documentation

◆ CanonicalDeclaration

SymbolLocation clang::clangd::Symbol::CanonicalDeclaration

◆ CompletionSnippetSuffix

llvm::StringRef clang::clangd::Symbol::CompletionSnippetSuffix

What to insert when completing this symbol, after the symbol name.

This is in LSP snippet syntax (e.g. "({$0})" for a no-args function). (When snippets are disabled, the symbol name alone is used).

Definition at line 199 of file Index.h.

Referenced by clang::clangd::SymbolCollector::finish(), llvm::yaml::MappingTraits< Symbol >::mapping(), and clang::clangd::mergeSymbol().

◆ Definition

SymbolLocation clang::clangd::Symbol::Definition

◆ Detail

const Details* clang::clangd::Symbol::Detail = nullptr

◆ ID

SymbolID clang::clangd::Symbol::ID

◆ IsIndexedForCodeCompletion

bool clang::clangd::Symbol::IsIndexedForCodeCompletion = false

Whether or not this symbol is meant to be used for the code completion.

See also isIndexedForCodeCompletion().

Definition at line 190 of file Index.h.

Referenced by clang::clangd::SymbolCollector::finish(), clang::clangd::MemIndex::fuzzyFind(), and llvm::yaml::MappingTraits< Symbol >::mapping().

◆ Name

llvm::StringRef clang::clangd::Symbol::Name

◆ Origin

SymbolOrigin clang::clangd::Symbol::Origin = SymbolOrigin::Unknown

Where this symbol came from. Usually an index provides a constant value.

Definition at line 192 of file Index.h.

Referenced by clang::clangd::SymbolCollector::finish(), and clang::clangd::mergeSymbol().

◆ References

unsigned clang::clangd::Symbol::References = 0

◆ Scope

llvm::StringRef clang::clangd::Symbol::Scope

◆ Signature

llvm::StringRef clang::clangd::Symbol::Signature

A brief description of the symbol that can be appended in the completion candidate list.

For example, "(X x, Y y) const" is a function signature.

Definition at line 195 of file Index.h.

Referenced by clang::clangd::SymbolCollector::finish(), llvm::yaml::MappingTraits< Symbol >::mapping(), and clang::clangd::mergeSymbol().

◆ SymInfo

index::SymbolInfo clang::clangd::Symbol::SymInfo

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