blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/renderers/geras/renderer.ts

@@ -1,126 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Geras renderer.
- */
-
-/**
- * Geras renderer.
- * @class
- */
-import * as goog from '../../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.geras.Renderer');
-
-/* eslint-disable-next-line no-unused-vars */
-// Unused import preserved for side-effects. Remove if unneeded.
-// import '../common/constants.js';
-
-import type {BlockSvg} from '../../block_svg.js';
-import type {BlockStyle, Theme} from '../../theme.js';
-import * as blockRendering from '../common/block_rendering.js';
-import type {RenderInfo as BaseRenderInfo} from '../common/info.js';
-import {Renderer as BaseRenderer} from '../common/renderer.js';
-
-import {ConstantProvider} from './constants.js';
-import {Drawer} from './drawer.js';
-import {HighlightConstantProvider} from './highlight_constants.js';
-import {RenderInfo} from './info.js';
-import {PathObject} from './path_object.js';
-
-
-/**
- * The geras renderer.
- * @alias Blockly.geras.Renderer
- */
-export class Renderer extends BaseRenderer {
-  /** The renderer's highlight constant provider. */
-  // AnyDuringMigration because:  Type 'null' is not assignable to type
-  // 'HighlightConstantProvider'.
-  private highlightConstants_: HighlightConstantProvider =
-      null as AnyDuringMigration;
-
-  /**
-   * @param name The renderer name.
-   * @internal
-   */
-  constructor(name: string) {
-    super(name);
-  }
-
-  /**
-   * Initialize the renderer.  Geras has a highlight provider in addition to
-   * the normal constant provider.
-   * @internal
-   */
-  override init(theme: Theme, opt_rendererOverrides: AnyDuringMigration) {
-    super.init(theme, opt_rendererOverrides);
-    this.highlightConstants_ = this.makeHighlightConstants_();
-    this.highlightConstants_.init();
-  }
-
-  override refreshDom(svg: SVGElement, theme: Theme) {
-    super.refreshDom(svg, theme);
-    this.getHighlightConstants().init();
-  }
-
-  override makeConstants_() {
-    return new ConstantProvider();
-  }
-
-  /**
-   * Create a new instance of the renderer's render info object.
-   * @param block The block to measure.
-   * @return The render info object.
-   */
-  protected override makeRenderInfo_(block: BlockSvg): RenderInfo {
-    return new RenderInfo(this, block);
-  }
-
-  /**
-   * Create a new instance of the renderer's drawer.
-   * @param block The block to render.
-   * @param info An object containing all information needed to render this
-   *     block.
-   * @return The drawer.
-   */
-  protected override makeDrawer_(block: BlockSvg, info: BaseRenderInfo):
-      Drawer {
-    return new Drawer(block, (info as RenderInfo));
-  }
-
-  /**
-   * Create a new instance of a renderer path object.
-   * @param root The root SVG element.
-   * @param style The style object to use for colouring.
-   * @return The renderer path object.
-   * @internal
-   */
-  override makePathObject(root: SVGElement, style: BlockStyle): PathObject {
-    return new PathObject(
-        root, style, (this.getConstants() as ConstantProvider));
-  }
-
-  /**
-   * Create a new instance of the renderer's highlight constant provider.
-   * @return The highlight constant provider.
-   */
-  protected makeHighlightConstants_(): HighlightConstantProvider {
-    return new HighlightConstantProvider((this.getConstants()));
-  }
-
-  /**
-   * Get the renderer's highlight constant provider.  We assume that when this
-   * is called, the renderer has already been initialized.
-   * @return The highlight constant provider.
-   * @internal
-   */
-  getHighlightConstants(): HighlightConstantProvider {
-    return this.highlightConstants_;
-  }
-}
-
-blockRendering.register('geras', Renderer);

package/core/renderers/measurables/base.ts

@@ -1,53 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Methods for graphically rendering a block as SVG.
- */
-
-/**
- * Methods for graphically rendering a block as SVG.
- * @class
- */
-import * as goog from '../../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.blockRendering.Measurable');
-
-import type {ConstantProvider} from '../common/constants.js';
-
-import {Types} from './types.js';
-
-
-/**
- * The base class to represent a part of a block that takes up space during
- * rendering.  The constructor for each non-spacer Measurable records the size
- * of the block element (e.g. field, statement input).
- * @alias Blockly.blockRendering.Measurable
- */
-export class Measurable {
-  width: number = 0;
-
-  height: number = 0;
-  type: number;
-  xPos = 0;
-
-  centerline = 0;
-  notchOffset: number;
-
-  /** The renderer's constant provider. */
-  protected readonly constants_: ConstantProvider
-
-  /**
-   * @param constants The rendering constants provider.
-   * @internal
-   */
-  constructor(constants: ConstantProvider) {
-    this.constants_ = constants;
-
-    this.type = Types.NONE;
-
-    this.notchOffset = this.constants_.NOTCH_OFFSET_LEFT;
-  }
-}

