blockly 12.4.0 → 12.5.0

package/core/renderers/thrasos/info.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import { RenderInfo as BaseRenderInfo } from '../common/info.js';
+import type { Measurable } from '../measurables/base.js';
+import type { Row } from '../measurables/row.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 declare class RenderInfo extends BaseRenderInfo {
+    protected renderer_: Renderer;
+    /**
+     * @param renderer The renderer in use.
+     * @param block The block to measure.
+     */
+    constructor(renderer: Renderer, block: BlockSvg);
+    /**
+     * Get the block renderer in use.
+     *
+     * @returns The block renderer in use.
+     */
+    getRenderer(): Renderer;
+    addElemSpacing_(): void;
+    getInRowSpacing_(prev: Measurable | null, next: Measurable | null): number;
+    getSpacerRowHeight_(prev: Row, next: Row): number;
+    getElemCenterline_(row: Row, elem: Measurable): number;
+    finalize_(): void;
+}
+//# sourceMappingURL=info.d.ts.map

package/core/renderers/thrasos/renderer.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 { Renderer as BaseRenderer } from '../common/renderer.js';
+import { RenderInfo } from './info.js';
+/**
+ * The thrasos renderer. This is a more modern take on the legacy geras
+ * renderer.
+ *
+ * Thrasos is the ancient Greek spirit of boldness.
+ */
+export declare class Renderer extends BaseRenderer {
+    /**
+     * @param name The renderer name.
+     */
+    constructor(name: string);
+    /**
+     * Create a new instance of the renderer's render info object.
+     *
+     * @param block The block to measure.
+     * @returns The render info object.
+     */
+    protected makeRenderInfo_(block: BlockSvg): RenderInfo;
+}
+//# sourceMappingURL=renderer.d.ts.map

package/core/renderers/thrasos/thrasos.d.ts

@@ -0,0 +1,10 @@
+/** @file Re-exports of Blockly.thrasos.* modules. */
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { RenderInfo } from './info.js';
+import { Renderer } from './renderer.js';
+export { Renderer, RenderInfo };
+//# sourceMappingURL=thrasos.d.ts.map

package/core/renderers/zelos/constants.d.ts

