[vscode] fix #4203: support os specific keybindings

Signed-off-by: Anton Kosyakov <anton.kosyakov@typefox.io>
eclipse-theia · Jan 31, 2019 · 364621f · 364621f
1 parent 16b0159
commit 364621f
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 15 deletions.
diff --git a/packages/plugin-ext/src/common/plugin-protocol.ts b/packages/plugin-ext/src/common/plugin-protocol.ts
@@ -83,9 +83,12 @@ export interface PluginPackageMenu {
 }
 
 export interface PluginPackageKeybinding {
-    key: string;
+    key?: string;
     command: string;
     when?: string;
+    mac?: string;
+    linux?: string;
+    win?: string;
 }
 
 export interface PluginPackageGrammarsContribution {
@@ -462,9 +465,12 @@ export interface Menu {
  * Keybinding contribution
  */
 export interface Keybinding {
-    keybinding: string;
+    keybinding?: string;
     command: string;
     when?: string;
+    mac?: string;
+    linux?: string;
+    win?: string;
 }
 
 /**

diff --git a/packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts b/packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts
@@ -217,7 +217,10 @@ export class TheiaPluginScanner implements PluginScanner {
         return {
             keybinding: rawKeybinding.key,
             command: rawKeybinding.command,
-            when: rawKeybinding.when
+            when: rawKeybinding.when,
+            mac: rawKeybinding.mac,
+            linux: rawKeybinding.linux,
+            win: rawKeybinding.win
         };
     }
 

diff --git a/packages/plugin-ext/src/main/browser/keybindings/keybindings-contribution-handler.ts b/packages/plugin-ext/src/main/browser/keybindings/keybindings-contribution-handler.ts
@@ -15,10 +15,11 @@
  ********************************************************************************/
 
 import { injectable, inject } from 'inversify';
-import { PluginContribution } from '../../../common';
+import { PluginContribution, Keybinding as PluginKeybinding } from '../../../common';
 import { Keybinding, KeybindingRegistry, KeybindingScope } from '@theia/core/lib/browser/keybinding';
 import { KeySequence } from '@theia/core/lib/browser';
 import { ILogger } from '@theia/core/lib/common/logger';
+import { OS } from '@theia/core/lib/common/os';
 
 @injectable()
 export class KeybindingsContributionPointHandler {
@@ -33,19 +34,43 @@ export class KeybindingsContributionPointHandler {
         if (!contributions || !contributions.keybindings) {
             return;
         }
-
-        const keybindings = contributions.keybindings;
-        keybindings.forEach(keybinding => {
-            try {
-                const keybindingResult = this.keybindingRegistry.getKeybindingsForKeySequence(KeySequence.parse(keybinding.keybinding));
-                this.handleShadingKeybindings(keybinding, keybindingResult.shadow);
-                this.handlePartialKeybindings(keybinding, keybindingResult.partial);
-            } catch (e) {
-                this.logger.error(e.message || e);
+        const keybindings: Keybinding[] = [];
+        for (const raw of contributions.keybindings) {
+            const keybinding = this.toKeybinding(raw);
+            if (keybinding) {
+                try {
+                    const keybindingResult = this.keybindingRegistry.getKeybindingsForKeySequence(KeySequence.parse(keybinding.keybinding));
+                    this.handleShadingKeybindings(keybinding, keybindingResult.shadow);
+                    this.handlePartialKeybindings(keybinding, keybindingResult.partial);
+                    keybindings.push(keybinding);
+                } catch (e) {
+                    this.logger.error(e.message || e);
+                }
             }
-        });
+        }
+        this.keybindingRegistry.setKeymap(KeybindingScope.USER, keybindings);
+    }
 
-        this.keybindingRegistry.setKeymap(KeybindingScope.USER, contributions.keybindings);
+    protected toKeybinding(pluginKeybinding: PluginKeybinding): Keybinding | undefined {
+        const keybinding = this.toOSKeybinding(pluginKeybinding);
+        if (!keybinding) {
+            return undefined;
+        }
+        const { command, when } = pluginKeybinding;
+        return { keybinding, command, when };
+    }
+
+    protected toOSKeybinding(pluginKeybinding: PluginKeybinding): string | undefined {
+        let keybinding: string | undefined;
+        const os = OS.type();
+        if (os === OS.Type.Windows) {
+            keybinding = pluginKeybinding.win;
+        } else if (os === OS.Type.OSX) {
+            keybinding = pluginKeybinding.mac;
+        } else {
+            keybinding = pluginKeybinding.linux;
+        }
+        return keybinding || pluginKeybinding.keybinding;
     }
 
     private handlePartialKeybindings(keybinding: Keybinding, partialKeybindings: Keybinding[]) {