GH-707: Introduced the @theia/typehierarchy extension.

- Extended the LSP with the type hierarchy. - From now on, a tree node can carry decoration data. - TODO... Closes: #707. Signed-off-by: Akos Kitta <[email protected]>
eclipse-theia · Oct 11, 2018 · 3dd6c0b · 3dd6c0b
1 parent 02ae8ea
commit 3dd6c0b
Show file tree

Hide file tree

Showing 27 changed files with 1,245 additions and 20 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -52,6 +52,7 @@ cache:
   - packages/terminal/node_modules
   - packages/textmate-grammars/node_modules
   - packages/tslint/node_modules
+  - packages/typehierarchy/node_modules
   - packages/typescript/node_modules
   - packages/userstorage/node_modules
   - packages/variable-resolver/node_modules

diff --git a/examples/browser/package.json b/examples/browser/package.json
@@ -40,6 +40,7 @@
     "@theia/textmate-grammars": "^0.3.15",
     "@theia/tslint": "^0.3.15",
     "@theia/typescript": "^0.3.15",
+    "@theia/typehierarchy": "^0.3.15",
     "@theia/userstorage": "^0.3.15",
     "@theia/variable-resolver": "^0.3.15",
     "@theia/workspace": "^0.3.15"
@@ -62,4 +63,4 @@
   "devDependencies": {
     "@theia/cli": "^0.3.15"
   }
-}
+}
diff --git a/examples/electron/package.json b/examples/electron/package.json
@@ -43,6 +43,7 @@
     "@theia/textmate-grammars": "^0.3.15",
     "@theia/tslint": "^0.3.15",
     "@theia/typescript": "^0.3.15",
+    "@theia/typehierarchy": "^0.3.15",
     "@theia/userstorage": "^0.3.15",
     "@theia/variable-resolver": "^0.3.15",
     "@theia/workspace": "^0.3.15"
@@ -60,4 +61,4 @@
   "devDependencies": {
     "@theia/cli": "^0.3.15"
   }
-}
+}
diff --git a/packages/core/src/browser/tree/tree-decorator.ts b/packages/core/src/browser/tree/tree-decorator.ts
@@ -15,7 +15,7 @@
  ********************************************************************************/
 
 import { injectable } from 'inversify';
-import { Tree } from './tree';
+import { Tree, TreeNode } from './tree';
 import { Event, Emitter, Disposable, DisposableCollection, MaybePromise } from '../../common';
 
 /**
@@ -501,4 +501,27 @@ export namespace TreeDecoration {
 
     }
 
+    /**
+     * Tree node that can be decorated explicitly, without the tree decorators.
+     */
+    export interface DecoratedTreeNode extends TreeNode {
+
+        /**
+         * The additional tree decoration data attached to the tree node itself.
+         */
+        readonly decorationData: Data;
+
+    }
+
+    export namespace DecoratedTreeNode {
+
+        /**
+         * Type-guard for decorated tree nodes.
+         */
+        export function is(node: TreeNode | undefined): node is DecoratedTreeNode {
+            return !!node && 'decorationData' in node;
+        }
+
+    }
+
 }
