blockly 8.0.4 → 8.0.5-beta.0

package/core/renderers/measurables/top_row.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import type { ConstantProvider } from '../common/constants.js';
+import type { PreviousConnection } from './previous_connection.js';
+import { Row } from './row.js';
+/**
+ * An object containing information about what elements are in the top row of a
+ * block as well as sizing information for the top row.
+ * Elements in a top row can consist of corners, hats, spacers, and previous
+ * connections.
+ * After this constructor is called, the row will contain all non-spacer
+ * elements it needs.
+ * @struct
+ * @alias Blockly.blockRendering.TopRow
+ */
+export declare class TopRow extends Row {
+    /**
+     * The starting point for drawing the row, in the y direction.
+     * This allows us to draw hats and similar shapes that don't start at the
+     * origin. Must be non-negative (see #2820).
+     * @internal
+     */
+    capline: number;
+    /** How much the row extends up above its capline. */
+    ascenderHeight: number;
+    /** Whether the block has a previous connection. */
+    hasPreviousConnection: boolean;
+    /** The previous connection on the block, if any. */
+    connection: PreviousConnection | null;
+    widthWithConnectedBlocks: any;
+    /**
+     * @param constants The rendering constants provider.
+     * @internal
+     */
+    constructor(constants: ConstantProvider);
+    /**
+     * Returns whether or not the top row has a left square corner.
+     * @param block The block whose top row this represents.
+     * @return Whether or not the top row has a left square corner.
+     * @internal
+     */
+    hasLeftSquareCorner(block: BlockSvg): boolean;
+    /**
+     * Returns whether or not the top row has a right square corner.
+     * @param _block The block whose top row this represents.
+     * @return Whether or not the top row has a right square corner.
+     */
+    hasRightSquareCorner(_block: BlockSvg): boolean;
+    measure(): void;
+    startsWithElemSpacer(): boolean;
+    endsWithElemSpacer(): boolean;
+}

package/core/renderers/measurables/top_row.ts

@@ -0,0 +1,122 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Object representing a top row on a rendered block.
+ */
+
+/**
+ * Object representing a top row on a rendered block.
+ * @class
+ */
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.blockRendering.TopRow');
+
+import type {BlockSvg} from '../../block_svg.js';
+import type {ConstantProvider} from '../common/constants.js';
+
+import {Hat} from './hat.js';
+import type {PreviousConnection} from './previous_connection.js';
+import {Row} from './row.js';
+import {Types} from './types.js';
+
+
+/**
+ * An object containing information about what elements are in the top row of a
+ * block as well as sizing information for the top row.
+ * Elements in a top row can consist of corners, hats, spacers, and previous
+ * connections.
+ * After this constructor is called, the row will contain all non-spacer
+ * elements it needs.
+ * @struct
+ * @alias Blockly.blockRendering.TopRow
+ */
+export class TopRow extends Row {
+  /**
+   * The starting point for drawing the row, in the y direction.
+   * This allows us to draw hats and similar shapes that don't start at the
+   * origin. Must be non-negative (see #2820).
+   * @internal
+   */
+  capline = 0;
+
+  /** How much the row extends up above its capline. */
+  ascenderHeight = 0;
+
+  /** Whether the block has a previous connection. */
+  hasPreviousConnection = false;
+
+  /** The previous connection on the block, if any. */
+  connection: PreviousConnection|null = null;
+  override widthWithConnectedBlocks: AnyDuringMigration;
+
+  /**
+   * @param constants The rendering constants provider.
+   * @internal
+   */
+  constructor(constants: ConstantProvider) {
+    super(constants);
+
+    this.type |= Types.TOP_ROW;
+  }
+
+  /**
+   * Returns whether or not the top row has a left square corner.
+   * @param block The block whose top row this represents.
+   * @return Whether or not the top row has a left square corner.
+   * @internal
+   */
+  hasLeftSquareCorner(block: BlockSvg): boolean {
+    const hasHat =
+        (block.hat ? block.hat === 'cap' : this.constants_.ADD_START_HATS) &&
+        !block.outputConnection && !block.previousConnection;
+    const prevBlock = block.getPreviousBlock();
+
+    return !!block.outputConnection || hasHat ||
+        (prevBlock ? prevBlock.getNextBlock() === block : false);
+  }
+
+  /**
+   * Returns whether or not the top row has a right square corner.
+   * @param _block The block whose top row this represents.
+   * @return Whether or not the top row has a right square corner.
+   */
+  hasRightSquareCorner(_block: BlockSvg): boolean {
+    return true;
+  }
+
+  override measure() {
+    let height = 0;
+    let width = 0;
+    let ascenderHeight = 0;
+    for (let i = 0; i < this.elements.length; i++) {
+      const elem = this.elements[i];
+      width += elem.width;
+      if (!Types.isSpacer(elem)) {
+        // AnyDuringMigration because:  Property 'isHat' does not exist on type
+        // 'typeof Types'.
+        if ((Types as AnyDuringMigration).isHat(elem) && elem instanceof Hat) {
+          ascenderHeight = Math.max(ascenderHeight, elem.ascenderHeight);
+        } else {
+          height = Math.max(height, elem.height);
+        }
+      }
+    }
+    this.width = Math.max(this.minWidth, width);
+    this.height = Math.max(this.minHeight, height) + ascenderHeight;
+    this.ascenderHeight = ascenderHeight;
+    this.capline = this.ascenderHeight;
+    this.widthWithConnectedBlocks = this.width;
+  }
+
+  override startsWithElemSpacer() {
+    return false;
+  }
+
+  override endsWithElemSpacer() {
+    return false;
+  }
+}