@@ -0,0 +1,165 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { RenderedConnection } from '../../rendered_connection.js';
+import type { Theme } from '../../theme.js';
+import type { Shape } from '../common/constants.js';
+import { ConstantProvider as BaseConstantProvider } from '../common/constants.js';
+/** An object containing sizing and path information about inside corners. */
+export interface InsideCorners {
+    width: number;
+    height: number;
+    pathTop: string;
+    pathBottom: string;
+    rightWidth: number;
+    rightHeight: number;
+    pathTopRight: string;
+    pathBottomRight: string;
+}
+/**
+ * An object that provides constants for rendering blocks in Zelos mode.
+ */
+export declare class ConstantProvider extends BaseConstantProvider {
+    GRID_UNIT: number;
+    STATEMENT_INPUT_SPACER_MIN_WIDTH: number;
+    CURSOR_COLOUR: string;
+    /**
+     * Radius of the cursor for input and output connections.
+     */
+    CURSOR_RADIUS: number;
+    JAGGED_TEETH_HEIGHT: number;
+    JAGGED_TEETH_WIDTH: number;
+    START_HAT_HEIGHT: number;
+    START_HAT_WIDTH: number;
+    SHAPES: {
+        HEXAGONAL: number;
+        ROUND: number;
+        SQUARE: number;
+        PUZZLE: number;
+        NOTCH: number;
+    };
+    /**
+     * Map of output/input shapes and the amount they should cause a block to be
+     * padded. Outer key is the outer shape, inner key is the inner shape.
+     * When a block with the outer shape contains an input block with the inner
+     * shape on its left or right edge, the block elements are aligned such that
+     * the padding specified is reached.
+     */
+    SHAPE_IN_SHAPE_PADDING: {
+        [key: number]: {
+            [key: number]: number;
+        };
+    };
+    FULL_BLOCK_FIELDS: boolean;
+    FIELD_TEXT_FONTWEIGHT: string;
+    FIELD_TEXT_FONTFAMILY: string;
+    FIELD_DROPDOWN_NO_BORDER_RECT_SHADOW: boolean;
+    FIELD_DROPDOWN_COLOURED_DIV: boolean;
+    FIELD_DROPDOWN_SVG_ARROW: boolean;
+    FIELD_TEXTINPUT_BOX_SHADOW: boolean;
+    FIELD_COLOUR_FULL_BLOCK: boolean;
+    MAX_DYNAMIC_CONNECTION_SHAPE_WIDTH: number;
+    /** The selected glow colour. */
+    SELECTED_GLOW_COLOUR: string;
+    /** The size of the selected glow. */
+    SELECTED_GLOW_SIZE: number;
+    /** The replacement glow colour. */
+    REPLACEMENT_GLOW_COLOUR: string;
+    /** The size of the selected glow. */
+    REPLACEMENT_GLOW_SIZE: number;
+    /**
+     * The ID of the selected glow filter, or the empty string if no filter is
+     * set.
+     */
+    selectedGlowFilterId: string;
+    /**
+     * The <filter> element to use for a selected glow, or null if not set.
+     */
+    private selectedGlowFilter;
+    /**
+     * The ID of the replacement glow filter, or the empty string if no filter
+     * is set.
+     */
+    replacementGlowFilterId: string;
+    /**
+     * The <filter> element to use for a replacement glow, or null if not set.
+     */
+    private replacementGlowFilter;
+    /**
+     * The object containing information about the hexagon used for a boolean
+     * reporter block. Null before init is called.
+     */
+    HEXAGONAL: Shape | null;
+    /**
+     * The object containing information about the hexagon used for a number or
+     * string reporter block. Null before init is called.
+     */
+    ROUNDED: Shape | null;
+    /**
+     * The object containing information about the hexagon used for a
+     * rectangular reporter block. Null before init is called.
+     */
+    SQUARED: Shape | null;
+    /**
+     * Creates a new ConstantProvider.
+     *
+     * @param gridUnit If set, defines the base unit used to calculate other
+     *     constants.
+     */
+    constructor(gridUnit?: number);
+    setFontConstants_(theme: Theme): void;
+    init(): void;
+    setDynamicProperties_(theme: Theme): void;
+    dispose(): void;
+    makeStartHat(): {
+        height: number;
+        width: number;
+        path: string;
+    };
+    /**
+     * Create sizing and path information about a hexagonal shape.
+     *
+     * @returns An object containing sizing and path information about a hexagonal
+     *     shape for connections.
+     */
+    protected makeHexagonal(): Shape;
+    /**
+     * Create sizing and path information about a rounded shape.
+     *
+     * @returns An object containing sizing and path information about a rounded
+     *     shape for connections.
+     */
+    protected makeRounded(): Shape;
+    /**
+     * Create sizing and path information about a squared shape.
+     *
+     * @returns An object containing sizing and path information about a squared
+     *     shape for connections.
+     */
+    protected makeSquared(): Shape;
+    shapeFor(connection: RenderedConnection): Shape;
+    makeNotch(): {
+        type: number;
+        width: number;
+        height: number;
+        pathLeft: string;
+        pathRight: string;
+    };
+    makeInsideCorners(): {
+        width: number;
+        height: number;
+        pathTop: string;
+        pathBottom: string;
+        rightWidth: number;
+        rightHeight: number;
+        pathTopRight: string;
+        pathBottomRight: string;
+    };
+    generateSecondaryColour_(colour: string): string;
+    generateTertiaryColour_(colour: string): string;
+    createDom(svg: SVGElement, tagName: string, selector: string, injectionDivIfIsParent?: HTMLElement): void;
+    getCSS_(selector: string): string[];
+}
+//# sourceMappingURL=constants.d.ts.map

