clang-tools 10.0.0

Classes | Public Types | Public Attributes | List of all members
clang::clangd::Symbol Struct Reference

The class presents a C++ symbol, e.g. More...

`#include <Symbol.h>`

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

## Classes
struct | IncludeHeaderWithReferences

## Public Types
enum | SymbolFlag : uint8_t { None = 0, IndexedForCodeCompletion = 1 << 0, Deprecated = 1 << 1, ImplementationDetail = 1 << 2, VisibleOutsideFile = 1 << 3 }

## Public Attributes
SymbolID | ID
| The ID of the symbol. More...
index::SymbolInfo | SymInfo = index::SymbolInfo()
| The symbol information, like symbol kind. More...
llvm::StringRef | Name
| The unqualified name of the symbol, e.g. "bar" (for ns::bar). More...
llvm::StringRef | Scope
| The containing namespace. e.g. "" (global), "ns::" (top-level namespace). More...
SymbolLocation | Definition
| The location of the symbol's definition, if one was found. More...
SymbolLocation | CanonicalDeclaration
| The location of the preferred declaration of the symbol. More...
unsigned | References = 0
| The number of translation units that reference this symbol from their main file. 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 | TemplateSpecializationArgs
| Argument list in human-readable format, will be displayed to help disambiguate between different specializations of a template. More...
llvm::StringRef | CompletionSnippetSuffix
| What to insert when completing this symbol, after the symbol name. More...
llvm::StringRef | Documentation
| Documentation including comment for the symbol declaration. More...
llvm::StringRef | ReturnType
| Type when this symbol is used in an expression. More...
llvm::StringRef | Type
| Raw representation of the OpaqueType of the symbol, used for scoring purposes. More...
llvm::SmallVector< IncludeHeaderWithReferences, 1 > | IncludeHeaders
| One Symbol can potentially be included via different headers. More...
SymbolFlag | Flags = SymbolFlag::None

## Detailed Description

The class presents a C++ symbol, e.g.

class, function.

WARNING: Symbols do not own much of their underlying data - typically strings are owned by a SymbolSlab. They should be treated as non-owning references. Copies are shallow.

When adding new unowned data fields to Symbol, remember to update:

- SymbolSlab::Builder in Index.cpp, to copy them to the slab's storage.
- mergeSymbol in Merge.cpp, to properly combine two Symbols.

A fully documented symbol can be split as: size_type std::map<k, t>::count(const K& key) const | Return | Scope |Name| Signature | We split up these components to allow display flexibility later.

Definition at line 36 of file Symbol.h.

## Member Enumeration Documentation

## ◆ SymbolFlag

enum clang::clangd::Symbol::SymbolFlag : uint8_t

Enumerator
None |
IndexedForCodeCompletion | Whether or not this symbol is meant to be used for the code completion. See also isIndexedForCodeCompletion(). Note that we don't store completion information (signature, snippet, type, includes) if the symbol is not indexed for code completion.
Deprecated | Indicates if the symbol is deprecated.
ImplementationDetail | Symbol is an implementation detail.
VisibleOutsideFile | Symbol is visible to other files (not e.g. a static helper function).

Definition at line 113 of file Symbol.h.

## Member Data Documentation

## ◆ CanonicalDeclaration

SymbolLocation clang::clangd::Symbol::CanonicalDeclaration

The location of the preferred declaration of the symbol.

This just covers the symbol name. This may be the same as Definition.

A C++ symbol may have multiple declarations, and we pick one to prefer.

- For classes, the canonical declaration should be the definition.
- For non-inline functions, the canonical declaration typically appears in the ".h" file corresponding to the definition.

Definition at line 56 of file Symbol.h.

Referenced by llvm::yaml::MappingTraits< Symbol >::mapping(), clang::clangd::SymbolRelevanceSignals::merge(), clang::clangd::mergeSymbol(), and clang::clangd::visitStrings().

## ◆ 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). Only set when the symbol is indexed for completion.

Definition at line 74 of file Symbol.h.

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

## ◆ Definition

SymbolLocation clang::clangd::Symbol::Definition

The location of the symbol's definition, if one was found.

This just covers the symbol name (e.g. without class/function body).

Definition at line 47 of file Symbol.h.

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

## ◆ Documentation

llvm::StringRef clang::clangd::Symbol::Documentation

Documentation including comment for the symbol declaration.

Definition at line 76 of file Symbol.h.

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

## ◆ Flags

SymbolFlag clang::clangd::Symbol::Flags = SymbolFlag::None

Definition at line 128 of file Symbol.h.

