Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

minor cleanups in keybindings #178416

Merged
merged 5 commits into from Mar 27, 2023
Merged

minor cleanups in keybindings #178416

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fcc9a0f
keybindingService: fix depr warning
ulugbekna Mar 24, 2023
91261a8
keybindingService: organize imports
ulugbekna Mar 24, 2023
3f24070
keybindingService: remove unused fn
ulugbekna Mar 24, 2023
76d3224
keybindingService: more clear naming
ulugbekna Mar 24, 2023
54d01c4
keybindingService: fix typo in naming
ulugbekna Mar 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
81 changes: 41 additions & 40 deletions src/vs/workbench/services/keybinding/browser/keybindingService.ts
View file
Open in desktop
Expand Up @@ -4,48 +4,53 @@
*--------------------------------------------------------------------------------------------*/

import * as nls from 'vs/nls';

// base
import * as browser from 'vs/base/browser/browser';
import { BrowserFeatures, KeyboardSupport } from 'vs/base/browser/canIUse';
import * as dom from 'vs/base/browser/dom';
import { printKeyboardEvent, printStandardKeyboardEvent, StandardKeyboardEvent } from 'vs/base/browser/keyboardEvent';
import { RunOnceScheduler } from 'vs/base/common/async';
import { Emitter, Event } from 'vs/base/common/event';
import { parse } from 'vs/base/common/json';
import { IJSONSchema } from 'vs/base/common/jsonSchema';
import { KeyCode, KeyMod, ScanCode, ScanCodeUtils, IMMUTABLE_CODE_TO_KEY_CODE, KeyCodeUtils } from 'vs/base/common/keyCodes';
import { ResolvedKeybinding, KeyCodeChord, ScanCodeChord, Keybinding } from 'vs/base/common/keybindings';
import { UserSettingsLabelProvider } from 'vs/base/common/keybindingLabels';
import { KeybindingParser } from 'vs/base/common/keybindingParser';
import { OS, OperatingSystem, isMacintosh } from 'vs/base/common/platform';
import { ICommandService, CommandsRegistry } from 'vs/platform/commands/common/commands';
import { ContextKeyExpr, IContextKeyService, ContextKeyExpression, IContextKey } from 'vs/platform/contextkey/common/contextkey';
import { Keybinding, KeyCodeChord, ResolvedKeybinding, ScanCodeChord } from 'vs/base/common/keybindings';
import { IMMUTABLE_CODE_TO_KEY_CODE, KeyCode, KeyCodeUtils, KeyMod, ScanCode, ScanCodeUtils } from 'vs/base/common/keyCodes';
import { Disposable, DisposableStore } from 'vs/base/common/lifecycle';
import * as objects from 'vs/base/common/objects';
import { isMacintosh, OperatingSystem, OS } from 'vs/base/common/platform';
import { dirname } from 'vs/base/common/resources';

// platform
import { MenuRegistry } from 'vs/platform/actions/common/actions';
import { CommandsRegistry, ICommandService } from 'vs/platform/commands/common/commands';
import { ContextKeyExpr, ContextKeyExpression, IContextKey, IContextKeyService } from 'vs/platform/contextkey/common/contextkey';
import { ExtensionIdentifier } from 'vs/platform/extensions/common/extensions';
import { FileOperation, IFileService } from 'vs/platform/files/common/files';
import { InstantiationType, registerSingleton } from 'vs/platform/instantiation/common/extensions';
import { Extensions, IJSONContributionRegistry } from 'vs/platform/jsonschemas/common/jsonContributionRegistry';
import { AbstractKeybindingService } from 'vs/platform/keybinding/common/abstractKeybindingService';
import { IKeyboardEvent, IKeybindingService, KeybindingsSchemaContribution } from 'vs/platform/keybinding/common/keybinding';
import { IKeybindingService, IKeyboardEvent, KeybindingsSchemaContribution } from 'vs/platform/keybinding/common/keybinding';
import { KeybindingResolver } from 'vs/platform/keybinding/common/keybindingResolver';
import { IKeybindingItem, IExtensionKeybindingRule, KeybindingWeight, KeybindingsRegistry } from 'vs/platform/keybinding/common/keybindingsRegistry';
import { IExtensionKeybindingRule, IKeybindingItem, KeybindingsRegistry, KeybindingWeight } from 'vs/platform/keybinding/common/keybindingsRegistry';
import { ResolvedKeybindingItem } from 'vs/platform/keybinding/common/resolvedKeybindingItem';
import { IKeyboardLayoutService } from 'vs/platform/keyboardLayout/common/keyboardLayout';
import { IKeyboardMapper } from 'vs/platform/keyboardLayout/common/keyboardMapper';
import { ILogService } from 'vs/platform/log/common/log';
import { INotificationService } from 'vs/platform/notification/common/notification';
import { Registry } from 'vs/platform/registry/common/platform';
import { ITelemetryService } from 'vs/platform/telemetry/common/telemetry';

