clang-tools  10.0.0svn
Public Attributes | List of all members
clang::clangd::TypeHierarchyItem Struct Reference

#include <Protocol.h>

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

Public Attributes

std::string name
 The human readable name of the hierarchy item. More...
 
llvm::Optional< std::string > detail
 Optional detail for the hierarchy item. More...
 
SymbolKind kind
 The kind of the hierarchy item. For instance, class or interface. More...
 
bool deprecated = false
 true if the hierarchy item is deprecated. Otherwise, false. More...
 
URIForFile uri
 The URI of the text document where this type hierarchy item belongs to. More...
 
Range range
 The range enclosing this type hierarchy item not including leading/trailing whitespace but everything else like comments. More...
 
Range selectionRange
 The range that should be selected and revealed when this type hierarchy item is being picked, e.g. More...
 
llvm::Optional< std::vector< TypeHierarchyItem > > parents
 If this type hierarchy item is resolved, it contains the direct parents. More...
 
llvm::Optional< std::vector< TypeHierarchyItem > > children
 If this type hierarchy item is resolved, it contains the direct children of the current item. More...
 
llvm::Optional< std::string > data
 An optional 'data' filed, which can be used to identify a type hierarchy item in a resolve request. More...
 

Detailed Description

Definition at line 1129 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.

Definition at line 1165 of file Protocol.h.

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

◆ data

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

An optional 'data' filed, which can be used to identify a type hierarchy item in a resolve request.

Definition at line 1169 of file Protocol.h.

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

◆ deprecated

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

true if the hierarchy item is deprecated. Otherwise, false.

Definition at line 1141 of file Protocol.h.

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

◆ detail

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

Optional detail for the hierarchy item.

It can be, for instance, the signature of a function or method.

Definition at line 1135 of file Protocol.h.

◆ kind

SymbolKind clang::clangd::TypeHierarchyItem::kind

The kind of the hierarchy item. For instance, class or interface.

Definition at line 1138 of file Protocol.h.

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

◆ name

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

The human readable name of the hierarchy item.

Definition at line 1131 of file Protocol.h.

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

◆ parents

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

If this type hierarchy item is resolved, it contains the direct parents.

Could be empty if the item does not have direct parents. If not defined, the parents have not been resolved yet.

Definition at line 1160 of file Protocol.h.

◆ range

Range clang::clangd::TypeHierarchyItem::range

The range enclosing this type hierarchy item not including leading/trailing whitespace but everything else like comments.

This information is typically used to determine if the client's cursor is inside the type hierarch item to reveal in the symbol in the UI.

Definition at line 1150 of file Protocol.h.

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

◆ selectionRange

Range clang::clangd::TypeHierarchyItem::selectionRange

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

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

Definition at line 1155 of file Protocol.h.

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

◆ uri

URIForFile clang::clangd::TypeHierarchyItem::uri

The URI of the text document where this type hierarchy item belongs to.

Definition at line 1144 of file Protocol.h.

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


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