blockly 8.0.5 → 9.0.0-beta.0

package/core/renderers/measurables/round_corner.ts

@@ -0,0 +1,49 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Objects representing a round corner in a row of a rendered
+ * block.
+ */
+
+/**
+ * Objects representing a round corner in a row of a rendered
+ * block.
+ * @class
+ */
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.blockRendering.RoundCorner');
+
+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 rounded corner takes up
+ * during rendering.
+ * @struct
+ * @alias Blockly.blockRendering.RoundCorner
+ */
+export class RoundCorner extends Measurable {
+  /**
+   * @param constants The rendering constants provider.
+   * @param opt_position The position of this corner.
+   * @internal
+   */
+  constructor(constants: ConstantProvider, opt_position?: string) {
+    super(constants);
+    this.type =
+        (!opt_position || opt_position === 'left' ? Types.LEFT_ROUND_CORNER :
+                                                    Types.RIGHT_ROUND_CORNER) |
+        Types.CORNER;
+    this.width = this.constants_.CORNER_RADIUS;
+    // The rounded corner extends into the next row by 4 so we only take the
+    // height that is aligned with this row.
+    this.height = this.constants_.CORNER_RADIUS / 2;
+  }
+}

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

@@ -0,0 +1,141 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ConstantProvider } from '../common/constants.js';
+import type { Measurable } from './base.js';
+import type { InRowSpacer } from './in_row_spacer.js';
+import type { InputConnection } from './input_connection.js';
+/**
+ * An object representing a single row on a rendered block and all of its
+ * subcomponents.
+ * @alias Blockly.blockRendering.Row
+ */
+export declare class Row {
+    /** @internal */
+    type: number;
+    /**
+     * An array of elements contained in this row.
+     * @internal
+     */
+    elements: Measurable[];
+    /**
+     * The height of the row.
+     * @internal
+     */
+    height: number;
+    /**
+     * The width of the row, from the left edge of the block to the right.
+     * Does not include child blocks unless they are inline.
+     * @internal
+     */
+    width: number;
+    /**
+     * The minimum height of the row.
+     * @internal
+     */
+    minHeight: number;
+    /**
+     * The minimum width of the row, from the left edge of the block to the
+     * right. Does not include child blocks unless they are inline.
+     * @internal
+     */
+    minWidth: number;
+    /**
+     * The width of the row, from the left edge of the block to the edge of the
+     * block or any connected child blocks.
+     * @internal
+     */
+    widthWithConnectedBlocks: number;
+    /**
+     * The Y position of the row relative to the origin of the block's svg
+     * group.
+     * @internal
+     */
+    yPos: number;
+    /**
+     * The X position of the row relative to the origin of the block's svg
+     * group.
+     * @internal
+     */
+    xPos: number;
+    /**
+     * Whether the row has any external inputs.
+     * @internal
+     */
+    hasExternalInput: boolean;
+    /**
+     * Whether the row has any statement inputs.
+     * @internal
+     */
+    hasStatement: boolean;
+    /**
+     * Where the left edge of all of the statement inputs on the block should
+     * be. This makes sure that statement inputs which are proceded by fields
+     * of varius widths are all aligned.
+     */
+    statementEdge: number;
+    /**
+     * Whether the row has any inline inputs.
+     * @internal
+     */
+    hasInlineInput: boolean;
+    /**
+     * Whether the row has any dummy inputs.
+     * @internal
+     */
+    hasDummyInput: boolean;
+    /**
+     * Whether the row has a jagged edge.
+     * @internal
+     */
+    hasJaggedEdge: boolean;
+    notchOffset: number;
+    /**
+     * Alignment of the row.
+     * @internal
+     */
+    align: number | null;
+    protected readonly constants_: ConstantProvider;
+    /**
+     * @param constants The rendering constants provider.
+     * @internal
+     */
+    constructor(constants: ConstantProvider);
+    /**
+     * Get the last input on this row, if it has one.
+     * @return The last input on the row, or null.
+     * @internal
+     */
+    getLastInput(): InputConnection;
+    /**
+     * Inspect all subcomponents and populate all size properties on the row.
+     * @internal
+     */
+    measure(): void;
+    /**
+     * Determines whether this row should start with an element spacer.
+     * @return Whether the row should start with a spacer.
+     * @internal
+     */
+    startsWithElemSpacer(): boolean;
+    /**
+     * Determines whether this row should end with an element spacer.
+     * @return Whether the row should end with a spacer.
+     * @internal
+     */
+    endsWithElemSpacer(): boolean;
+    /**
+     * Convenience method to get the first spacer element on this row.
+     * @return The first spacer element on this row.
+     * @internal
+     */
+    getFirstSpacer(): InRowSpacer;
+    /**
+     * Convenience method to get the last spacer element on this row.
+     * @return The last spacer element on this row.
+     * @internal
+     */
+    getLastSpacer(): InRowSpacer;
+}

