scratch-blocks 2.0.0-beta.1 → 2.0.0-beta.2

package/blockly-rc/core/shortcut_items.ts

@@ -1,338 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.ShortcutItems
-
-import {BlockSvg} from './block_svg.js';
-import * as clipboard from './clipboard.js';
-import * as common from './common.js';
-import {Gesture} from './gesture.js';
-import {ICopyData, isCopyable} from './interfaces/i_copyable.js';
-import {isDeletable} from './interfaces/i_deletable.js';
-import {KeyboardShortcut, ShortcutRegistry} from './shortcut_registry.js';
-import {KeyCodes} from './utils/keycodes.js';
-import type {WorkspaceSvg} from './workspace_svg.js';
-import {isDraggable} from './interfaces/i_draggable.js';
-import * as eventUtils from './events/utils.js';
-import {Coordinate} from './utils/coordinate.js';
-import {Rect} from './utils/rect.js';
-
-/**
- * Object holding the names of the default shortcut items.
- */
-export enum names {
-  ESCAPE = 'escape',
-  DELETE = 'delete',
-  COPY = 'copy',
-  CUT = 'cut',
-  PASTE = 'paste',
-  UNDO = 'undo',
-  REDO = 'redo',
-}
-
-/**
- * Keyboard shortcut to hide chaff on escape.
- */
-export function registerEscape() {
-  const escapeAction: KeyboardShortcut = {
-    name: names.ESCAPE,
-    preconditionFn(workspace) {
-      return !workspace.options.readOnly;
-    },
-    callback(workspace) {
-      // AnyDuringMigration because:  Property 'hideChaff' does not exist on
-      // type 'Workspace'.
-      (workspace as AnyDuringMigration).hideChaff();
-      return true;
-    },
-    keyCodes: [KeyCodes.ESC],
-  };
-  ShortcutRegistry.registry.register(escapeAction);
-}
-
-/**
- * Keyboard shortcut to delete a block on delete or backspace
- */
-export function registerDelete() {
-  const deleteShortcut: KeyboardShortcut = {
-    name: names.DELETE,
-    preconditionFn(workspace) {
-      const selected = common.getSelected();
-      return (
-        !workspace.options.readOnly &&
-        selected != null &&
-        isDeletable(selected) &&
-        selected.isDeletable() &&
-        !Gesture.inProgress()
-      );
-    },
-    callback(workspace, e) {
-      // Delete or backspace.
-      // Stop the browser from going back to the previous page.
-      // Do this first to prevent an error in the delete code from resulting in
-      // data loss.
-      e.preventDefault();
-      const selected = common.getSelected();
-      if (selected instanceof BlockSvg) {
-        selected.checkAndDelete();
-      } else if (isDeletable(selected) && selected.isDeletable()) {
-        eventUtils.setGroup(true);
-        selected.dispose();
-        eventUtils.setGroup(false);
-      }
-      return true;
-    },
-    keyCodes: [KeyCodes.DELETE, KeyCodes.BACKSPACE],
-  };
-  ShortcutRegistry.registry.register(deleteShortcut);
-}
-
-let copyData: ICopyData | null = null;
-let copyWorkspace: WorkspaceSvg | null = null;
-let copyCoords: Coordinate | null = null;
-
-/**
- * Keyboard shortcut to copy a block on ctrl+c, cmd+c, or alt+c.
- */
-export function registerCopy() {
-  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,
-  ]);
-
-  const copyShortcut: KeyboardShortcut = {
-    name: names.COPY,
-    preconditionFn(workspace) {
-      const selected = common.getSelected();
-      return (
-        !workspace.options.readOnly &&
-        !Gesture.inProgress() &&
-        selected != null &&
-        isDeletable(selected) &&
-        selected.isDeletable() &&
-        isDraggable(selected) &&
-        selected.isMovable() &&
-        isCopyable(selected)
-      );
-    },
-    callback(workspace, e) {
-      // Prevent the default copy behavior, which may beep or otherwise indicate
-      // an error due to the lack of a selection.
-      e.preventDefault();
-      workspace.hideChaff();
-      const selected = common.getSelected();
-      if (!selected || !isCopyable(selected)) return false;
-      copyData = selected.toCopyData();
-      copyWorkspace = workspace;
-      copyCoords = isDraggable(selected)
-        ? selected.getRelativeToSurfaceXY()
-        : null;
-      return !!copyData;
-    },
-    keyCodes: [ctrlC, altC, metaC],
-  };
-  ShortcutRegistry.registry.register(copyShortcut);
-}
-
-/**
- * Keyboard shortcut to copy and delete a block on ctrl+x, cmd+x, or alt+x.
- */
-export function registerCut() {
-  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,
-  ]);
-
-  const cutShortcut: KeyboardShortcut = {
-    name: names.CUT,
-    preconditionFn(workspace) {
-      const selected = common.getSelected();
-      return (
-        !workspace.options.readOnly &&
-        !Gesture.inProgress() &&
-        selected != null &&
-        isDeletable(selected) &&
-        selected.isDeletable() &&
-        isDraggable(selected) &&
-        selected.isMovable() &&
-        !selected.workspace!.isFlyout
-      );
-    },
-    callback(workspace) {
-      const selected = common.getSelected();
-
-      if (selected instanceof BlockSvg) {
-        copyData = selected.toCopyData();
-        copyWorkspace = workspace;
-        copyCoords = selected.getRelativeToSurfaceXY();
-        selected.checkAndDelete();
-        return true;
-      } else if (
-        isDeletable(selected) &&
-        selected.isDeletable() &&
-        isCopyable(selected)
-      ) {
-        copyData = selected.toCopyData();
-        copyWorkspace = workspace;
-        copyCoords = isDraggable(selected)
-          ? selected.getRelativeToSurfaceXY()
-          : null;
-        selected.dispose();
-        return true;
-      }
-      return false;
-    },
-    keyCodes: [ctrlX, altX, metaX],
-  };
-
-  ShortcutRegistry.registry.register(cutShortcut);
-}
-
-/**
- * Keyboard shortcut to paste a block on ctrl+v, cmd+v, or alt+v.
- */
-export function registerPaste() {
-  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,
-  ]);
-
-  const pasteShortcut: KeyboardShortcut = {
-    name: names.PASTE,
-    preconditionFn(workspace) {
-      return !workspace.options.readOnly && !Gesture.inProgress();
-    },
-    callback() {
-      if (!copyData || !copyWorkspace) return false;
-      if (!copyCoords) {
-        // If we don't have location data about the original copyable, let the
-        // paster determine position.
-        return !!clipboard.paste(copyData, copyWorkspace);
-      }
-
-      const {left, top, width, height} = copyWorkspace
-        .getMetricsManager()
-        .getViewMetrics(true);
-      const viewportRect = new Rect(top, top + height, left, left + width);
-
-      if (viewportRect.contains(copyCoords.x, copyCoords.y)) {
-        // If the original copyable is inside the viewport, let the paster
-        // determine position.
-        return !!clipboard.paste(copyData, copyWorkspace);
-      }
-
-      // Otherwise, paste in the middle of the viewport.
-      const centerCoords = new Coordinate(left + width / 2, top + height / 2);
-      return !!clipboard.paste(copyData, copyWorkspace, centerCoords);
-    },
-    keyCodes: [ctrlV, altV, metaV],
-  };
-
-  ShortcutRegistry.registry.register(pasteShortcut);
-}
-
-/**
- * Keyboard shortcut to undo the previous action on ctrl+z, cmd+z, or alt+z.
- */
-export function registerUndo() {
-  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,
-  ]);
-
-  const undoShortcut: KeyboardShortcut = {
-    name: names.UNDO,
-    preconditionFn(workspace) {
-      return !workspace.options.readOnly && !Gesture.inProgress();
-    },
-    callback(workspace, e) {
-      // 'z' for undo 'Z' is for redo.
-      (workspace as WorkspaceSvg).hideChaff();
-      workspace.undo(false);
-      e.preventDefault();
-      return true;
-    },
-    keyCodes: [ctrlZ, altZ, metaZ],
-  };
-  ShortcutRegistry.registry.register(undoShortcut);
-}
-
-/**
- * Keyboard shortcut to redo the previous action on ctrl+shift+z, cmd+shift+z,
- * or alt+shift+z.
- */
-export function registerRedo() {
-  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,
-  ]);
-
-  const redoShortcut: KeyboardShortcut = {
-    name: names.REDO,
-    preconditionFn(workspace) {
-      return !Gesture.inProgress() && !workspace.options.readOnly;
-    },
-    callback(workspace, e) {
-      // 'z' for undo 'Z' is for redo.
-      (workspace as WorkspaceSvg).hideChaff();
-      workspace.undo(true);
-      e.preventDefault();
-      return true;
-    },
-    keyCodes: [ctrlShiftZ, altShiftZ, metaShiftZ, ctrlY],
-  };
-  ShortcutRegistry.registry.register(redoShortcut);
-}
-
-/**
- * Registers all default keyboard shortcut item. This should be called once per
- * instance of KeyboardShortcutRegistry.
- *
- * @internal
- */
-export function registerDefaultShortcuts() {
-  registerEscape();
-  registerDelete();
-  registerCopy();
-  registerCut();
-  registerPaste();
-  registerUndo();
-  registerRedo();
-}
-
-registerDefaultShortcuts();

