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

feat: creates a new way to add shortcut key mappings #6122

Merged
merged 5 commits into from
May 13, 2022
Merged

feat: creates a new way to add shortcut key mappings #6122

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fb40e4f
feat: creates a new way to add shortcut key mappings
alschmiedt Apr 27, 2022
3d8ea27
feat: adds ability to set allowCollisions to true
alschmiedt Apr 28, 2022
76738fc
chore: format
alschmiedt Apr 28, 2022
2d70092
chore: fix types and add chunks.json
alschmiedt Apr 28, 2022
e8d4ea7
Merge branch 'develop' of https://github.com/google/blockly into upda…
alschmiedt May 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 45 additions & 69 deletions core/shortcut_items.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ const registerEscape = function() {
workspace.hideChaff();
return true;
},
keyCodes: [KeyCodes.ESC],
};
ShortcutRegistry.registry.register(escapeAction);
ShortcutRegistry.registry.addKeyMapping(KeyCodes.ESC, escapeAction.name);
};
exports.registerEscape = registerEscape;

Expand Down Expand Up @@ -88,11 +88,9 @@ const registerDelete = function() {
(/** @type {!BlockSvg} */ (common.getSelected())).checkAndDelete();
return true;
},
keyCodes: [KeyCodes.DELETE, KeyCodes.BACKSPACE],
};
ShortcutRegistry.registry.register(deleteShortcut);
ShortcutRegistry.registry.addKeyMapping(KeyCodes.DELETE, deleteShortcut.name);
ShortcutRegistry.registry.addKeyMapping(
KeyCodes.BACKSPACE, deleteShortcut.name);
};
exports.registerDelete = registerDelete;

Expand All @@ -101,6 +99,13 @@ exports.registerDelete = registerDelete;
* @alias Blockly.ShortcutItems.registerCopy
*/
const registerCopy = function() {
const ctrlC = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.C, [KeyCodes.CTRL]);
const altC =
ShortcutRegistry.registry.createSerializedKey(KeyCodes.C, [KeyCodes.ALT]);
const metaC = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.C, [KeyCodes.META]);

/** @type {!ShortcutRegistry.KeyboardShortcut} */
const copyShortcut = {
name: names.COPY,
Expand All @@ -117,20 +122,9 @@ const registerCopy = function() {
clipboard.copy(/** @type {!ICopyable} */ (common.getSelected()));
return true;
},
keyCodes: [ctrlC, altC, metaC],
};
ShortcutRegistry.registry.register(copyShortcut);

const ctrlC = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.C, [KeyCodes.CTRL]);
ShortcutRegistry.registry.addKeyMapping(ctrlC, copyShortcut.name);

const altC =
ShortcutRegistry.registry.createSerializedKey(KeyCodes.C, [KeyCodes.ALT]);
ShortcutRegistry.registry.addKeyMapping(altC, copyShortcut.name);

const metaC = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.C, [KeyCodes.META]);
ShortcutRegistry.registry.addKeyMapping(metaC, copyShortcut.name);
};
exports.registerCopy = registerCopy;

Expand All @@ -139,6 +133,13 @@ exports.registerCopy = registerCopy;
* @alias Blockly.ShortcutItems.registerCut
*/
const registerCut = function() {
const ctrlX = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.X, [KeyCodes.CTRL]);
const altX =
ShortcutRegistry.registry.createSerializedKey(KeyCodes.X, [KeyCodes.ALT]);
const metaX = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.X, [KeyCodes.META]);

/** @type {!ShortcutRegistry.KeyboardShortcut} */
const cutShortcut = {
name: names.CUT,
Expand All @@ -158,21 +159,10 @@ const registerCut = function() {
(/** @type {!BlockSvg} */ (selected)).checkAndDelete();
return true;
},
keyCodes: [ctrlX, altX, metaX],
};

ShortcutRegistry.registry.register(cutShortcut);

const ctrlX = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.X, [KeyCodes.CTRL]);
ShortcutRegistry.registry.addKeyMapping(ctrlX, cutShortcut.name);

const altX =
ShortcutRegistry.registry.createSerializedKey(KeyCodes.X, [KeyCodes.ALT]);
ShortcutRegistry.registry.addKeyMapping(altX, cutShortcut.name);