diff --git a/packages/core/src/browser/tree/tree-widget.tsx b/packages/core/src/browser/tree/tree-widget.tsx
@@ -592,11 +592,14 @@ export class TreeWidget extends ReactWidget implements StatefulWidget {
     }
 
     protected getDecorations(node: TreeNode): TreeDecoration.Data[] {
-        const decorations = this.decorations.get(node.id);
-        if (decorations) {
-            return decorations.sort(TreeDecoration.Data.comparePriority);
+        const decorations: TreeDecoration.Data[] = [];
+        if (TreeDecoration.DecoratedTreeNode.is(node)) {
+            decorations.push(node.decorationData);
+        }
+        if (this.decorations.has(node.id)) {
+            decorations.push(...this.decorations.get(node.id));
         }
-        return [];
+        return decorations.sort(TreeDecoration.Data.comparePriority);
     }
 
     protected getDecorationData<K extends keyof TreeDecoration.Data>(node: TreeNode, key: K): TreeDecoration.Data[K][] {

diff --git a/packages/editor/src/browser/editor-frontend-module.ts b/packages/editor/src/browser/editor-frontend-module.ts
@@ -18,7 +18,7 @@ import { ContainerModule } from 'inversify';
 import { CommandContribution, MenuContribution } from '@theia/core/lib/common';
 import { OpenHandler, WidgetFactory, FrontendApplicationContribution, KeybindingContext, KeybindingContribution } from '@theia/core/lib/browser';
 import { VariableContribution } from '@theia/variable-resolver/lib/browser';
-import { EditorManager } from './editor-manager';
+import { EditorManager, EditorAccess, ActiveEditorAccess, CurrentEditorAccess } from './editor-manager';
 import { EditorContribution } from './editor-contribution';
 import { EditorMenuContribution } from './editor-menu';
 import { EditorCommandContribution } from './editor-command';
@@ -61,4 +61,9 @@ export default new ContainerModule(bind => {
     bind(VariableContribution).to(EditorVariableContribution).inSingletonScope();
 
     bind(SemanticHighlightingService).toSelf().inSingletonScope();
+
+    bind(CurrentEditorAccess).toSelf().inSingletonScope();
+    bind(ActiveEditorAccess).toSelf().inSingletonScope();
+    bind(EditorAccess).to(CurrentEditorAccess).inSingletonScope().whenTargetNamed(EditorAccess.CURRENT);
+    bind(EditorAccess).to(ActiveEditorAccess).inSingletonScope().whenTargetNamed(EditorAccess.ACTIVE);
 });
diff --git a/packages/editor/src/browser/editor-manager.ts b/packages/editor/src/browser/editor-manager.ts
@@ -14,13 +14,14 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { injectable, postConstruct, } from 'inversify';
+import { injectable, postConstruct, inject } from 'inversify';
 import URI from '@theia/core/lib/common/uri';
 import { RecursivePartial, Emitter, Event } from '@theia/core/lib/common';
 import { WidgetOpenerOptions, NavigatableWidgetOpenHandler } from '@theia/core/lib/browser';
 import { EditorWidget } from './editor-widget';
-import { Range, Position } from './editor';
+import { Range, Position, Location } from './editor';
 import { EditorWidgetFactory } from './editor-widget-factory';
+import { TextEditor } from './editor';
 
 export interface EditorOpenerOptions extends WidgetOpenerOptions {
     selection?: RecursivePartial<Range>;
@@ -134,3 +135,97 @@ export class EditorManager extends NavigatableWidgetOpenHandler<EditorWidget> {
     }
 
 }
+
+/**
+ * Provides direct access to the underlying text editor.
+ */
+@injectable()
+export abstract class EditorAccess {
+
+    @inject(EditorManager)
+    protected readonly editorManager: EditorManager;
+
+    /**
+     * The URI of the underlying document from the editor.
+     */
+    get uri(): string | undefined {
+        const editor = this.editor;
+        if (editor) {
+            return editor.uri.toString();
+        }
+        return undefined;
+    }
+
+    /**
+     * The selection location from the text editor.
+     */
+    get selection(): Location | undefined {
+        const editor = this.editor;
+        if (editor) {
+            const uri = editor.uri.toString();
+            const range = editor.selection;
+            return {
+                range,
+                uri
+            };
+        }
+        return undefined;
+    }
+
+    /**
+     * The unique identifier of the language the current editor belongs to.
+     */
+    get languageId(): string | undefined {
+        const editor = this.editor;
+        if (editor) {
+            return editor.document.languageId;
+        }
+        return undefined;
+    }
+
+    /**
+     * The text editor.
+     */
+    get editor(): TextEditor | undefined {
+        const editorWidget = this.editorWidget();
+        if (editorWidget) {
+            return editorWidget.editor;
+        }
+        return undefined;
+    }
+
+    /**
+     * The editor widget, or `undefined` if not applicable.
+     */
+    protected abstract editorWidget(): EditorWidget | undefined;
+
+}
+
+/**
+ * Provides direct access to the currently active text editor.
+ */
+@injectable()
+export class CurrentEditorAccess extends EditorAccess {
+
+    protected editorWidget(): EditorWidget | undefined {
+        return this.editorManager.currentEditor;
+    }
+
+}
+
+/**
+ * Provides access to the active text editor.
+ */
+@injectable()
+export class ActiveEditorAccess extends EditorAccess {
+
+    protected editorWidget(): EditorWidget | undefined {
+        return this.editorManager.activeEditor;
+    }
+
+}
+
+export namespace EditorAccess {
+    export const CURRENT = 'current-editor-access';
+    export const ACTIVE = 'active-editor-access';
+}
diff --git a/packages/editor/src/browser/editor.ts b/packages/editor/src/browser/editor.ts
@@ -14,15 +14,15 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { Position, Range } from 'vscode-languageserver-types';
+import { Position, Range, Location } from 'vscode-languageserver-types';
 import * as lsp from 'vscode-languageserver-types';
 import URI from '@theia/core/lib/common/uri';
 import { Event, Disposable } from '@theia/core/lib/common';
 import { Saveable } from '@theia/core/lib/browser';
 import { EditorDecoration } from './decorations';
 
 export {
-    Position, Range
+    Position, Range, Location
 };
 
 export const TextEditorProvider = Symbol('TextEditorProvider');

diff --git a/packages/java/package.json b/packages/java/package.json
@@ -7,6 +7,7 @@
     "@theia/editor": "^0.3.15",
     "@theia/languages": "^0.3.15",
     "@theia/monaco": "^0.3.15",
+    "@theia/typehierarchy": "^0.3.15",
     "@types/glob": "^5.0.30",
     "@types/tar": "4.0.0",
     "glob": "^7.1.2",
@@ -58,6 +59,6 @@
     "extends": "../../configs/nyc.json"
   },
   "ls": {
-    "downloadUrl": "https://github.com/kittaakos/eclipse.jdt.ls-gh-715/raw/master/jdt-language-server-latest.tar.gz"
+    "downloadUrl": "https://github.com/kittaakos/eclipse.jdt.ls-gh-28/raw/master/jdt-language-server-latest.tar.gz"
   }
-}
+}
diff --git a/packages/java/src/browser/java-client-contribution.ts b/packages/java/src/browser/java-client-contribution.ts
@@ -18,6 +18,7 @@ import { injectable, inject } from 'inversify';
 import { MessageConnection } from 'vscode-jsonrpc';
 import { CommandService } from '@theia/core/lib/common';
 import { StatusBar, StatusBarEntry, StatusBarAlignment } from '@theia/core/lib/browser';
