clang-tools  14.0.0git
Public Attributes | List of all members
clang::clangd::SymbolInformation Struct Reference

Represents information about programming constructs like variables, classes, interfaces etc. More...

#include <Protocol.h>

Collaboration diagram for clang::clangd::SymbolInformation:
Collaboration graph
[legend]

Public Attributes

std::string name
 The name of this symbol. More...
 
SymbolKind kind
 The kind of this symbol. More...
 
Location location
 The location of this symbol. More...
 
std::string containerName
 The name of the symbol containing this symbol. More...
 
llvm::Optional< float > score
 The score that clangd calculates to rank the returned symbols. More...
 

Detailed Description

Represents information about programming constructs like variables, classes, interfaces etc.

Definition at line 1037 of file Protocol.h.

Member Data Documentation

◆ containerName

std::string clang::clangd::SymbolInformation::containerName

The name of the symbol containing this symbol.

Definition at line 1048 of file Protocol.h.

Referenced by clang::clangd::flattenSymbolHierarchy(), clang::clangd::operator<<(), and clang::clangd::toJSON().

◆ kind

SymbolKind clang::clangd::SymbolInformation::kind

The kind of this symbol.

Definition at line 1042 of file Protocol.h.

Referenced by clang::clangd::flattenSymbolHierarchy(), and clang::clangd::toJSON().

◆ location

Location clang::clangd::SymbolInformation::location

The location of this symbol.

Definition at line 1045 of file Protocol.h.

Referenced by clang::clangd::flattenSymbolHierarchy(), and clang::clangd::toJSON().

◆ name

std::string clang::clangd::SymbolInformation::name

The name of this symbol.

Definition at line 1039 of file Protocol.h.

Referenced by clang::clangd::flattenSymbolHierarchy(), clang::clangd::operator<<(), and clang::clangd::toJSON().

◆ score

llvm::Optional<float> clang::clangd::SymbolInformation::score

The score that clangd calculates to rank the returned symbols.

This excludes the fuzzy-matching score between name and the query. (Specifically, the last ::-separated component). This can be used to re-rank results as the user types, using client-side fuzzy-matching (that score should be multiplied with this one). This is a clangd extension, set only for workspace/symbol responses.

Definition at line 1056 of file Protocol.h.

Referenced by clang::clangd::toJSON().


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