package/core/renderers/measurables/bottom_row.ts

@@ -1,120 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Object representing a bottom row on a rendered block.
- * of its subcomponents.
- */
-
-/**
- * Object representing a bottom row on a rendered block.
- * of its subcomponents.
- * @class
- */
-import * as goog from '../../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.blockRendering.BottomRow');
-
-import type {BlockSvg} from '../../block_svg.js';
-import type {ConstantProvider} from '../common/constants.js';
-
-import type {NextConnection} from './next_connection.js';
-import {Row} from './row.js';
-import {Types} from './types.js';
-
-
-/**
- * An object containing information about what elements are in the bottom row of
- * a block as well as spacing information for the bottom row.
- * Elements in a bottom row can consist of corners, spacers and next
- * connections.
- * @struct
- * @alias Blockly.blockRendering.BottomRow
- */
-export class BottomRow extends Row {
-  /**
-   * Whether this row has a next connection.
-   * @internal
-   */
-  hasNextConnection = false;
-
-  /**
-   * The next connection on the row, if any.
-   * @internal
-   */
-  connection: NextConnection|null = null;
-
-  /**
-   * The amount that the bottom of the block extends below the horizontal
-   * edge, e.g. because of a next connection.  Must be non-negative (see
-   * #2820).
-   * @internal
-   */
-  descenderHeight = 0;
-
-  /**
-   * The Y position of the bottom edge of the block, relative to the origin
-   * of the block rendering.
-   */
-  baseline = 0;
-
-  /**
-   * @param constants The rendering constants provider.
-   * @internal
-   */
-  constructor(constants: ConstantProvider) {
-    super(constants);
-    this.type |= Types.BOTTOM_ROW;
-  }
-
-  /**
-   * Returns whether or not the bottom row has a left square corner.
-   * @param block The block whose bottom row this represents.
-   * @return Whether or not the bottom row has a left square corner.
-   */
-  hasLeftSquareCorner(block: BlockSvg): boolean {
-    return !!block.outputConnection || !!block.getNextBlock();
-  }
-
-  /**
-   * Returns whether or not the bottom row has a right square corner.
-   * @param _block The block whose bottom row this represents.
-   * @return Whether or not the bottom row has a right square corner.
-   */
-  hasRightSquareCorner(_block: BlockSvg): boolean {
-    return true;
-  }
-
-  override measure() {
-    let height = 0;
-    let width = 0;
-    let descenderHeight = 0;
-    for (let i = 0; i < this.elements.length; i++) {
-      const elem = this.elements[i];
-      width += elem.width;
-      if (!Types.isSpacer(elem)) {
-        // Note: this assumes that next connections have *only* descenderHeight,
-        // with no height above the baseline.
-        if (Types.isNextConnection(elem)) {
-          descenderHeight = Math.max(descenderHeight, elem.height);
-        } else {
-          height = Math.max(height, elem.height);
-        }
-      }
-    }
-    this.width = Math.max(this.minWidth, width);
-    this.height = Math.max(this.minHeight, height) + descenderHeight;
-    this.descenderHeight = descenderHeight;
-    this.widthWithConnectedBlocks = this.width;
-  }
-
-  override startsWithElemSpacer() {
-    return false;
-  }
-
-  override endsWithElemSpacer() {
-    return false;
-  }
-}

package/core/renderers/measurables/connection.ts

@@ -1,52 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Base class representing the space a connection takes up during
- * rendering.
- */
-
-/**
- * Base class representing the space a connection takes up during
- * rendering.
- * @class
- */
-import * as goog from '../../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.blockRendering.Connection');
-
-/* eslint-disable-next-line no-unused-vars */
-import type {RenderedConnection} from '../../rendered_connection.js';
-import type {ConstantProvider, Shape} from '../common/constants.js';
-
-import {Measurable} from './base.js';
-import {Types} from './types.js';
-
-
-/**
- * The base class to represent a connection and the space that it takes up on
- * the block.
- * @alias Blockly.blockRendering.Connection
- */
-export class Connection extends Measurable {
-  shape: Shape;
-  isDynamicShape: boolean;
-
-  /**
-   * @param constants The rendering constants provider.
-   * @param connectionModel The connection object on the block that this
-   *     represents.
-   * @internal
-   */
-  constructor(
-      constants: ConstantProvider, public connectionModel: RenderedConnection) {
-    super(constants);
-
-    this.shape = this.constants_.shapeFor(connectionModel);
-
-    this.isDynamicShape = 'isDynamic' in this.shape && this.shape.isDynamic;
-    this.type |= Types.CONNECTION;
-  }
-}

