blockly 8.0.5 → 9.0.0-beta.0

package/core/renderers/common/path_object.js

@@ -1,283 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview An object that owns a block's rendering SVG elements.
- */
-
-'use strict';
-
-/**
- * An object that owns a block's rendering SVG elements.
- * @class
- */
-goog.module('Blockly.blockRendering.PathObject');
-
-const dom = goog.require('Blockly.utils.dom');
-/* eslint-disable-next-line no-unused-vars */
-const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {Connection} = goog.requireType('Blockly.Connection');
-/* eslint-disable-next-line no-unused-vars */
-const {ConstantProvider} = goog.requireType('Blockly.blockRendering.ConstantProvider');
-/* eslint-disable-next-line no-unused-vars */
-const {IPathObject} = goog.require('Blockly.blockRendering.IPathObject');
-const {Svg} = goog.require('Blockly.utils.Svg');
-/* eslint-disable-next-line no-unused-vars */
-const {Theme} = goog.requireType('Blockly.Theme');
-
-
-/**
- * An object that handles creating and setting each of the SVG elements
- * used by the renderer.
- * @implements {IPathObject}
- * @alias Blockly.blockRendering.PathObject
- */
-class PathObject {
-  /**
-   * @param {!SVGElement} root The root SVG element.
-   * @param {!Theme.BlockStyle} style The style object to use for
-   *     colouring.
-   * @param {!ConstantProvider} constants The renderer's
-   *     constants.
-   * @package
-   */
-  constructor(root, style, constants) {
-    /**
-     * The renderer's constant provider.
-     * @type {!ConstantProvider}
-     * @package
-     */
-    this.constants = constants;
-
-    this.svgRoot = root;
-
-    /**
-     * The primary path of the block.
-     * @type {!SVGElement}
-     * @package
-     */
-    this.svgPath =
-        dom.createSvgElement(Svg.PATH, {'class': 'blocklyPath'}, this.svgRoot);
-
-    /**
-     * The style object to use when colouring block paths.
-     * @type {!Theme.BlockStyle}
-     * @package
-     */
-    this.style = style;
-
-    /**
-     * Holds the cursors svg element when the cursor is attached to the block.
-     * This is null if there is no cursor on the block.
-     * @type {SVGElement}
-     * @package
-     */
-    this.cursorSvg = null;
-
-    /**
-     * Holds the markers svg element when the marker is attached to the block.
-     * This is null if there is no marker on the block.
-     * @type {SVGElement}
-     * @package
-     */
-    this.markerSvg = null;
-  }
-
-  /**
-   * Set the path generated by the renderer onto the respective SVG element.
-   * @param {string} pathString The path.
-   * @package
-   */
-  setPath(pathString) {
-    this.svgPath.setAttribute('d', pathString);
-  }
-
-  /**
-   * Flip the SVG paths in RTL.
-   * @package
-   */
-  flipRTL() {
-    // Mirror the block's path.
-    this.svgPath.setAttribute('transform', 'scale(-1 1)');
-  }
-
-  /**
-   * Add the cursor SVG to this block's SVG group.
-   * @param {SVGElement} cursorSvg The SVG root of the cursor to be added to the
-   *     block SVG group.
-   * @package
-   */
-  setCursorSvg(cursorSvg) {
-    if (!cursorSvg) {
-      this.cursorSvg = null;
-      return;
-    }
-
-    this.svgRoot.appendChild(cursorSvg);
-    this.cursorSvg = cursorSvg;
-  }
-
-  /**
-   * Add the marker SVG to this block's SVG group.
-   * @param {SVGElement} markerSvg The SVG root of the marker to be added to the
-   *     block SVG group.
-   * @package
-   */
-  setMarkerSvg(markerSvg) {
-    if (!markerSvg) {
-      this.markerSvg = null;
-      return;
-    }
-
-    if (this.cursorSvg) {
-      this.svgRoot.insertBefore(markerSvg, this.cursorSvg);
-    } else {
-      this.svgRoot.appendChild(markerSvg);
-    }
-    this.markerSvg = markerSvg;
-  }
-
-  /**
-   * Apply the stored colours to the block's path, taking into account whether
-   * the paths belong to a shadow block.
-   * @param {!BlockSvg} block The source block.
-   * @package
-   */
-  applyColour(block) {
-    this.svgPath.setAttribute('stroke', this.style.colourTertiary);
-    this.svgPath.setAttribute('fill', this.style.colourPrimary);
-
-    this.updateShadow_(block.isShadow());
-    this.updateDisabled_(!block.isEnabled() || block.getInheritedDisabled());
-  }
-
-  /**
-   * Set the style.
-   * @param {!Theme.BlockStyle} blockStyle The block style to use.
-   * @package
-   */
-  setStyle(blockStyle) {
-    this.style = blockStyle;
-  }
-
-  /**
-   * Add or remove the given CSS class on the path object's root SVG element.
-   * @param {string} className The name of the class to add or remove
-   * @param {boolean} add True if the class should be added.  False if it should
-   *     be removed.
-   * @protected
-   */
-  setClass_(className, add) {
-    if (add) {
-      dom.addClass(/** @type {!Element} */ (this.svgRoot), className);
-    } else {
-      dom.removeClass(/** @type {!Element} */ (this.svgRoot), className);
-    }
-  }
-
-  /**
-   * Set whether the block shows a highlight or not.  Block highlighting is
-   * often used to visually mark blocks currently being executed.
-   * @param {boolean} enable True if highlighted.
-   * @package
-   */
-  updateHighlighted(enable) {
-    if (enable) {
-      this.svgPath.setAttribute(
-          'filter', 'url(#' + this.constants.embossFilterId + ')');
-    } else {
-      this.svgPath.setAttribute('filter', 'none');
-    }
-  }
-
-  /**
-   * Updates the look of the block to reflect a shadow state.
-   * @param {boolean} shadow True if the block is a shadow block.
-   * @protected
-   */
-  updateShadow_(shadow) {
-    if (shadow) {
-      this.svgPath.setAttribute('stroke', 'none');
-      this.svgPath.setAttribute('fill', this.style.colourSecondary);
-    }
-  }
-
-  /**
-   * Updates the look of the block to reflect a disabled state.
-   * @param {boolean} disabled True if disabled.
-   * @protected
-   */
-  updateDisabled_(disabled) {
-    this.setClass_('blocklyDisabled', disabled);
-    if (disabled) {
-      this.svgPath.setAttribute(
-          'fill', 'url(#' + this.constants.disabledPatternId + ')');
-    }
-  }
-
-  /**
-   * Add or remove styling showing that a block is selected.
-   * @param {boolean} enable True if selection is enabled, false otherwise.
-   * @package
-   */
-  updateSelected(enable) {
-    this.setClass_('blocklySelected', enable);
-  }
-
-  /**
-   * Add or remove styling showing that a block is dragged over a delete area.
-   * @param {boolean} enable True if the block is being dragged over a delete
-   *     area, false otherwise.
-   * @package
-   */
-  updateDraggingDelete(enable) {
-    this.setClass_('blocklyDraggingDelete', enable);
-  }
-
-  /**
-   * Add or remove styling showing that a block is an insertion marker.
-   * @param {boolean} enable True if the block is an insertion marker, false
-   *     otherwise.
-   * @package
-   */
-  updateInsertionMarker(enable) {
-    this.setClass_('blocklyInsertionMarker', enable);
-  }
-
-  /**
-   * Add or remove styling showing that a block is movable.
-   * @param {boolean} enable True if the block is movable, false otherwise.
-   * @package
-   */
-  updateMovable(enable) {
-    this.setClass_('blocklyDraggable', enable);
-  }
-
-  /**
-   * Add or remove styling that shows that if the dragging block is dropped,
-   * this block will be replaced.  If a shadow block, it will disappear.
-   * Otherwise it will bump.
-   * @param {boolean} enable True if styling should be added.
-   * @package
-   */
-  updateReplacementFade(enable) {
-    this.setClass_('blocklyReplaceable', enable);
-  }
-
-  /**
-   * Add or remove styling that shows that if the dragging block is dropped,
-   * this block will be connected to the input.
-   * @param {Connection} _conn The connection on the input to highlight.
-   * @param {boolean} _enable True if styling should be added.
-   * @package
-   */
-  updateShapeForInputHighlight(_conn, _enable) {
-    // NOP
-  }
-}
-
-exports.PathObject = PathObject;

