blockly 8.0.5 → 9.0.0-beta.0

package/core/icon.js

@@ -1,225 +0,0 @@
-/**
- * @license
- * Copyright 2013 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Object representing an icon on a block.
- */
-'use strict';
-
-/**
- * Object representing an icon on a block.
- * @class
- */
-goog.module('Blockly.Icon');
-
-const browserEvents = goog.require('Blockly.browserEvents');
-const dom = goog.require('Blockly.utils.dom');
-const svgMath = goog.require('Blockly.utils.svgMath');
-/* eslint-disable-next-line no-unused-vars */
-const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {Bubble} = goog.requireType('Blockly.Bubble');
-const {Coordinate} = goog.require('Blockly.utils.Coordinate');
-const {Size} = goog.require('Blockly.utils.Size');
-const {Svg} = goog.require('Blockly.utils.Svg');
-
-
-/**
- * Class for an icon.
- * @abstract
- * @alias Blockly.Icon
- */
-class Icon {
-  /**
-   * @param {BlockSvg} block The block associated with this icon.
-   */
-  constructor(block) {
-    /**
-     * The block this icon is attached to.
-     * @type {BlockSvg}
-     * @protected
-     */
-    this.block_ = block;
-
-    /**
-     * The icon SVG group.
-     * @type {?SVGGElement}
-     */
-    this.iconGroup_ = null;
-
-    /**
-     * Whether this icon gets hidden when the block is collapsed.
-     * @type {boolean}
-     */
-    this.collapseHidden = true;
-
-    /**
-     * Height and width of icons.
-     * @const
-     */
-    this.SIZE = 17;
-
-    /**
-     * Bubble UI (if visible).
-     * @type {?Bubble}
-     * @protected
-     */
-    this.bubble_ = null;
-
-    /**
-     * Absolute coordinate of icon's center.
-     * @type {?Coordinate}
-     * @protected
-     */
-    this.iconXY_ = null;
-  }
-
-  /**
-   * Create the icon on the block.
-   */
-  createIcon() {
-    if (this.iconGroup_) {
-      // Icon already exists.
-      return;
-    }
-    /* Here's the markup that will be generated:
-    <g class="blocklyIconGroup">
-      ...
-    </g>
-    */
-    this.iconGroup_ =
-        dom.createSvgElement(Svg.G, {'class': 'blocklyIconGroup'}, null);
-    if (this.block_.isInFlyout) {
-      dom.addClass(
-          /** @type {!Element} */ (this.iconGroup_),
-          'blocklyIconGroupReadonly');
-    }
-    this.drawIcon_(this.iconGroup_);
-
-    this.block_.getSvgRoot().appendChild(this.iconGroup_);
-    browserEvents.conditionalBind(
-        this.iconGroup_, 'mouseup', this, this.iconClick_);
-    this.updateEditable();
-  }
-
-  /**
-   * Dispose of this icon.
-   */
-  dispose() {
-    // Dispose of and unlink the icon.
-    dom.removeNode(this.iconGroup_);
-    this.iconGroup_ = null;
-    // Dispose of and unlink the bubble.
-    this.setVisible(false);
-    this.block_ = null;
-  }
-
-  /**
-   * Add or remove the UI indicating if this icon may be clicked or not.
-   */
-  updateEditable() {
-    // No-op on the base class.
-  }
-
-  /**
-   * Is the associated bubble visible?
-   * @return {boolean} True if the bubble is visible.
-   */
-  isVisible() {
-    return !!this.bubble_;
-  }
-
-  /**
-   * Clicking on the icon toggles if the bubble is visible.
-   * @param {!Event} e Mouse click event.
-   * @protected
-   */
-  iconClick_(e) {
-    if (this.block_.workspace.isDragging()) {
-      // Drag operation is concluding.  Don't open the editor.
-      return;
-    }
-    if (!this.block_.isInFlyout && !browserEvents.isRightButton(e)) {
-      this.setVisible(!this.isVisible());
-    }
-  }
-
-  /**
-   * Change the colour of the associated bubble to match its block.
-   */
-  applyColour() {
-    if (this.isVisible()) {
-      this.bubble_.setColour(this.block_.style.colourPrimary);
-    }
-  }
-
-  /**
-   * Notification that the icon has moved.  Update the arrow accordingly.
-   * @param {!Coordinate} xy Absolute location in workspace coordinates.
-   */
-  setIconLocation(xy) {
-    this.iconXY_ = xy;
-    if (this.isVisible()) {
-      this.bubble_.setAnchorLocation(xy);
-    }
-  }
-
-  /**
-   * Notification that the icon has moved, but we don't really know where.
-   * Recompute the icon's location from scratch.
-   */
-  computeIconLocation() {
-    // Find coordinates for the centre of the icon and update the arrow.
-    const blockXY = this.block_.getRelativeToSurfaceXY();
-    const iconXY = svgMath.getRelativeXY(
-        /** @type {!SVGElement} */ (this.iconGroup_));
-    const newXY = new Coordinate(
-        blockXY.x + iconXY.x + this.SIZE / 2,
-        blockXY.y + iconXY.y + this.SIZE / 2);
-    if (!Coordinate.equals(this.getIconLocation(), newXY)) {
-      this.setIconLocation(newXY);
-    }
-  }
-
-  /**
-   * Returns the center of the block's icon relative to the surface.
-   * @return {?Coordinate} Object with x and y properties in
-   *     workspace coordinates.
-   */
-  getIconLocation() {
-    return this.iconXY_;
-  }
-
-  /**
-   * Get the size of the icon as used for rendering.
-   * This differs from the actual size of the icon, because it bulges slightly
-   * out of its row rather than increasing the height of its row.
-   * @return {!Size} Height and width.
-   */
-  getCorrectedSize() {
-    // TODO (#2562): Remove getCorrectedSize.
-    return new Size(this.SIZE, this.SIZE - 2);
-  }
-
-  /**
-   * Draw the icon.
-   * @param {!Element} _group The icon group.
-   * @protected
-   */
-  drawIcon_(_group) {
-    // No-op on base class.
-  }
-
-  /**
-   * Show or hide the icon.
-   * @param {boolean} _visible True if the icon should be visible.
-   */
-  setVisible(_visible) {
-    // No-op on base class
-  }
-}
-
-exports.Icon = Icon;

