blockly 8.0.5 → 9.0.0-beta.0

package/core/renderers/zelos/renderer.js

@@ -1,147 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Zelos renderer.
- */
-'use strict';
-
-/**
- * Zelos renderer.
- * @class
- */
-goog.module('Blockly.zelos.Renderer');
-
-const blockRendering = goog.require('Blockly.blockRendering');
-/* eslint-disable-next-line no-unused-vars */
-const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-const {ConnectionType} = goog.require('Blockly.ConnectionType');
-const {ConstantProvider} = goog.require('Blockly.zelos.ConstantProvider');
-const {Drawer} = goog.require('Blockly.zelos.Drawer');
-const {InsertionMarkerManager} = goog.require('Blockly.InsertionMarkerManager');
-const {MarkerSvg} = goog.require('Blockly.zelos.MarkerSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {Marker} = goog.requireType('Blockly.Marker');
-const {PathObject} = goog.require('Blockly.zelos.PathObject');
-/* eslint-disable-next-line no-unused-vars */
-const {RenderInfo: BaseRenderInfo} = goog.requireType('Blockly.blockRendering.RenderInfo');
-const {RenderInfo} = goog.require('Blockly.zelos.RenderInfo');
-const {Renderer: BaseRenderer} = goog.require('Blockly.blockRendering.Renderer');
-/* eslint-disable-next-line no-unused-vars */
-const {Theme} = goog.requireType('Blockly.Theme');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
-
-
-/**
- * The zelos renderer.
- * @extends {BaseRenderer}
- * @alias Blockly.zelos.Renderer
- */
-class Renderer extends BaseRenderer {
-  /**
-   * @param {string} name The renderer name.
-   * @package
-   */
-  constructor(name) {
-    super(name);
-  }
-
-  /**
-   * Create a new instance of the renderer's constant provider.
-   * @return {!ConstantProvider} The constant provider.
-   * @protected
-   * @override
-   */
-  makeConstants_() {
-    return new ConstantProvider();
-  }
-
-  /**
-   * Create a new instance of the renderer's render info object.
-   * @param {!BlockSvg} block The block to measure.
-   * @return {!RenderInfo} The render info object.
-   * @protected
-   * @override
-   */
-  makeRenderInfo_(block) {
-    return new RenderInfo(this, block);
-  }
-
-  /**
-   * Create a new instance of the renderer's drawer.
-   * @param {!BlockSvg} block The block to render.
-   * @param {!BaseRenderInfo} info An object containing all
-   *   information needed to render this block.
-   * @return {!Drawer} The drawer.
-   * @protected
-   * @override
-   */
-  makeDrawer_(block, info) {
-    return new Drawer(
-        block,
-        /** @type {!RenderInfo} */ (info));
-  }
-
-  /**
-   * Create a new instance of the renderer's cursor drawer.
-   * @param {!WorkspaceSvg} workspace The workspace the cursor belongs to.
-   * @param {!Marker} marker The marker.
-   * @return {!MarkerSvg} The object in charge of drawing
-   *     the marker.
-   * @package
-   * @override
-   */
-  makeMarkerDrawer(workspace, marker) {
-    return new MarkerSvg(workspace, this.getConstants(), marker);
-  }
-
-  /**
-   * Create a new instance of a renderer path object.
-   * @param {!SVGElement} root The root SVG element.
-   * @param {!Theme.BlockStyle} style The style object to use for
-   *     colouring.
-   * @return {!PathObject} The renderer path object.
-   * @package
-   * @override
-   */
-  makePathObject(root, style) {
-    return new PathObject(
-        root, style,
-        /** @type {!ConstantProvider} */ (this.getConstants()));
-  }
-
-  /**
-   * @override
-   */
-  shouldHighlightConnection(conn) {
-    return conn.type !== ConnectionType.INPUT_VALUE &&
-        conn.type !== ConnectionType.OUTPUT_VALUE;
-  }
-
-  /**
-   * @override
-   */
-  getConnectionPreviewMethod(closest, local, topBlock) {
-    if (local.type === ConnectionType.OUTPUT_VALUE) {
-      if (!closest.isConnected()) {
-        return InsertionMarkerManager.PREVIEW_TYPE.INPUT_OUTLINE;
-      }
-      // TODO: Returning this is a total hack, because we don't want to show
-      //   a replacement fade, we want to show an outline affect.
-      //   Sadly zelos does not support showing an outline around filled
-      //   inputs, so we have to pretend like the connected block is getting
-      //   replaced.
-      return InsertionMarkerManager.PREVIEW_TYPE.REPLACEMENT_FADE;
-    }
-
-    return super.getConnectionPreviewMethod(closest, local, topBlock);
-  }
-}
-
-blockRendering.register('zelos', Renderer);
-
-exports.Renderer = Renderer;

package/core/renderers/zelos/zelos.js

@@ -1,38 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Re-exports of Blockly.zelos.* modules.
- */
-'use strict';
-
-/**
- * Re-exports of Blockly.zelos.* modules.
- * @namespace Blockly.zelos
- */
-goog.module('Blockly.zelos');
-
-const {BottomRow} = goog.require('Blockly.zelos.BottomRow');
-const {ConstantProvider} = goog.require('Blockly.zelos.ConstantProvider');
-const {Drawer} = goog.require('Blockly.zelos.Drawer');
-const {MarkerSvg} = goog.require('Blockly.zelos.MarkerSvg');
-const {PathObject} = goog.require('Blockly.zelos.PathObject');
-const {RenderInfo} = goog.require('Blockly.zelos.RenderInfo');
-const {Renderer} = goog.require('Blockly.zelos.Renderer');
-const {RightConnectionShape} = goog.require('Blockly.zelos.RightConnectionShape');
-const {StatementInput} = goog.require('Blockly.zelos.StatementInput');
-const {TopRow} = goog.require('Blockly.zelos.TopRow');
-
-exports.BottomRow = BottomRow;
-exports.ConstantProvider = ConstantProvider;
-exports.Drawer = Drawer;
-exports.MarkerSvg = MarkerSvg;
-exports.PathObject = PathObject;
-exports.RenderInfo = RenderInfo;
-exports.Renderer = Renderer;
-exports.RightConnectionShape = RightConnectionShape;
-exports.StatementInput = StatementInput;
-exports.TopRow = TopRow;

package/core/serialization/exceptions.js

@@ -1,144 +0,0 @@
-
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Contains custom errors thrown by the serialization system.
- */
-'use strict';
-
-/**
- * Contains custom errors thrown by the serialization system.
- * @namespace Blockly.serialization.exceptions
- */
-goog.module('Blockly.serialization.exceptions');
-
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
-// eslint-disable-next-line no-unused-vars
-const {State} = goog.requireType('Blockly.serialization.blocks');
-
-
-/**
- * @alias Blockly.serialization.exceptions.DeserializationError
- */
-class DeserializationError extends Error {}
-exports.DeserializationError = DeserializationError;
-
-/**
- * Represents an error where the serialized state is expected to provide a
- * block type, but it is not provided.
- * @alias Blockly.serialization.exceptions.MissingBlockType
- */
-class MissingBlockType extends DeserializationError {
-  /**
-   * @param {!State} state The state object which is missing the block type.
-   * @package
-   */
-  constructor(state) {
-    super(`Expected to find a 'type' property, defining the block type`);
-
-    /**
-     * The state object containing the bad name.
-     * @type {!State}
-     */
-    this.state = state;
-  }
-}
-exports.MissingBlockType = MissingBlockType;
-
-/**
- * Represents an error where deserialization encountered a block that did
- * not have a connection that was defined in the serialized state.
- * @alias Blockly.serialization.exceptions.MissingConnection
- */
-class MissingConnection extends DeserializationError {
-  /**
-   * @param {string} connection The name of the connection that is missing. E.g.
-   *     'IF0', or 'next'.
-   * @param {!Block} block The block missing the connection.
-   * @param {!State} state The state object containing the bad connection.
-   * @package
-   */
-  constructor(connection, block, state) {
-    super(`The block ${block.toDevString()} is missing a(n) ${connection}
-connection`);
-
-    /**
-     * The block missing the connection.
-     * @type {!Block}
-     */
-    this.block = block;
-
-    /**
-     * The state object containing the bad name.
-     * @type {!State}
-     */
-    this.state = state;
-  }
-}
-exports.MissingConnection = MissingConnection;
-
-/**
- * Represents an error where deserialization tried to connect two connections
- * that were not compatible.
- * @alias Blockly.serialization.exceptions.BadConnectionCheck
- */
-class BadConnectionCheck extends DeserializationError {
-  /**
-   * @param {string} reason The reason the connections were not compatible.
-   * @param {string} childConnection The name of the incompatible child
-   *     connection. E.g. 'output' or 'previous'.
-   * @param {!Block} childBlock The child block that could not connect
-   *     to its parent.
-   * @param {!State} childState The state object representing the child block.
-   * @package
-   */
-  constructor(reason, childConnection, childBlock, childState) {
-    super(`The block ${childBlock.toDevString()} could not connect its
-${childConnection} to its parent, because: ${reason}`);
-
-    /**
-     * The block that could not connect to its parent.
-     * @type {!Block}
-     */
-    this.childBlock = childBlock;
-
-    /**
-     * The state object representing the block that could not connect to its
-     * parent.
-     * @type {!State}
-     */
-    this.childState = childState;
-  }
-}
-exports.BadConnectionCheck = BadConnectionCheck;
-
-/**
- * Represents an error where deserialization encountered a real block as it
- * was deserializing children of a shadow.
- * This is an error because it is an invariant of Blockly that shadow blocks
- * do not have real children.
- * @alias Blockly.serialization.exceptions.RealChildOfShadow
- */
-class RealChildOfShadow extends DeserializationError {
-  /**
-   * @param {!State} state The state object representing the real block.
-   * @package
-   */
-  constructor(state) {
-    super(`Encountered a real block which is defined as a child of a shadow
-block. It is an invariant of Blockly that shadow blocks only have shadow
-children`);
-
-    /**
-     * The state object representing the real block.
-     * @type {!State}
-     */
-    this.state = state;
-  }
-}
-exports.RealChildOfShadow = RealChildOfShadow;

package/core/shortcut_registry.js

@@ -1,366 +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.
- */
-'use strict';
-
-/**
- * The namespace used to keep track of keyboard shortcuts and the
- * key codes used to execute those shortcuts.
- * @class
- */
-goog.module('Blockly.ShortcutRegistry');
-
-const object = goog.require('Blockly.utils.object');
-const {KeyCodes} = goog.require('Blockly.utils.KeyCodes');
-/* eslint-disable-next-line no-unused-vars */
-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.
- * @alias Blockly.ShortcutRegistry
- */
-class ShortcutRegistry {
-  /**
-   * Resets the existing ShortcutRegistry singleton.
-   */
-  constructor() {
-    this.reset();
-  }
-
-  /**
-   * Clear and recreate the registry and keyMap.
-   */
-  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);
-  }
-
-  /**
-   * 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;
-  }
-
-  /**
-   * 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];
-
-    if (!shortcut) {
-      console.warn(
-          'Keyboard shortcut with name "' + shortcutName + '" not found.');
-      return false;
-    }
-
-    this.removeAllKeyMappings(shortcutName);
-
-    delete this.registry_[shortcutName];
-    return 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];
-    }
-  }
-
-  /**
-   * 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;
-    }
-
-    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;
-  }
-
-  /**
-   * 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);
-    }
-  }
-
-  /**
-   * 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 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_);
-  }
-
-  /**
-   * 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;
-        }
-      }
-    }
-    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
-   */
-  getShortcutNamesByKeyCode(keyCode) {
-    return this.keyMap_[keyCode] || [];
-  }
-
-  /**
-   * 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;
-  }
-
-  /**
-   * 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) {
-      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.');
-      }
-    }
-  }
-
-  /**
-   * 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;
-  }
-}
-
-/**
- * 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.
-const registry = new ShortcutRegistry();
-ShortcutRegistry.registry = registry;
-
-exports.ShortcutRegistry = ShortcutRegistry;