blockly 12.4.0 → 12.4.1

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

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import type { Input } from '../../inputs/input.js';
+import type { ConstantProvider } from '../common/constants.js';
+import { Connection } from './connection.js';
+/**
+ * The base class to represent an input that takes up space on a block
+ * during rendering.
+ */
+export declare class InputConnection extends Connection {
+    input: Input;
+    align: number;
+    connectedBlock: BlockSvg | null;
+    connectedBlockWidth: number;
+    connectedBlockHeight: number;
+    connectionOffsetX: number;
+    connectionOffsetY: number;
+    /**
+     * @param constants The rendering constants provider.
+     * @param input The input to measure and store information for.
+     */
+    constructor(constants: ConstantProvider, input: Input);
+}
+//# sourceMappingURL=input_connection.d.ts.map

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

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ConstantProvider } from '../common/constants.js';
+import { Row } from './row.js';
+/**
+ * An object containing information about a row that holds one or more inputs.
+ */
+export declare class InputRow extends Row {
+    /**
+     * The total width of all blocks connected to this row.
+     */
+    connectedBlockWidths: number;
+    /**
+     * @param constants The rendering constants provider.
+     */
+    constructor(constants: ConstantProvider);
+    /**
+     * Inspect all subcomponents and populate all size properties on the row.
+     */
+    measure(): void;
+    endsWithElemSpacer(): boolean;
+}
+//# sourceMappingURL=input_row.d.ts.map

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

@@ -0,0 +1,19 @@
+/**
+ * @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 the jagged edge of a
+ * collapsed block takes up during rendering.
+ */
+export declare class JaggedEdge extends Measurable {
+    private jaggedEdge;
+    /**
+     * @param constants The rendering constants provider.
+     */
+    constructor(constants: ConstantProvider);
+}
+//# sourceMappingURL=jagged_edge.d.ts.map

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

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { RenderedConnection } from '../../rendered_connection.js';
+import type { ConstantProvider } from '../common/constants.js';
+import { Connection } from './connection.js';
+/**
+ * An object containing information about the space a next connection takes
+ * up during rendering.
+ */
+export declare class NextConnection extends Connection {
+    private nextConnection;
+    /**
+     * @param constants The rendering constants provider.
+     * @param connectionModel The connection object on the block that this
+     *     represents.
+     */
+    constructor(constants: ConstantProvider, connectionModel: RenderedConnection);
+}
+//# sourceMappingURL=next_connection.d.ts.map

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

@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { RenderedConnection } from '../../rendered_connection.js';
+import type { ConstantProvider } from '../common/constants.js';
+import { Connection } from './connection.js';
+/**
+ * An object containing information about the space an output connection takes
+ * up during rendering.
+ */
+export declare class OutputConnection extends Connection {
+    startX: number;
+    connectionOffsetY: number;
+    connectionOffsetX: number;
+    /**
+     * @param constants The rendering constants provider.
+     * @param connectionModel The connection object on the block that this
+     *     represents.
+     */
+    constructor(constants: ConstantProvider, connectionModel: RenderedConnection);
+}
+//# sourceMappingURL=output_connection.d.ts.map

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

@@ -0,0 +1,22 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { RenderedConnection } from '../../rendered_connection.js';
+import type { ConstantProvider } from '../common/constants.js';
+import { Connection } from './connection.js';
+/**
+ * An object containing information about the space a previous connection takes
+ * up during rendering.
+ */
+export declare class PreviousConnection extends Connection {
+    private previousConnection;
+    /**
+     * @param constants The rendering constants provider.
+     * @param connectionModel The connection object on the block that this
+     *     represents.
+     */
+    constructor(constants: ConstantProvider, connectionModel: RenderedConnection);
+}
+//# sourceMappingURL=previous_connection.d.ts.map

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

@@ -0,0 +1,20 @@
+/**
+ * @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 rounded corner takes up
+ * during rendering.
+ */
+export declare class RoundCorner extends Measurable {
+    private roundCorner;
+    /**
+     * @param constants The rendering constants provider.
+     * @param opt_position The position of this corner.
+     */
+    constructor(constants: ConstantProvider, opt_position?: string);
+}
+//# sourceMappingURL=round_corner.d.ts.map

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