package/core/renderers/measurables/row.ts

@@ -0,0 +1,225 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Object representing a single row on a rendered block.
+ */
+
+/**
+ * Object representing a single row on a rendered block.
+ * @class
+ */
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.blockRendering.Row');
+
+import type {ConstantProvider} from '../common/constants.js';
+
+import type {Measurable} from './base.js';
+import type {InRowSpacer} from './in_row_spacer.js';
+import type {InputConnection} from './input_connection.js';
+import {Types} from './types.js';
+
+
+/**
+ * An object representing a single row on a rendered block and all of its
+ * subcomponents.
+ * @alias Blockly.blockRendering.Row
+ */
+export class Row {
+  /** @internal */
+  type: number;
+
+  /**
+   * An array of elements contained in this row.
+   * @internal
+   */
+  elements: Measurable[] = [];
+
+  /**
+   * The height of the row.
+   * @internal
+   */
+  height = 0;
+
+  /**
+   * The width of the row, from the left edge of the block to the right.
+   * Does not include child blocks unless they are inline.
+   * @internal
+   */
+  width = 0;
+
+  /**
+   * The minimum height of the row.
+   * @internal
+   */
+  minHeight = 0;
+
+  /**
+   * The minimum width of the row, from the left edge of the block to the
+   * right. Does not include child blocks unless they are inline.
+   * @internal
+   */
+  minWidth = 0;
+
+  /**
+   * The width of the row, from the left edge of the block to the edge of the
+   * block or any connected child blocks.
+   * @internal
+   */
+  widthWithConnectedBlocks = 0;
+
+  /**
+   * The Y position of the row relative to the origin of the block's svg
+   * group.
+   * @internal
+   */
+  yPos = 0;
+
+  /**
+   * The X position of the row relative to the origin of the block's svg
+   * group.
+   * @internal
+   */
+  xPos = 0;
+
+  /**
+   * Whether the row has any external inputs.
+   * @internal
+   */
+  hasExternalInput = false;
+
+  /**
+   * Whether the row has any statement inputs.
+   * @internal
+   */
+  hasStatement = false;
+
+  /**
+   * Where the left edge of all of the statement inputs on the block should
+   * be. This makes sure that statement inputs which are proceded by fields
+   * of varius widths are all aligned.
+   */
+  statementEdge = 0;
+
+  /**
+   * Whether the row has any inline inputs.
+   * @internal
+   */
+  hasInlineInput = false;
+
+  /**
+   * Whether the row has any dummy inputs.
+   * @internal
+   */
+  hasDummyInput = false;
+
+  /**
+   * Whether the row has a jagged edge.
+   * @internal
+   */
+  hasJaggedEdge = false;
+  notchOffset: number;
+
+  /**
+   * Alignment of the row.
+   * @internal
+   */
+  align: number|null = null;
+
+  protected readonly constants_: ConstantProvider;
+
+  /**
+   * @param constants The rendering constants provider.
+   * @internal
+   */
+  constructor(constants: ConstantProvider) {
+    /** The renderer's constant provider. */
+    this.constants_ = constants;
+
+    /** The type of this rendering object. */
+    this.type = Types.ROW;
+
+    this.notchOffset = this.constants_.NOTCH_OFFSET_LEFT;
+  }
+
+  /**
+   * Get the last input on this row, if it has one.
+   * @return The last input on the row, or null.
+   * @internal
+   */
+  getLastInput(): InputConnection {
+    // TODO: Consider moving this to InputRow, if possible.
+    for (let i = this.elements.length - 1; i >= 0; i--) {
+      const elem = this.elements[i];
+      if (Types.isInput(elem)) {
+        return elem as InputConnection;
+      }
+    }
+    // AnyDuringMigration because:  Type 'null' is not assignable to type
+    // 'InputConnection'.
+    return null as AnyDuringMigration;
+  }
+
+  /**
+   * Inspect all subcomponents and populate all size properties on the row.
+   * @internal
+   */
+  measure() {
+    throw Error('Unexpected attempt to measure a base Row.');
+  }
+
+  /**
+   * Determines whether this row should start with an element spacer.
+   * @return Whether the row should start with a spacer.
+   * @internal
+   */
+  startsWithElemSpacer(): boolean {
+    return true;
+  }
+
+  /**
+   * Determines whether this row should end with an element spacer.
+   * @return Whether the row should end with a spacer.
+   * @internal
+   */
+  endsWithElemSpacer(): boolean {
+    return true;
+  }
+
+  /**
+   * Convenience method to get the first spacer element on this row.
+   * @return The first spacer element on this row.
+   * @internal
+   */
+  getFirstSpacer(): InRowSpacer {
+    for (let i = 0; i < this.elements.length; i++) {
+      const elem = this.elements[i];
+      if (Types.isSpacer(elem)) {
+        return elem as InRowSpacer;
+      }
+    }
+    // AnyDuringMigration because:  Type 'null' is not assignable to type
+    // 'InRowSpacer'.
+    return null as AnyDuringMigration;
+  }
+
+  /**
+   * Convenience method to get the last spacer element on this row.
+   * @return The last spacer element on this row.
+   * @internal
+   */
+  getLastSpacer(): InRowSpacer {
+    for (let i = this.elements.length - 1; i >= 0; i--) {
+      const elem = this.elements[i];
+      if (Types.isSpacer(elem)) {
+        return elem as InRowSpacer;
+      }
+    }
+    // AnyDuringMigration because:  Type 'null' is not assignable to type
+    // 'InRowSpacer'.
+    return null as AnyDuringMigration;
+  }
+}

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

