blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/shortcut_registry.ts

@@ -1,355 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The namespace used to keep track of keyboard shortcuts and the
- * key codes used to execute those shortcuts.
- */
-
-/**
- * The namespace used to keep track of keyboard shortcuts and the
- * key codes used to execute those shortcuts.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.ShortcutRegistry');
-
-import {KeyCodes} from './utils/keycodes.js';
-import * as object from './utils/object.js';
-import type {Workspace} from './workspace.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.
- * @alias Blockly.ShortcutRegistry
- */
-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 with name "' + 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.
-   * @return True if an item was unregistered, false otherwise.
-   */
-  unregister(shortcutName: string): boolean {
-    const shortcut = this.shortcuts.get(shortcutName);
-
-    if (!shortcut) {
-      console.warn(
-          'Keyboard shortcut with name "' + 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 = String(keyCode);
-    const shortcutNames = this.keyMap.get(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.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.
-   * @return 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 with name "' + 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 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 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.
-   * @return 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.
-   * @return 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.
-   * @return True if the event was handled, false otherwise.
-   */
-  onKeyDown(workspace: Workspace, 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.
-   * @return 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.
-   * @return 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.
-   * @return 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 = serializedKey + '+' + e.keyCode;
-    } else if (e.keyCode) {
-      serializedKey = e.keyCode.toString();
-    }
-    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[]) {
-    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.');
-      }
-    }
-  }
-
-  /**
-   * 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.
-   * @return 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.indexOf(modifierKeyCode) > -1) {
-          if (serializedKey !== '') {
-            serializedKey += '+';
-          }
-          serializedKey += modifier;
-        }
-      }
-    }
-
-    if (serializedKey !== '' && keyCode) {
-      serializedKey = serializedKey + '+' + keyCode;
-    } else if (keyCode) {
-      serializedKey = keyCode.toString();
-    }
-    return serializedKey;
-  }
-}
-
-export namespace ShortcutRegistry {
-  export interface KeyboardShortcut {
-    callback?: ((p1: Workspace, p2: Event, p3: KeyboardShortcut) => boolean);
-    name: string;
-    preconditionFn?: ((p1: Workspace) => 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.

package/core/sprites.ts

@@ -1,29 +0,0 @@
-/**
- * @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.
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.sprite');
-
-
-/**
- * Holds constants that have to do with the sprites that create the trashcan
- * and zoom controls.
- */
-
-/**
- * Contains the path to a single png tat holds the images for the trashcan
- * as well as the zoom controls.
- * @alias Blockly.sprite.SPRITE
- */
-export const SPRITE = {
-  width: 96,
-  height: 124,
-  url: 'sprites.png',
-};

package/core/theme/classic.ts

@@ -1,54 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Classic theme.
- * Contains multi-coloured border to create shadow effect.
- */
-
-/**
- * Classic theme.
- * Contains multi-coloured border to create shadow effect.
- * @namespace Blockly.Themes.Classic
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Themes.Classic');
-
-import {Theme} from '../theme.js';
-
-
-const defaultBlockStyles = {
-  'colour_blocks': {'colourPrimary': '20'},
-  'list_blocks': {'colourPrimary': '260'},
-  'logic_blocks': {'colourPrimary': '210'},
-  'loop_blocks': {'colourPrimary': '120'},
-  'math_blocks': {'colourPrimary': '230'},
-  'procedure_blocks': {'colourPrimary': '290'},
-  'text_blocks': {'colourPrimary': '160'},
-  'variable_blocks': {'colourPrimary': '330'},
-  'variable_dynamic_blocks': {'colourPrimary': '310'},
-  'hat_blocks': {'colourPrimary': '330', 'hat': 'cap'},
-};
-
-const categoryStyles = {
-  'colour_category': {'colour': '20'},
-  'list_category': {'colour': '260'},
-  'logic_category': {'colour': '210'},
-  'loop_category': {'colour': '120'},
-  'math_category': {'colour': '230'},
-  'procedure_category': {'colour': '290'},
-  'text_category': {'colour': '160'},
-  'variable_category': {'colour': '330'},
-  'variable_dynamic_category': {'colour': '310'},
-};
-
-/**
- * Classic theme.
- * Contains multi-coloured border to create shadow effect.
- * @alias Blockly.Themes.Classic
- */
-export const Classic = new Theme(
-    'classic', defaultBlockStyles as AnyDuringMigration, categoryStyles);

package/core/theme/themes.ts

@@ -1,22 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Namespace for themes.
- */
-
-/**
- * Namespace for themes.
- * @namespace Blockly.Themes
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Themes');
-
-import {Classic} from './classic.js';
-import {Zelos} from './zelos.js';
-
-
-export {Classic, Zelos};

package/core/theme/zelos.ts

@@ -1,91 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Zelos theme.
- */
-
-/**
- * Zelos theme.
- * @namespace Blockly.Themes.Zelos
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Themes.Zelos');
-
-import {Theme} from '../theme.js';
-
-
-const defaultBlockStyles = {
-  'colour_blocks': {
-    'colourPrimary': '#CF63CF',
-    'colourSecondary': '#C94FC9',
-    'colourTertiary': '#BD42BD',
-  },
-  'list_blocks': {
-    'colourPrimary': '#9966FF',
-    'colourSecondary': '#855CD6',
-    'colourTertiary': '#774DCB',
-  },
-  'logic_blocks': {
-    'colourPrimary': '#4C97FF',
-    'colourSecondary': '#4280D7',
-    'colourTertiary': '#3373CC',
-  },
-  'loop_blocks': {
-    'colourPrimary': '#0fBD8C',
-    'colourSecondary': '#0DA57A',
-    'colourTertiary': '#0B8E69',
-  },
-  'math_blocks': {
-    'colourPrimary': '#59C059',
-    'colourSecondary': '#46B946',
-    'colourTertiary': '#389438',
-  },
-  'procedure_blocks': {
-    'colourPrimary': '#FF6680',
-    'colourSecondary': '#FF4D6A',
-    'colourTertiary': '#FF3355',
-  },
-  'text_blocks': {
-    'colourPrimary': '#FFBF00',
-    'colourSecondary': '#E6AC00',
-    'colourTertiary': '#CC9900',
-  },
-  'variable_blocks': {
-    'colourPrimary': '#FF8C1A',
-    'colourSecondary': '#FF8000',
-    'colourTertiary': '#DB6E00',
-  },
-  'variable_dynamic_blocks': {
-    'colourPrimary': '#FF8C1A',
-    'colourSecondary': '#FF8000',
-    'colourTertiary': '#DB6E00',
-  },
-  'hat_blocks': {
-    'colourPrimary': '#4C97FF',
-    'colourSecondary': '#4280D7',
-    'colourTertiary': '#3373CC',
-    'hat': 'cap',
-  },
-};
-
-const categoryStyles = {
-  'colour_category': {'colour': '#CF63CF'},
-  'list_category': {'colour': '#9966FF'},
-  'logic_category': {'colour': '#4C97FF'},
-  'loop_category': {'colour': '#0fBD8C'},
-  'math_category': {'colour': '#59C059'},
-  'procedure_category': {'colour': '#FF6680'},
-  'text_category': {'colour': '#FFBF00'},
-  'variable_category': {'colour': '#FF8C1A'},
-  'variable_dynamic_category': {'colour': '#FF8C1A'},
-};
-
-/**
- * Zelos theme.
- * @alias Blockly.Themes.Zelos
- */
-export const Zelos = new Theme('zelos', defaultBlockStyles, categoryStyles);