blockly 8.0.5 → 9.0.0-beta.0

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

@@ -0,0 +1,61 @@
+/**
+ * @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 { NextConnection } from './next_connection.js';
+import { Row } from './row.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 declare class BottomRow extends Row {
+    /**
+     * Whether this row has a next connection.
+     * @internal
+     */
+    hasNextConnection: boolean;
+    /**
+     * The next connection on the row, if any.
+     * @internal
+     */
+    connection: NextConnection | 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: number;
+    /**
+     * The Y position of the bottom edge of the block, relative to the origin
+     * of the block rendering.
+     */
+    baseline: number;
+    /**
+     * @param constants The rendering constants provider.
+     * @internal
+     */
+    constructor(constants: ConstantProvider);
+    /**
+     * 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;
+    /**
+     * 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;
+    measure(): void;
+    startsWithElemSpacer(): boolean;
+    endsWithElemSpacer(): boolean;
+}

package/core/renderers/measurables/bottom_row.ts

@@ -0,0 +1,120 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { RenderedConnection } from '../../rendered_connection.js';
+import type { ConstantProvider, Shape } from '../common/constants.js';
+import { Measurable } from './base.js';
+/**
+ * The base class to represent a connection and the space that it takes up on
+ * the block.
+ * @alias Blockly.blockRendering.Connection
+ */
+export declare class Connection extends Measurable {
+    connectionModel: RenderedConnection;
+    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, connectionModel: RenderedConnection);
+}

package/core/renderers/measurables/connection.ts

@@ -0,0 +1,52 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @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 an external value input
+ * takes up during rendering
+ * @struct
+ * @alias Blockly.blockRendering.ExternalValueInput
+ */
+export declare class ExternalValueInput extends InputConnection {
+    height: number;
+    width: number;
+    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);
+}

package/core/renderers/measurables/external_value_input.ts

@@ -0,0 +1,65 @@
+/**
+ * @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.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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';
+/**
+ * An object containing information about the space a field takes up during
+ * rendering
+ * @struct
+ * @alias Blockly.blockRendering.Field
+ */
+export declare class Field extends Measurable {
+    field: BlocklyField;
+    parentInput: Input;
+    isEditable: boolean;
+    flipRtl: boolean;
+    height: number;
+    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, field: BlocklyField, parentInput: Input);
+}

package/core/renderers/measurables/field.ts

@@ -0,0 +1,63 @@
+/**
+ * @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.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 hat takes up during
+ * rendering.
+ * @struct
+ * @alias Blockly.blockRendering.Hat
+ */
+export declare class Hat extends Measurable {
+    ascenderHeight: number;
+    /**
+     * @param constants The rendering constants provider.
+     * @internal
+     */
+    constructor(constants: ConstantProvider);
+}

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

@@ -14,37 +14,35 @@
  * block.
  * @class
  */
-goog.module('Blockly.blockRendering.Hat');
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.blockRendering.Hat');
 
-/* eslint-disable-next-line no-unused-vars */
-const {ConstantProvider} = goog.requireType('Blockly.blockRendering.ConstantProvider');
-const {Measurable} = goog.require('Blockly.blockRendering.Measurable');
-const {Types} = goog.require('Blockly.blockRendering.Types');
+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
- * @extends {Measurable}
  * @alias Blockly.blockRendering.Hat
  */
-class Hat extends Measurable {
+export class Hat extends Measurable {
+  ascenderHeight: number;
+
   /**
-   * @param {!ConstantProvider} constants The rendering
-   *   constants provider.
-   * @package
+   * @param constants The rendering constants provider.
+   * @internal
    */
-  constructor(constants) {
+  constructor(constants: ConstantProvider) {
     super(constants);
     this.type |= Types.HAT;
 
     this.height = this.constants_.START_HAT.height;
     this.width = this.constants_.START_HAT.width;
 
-    /** @type {number} */
     this.ascenderHeight = this.height;
   }
 }
-
-exports.Hat = Hat;

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

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Icon as BlocklyIcon } from '../../icon.js';
+import type { ConstantProvider } from '../common/constants.js';
+import { Measurable } from './base.js';
+/**
+ * An object containing information about the space an icon takes up during
+ * rendering
+ * @struct
+ * @alias Blockly.blockRendering.Icon
+ */
+export declare class Icon extends Measurable {
+    icon: BlocklyIcon;
+    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, icon: BlocklyIcon);
+}

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

@@ -14,39 +14,36 @@
  * block.
  * @class
  */
-goog.module('Blockly.blockRendering.Icon');
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.blockRendering.Icon');
 
 /* eslint-disable-next-line no-unused-vars */
-const {ConstantProvider} = goog.requireType('Blockly.blockRendering.ConstantProvider');
-/* eslint-disable-next-line no-unused-vars */
-const {Icon: BlocklyIcon} = goog.requireType('Blockly.Icon');
-const {Measurable} = goog.require('Blockly.blockRendering.Measurable');
-const {Types} = goog.require('Blockly.blockRendering.Types');
+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
- * @extends {Measurable}
  * @struct
  * @alias Blockly.blockRendering.Icon
  */
-class Icon extends Measurable {
+export class Icon extends Measurable {
+  isVisible: boolean;
+
   /**
    * An object containing information about the space an icon takes up during
    * rendering
-   * @param {!ConstantProvider} constants The rendering
-   *   constants provider.
-   * @param {!BlocklyIcon} icon The icon to measure and store information for.
-   * @package
+   * @param constants The rendering constants provider.
+   * @param icon The icon to measure and store information for.
+   * @internal
    */
-  constructor(constants, icon) {
+  constructor(constants: ConstantProvider, public icon: BlocklyIcon) {
     super(constants);
 
-    /** @type {!BlocklyIcon} */
-    this.icon = icon;
-
-    /** @type {boolean} */
     this.isVisible = icon.isVisible();
     this.type |= Types.ICON;
 
@@ -55,4 +52,3 @@ class Icon extends Measurable {
     this.width = size.width;
   }
 }
-exports.Icon = Icon;

package/core/renderers/measurables/in_row_spacer.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 a spacer between two elements on a
+ * row.
+ * @struct
+ * @alias Blockly.blockRendering.InRowSpacer
+ */
+export declare class InRowSpacer extends Measurable {
+    /**
+     * @param constants The rendering constants provider.
+     * @param width The width of the spacer.
+     * @internal
+     */
+    constructor(constants: ConstantProvider, width: number);
+}

package/core/renderers/measurables/in_row_spacer.ts

@@ -0,0 +1,44 @@
+/**
+ * @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;
+  }
+}