blockly 12.4.0 → 12.5.0

package/core/renderers/measurables/types.ts

@@ -1,362 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.blockRendering.Types
-
-import type {Measurable} from './base.js';
-import type {BottomRow} from './bottom_row.js';
-import type {ExternalValueInput} from './external_value_input.js';
-import type {Field} from './field.js';
-import type {Hat} from './hat.js';
-import type {Icon} from './icon.js';
-import type {InRowSpacer} from './in_row_spacer.js';
-import type {InlineInput} from './inline_input.js';
-import type {InputConnection} from './input_connection.js';
-import type {InputRow} from './input_row.js';
-import type {JaggedEdge} from './jagged_edge.js';
-import type {NextConnection} from './next_connection.js';
-import type {PreviousConnection} from './previous_connection.js';
-import type {RoundCorner} from './round_corner.js';
-import type {Row} from './row.js';
-import type {SpacerRow} from './spacer_row.js';
-import type {SquareCorner} from './square_corner.js';
-import type {StatementInput} from './statement_input.js';
-import type {TopRow} from './top_row.js';
-
-/**
- * Types of rendering elements.
- */
-class TypesContainer {
-  // This class is very non-idiomatic for typescript, so we have to use
-  // the Function type to make it happy.
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-  [index: string]: number | Function;
-
-  NONE = 0; // None
-  FIELD = 1 << 0; // Field.
-  HAT = 1 << 1; // Hat.
-  ICON = 1 << 2; // Icon.
-  SPACER = 1 << 3; // Spacer.
-  BETWEEN_ROW_SPACER = 1 << 4; // Between Row Spacer.
-  IN_ROW_SPACER = 1 << 5; // In Row Spacer.
-  EXTERNAL_VALUE_INPUT = 1 << 6; // External Value Input.
-  INPUT = 1 << 7; // Input.
-  INLINE_INPUT = 1 << 8; // Inline Input.
-  STATEMENT_INPUT = 1 << 9; // Statement Input.
-  CONNECTION = 1 << 10; // Connection.
-  PREVIOUS_CONNECTION = 1 << 11; // Previous Connection.
-  NEXT_CONNECTION = 1 << 12; // Next Connection.
-  OUTPUT_CONNECTION = 1 << 13; // Output Connection.
-  CORNER = 1 << 14; // Corner.
-  LEFT_SQUARE_CORNER = 1 << 15; // Square Corner.
-  LEFT_ROUND_CORNER = 1 << 16; // Round Corner.
-  RIGHT_SQUARE_CORNER = 1 << 17; // Right Square Corner.
-  RIGHT_ROUND_CORNER = 1 << 18; // Right Round Corner.
-  JAGGED_EDGE = 1 << 19; // Jagged Edge.
-  ROW = 1 << 20; // Row.
-  TOP_ROW = 1 << 21; // Top Row.
-  BOTTOM_ROW = 1 << 22; // Bottom Row.
-  INPUT_ROW = 1 << 23; // Input Row.
-
-  /**
-   * A Left Corner Union Type.
-   */
-  LEFT_CORNER = this.LEFT_SQUARE_CORNER | this.LEFT_ROUND_CORNER;
-
-  /**
-   * A Right Corner Union Type.
-   */
-  RIGHT_CORNER = this.RIGHT_SQUARE_CORNER | this.RIGHT_ROUND_CORNER;
-
-  /**
-   * Next flag value to use for custom rendering element types.
-   * This must be updated to reflect the next enum flag value
-   * to use if additional elements are added to
-   * `Types`.
-   */
-  nextTypeValue_ = 1 << 24;
-
-  /**
-   * Get the enum flag value of an existing type or register a new type.
-   *
-   * @param type The name of the type.
-   * @returns The enum flag value associated with that type.
-   */
-  getType(type: string): number {
-    if (!Object.prototype.hasOwnProperty.call(this, type)) {
-      this[type] = this.nextTypeValue_;
-      this.nextTypeValue_ <<= 1;
-    }
-    return this[type] as number;
-  }
-
-  /**
-   * Whether a measurable stores information about a field.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a field.
-   */
-  isField(elem: Measurable): elem is Field {
-    return (elem.type & this.FIELD) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a hat.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a hat.
-   */
-  isHat(elem: Measurable): elem is Hat {
-    return (elem.type & this.HAT) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about an icon.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about an icon.
-   */
-  isIcon(elem: Measurable): elem is Icon {
-    return (elem.type & this.ICON) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a spacer.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a spacer.
-   */
-  isSpacer(elem: Measurable | Row): elem is SpacerRow | InRowSpacer {
-    return (elem.type & this.SPACER) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about an in-row spacer.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about an in-row spacer.
-   */
-  isInRowSpacer(elem: Measurable): elem is InRowSpacer {
-    return (elem.type & this.IN_ROW_SPACER) >= 1;
-  }
-
-  /**
-   * Whether a row is a spacer row.
-   *
-   * @param row The row to check.
-   * @returns True if the row is a spacer row.
-   */
-  isSpacerRow(row: Row): row is SpacerRow {
-    return (row.type & this.BETWEEN_ROW_SPACER) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about an input.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about an input.
-   */
-  isInput(elem: Measurable): elem is InputConnection {
-    return (elem.type & this.INPUT) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about an external input.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about an external input.
-   */
-  isExternalInput(elem: Measurable): elem is ExternalValueInput {
-    return (elem.type & this.EXTERNAL_VALUE_INPUT) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about an inline input.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about an inline input.
-   */
-  isInlineInput(elem: Measurable): elem is InlineInput {
-    return (elem.type & this.INLINE_INPUT) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a statement input.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a statement input.
-   */
-  isStatementInput(elem: Measurable): elem is StatementInput {
-    return (elem.type & this.STATEMENT_INPUT) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a previous connection.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a previous connection.
-   */
-  isPreviousConnection(elem: Measurable): elem is PreviousConnection {
-    return (elem.type & this.PREVIOUS_CONNECTION) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a next connection.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a next connection.
-   */
-  isNextConnection(elem: Measurable): elem is NextConnection {
-    return (elem.type & this.NEXT_CONNECTION) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a previous or next
-   * connection.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a previous or next
-   *     connection.
-   */
-  isPreviousOrNextConnection(
-    elem: Measurable,
-  ): elem is PreviousConnection | NextConnection {
-    return this.isPreviousConnection(elem) || this.isNextConnection(elem);
-  }
-
-  isRoundCorner(elem: Measurable): elem is RoundCorner {
-    return (
-      (elem.type & this.LEFT_ROUND_CORNER) >= 1 ||
-      (elem.type & this.RIGHT_ROUND_CORNER) >= 1
-    );
-  }
-
-  /**
-   * Whether a measurable stores information about a left round corner.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a left round corner.
-   */
-  isLeftRoundedCorner(elem: Measurable): boolean {
-    return (
-      this.isRoundCorner(elem) && (elem.type & this.LEFT_ROUND_CORNER) >= 1
-    );
-  }
-
-  /**
-   * Whether a measurable stores information about a right round corner.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a right round corner.
-   */
-  isRightRoundedCorner(elem: Measurable): boolean {
-    return (
-      this.isRoundCorner(elem) && (elem.type & this.RIGHT_ROUND_CORNER) >= 1
-    );
-  }
-
-  /**
-   * Whether a measurable stores information about a left square corner.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a left square corner.
-   */
-  isLeftSquareCorner(elem: Measurable): boolean {
-    return (elem.type & this.LEFT_SQUARE_CORNER) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a right square corner.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a right square corner.
-   */
-  isRightSquareCorner(elem: Measurable): boolean {
-    return (elem.type & this.RIGHT_SQUARE_CORNER) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a corner.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a corner.
-   */
-  isCorner(elem: Measurable): elem is SquareCorner | RoundCorner {
-    return (elem.type & this.CORNER) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a jagged edge.
-   *
-   * @param elem The element to check.
-   * @returns 1 if the object stores information about a jagged edge.
-   */
-  isJaggedEdge(elem: Measurable): elem is JaggedEdge {
-    return (elem.type & this.JAGGED_EDGE) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a row.
-   *
-   * @param row The row to check.
-   * @returns 1 if the object stores information about a row.
-   */
-  isRow(row: Row): row is Row {
-    return (row.type & this.ROW) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a between-row spacer.
-   *
-   * @param row The row to check.
-   * @returns 1 if the object stores information about a between-row spacer.
-   */
-  isBetweenRowSpacer(row: Row): row is SpacerRow {
-    return (row.type & this.BETWEEN_ROW_SPACER) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a top row.
-   *
-   * @param row The row to check.
-   * @returns 1 if the object stores information about a top row.
-   */
-  isTopRow(row: Row): row is TopRow {
-    return (row.type & this.TOP_ROW) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a bottom row.
-   *
-   * @param row The row to check.
-   * @returns 1 if the object stores information about a bottom row.
-   */
-  isBottomRow(row: Row): row is BottomRow {
-    return (row.type & this.BOTTOM_ROW) >= 1;
-  }
-
-  /**
-   * Whether a measurable stores information about a top or bottom row.
-   *
-   * @param row The row to check.
-   * @returns 1 if the object stores information about a top or bottom row.
-   */
-  isTopOrBottomRow(row: Row): row is TopRow | BottomRow {
-    return this.isTopRow(row) || this.isBottomRow(row);
-  }
-
-  /**
-   * Whether a measurable stores information about an input row.
-   *
-   * @param row The row to check.
-   * @returns 1 if the object stores information about an input row.
-   */
-  isInputRow(row: Row): row is InputRow {
-    return (row.type & this.INPUT_ROW) >= 1;
-  }
-}
-
-export const Types = new TypesContainer();

package/core/renderers/thrasos/info.ts

@@ -1,327 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.thrasos.RenderInfo
-
-import type {BlockSvg} from '../../block_svg.js';
-import {RenderInfo as BaseRenderInfo} from '../common/info.js';
-import type {Measurable} from '../measurables/base.js';
-import {InRowSpacer} from '../measurables/in_row_spacer.js';
-import type {Row} from '../measurables/row.js';
-import {Types} from '../measurables/types.js';
-import type {Renderer} from './renderer.js';
-
-/**
- * An object containing all sizing information needed to draw this block.
- *
- * This measure pass does not propagate changes to the block (although fields
- * may choose to rerender when getSize() is called).  However, calling it
- * repeatedly may be expensive.
- */
-export class RenderInfo extends BaseRenderInfo {
-  // Exclamation is fine b/c this is assigned by the super constructor.
-  protected override renderer_!: Renderer;
-
-  /**
-   * @param renderer The renderer in use.
-   * @param block The block to measure.
-   */
-  constructor(renderer: Renderer, block: BlockSvg) {
-    super(renderer, block);
-  }
-
-  /**
-   * Get the block renderer in use.
-   *
-   * @returns The block renderer in use.
-   */
-  override getRenderer(): Renderer {
-    return this.renderer_;
-  }
-
-  override addElemSpacing_() {
-    let hasExternalInputs = false;
-    for (let i = 0; i < this.rows.length; i++) {
-      const row = this.rows[i];
-      if (row.hasExternalInput) {
-        hasExternalInputs = true;
-        break;
-      }
-    }
-    for (let i = 0; i < this.rows.length; i++) {
-      const row = this.rows[i];
-      const oldElems = row.elements;
-      row.elements = [];
-      // No spacing needed before the corner on the top row or the bottom row.
-      if (row.startsWithElemSpacer()) {
-        // There's a spacer before the first element in the row.
-        row.elements.push(
-          new InRowSpacer(
-            this.constants_,
-            this.getInRowSpacing_(null, oldElems[0]),
-          ),
-        );
-      }
-      if (!oldElems.length) {
-        continue;
-      }
-      for (let e = 0; e < oldElems.length - 1; e++) {
-        row.elements.push(oldElems[e]);
-        const spacing = this.getInRowSpacing_(oldElems[e], oldElems[e + 1]);
-        row.elements.push(new InRowSpacer(this.constants_, spacing));
-      }
-      row.elements.push(oldElems[oldElems.length - 1]);
-      if (row.endsWithElemSpacer()) {
-        let spacing = this.getInRowSpacing_(
-          oldElems[oldElems.length - 1],
-          null,
-        );
-        if (hasExternalInputs && row.hasDummyInput) {
-          spacing += this.constants_.TAB_WIDTH;
-        }
-        // There's a spacer after the last element in the row.
-        row.elements.push(new InRowSpacer(this.constants_, spacing));
-      }
-    }
-  }
-
-  override getInRowSpacing_(prev: Measurable | null, next: Measurable | null) {
-    if (!prev) {
-      // Between an editable field and the beginning of the row.
-      if (next && Types.isField(next) && next.isEditable) {
-        return this.constants_.MEDIUM_PADDING;
-      }
-      // Inline input at the beginning of the row.
-      if (next && Types.isInlineInput(next)) {
-        return this.constants_.MEDIUM_LARGE_PADDING;
-      }
-      if (next && Types.isStatementInput(next)) {
-        return this.constants_.STATEMENT_INPUT_PADDING_LEFT;
-      }
-      // Anything else at the beginning of the row.
-      return this.constants_.LARGE_PADDING;
-    }
-
-    // Spacing between a non-input and the end of the row.
-    if (!Types.isInput(prev) && !next) {
-      // Between an editable field and the end of the row.
-      if (Types.isField(prev) && prev.isEditable) {
-        if (prev.width === 0) {
-          return this.constants_.NO_PADDING;
-        }
-        return this.constants_.MEDIUM_PADDING;
-      }
-      // Padding at the end of an icon-only row to make the block shape clearer.
-      if (Types.isIcon(prev)) {
-        return this.constants_.LARGE_PADDING * 2 + 1;
-      }
-      if (Types.isHat(prev)) {
-        return this.constants_.NO_PADDING;
-      }
-      // Establish a minimum width for a block with a previous or next
-      // connection.
-      if (Types.isPreviousOrNextConnection(prev)) {
-        return this.constants_.LARGE_PADDING;
-      }
-      // Between rounded corner and the end of the row.
-      if (Types.isLeftRoundedCorner(prev)) {
-        return this.constants_.MIN_BLOCK_WIDTH;
-      }
-      // Between a jagged edge and the end of the row.
-      if (Types.isJaggedEdge(prev)) {
-        return this.constants_.NO_PADDING;
-      }
-      // Between noneditable fields and icons and the end of the row.
-      return this.constants_.LARGE_PADDING;
-    }
-    // Between inputs and the end of the row.
-    if (Types.isInput(prev) && !next) {
-      if (Types.isExternalInput(prev)) {
-        return this.constants_.NO_PADDING;
-      } else if (Types.isInlineInput(prev)) {
-        return this.constants_.LARGE_PADDING;
-      } else if (Types.isStatementInput(prev)) {
-        return this.constants_.NO_PADDING;
-      }
-    }
-
-    // Spacing between a non-input and an input.
-    if (!Types.isInput(prev) && next && Types.isInput(next)) {
-      // Between an editable field and an input.
-      if (Types.isField(prev) && prev.isEditable) {
-        if (Types.isInlineInput(next)) {
-          return this.constants_.SMALL_PADDING;
-        } else if (Types.isExternalInput(next)) {
-          return this.constants_.SMALL_PADDING;
-        }
-      } else {
-        if (Types.isInlineInput(next)) {
-          return this.constants_.MEDIUM_LARGE_PADDING;
-        } else if (Types.isExternalInput(next)) {
-          return this.constants_.MEDIUM_LARGE_PADDING;
-        } else if (Types.isStatementInput(next)) {
-          return this.constants_.LARGE_PADDING;
-        }
-      }
-      return this.constants_.LARGE_PADDING - 1;
-    }
-
-    // Spacing between an icon and an icon or field.
-    if (Types.isIcon(prev) && next && !Types.isInput(next)) {
-      return this.constants_.LARGE_PADDING;
-    }
-
-    // Spacing between an inline input and a field.
-    if (Types.isInlineInput(prev) && next && Types.isField(next)) {
-      // Editable field after inline input.
-      if (next.isEditable) {
-        return this.constants_.MEDIUM_PADDING;
-      } else {
-        // Noneditable field after inline input.
-        return this.constants_.LARGE_PADDING;
-      }
-    }
-
-    if (Types.isLeftSquareCorner(prev) && next) {
-      // Spacing between a hat and a corner
-      if (Types.isHat(next)) {
-        return this.constants_.NO_PADDING;
-      }
-      // Spacing between a square corner and a previous or next connection
-      if (Types.isPreviousConnection(next) || Types.isNextConnection(next)) {
-        return next.notchOffset;
-      }
-    }
-    // Spacing between a rounded corner and a previous or next connection.
-    if (Types.isLeftRoundedCorner(prev) && next) {
-      return next.notchOffset - this.constants_.CORNER_RADIUS;
-    }
-
-    // Spacing between two fields of the same editability.
-    if (
-      Types.isField(prev) &&
-      next &&
-      Types.isField(next) &&
-      prev.isEditable === next.isEditable
-    ) {
-      if (prev.width === 0) {
-        return this.constants_.NO_PADDING;
-      }
-      return this.constants_.LARGE_PADDING;
-    }
-
-    // Spacing between anything and a jagged edge.
-    if (next && Types.isJaggedEdge(next)) {
-      return this.constants_.LARGE_PADDING;
-    }
-
-    return this.constants_.MEDIUM_PADDING;
-  }
-
-  override getSpacerRowHeight_(prev: Row, next: Row) {
-    // If we have an empty block add a spacer to increase the height.
-    if (Types.isTopRow(prev) && Types.isBottomRow(next)) {
-      return this.constants_.EMPTY_BLOCK_SPACER_HEIGHT;
-    }
-    // Top and bottom rows act as a spacer so we don't need any extra padding.
-    if (Types.isTopRow(prev) || Types.isBottomRow(next)) {
-      return this.constants_.NO_PADDING;
-    }
-    if (prev.hasExternalInput && next.hasExternalInput) {
-      return this.constants_.LARGE_PADDING;
-    }
-    if (!prev.hasStatement && next.hasStatement) {
-      return this.constants_.BETWEEN_STATEMENT_PADDING_Y;
-    }
-    if (prev.hasStatement && next.hasStatement) {
-      return this.constants_.LARGE_PADDING;
-    }
-    if (prev.hasDummyInput || next.hasDummyInput) {
-      return this.constants_.LARGE_PADDING;
-    }
-    return this.constants_.MEDIUM_PADDING;
-  }
-
-  override getElemCenterline_(row: Row, elem: Measurable) {
-    if (Types.isSpacer(elem)) {
-      return row.yPos + elem.height / 2;
-    }
-    if (Types.isBottomRow(row)) {
-      const baseline = row.yPos + row.height - row.descenderHeight;
-      if (Types.isNextConnection(elem)) {
-        return baseline + elem.height / 2;
-      }
-      return baseline - elem.height / 2;
-    }
-    if (Types.isTopRow(row)) {
-      if (Types.isHat(elem)) {
-        return row.capline - elem.height / 2;
-      }
-      return row.capline + elem.height / 2;
-    }
-
-    let result = row.yPos;
-    if (Types.isField(elem) && row.hasStatement) {
-      const offset =
-        this.constants_.TALL_INPUT_FIELD_OFFSET_Y + elem.height / 2;
-      result += offset;
-    } else {
-      result += row.height / 2;
-    }
-    return result;
-  }
-
-  override finalize_() {
-    // Performance note: this could be combined with the draw pass, if the time
-    // that this takes is excessive.  But it shouldn't be, because it only
-    // accesses and sets properties that already exist on the objects.
-    let widestRowWithConnectedBlocks = 0;
-    let yCursor = 0;
-    for (let i = 0; i < this.rows.length; i++) {
-      const row = this.rows[i];
-      row.yPos = yCursor;
-      row.xPos = this.startX;
-      yCursor += row.height;
-
-      widestRowWithConnectedBlocks = Math.max(
-        widestRowWithConnectedBlocks,
-        row.widthWithConnectedBlocks,
-      );
-      // Add padding to the bottom row if block height is less than minimum
-      const heightWithoutHat = yCursor - this.topRow.ascenderHeight;
-      if (
-        row === this.bottomRow &&
-        heightWithoutHat < this.constants_.MIN_BLOCK_HEIGHT
-      ) {
-        // But the hat height shouldn't be part of this.
-        const diff = this.constants_.MIN_BLOCK_HEIGHT - heightWithoutHat;
-        this.bottomRow.height += diff;
-        yCursor += diff;
-      }
-      this.recordElemPositions_(row);
-    }
-    if (
-      this.outputConnection &&
-      this.block_.nextConnection &&
-      this.block_.nextConnection.isConnected()
-    ) {
-      const target = this.block_.nextConnection.targetBlock();
-      if (target) {
-        // Include width of connected block in value to stack width measurement.
-        widestRowWithConnectedBlocks = Math.max(
-          widestRowWithConnectedBlocks,
-          target.getHeightWidth().width,
-        );
-      }
-    }
-
-    this.bottomRow.baseline = yCursor - this.bottomRow.descenderHeight;
-    this.widthWithChildren = widestRowWithConnectedBlocks + this.startX;
-
-    this.height = yCursor;
-    this.startY = this.topRow.capline;
-  }
-}