|
| 1 | +/* -------------------------------------------------------------------------------------------- |
| 2 | + * Copyright (c) TypeFox and others. All rights reserved. |
| 3 | + * Licensed under the MIT License. See License.txt in the project root for license information. |
| 4 | + * ------------------------------------------------------------------------------------------ */ |
| 5 | +'use strict'; |
| 6 | + |
| 7 | +import { RequestType, RequestHandler } from 'vscode-jsonrpc'; |
| 8 | +import { Location, SymbolKind, Range } from 'vscode-languageserver-types'; |
| 9 | +import { TextDocumentRegistrationOptions, StaticRegistrationOptions, TextDocumentPositionParams } from './protocol'; |
| 10 | + |
| 11 | +export interface CallHierarchyClientCapabilities { |
| 12 | + /** |
| 13 | + * The text document client capabilities |
| 14 | + */ |
| 15 | + textDocument?: { |
| 16 | + /** |
| 17 | + * Capabilities specific to the `textDocument/callHierarchy` |
| 18 | + */ |
| 19 | + callHierarchy?: { |
| 20 | + /** |
| 21 | + * Whether implementation supports dynamic registration. If this is set to `true` |
| 22 | + * the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)` |
| 23 | + * return value for the corresponding server capability as well. |
| 24 | + */ |
| 25 | + dynamicRegistration?: boolean; |
| 26 | + }; |
| 27 | + } |
| 28 | +} |
| 29 | + |
| 30 | +export interface CallHierarchyServerCapabilities { |
| 31 | + /** |
| 32 | + * The server provides Call Hierarchy support. |
| 33 | + */ |
| 34 | + callHierarchyProvider?: boolean | (TextDocumentRegistrationOptions & StaticRegistrationOptions); |
| 35 | +} |
| 36 | + |
| 37 | +/** |
| 38 | + * Request to request the call hierarchy at a given text document position. |
| 39 | + * |
| 40 | + * The request's parameter is of type [CallHierarchyParams](#CallHierarchyParams). The response |
| 41 | + * is of type [CallHierarchyItem](#CallHierarchyItem) or a Thenable that resolves to such. |
| 42 | + * |
| 43 | + * The optional request's parameter defines the maximum number of levels to [resolve](#CallHierarchyParams.resolve) by this request. |
| 44 | + * Unresolved items can be resolved in subsequent `callHierarchy/resolve` requests. |
| 45 | + */ |
| 46 | +export namespace CallHierarchyRequest { |
| 47 | + export const type = new RequestType<CallHierarchyParams, CallHierarchyItem, void, TextDocumentRegistrationOptions>('textDocument/callHierarchy'); |
| 48 | + export type HandlerSignature = RequestHandler<CallHierarchyParams, CallHierarchyItem | null, void>; |
| 49 | +} |
| 50 | + |
| 51 | +/** |
| 52 | + * Request to resolve a call hierarchy item. |
| 53 | + * |
| 54 | + * The request's parameter is of type [ResolveCallHierarchyItemParams](#ResolveCallHierarchyItemParams). The response |
| 55 | + * is of type [CallHierarchyItem](#CallHierarchyItem) or a Thenable that resolves to such. |
| 56 | + */ |
| 57 | +export namespace CallHierarchyResolveRequest { |
| 58 | + export const type = new RequestType<ResolveCallHierarchyItemParams, CallHierarchyItem, void, void>('callHierarchy/resolve'); |
| 59 | + export type HandlerSignature = RequestHandler<ResolveCallHierarchyItemParams, CallHierarchyItem | null, void>; |
| 60 | +} |
| 61 | + |
| 62 | +/** |
| 63 | + * The parameters of a `textDocument/callHierarchy` request. |
| 64 | + */ |
| 65 | +export interface CallHierarchyParams extends TextDocumentPositionParams { |
| 66 | + /** |
| 67 | + * The number of levels to resolve. |
| 68 | + */ |
| 69 | + resolve?: number; |
| 70 | + /** |
| 71 | + * The direction of calls to resolve. |
| 72 | + */ |
| 73 | + direction?: CallHierarchyDirection; |
| 74 | +} |
| 75 | + |
| 76 | +/** |
| 77 | + * The parameters of a `callHierarchy/resolve` request. |
| 78 | + */ |
| 79 | +export interface ResolveCallHierarchyItemParams { |
| 80 | + /** |
| 81 | + * Unresolved item. |
| 82 | + */ |
| 83 | + item: CallHierarchyItem; |
| 84 | + /** |
| 85 | + * The number of levels to resolve. |
| 86 | + */ |
| 87 | + resolve: number; |
| 88 | + /** |
| 89 | + * The direction of calls to resolve. |
| 90 | + */ |
| 91 | + direction: CallHierarchyDirection; |
| 92 | +} |
| 93 | + |
| 94 | +/** |
| 95 | + * The direction of a call hierarchy. |
| 96 | + */ |
| 97 | +export namespace CallHierarchyDirection { |
| 98 | + /** |
| 99 | + * The callers of a symbol. |
| 100 | + */ |
| 101 | + export const Incoming: 1 = 1; |
| 102 | + |
| 103 | + /** |
| 104 | + * The callees of a symbol. |
| 105 | + */ |
| 106 | + export const Outgoing: 2 = 2; |
| 107 | +} |
| 108 | + |
| 109 | +export type CallHierarchyDirection = 1 | 2; |
| 110 | + |
| 111 | +/** |
| 112 | + * The result of a `textDocument/callHierarchy` request. |
| 113 | + */ |
| 114 | +export interface CallHierarchyItem { |
| 115 | + |
| 116 | + /** |
| 117 | + * The name of the symbol targeted by the call hierarchy request. |
| 118 | + */ |
| 119 | + name: string; |
| 120 | + |
| 121 | + /** |
| 122 | + * More detail for this symbol, e.g the signature of a function. |
| 123 | + */ |
| 124 | + detail?: string; |
| 125 | + |
| 126 | + /** |
| 127 | + * The kind of this symbol. |
| 128 | + */ |
| 129 | + kind: SymbolKind; |
| 130 | + |
| 131 | + /** |
| 132 | + * `true` if the hierarchy item is deprecated. Otherwise, `false`. It is `false` by default. |
| 133 | + */ |
| 134 | + deprecated?: boolean; |
| 135 | + |
| 136 | + /** |
| 137 | + * URI of the document containing the symbol. |
| 138 | + */ |
| 139 | + uri: string; |
| 140 | + |
| 141 | + /** |
| 142 | + * The range enclosing this symbol not including leading/trailing whitespace but everything else |
| 143 | + * like comments. This information is typically used to determine if the the clients cursor is |
| 144 | + * inside the symbol to reveal in the symbol in the UI. |
| 145 | + */ |
| 146 | + range: Range; |
| 147 | + |
| 148 | + /** |
| 149 | + * The range that should be selected and revealed when this symbol is being picked, e.g the name of a function. |
| 150 | + * Must be contained by the the `range`. |
| 151 | + */ |
| 152 | + selectionRange: Range; |
| 153 | + |
| 154 | + /** |
| 155 | + * The actual locations of incoming (or outgoing) calls to (or from) a callable identified by this item. |
| 156 | + * |
| 157 | + * *Note*: undefined in root item. |
| 158 | + */ |
| 159 | + callLocations?: Location[]; |
| 160 | + |
| 161 | + /** |
| 162 | + * List of incoming (or outgoing) calls to (or from) a callable identified by this item. |
| 163 | + * |
| 164 | + * *Note*: if undefined, this item is unresolved. |
| 165 | + */ |
| 166 | + calls?: CallHierarchyItem[]; |
| 167 | + |
| 168 | + /** |
| 169 | + * Optional data to identify an item in a resolve request. |
| 170 | + */ |
| 171 | + data?: any; |
| 172 | +} |
0 commit comments