package/core/renderers/zelos/drawer.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import { Drawer as BaseDrawer } from '../common/drawer.js';
+import { Connection } from '../measurables/connection.js';
+import type { InlineInput } from '../measurables/inline_input.js';
+import type { Row } from '../measurables/row.js';
+import type { RenderInfo } from './info.js';
+/**
+ * An object that draws a block based on the given rendering information.
+ */
+export declare class Drawer extends BaseDrawer {
+    info_: RenderInfo;
+    /**
+     * @param block The block to render.
+     * @param info An object containing all information needed to render this
+     *     block.
+     */
+    constructor(block: BlockSvg, info: RenderInfo);
+    draw(): void;
+    drawOutline_(): void;
+    drawLeft_(): void;
+    /**
+     * Add steps for the right side of a row that does not have value or
+     * statement input connections.
+     *
+     * @param row The row to draw the side of.
+     */
+    protected drawRightSideRow_(row: Row): void;
+    /**
+     * Add steps to draw the right side of an output with a dynamic connection.
+     */
+    protected drawRightDynamicConnection_(): void;
+    /**
+     * Add steps to draw the left side of an output with a dynamic connection.
+     */
+    protected drawLeftDynamicConnection_(): void;
+    /** Add steps to draw a flat top row. */
+    protected drawFlatTop_(): void;
+    /** Add steps to draw a flat bottom row. */
+    protected drawFlatBottom_(): void;
+    drawInlineInput_(input: InlineInput): void;
+    private getInlineInputPath;
+    drawStatementInput_(row: Row): void;
+    /** Returns a path to highlight the given connection. */
+    drawConnectionHighlightPath(measurable: Connection): SVGElement | undefined;
+}
+//# sourceMappingURL=drawer.d.ts.map

package/core/renderers/zelos/info.d.ts

@@ -0,0 +1,89 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import { Input } from '../../inputs/input.js';
+import { RenderInfo as BaseRenderInfo } from '../common/info.js';
+import type { Measurable } from '../measurables/base.js';
+import type { Row } from '../measurables/row.js';
+import type { ConstantProvider } from './constants.js';
+import { BottomRow } from './measurables/bottom_row.js';
+import { RightConnectionShape } from './measurables/row_elements.js';
+import { TopRow } from './measurables/top_row.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 declare class RenderInfo extends BaseRenderInfo {
+    topRow: TopRow;
+    bottomRow: BottomRow;
+    constants_: ConstantProvider;
+    renderer_: Renderer;
+    isInline: boolean;
+    isMultiRow: boolean;
+    hasStatementInput: boolean;
+    rightSide: RightConnectionShape | null;
+    private readonly rightAlignedDummyInputs;
+    /**
+     * @param renderer The renderer in use.
+     * @param block The block to measure.
+     */
+    constructor(renderer: Renderer, block: BlockSvg);
+    /**
+     * Get the block renderer in use.
+     *
+     * @returns The block renderer in use.
+     */
+    getRenderer(): Renderer;
+    measure(): void;
+    shouldStartNewRow_(currInput: Input, prevInput: Input): boolean;
+    getDesiredRowWidth_(row: Row): number;
+    getInRowSpacing_(prev: Measurable | null, next: Measurable | null): number;
+    getSpacerRowHeight_(prev: Row, next: Row): number;
+    getSpacerRowWidth_(prev: Row, next: Row): number;
+    getElemCenterline_(row: Row, elem: Measurable): number;
+    addInput_(input: Input, activeRow: Row): void;
+    addAlignmentPadding_(row: Row, missingSpace: number): void;
+    /**
+     * Adjust the x position of fields to bump all non-label fields in the first
+     * row past the notch position.  This must be called before `computeBounds`
+     * is called.
+     */
+    protected adjustXPosition_(): void;
+    /**
+     * Finalize the output connection info.  In particular, set the height of the
+     * output connection to match that of the block.  For the right side, add a
+     * right connection shape element and have it match the dimensions of the
+     * output connection.
+     */
+    protected finalizeOutputConnection_(): void;
+    /**
+     * Finalize horizontal alignment of elements on the block.  In particular,
+     * reduce the implicit spacing created by the left and right output connection
+     * shapes by adding setting negative spacing onto the leftmost and rightmost
+     * spacers.
+     */
+    protected finalizeHorizontalAlignment_(): void;
+    /**
+     * Calculate the spacing to reduce the left and right edges by based on the
+     * outer and inner connection shape.
+     *
+     * @param elem The first or last element on a block.
+     * @returns The amount of spacing to reduce the first or last spacer.
+     */
+    protected getNegativeSpacing_(elem: Measurable): number;
+    /**
+     * Finalize vertical alignment of rows on a block.  In particular, reduce the
+     * implicit spacing when a non-shadow block is connected to any of an input
+     * row's inline inputs.
+     */
+    protected finalizeVerticalAlignment_(): void;
+    finalize_(): void;
+}
+//# sourceMappingURL=info.d.ts.map

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

