Add env.uiKind API

Signed-off-by: Thomas Mäder <tmader@redhat.com>
eclipse-theia · Jun 17, 2020 · 93b19e5 · 93b19e5
1 parent 0dce814
commit 93b19e5
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 1 deletion.
diff --git a/packages/plugin-ext/src/common/plugin-api-rpc.ts b/packages/plugin-ext/src/common/plugin-api-rpc.ts
@@ -98,10 +98,24 @@ export interface ConfigStorage {
     hostGlobalStoragePath: string;
 }
 
+export enum UIKind {
+
+    /**
+     * Extensions are accessed from a desktop application.
+     */
+    Desktop = 1,
+
+    /**
+     * Extensions are accessed from a web browser.
+     */
+    Web = 2
+}
+
 export interface EnvInit {
     queryParams: QueryParameters;
     language: string;
     shell: string;
+    uiKind: UIKind,
     appName: string;
 }
 

diff --git a/packages/plugin-ext/src/hosted/browser/hosted-plugin.ts b/packages/plugin-ext/src/hosted/browser/hosted-plugin.ts
@@ -27,7 +27,7 @@ import { injectable, inject, interfaces, named, postConstruct } from 'inversify'
 import { PluginWorker } from '../../main/browser/plugin-worker';
 import { PluginMetadata, getPluginId, HostedPluginServer, DeployedPlugin } from '../../common/plugin-protocol';
 import { HostedPluginWatcher } from './hosted-plugin-watcher';
-import { MAIN_RPC_CONTEXT, PluginManagerExt, ConfigStorage } from '../../common/plugin-api-rpc';
+import { MAIN_RPC_CONTEXT, PluginManagerExt, ConfigStorage, UIKind } from '../../common/plugin-api-rpc';
 import { setUpPluginApi } from '../../main/browser/main-context';
 import { RPCProtocol, RPCProtocolImpl } from '../../common/rpc-protocol';
 import {
@@ -60,6 +60,7 @@ import { TerminalService } from '@theia/terminal/lib/browser/base/terminal-servi
 import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
 import URI from '@theia/core/lib/common/uri';
 import { FrontendApplicationConfigProvider } from '@theia/core/lib/browser/frontend-application-config-provider';
+import { environment } from '@theia/application-package/lib/environment';
 
 export type PluginHost = 'frontend' | string;
 export type DebugActivationEvent = 'onDebugResolve' | 'onDebugInitialConfigurations' | 'onDebugAdapterProtocolTracker';
@@ -454,6 +455,7 @@ export class HostedPluginSupport {
                     queryParams: getQueryParameters(),
                     language: navigator.language,
                     shell: defaultShell,
+                    uiKind: environment.electron.is() ? UIKind.Desktop : UIKind.Web,
                     appName: FrontendApplicationConfigProvider.get().applicationName
                 },
                 extApi,

diff --git a/packages/plugin-ext/src/plugin/env.ts b/packages/plugin-ext/src/plugin/env.ts
@@ -26,6 +26,7 @@ export abstract class EnvExtImpl {
     private lang: string;
     private applicationName: string;
     private defaultShell: string;
+    private ui: theia.UIKind;
     private envMachineId: string;
     private envSessionId: string;
 
@@ -68,6 +69,10 @@ export abstract class EnvExtImpl {
         this.defaultShell = shell;
     }
 
+    setUIKind(uiKind: theia.UIKind): void {
+        this.ui = uiKind;
+    }
+
     getClientOperatingSystem(): Promise<theia.OperatingSystem> {
         return this.proxy.$getClientOperatingSystem();
     }
@@ -93,4 +98,7 @@ export abstract class EnvExtImpl {
     get shell(): string {
         return this.defaultShell;
     }
+    get uiKind(): theia.UIKind {
+        return this.ui;
+    }
 }
diff --git a/packages/plugin-ext/src/plugin/plugin-context.ts b/packages/plugin-ext/src/plugin/plugin-context.ts
@@ -111,6 +111,7 @@ import {
     ColorPresentation,
     OperatingSystem,
     WebviewPanelTargetArea,
+    UIKind,
     FileSystemError,
     CommentThreadCollapsibleState,
     QuickInputButtons,
@@ -510,6 +511,7 @@ export function createAPIFactory(
             get sessionId(): string { return envExt.sessionId; },
             get uriScheme(): string { return envExt.uriScheme; },
             get shell(): string { return envExt.shell; },
+            get uiKind(): theia.UIKind { return envExt.uiKind; },
             clipboard,
             getEnvVariable(envVarName: string): PromiseLike<string | undefined> {
                 return envExt.getEnvVariable(envVarName);
@@ -876,6 +878,7 @@ export function createAPIFactory(
             FoldingRangeKind,
             OperatingSystem,
             WebviewPanelTargetArea,
+            UIKind,
             FileSystemError,
             CommentThreadCollapsibleState,
             QuickInputButtons,

diff --git a/packages/plugin-ext/src/plugin/plugin-manager.ts b/packages/plugin-ext/src/plugin/plugin-manager.ts
@@ -186,6 +186,7 @@ export class PluginManagerExtImpl implements PluginManagerExt, PluginManager {
         this.envExt.setQueryParameters(params.env.queryParams);
         this.envExt.setLanguage(params.env.language);
         this.envExt.setShell(params.env.shell);
+        this.envExt.setUIKind(params.env.uiKind);
         this.envExt.setApplicationName(params.env.appName);
 
         this.preferencesManager.init(params.preferences);

diff --git a/packages/plugin-ext/src/plugin/types-impl.ts b/packages/plugin-ext/src/plugin/types-impl.ts
@@ -2050,6 +2050,23 @@ export enum WebviewPanelTargetArea {
     Right = 'right',
     Bottom = 'bottom'
 }
+
+/**
+ * Possible kinds of UI that can use extensions.
+ */
+export enum UIKind {
+
+    /**
+     * Extensions are accessed from a desktop application.
+     */
+    Desktop = 1,
+
+    /**
+     * Extensions are accessed from a web browser.
+     */
+    Web = 2
+}
+
 export class CallHierarchyItem {
     _sessionId?: string;
     _itemId?: string;

diff --git a/packages/plugin/src/theia.d.ts b/packages/plugin/src/theia.d.ts
@@ -3150,6 +3150,22 @@ declare module '@theia/plugin' {
         writeText(value: string): PromiseLike<void>;
     }
 
+    /**
+	 * Possible kinds of UI that can use extensions.
+	 */
+    export enum UIKind {
+
+		/**
+		 * Extensions are accessed from a desktop application.
+		 */
+        Desktop = 1,
+
+		/**
+		 * Extensions are accessed from a web browser.
+		 */
+        Web = 2
+    }
+
     /**
      * A uri handler is responsible for handling system-wide [uris](#Uri).
      *
@@ -5295,6 +5311,13 @@ declare module '@theia/plugin' {
          */
         export const shell: string;
 
+		/**
+		 * The UI kind property indicates from which UI extensions
+		 * are accessed from. For example, extensions could be accessed
+		 * from a desktop application or a web browser.
+		 */
+        export const uiKind: UIKind;
+
         /**
          * The system clipboard.
          */