package/core/renderers/measurables/types.d.ts

@@ -0,0 +1,235 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Measurable } from './base.js';
+import type { Row } from './row.js';
+/**
+ * Types of rendering elements.
+ * @alias Blockly.blockRendering.Types
+ */
+declare class TypesContainer {
+    [index: string]: number | Function;
+    NONE: number;
+    FIELD: number;
+    HAT: number;
+    ICON: number;
+    SPACER: number;
+    BETWEEN_ROW_SPACER: number;
+    IN_ROW_SPACER: number;
+    EXTERNAL_VALUE_INPUT: number;
+    INPUT: number;
+    INLINE_INPUT: number;
+    STATEMENT_INPUT: number;
+    CONNECTION: number;
+    PREVIOUS_CONNECTION: number;
+    NEXT_CONNECTION: number;
+    OUTPUT_CONNECTION: number;
+    CORNER: number;
+    LEFT_SQUARE_CORNER: number;
+    LEFT_ROUND_CORNER: number;
+    RIGHT_SQUARE_CORNER: number;
+    RIGHT_ROUND_CORNER: number;
+    JAGGED_EDGE: number;
+    ROW: number;
+    TOP_ROW: number;
+    BOTTOM_ROW: number;
+    INPUT_ROW: number;
+    /**
+     * A Left Corner Union Type.
+     * @internal
+     */
+    LEFT_CORNER: number;
+    /**
+     * A Right Corner Union Type.
+     * @internal
+     */
+    RIGHT_CORNER: number;
+    /**
+     * 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_: number;
+    /**
+     * Get the enum flag value of an existing type or register a new type.
+     * @param type The name of the type.
+     * @return The enum flag value associated with that type.
+     * @internal
+     */
+    getType(type: string): number;
+    /**
+     * Whether a measurable stores information about a field.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a field.
+     * @internal
+     */
+    isField(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a hat.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a hat.
+     * @internal
+     */
+    isHat(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about an icon.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about an icon.
+     * @internal
+     */
+    isIcon(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a spacer.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a spacer.
+     * @internal
+     */
+    isSpacer(elem: Measurable | Row): number;
+    /**
+     * Whether a measurable stores information about an in-row spacer.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about an in-row spacer.
+     * @internal
+     */
+    isInRowSpacer(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about an input.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about an input.
+     * @internal
+     */
+    isInput(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about an external input.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about an external input.
+     * @internal
+     */
+    isExternalInput(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about an inline input.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about an inline input.
+     * @internal
+     */
+    isInlineInput(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a statement input.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a statement input.
+     * @internal
+     */
+    isStatementInput(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a previous connection.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a previous connection.
+     * @internal
+     */
+    isPreviousConnection(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a next connection.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a next connection.
+     * @internal
+     */
+    isNextConnection(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a previous or next
+     * connection.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a previous or next
+     *     connection.
+     * @internal
+     */
+    isPreviousOrNextConnection(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a left round corner.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a left round corner.
+     * @internal
+     */
+    isLeftRoundedCorner(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a right round corner.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a right round corner.
+     * @internal
+     */
+    isRightRoundedCorner(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a left square corner.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a left square corner.
+     * @internal
+     */
+    isLeftSquareCorner(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a right square corner.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a right square corner.
+     * @internal
+     */
+    isRightSquareCorner(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a corner.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a corner.
+     * @internal
+     */
+    isCorner(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a jagged edge.
+     * @param elem The element to check.
+     * @return 1 if the object stores information about a jagged edge.
+     * @internal
+     */
+    isJaggedEdge(elem: Measurable): number;
+    /**
+     * Whether a measurable stores information about a row.
+     * @param row The row to check.
+     * @return 1 if the object stores information about a row.
+     * @internal
+     */
+    isRow(row: Row): number;
+    /**
+     * Whether a measurable stores information about a between-row spacer.
+     * @param row The row to check.
+     * @return 1 if the object stores information about a between-row spacer.
+     * @internal
+     */
+    isBetweenRowSpacer(row: Row): number;
+    /**
+     * Whether a measurable stores information about a top row.
+     * @param row The row to check.
+     * @return 1 if the object stores information about a top row.
+     * @internal
+     */
+    isTopRow(row: Row): number;
+    /**
+     * Whether a measurable stores information about a bottom row.
+     * @param row The row to check.
+     * @return 1 if the object stores information about a bottom row.
+     * @internal
+     */
+    isBottomRow(row: Row): number;
+    /**
+     * Whether a measurable stores information about a top or bottom row.
+     * @param row The row to check.
+     * @return 1 if the object stores information about a top or bottom row.
+     * @internal
+     */
+    isTopOrBottomRow(row: Row): number;
+    /**
+     * Whether a measurable stores information about an input row.
+     * @param row The row to check.
+     * @return 1 if the object stores information about an input row.
+     * @internal
+     */
+    isInputRow(row: Row): number;
+}
+export declare const Types: TypesContainer;
+export {};