lspserver::TypeHierarchyItem Struct Reference

#include <Protocol.h>

Collaboration diagram for lspserver::TypeHierarchyItem:

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

Public Attributes
std::string	name
	The name of this item.
SymbolKind	kind
	The kind of this item.
std::optional< std::string >	detail
	More detail for this item, e.g. the signature of a function.
URIForFile	uri
	The resource identifier of this item.
Range	range
Range	selectionRange
ResolveParams	data
bool	deprecated = false
std::optional< std::vector< TypeHierarchyItem > >	parents
	This is a clangd exntesion.
std::optional< std::vector< TypeHierarchyItem > >	children

Detailed Description

Definition at line 1428 of file lspserver/include/lspserver/Protocol.h.

Member Data Documentation

children

std::optional<std::vector<TypeHierarchyItem> > lspserver::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 1471 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::fromJSON().

data

ResolveParams lspserver::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 1458 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

deprecated

bool lspserver::TypeHierarchyItem::deprecated = false

true if the hierarchy item is deprecated. Otherwise, false. This is a clangd exntesion.

Definition at line 1462 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::fromJSON().

detail

std::optional<std::string> lspserver::TypeHierarchyItem::detail

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

Definition at line 1436 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

kind

SymbolKind lspserver::TypeHierarchyItem::kind

The kind of this item.

Definition at line 1433 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

name

std::string lspserver::TypeHierarchyItem::name

The name of this item.

Definition at line 1430 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::fromJSON(), lspserver::operator<<(), and lspserver::toJSON().

parents

std::optional<std::vector<TypeHierarchyItem> > lspserver::TypeHierarchyItem::parents

This is a clangd exntesion.

Definition at line 1465 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::fromJSON().

range

Range lspserver::TypeHierarchyItem::range

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

Definition at line 1443 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

selectionRange

Range lspserver::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 1447 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

uri

URIForFile lspserver::TypeHierarchyItem::uri

The resource identifier of this item.

Definition at line 1439 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

---

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

• lspserver/include/lspserver/Protocol.h