package/core/input.js

@@ -1,335 +0,0 @@
-/**
- * @license
- * Copyright 2012 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Object representing an input (value, statement, or dummy).
- */
-'use strict';
-
-/**
- * Object representing an input (value, statement, or dummy).
- * @class
- */
-goog.module('Blockly.Input');
-
-const fieldRegistry = goog.require('Blockly.fieldRegistry');
-/* eslint-disable-next-line no-unused-vars */
-const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
-/* eslint-disable-next-line no-unused-vars */
-const {Connection} = goog.requireType('Blockly.Connection');
-/* eslint-disable-next-line no-unused-vars */
-const {Field} = goog.requireType('Blockly.Field');
-/* eslint-disable-next-line no-unused-vars */
-const {RenderedConnection} = goog.requireType('Blockly.RenderedConnection');
-const {inputTypes} = goog.require('Blockly.inputTypes');
-/** @suppress {extraRequire} */
-goog.require('Blockly.FieldLabel');
-
-
-/**
- * Class for an input with an optional field.
- * @alias Blockly.Input
- */
-class Input {
-  /**
-   * @param {number} type The type of the input.
-   * @param {string} name Language-neutral identifier which may used to find
-   *     this input again.
-   * @param {!Block} block The block containing this input.
-   * @param {Connection} connection Optional connection for this input.
-   */
-  constructor(type, name, block, connection) {
-    if (type !== inputTypes.DUMMY && !name) {
-      throw Error(
-          'Value inputs and statement inputs must have non-empty name.');
-    }
-    /** @type {number} */
-    this.type = type;
-    /** @type {string} */
-    this.name = name;
-    /**
-     * @type {!Block}
-     * @private
-     */
-    this.sourceBlock_ = block;
-    /** @type {Connection} */
-    this.connection = connection;
-    /** @type {!Array<!Field>} */
-    this.fieldRow = [];
-
-    /**
-     * Alignment of input's fields (left, right or centre).
-     * @type {number}
-     */
-    this.align = Align.LEFT;
-
-    /**
-     * Is the input visible?
-     * @type {boolean}
-     * @private
-     */
-    this.visible_ = true;
-  }
-
-  /**
-   * Get the source block for this input.
-   * @return {?Block} The source block, or null if there is none.
-   */
-  getSourceBlock() {
-    return this.sourceBlock_;
-  }
-
-  /**
-   * Add a field (or label from string), and all prefix and suffix fields, to
-   * the end of the input's field row.
-   * @param {string|!Field} field Something to add as a field.
-   * @param {string=} opt_name Language-neutral identifier which may used to
-   *     find this field again.  Should be unique to the host block.
-   * @return {!Input} The input being append to (to allow chaining).
-   */
-  appendField(field, opt_name) {
-    this.insertFieldAt(this.fieldRow.length, field, opt_name);
-    return this;
-  }
-
-  /**
-   * Inserts a field (or label from string), and all prefix and suffix fields,
-   * at the location of the input's field row.
-   * @param {number} index The index at which to insert field.
-   * @param {string|!Field} field Something to add as a field.
-   * @param {string=} opt_name Language-neutral identifier which may used to
-   *     find this field again.  Should be unique to the host block.
-   * @return {number} The index following the last inserted field.
-   */
-  insertFieldAt(index, field, opt_name) {
-    if (index < 0 || index > this.fieldRow.length) {
-      throw Error('index ' + index + ' out of bounds.');
-    }
-    // Falsy field values don't generate a field, unless the field is an empty
-    // string and named.
-    if (!field && !(field === '' && opt_name)) {
-      return index;
-    }
-
-    // Generate a FieldLabel when given a plain text field.
-    if (typeof field === 'string') {
-      field = /** @type {!Field} **/ (fieldRegistry.fromJson({
-        'type': 'field_label',
-        'text': field,
-      }));
-    }
-
-    field.setSourceBlock(this.sourceBlock_);
-    if (this.sourceBlock_.rendered) {
-      field.init();
-      field.applyColour();
-    }
-    field.name = opt_name;
-    field.setVisible(this.isVisible());
-
-    if (field.prefixField) {
-      // Add any prefix.
-      index = this.insertFieldAt(index, field.prefixField);
-    }
-    // Add the field to the field row.
-    this.fieldRow.splice(index, 0, field);
-    index++;
-    if (field.suffixField) {
-      // Add any suffix.
-      index = this.insertFieldAt(index, field.suffixField);
-    }
-
-    if (this.sourceBlock_.rendered) {
-      this.sourceBlock_ = /** @type {!BlockSvg} */ (this.sourceBlock_);
-      this.sourceBlock_.render();
-      // Adding a field will cause the block to change shape.
-      this.sourceBlock_.bumpNeighbours();
-    }
-    return index;
-  }
-
-  /**
-   * Remove a field from this input.
-   * @param {string} name The name of the field.
-   * @param {boolean=} opt_quiet True to prevent an error if field is not
-   *     present.
-   * @return {boolean} True if operation succeeds, false if field is not present
-   *     and opt_quiet is true.
-   * @throws {Error} if the field is not present and opt_quiet is false.
-   */
-  removeField(name, opt_quiet) {
-    for (let i = 0, field; (field = this.fieldRow[i]); i++) {
-      if (field.name === name) {
-        field.dispose();
-        this.fieldRow.splice(i, 1);
-        if (this.sourceBlock_.rendered) {
-          this.sourceBlock_ = /** @type {!BlockSvg} */ (this.sourceBlock_);
-          this.sourceBlock_.render();
-          // Removing a field will cause the block to change shape.
-          this.sourceBlock_.bumpNeighbours();
-        }
-        return true;
-      }
-    }
-    if (opt_quiet) {
-      return false;
-    }
-    throw Error('Field "' + name + '" not found.');
-  }
-
-  /**
-   * Gets whether this input is visible or not.
-   * @return {boolean} True if visible.
-   */
-  isVisible() {
-    return this.visible_;
-  }
-
-  /**
-   * Sets whether this input is visible or not.
-   * Should only be used to collapse/uncollapse a block.
-   * @param {boolean} visible True if visible.
-   * @return {!Array<!BlockSvg>} List of blocks to render.
-   * @package
-   */
-  setVisible(visible) {
-    // Note: Currently there are only unit tests for block.setCollapsed()
-    // because this function is package. If this function goes back to being a
-    // public API tests (lots of tests) should be added.
-    let renderList = [];
-    if (this.visible_ === visible) {
-      return renderList;
-    }
-    this.visible_ = visible;
-
-    for (let y = 0, field; (field = this.fieldRow[y]); y++) {
-      field.setVisible(visible);
-    }
-    if (this.connection) {
-      this.connection =
-          /** @type {!RenderedConnection} */ (this.connection);
-      // Has a connection.
-      if (visible) {
-        renderList = this.connection.startTrackingAll();
-      } else {
-        this.connection.stopTrackingAll();
-      }
-      const child = this.connection.targetBlock();
-      if (child) {
-        child.getSvgRoot().style.display = visible ? 'block' : 'none';
-      }
-    }
-    return renderList;
-  }
-
-  /**
-   * Mark all fields on this input as dirty.
-   * @package
-   */
-  markDirty() {
-    for (let y = 0, field; (field = this.fieldRow[y]); y++) {
-      field.markDirty();
-    }
-  }
-
-  /**
-   * Change a connection's compatibility.
-   * @param {string|Array<string>|null} check Compatible value type or
-   *     list of value types.  Null if all types are compatible.
-   * @return {!Input} The input being modified (to allow chaining).
-   */
-  setCheck(check) {
-    if (!this.connection) {
-      throw Error('This input does not have a connection.');
-    }
-    this.connection.setCheck(check);
-    return this;
-  }
-
-  /**
-   * Change the alignment of the connection's field(s).
-   * @param {number} align One of the values of Align
-   *   In RTL mode directions are reversed, and Align.RIGHT aligns to the left.
-   * @return {!Input} The input being modified (to allow chaining).
-   */
-  setAlign(align) {
-    this.align = align;
-    if (this.sourceBlock_.rendered) {
-      this.sourceBlock_ = /** @type {!BlockSvg} */ (this.sourceBlock_);
-      this.sourceBlock_.render();
-    }
-    return this;
-  }
-
-  /**
-   * Changes the connection's shadow block.
-   * @param {?Element} shadow DOM representation of a block or null.
-   * @return {!Input} The input being modified (to allow chaining).
-   */
-  setShadowDom(shadow) {
-    if (!this.connection) {
-      throw Error('This input does not have a connection.');
-    }
-    this.connection.setShadowDom(shadow);
-    return this;
-  }
-
-  /**
-   * Returns the XML representation of the connection's shadow block.
-   * @return {?Element} Shadow DOM representation of a block or null.
-   */
-  getShadowDom() {
-    if (!this.connection) {
-      throw Error('This input does not have a connection.');
-    }
-    return this.connection.getShadowDom();
-  }
-
-  /**
-   * Initialize the fields on this input.
-   */
-  init() {
-    if (!this.sourceBlock_.workspace.rendered) {
-      return;  // Headless blocks don't need fields initialized.
-    }
-    for (let i = 0; i < this.fieldRow.length; i++) {
-      this.fieldRow[i].init();
-    }
-  }
-
-  /**
-   * Sever all links to this input.
-   * @suppress {checkTypes}
-   */
-  dispose() {
-    for (let i = 0, field; (field = this.fieldRow[i]); i++) {
-      field.dispose();
-    }
-    if (this.connection) {
-      this.connection.dispose();
-    }
-    this.sourceBlock_ = null;
-  }
-}
-
-/**
- * Enum for alignment of inputs.
- * @enum {number}
- * @alias Blockly.Input.Align
- */
-const Align = {
-  LEFT: -1,
-  CENTRE: 0,
-  RIGHT: 1,
-};
-exports.Align = Align;
-
-// Add Align to Input so that `Blockly.Input.Align` is publicly accessible.
-Input.Align = Align;
-
-exports.Input = Input;

