Skip to content

Latest commit

 

History

History
102 lines (63 loc) · 4.72 KB

codearts_plugin_.CallHierarchyProvider.md

File metadata and controls

102 lines (63 loc) · 4.72 KB
Raw

@codearts/plugin / "@codearts/plugin" / CallHierarchyProvider

Interface: CallHierarchyProvider

"@codearts/plugin".CallHierarchyProvider

The call hierarchy provider interface describes the contract between extensions and the call hierarchy feature which allows to browse calls and caller of function, methods, constructor etc.

Table of contents

Methods

Methods

prepareCallHierarchy

▸ prepareCallHierarchy(document, position, token): ProviderResult<CallHierarchyItem | CallHierarchyItem[]>

Bootstraps call hierarchy by returning the item that is denoted by the given document and position. This item will be used as entry into the call graph. Providers should return undefined or null when there is no item at the given location.

Parameters

Name Type Description
document TextDocument The document in which the command was invoked.
position Position The position at which the command was invoked.
token CancellationToken A cancellation token.

Returns

ProviderResult<CallHierarchyItem | CallHierarchyItem[]>

One or multiple call hierarchy items or a thenable that resolves to such. The lack of a result can be signaled by returning undefined, null, or an empty array.

Defined in

index.d.ts:5321

provideCallHierarchyIncomingCalls

▸ provideCallHierarchyIncomingCalls(item, token): ProviderResult<CallHierarchyIncomingCall[]>

Provide all incoming calls for an item, e.g all callers for a method. In graph terms this describes directed and annotated edges inside the call graph, e.g the given item is the starting node and the result is the nodes that can be reached.

Parameters

Name Type Description
item CallHierarchyItem The hierarchy item for which incoming calls should be computed.
token CancellationToken A cancellation token.

Returns

ProviderResult<CallHierarchyIncomingCall[]>

A set of incoming calls or a thenable that resolves to such. The lack of a result can be signaled by returning undefined or null.

Defined in

index.d.ts:5333

provideCallHierarchyOutgoingCalls

▸ provideCallHierarchyOutgoingCalls(item, token): ProviderResult<CallHierarchyOutgoingCall[]>

Provide all outgoing calls for an item, e.g call calls to functions, methods, or constructors from the given item. In graph terms this describes directed and annotated edges inside the call graph, e.g the given item is the starting node and the result is the nodes that can be reached.

Parameters

Name Type Description
item CallHierarchyItem The hierarchy item for which outgoing calls should be computed.
token CancellationToken A cancellation token.

Returns

ProviderResult<CallHierarchyOutgoingCall[]>

A set of outgoing calls or a thenable that resolves to such. The lack of a result can be signaled by returning undefined or null.

Defined in

index.d.ts:5345