package/blockly-rc/core/shortcut_registry.ts

@@ -1,368 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * The namespace used to keep track of keyboard shortcuts and the
- * key codes used to execute those shortcuts.
- *
- * @class
- */
-// Former goog.module ID: Blockly.ShortcutRegistry
-
-import {KeyCodes} from './utils/keycodes.js';
-import * as object from './utils/object.js';
-import {WorkspaceSvg} from './workspace_svg.js';
-
-/**
- * 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.
- */
-export class ShortcutRegistry {
-  static readonly registry = new ShortcutRegistry();
-
-  /** Registry of all keyboard shortcuts, keyed by name of shortcut. */
-  private shortcuts = new Map<string, KeyboardShortcut>();
-
-  /** Map of key codes to an array of shortcut names. */
-  private keyMap = new Map<string, string[]>();
-
-  /** Resets the existing ShortcutRegistry singleton. */
-  private constructor() {
-    this.reset();
-  }
-
-  /** Clear and recreate the registry and keyMap. */
-  reset() {
-    this.shortcuts.clear();
-    this.keyMap.clear();
-  }
-
-  /**
-   * Registers a keyboard shortcut.
-   *
-   * @param shortcut The shortcut for this key code.
-   * @param opt_allowOverrides True to prevent a warning when overriding an
-   *     already registered item.
-   * @throws {Error} if a shortcut with the same name already exists.
-   */
-  register(shortcut: KeyboardShortcut, opt_allowOverrides?: boolean) {
-    const registeredShortcut = this.shortcuts.get(shortcut.name);
-    if (registeredShortcut && !opt_allowOverrides) {
-      throw new Error(`Shortcut named "${shortcut.name}" already exists.`);
-    }
-    this.shortcuts.set(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,
-        );
-      }
-    }
-  }
-
-  /**
-   * Unregisters a keyboard shortcut registered with the given key code. This
-   * will also remove any key mappings that reference this shortcut.
-   *
-   * @param shortcutName The name of the shortcut to unregister.
-   * @returns True if an item was unregistered, false otherwise.
-   */
-  unregister(shortcutName: string): boolean {
-    const shortcut = this.shortcuts.get(shortcutName);
-
-    if (!shortcut) {
-      console.warn(`Keyboard shortcut named "${shortcutName}" not found.`);
-      return false;
-    }
-
-    this.removeAllKeyMappings(shortcutName);
-
-    this.shortcuts.delete(shortcutName);
-    return true;
-  }
-
-  /**
-   * Adds a mapping between a keycode and a keyboard shortcut.
-   *
-   * @param keyCode The key code for the keyboard shortcut. If registering a key
-   *     code with a modifier (ex: ctrl+c) use
-   *     ShortcutRegistry.registry.createSerializedKey;
-   * @param shortcutName The name of the shortcut to execute when the given
-   *     keycode is pressed.
-   * @param 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.
-   */
-  addKeyMapping(
-    keyCode: string | number | KeyCodes,
-    shortcutName: string,
-    opt_allowCollision?: boolean,
-  ) {
-    keyCode = `${keyCode}`;
-    const shortcutNames = this.keyMap.get(keyCode);
-    if (shortcutNames && !opt_allowCollision) {
-      throw new Error(
-        `Shortcut named "${shortcutName}" collides with shortcuts "${shortcutNames}"`,
-      );
-    } else if (shortcutNames && opt_allowCollision) {
-      shortcutNames.unshift(shortcutName);
-    } else {
-      this.keyMap.set(keyCode, [shortcutName]);
-    }
-  }
-
-  /**
-   * Removes a mapping between a keycode and a keyboard shortcut.
-   *
-   * @param keyCode The key code for the keyboard shortcut. If registering a key
-   *     code with a modifier (ex: ctrl+c) use
-   *     ShortcutRegistry.registry.createSerializedKey;
-   * @param shortcutName The name of the shortcut to execute when the given
-   *     keycode is pressed.
-   * @param opt_quiet True to not console warn when there is no shortcut to
-   *     remove.
-   * @returns True if a key mapping was removed, false otherwise.
-   */
-  removeKeyMapping(
-    keyCode: string,
-    shortcutName: string,
-    opt_quiet?: boolean,
-  ): boolean {
-    const shortcutNames = this.keyMap.get(keyCode);
-
-    if (!shortcutNames) {
-      if (!opt_quiet) {
-        console.warn(
-          `No keyboard shortcut named "${shortcutName}" registered with key code "${keyCode}"`,
-        );
-      }
-      return false;
-    }
-
-    const shortcutIdx = shortcutNames.indexOf(shortcutName);
-    if (shortcutIdx > -1) {
-      shortcutNames.splice(shortcutIdx, 1);
-      if (shortcutNames.length === 0) {
-        this.keyMap.delete(keyCode);
-      }
-      return true;
-    }
-    if (!opt_quiet) {
-      console.warn(
-        `No keyboard shortcut named "${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 shortcutName The name of the shortcut to remove from the key map.
-   */
-  removeAllKeyMappings(shortcutName: string) {
-    for (const keyCode of this.keyMap.keys()) {
-      this.removeKeyMapping(keyCode, shortcutName, true);
-    }
-  }
-
-  /**
-   * Sets the key map. Setting the key map will override any default key
-   * mappings.
-   *
-   * @param newKeyMap The object with key code to shortcut names.
-   */
-  setKeyMap(newKeyMap: {[key: string]: string[]}) {
-    this.keyMap.clear();
-    for (const key in newKeyMap) {
-      this.keyMap.set(key, newKeyMap[key]);
-    }
-  }
-
-  /**
-   * Gets the current key map.
-   *
-   * @returns The object holding key codes to ShortcutRegistry.KeyboardShortcut.
-   */
-  getKeyMap(): {[key: string]: string[]} {
-    const legacyKeyMap: {[key: string]: string[]} = Object.create(null);
-    for (const [key, value] of this.keyMap) {
-      legacyKeyMap[key] = value;
-    }
-    return legacyKeyMap;
-  }
-
-  /**
-   * Gets the registry of keyboard shortcuts.
-   *
-   * @returns The registry of keyboard shortcuts.
-   */
-  getRegistry(): {[key: string]: KeyboardShortcut} {
-    const legacyRegistry: {[key: string]: KeyboardShortcut} =
-      Object.create(null);
-    for (const [key, value] of this.shortcuts) {
-      legacyRegistry[key] = value;
-    }
-    return object.deepMerge(Object.create(null), legacyRegistry);
-  }
-
-  /**
-   * Handles key down events.
-   *
-   * @param workspace The main workspace where the event was captured.
-   * @param e The key down event.
-   * @returns True if the event was handled, false otherwise.
-   */
-  onKeyDown(workspace: WorkspaceSvg, e: KeyboardEvent): boolean {
-    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.shortcuts.get(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;
-        }
-      }
-    }
-    return false;
-  }
-
-  /**
-   * Gets the shortcuts registered to the given key code.
-   *
-   * @param keyCode The serialized key code.
-   * @returns The list of shortcuts to call when the given keyCode is used.
-   *     Undefined if no shortcuts exist.
-   */
-  getShortcutNamesByKeyCode(keyCode: string): string[] | undefined {
-    return this.keyMap.get(keyCode) || [];
-  }
-
-  /**
-   * Gets the serialized key codes that the shortcut with the given name is
-   * registered under.
-   *
-   * @param shortcutName The name of the shortcut.
-   * @returns An array with all the key codes the shortcut is registered under.
-   */
-  getKeyCodesByShortcutName(shortcutName: string): string[] {
-    const keys = [];
-    for (const [keyCode, shortcuts] of this.keyMap) {
-      const shortcutIdx = shortcuts.indexOf(shortcutName);
-      if (shortcutIdx > -1) {
-        keys.push(keyCode);
-      }
-    }
-    return keys;
-  }
-
-  /**
-   * Serializes a key event.
-   *
-   * @param e A key down event.
-   * @returns The serialized key code for the given event.
-   */
-  private serializeKeyEvent_(e: KeyboardEvent): string {
-    let serializedKey = '';
-    for (const modifier in ShortcutRegistry.modifierKeys) {
-      if (e.getModifierState(modifier)) {
-        if (serializedKey !== '') {
-          serializedKey += '+';
-        }
-        serializedKey += modifier;
-      }
-    }
-    if (serializedKey !== '' && e.keyCode) {
-      serializedKey += '+' + e.keyCode;
-    } else if (e.keyCode) {
-      serializedKey = String(e.keyCode);
-    }
-    return serializedKey;
-  }
-
-  /**
-   * Checks whether any of the given modifiers are not valid.
-   *
-   * @param 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: KeyCodes[]) {
-    for (let i = 0, modifier; (modifier = modifiers[i]); i++) {
-      if (!(modifier in ShortcutRegistry.modifierKeys)) {
-        throw new Error(modifier + ' is not a valid modifier key.');
-      }
-    }
-  }
-
-  /**
-   * Creates the serialized key code that will be used in the key map.
-   *
-   * @param keyCode Number code representing the key.
-   * @param modifiers List of modifier key codes to be used with the key. All
-   *     valid modifiers can be found in the ShortcutRegistry.modifierKeys.
-   * @returns The serialized key code for the given modifiers and key.
-   */
-  createSerializedKey(keyCode: number, modifiers: KeyCodes[] | null): string {
-    let serializedKey = '';
-
-    if (modifiers) {
-      this.checkModifiers_(modifiers);
-      for (const modifier in ShortcutRegistry.modifierKeys) {
-        const modifierKeyCode = (
-          ShortcutRegistry.modifierKeys as AnyDuringMigration
-        )[modifier];
-        if (modifiers.includes(modifierKeyCode)) {
-          if (serializedKey !== '') {
-            serializedKey += '+';
-          }
-          serializedKey += modifier;
-        }
-      }
-    }
-
-    if (serializedKey !== '' && keyCode) {
-      serializedKey += '+' + keyCode;
-    } else if (keyCode) {
-      serializedKey = `${keyCode}`;
-    }
-    return serializedKey;
-  }
-}
-
-export namespace ShortcutRegistry {
-  export interface KeyboardShortcut {
-    callback?: (p1: WorkspaceSvg, p2: Event, p3: KeyboardShortcut) => boolean;
-    name: string;
-    preconditionFn?: (p1: WorkspaceSvg) => boolean;
-    metadata?: object;
-    keyCodes?: (number | string)[];
-    allowCollision?: boolean;
-  }
-
-  /** Supported modifiers. */
-  export enum modifierKeys {
-    Shift = KeyCodes.SHIFT,
-    Control = KeyCodes.CTRL,
-    Alt = KeyCodes.ALT,
-    Meta = KeyCodes.META,
-  }
-}
-
-export type KeyboardShortcut = ShortcutRegistry.KeyboardShortcut;
-// No need to export ShorcutRegistry.modifierKeys from the module at this time
-// because (1) it wasn't automatically converted by the automatic migration
-// script, (2) the name doesn't follow the styleguide.