package/core/interfaces/i_ast_node_location_svg.js

@@ -1,45 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an AST node location SVG.
- */
-
-'use strict';
-
-/**
- * The interface for an AST node location SVG.
- * @namespace Blockly.IASTNodeLocationSvg
- */
-goog.module('Blockly.IASTNodeLocationSvg');
-
-/* eslint-disable-next-line no-unused-vars */
-const {IASTNodeLocation} = goog.require('Blockly.IASTNodeLocation');
-
-
-/**
- * An AST node location SVG interface.
- * @interface
- * @extends {IASTNodeLocation}
- * @alias Blockly.IASTNodeLocationSvg
- */
-const IASTNodeLocationSvg = function() {};
-
-/**
- * Add the marker SVG to this node's SVG group.
- * @param {SVGElement} markerSvg The SVG root of the marker to be added to the
- *     SVG group.
- */
-IASTNodeLocationSvg.prototype.setMarkerSvg;
-
-/**
- * Add the cursor SVG to this node's SVG group.
- * @param {SVGElement} cursorSvg The SVG root of the cursor to be added to the
- *     SVG group.
- */
-IASTNodeLocationSvg.prototype.setCursorSvg;
-
-exports.IASTNodeLocationSvg = IASTNodeLocationSvg;

package/core/interfaces/i_ast_node_location_with_block.js