package/core/renderers/measurables/external_value_input.ts

@@ -1,65 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class representing external value inputs with connections on a
- * rendered block.
- */
-
-/**
- * Class representing external value inputs with connections on a
- * rendered block.
- * @class
- */
-import * as goog from '../../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.blockRendering.ExternalValueInput');
-
-/* eslint-disable-next-line no-unused-vars */
-import type {Input} from '../../input.js';
-import type {ConstantProvider} from '../common/constants.js';
-
-import {InputConnection} from './input_connection.js';
-import {Types} from './types.js';
-
-
-/**
- * An object containing information about the space an external value input
- * takes up during rendering
- * @struct
- * @alias Blockly.blockRendering.ExternalValueInput
- */
-export class ExternalValueInput extends InputConnection {
-  override height = 0;
-  override width: number;
-  override connectionOffsetY: number;
-  connectionHeight: number;
-  connectionWidth: number;
-
-  /**
-   * @param constants The rendering constants provider.
-   * @param input The external value input to measure and store information for.
-   * @internal
-   */
-  constructor(constants: ConstantProvider, input: Input) {
-    super(constants, input);
-    this.type |= Types.EXTERNAL_VALUE_INPUT;
-    if (!this.connectedBlock) {
-      this.height = this.shape.height as number;
-    } else {
-      this.height = this.connectedBlockHeight -
-          this.constants_.TAB_OFFSET_FROM_TOP - this.constants_.MEDIUM_PADDING;
-    }
-
-    this.width = this.shape.width as
-        number + this.constants_.EXTERNAL_VALUE_INPUT_PADDING;
-
-    this.connectionOffsetY = this.constants_.TAB_OFFSET_FROM_TOP;
-
-    this.connectionHeight = this.shape.height as number;
-
-    this.connectionWidth = this.shape.width as number;
-  }
-}

package/core/renderers/measurables/field.ts

@@ -1,63 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Objects representing a field in a row of a rendered
- * block.
- */
-
-/**
- * Objects representing a field in a row of a rendered
- * block.
- * @class
- */
-import * as goog from '../../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.blockRendering.Field');
-
-/* eslint-disable-next-line no-unused-vars */
-import type {Field as BlocklyField} from '../../field.js';
-import type {Input} from '../../input.js';
-import type {ConstantProvider} from '../common/constants.js';
-
-import {Measurable} from './base.js';
-import {Types} from './types.js';
-
-
-/**
- * An object containing information about the space a field takes up during
- * rendering
- * @struct
- * @alias Blockly.blockRendering.Field
- */
-export class Field extends Measurable {
-  isEditable: boolean;
-  flipRtl: boolean;
-  override height: number;
-  override width: number;
-
-  /**
-   * @param constants The rendering constants provider.
-   * @param field The field to measure and store information for.
-   * @param parentInput The parent input for the field.
-   * @internal
-   */
-  constructor(
-      constants: ConstantProvider, public field: BlocklyField,
-      public parentInput: Input) {
-    super(constants);
-
-    this.isEditable = field.EDITABLE;
-
-    this.flipRtl = field.getFlipRtl();
-    this.type |= Types.FIELD;
-
-    const size = this.field.getSize();
-
-    this.height = size.height;
-
-    this.width = size.width;
-  }
-}

package/core/renderers/measurables/hat.ts

@@ -1,48 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Objects representing a hat in a row of a rendered
- * block.
- */
-
-/**
- * Objects representing a hat in a row of a rendered
- * block.
- * @class
- */
-import * as goog from '../../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.blockRendering.Hat');
-
-import type {ConstantProvider} from '../common/constants.js';
-
-import {Measurable} from './base.js';
-import {Types} from './types.js';
-
-
-/**
- * An object containing information about the space a hat takes up during
- * rendering.
- * @struct
- * @alias Blockly.blockRendering.Hat
- */
-export class Hat extends Measurable {
-  ascenderHeight: number;
-
-  /**
-   * @param constants The rendering constants provider.
-   * @internal
-   */
-  constructor(constants: ConstantProvider) {
-    super(constants);
-    this.type |= Types.HAT;
-
-    this.height = this.constants_.START_HAT.height;
-    this.width = this.constants_.START_HAT.width;
-
-    this.ascenderHeight = this.height;
-  }
-}

package/core/renderers/measurables/icon.ts