// workbench
import { commandsExtensionPoint } from 'vs/workbench/services/actions/common/menusExtensionPoint';
import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions';
import { ExtensionMessageCollector, ExtensionsRegistry } from 'vs/workbench/services/extensions/common/extensionsRegistry';
import { IUserKeybindingItem, KeybindingIO, OutputBuilder } from 'vs/workbench/services/keybinding/common/keybindingIO';
import { IKeyboardMapper } from 'vs/platform/keyboardLayout/common/keyboardMapper';
import { IHostService } from 'vs/workbench/services/host/browser/host';
import { IExtensionService } from 'vs/workbench/services/extensions/common/extensions';
import { MenuRegistry } from 'vs/platform/actions/common/actions';
import { InstantiationType, registerSingleton } from 'vs/platform/instantiation/common/extensions';
import { commandsExtensionPoint } from 'vs/workbench/services/actions/common/menusExtensionPoint';
import { Disposable, DisposableStore } from 'vs/base/common/lifecycle';
import { RunOnceScheduler } from 'vs/base/common/async';
import { FileOperation, IFileService } from 'vs/platform/files/common/files';
import { parse } from 'vs/base/common/json';
import * as objects from 'vs/base/common/objects';
import { IKeyboardLayoutService } from 'vs/platform/keyboardLayout/common/keyboardLayout';
import { INavigatorWithKeyboard, IKeyboard } from 'vs/workbench/services/keybinding/browser/navigatorKeyboard';
import { flatten } from 'vs/base/common/arrays';
import { BrowserFeatures, KeyboardSupport } from 'vs/base/browser/canIUse';
import { ILogService } from 'vs/platform/log/common/log';
import { ExtensionIdentifier } from 'vs/platform/extensions/common/extensions';
import { dirname } from 'vs/base/common/resources';
import { IKeyboard, INavigatorWithKeyboard } from 'vs/workbench/services/keybinding/browser/navigatorKeyboard';
import { getAllUnboundCommands } from 'vs/workbench/services/keybinding/browser/unboundCommands';
import { UserSettingsLabelProvider } from 'vs/base/common/keybindingLabels';
import { IUserKeybindingItem, KeybindingIO, OutputBuilder } from 'vs/workbench/services/keybinding/common/keybindingIO';
import { DidChangeUserDataProfileEvent, IUserDataProfileService } from 'vs/workbench/services/userDataProfile/common/userDataProfile';

interface ContributedKeyBinding {
Expand All @@ -58,10 +63,6 @@ interface ContributedKeyBinding {
win?: string;
}

function isContributedKeyBindingsArray(thing: ContributedKeyBinding | ContributedKeyBinding[]): thing is ContributedKeyBinding[] {
return Array.isArray(thing);
}

function isValidContributedKeyBinding(keyBinding: ContributedKeyBinding, rejects: string[]): boolean {
if (!keyBinding) {
rejects.push(nls.localize('nonempty', "expected non-empty value."));
Expand Down Expand Up @@ -196,7 +197,7 @@ export class WorkbenchKeybindingService extends AbstractKeybindingService {
super(contextKeyService, commandService, telemetryService, notificationService, logService);

this.isComposingGlobalContextKey = contextKeyService.createKey('isComposing', false);
this.updateSchema();
this.updateKeybindingsJsonSchema();

this._keyboardMapper = this.keyboardLayoutService.getKeyboardMapper();
this.keyboardLayoutService.onDidChangeKeyboardLayout(() => {
Expand Down Expand Up @@ -228,8 +229,8 @@ export class WorkbenchKeybindingService extends AbstractKeybindingService {
this.updateResolver();
});

this.updateSchema();
this._register(extensionService.onDidRegisterExtensions(() => this.updateSchema()));
this.updateKeybindingsJsonSchema();
this._register(extensionService.onDidRegisterExtensions(() => this.updateKeybindingsJsonSchema()));

// for standard keybindings
this._register(dom.addDisposableListener(window, dom.EventType.KEY_DOWN, (e: KeyboardEvent) => {
Expand Down Expand Up @@ -277,13 +278,13 @@ export class WorkbenchKeybindingService extends AbstractKeybindingService {
public registerSchemaContribution(contribution: KeybindingsSchemaContribution): void {
this._contributions.push(contribution);
if (contribution.onDidChange) {
this._register(contribution.onDidChange(() => this.updateSchema()));
this._register(contribution.onDidChange(() => this.updateKeybindingsJsonSchema()));
}
this.updateSchema();
this.updateKeybindingsJsonSchema();
}

private updateSchema() {
updateSchema(flatten(this._contributions.map(x => x.getSchemaAdditions())));
private updateKeybindingsJsonSchema() {
updateSchema(this._contributions.flatMap(x => x.getSchemaAdditions()));
}

private _printKeybinding(keybinding: Keybinding): string {
Expand Down Expand Up @@ -514,7 +515,7 @@ export class WorkbenchKeybindingService extends AbstractKeybindingService {
}

private _handleKeybindingsExtensionPointUser(extensionId: ExtensionIdentifier, isBuiltin: boolean, keybindings: ContributedKeyBinding | ContributedKeyBinding[], collector: ExtensionMessageCollector, result: IExtensionKeybindingRule[]): void {
if (isContributedKeyBindingsArray(keybindings)) {
if (Array.isArray(keybindings)) {
for (let i = 0, len = keybindings.length; i < len; i++) {
this._handleKeybinding(extensionId, isBuiltin, i + 1, keybindings[i], collector, result);
}
Expand Down Expand Up @@ -720,10 +721,10 @@ class UserKeybindings extends Disposable {
}
}));

this._register(userDataProfileService.onDidChangeCurrentProfile(e => e.join(this.whenCurrentProfieChanged(e))));
this._register(userDataProfileService.onDidChangeCurrentProfile(e => e.join(this.whenCurrentProfileChanged(e))));
}

private async whenCurrentProfieChanged(e: DidChangeUserDataProfileEvent): Promise<void> {
private async whenCurrentProfileChanged(e: DidChangeUserDataProfileEvent): Promise<void> {
if (e.preserveData) {
if (await this.fileService.exists(e.previous.keybindingsResource)) {
await this.fileService.copy(e.previous.keybindingsResource, e.profile.keybindingsResource);
Expand Down