@@ -0,0 +1,29 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ConstantProvider } from '../common/constants.js';
+import { InRowSpacer } from './in_row_spacer.js';
+import { Row } from './row.js';
+/**
+ * An object containing information about a spacer between two rows.
+ * @struct
+ * @alias Blockly.blockRendering.SpacerRow
+ */
+export declare class SpacerRow extends Row {
+    height: number;
+    width: number;
+    followsStatement: boolean;
+    precedesStatement: boolean;
+    widthWithConnectedBlocks: number;
+    elements: InRowSpacer[];
+    /**
+     * @param constants The rendering constants provider.
+     * @param height The height of the spacer.
+     * @param width The width of the spacer.
+     * @internal
+     */
+    constructor(constants: ConstantProvider, height: number, width: number);
+    measure(): void;
+}

package/core/renderers/measurables/spacer_row.ts

@@ -0,0 +1,55 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Object representing a spacer between two rows.
+ */
+
+/**
+ * Object representing a spacer between two rows.
+ * @class
+ */
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.blockRendering.SpacerRow');
+
+import type {ConstantProvider} from '../common/constants.js';
+
+import {InRowSpacer} from './in_row_spacer.js';
+import {Row} from './row.js';
+import {Types} from './types.js';
+
+
+/**
+ * An object containing information about a spacer between two rows.
+ * @struct
+ * @alias Blockly.blockRendering.SpacerRow
+ */
+export class SpacerRow extends Row {
+  followsStatement = false;
+
+  precedesStatement = false;
+
+  override widthWithConnectedBlocks = 0;
+  override elements: InRowSpacer[];
+
+  /**
+   * @param constants The rendering constants provider.
+   * @param height The height of the spacer.
+   * @param width The width of the spacer.
+   * @internal
+   */
+  constructor(
+      constants: ConstantProvider, public override height: number,
+      public override width: number) {
+    super(constants);
+    this.type |= Types.SPACER | Types.BETWEEN_ROW_SPACER;
+
+    this.elements = [new InRowSpacer(this.constants_, width)];
+  }
+
+  override measure() {}
+}
+// NOP.  Width and height were set at creation.

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

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ConstantProvider } from '../common/constants.js';
+import { Measurable } from './base.js';
+/**
+ * An object containing information about the space a square corner takes up
+ * during rendering.
+ * @struct
+ * @alias Blockly.blockRendering.SquareCorner
+ */
+export declare class SquareCorner extends Measurable {
+    /**
+     * @param constants The rendering constants provider.
+     * @param opt_position The position of this corner.
+     * @internal
+     */
+    constructor(constants: ConstantProvider, opt_position?: string);
+}