const metaX = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.X, [KeyCodes.META]);
ShortcutRegistry.registry.addKeyMapping(metaX, cutShortcut.name);
};
exports.registerCut = registerCut;

Expand All @@ -181,6 +171,13 @@ exports.registerCut = registerCut;
* @alias Blockly.ShortcutItems.registerPaste
*/
const registerPaste = function() {
const ctrlV = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.V, [KeyCodes.CTRL]);
const altV =
ShortcutRegistry.registry.createSerializedKey(KeyCodes.V, [KeyCodes.ALT]);
const metaV = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.V, [KeyCodes.META]);

/** @type {!ShortcutRegistry.KeyboardShortcut} */
const pasteShortcut = {
name: names.PASTE,
Expand All @@ -190,21 +187,10 @@ const registerPaste = function() {
callback: function() {
return clipboard.paste();
},
keyCodes: [ctrlV, altV, metaV],
};

ShortcutRegistry.registry.register(pasteShortcut);

const ctrlV = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.V, [KeyCodes.CTRL]);
ShortcutRegistry.registry.addKeyMapping(ctrlV, pasteShortcut.name);

const altV =
ShortcutRegistry.registry.createSerializedKey(KeyCodes.V, [KeyCodes.ALT]);
ShortcutRegistry.registry.addKeyMapping(altV, pasteShortcut.name);

const metaV = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.V, [KeyCodes.META]);
ShortcutRegistry.registry.addKeyMapping(metaV, pasteShortcut.name);
};
exports.registerPaste = registerPaste;

Expand All @@ -213,6 +199,13 @@ exports.registerPaste = registerPaste;
* @alias Blockly.ShortcutItems.registerUndo
*/
const registerUndo = function() {
const ctrlZ = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Z, [KeyCodes.CTRL]);
const altZ =
ShortcutRegistry.registry.createSerializedKey(KeyCodes.Z, [KeyCodes.ALT]);
const metaZ = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Z, [KeyCodes.META]);

/** @type {!ShortcutRegistry.KeyboardShortcut} */
const undoShortcut = {
name: names.UNDO,
Expand All @@ -225,20 +218,9 @@ const registerUndo = function() {
workspace.undo(false);
return true;
},
keyCodes: [ctrlZ, altZ, metaZ],
};
ShortcutRegistry.registry.register(undoShortcut);

const ctrlZ = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Z, [KeyCodes.CTRL]);
ShortcutRegistry.registry.addKeyMapping(ctrlZ, undoShortcut.name);

const altZ =
ShortcutRegistry.registry.createSerializedKey(KeyCodes.Z, [KeyCodes.ALT]);
ShortcutRegistry.registry.addKeyMapping(altZ, undoShortcut.name);

const metaZ = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Z, [KeyCodes.META]);
ShortcutRegistry.registry.addKeyMapping(metaZ, undoShortcut.name);
};
exports.registerUndo = registerUndo;

Expand All @@ -248,6 +230,16 @@ exports.registerUndo = registerUndo;
* @alias Blockly.ShortcutItems.registerRedo
*/
const registerRedo = function() {
const ctrlShiftZ = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Z, [KeyCodes.SHIFT, KeyCodes.CTRL]);
const altShiftZ = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Z, [KeyCodes.SHIFT, KeyCodes.ALT]);
const metaShiftZ = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Z, [KeyCodes.SHIFT, KeyCodes.META]);
// Ctrl-y is redo in Windows. Command-y is never valid on Macs.
const ctrlY = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Y, [KeyCodes.CTRL]);

/** @type {!ShortcutRegistry.KeyboardShortcut} */
const redoShortcut = {
name: names.REDO,
Expand All @@ -260,25 +252,9 @@ const registerRedo = function() {
workspace.undo(true);
return true;
},
keyCodes: [ctrlShiftZ, altShiftZ, metaShiftZ, ctrlY],
};
ShortcutRegistry.registry.register(redoShortcut);

const ctrlShiftZ = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Z, [KeyCodes.SHIFT, KeyCodes.CTRL]);
ShortcutRegistry.registry.addKeyMapping(ctrlShiftZ, redoShortcut.name);

