clang-tools  16.0.0git
Classes | Public Attributes | List of all members
clang::clangd::TypeHierarchyItem Struct Reference

#include <Protocol.h>

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

Classes

struct  ResolveParams
 Used to resolve a client provided item back. More...
 

Public Attributes

std::string name
 The name of this item. More...
 
SymbolKind kind
 The kind of this item. More...
 
llvm::Optional< std::string > detail
 More detail for this item, e.g. the signature of a function. More...
 
URIForFile uri
 The resource identifier of this item. More...
 
Range range
 The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. More...
 
Range selectionRange
 The range that should be selected and revealed when this symbol is being picked, e.g. More...
 
ResolveParams data
 A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requests. More...
 
bool deprecated = false
 true if the hierarchy item is deprecated. More...
 
llvm::Optional< std::vector< TypeHierarchyItem > > parents
 This is a clangd exntesion. More...
 
llvm::Optional< std::vector< TypeHierarchyItem > > children
 If this type hierarchy item is resolved, it contains the direct children of the current item. More...
 

Detailed Description

Definition at line 1403 of file Protocol.h.

Member Data Documentation

◆ children

llvm::Optional<std::vector<TypeHierarchyItem> > clang::clangd::TypeHierarchyItem::children

If this type hierarchy item is resolved, it contains the direct children of the current item.

Could be empty if the item does not have any descendants. If not defined, the children have not been resolved. This is a clangd exntesion.

Definition at line 1447 of file Protocol.h.

Referenced by clang::clangd::fromJSON(), and clang::clangd::resolveTypeHierarchy().

◆ data

ResolveParams clang::clangd::TypeHierarchyItem::data

A data entry field that is preserved between a type hierarchy prepare and supertypes or subtypes requests.

It could also be used to identify the type hierarchy in the server, helping improve the performance on resolving supertypes and subtypes.

Definition at line 1434 of file Protocol.h.

Referenced by clang::clangd::fillSuperTypes(), clang::clangd::fromJSON(), clang::clangd::resolveTypeHierarchy(), clang::clangd::subTypes(), and clang::clangd::superTypes().

◆ deprecated

bool clang::clangd::TypeHierarchyItem::deprecated = false

true if the hierarchy item is deprecated.

Otherwise, false. This is a clangd exntesion.

Definition at line 1438 of file Protocol.h.

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

◆ detail

llvm::Optional<std::string> clang::clangd::TypeHierarchyItem::detail

More detail for this item, e.g. the signature of a function.

Definition at line 1411 of file Protocol.h.

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

◆ kind

SymbolKind clang::clangd::TypeHierarchyItem::kind

The kind of this item.

Definition at line 1408 of file Protocol.h.

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

◆ name

std::string clang::clangd::TypeHierarchyItem::name

The name of this item.

Definition at line 1405 of file Protocol.h.

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

◆ parents

llvm::Optional<std::vector<TypeHierarchyItem> > clang::clangd::TypeHierarchyItem::parents

This is a clangd exntesion.

Definition at line 1441 of file Protocol.h.

Referenced by clang::clangd::fillSuperTypes(), and clang::clangd::fromJSON().

◆ range

Range clang::clangd::TypeHierarchyItem::range

The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g.

comments and code.

Definition at line 1418 of file Protocol.h.

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

◆ selectionRange

Range clang::clangd::TypeHierarchyItem::selectionRange

The range that should be selected and revealed when this symbol is being picked, e.g.

the name of a function. Must be contained by the range.

Definition at line 1422 of file Protocol.h.

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

◆ uri

URIForFile clang::clangd::TypeHierarchyItem::uri

The resource identifier of this item.

Definition at line 1414 of file Protocol.h.

Referenced by clang::clangd::fromJSON(), clang::clangd::resolveTypeHierarchy(), clang::clangd::subTypes(), and clang::clangd::superTypes().


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