Fixes #21780: Add keyboard.dispatch setting

src/vs/workbench/services/keybinding/common/macLinuxFallbackKeyboardMapper.ts

@@ -38,7 +38,7 @@ export class MacLinuxFallbackKeyboardMapper implements IKeyboardMapper {
 	 */
 	private readonly _OS: OperatingSystem;
 
-	constructor(rawMappings: IMacLinuxKeyboardMapping, OS: OperatingSystem) {
+	constructor(OS: OperatingSystem) {
 		this._OS = OS;
 	}
 

src/vs/workbench/services/keybinding/electron-browser/keybindingService.ts

@@ -38,6 +38,8 @@ import { IStorageService, StorageScope } from 'vs/platform/storage/common/storag
 import { Action } from 'vs/base/common/actions';
 import { TPromise } from 'vs/base/common/winjs.base';
 import Severity from 'vs/base/common/severity';
+import { Extensions as ConfigExtensions, IConfigurationRegistry, IConfigurationNode } from 'vs/platform/configuration/common/configurationRegistry';
+import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 
 export class KeyboardMapperFactory {
 	public static INSTANCE = new KeyboardMapperFactory();
@@ -63,10 +65,14 @@ export class KeyboardMapperFactory {
 		}
 	}
 
-	public getKeyboardMapper(): IKeyboardMapper {
+	public getKeyboardMapper(dispatchConfig: DispatchConfig): IKeyboardMapper {
 		if (!this._initialized) {
 			this._setKeyboardData(nativeKeymap.getCurrentKeyboardLayout(), nativeKeymap.getKeyMap());
 		}
+		if (dispatchConfig === DispatchConfig.KeyCode) {
+			// Forcefully set to use keyCode
+			return new MacLinuxFallbackKeyboardMapper(OS);
+		}
 		return this._keyboardMapper;
 	}
 
@@ -127,7 +133,7 @@ export class KeyboardMapperFactory {
 
 		if (Object.keys(rawMapping).length === 0) {
 			// Looks like reading the mappings failed (most likely Mac + Japanese/Chinese keyboard layouts)
-			return new MacLinuxFallbackKeyboardMapper(<IMacLinuxKeyboardMapping>rawMapping, OS);
+			return new MacLinuxFallbackKeyboardMapper(OS);
 		}
 
 		return new MacLinuxKeyboardMapper(<IMacLinuxKeyboardMapping>rawMapping, OS);
@@ -266,6 +272,17 @@ class KeybindingsMigrationsStorage {
 	}
 }
 
+export const enum DispatchConfig {
+	Code,
+	KeyCode
+}
+
+function getDispatchConfig(configurationService: IConfigurationService): DispatchConfig {
+	const keyboard = configurationService.getConfiguration('keyboard');
+	const r = (keyboard ? (<any>keyboard).dispatch : null);
+	return (r === 'keyCode' ? DispatchConfig.KeyCode : DispatchConfig.Code);
+}
+
 export class WorkbenchKeybindingService extends AbstractKeybindingService {
 
 	private _keyboardMapper: IKeyboardMapper;
@@ -281,15 +298,29 @@ export class WorkbenchKeybindingService extends AbstractKeybindingService {
 		@IMessageService private messageService: IMessageService,
 		@IEnvironmentService environmentService: IEnvironmentService,
 		@IStorageService private storageService: IStorageService,
-		@IStatusbarService statusBarService: IStatusbarService
+		@IStatusbarService statusBarService: IStatusbarService,
+		@IConfigurationService private configurationService: IConfigurationService
 	) {
 		super(contextKeyService, commandService, messageService, statusBarService);
 
-		this._keyboardMapper = KeyboardMapperFactory.INSTANCE.getKeyboardMapper();
+		let dispatchConfig = getDispatchConfig(configurationService);
+		configurationService.onDidUpdateConfiguration((e) => {
+			let newDispatchConfig = getDispatchConfig(configurationService);
+			if (dispatchConfig === newDispatchConfig) {
+				return;
+			}
+
+			dispatchConfig = newDispatchConfig;
+			this._keyboardMapper = KeyboardMapperFactory.INSTANCE.getKeyboardMapper(dispatchConfig);
+			this.updateResolver({ source: KeybindingSource.Default });
+		});
+
+		this._keyboardMapper = KeyboardMapperFactory.INSTANCE.getKeyboardMapper(dispatchConfig);
 		KeyboardMapperFactory.INSTANCE.onDidChangeKeyboardMapper(() => {
-			this._keyboardMapper = KeyboardMapperFactory.INSTANCE.getKeyboardMapper();
+			this._keyboardMapper = KeyboardMapperFactory.INSTANCE.getKeyboardMapper(dispatchConfig);
 			this.updateResolver({ source: KeybindingSource.Default });
 		});
+
 		this._cachedResolver = null;
 		this._firstTimeComputingResolver = true;
 
@@ -597,3 +628,26 @@ let schema: IJSONSchema = {
 
 let schemaRegistry = <IJSONContributionRegistry>Registry.as(Extensions.JSONContribution);
 schemaRegistry.registerSchema(schemaId, schema);
+
+if (OS === OperatingSystem.Macintosh || OS === OperatingSystem.Linux) {
+
+	const configurationRegistry = <IConfigurationRegistry>Registry.as(ConfigExtensions.Configuration);
+	const keyboardConfiguration: IConfigurationNode = {
+		'id': 'keyboard',
+		'order': 15,
+		'type': 'object',
+		'title': nls.localize('keyboardConfigurationTitle', "Keyboard"),
+		'overridable': true,
+		'properties': {
+			'keyboard.dispatch': {
+				'type': 'string',
+				'enum': ['code', 'keyCode'],
+				'default': 'code',
+				'description': nls.localize('dispatch', "Controls the dispatching logic for key presses to use either `keydown.code` (recommended) or `keydown.keyCode`.")
+			}
+		}
+	};
+
+	configurationRegistry.registerConfiguration(keyboardConfiguration);
+
+}

src/vs/workbench/services/keybinding/test/macLinuxFallbackKeyboardMapper.test.ts

@@ -14,7 +14,7 @@ import { ScanCodeBinding, ScanCode } from 'vs/workbench/services/keybinding/comm
 
 suite('keyboardMapper - MAC fallback', () => {
 
-	let mapper = new MacLinuxFallbackKeyboardMapper({}, OperatingSystem.Macintosh);
+	let mapper = new MacLinuxFallbackKeyboardMapper(OperatingSystem.Macintosh);
 
 	function _assertResolveKeybinding(k: number, expected: IResolvedKeybinding[]): void {
 		assertResolveKeybinding(mapper, createKeybinding(k, OperatingSystem.Macintosh), expected);
@@ -149,7 +149,7 @@ suite('keyboardMapper - MAC fallback', () => {
 
 suite('keyboardMapper - LINUX fallback', () => {
 
-	let mapper = new MacLinuxFallbackKeyboardMapper({}, OperatingSystem.Linux);
+	let mapper = new MacLinuxFallbackKeyboardMapper(OperatingSystem.Linux);
 
 	function _assertResolveKeybinding(k: number, expected: IResolvedKeybinding[]): void {
 		assertResolveKeybinding(mapper, createKeybinding(k, OperatingSystem.Linux), expected);