@@ -1,41 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for an AST node location that has an associated
- * block.
- */
-
-'use strict';
-
-/**
- * The interface for an AST node location that has an associated
- * block.
- * @namespace Blockly.IASTNodeLocationWithBlock
- */
-goog.module('Blockly.IASTNodeLocationWithBlock');
-
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
-/* eslint-disable-next-line no-unused-vars */
-const {IASTNodeLocation} = goog.require('Blockly.IASTNodeLocation');
-
-
-/**
- * An AST node location that has an associated block.
- * @interface
- * @extends {IASTNodeLocation}
- * @alias Blockly.IASTNodeLocationWithBlock
- */
-const IASTNodeLocationWithBlock = function() {};
-
-/**
- * Get the source block associated with this node.
- * @return {Block} The source block.
- */
-IASTNodeLocationWithBlock.prototype.getSourceBlock;
-
-exports.IASTNodeLocationWithBlock = IASTNodeLocationWithBlock;

package/core/interfaces/i_autohideable.js

@@ -1,40 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The interface for a component that is automatically hidden
- * when WorkspaceSvg.hideChaff is called.
- */
-
-'use strict';
-
-/**
- * The interface for a component that is automatically hidden
- * when WorkspaceSvg.hideChaff is called.
- * @namespace Blockly.IAutoHideable
- */
-goog.module('Blockly.IAutoHideable');
-
-/* eslint-disable-next-line no-unused-vars */
-const {IComponent} = goog.require('Blockly.IComponent');
-
-
-/**
- * Interface for a component that can be automatically hidden.
- * @extends {IComponent}
- * @interface
- * @alias Blockly.IAutoHideable
- */
-const IAutoHideable = function() {};
-
-/**
- * Hides the component. Called in WorkspaceSvg.hideChaff.
- * @param {boolean} onlyClosePopups Whether only popups should be closed.
- *   Flyouts should not be closed if this is true.
- */
-IAutoHideable.prototype.autoHide;
-
-exports.IAutoHideable = IAutoHideable;