package/core/renderers/common/renderer.js

@@ -1,305 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Base renderer.
- */
-'use strict';
-
-/**
- * Base renderer.
- * @class
- */
-goog.module('Blockly.blockRendering.Renderer');
-
-const debug = goog.require('Blockly.blockRendering.debug');
-const object = goog.require('Blockly.utils.object');
-/* 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');
-const {ConnectionType} = goog.require('Blockly.ConnectionType');
-const {Connection} = goog.require('Blockly.Connection');
-const {ConstantProvider} = goog.require('Blockly.blockRendering.ConstantProvider');
-/* eslint-disable-next-line no-unused-vars */
-const {Debug} = goog.requireType('Blockly.blockRendering.Debug');
-const {Drawer} = goog.require('Blockly.blockRendering.Drawer');
-/* eslint-disable-next-line no-unused-vars */
-const {IPathObject} = goog.requireType('Blockly.blockRendering.IPathObject');
-/* eslint-disable-next-line no-unused-vars */
-const {IRegistrable} = goog.require('Blockly.IRegistrable');
-const {InsertionMarkerManager} = goog.require('Blockly.InsertionMarkerManager');
-const {MarkerSvg} = goog.require('Blockly.blockRendering.MarkerSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {Marker} = goog.requireType('Blockly.Marker');
-const {PathObject} = goog.require('Blockly.blockRendering.PathObject');
-const {RenderInfo} = goog.require('Blockly.blockRendering.RenderInfo');
-/* eslint-disable-next-line no-unused-vars */
-const {RenderedConnection} = goog.requireType('Blockly.RenderedConnection');
-/* 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 base class for a block renderer.
- * @implements {IRegistrable}
- * @alias Blockly.blockRendering.Renderer
- */
-class Renderer {
-  /**
-   * @param {string} name The renderer name.
-   * @package
-   */
-  constructor(name) {
-    /**
-     * The renderer name.
-     * @type {string}
-     * @package
-     */
-    this.name = name;
-
-    /**
-     * The renderer's constant provider.
-     * @type {ConstantProvider}
-     * @private
-     */
-    this.constants_ = null;
-
-    /**
-     * Rendering constant overrides, passed in through options.
-     * @type {?Object}
-     * @package
-     */
-    this.overrides = null;
-  }
-
-  /**
-   * Gets the class name that identifies this renderer.
-   * @return {string} The CSS class name.
-   * @package
-   */
-  getClassName() {
-    return this.name + '-renderer';
-  }
-
-  /**
-   * Initialize the renderer.
-   * @param {!Theme} theme The workspace theme object.
-   * @param {Object=} opt_rendererOverrides Rendering constant overrides.
-   * @package
-   */
-  init(theme, opt_rendererOverrides) {
-    this.constants_ = this.makeConstants_();
-    if (opt_rendererOverrides) {
-      this.overrides = opt_rendererOverrides;
-      object.mixin(this.constants_, opt_rendererOverrides);
-    }
-    this.constants_.setTheme(theme);
-    this.constants_.init();
-  }
-
-  /**
-   * Create any DOM elements that this renderer needs.
-   * @param {!SVGElement} svg The root of the workspace's SVG.
-   * @param {!Theme} theme The workspace theme object.
-   * @package
-   */
-  createDom(svg, theme) {
-    this.constants_.createDom(
-        svg, this.name + '-' + theme.name,
-        '.' + this.getClassName() + '.' + theme.getClassName());
-  }
-
-  /**
-   * Refresh the renderer after a theme change.
-   * @param {!SVGElement} svg The root of the workspace's SVG.
-   * @param {!Theme} theme The workspace theme object.
-   * @package
-   */
-  refreshDom(svg, theme) {
-    const previousConstants = this.getConstants();
-    previousConstants.dispose();
-    this.constants_ = this.makeConstants_();
-    if (this.overrides) {
-      object.mixin(this.constants_, this.overrides);
-    }
-    // Ensure the constant provider's random identifier does not change.
-    this.constants_.randomIdentifier = previousConstants.randomIdentifier;
-    this.constants_.setTheme(theme);
-    this.constants_.init();
-    this.createDom(svg, theme);
-  }
-
-  /**
-   * Dispose of this renderer.
-   * Delete all DOM elements that this renderer and its constants created.
-   * @package
-   */
-  dispose() {
-    if (this.constants_) {
-      this.constants_.dispose();
-    }
-  }
-
-  /**
-   * Create a new instance of the renderer's constant provider.
-   * @return {!ConstantProvider} The constant provider.
-   * @protected
-   */
-  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
-   */
-  makeRenderInfo_(block) {
-    return new RenderInfo(this, block);
-  }
-
-  /**
-   * Create a new instance of the renderer's drawer.
-   * @param {!BlockSvg} block The block to render.
-   * @param {!RenderInfo} info An object containing all
-   *   information needed to render this block.
-   * @return {!Drawer} The drawer.
-   * @protected
-   */
-  makeDrawer_(block, info) {
-    return new Drawer(block, info);
-  }
-
-  /**
-   * Create a new instance of the renderer's debugger.
-   * @return {!Debug} The renderer debugger.
-   * @suppress {strictModuleDepCheck} Debug renderer only included in
-   * playground.
-   * @protected
-   */
-  makeDebugger_() {
-    const {Debug} = goog.module.get('Blockly.blockRendering.Debug');
-    if (!Debug) {
-      throw Error('Missing require for Blockly.blockRendering.Debug');
-    }
-    return new Debug(this.getConstants());
-  }
-
-  /**
-   * Create a new instance of the renderer's marker drawer.
-   * @param {!WorkspaceSvg} workspace The workspace the marker belongs to.
-   * @param {!Marker} marker The marker.
-   * @return {!MarkerSvg} The object in charge of drawing
-   *     the marker.
-   * @package
-   */
-  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 {!IPathObject} The renderer path object.
-   * @package
-   */
-  makePathObject(root, style) {
-    return new PathObject(
-        root, style, /** @type {!ConstantProvider} */ (this.constants_));
-  }
-
-  /**
-   * Get the current renderer's constant provider.  We assume that when this is
-   * called, the renderer has already been initialized.
-   * @return {!ConstantProvider} The constant provider.
-   * @package
-   */
-  getConstants() {
-    return /** @type {!ConstantProvider} */ (this.constants_);
-  }
-
-  /**
-   * Determine whether or not to highlight a connection.
-   * @param {Connection} _conn The connection to determine whether or not
-   *     to highlight.
-   * @return {boolean} True if we should highlight the connection.
-   * @package
-   */
-  shouldHighlightConnection(_conn) {
-    return true;
-  }
-
-  /**
-   * Checks if an orphaned block can connect to the "end" of the topBlock's
-   * block-clump. If the clump is a row the end is the last input. If the clump
-   * is a stack, the end is the last next connection. If the clump is neither,
-   * then this returns false.
-   * @param {!BlockSvg} topBlock The top block of the block clump we want to try
-   *     and connect to.
-   * @param {!BlockSvg} orphanBlock The orphan block that wants to find
-   *     a home.
-   * @param {number} localType The type of the connection being dragged.
-   * @return {boolean} Whether there is a home for the orphan or not.
-   * @package
-   */
-  orphanCanConnectAtEnd(topBlock, orphanBlock, localType) {
-    const orphanConnection =
-        (localType === ConnectionType.OUTPUT_VALUE ?
-             orphanBlock.outputConnection :
-             orphanBlock.previousConnection);
-    return !!Connection.getConnectionForOrphanedConnection(
-        /** @type {!Block} **/ (topBlock),
-        /** @type {!Connection} **/ (orphanConnection));
-  }
-
-  /**
-   * Chooses a connection preview method based on the available connection, the
-   * current dragged connection, and the block being dragged.
-   * @param {!RenderedConnection} closest The available connection.
-   * @param {!RenderedConnection} local The connection currently being
-   *     dragged.
-   * @param {!BlockSvg} topBlock The block currently being dragged.
-   * @return {!InsertionMarkerManager.PREVIEW_TYPE} The preview type
-   *     to display.
-   * @package
-   */
-  getConnectionPreviewMethod(closest, local, topBlock) {
-    if (local.type === ConnectionType.OUTPUT_VALUE ||
-        local.type === ConnectionType.PREVIOUS_STATEMENT) {
-      if (!closest.isConnected() ||
-          this.orphanCanConnectAtEnd(
-              topBlock,
-              /** @type {!BlockSvg} */ (closest.targetBlock()), local.type)) {
-        return InsertionMarkerManager.PREVIEW_TYPE.INSERTION_MARKER;
-      }
-      return InsertionMarkerManager.PREVIEW_TYPE.REPLACEMENT_FADE;
-    }
-
-    return InsertionMarkerManager.PREVIEW_TYPE.INSERTION_MARKER;
-  }
-
-  /**
-   * Render the block.
-   * @param {!BlockSvg} block The block to render.
-   * @package
-   */
-  render(block) {
-    if (debug.isDebuggerEnabled() && !block.renderingDebugger) {
-      block.renderingDebugger = this.makeDebugger_();
-    }
-    const info = this.makeRenderInfo_(block);
-    info.measure();
-    this.makeDrawer_(block, info).draw();
-  }
-}
-
-exports.Renderer = Renderer;

package/core/renderers/geras/constants.js

@@ -1,73 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview An object that provides constants for rendering blocks in Geras
- * mode.
- */
-'use strict';
-
-/**
- * An object that provides constants for rendering blocks in Geras
- * mode.
- * @class
- */
-goog.module('Blockly.geras.ConstantProvider');
-
-const {ConstantProvider: BaseConstantProvider} = goog.require('Blockly.blockRendering.ConstantProvider');
-
-
-/**
- * An object that provides constants for rendering blocks in Geras mode.
- * @extends {BaseConstantProvider}
- * @alias Blockly.geras.ConstantProvider
- */
-class ConstantProvider extends BaseConstantProvider {
-  /**
-   * @package
-   */
-  constructor() {
-    super();
-
-    /**
-     * @override
-     */
-    this.FIELD_TEXT_BASELINE_CENTER = false;
-
-    // The dark/shadow path in classic rendering is the same as the normal block
-    // path, but translated down one and right one.
-    this.DARK_PATH_OFFSET = 1;
-
-    /**
-     * The maximum width of a bottom row that follows a statement input and has
-     * inputs inline.
-     * @type {number}
-     */
-    this.MAX_BOTTOM_WIDTH = 30;
-
-    /**
-     * @override
-     */
-    this.STATEMENT_BOTTOM_SPACER = -this.NOTCH_HEIGHT / 2;
-  }
-
-  /**
-   * @override
-   */
-  getCSS_(selector) {
-    return super.getCSS_(selector).concat([
-      /* eslint-disable indent */
-      // Insertion marker.
-      selector + ' .blocklyInsertionMarker>.blocklyPathLight,',
-      selector + ' .blocklyInsertionMarker>.blocklyPathDark {',
-      'fill-opacity: ' + this.INSERTION_MARKER_OPACITY + ';', 'stroke: none;',
-      '}',
-      /* eslint-enable indent */
-    ]);
-  }
-}
-
-exports.ConstantProvider = ConstantProvider;

package/core/renderers/geras/geras.js

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