package/core/renderers/measurables/square_corner.ts

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Objects representing a square corner in a row of a rendered
+ * block.
+ */
+
+/**
+ * Objects representing a square corner in a row of a rendered
+ * block.
+ * @class
+ */
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.blockRendering.SquareCorner');
+
+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 square corner takes up
+ * during rendering.
+ * @struct
+ * @alias Blockly.blockRendering.SquareCorner
+ */
+export class SquareCorner extends Measurable {
+  /**
+   * @param constants The rendering constants provider.
+   * @param opt_position The position of this corner.
+   * @internal
+   */
+  constructor(constants: ConstantProvider, opt_position?: string) {
+    super(constants);
+    this.type =
+        (!opt_position || opt_position === 'left' ? Types.LEFT_SQUARE_CORNER :
+                                                    Types.RIGHT_SQUARE_CORNER) |
+        Types.CORNER;
+    this.height = this.constants_.NO_PADDING;
+    this.width = this.constants_.NO_PADDING;
+  }
+}

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

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Input } from '../../input.js';
+import type { ConstantProvider } from '../common/constants.js';
+import { InputConnection } from './input_connection.js';
+/**
+ * An object containing information about the space a statement input takes up
+ * during rendering
+ * @struct
+ * @alias Blockly.blockRendering.StatementInput
+ */
+export declare class StatementInput extends InputConnection {
+    /**
+     * @param constants The rendering constants provider.
+     * @param input The statement input to measure and store information for.
+     * @internal
+     */
+    constructor(constants: ConstantProvider, input: Input);
+}

package/core/renderers/measurables/{statement_input.js → statement_input.ts}

@@ -14,32 +14,30 @@
  * rendered block.
  * @class
  */
-goog.module('Blockly.blockRendering.StatementInput');
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.blockRendering.StatementInput');
 
 /* eslint-disable-next-line no-unused-vars */
-const {ConstantProvider} = goog.requireType('Blockly.blockRendering.ConstantProvider');
-const {InputConnection} = goog.require('Blockly.blockRendering.InputConnection');
-/* eslint-disable-next-line no-unused-vars */
-const {Input} = goog.requireType('Blockly.Input');
-const {Types} = goog.require('Blockly.blockRendering.Types');
+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 a statement input takes up
  * during rendering
  * @struct
- * @extends {InputConnection}
  * @alias Blockly.blockRendering.StatementInput
  */
-class StatementInput extends InputConnection {
+export class StatementInput extends InputConnection {
   /**
-   * @param {!ConstantProvider} constants The rendering
-   *   constants provider.
-   * @param {!Input} input The statement input to measure and store
-   *     information for.
-   * @package
+   * @param constants The rendering constants provider.
+   * @param input The statement input to measure and store information for.
+   * @internal
    */
-  constructor(constants, input) {
+  constructor(constants: ConstantProvider, input: Input) {
     super(constants, input);
     this.type |= Types.STATEMENT_INPUT;
 
@@ -51,9 +49,7 @@ class StatementInput extends InputConnection {
       this.height =
           this.connectedBlockHeight + this.constants_.STATEMENT_BOTTOM_SPACER;
     }
-    this.width =
-        this.constants_.STATEMENT_INPUT_NOTCH_OFFSET + this.shape.width;
+    this.width = this.constants_.STATEMENT_INPUT_NOTCH_OFFSET +
+        (this.shape.width as number);
   }
 }
-
-exports.StatementInput = StatementInput;