The class presents a C++ symbol, e.g. More...
#include <Symbol.h>
Classes | |
| struct | IncludeHeaderWithReferences |
Public Types | |
| enum | IncludeDirective : uint8_t { Invalid = 0 , Include = 1 , Import = 2 } |
| enum | SymbolFlag : uint8_t { None = 0 , IndexedForCodeCompletion = 1 << 0 , Deprecated = 1 << 1 , ImplementationDetail = 1 << 2 , VisibleOutsideFile = 1 << 3 , HasDocComment = 1 << 4 } |
Public Attributes | |
| SymbolID | ID |
| The ID of the symbol. | |
| index::SymbolInfo | SymInfo = index::SymbolInfo() |
| The symbol information, like symbol kind. | |
| llvm::StringRef | Name |
| The unqualified name of the symbol, e.g. "bar" (for ns::bar). | |
| llvm::StringRef | Scope |
| The containing namespace. e.g. "" (global), "ns::" (top-level namespace). | |
| SymbolLocation | Definition |
| The location of the symbol's definition, if one was found. | |
| SymbolLocation | CanonicalDeclaration |
| The location of the preferred declaration of the symbol. | |
| unsigned | References = 0 |
| The number of translation units that reference this symbol from their main file. | |
| SymbolOrigin | Origin = SymbolOrigin::Unknown |
| Where this symbol came from. Usually an index provides a constant value. | |
| llvm::StringRef | Signature |
| A brief description of the symbol that can be appended in the completion candidate list. | |
| llvm::StringRef | TemplateSpecializationArgs |
| Argument list in human-readable format, will be displayed to help disambiguate between different specializations of a template. | |
| llvm::StringRef | CompletionSnippetSuffix |
| What to insert when completing this symbol, after the symbol name. | |
| llvm::StringRef | Documentation |
| Documentation including comment for the symbol declaration. | |
| llvm::StringRef | ReturnType |
| Type when this symbol is used in an expression. | |
| llvm::StringRef | Type |
| Raw representation of the OpaqueType of the symbol, used for scoring purposes. | |
| llvm::SmallVector< IncludeHeaderWithReferences, 1 > | IncludeHeaders |
| One Symbol can potentially be included via different headers. | |
| 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.
Member Enumeration Documentation
◆ IncludeDirective
| enum clang::clangd::Symbol::IncludeDirective : uint8_t |
◆ 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). |
| HasDocComment | Symbol has an attached documentation comment. |
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.
◆ CompletionSnippetSuffix
| llvm::StringRef clang::clangd::Symbol::CompletionSnippetSuffix |
◆ Definition
| SymbolLocation clang::clangd::Symbol::Definition |
◆ Documentation
| llvm::StringRef clang::clangd::Symbol::Documentation |
◆ Flags
| SymbolFlag clang::clangd::Symbol::Flags = SymbolFlag::None |
◆ ID
◆ 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.
◆ Name
| llvm::StringRef clang::clangd::Symbol::Name |
◆ Origin
| SymbolOrigin clang::clangd::Symbol::Origin = SymbolOrigin::Unknown |
◆ References
| unsigned clang::clangd::Symbol::References = 0 |
◆ ReturnType
| llvm::StringRef clang::clangd::Symbol::ReturnType |
◆ Scope
| llvm::StringRef clang::clangd::Symbol::Scope |
◆ Signature
| llvm::StringRef clang::clangd::Symbol::Signature |
◆ SymInfo
| index::SymbolInfo clang::clangd::Symbol::SymInfo = index::SymbolInfo() |
◆ TemplateSpecializationArgs
| llvm::StringRef clang::clangd::Symbol::TemplateSpecializationArgs |
◆ 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.
The documentation for this struct was generated from the following file:
Generated on for clang-tools by
1.14.0