blockly 7.20211209.2 → 8.0.0

package/core/shortcut_registry.js

@@ -27,331 +27,340 @@ const {Workspace} = goog.requireType('Blockly.Workspace');
  * Class for the registry of keyboard shortcuts. This is intended to be a
  * singleton. You should not create a new instance, and only access this class
  * from ShortcutRegistry.registry.
- * @constructor
  * @alias Blockly.ShortcutRegistry
  */
-const ShortcutRegistry = function() {
-  // Singleton instance should be registered once.
-  ShortcutRegistry.registry = this;
-
+class ShortcutRegistry {
   /**
-   * Registry of all keyboard shortcuts, keyed by name of shortcut.
-   * @type {!Object<string, !ShortcutRegistry.KeyboardShortcut>}
-   * @private
+   * Resets the existing ShortcutRegistry singleton.
    */
-  this.registry_ = Object.create(null);
+  constructor() {
+    this.reset();
+  }
 
   /**
-   * Map of key codes to an array of shortcut names.
-   * @type {!Object<string, !Array<string>>}
-   * @private
+   * Clear and recreate the registry and keyMap.
    */
-  this.keyMap_ = Object.create(null);
-};
-
-/**
- * Enum of valid modifiers.
- * @enum {!KeyCodes<number>}
- */
-ShortcutRegistry.modifierKeys = {
-  'Shift': KeyCodes.SHIFT,
-  'Control': KeyCodes.CTRL,
-  'Alt': KeyCodes.ALT,
-  'Meta': KeyCodes.META,
-};
-
-/**
- * A keyboard shortcut.
- * @typedef {{
- *    callback: ((function(!Workspace, Event,
- * !ShortcutRegistry.KeyboardShortcut):boolean)|undefined),
- *    name: string,
- *    preconditionFn: ((function(!Workspace):boolean)|undefined),
- *    metadata: (Object|undefined)
- * }}
- */
-ShortcutRegistry.KeyboardShortcut;
-
-/**
- * Registers a keyboard shortcut.
- * @param {!ShortcutRegistry.KeyboardShortcut} shortcut The
- *     shortcut for this key code.
- * @param {boolean=} opt_allowOverrides True to prevent a warning when
- *     overriding an already registered item.
- * @throws {Error} if a shortcut with the same name already exists.
- * @public
- */
-ShortcutRegistry.prototype.register = function(shortcut, opt_allowOverrides) {
-  const registeredShortcut = this.registry_[shortcut.name];
-  if (registeredShortcut && !opt_allowOverrides) {
-    throw new Error(
-        'Shortcut with name "' + shortcut.name + '" already exists.');
+  reset() {
+    /**
+     * Registry of all keyboard shortcuts, keyed by name of shortcut.
+     * @type {!Object<string, !ShortcutRegistry.KeyboardShortcut>}
+     * @private
+     */
+    this.registry_ = Object.create(null);
+
+    /**
+     * Map of key codes to an array of shortcut names.
+     * @type {!Object<string, !Array<string>>}
+     * @private
+     */
+    this.keyMap_ = Object.create(null);
   }
-  this.registry_[shortcut.name] = shortcut;
-};
 
-/**
- * Unregisters a keyboard shortcut registered with the given key code. This will
- * also remove any key mappings that reference this shortcut.
- * @param {string} shortcutName The name of the shortcut to unregister.
- * @return {boolean} True if an item was unregistered, false otherwise.
- * @public
- */
-ShortcutRegistry.prototype.unregister = function(shortcutName) {
-  const shortcut = this.registry_[shortcutName];
-
-  if (!shortcut) {
-    console.warn(
-        'Keyboard shortcut with name "' + shortcutName + '" not found.');
-    return false;
+  /**
+   * Registers a keyboard shortcut.
+   * @param {!ShortcutRegistry.KeyboardShortcut} shortcut The
+   *     shortcut for this key code.
+   * @param {boolean=} opt_allowOverrides True to prevent a warning when
+   *     overriding an already registered item.
+   * @throws {Error} if a shortcut with the same name already exists.
+   * @public
+   */
+  register(shortcut, opt_allowOverrides) {
+    const registeredShortcut = this.registry_[shortcut.name];
+    if (registeredShortcut && !opt_allowOverrides) {
+      throw new Error(
+          'Shortcut with name "' + shortcut.name + '" already exists.');
+    }
+    this.registry_[shortcut.name] = shortcut;
   }
 
-  this.removeAllKeyMappings(shortcutName);
-
-  delete this.registry_[shortcutName];
-  return true;
-};
+  /**
+   * Unregisters a keyboard shortcut registered with the given key code. This
+   * will also remove any key mappings that reference this shortcut.
+   * @param {string} shortcutName The name of the shortcut to unregister.
+   * @return {boolean} True if an item was unregistered, false otherwise.
+   * @public
+   */
+  unregister(shortcutName) {
+    const shortcut = this.registry_[shortcutName];
 
-/**
- * Adds a mapping between a keycode and a keyboard shortcut.
- * @param {string|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
- *     given keycode is pressed.
- * @param {boolean=} opt_allowCollision True to prevent an error when adding a
- *     shortcut to a key that is already mapped to a shortcut.
- * @throws {Error} if the given key code is already mapped to a shortcut.
- * @public
- */
-ShortcutRegistry.prototype.addKeyMapping = function(
-    keyCode, shortcutName, opt_allowCollision) {
-  keyCode = String(keyCode);
-  const shortcutNames = this.keyMap_[keyCode];
-  if (shortcutNames && !opt_allowCollision) {
-    throw new Error(
-        'Shortcut with name "' + shortcutName + '" collides with shortcuts ' +
-        shortcutNames.toString());
-  } else if (shortcutNames && opt_allowCollision) {
-    shortcutNames.unshift(shortcutName);
-  } else {
-    this.keyMap_[keyCode] = [shortcutName];
-  }
-};
+    if (!shortcut) {
+      console.warn(
+          'Keyboard shortcut with name "' + shortcutName + '" not found.');
+      return false;
+    }
 
-/**
- * Removes a mapping between a keycode and a keyboard shortcut.
- * @param {string} 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
- *     given keycode is pressed.
- * @param {boolean=} opt_quiet True to not console warn when there is no
- *     shortcut to remove.
- * @return {boolean} True if a key mapping was removed, false otherwise.
- * @public
- */
-ShortcutRegistry.prototype.removeKeyMapping = function(
-    keyCode, shortcutName, opt_quiet) {
-  const shortcutNames = this.keyMap_[keyCode];
-
-  if (!shortcutNames && !opt_quiet) {
-    console.warn(
-        'No keyboard shortcut with name "' + shortcutName +
-        '" registered with key code "' + keyCode + '"');
-    return false;
-  }
+    this.removeAllKeyMappings(shortcutName);
 
-  const shortcutIdx = shortcutNames.indexOf(shortcutName);
-  if (shortcutIdx > -1) {
-    shortcutNames.splice(shortcutIdx, 1);
-    if (shortcutNames.length === 0) {
-      delete this.keyMap_[keyCode];
-    }
+    delete this.registry_[shortcutName];
     return true;
   }
-  if (!opt_quiet) {
-    console.warn(
-        'No keyboard shortcut with name "' + shortcutName +
-        '" registered with key code "' + keyCode + '"');
-  }
-  return false;
-};
 
-/**
- * Removes all the key mappings for a shortcut with the given name.
- * Useful when changing the default key mappings and the key codes registered to
- * the shortcut are unknown.
- * @param {string} shortcutName The name of the shortcut to remove from the key
- *     map.
- * @public
- */
-ShortcutRegistry.prototype.removeAllKeyMappings = function(shortcutName) {
-  for (const keyCode in this.keyMap_) {
-    this.removeKeyMapping(keyCode, shortcutName, true);
+  /**
+   * Adds a mapping between a keycode and a keyboard shortcut.
+   * @param {string|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
+   *     given keycode is pressed.
+   * @param {boolean=} opt_allowCollision True to prevent an error when adding a
+   *     shortcut to a key that is already mapped to a shortcut.
+   * @throws {Error} if the given key code is already mapped to a shortcut.
+   * @public
+   */
+  addKeyMapping(keyCode, shortcutName, opt_allowCollision) {
+    keyCode = String(keyCode);
+    const shortcutNames = this.keyMap_[keyCode];
+    if (shortcutNames && !opt_allowCollision) {
+      throw new Error(
+          'Shortcut with name "' + shortcutName + '" collides with shortcuts ' +
+          shortcutNames.toString());
+    } else if (shortcutNames && opt_allowCollision) {
+      shortcutNames.unshift(shortcutName);
+    } else {
+      this.keyMap_[keyCode] = [shortcutName];
+    }
   }
-};
 
-/**
- * Sets the key map. Setting the key map will override any default key mappings.
- * @param {!Object<string, !Array<string>>} keyMap The object with key code to
- *     shortcut names.
- * @public
- */
-ShortcutRegistry.prototype.setKeyMap = function(keyMap) {
-  this.keyMap_ = keyMap;
-};
-
-/**
- * Gets the current key map.
- * @return {!Object<string,!Array<!ShortcutRegistry.KeyboardShortcut>>}
- *     The object holding key codes to ShortcutRegistry.KeyboardShortcut.
- * @public
- */
-ShortcutRegistry.prototype.getKeyMap = function() {
-  return object.deepMerge(Object.create(null), this.keyMap_);
-};
-
-/**
- * Gets the registry of keyboard shortcuts.
- * @return {!Object<string, !ShortcutRegistry.KeyboardShortcut>}
- *     The registry of keyboard shortcuts.
- * @public
- */
-ShortcutRegistry.prototype.getRegistry = function() {
-  return object.deepMerge(Object.create(null), this.registry_);
-};
+  /**
+   * Removes a mapping between a keycode and a keyboard shortcut.
+   * @param {string} 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
+   *     given keycode is pressed.
+   * @param {boolean=} opt_quiet True to not console warn when there is no
+   *     shortcut to remove.
+   * @return {boolean} True if a key mapping was removed, false otherwise.
+   * @public
+   */
+  removeKeyMapping(keyCode, shortcutName, opt_quiet) {
+    const shortcutNames = this.keyMap_[keyCode];
+
+    if (!shortcutNames && !opt_quiet) {
+      console.warn(
+          'No keyboard shortcut with name "' + shortcutName +
+          '" registered with key code "' + keyCode + '"');
+      return false;
+    }
 
-/**
- * Handles key down events.
- * @param {!Workspace} workspace The main workspace where the event was
- *     captured.
- * @param {!Event} e The key down event.
- * @return {boolean} True if the event was handled, false otherwise.
- * @public
- */
-ShortcutRegistry.prototype.onKeyDown = function(workspace, e) {
-  const key = this.serializeKeyEvent_(e);
-  const shortcutNames = this.getShortcutNamesByKeyCode(key);
-  if (!shortcutNames) {
+    const shortcutIdx = shortcutNames.indexOf(shortcutName);
+    if (shortcutIdx > -1) {
+      shortcutNames.splice(shortcutIdx, 1);
+      if (shortcutNames.length === 0) {
+        delete this.keyMap_[keyCode];
+      }
+      return true;
+    }
+    if (!opt_quiet) {
+      console.warn(
+          'No keyboard shortcut with name "' + shortcutName +
+          '" registered with key code "' + keyCode + '"');
+    }
     return false;
   }
-  for (let i = 0, shortcutName; (shortcutName = shortcutNames[i]); i++) {
-    const shortcut = this.registry_[shortcutName];
-    if (!shortcut.preconditionFn || shortcut.preconditionFn(workspace)) {
-      // If the key has been handled, stop processing shortcuts.
-      if (shortcut.callback && shortcut.callback(workspace, e, shortcut)) {
-        return true;
-      }
+
+  /**
+   * Removes all the key mappings for a shortcut with the given name.
+   * Useful when changing the default key mappings and the key codes registered
+   * to the shortcut are unknown.
+   * @param {string} shortcutName The name of the shortcut to remove from the
+   *     key map.
+   * @public
+   */
+  removeAllKeyMappings(shortcutName) {
+    for (const keyCode in this.keyMap_) {
+      this.removeKeyMapping(keyCode, shortcutName, true);
     }
   }
-  return false;
-};
 
-/**
- * Gets the shortcuts registered to the given key code.
- * @param {string} keyCode The serialized key code.
- * @return {!Array<string>|undefined} The list of shortcuts to call when the
- *     given keyCode is used. Undefined if no shortcuts exist.
- * @public
- */
-ShortcutRegistry.prototype.getShortcutNamesByKeyCode = function(keyCode) {
-  return this.keyMap_[keyCode] || [];
-};
+  /**
+   * Sets the key map. Setting the key map will override any default key
+   * mappings.
+   * @param {!Object<string, !Array<string>>} keyMap The object with key code to
+   *     shortcut names.
+   * @public
+   */
+  setKeyMap(keyMap) {
+    this.keyMap_ = keyMap;
+  }
 
-/**
- * Gets the serialized key codes that the shortcut with the given name is
- * registered under.
- * @param {string} shortcutName The name of the shortcut.
- * @return {!Array<string>} An array with all the key codes the shortcut is
- *     registered under.
- * @public
- */
-ShortcutRegistry.prototype.getKeyCodesByShortcutName = function(shortcutName) {
-  const keys = [];
-  for (const keyCode in this.keyMap_) {
-    const shortcuts = this.keyMap_[keyCode];
-    const shortcutIdx = shortcuts.indexOf(shortcutName);
-    if (shortcutIdx > -1) {
-      keys.push(keyCode);
-    }
+  /**
+   * Gets the current key map.
+   * @return {!Object<string,!Array<!ShortcutRegistry.KeyboardShortcut>>}
+   *     The object holding key codes to ShortcutRegistry.KeyboardShortcut.
+   * @public
+   */
+  getKeyMap() {
+    return object.deepMerge(Object.create(null), this.keyMap_);
   }
-  return keys;
-};
 
-/**
- * Serializes a key event.
- * @param {!Event} e A key down event.
- * @return {string} The serialized key code for the given event.
- * @private
- */
-ShortcutRegistry.prototype.serializeKeyEvent_ = function(e) {
-  let serializedKey = '';
-  for (const modifier in ShortcutRegistry.modifierKeys) {
-    if (e.getModifierState(modifier)) {
-      if (serializedKey !== '') {
-        serializedKey += '+';
+  /**
+   * Gets the registry of keyboard shortcuts.
+   * @return {!Object<string, !ShortcutRegistry.KeyboardShortcut>}
+   *     The registry of keyboard shortcuts.
+   * @public
+   */
+  getRegistry() {
+    return object.deepMerge(Object.create(null), this.registry_);
+  }
+
+  /**
+   * Handles key down events.
+   * @param {!Workspace} workspace The main workspace where the event was
+   *     captured.
+   * @param {!Event} e The key down event.
+   * @return {boolean} True if the event was handled, false otherwise.
+   * @public
+   */
+  onKeyDown(workspace, e) {
+    const key = this.serializeKeyEvent_(e);
+    const shortcutNames = this.getShortcutNamesByKeyCode(key);
+    if (!shortcutNames) {
+      return false;
+    }
+    for (let i = 0, shortcutName; (shortcutName = shortcutNames[i]); i++) {
+      const shortcut = this.registry_[shortcutName];
+      if (!shortcut.preconditionFn || shortcut.preconditionFn(workspace)) {
+        // If the key has been handled, stop processing shortcuts.
+        if (shortcut.callback && shortcut.callback(workspace, e, shortcut)) {
+          return true;
+        }
       }
-      serializedKey += modifier;
     }
+    return false;
   }
-  if (serializedKey !== '' && e.keyCode) {
-    serializedKey = serializedKey + '+' + e.keyCode;
-  } else if (e.keyCode) {
-    serializedKey = e.keyCode.toString();
+
+  /**
+   * Gets the shortcuts registered to the given key code.
+   * @param {string} keyCode The serialized key code.
+   * @return {!Array<string>|undefined} The list of shortcuts to call when the
+   *     given keyCode is used. Undefined if no shortcuts exist.
+   * @public
+   */
+  getShortcutNamesByKeyCode(keyCode) {
+    return this.keyMap_[keyCode] || [];
   }
-  return serializedKey;
-};
 
-/**
- * Checks whether any of the given modifiers are not valid.
- * @param {!Array<string>} modifiers List of modifiers to be used with the key.
- * @throws {Error} if the modifier is not in the valid modifiers list.
- * @private
- */
-ShortcutRegistry.prototype.checkModifiers_ = function(modifiers) {
-  const validModifiers = object.values(ShortcutRegistry.modifierKeys);
-  for (let i = 0, modifier; (modifier = modifiers[i]); i++) {
-    if (validModifiers.indexOf(modifier) < 0) {
-      throw new Error(modifier + ' is not a valid modifier key.');
+  /**
+   * Gets the serialized key codes that the shortcut with the given name is
+   * registered under.
+   * @param {string} shortcutName The name of the shortcut.
+   * @return {!Array<string>} An array with all the key codes the shortcut is
+   *     registered under.
+   * @public
+   */
+  getKeyCodesByShortcutName(shortcutName) {
+    const keys = [];
+    for (const keyCode in this.keyMap_) {
+      const shortcuts = this.keyMap_[keyCode];
+      const shortcutIdx = shortcuts.indexOf(shortcutName);
+      if (shortcutIdx > -1) {
+        keys.push(keyCode);
+      }
     }
+    return keys;
   }
-};
 
-/**
- * Creates the serialized key code that will be used in the key map.
- * @param {number} keyCode Number code representing the key.
- * @param {?Array<string>} modifiers List of modifier key codes to be used with
- *     the key. All valid modifiers can be found in the
- *     ShortcutRegistry.modifierKeys.
- * @return {string} The serialized key code for the given modifiers and key.
- * @public
- */
-ShortcutRegistry.prototype.createSerializedKey = function(keyCode, modifiers) {
-  let serializedKey = '';
-
-  if (modifiers) {
-    this.checkModifiers_(modifiers);
+  /**
+   * Serializes a key event.
+   * @param {!Event} e A key down event.
+   * @return {string} The serialized key code for the given event.
+   * @private
+   */
+  serializeKeyEvent_(e) {
+    let serializedKey = '';
     for (const modifier in ShortcutRegistry.modifierKeys) {
-      const modifierKeyCode = ShortcutRegistry.modifierKeys[modifier];
-      if (modifiers.indexOf(modifierKeyCode) > -1) {
+      if (e.getModifierState(modifier)) {
         if (serializedKey !== '') {
           serializedKey += '+';
         }
         serializedKey += modifier;
       }
     }
+    if (serializedKey !== '' && e.keyCode) {
+      serializedKey = serializedKey + '+' + e.keyCode;
+    } else if (e.keyCode) {
+      serializedKey = e.keyCode.toString();
+    }
+    return serializedKey;
+  }
+
+  /**
+   * Checks whether any of the given modifiers are not valid.
+   * @param {!Array<string>} modifiers List of modifiers to be used with the
+   *     key.
+   * @throws {Error} if the modifier is not in the valid modifiers list.
+   * @private
+   */
+  checkModifiers_(modifiers) {
+    const validModifiers = object.values(ShortcutRegistry.modifierKeys);
+    for (let i = 0, modifier; (modifier = modifiers[i]); i++) {
+      if (validModifiers.indexOf(modifier) < 0) {
+        throw new Error(modifier + ' is not a valid modifier key.');
+      }
+    }
   }
 
-  if (serializedKey !== '' && keyCode) {
-    serializedKey = serializedKey + '+' + keyCode;
-  } else if (keyCode) {
-    serializedKey = keyCode.toString();
+  /**
+   * Creates the serialized key code that will be used in the key map.
+   * @param {number} keyCode Number code representing the key.
+   * @param {?Array<string>} modifiers List of modifier key codes to be used
+   *     with the key. All valid modifiers can be found in the
+   *     ShortcutRegistry.modifierKeys.
+   * @return {string} The serialized key code for the given modifiers and key.
+   * @public
+   */
+  createSerializedKey(keyCode, modifiers) {
+    let serializedKey = '';
+
+    if (modifiers) {
+      this.checkModifiers_(modifiers);
+      for (const modifier in ShortcutRegistry.modifierKeys) {
+        const modifierKeyCode = ShortcutRegistry.modifierKeys[modifier];
+        if (modifiers.indexOf(modifierKeyCode) > -1) {
+          if (serializedKey !== '') {
+            serializedKey += '+';
+          }
+          serializedKey += modifier;
+        }
+      }
+    }
+
+    if (serializedKey !== '' && keyCode) {
+      serializedKey = serializedKey + '+' + keyCode;
+    } else if (keyCode) {
+      serializedKey = keyCode.toString();
+    }
+    return serializedKey;
   }
-  return serializedKey;
+}
+
+/**
+ * Enum of valid modifiers.
+ * @enum {!KeyCodes}
+ */
+ShortcutRegistry.modifierKeys = {
+  'Shift': KeyCodes.SHIFT,
+  'Control': KeyCodes.CTRL,
+  'Alt': KeyCodes.ALT,
+  'Meta': KeyCodes.META,
 };
 
+/**
+ * A keyboard shortcut.
+ * @typedef {{
+ *    callback: ((function(!Workspace, Event,
+ * !ShortcutRegistry.KeyboardShortcut):boolean)|undefined),
+ *    name: string,
+ *    preconditionFn: ((function(!Workspace):boolean)|undefined),
+ *    metadata: (Object|undefined)
+ * }}
+ */
+ShortcutRegistry.KeyboardShortcut;
+
 // Creates and assigns the singleton instance.
-new ShortcutRegistry();
+const registry = new ShortcutRegistry();
+ShortcutRegistry.registry = registry;
 
 exports.ShortcutRegistry = ShortcutRegistry;

package/core/sprites.js

@@ -0,0 +1,31 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Holds constants that have to do with the sprites that create
+ * the trashcan and zoom controls.
+ */
+'use strict';
+
+/**
+ * Holds constants that have to do with the sprites that create the trashcan
+ * and zoom controls.
+ */
+goog.module('Blockly.sprite');
+
+
+/**
+ * Contains the path to a single png tat holds the images for the trashcan
+ * as well as the zoom controls.
+ * @const {!Object}
+ * @alias Blockly.sprite.SPRITE
+ */
+const SPRITE = {
+  width: 96,
+  height: 124,
+  url: 'sprites.png',
+};
+exports.SPRITE = SPRITE;