Support vscode TypeHierarchy API (references-view)

This change introduces support for vscode Typehierarchy API and
integrates the solution with the facilities provided by the
references-view extension.
E.g. via the implementation of the commands
	`vscode.prepareTypeHierarchy`,
	`vscode.provideSupertypes`,
	`vscode.provideSupertypes`

The `Show Type Hierarchy` context menu shall be enabled from an
editor as long as a TypeHIerarchyProvider is registered for the
specific language.

Similarly the following commands shall now be functional from the
command palette.
	`Types: Show Type Hierarchy`
	`Types: Show Subtypes`
	`Types: Show Supertypes`

Signed-off-by: Alvaro Sanchez-Leon <[email protected]>

Author: alvsan09

CHANGELOG.md

@@ -15,6 +15,11 @@
 generating the main code bundle (as before), the second serves to generate a *.css file for inclusion into `secondaryWindow.html` [#11707](https://github.com/eclipse-theia/theia/pull/11707)
 - [plugin-ext] `when` clauses removed from `codeToTheiaMappings` [#11741](https://github.com/eclipse-theia/theia/pull/#11741)
 - [terminal] The `AbstractCmdClickTerminalContribution` API has been removed in favor of the `TerminalLinkProvider` interface [#11552](https://github.com/eclipse-theia/theia/pull/11552) - Contributed on behalf of STMicroelectronics
+- [typehierarchy] - Adding Support of vscode TypeHierarchy API with the following breaking changes: [#11694](https://github.com/eclipse-theia/theia/pull/11694)
+  -  [plugin-ext/main] The file `callhierarchy-type-converters.ts` was renamed to `hierarchy-types-converters.ts`
+      - The method `toDefinition` was renamed to `toItemHierarchyDefinition` and the overloaded signatures were removed.
+      - The method `fromDefinition` was replaced for `fromItemHierarchyDefinition` to convert both `TypeHierarchyItem` and `CallHierarchyItem` to a common `HierarchyItem`.
+  - [plugin-ext/plugin] - `thype-converters.ts #fromCallHierarchyItem` was replaced by `fromHierarchyItem` to convert from `CallHierarchyItem` or  `TypeHierarchyItem` to `HierarchyItem`.
 
 ## v1.30.0 - 9/29/2022
 

packages/plugin-ext-vscode/package.json

@@ -13,6 +13,7 @@
     "@theia/plugin": "1.30.0",
     "@theia/plugin-ext": "1.30.0",
     "@theia/terminal": "1.30.0",
+    "@theia/typehierarchy": "1.30.0",
     "@theia/userstorage": "1.30.0",
     "@theia/workspace": "1.30.0",
     "@types/request": "^2.0.3",

packages/plugin-ext-vscode/src/browser/plugin-vscode-commands-contribution.ts

@@ -37,6 +37,7 @@ import {
     CallHierarchyItem,
     CallHierarchyIncomingCall,
     CallHierarchyOutgoingCall,
+    TypeHierarchyItem,
     Hover,
     TextEdit,
     FormattingOptions,
@@ -64,13 +65,14 @@ import { SelectableTreeNode } from '@theia/core/lib/browser/tree/tree-selection'
 import { UriComponents } from '@theia/plugin-ext/lib/common/uri-components';
 import { FileService } from '@theia/filesystem/lib/browser/file-service';
 import { CallHierarchyServiceProvider, CallHierarchyService } from '@theia/callhierarchy/lib/browser';
+import { TypeHierarchyServiceProvider, TypeHierarchyService } from '@theia/typehierarchy/lib/browser';
 import { MonacoTextModelService } from '@theia/monaco/lib/browser/monaco-text-model-service';
 import {
     fromCallHierarchyCalleeToModelCallHierarchyOutgoingCall,
     fromCallHierarchyCallerToModelCallHierarchyIncomingCall,
-    fromDefinition,
-    toDefinition
-} from '@theia/plugin-ext/lib/main/browser/callhierarchy/callhierarchy-type-converters';
+    fromItemHierarchyDefinition,
+    toItemHierarchyDefinition
+} from '@theia/plugin-ext/lib/main/browser/hierarchy/hierarchy-types-converters';
 import { CustomEditorOpener } from '@theia/plugin-ext/lib/main/browser/custom-editors/custom-editor-opener';
 import { nls } from '@theia/core/lib/common/nls';
 import { WindowService } from '@theia/core/lib/browser/window/window-service';
@@ -170,6 +172,8 @@ export class PluginVscodeCommandsContribution implements CommandContribution {
     protected readonly fileService: FileService;
     @inject(CallHierarchyServiceProvider)
     protected readonly callHierarchyProvider: CallHierarchyServiceProvider;
+    @inject(TypeHierarchyServiceProvider)
+    protected readonly typeHierarchyProvider: TypeHierarchyServiceProvider;
     @inject(MonacoTextModelService)
     protected readonly textModelService: MonacoTextModelService;
     @inject(WindowService)
@@ -642,7 +646,7 @@ export class PluginVscodeCommandsContribution implements CommandContribution {
                         new CancellationTokenSource().token
                     );
                     if (definition) {
-                        return definition.items.map(item => fromDefinition(item));
+                        return definition.items.map(item => fromItemHierarchyDefinition(item));
                     };
                     return [];
                 }
@@ -657,7 +661,7 @@ export class PluginVscodeCommandsContribution implements CommandContribution {
                     const resource = URI.from(item.uri);
                     const provider = await this.getCallHierarchyServiceForUri(resource);
                     const incomingCalls = await provider?.getCallers(
-                        toDefinition(item),
+                        toItemHierarchyDefinition(item),
                         new CancellationTokenSource().token,
                     );
                     if (incomingCalls) {
@@ -676,7 +680,7 @@ export class PluginVscodeCommandsContribution implements CommandContribution {
                     const resource = URI.from(item.uri);
                     const provider = await this.getCallHierarchyServiceForUri(resource);
                     const outgoingCalls = await provider?.getCallees?.(
-                        toDefinition(item),
+                        toItemHierarchyDefinition(item),
                         new CancellationTokenSource().token,
                     );
                     if (outgoingCalls) {
@@ -686,6 +690,62 @@ export class PluginVscodeCommandsContribution implements CommandContribution {
                 }
             }
         );
+        commands.registerCommand(
+            {
+                id: 'vscode.prepareTypeHierarchy'
+            },
+            {
+                execute: async (resource: URI, position: Position): Promise<TypeHierarchyItem[]> => {
+                    const provider = await this.getTypeHierarchyServiceForUri(resource);
+                    const session = await provider?.prepareSession(
+                        resource.path,
+                        toPosition(position),
+                        new CancellationTokenSource().token
+                    );
+                    return session ? session.items.map(item => fromItemHierarchyDefinition(item)) : [];
+                }
+            }
+        );
+        commands.registerCommand(
+            {
+                id: 'vscode.provideSupertypes'
+            },
+            {
+                execute: async (item: TypeHierarchyItem): Promise<TypeHierarchyItem[]> => {
+                    if (!item._sessionId || !item._itemId) {
+                        return [];
+                    }
+                    const resource = URI.from(item.uri);
+                    const provider = await this.getTypeHierarchyServiceForUri(resource);
+                    const items = await provider?.provideSuperTypes(
+                        item._sessionId,
+                        item._itemId,
+                        new CancellationTokenSource().token
+                    );
+                    return (items ? items : []).map(typeItem => fromItemHierarchyDefinition(typeItem));
+                }
+            }
+        );
+        commands.registerCommand(
+            {
+                id: 'vscode.provideSubtypes'
+            },
+            {
+                execute: async (item: TypeHierarchyItem): Promise<TypeHierarchyItem[]> => {
+                    if (!item._sessionId || !item._itemId) {
+                        return [];
+                    }
+                    const resource = URI.from(item.uri);
+                    const provider = await this.getTypeHierarchyServiceForUri(resource);
+                    const items = await provider?.provideSubTypes(
+                        item._sessionId, item._itemId,
+                        new CancellationTokenSource().token
+                    );
+                    return (items ? items : []).map(typeItem => fromItemHierarchyDefinition(typeItem));
+
+                }
+            }
+        );
 
         commands.registerCommand({
             id: 'workbench.action.openRecent'
@@ -845,11 +905,20 @@ export class PluginVscodeCommandsContribution implements CommandContribution {
         });
     }
 
-    protected async getCallHierarchyServiceForUri(resource: URI): Promise<CallHierarchyService | undefined> {
+    private async resolveLanguageId(resource: URI): Promise<string> {
         const reference = await this.textModelService.createModelReference(resource);
-        const uri = new TheiaURI(resource);
         const languageId = reference.object.languageId;
         reference.dispose();
-        return this.callHierarchyProvider.get(languageId, uri);
+        return languageId;
+    }
+
+    protected async getCallHierarchyServiceForUri(resource: URI): Promise<CallHierarchyService | undefined> {
+        const languageId = await this.resolveLanguageId(resource);
+        return this.callHierarchyProvider.get(languageId, new TheiaURI(resource));
+    }
+
+    protected async getTypeHierarchyServiceForUri(resource: URI): Promise<TypeHierarchyService | undefined> {
+        const languageId = await this.resolveLanguageId(resource);
+        return this.typeHierarchyProvider.get(languageId, new TheiaURI(resource));
     }
 }

packages/plugin-ext-vscode/tsconfig.json

@@ -41,6 +41,9 @@
     {
       "path": "../terminal"
     },
+    {
+      "path": "../typehierarchy"
+    },
     {
       "path": "../userstorage"
     },

packages/plugin-ext/package.json

@@ -26,6 +26,7 @@
     "@theia/task": "1.30.0",
     "@theia/terminal": "1.30.0",
     "@theia/timeline": "1.30.0",
+    "@theia/typehierarchy": "1.30.0",
     "@theia/variable-resolver": "1.30.0",
     "@theia/workspace": "1.30.0",
     "@types/mime": "^2.0.1",

packages/plugin-ext/src/common/plugin-api-rpc-model.ts

@@ -565,17 +565,22 @@ export interface RenameLocation {
     text: string;
 }
 
-export interface CallHierarchyItem {
+export class HierarchyItem {
     _sessionId?: string;
     _itemId?: string;
 
     kind: SymbolKind;
+    tags?: readonly SymbolTag[];
     name: string;
     detail?: string;
     uri: UriComponents;
     range: Range;
     selectionRange: Range;
-    tags?: readonly SymbolTag[];
+}
+
+export class TypeHierarchyItem extends HierarchyItem { }
+
+export interface CallHierarchyItem extends HierarchyItem {
     data?: unknown;
 }
 

packages/plugin-ext/src/common/plugin-api-rpc.ts

@@ -80,7 +80,8 @@ import {
     ProvidedTerminalLink,
     InlayHint,
     CachedSession,
-    CachedSessionItem
+    CachedSessionItem,
+    TypeHierarchyItem
 } from './plugin-api-rpc-model';
 import { ExtPluginApi } from './plugin-ext-api-contribution';
 import { KeysToAnyValues, KeysToKeysToAnyValue } from './types';
@@ -1566,6 +1567,10 @@ export interface LanguagesExt {
     $provideCallees(handle: number, definition: CallHierarchyItem, token: CancellationToken): Promise<CallHierarchyOutgoingCall[] | undefined>;
     $provideLinkedEditingRanges(handle: number, resource: UriComponents, position: Position, token: CancellationToken): Promise<LinkedEditingRanges | undefined>;
     $releaseCallHierarchy(handle: number, session?: string): Promise<boolean>;
+    $prepareTypeHierarchy(handle: number, resource: UriComponents, location: Position, token: theia.CancellationToken): Promise<TypeHierarchyItem[] | undefined>
+    $provideSuperTypes(handle: number, sessionId: string, itemId: string, token: theia.CancellationToken): Promise<TypeHierarchyItem[] | undefined>
+    $provideSubTypes(handle: number, sessionId: string, itemId: string, token: theia.CancellationToken): Promise<TypeHierarchyItem[] | undefined>;
+    $releaseTypeHierarchy(handle: number, session?: string): Promise<boolean>;
 }
 
 export const LanguagesMainFactory = Symbol('LanguagesMainFactory');
@@ -1620,6 +1625,7 @@ export interface LanguagesMain {
     $registerDocumentRangeSemanticTokensProvider(handle: number, pluginInfo: PluginInfo, selector: SerializedDocumentFilter[], legend: theia.SemanticTokensLegend): void;
     $registerCallHierarchyProvider(handle: number, selector: SerializedDocumentFilter[]): void;
     $registerLinkedEditingRangeProvider(handle: number, selector: SerializedDocumentFilter[]): void;
+    $registerTypeHierarchyProvider(handle: number, selector: SerializedDocumentFilter[]): void;
     $setLanguageStatus(handle: number, status: LanguageStatus): void;
     $removeLanguageStatus(handle: number): void;
 }