blockly 8.20220331.0-beta.0 → 9.0.0-beta.1

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/bump_objects.js

@@ -1,180 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Utilities for bumping objects back into worksapce bounds.
- */
-'use strict';
-
-/**
- * Utilities for bumping objects back into worksapce bounds.
- * @namespace Blockly.bumpObjects
- */
-goog.module('Blockly.bumpObjects');
-
-const eventUtils = goog.require('Blockly.Events.utils');
-const mathUtils = goog.require('Blockly.utils.math');
-/* eslint-disable-next-line no-unused-vars */
-const {Abstract} = goog.requireType('Blockly.Events.Abstract');
-/* eslint-disable-next-line no-unused-vars */
-const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {IBoundedElement} = goog.requireType('Blockly.IBoundedElement');
-/* eslint-disable-next-line no-unused-vars */
-const {MetricsManager} = goog.requireType('Blockly.MetricsManager');
-/* eslint-disable-next-line no-unused-vars */
-const {ViewportChange} = goog.requireType('Blockly.Events.ViewportChange');
-/* 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');
-
-
-/**
- * Bumps the given object that has passed out of bounds.
- * @param {!WorkspaceSvg} workspace The workspace containing the object.
- * @param {!MetricsManager.ContainerRegion} scrollMetrics Scroll metrics
- *    in workspace coordinates.
- * @param {!IBoundedElement} object The object to bump.
- * @return {boolean} True if block was bumped.
- * @alias Blockly.bumpObjects.bumpIntoBounds
- */
-const bumpObjectIntoBounds = function(workspace, scrollMetrics, object) {
-  // Compute new top/left position for object.
-  const objectMetrics = object.getBoundingRectangle();
-  const height = objectMetrics.bottom - objectMetrics.top;
-  const width = objectMetrics.right - objectMetrics.left;
-
-  const topClamp = scrollMetrics.top;
-  const scrollMetricsBottom = scrollMetrics.top + scrollMetrics.height;
-  const bottomClamp = scrollMetricsBottom - height;
-  // If the object is taller than the workspace we want to
-  // top-align the block
-  const newYPosition =
-      mathUtils.clamp(topClamp, objectMetrics.top, bottomClamp);
-  const deltaY = newYPosition - objectMetrics.top;
-
-  // Note: Even in RTL mode the "anchor" of the object is the
-  // top-left corner of the object.
-  let leftClamp = scrollMetrics.left;
-  const scrollMetricsRight = scrollMetrics.left + scrollMetrics.width;
-  let rightClamp = scrollMetricsRight - width;
-  if (workspace.RTL) {
-    // If the object is wider than the workspace and we're in RTL
-    // mode we want to right-align the block, which means setting
-    // the left clamp to match.
-    leftClamp = Math.min(rightClamp, leftClamp);
-  } else {
-    // If the object is wider than the workspace and we're in LTR
-    // mode we want to left-align the block, which means setting
-    // the right clamp to match.
-    rightClamp = Math.max(leftClamp, rightClamp);
-  }
-  const newXPosition =
-      mathUtils.clamp(leftClamp, objectMetrics.left, rightClamp);
-  const deltaX = newXPosition - objectMetrics.left;
-
-  if (deltaX || deltaY) {
-    object.moveBy(deltaX, deltaY);
-    return true;
-  }
-  return false;
-};
-exports.bumpIntoBounds = bumpObjectIntoBounds;
-
-/**
- * Creates a handler for bumping objects when they cross fixed bounds.
- * @param {!WorkspaceSvg} workspace The workspace to handle.
- * @return {function(Abstract)} The event handler.
- * @alias Blockly.bumpObjects.bumpIntoBoundsHandler
- */
-const bumpIntoBoundsHandler = function(workspace) {
-  return function(e) {
-    const metricsManager = workspace.getMetricsManager();
-    if (!metricsManager.hasFixedEdges() || workspace.isDragging()) {
-      return;
-    }
-
-    if (eventUtils.BUMP_EVENTS.indexOf(e.type) !== -1) {
-      const scrollMetricsInWsCoords = metricsManager.getScrollMetrics(true);
-
-      // Triggered by move/create event
-      const object = extractObjectFromEvent(workspace, e);
-      if (!object) {
-        return;
-      }
-      // Handle undo.
-      const oldGroup = eventUtils.getGroup();
-      eventUtils.setGroup(e.group);
-
-      const wasBumped = bumpObjectIntoBounds(
-          workspace, scrollMetricsInWsCoords,
-          /** @type {!IBoundedElement} */ (object));
-
-      if (wasBumped && !e.group) {
-        console.warn(
-            'Moved object in bounds but there was no' +
-            ' event group. This may break undo.');
-      }
-      if (oldGroup !== null) {
-        eventUtils.setGroup(oldGroup);
-      }
-    } else if (e.type === eventUtils.VIEWPORT_CHANGE) {
-      const viewportEvent = /** @type {!ViewportChange} */ (e);
-      if (viewportEvent.scale > viewportEvent.oldScale) {
-        bumpTopObjectsIntoBounds(workspace);
-      }
-    }
-  };
-};
-exports.bumpIntoBoundsHandler = bumpIntoBoundsHandler;
-
-/**
- * Extracts the object from the given event.
- * @param {!WorkspaceSvg} workspace The workspace the event originated
- *    from.
- * @param {!eventUtils.BumpEvent} e An event containing an object.
- * @return {?BlockSvg|?WorkspaceCommentSvg} The extracted
- *    object.
- */
-const extractObjectFromEvent = function(workspace, e) {
-  let object = null;
-  switch (e.type) {
-    case eventUtils.BLOCK_CREATE:
-    case eventUtils.BLOCK_MOVE:
-      object = workspace.getBlockById(e.blockId);
-      if (object) {
-        object = object.getRootBlock();
-      }
-      break;
-    case eventUtils.COMMENT_CREATE:
-    case eventUtils.COMMENT_MOVE:
-      object = (
-          /** @type {?WorkspaceCommentSvg} */
-          (workspace.getCommentById(e.commentId)));
-      break;
-  }
-  return object;
-};
-
-/**
- * Bumps the top objects in the given workspace into bounds.
- * @param {!WorkspaceSvg} workspace The workspace.
- * @alias Blockly.bumpObjects.bumpTopObjectsIntoBounds
- */
-const bumpTopObjectsIntoBounds = function(workspace) {
-  const metricsManager = workspace.getMetricsManager();
-  if (!metricsManager.hasFixedEdges() || workspace.isDragging()) {
-    return;
-  }
-
-  const scrollMetricsInWsCoords = metricsManager.getScrollMetrics(true);
-  const topBlocks = workspace.getTopBoundedElements();
-  for (let i = 0, block; (block = topBlocks[i]); i++) {
-    bumpObjectIntoBounds(workspace, scrollMetricsInWsCoords, block);
-  }
-};
-exports.bumpTopObjectsIntoBounds = bumpTopObjectsIntoBounds;

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;