const altShiftZ = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Z, [KeyCodes.SHIFT, KeyCodes.ALT]);
ShortcutRegistry.registry.addKeyMapping(altShiftZ, redoShortcut.name);

const metaShiftZ = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Z, [KeyCodes.SHIFT, KeyCodes.META]);
ShortcutRegistry.registry.addKeyMapping(metaShiftZ, redoShortcut.name);

// Ctrl-y is redo in Windows. Command-y is never valid on Macs.
const ctrlY = ShortcutRegistry.registry.createSerializedKey(
KeyCodes.Y, [KeyCodes.CTRL]);
ShortcutRegistry.registry.addKeyMapping(ctrlY, redoShortcut.name);
};
exports.registerRedo = registerRedo;

Expand Down
14 changes: 12 additions & 2 deletions core/shortcut_registry.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ class ShortcutRegistry {
'Shortcut with name "' + shortcut.name + '" already exists.');
}
this.registry_[shortcut.name] = shortcut;

const keyCodes = shortcut.keyCodes;
if (keyCodes && keyCodes.length > 0) {
for (let i = 0; i < keyCodes.length; i++) {
this.addKeyMapping(
keyCodes[i], shortcut.name, !!shortcut.allowCollision);
}
}
}

/**
Expand All @@ -98,7 +106,7 @@ class ShortcutRegistry {

/**
* Adds a mapping between a keycode and a keyboard shortcut.
* @param {string|KeyCodes} keyCode The key code for the keyboard
* @param {string|number|KeyCodes} keyCode The key code for the keyboard
* shortcut. If registering a key code with a modifier (ex: ctrl+c) use
* ShortcutRegistry.registry.createSerializedKey;
* @param {string} shortcutName The name of the shortcut to execute when the
Expand Down Expand Up @@ -354,7 +362,9 @@ ShortcutRegistry.modifierKeys = {
* !ShortcutRegistry.KeyboardShortcut):boolean)|undefined),
* name: string,
* preconditionFn: ((function(!Workspace):boolean)|undefined),
* metadata: (Object|undefined)
* metadata: (Object|undefined),
* keyCodes: (Array<string|number>|undefined),
* allowCollision: (boolean|undefined)
* }}
*/
ShortcutRegistry.KeyboardShortcut;
Expand Down
2 changes: 1 addition & 1 deletion scripts/gulpfiles/chunks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,6 @@
"./core/events/events_bubble_open.js",
"./core/procedures.js",
"./core/workspace_svg.js",
"./core/utils/rect.js",
"./core/utils/deprecation.js",
"./core/utils/svg_math.js",
"./core/bubble_dragger.js",
Expand All @@ -242,6 +241,7 @@
"./core/tooltip.js",
"./core/block_svg.js",
"./core/utils/size.js",
"./core/utils/rect.js",
"./core/utils/coordinate.js",
"./core/utils/style.js",
"./core/dropdowndiv.js",
Expand Down
29 changes: 29 additions & 0 deletions tests/mocha/shortcut_registry_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,35 @@ suite('Keyboard Shortcut Registry Test', function() {
chai.assert.doesNotThrow(shouldNotThrow);
chai.assert.exists(registry.registry_['test_shortcut'].callback);
});
test('Registering a shortcut with keycodes', function() {
const shiftA = this.registry.createSerializedKey(
'65', [Blockly.ShortcutRegistry.modifierKeys.Shift]);
const testShortcut = {
'name': 'test_shortcut',
'keyCodes': ['65', 66, shiftA],
};
this.registry.register(testShortcut, true);
chai.assert.lengthOf(this.registry.keyMap_[shiftA], 1);
chai.assert.lengthOf(this.registry.keyMap_['65'], 1);
chai.assert.lengthOf(this.registry.keyMap_['66'], 1);
});
test('Registering a shortcut with allowCollision', function() {
const testShortcut = {
'name': 'test_shortcut',
'keyCodes': ['65'],
};
const duplicateShortcut = {
'name': 'duplicate_shortcut',
'keyCodes': ['65'],
'allowCollision': true,
};
this.registry.register(testShortcut);
const registry = this.registry;
const shouldNotThrow = function() {
registry.register(duplicateShortcut);
};
chai.assert.doesNotThrow(shouldNotThrow);
});
});

suite('Unregistering', function() {
Expand Down