Referenced by llvm::yaml::MappingTraits< Symbol >::mapping(), clang::clangd::SymbolQualitySignals::merge(), clang::clangd::SymbolRelevanceSignals::merge(), clang::clangd::mergeSymbol(), clang::clangd::sym(), and clang::clangd::symbolToTypeHierarchyItem().

## ◆ ID

SymbolID clang::clangd::Symbol::ID

The ID of the symbol.

Definition at line 38 of file Symbol.h.

Referenced by clang::clangd::SymbolSlab::Builder::build(), clang::clangd::SymbolSlab::Builder::insert(), llvm::yaml::MappingTraits< Symbol >::mapping(), clang::clangd::mergeSymbol(), clang::clangd::MergedIndex::relations(), clang::clangd::sym(), clang::clangd::symbol(), and clang::clangd::symbolToTypeHierarchyItem().

## ◆ IncludeHeaders

llvm::SmallVector<IncludeHeaderWithReferences, 1> clang::clangd::Symbol::IncludeHeaders

One Symbol can potentially be included via different headers.

- If we haven't seen a definition, this covers all declarations.
- If we have seen a definition, this covers declarations visible from any definition. Only set when the symbol is indexed for completion.

Definition at line 111 of file Symbol.h.

Referenced by llvm::yaml::MappingTraits< Symbol >::mapping(), clang::clangd::mergeSymbol(), clang::clangd::IncludeFixer::unresolvedNameRecorder(), and clang::clangd::visitStrings().

## ◆ Name

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

The unqualified name of the symbol, e.g. "bar" (for ns::bar).

Definition at line 42 of file Symbol.h.

Referenced by clang::clangd::getQualifiedName(), llvm::yaml::MappingTraits< Symbol >::mapping(), clang::clangd::SymbolQualitySignals::merge(), clang::clangd::sym(), clang::clangd::symbol(), clang::clangd::symbolToTypeHierarchyItem(), clang::clangd::IncludeFixer::unresolvedNameRecorder(), and clang::clangd::visitStrings().

## ◆ Origin

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

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

Definition at line 61 of file Symbol.h.

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

## ◆ References

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

The number of translation units that reference this symbol from their main file.

This number is only meaningful if aggregated in an index.

Definition at line 59 of file Symbol.h.

Referenced by llvm::yaml::MappingTraits< Symbol >::mapping(), clang::clangd::SymbolQualitySignals::merge(), clang::clangd::mergeSymbol(), and clang::clangd::quality().

## ◆ ReturnType

llvm::StringRef clang::clangd::Symbol::ReturnType

Type when this symbol is used in an expression.

(Short display form). e.g. return type of a function, or type of a variable. Only set when the symbol is indexed for completion.

Definition at line 80 of file Symbol.h.

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

## ◆ Scope

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

The containing namespace. e.g. "" (global), "ns::" (top-level namespace).

Definition at line 44 of file Symbol.h.

Referenced by clang::clangd::getQualifiedName(), llvm::yaml::MappingTraits< Symbol >::mapping(), clang::clangd::SymbolRelevanceSignals::merge(), clang::clangd::sym(), clang::clangd::symbol(), and clang::clangd::visitStrings().

## ◆ 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. Only set when the symbol is indexed for completion.

Definition at line 65 of file Symbol.h.

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

## ◆ SymInfo

index::SymbolInfo clang::clangd::Symbol::SymInfo = index::SymbolInfo()

The symbol information, like symbol kind.

Definition at line 40 of file Symbol.h.

Referenced by llvm::yaml::MappingTraits< Symbol >::mapping(), clang::clangd::SymbolQualitySignals::merge(), clang::clangd::SymbolRelevanceSignals::merge(), clang::clangd::mergeSymbol(), clang::clangd::sym(), and clang::clangd::symbolToTypeHierarchyItem().

## ◆ TemplateSpecializationArgs

llvm::StringRef clang::clangd::Symbol::TemplateSpecializationArgs

Argument list in human-readable format, will be displayed to help disambiguate between different specializations of a template.

Empty for non-specializations. Example: "<int, bool, 3>"

Definition at line 69 of file Symbol.h.

Referenced by clang::clangd::getQualifiedName(), llvm::yaml::MappingTraits< Symbol >::mapping(), and clang::clangd::visitStrings().

## ◆ Type

llvm::StringRef clang::clangd::Symbol::Type

Raw representation of the OpaqueType of the symbol, used for scoring purposes.

Only set when the symbol is indexed for completion.

Definition at line 85 of file Symbol.h.

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

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

- Symbol.h