@@ -1,54 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Objects representing an icon in a row of a rendered
- * block.
- */
-
-/**
- * Objects representing an icon in a row of a rendered
- * block.
- * @class
- */
-import * as goog from '../../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.blockRendering.Icon');
-
-/* eslint-disable-next-line no-unused-vars */
-import type {Icon as BlocklyIcon} from '../../icon.js';
-import type {ConstantProvider} from '../common/constants.js';
-
-import {Measurable} from './base.js';
-import {Types} from './types.js';
-
-
-/**
- * An object containing information about the space an icon takes up during
- * rendering
- * @struct
- * @alias Blockly.blockRendering.Icon
- */
-export class Icon extends Measurable {
-  isVisible: boolean;
-
-  /**
-   * An object containing information about the space an icon takes up during
-   * rendering
-   * @param constants The rendering constants provider.
-   * @param icon The icon to measure and store information for.
-   * @internal
-   */
-  constructor(constants: ConstantProvider, public icon: BlocklyIcon) {
-    super(constants);
-
-    this.isVisible = icon.isVisible();
-    this.type |= Types.ICON;
-
-    const size = icon.getCorrectedSize();
-    this.height = size.height;
-    this.width = size.width;
-  }
-}

package/core/renderers/measurables/in_row_spacer.ts

@@ -1,44 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Objects representing a spacer in a row of a rendered
- * block.
- */
-
-/**
- * Objects representing a spacer in a row of a rendered
- * block.
- * @class
- */
-import * as goog from '../../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.blockRendering.InRowSpacer');
-
-import type {ConstantProvider} from '../common/constants.js';
-
-import {Measurable} from './base.js';
-import {Types} from './types.js';
-
-
-/**
- * An object containing information about a spacer between two elements on a
- * row.
- * @struct
- * @alias Blockly.blockRendering.InRowSpacer
- */
-export class InRowSpacer extends Measurable {
-  /**
-   * @param constants The rendering constants provider.
-   * @param width The width of the spacer.
-   * @internal
-   */
-  constructor(constants: ConstantProvider, width: number) {
-    super(constants);
-    this.type |= Types.SPACER | Types.IN_ROW_SPACER;
-    this.width = width;
-    this.height = this.constants_.SPACER_DEFAULT_HEIGHT;
-  }
-}

package/core/renderers/measurables/inline_input.ts

@@ -1,76 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Class representing inline inputs with connections on a rendered
- * block.
- */
-
-/**
- * Class representing inline inputs with connections on a rendered
- * block.
- * @class
- */
-import * as goog from '../../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.blockRendering.InlineInput');
-
-/* eslint-disable-next-line no-unused-vars */
-import type {Input} from '../../input.js';
-import type {ConstantProvider} from '../common/constants.js';
-
-import {InputConnection} from './input_connection.js';
-import {Types} from './types.js';
-
-
-/**
- * An object containing information about the space an inline input takes up
- * during rendering
- * @struct
- * @alias Blockly.blockRendering.InlineInput
- */
-export class InlineInput extends InputConnection {
-  connectionHeight: number;
-  connectionWidth: number;
-
-  /**
-   * @param constants The rendering constants provider.
-   * @param input The inline input to measure and store information for.
-   * @internal
-   */
-  constructor(constants: ConstantProvider, input: Input) {
-    super(constants, input);
-    this.type |= Types.INLINE_INPUT;
-
-    if (!this.connectedBlock) {
-      this.height = this.constants_.EMPTY_INLINE_INPUT_HEIGHT;
-      this.width = this.constants_.EMPTY_INLINE_INPUT_PADDING;
-    } else {
-      // We allow the dark path to show on the parent block so that the child
-      // block looks embossed.  This takes up an extra pixel in both x and y.
-      this.width = this.connectedBlockWidth;
-      this.height = this.connectedBlockHeight;
-    }
-
-    this.connectionHeight = !this.isDynamicShape ?
-        this.shape.height as number :
-        (this.shape.height as (p1: number) => number)(this.height);
-
-    this.connectionWidth = !this.isDynamicShape ?
-        this.shape.width as number :
-        (this.shape.width as (p1: number) => number)(this.height);
-    if (!this.connectedBlock) {
-      this.width += this.connectionWidth * (this.isDynamicShape ? 2 : 1);
-    }
-
-    this.connectionOffsetY = 'connectionOffsetY' in this.shape ?
-        this.shape.connectionOffsetY(this.connectionHeight) :
-        this.constants_.TAB_OFFSET_FROM_TOP;
-
-    this.connectionOffsetX = 'connectionOffsetX' in this.shape ?
-        this.shape.connectionOffsetX(this.connectionWidth) :
-        0;
-  }
-}