@@ -0,0 +1,26 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../../block_svg.js';
+import type { ConstantProvider } from '../../../renderers/common/constants.js';
+import { BottomRow as BaseBottomRow } from '../../../renderers/measurables/bottom_row.js';
+/**
+ * An object containing information about what elements are in the bottom row of
+ * a block as well as spacing information for the top row.
+ * Elements in a bottom row can consist of corners, spacers and next
+ * connections.
+ */
+export declare class BottomRow extends BaseBottomRow {
+    /**
+     * @param constants The rendering constants provider.
+     */
+    constructor(constants: ConstantProvider);
+    endsWithElemSpacer(): boolean;
+    /** Render a round corner unless the block has an output connection. */
+    hasLeftSquareCorner(block: BlockSvg): boolean;
+    /** Render a round corner unless the block has an output connection. */
+    hasRightSquareCorner(block: BlockSvg): false;
+}
+//# sourceMappingURL=bottom_row.d.ts.map

package/core/renderers/zelos/measurables/inputs.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Input } from '../../../inputs/input.js';
+import type { ConstantProvider } from '../../../renderers/common/constants.js';
+import { StatementInput as BaseStatementInput } from '../../../renderers/measurables/statement_input.js';
+/**
+ * An object containing information about the space a statement input takes up
+ * during rendering.
+ */
+export declare class StatementInput extends BaseStatementInput {
+    connectedBottomNextConnection: boolean;
+    /**
+     * @param constants The rendering constants provider.
+     * @param input The statement input to measure and store information for.
+     */
+    constructor(constants: ConstantProvider, input: Input);
+}
+//# sourceMappingURL=inputs.d.ts.map

package/core/renderers/zelos/measurables/row_elements.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ConstantProvider } from '../../../renderers/common/constants.js';
+import { Measurable } from '../../../renderers/measurables/base.js';
+/**
+ * An object containing information about the space a right connection shape
+ * takes up during rendering.
+ */
+export declare class RightConnectionShape extends Measurable {
+    height: number;
+    width: number;
+    /**
+     * @param constants The rendering constants provider.
+     */
+    constructor(constants: ConstantProvider);
+}
+//# sourceMappingURL=row_elements.d.ts.map

package/core/renderers/zelos/measurables/top_row.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 { ConstantProvider } from '../../../renderers/common/constants.js';
+import { TopRow as BaseTopRow } from '../../../renderers/measurables/top_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 BaseTopRow {
+    /**
+     * @param constants The rendering constants provider.
+     */
+    constructor(constants: ConstantProvider);
+    endsWithElemSpacer(): boolean;
+    /** Render a round corner unless the block has an output connection. */
+    hasLeftSquareCorner(block: BlockSvg): boolean;
+    /** Render a round corner unless the block has an output connection. */
+    hasRightSquareCorner(block: BlockSvg): false;
+}
+//# sourceMappingURL=top_row.d.ts.map

package/core/renderers/zelos/path_object.d.ts