@@ -0,0 +1,124 @@
+/**
+ * @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.
+ */
+export declare class Row {
+    type: number;
+    /**
+     * An array of elements contained in this row.
+     */
+    elements: Measurable[];
+    /**
+     * The height of the row.
+     */
+    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.
+     */
+    width: number;
+    /**
+     * The minimum height of the row.
+     */
+    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.
+     */
+    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.
+     */
+    widthWithConnectedBlocks: number;
+    /**
+     * The Y position of the row relative to the origin of the block's svg
+     * group.
+     */
+    yPos: number;
+    /**
+     * The X position of the row relative to the origin of the block's svg
+     * group.
+     */
+    xPos: number;
+    /**
+     * Whether the row has any external inputs.
+     */
+    hasExternalInput: boolean;
+    /**
+     * Whether the row has any statement inputs.
+     */
+    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.
+     */
+    hasInlineInput: boolean;
+    /**
+     * Whether the row has any dummy inputs or end-row inputs.
+     */
+    hasDummyInput: boolean;
+    /**
+     * Whether the row has a jagged edge.
+     */
+    hasJaggedEdge: boolean;
+    notchOffset: number;
+    /**
+     * Alignment of the row.
+     */
+    align: number | null;
+    protected readonly constants_: ConstantProvider;
+    /**
+     * @param constants The rendering constants provider.
+     */
+    constructor(constants: ConstantProvider);
+    /**
+     * Get the last input on this row, if it has one.
+     *
+     * @returns The last input on the row, or null.
+     */
+    getLastInput(): InputConnection | null;
+    /**
+     * Inspect all subcomponents and populate all size properties on the row.
+     */
+    measure(): void;
+    /**
+     * Determines whether this row should start with an element spacer.
+     *
+     * @returns Whether the row should start with a spacer.
+     */
+    startsWithElemSpacer(): boolean;
+    /**
+     * Determines whether this row should end with an element spacer.
+     *
+     * @returns Whether the row should end with a spacer.
+     */
+    endsWithElemSpacer(): boolean;
+    /**
+     * Convenience method to get the first spacer element on this row.
+     *
+     * @returns The first spacer element on this row.
+     */
+    getFirstSpacer(): InRowSpacer | null;
+    /**
+     * Convenience method to get the last spacer element on this row.
+     *
+     * @returns The last spacer element on this row.
+     */
+    getLastSpacer(): InRowSpacer | null;
+}
+//# sourceMappingURL=row.d.ts.map

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

@@ -0,0 +1,27 @@
+/**
+ * @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.
+ */
+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.
+     */
+    constructor(constants: ConstantProvider, height: number, width: number);
+    measure(): void;
+}
+//# sourceMappingURL=spacer_row.d.ts.map

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

@@ -0,0 +1,20 @@
+/**
+ * @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.
+ */
+export declare class SquareCorner extends Measurable {
+    private squareCorner;
+    /**
+     * @param constants The rendering constants provider.
+     * @param opt_position The position of this corner.
+     */
+    constructor(constants: ConstantProvider, opt_position?: string);
+}
+//# sourceMappingURL=square_corner.d.ts.map

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

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Input } from '../../inputs/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
+ */
+export declare class StatementInput extends InputConnection {
+    private statementInput;
+    /**
+     * @param constants The rendering constants provider.
+     * @param input The statement input to measure and store information for.
+     */
+    constructor(constants: ConstantProvider, input: Input);
+}
+//# sourceMappingURL=statement_input.d.ts.map

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

@@ -0,0 +1,53 @@
+/**
+ * @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.
+ */
+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).
+     */
+    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;
+    /**
+     * @param constants The rendering constants provider.
+     */
+    constructor(constants: ConstantProvider);
+    /**
+     * Returns whether or not the top row has a left square corner.
+     *
+     * @param block The block whose top row this represents.
+     * @returns Whether or not the top row has a left square corner.
+     */
+    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.
+     * @returns Whether or not the top row has a right square corner.
+     */
+    hasRightSquareCorner(_block: BlockSvg): boolean;
+    measure(): void;
+    startsWithElemSpacer(): boolean;
+    endsWithElemSpacer(): boolean;
+}
+//# sourceMappingURL=top_row.d.ts.map

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

@@ -0,0 +1,258 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+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.
+ */
+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.
+     */
+    LEFT_CORNER: number;
+    /**
+     * A Right Corner Union Type.
+     */
+    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.
+     * @returns The enum flag value associated with that type.
+     */
+    getType(type: string): 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    isRoundCorner(elem: Measurable): elem is RoundCorner;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+}
+export declare const Types: TypesContainer;
+export {};
+//# sourceMappingURL=types.d.ts.map