@theia/keymaps 1.34.3 → 1.34.4

package/src/browser/keymaps-service.ts

@@ -1,210 +1,210 @@
-// *****************************************************************************
-// Copyright (C) 2017 Ericsson and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
-import { OpenerService, open, WidgetOpenerOptions, Widget } from '@theia/core/lib/browser';
-import { KeybindingRegistry, KeybindingScope, ScopedKeybinding } from '@theia/core/lib/browser/keybinding';
-import { Keybinding, RawKeybinding } from '@theia/core/lib/common/keybinding';
-import { UserStorageUri } from '@theia/userstorage/lib/browser';
-import * as jsoncparser from 'jsonc-parser';
-import { Emitter } from '@theia/core/lib/common/event';
-import { MonacoTextModelService } from '@theia/monaco/lib/browser/monaco-text-model-service';
-import { MonacoEditorModel } from '@theia/monaco/lib/browser/monaco-editor-model';
-import { Deferred } from '@theia/core/lib/common/promise-util';
-import URI from '@theia/core/lib/common/uri';
-import { MonacoWorkspace } from '@theia/monaco/lib/browser/monaco-workspace';
-import { MessageService } from '@theia/core/lib/common/message-service';
-import { MonacoJSONCEditor } from '@theia/preferences/lib/browser/monaco-jsonc-editor';
-
-@injectable()
-export class KeymapsService {
-
-    @inject(MonacoWorkspace)
-    protected readonly workspace: MonacoWorkspace;
-
-    @inject(MonacoTextModelService)
-    protected readonly textModelService: MonacoTextModelService;
-
-    @inject(KeybindingRegistry)
-    protected readonly keybindingRegistry: KeybindingRegistry;
-
-    @inject(OpenerService)
-    protected readonly opener: OpenerService;
-
-    @inject(MessageService)
-    protected readonly messageService: MessageService;
-
-    @inject(MonacoJSONCEditor)
-    protected readonly jsoncEditor: MonacoJSONCEditor;
-
-    protected readonly changeKeymapEmitter = new Emitter<void>();
-    readonly onDidChangeKeymaps = this.changeKeymapEmitter.event;
-
-    protected model: MonacoEditorModel | undefined;
-    protected readonly deferredModel = new Deferred<MonacoEditorModel>();
-
-    /**
-     * Initialize the keybinding service.
-     */
-    @postConstruct()
-    protected async init(): Promise<void> {
-        const reference = await this.textModelService.createModelReference(UserStorageUri.resolve('keymaps.json'));
-        this.model = reference.object;
-        this.deferredModel.resolve(this.model);
-
-        this.reconcile();
-        this.model.onDidChangeContent(() => this.reconcile());
-        this.model.onDirtyChanged(() => this.reconcile());
-        this.model.onDidChangeValid(() => this.reconcile());
-        this.keybindingRegistry.onKeybindingsChanged(() => this.changeKeymapEmitter.fire(undefined));
-    }
-
-    /**
-     * Reconcile all the keybindings, registering them to the registry.
-     */
-    protected reconcile(): void {
-        const model = this.model;
-        if (!model || model.dirty) {
-            return;
-        }
-        try {
-            const keybindings: Keybinding[] = [];
-            if (model.valid) {
-                const content = model.getText();
-                const json = jsoncparser.parse(content, undefined, { disallowComments: false });
-                if (Array.isArray(json)) {
-                    for (const value of json) {
-                        if (Keybinding.is(value)) {
-                            keybindings.push(value);
-                        } else if (RawKeybinding.is(value)) {
-                            keybindings.push(Keybinding.apiObjectify(value));
-                        }
-                    }
-                }
-            }
-            this.keybindingRegistry.setKeymap(KeybindingScope.USER, keybindings);
-        } catch (e) {
-            console.error(`Failed to load keymaps from '${model.uri}'.`, e);
-        }
-    }
-
-    /**
-     * Open the keybindings widget.
-     * @param ref the optional reference for opening the widget.
-     */
-    async open(ref?: Widget): Promise<void> {
-        const model = await this.deferredModel.promise;
-        const options: WidgetOpenerOptions = {
-            widgetOptions: ref ? { area: 'main', mode: 'split-right', ref } : { area: 'main' },
-            mode: 'activate'
-        };
-        if (!model.valid) {
-            await model.save();
-        }
-        await open(this.opener, new URI(model.uri), options);
-    }
-
-    /**
-     * Set the keybinding in the JSON.
-     * @param newKeybinding the new JSON keybinding
-     * @param oldKeybinding the old JSON keybinding
-     */
-    async setKeybinding(newKeybinding: Keybinding, oldKeybinding: ScopedKeybinding | undefined): Promise<void> {
-        return this.updateKeymap(() => {
-            let newAdded = false;
-            let isOldKeybindingDisabled = false;
-            let addedDisabledEntry = false;
-            const keybindings = [];
-            for (let keybinding of this.keybindingRegistry.getKeybindingsByScope(KeybindingScope.USER)) {
-                // search for the old keybinding and modify it
-                if (oldKeybinding && Keybinding.equals(keybinding, oldKeybinding, false, true)) {
-                    newAdded = true;
-                    keybinding = {
-                        ...keybinding,
-                        keybinding: newKeybinding.keybinding
-                    };
-                }
-
-                // we have an disabled entry for the same command and the oldKeybinding
-                if (oldKeybinding?.keybinding &&
-                    Keybinding.equals(keybinding, { ...newKeybinding, keybinding: oldKeybinding.keybinding, command: '-' + newKeybinding.command }, false, true)) {
-                    isOldKeybindingDisabled = true;
-                }
-                keybindings.push(keybinding);
-            }
-            if (!newAdded) {
-                keybindings.push({
-                    command: newKeybinding.command,
-                    keybinding: newKeybinding.keybinding,
-                    context: newKeybinding.context,
-                    when: newKeybinding.when,
-                    args: newKeybinding.args
-                });
-                newAdded = true;
-            }
-            // we want to add a disabled entry for the old keybinding only when we are modifying the default value
-            if (!isOldKeybindingDisabled && oldKeybinding?.scope === KeybindingScope.DEFAULT) {
-                const disabledBinding = {
-                    command: '-' + newKeybinding.command,
-                    // TODO key: oldKeybinding, see https://github.com/eclipse-theia/theia/issues/6879
-                    keybinding: oldKeybinding.keybinding,
-                    context: newKeybinding.context,
-                    when: newKeybinding.when,
-                    args: newKeybinding.args
-                };
-                // Add disablement of the old keybinding if it isn't already disabled in the list to avoid duplicate disabled entries
-                if (!keybindings.some(binding => Keybinding.equals(binding, disabledBinding, false, true))) {
-                    keybindings.push(disabledBinding);
-                }
-                isOldKeybindingDisabled = true;
-                addedDisabledEntry = true;
-            }
-            if (newAdded || addedDisabledEntry) {
-                return keybindings;
-            }
-        });
-    }
-
-    /**
-     * Remove the given keybinding with the given command id from the JSON.
-     * @param commandId the keybinding command id.
-     */
-    removeKeybinding(commandId: string): Promise<void> {
-        return this.updateKeymap(() => {
-            const keybindings = this.keybindingRegistry.getKeybindingsByScope(KeybindingScope.USER);
-            const removedCommand = '-' + commandId;
-            const filtered = keybindings.filter(a => a.command !== commandId && a.command !== removedCommand);
-            if (filtered.length !== keybindings.length) {
-                return filtered;
-            }
-        });
-    }
-
-    protected async updateKeymap(op: () => Keybinding[] | void): Promise<void> {
-        const model = await this.deferredModel.promise;
-        try {
-            const keybindings = op();
-            if (keybindings && this.model) {
-                await this.jsoncEditor.setValue(this.model, [], keybindings.map(binding => Keybinding.apiObjectify(binding)));
-            }
-        } catch (e) {
-            const message = `Failed to update a keymap in '${model.uri}'.`;
-            this.messageService.error(`${message} Please check if it is corrupted.`);
-            console.error(`${message}`, e);
-        }
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2017 Ericsson and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { inject, injectable, postConstruct } from '@theia/core/shared/inversify';
+import { OpenerService, open, WidgetOpenerOptions, Widget } from '@theia/core/lib/browser';
+import { KeybindingRegistry, KeybindingScope, ScopedKeybinding } from '@theia/core/lib/browser/keybinding';
+import { Keybinding, RawKeybinding } from '@theia/core/lib/common/keybinding';
+import { UserStorageUri } from '@theia/userstorage/lib/browser';
+import * as jsoncparser from 'jsonc-parser';
+import { Emitter } from '@theia/core/lib/common/event';
+import { MonacoTextModelService } from '@theia/monaco/lib/browser/monaco-text-model-service';
+import { MonacoEditorModel } from '@theia/monaco/lib/browser/monaco-editor-model';
+import { Deferred } from '@theia/core/lib/common/promise-util';
+import URI from '@theia/core/lib/common/uri';
+import { MonacoWorkspace } from '@theia/monaco/lib/browser/monaco-workspace';
+import { MessageService } from '@theia/core/lib/common/message-service';
+import { MonacoJSONCEditor } from '@theia/preferences/lib/browser/monaco-jsonc-editor';
+
+@injectable()
+export class KeymapsService {
+
+    @inject(MonacoWorkspace)
+    protected readonly workspace: MonacoWorkspace;
+
+    @inject(MonacoTextModelService)
+    protected readonly textModelService: MonacoTextModelService;
+
+    @inject(KeybindingRegistry)
+    protected readonly keybindingRegistry: KeybindingRegistry;
+
+    @inject(OpenerService)
+    protected readonly opener: OpenerService;
+
+    @inject(MessageService)
+    protected readonly messageService: MessageService;
+
+    @inject(MonacoJSONCEditor)
+    protected readonly jsoncEditor: MonacoJSONCEditor;
+
+    protected readonly changeKeymapEmitter = new Emitter<void>();
+    readonly onDidChangeKeymaps = this.changeKeymapEmitter.event;
+
+    protected model: MonacoEditorModel | undefined;
+    protected readonly deferredModel = new Deferred<MonacoEditorModel>();
+
+    /**
+     * Initialize the keybinding service.
+     */
+    @postConstruct()
+    protected async init(): Promise<void> {
+        const reference = await this.textModelService.createModelReference(UserStorageUri.resolve('keymaps.json'));
+        this.model = reference.object;
+        this.deferredModel.resolve(this.model);
+
+        this.reconcile();
+        this.model.onDidChangeContent(() => this.reconcile());
+        this.model.onDirtyChanged(() => this.reconcile());
+        this.model.onDidChangeValid(() => this.reconcile());
+        this.keybindingRegistry.onKeybindingsChanged(() => this.changeKeymapEmitter.fire(undefined));
+    }
+
+    /**
+     * Reconcile all the keybindings, registering them to the registry.
+     */
+    protected reconcile(): void {
+        const model = this.model;
+        if (!model || model.dirty) {
+            return;
+        }
+        try {
+            const keybindings: Keybinding[] = [];
+            if (model.valid) {
+                const content = model.getText();
+                const json = jsoncparser.parse(content, undefined, { disallowComments: false });
+                if (Array.isArray(json)) {
+                    for (const value of json) {
+                        if (Keybinding.is(value)) {
+                            keybindings.push(value);
+                        } else if (RawKeybinding.is(value)) {
+                            keybindings.push(Keybinding.apiObjectify(value));
+                        }
+                    }
+                }
+            }
+            this.keybindingRegistry.setKeymap(KeybindingScope.USER, keybindings);
+        } catch (e) {
+            console.error(`Failed to load keymaps from '${model.uri}'.`, e);
+        }
+    }
+
+    /**
+     * Open the keybindings widget.
+     * @param ref the optional reference for opening the widget.
+     */
+    async open(ref?: Widget): Promise<void> {
+        const model = await this.deferredModel.promise;
+        const options: WidgetOpenerOptions = {
+            widgetOptions: ref ? { area: 'main', mode: 'split-right', ref } : { area: 'main' },
+            mode: 'activate'
+        };
+        if (!model.valid) {
+            await model.save();
+        }
+        await open(this.opener, new URI(model.uri), options);
+    }
+
+    /**
+     * Set the keybinding in the JSON.
+     * @param newKeybinding the new JSON keybinding
+     * @param oldKeybinding the old JSON keybinding
+     */
+    async setKeybinding(newKeybinding: Keybinding, oldKeybinding: ScopedKeybinding | undefined): Promise<void> {
+        return this.updateKeymap(() => {
+            let newAdded = false;
+            let isOldKeybindingDisabled = false;
+            let addedDisabledEntry = false;
+            const keybindings = [];
+            for (let keybinding of this.keybindingRegistry.getKeybindingsByScope(KeybindingScope.USER)) {
+                // search for the old keybinding and modify it
+                if (oldKeybinding && Keybinding.equals(keybinding, oldKeybinding, false, true)) {
+                    newAdded = true;
+                    keybinding = {
+                        ...keybinding,
+                        keybinding: newKeybinding.keybinding
+                    };
+                }
+
+                // we have an disabled entry for the same command and the oldKeybinding
+                if (oldKeybinding?.keybinding &&
+                    Keybinding.equals(keybinding, { ...newKeybinding, keybinding: oldKeybinding.keybinding, command: '-' + newKeybinding.command }, false, true)) {
+                    isOldKeybindingDisabled = true;
+                }
+                keybindings.push(keybinding);
+            }
+            if (!newAdded) {
+                keybindings.push({
+                    command: newKeybinding.command,
+                    keybinding: newKeybinding.keybinding,
+                    context: newKeybinding.context,
+                    when: newKeybinding.when,
+                    args: newKeybinding.args
+                });
+                newAdded = true;
+            }
+            // we want to add a disabled entry for the old keybinding only when we are modifying the default value
+            if (!isOldKeybindingDisabled && oldKeybinding?.scope === KeybindingScope.DEFAULT) {
+                const disabledBinding = {
+                    command: '-' + newKeybinding.command,
+                    // TODO key: oldKeybinding, see https://github.com/eclipse-theia/theia/issues/6879
+                    keybinding: oldKeybinding.keybinding,
+                    context: newKeybinding.context,
+                    when: newKeybinding.when,
+                    args: newKeybinding.args
+                };
+                // Add disablement of the old keybinding if it isn't already disabled in the list to avoid duplicate disabled entries
+                if (!keybindings.some(binding => Keybinding.equals(binding, disabledBinding, false, true))) {
+                    keybindings.push(disabledBinding);
+                }
+                isOldKeybindingDisabled = true;
+                addedDisabledEntry = true;
+            }
+            if (newAdded || addedDisabledEntry) {
+                return keybindings;
+            }
+        });
+    }
+
+    /**
+     * Remove the given keybinding with the given command id from the JSON.
+     * @param commandId the keybinding command id.
+     */
+    removeKeybinding(commandId: string): Promise<void> {
+        return this.updateKeymap(() => {
+            const keybindings = this.keybindingRegistry.getKeybindingsByScope(KeybindingScope.USER);
+            const removedCommand = '-' + commandId;
+            const filtered = keybindings.filter(a => a.command !== commandId && a.command !== removedCommand);
+            if (filtered.length !== keybindings.length) {
+                return filtered;
+            }
+        });
+    }
+
+    protected async updateKeymap(op: () => Keybinding[] | void): Promise<void> {
+        const model = await this.deferredModel.promise;
+        try {
+            const keybindings = op();
+            if (keybindings && this.model) {
+                await this.jsoncEditor.setValue(this.model, [], keybindings.map(binding => Keybinding.apiObjectify(binding)));
+            }
+        } catch (e) {
+            const message = `Failed to update a keymap in '${model.uri}'.`;
+            this.messageService.error(`${message} Please check if it is corrupted.`);
+            console.error(`${message}`, e);
+        }
+    }
+
+}