@@ -0,0 +1,76 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import type { Connection } from '../../connection.js';
+import type { BlockStyle } from '../../theme.js';
+import { PathObject as BasePathObject } from '../common/path_object.js';
+import type { ConstantProvider } from './constants.js';
+/**
+ * An object that handles creating and setting each of the SVG elements
+ * used by the renderer.
+ */
+export declare class PathObject extends BasePathObject {
+    /** The selected path of the block. */
+    private svgPathSelected;
+    /** The outline paths on the block. */
+    private readonly outlines;
+    /**
+     * A set used to determine which outlines were used during a draw pass.  The
+     * set is initialized with a reference to all the outlines in
+     * `this.outlines`. Every time we use an outline during the draw pass, the
+     * reference is removed from this set.
+     */
+    private remainingOutlines;
+    /**
+     * The type of block's output connection shape.  This is set when a block
+     * with an output connection is drawn.
+     */
+    outputShapeType: number | null;
+    constants: ConstantProvider;
+    /**
+     * @param root The root SVG element.
+     * @param style The style object to use for colouring.
+     * @param constants The renderer's constants.
+     */
+    constructor(root: SVGElement, style: BlockStyle, constants: ConstantProvider);
+    setPath(pathString: string): void;
+    applyColour(block: BlockSvg): void;
+    flipRTL(): void;
+    updateSelected(enable: boolean): void;
+    updateReplacementFade(enable: boolean): void;
+    updateShapeForInputHighlight(conn: Connection, enable: boolean): void;
+    /**
+     * Method that's called when the drawer is about to draw the block.
+     */
+    beginDrawing(): void;
+    /**
+     * Method that's called when the drawer is done drawing.
+     */
+    endDrawing(): void;
+    /**
+     * Set the path generated by the renderer for an outline path on the
+     * respective outline path SVG element.
+     *
+     * @param name The input name.
+     * @param pathString The path.
+     */
+    setOutlinePath(name: string, pathString: string): void;
+    /**
+     * Create's an outline path for the specified input.
+     *
+     * @internal
+     * @param name The input name.
+     * @returns The SVG outline path.
+     */
+    getOutlinePath(name: string): SVGElement;
+    /**
+     * Remove an outline path that is associated with the specified input.
+     *
+     * @param name The input name.
+     */
+    private removeOutlinePath;
+}
+//# sourceMappingURL=path_object.d.ts.map

package/core/renderers/zelos/renderer.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import type { BlockStyle } from '../../theme.js';
+import type { RenderInfo as BaseRenderInfo } from '../common/info.js';
+import { Renderer as BaseRenderer } from '../common/renderer.js';
+import { ConstantProvider } from './constants.js';
+import { Drawer } from './drawer.js';
+import { RenderInfo } from './info.js';
+import { PathObject } from './path_object.js';
+/**
+ * The zelos renderer. This renderer emulates Scratch-style and MakeCode-style
+ * rendering.
+ *
+ * Zelos is the ancient Greek spirit of rivalry and emulation.
+ */
+export declare class Renderer extends BaseRenderer {
+    protected constants_: ConstantProvider;
+    /**
+     * @param name The renderer name.
+     */
+    constructor(name: string);
+    /**
+     * Create a new instance of the renderer's constant provider.
+     *
+     * @returns The constant provider.
+     */
+    protected makeConstants_(): ConstantProvider;
+    /**
+     * Create a new instance of the renderer's render info object.
+     *
+     * @param block The block to measure.
+     * @returns The render info object.
+     */
+    protected makeRenderInfo_(block: BlockSvg): RenderInfo;
+    /**
+     * Create a new instance of the renderer's drawer.
+     *
+     * @param block The block to render.
+     * @param info An object containing all information needed to render this
+     *     block.
+     * @returns The drawer.
+     */
+    protected makeDrawer_(block: BlockSvg, info: BaseRenderInfo): Drawer;
+    /**
+     * Create a new instance of a renderer path object.
+     *
+     * @param root The root SVG element.
+     * @param style The style object to use for colouring.
+     * @returns The renderer path object.
+     */
+    makePathObject(root: SVGElement, style: BlockStyle): PathObject;
+    /**
+     * Get the current renderer's constant provider.  We assume that when this is
+     * called, the renderer has already been initialized.
+     *
+     * @returns The constant provider.
+     */
+    getConstants(): ConstantProvider;
+}
+//# sourceMappingURL=renderer.d.ts.map

package/core/renderers/zelos/zelos.d.ts

@@ -0,0 +1,17 @@
+/** @file Re-exports of Blockly.zelos.* modules. */
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ConstantProvider } from './constants.js';
+import { Drawer } from './drawer.js';
+import { RenderInfo } from './info.js';
+import { BottomRow } from './measurables/bottom_row.js';
+import { StatementInput } from './measurables/inputs.js';
+import { RightConnectionShape } from './measurables/row_elements.js';
+import { TopRow } from './measurables/top_row.js';
+import { PathObject } from './path_object.js';
+import { Renderer } from './renderer.js';
+export { BottomRow, ConstantProvider, Drawer, PathObject, Renderer, RenderInfo, RightConnectionShape, StatementInput, TopRow, };
+//# sourceMappingURL=zelos.d.ts.map