+import { TypeHierarchyService } from '@theia/typehierarchy/lib/browser/typehierarchy-service';
 import { SemanticHighlightingService } from '@theia/editor/lib/browser/semantic-highlight/semantic-highlighting-service';
 import {
     Window,
@@ -50,7 +51,8 @@ export class JavaClientContribution extends BaseLanguageClientContribution {
         @inject(Window) protected readonly window: Window,
         @inject(CommandService) protected readonly commandService: CommandService,
         @inject(StatusBar) protected readonly statusBar: StatusBar,
-        @inject(SemanticHighlightingService) protected readonly semanticHighlightingService: SemanticHighlightingService
+        @inject(SemanticHighlightingService) protected readonly semanticHighlightingService: SemanticHighlightingService,
+        @inject(TypeHierarchyService) protected readonly typeHierarchyService: TypeHierarchyService
     ) {
         super(workspace, languages, languageClientFactory);
     }
@@ -71,7 +73,10 @@ export class JavaClientContribution extends BaseLanguageClientContribution {
 
     protected createLanguageClient(connection: MessageConnection): ILanguageClient {
         const client: ILanguageClient & Readonly<{ languageId: string }> = Object.assign(super.createLanguageClient(connection), { languageId: this.id });
-        client.registerFeature(SemanticHighlightingService.createNewFeature(this.semanticHighlightingService, client));
+        client.registerFeatures([
+            SemanticHighlightingService.createNewFeature(this.semanticHighlightingService, client),
+            ...TypeHierarchyService.createNewFeatures(this.typeHierarchyService, client)
+        ]);
         return client;
     }
 

diff --git a/packages/languages/src/browser/semantic-highlighting/semantic-highlighting-feature.ts b/packages/languages/src/browser/semantic-highlighting/semantic-highlighting-feature.ts
@@ -24,7 +24,7 @@ import {
     ServerCapabilities,
     Disposable,
     DocumentSelector
-} from '../';
+} from '../index';
 import { SemanticHighlight, SemanticHighlightingParams } from './semantic-highlighting-protocol';
 
 // NOTE: This module can be removed, or at least can be simplified once the semantic highlighting will become the part of the LSP.

diff --git a/packages/languages/src/browser/semantic-highlighting/semantic-highlighting-protocol.ts b/packages/languages/src/browser/semantic-highlighting/semantic-highlighting-protocol.ts
@@ -14,8 +14,7 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { NotificationType } from 'vscode-jsonrpc';
-import { VersionedTextDocumentIdentifier } from '..';
+import { NotificationType, VersionedTextDocumentIdentifier } from '../index';
 
 // NOTE: This module can be removed, once the semantic highlighting will become the part of the LSP.
 // https://github.com/Microsoft/vscode-languageserver-node/issues/368