blockly 8.0.5 → 9.0.0-beta.0

package/core/blockly_options.js

@@ -1,28 +0,0 @@
-/**
- * @license
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Object that defines user-specified options for the workspace.
- */
-'use strict';
-
-/**
- * Object that defines user-specified options for the workspace.
- * @namespace Blockly.BlocklyOptions
- */
-goog.module('Blockly.BlocklyOptions');
-
-
-/**
- * Blockly options.
- * This interface is further described in
- * `typings/parts/blockly-interfaces.d.ts`.
- * @interface
- * @alias Blockly.BlocklyOptions
- */
-const BlocklyOptions = function() {};
-
-exports.BlocklyOptions = BlocklyOptions;

package/core/bubble_dragger.js

@@ -1,298 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Methods for dragging a bubble visually.
- */
-'use strict';
-
-/**
- * Methods for dragging a bubble visually.
- * @class
- */
-goog.module('Blockly.BubbleDragger');
-
-const eventUtils = goog.require('Blockly.Events.utils');
-const svgMath = goog.require('Blockly.utils.svgMath');
-/* eslint-disable-next-line no-unused-vars */
-const {BlockDragSurfaceSvg} = goog.requireType('Blockly.BlockDragSurfaceSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {CommentMove} = goog.requireType('Blockly.Events.CommentMove');
-const {ComponentManager} = goog.require('Blockly.ComponentManager');
-const {Coordinate} = goog.require('Blockly.utils.Coordinate');
-/* eslint-disable-next-line no-unused-vars */
-const {IBubble} = goog.requireType('Blockly.IBubble');
-/* eslint-disable-next-line no-unused-vars */
-const {IDeleteArea} = goog.requireType('Blockly.IDeleteArea');
-/* eslint-disable-next-line no-unused-vars */
-const {IDragTarget} = goog.requireType('Blockly.IDragTarget');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceCommentSvg} = goog.requireType('Blockly.WorkspaceCommentSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
-/** @suppress {extraRequire} */
-goog.require('Blockly.Bubble');
-/** @suppress {extraRequire} */
-goog.require('Blockly.Events.CommentMove');
-/** @suppress {extraRequire} */
-goog.require('Blockly.constants');
-
-
-/**
- * Class for a bubble dragger.  It moves things on the bubble canvas around the
- * workspace when they are being dragged by a mouse or touch.  These can be
- * block comments, mutators, warnings, or workspace comments.
- * @alias Blockly.BubbleDragger
- */
-const BubbleDragger = class {
-  /**
-   * @param {!IBubble} bubble The item on the bubble canvas to drag.
-   * @param {!WorkspaceSvg} workspace The workspace to drag on.
-   */
-  constructor(bubble, workspace) {
-    /**
-     * The item on the bubble canvas that is being dragged.
-     * @type {!IBubble}
-     * @private
-     */
-    this.draggingBubble_ = bubble;
-
-    /**
-     * The workspace on which the bubble is being dragged.
-     * @type {!WorkspaceSvg}
-     * @private
-     */
-    this.workspace_ = workspace;
-
-    /**
-     * Which drag target the mouse pointer is over, if any.
-     * @type {?IDragTarget}
-     * @private
-     */
-    this.dragTarget_ = null;
-
-    /**
-     * Whether the bubble would be deleted if dropped immediately.
-     * @type {boolean}
-     * @private
-     */
-    this.wouldDeleteBubble_ = false;
-
-    /**
-     * The location of the top left corner of the dragging bubble's body at the
-     * beginning of the drag, in workspace coordinates.
-     * @type {!Coordinate}
-     * @private
-     */
-    this.startXY_ = this.draggingBubble_.getRelativeToSurfaceXY();
-
-    /**
-     * The drag surface to move bubbles to during a drag, or null if none should
-     * be used.  Block dragging and bubble dragging use the same surface.
-     * @type {BlockDragSurfaceSvg}
-     * @private
-     */
-    this.dragSurface_ =
-        svgMath.is3dSupported() && !!workspace.getBlockDragSurface() ?
-        workspace.getBlockDragSurface() :
-        null;
-  }
-
-  /**
-   * Sever all links from this object.
-   * @package
-   * @suppress {checkTypes}
-   */
-  dispose() {
-    this.draggingBubble_ = null;
-    this.workspace_ = null;
-    this.dragSurface_ = null;
-  }
-
-  /**
-   * Start dragging a bubble.  This includes moving it to the drag surface.
-   * @package
-   */
-  startBubbleDrag() {
-    if (!eventUtils.getGroup()) {
-      eventUtils.setGroup(true);
-    }
-
-    this.workspace_.setResizesEnabled(false);
-    this.draggingBubble_.setAutoLayout(false);
-    if (this.dragSurface_) {
-      this.moveToDragSurface_();
-    }
-
-    this.draggingBubble_.setDragging && this.draggingBubble_.setDragging(true);
-  }
-
-  /**
-   * Execute a step of bubble dragging, based on the given event.  Update the
-   * display accordingly.
-   * @param {!Event} e The most recent move event.
-   * @param {!Coordinate} currentDragDeltaXY How far the pointer has
-   *     moved from the position at the start of the drag, in pixel units.
-   * @package
-   */
-  dragBubble(e, currentDragDeltaXY) {
-    const delta = this.pixelsToWorkspaceUnits_(currentDragDeltaXY);
-    const newLoc = Coordinate.sum(this.startXY_, delta);
-    this.draggingBubble_.moveDuringDrag(this.dragSurface_, newLoc);
-
-    const oldDragTarget = this.dragTarget_;
-    this.dragTarget_ = this.workspace_.getDragTarget(e);
-
-    const oldWouldDeleteBubble = this.wouldDeleteBubble_;
-    this.wouldDeleteBubble_ = this.shouldDelete_(this.dragTarget_);
-    if (oldWouldDeleteBubble !== this.wouldDeleteBubble_) {
-      // Prevent unnecessary add/remove class calls.
-      this.updateCursorDuringBubbleDrag_();
-    }
-
-    // Call drag enter/exit/over after wouldDeleteBlock is called in
-    // shouldDelete_
-    if (this.dragTarget_ !== oldDragTarget) {
-      oldDragTarget && oldDragTarget.onDragExit(this.draggingBubble_);
-      this.dragTarget_ && this.dragTarget_.onDragEnter(this.draggingBubble_);
-    }
-    this.dragTarget_ && this.dragTarget_.onDragOver(this.draggingBubble_);
-  }
-
-  /**
-   * Whether ending the drag would delete the bubble.
-   * @param {?IDragTarget} dragTarget The drag target that the bubblee is
-   *     currently over.
-   * @return {boolean} Whether dropping the bubble immediately would delete the
-   *    block.
-   * @private
-   */
-  shouldDelete_(dragTarget) {
-    if (dragTarget) {
-      const componentManager = this.workspace_.getComponentManager();
-      const isDeleteArea = componentManager.hasCapability(
-          dragTarget.id, ComponentManager.Capability.DELETE_AREA);
-      if (isDeleteArea) {
-        return (/** @type {!IDeleteArea} */ (dragTarget))
-            .wouldDelete(this.draggingBubble_, false);
-      }
-    }
-    return false;
-  }
-
-  /**
-   * Update the cursor (and possibly the trash can lid) to reflect whether the
-   * dragging bubble would be deleted if released immediately.
-   * @private
-   */
-  updateCursorDuringBubbleDrag_() {
-    this.draggingBubble_.setDeleteStyle(this.wouldDeleteBubble_);
-  }
-
-  /**
-   * Finish a bubble drag and put the bubble back on the workspace.
-   * @param {!Event} e The mouseup/touchend event.
-   * @param {!Coordinate} currentDragDeltaXY How far the pointer has
-   *     moved from the position at the start of the drag, in pixel units.
-   * @package
-   */
-  endBubbleDrag(e, currentDragDeltaXY) {
-    // Make sure internal state is fresh.
-    this.dragBubble(e, currentDragDeltaXY);
-
-    const preventMove = this.dragTarget_ &&
-        this.dragTarget_.shouldPreventMove(this.draggingBubble_);
-    let newLoc;
-    if (preventMove) {
-      newLoc = this.startXY_;
-    } else {
-      const delta = this.pixelsToWorkspaceUnits_(currentDragDeltaXY);
-      newLoc = Coordinate.sum(this.startXY_, delta);
-    }
-    // Move the bubble to its final location.
-    this.draggingBubble_.moveTo(newLoc.x, newLoc.y);
-
-    if (this.dragTarget_) {
-      this.dragTarget_.onDrop(this.draggingBubble_);
-    }
-
-    if (this.wouldDeleteBubble_) {
-      // Fire a move event, so we know where to go back to for an undo.
-      this.fireMoveEvent_();
-      this.draggingBubble_.dispose(false, true);
-    } else {
-      // Put everything back onto the bubble canvas.
-      if (this.dragSurface_) {
-        this.dragSurface_.clearAndHide(this.workspace_.getBubbleCanvas());
-      }
-      if (this.draggingBubble_.setDragging) {
-        this.draggingBubble_.setDragging(false);
-      }
-      this.fireMoveEvent_();
-    }
-    this.workspace_.setResizesEnabled(true);
-
-    eventUtils.setGroup(false);
-  }
-
-  /**
-   * Fire a move event at the end of a bubble drag.
-   * @private
-   */
-  fireMoveEvent_() {
-    if (this.draggingBubble_.isComment) {
-      // TODO (adodson): Resolve build errors when requiring
-      // WorkspaceCommentSvg.
-      const event = /** @type {!CommentMove} */
-          (new (eventUtils.get(eventUtils.COMMENT_MOVE))(
-              /** @type {!WorkspaceCommentSvg} */ (this.draggingBubble_)));
-      event.setOldCoordinate(this.startXY_);
-      event.recordNew();
-      eventUtils.fire(event);
-    }
-    // TODO (fenichel): move events for comments.
-    return;
-  }
-
-  /**
-   * Convert a coordinate object from pixels to workspace units, including a
-   * correction for mutator workspaces.
-   * This function does not consider differing origins.  It simply scales the
-   * input's x and y values.
-   * @param {!Coordinate} pixelCoord A coordinate with x and y
-   *     values in CSS pixel units.
-   * @return {!Coordinate} The input coordinate divided by the
-   *     workspace scale.
-   * @private
-   */
-  pixelsToWorkspaceUnits_(pixelCoord) {
-    const result = new Coordinate(
-        pixelCoord.x / this.workspace_.scale,
-        pixelCoord.y / this.workspace_.scale);
-    if (this.workspace_.isMutator) {
-      // If we're in a mutator, its scale is always 1, purely because of some
-      // oddities in our rendering optimizations.  The actual scale is the same
-      // as the scale on the parent workspace. Fix that for dragging.
-      const mainScale = this.workspace_.options.parentWorkspace.scale;
-      result.scale(1 / mainScale);
-    }
-    return result;
-  }
-
-  /**
-   * Move the bubble onto the drag surface at the beginning of a drag.  Move the
-   * drag surface to preserve the apparent location of the bubble.
-   * @private
-   */
-  moveToDragSurface_() {
-    this.draggingBubble_.moveTo(0, 0);
-    this.dragSurface_.translateSurface(this.startXY_.x, this.startXY_.y);
-    // Execute the move on the top-level SVG component.
-    this.dragSurface_.setBlocksAndShow(this.draggingBubble_.getSvgRoot());
-  }
-};
-
-exports.BubbleDragger = BubbleDragger;

package/core/clipboard.js

@@ -1,80 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Blockly's internal clipboard for managing copy-paste.
- */
-'use strict';
-
-/**
- * Blockly's internal clipboard for managing copy-paste.
- * @namespace Blockly.clipboard
- */
-goog.module('Blockly.clipboard');
-
-/* eslint-disable-next-line no-unused-vars */
-const {ICopyable} = goog.requireType('Blockly.ICopyable');
-
-
-/**
- * Metadata about the object that is currently on the clipboard.
- * @type {?ICopyable.CopyData}
- */
-let copyData = null;
-
-/**
- * Copy a block or workspace comment onto the local clipboard.
- * @param {!ICopyable} toCopy Block or Workspace Comment to be copied.
- * @alias Blockly.clipboard.copy
- * @package
- */
-const copy = function(toCopy) {
-  copyData = toCopy.toCopyData();
-};
-exports.copy = copy;
-
-/**
- * Paste a block or workspace comment on to the main workspace.
- * @return {!ICopyable|null} The pasted thing if the paste
- *     was successful, null otherwise.
- * @alias Blockly.clipboard.paste
- * @package
- */
-const paste = function() {
-  if (!copyData) {
-    return null;
-  }
-  // Pasting always pastes to the main workspace, even if the copy
-  // started in a flyout workspace.
-  let workspace = copyData.source;
-  if (workspace.isFlyout) {
-    workspace = workspace.targetWorkspace;
-  }
-  if (copyData.typeCounts &&
-      workspace.isCapacityAvailable(copyData.typeCounts)) {
-    return workspace.paste(copyData.saveInfo);
-  }
-  return null;
-};
-exports.paste = paste;
-
-/**
- * Duplicate this block and its children, or a workspace comment.
- * @param {!ICopyable} toDuplicate Block or Workspace Comment to be
- *     duplicated.
- * @return {!ICopyable|null} The block or workspace comment that was duplicated,
- *     or null if the duplication failed.
- * @alias Blockly.clipboard.duplicate
- * @package
- */
-const duplicate = function(toDuplicate) {
-  const oldCopyData = copyData;
-  copy(toDuplicate);
-  const pastedThing = toDuplicate.workspace.paste(copyData.saveInfo);
-  copyData = oldCopyData;
-  return pastedThing;
-};
-exports.duplicate = duplicate;

package/core/component_manager.js

@@ -1,263 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Manager for all items registered with the workspace.
- */
-
-'use strict';
-
-/**
- * Manager for all items registered with the workspace.
- * @class
- */
-goog.module('Blockly.ComponentManager');
-
-const arrayUtils = goog.require('Blockly.utils.array');
-/* eslint-disable-next-line no-unused-vars */
-const {IAutoHideable} = goog.requireType('Blockly.IAutoHideable');
-/* eslint-disable-next-line no-unused-vars */
-const {IComponent} = goog.requireType('Blockly.IComponent');
-/* eslint-disable-next-line no-unused-vars */
-const {IDeleteArea} = goog.requireType('Blockly.IDeleteArea');
-/* eslint-disable-next-line no-unused-vars */
-const {IDragTarget} = goog.requireType('Blockly.IDragTarget');
-/* eslint-disable-next-line no-unused-vars */
-const {IPositionable} = goog.requireType('Blockly.IPositionable');
-
-
-/**
- * Manager for all items registered with the workspace.
- * @alias Blockly.ComponentManager
- */
-class ComponentManager {
-  /**
-   * Creates a new ComponentManager instance.
-   */
-  constructor() {
-    /**
-     * A map of the components registered with the workspace, mapped to id.
-     * @type {!Object<string, !ComponentManager.ComponentDatum>}
-     * @private
-     */
-    this.componentData_ = Object.create(null);
-
-    /**
-     * A map of capabilities to component IDs.
-     * @type {!Object<string, !Array<string>>}
-     * @private
-     */
-    this.capabilityToComponentIds_ = Object.create(null);
-  }
-
-  /**
-   * Adds a component.
-   * @param {!ComponentManager.ComponentDatum} componentInfo The data for
-   *   the component to register.
-   * @param {boolean=} opt_allowOverrides True to prevent an error when
-   *     overriding an already registered item.
-   */
-  addComponent(componentInfo, opt_allowOverrides) {
-    // Don't throw an error if opt_allowOverrides is true.
-    const id = componentInfo.component.id;
-    if (!opt_allowOverrides && this.componentData_[id]) {
-      throw Error(
-          'Plugin "' + id + '" with capabilities "' +
-          this.componentData_[id].capabilities + '" already added.');
-    }
-    this.componentData_[id] = componentInfo;
-    const stringCapabilities = [];
-    for (let i = 0; i < componentInfo.capabilities.length; i++) {
-      const capability = String(componentInfo.capabilities[i]).toLowerCase();
-      stringCapabilities.push(capability);
-      if (this.capabilityToComponentIds_[capability] === undefined) {
-        this.capabilityToComponentIds_[capability] = [id];
-      } else {
-        this.capabilityToComponentIds_[capability].push(id);
-      }
-    }
-    this.componentData_[id].capabilities = stringCapabilities;
-  }
-
-  /**
-   * Removes a component.
-   * @param {string} id The ID of the component to remove.
-   */
-  removeComponent(id) {
-    const componentInfo = this.componentData_[id];
-    if (!componentInfo) {
-      return;
-    }
-    for (let i = 0; i < componentInfo.capabilities.length; i++) {
-      const capability = String(componentInfo.capabilities[i]).toLowerCase();
-      arrayUtils.removeElem(this.capabilityToComponentIds_[capability], id);
-    }
-    delete this.componentData_[id];
-  }
-
-  /**
-   * Adds a capability to a existing registered component.
-   * @param {string} id The ID of the component to add the capability to.
-   * @param {string|!ComponentManager.Capability<T>} capability The
-   *     capability to add.
-   * @template T
-   */
-  addCapability(id, capability) {
-    if (!this.getComponent(id)) {
-      throw Error(
-          'Cannot add capability, "' + capability + '". Plugin "' + id +
-          '" has not been added to the ComponentManager');
-    }
-    if (this.hasCapability(id, capability)) {
-      console.warn(
-          'Plugin "' + id + 'already has capability "' + capability + '"');
-      return;
-    }
-    capability = String(capability).toLowerCase();
-    this.componentData_[id].capabilities.push(capability);
-    this.capabilityToComponentIds_[capability].push(id);
-  }
-
-  /**
-   * Removes a capability from an existing registered component.
-   * @param {string} id The ID of the component to remove the capability from.
-   * @param {string|!ComponentManager.Capability<T>} capability The
-   *     capability to remove.
-   * @template T
-   */
-  removeCapability(id, capability) {
-    if (!this.getComponent(id)) {
-      throw Error(
-          'Cannot remove capability, "' + capability + '". Plugin "' + id +
-          '" has not been added to the ComponentManager');
-    }
-    if (!this.hasCapability(id, capability)) {
-      console.warn(
-          'Plugin "' + id + 'doesn\'t have capability "' + capability +
-          '" to remove');
-      return;
-    }
-    capability = String(capability).toLowerCase();
-    arrayUtils.removeElem(this.componentData_[id].capabilities, capability);
-    arrayUtils.removeElem(this.capabilityToComponentIds_[capability], id);
-  }
-
-  /**
-   * Returns whether the component with this id has the specified capability.
-   * @param {string} id The ID of the component to check.
-   * @param {string|!ComponentManager.Capability<T>} capability The
-   *     capability to check for.
-   * @return {boolean} Whether the component has the capability.
-   * @template T
-   */
-  hasCapability(id, capability) {
-    capability = String(capability).toLowerCase();
-    return this.componentData_[id].capabilities.indexOf(capability) !== -1;
-  }
-
-  /**
-   * Gets the component with the given ID.
-   * @param {string} id The ID of the component to get.
-   * @return {!IComponent|undefined} The component with the given name
-   *    or undefined if not found.
-   */
-  getComponent(id) {
-    return this.componentData_[id] && this.componentData_[id].component;
-  }
-
-  /**
-   * Gets all the components with the specified capability.
-   * @param {string|!ComponentManager.Capability<T>
-   *   } capability The capability of the component.
-   * @param {boolean} sorted Whether to return list ordered by weights.
-   * @return {!Array<T>} The components that match the specified capability.
-   * @template T
-   */
-  getComponents(capability, sorted) {
-    capability = String(capability).toLowerCase();
-    const componentIds = this.capabilityToComponentIds_[capability];
-    if (!componentIds) {
-      return [];
-    }
-    const components = [];
-    if (sorted) {
-      const componentDataList = [];
-      const componentData = this.componentData_;
-      componentIds.forEach(function(id) {
-        componentDataList.push(componentData[id]);
-      });
-      componentDataList.sort(function(a, b) {
-        return a.weight - b.weight;
-      });
-      componentDataList.forEach(function(ComponentDatum) {
-        components.push(ComponentDatum.component);
-      });
-    } else {
-      const componentData = this.componentData_;
-      componentIds.forEach(function(id) {
-        components.push(componentData[id].component);
-      });
-    }
-    return components;
-  }
-}
-
-/**
- * An object storing component information.
- * @typedef {{
- *    component: !IComponent,
- *    capabilities: (
- *     !Array<string|!ComponentManager.Capability<!IComponent>>
- *       ),
- *    weight: number
- *  }}
- */
-ComponentManager.ComponentDatum;
-
-/**
- * A name with the capability of the element stored in the generic.
- * @template T
- * @alias Blockly.ComponentManager.Capability
- */
-ComponentManager.Capability = class {
-  /**
-   * @param {string} name The name of the component capability.
-   */
-  constructor(name) {
-    /**
-     * @type {string}
-     * @private
-     */
-    this.name_ = name;
-  }
-
-  /**
-   * Returns the name of the capability.
-   * @return {string} The name.
-   * @override
-   */
-  toString() {
-    return this.name_;
-  }
-};
-
-/** @type {!ComponentManager.Capability<!IPositionable>} */
-ComponentManager.Capability.POSITIONABLE =
-    new ComponentManager.Capability('positionable');
-
-/** @type {!ComponentManager.Capability<!IDragTarget>} */
-ComponentManager.Capability.DRAG_TARGET =
-    new ComponentManager.Capability('drag_target');
-
-/** @type {!ComponentManager.Capability<!IDeleteArea>} */
-ComponentManager.Capability.DELETE_AREA =
-    new ComponentManager.Capability('delete_area');
-
-/** @type {!ComponentManager.Capability<!IAutoHideable>} */
-ComponentManager.Capability.AUTOHIDEABLE =
-    new ComponentManager.Capability('autohideable');
-
-exports.ComponentManager = ComponentManager;