blockly 8.20220331.0-beta.0 → 9.0.0-beta.1

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

@@ -0,0 +1,50 @@
+/**
+ * @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 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.
+ *
+ * @alias Blockly.zelos.Drawer
+ */
+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.
+     * @internal
+     */
+    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;
+    drawStatementInput_(row: Row): void;
+}
+//# sourceMappingURL=drawer.d.ts.map

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

@@ -0,0 +1,93 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_svg.js';
+import { Input } from '../../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.
+ *
+ * @alias Blockly.zelos.RenderInfo
+ */
+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.
+     * @internal
+     */
+    constructor(renderer: Renderer, block: BlockSvg);
+    /**
+     * Get the block renderer in use.
+     *
+     * @returns The block renderer in use.
+     * @internal
+     */
+    getRenderer(): Renderer;
+    measure(): void;
+    shouldStartNewRow_(input: Input, lastInput: 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/marker_svg.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ASTNode } from '../../keyboard_nav/ast_node.js';
+import type { Marker } from '../../keyboard_nav/marker.js';
+import type { WorkspaceSvg } from '../../workspace_svg.js';
+import type { ConstantProvider as BaseConstantProvider } from '../common/constants.js';
+import { MarkerSvg as BaseMarkerSvg } from '../common/marker_svg.js';
+import type { ConstantProvider as ZelosConstantProvider } from './constants.js';
+/**
+ * Class to draw a marker.
+ *
+ * @alias Blockly.zelos.MarkerSvg
+ */
+export declare class MarkerSvg extends BaseMarkerSvg {
+    constants_: ZelosConstantProvider;
+    private markerCircle_;
+    /**
+     * @param workspace The workspace the marker belongs to.
+     * @param constants The constants for the renderer.
+     * @param marker The marker to draw.
+     */
+    constructor(workspace: WorkspaceSvg, constants: BaseConstantProvider, marker: Marker);
+    /**
+     * Position and display the marker for an input or an output connection.
+     *
+     * @param curNode The node to draw the marker for.
+     */
+    private showWithInputOutput_;
+    showWithOutput_(curNode: ASTNode): void;
+    showWithInput_(curNode: ASTNode): void;
+    /**
+     * Draw a rectangle around the block.
+     *
+     * @param curNode The current node of the marker.
+     */
+    showWithBlock_(curNode: ASTNode): void;
+    /**
+     * Position the circle we use for input and output connections.
+     *
+     * @param x The x position of the circle.
+     * @param y The y position of the circle.
+     */
+    private positionCircle_;
+    hide(): void;
+    createDomInternal_(): SVGGElement;
+    applyColour_(curNode: ASTNode): void;
+}
+//# sourceMappingURL=marker_svg.d.ts.map

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

@@ -0,0 +1,29 @@
+/**
+ * @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.
+ *
+ * @alias Blockly.zelos.BottomRow
+ */
+export declare class BottomRow extends BaseBottomRow {
+    /**
+     * @param constants The rendering constants provider.
+     * @internal
+     */
+    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,25 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Input } from '../../../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.
+ *
+ * @alias Blockly.zelos.StatementInput
+ */
+export declare class StatementInput extends BaseStatementInput {
+    connectedBottomNextConnection: boolean;
+    height: any;
+    /**
+     * @param constants The rendering constants provider.
+     * @param input The statement input to measure and store information for.
+     * @internal
+     */
+    constructor(constants: ConstantProvider, input: Input);
+}
+//# sourceMappingURL=inputs.d.ts.map

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

@@ -0,0 +1,23 @@
+/**
+ * @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.
+ *
+ * @alias Blockly.zelos.RightConnectionShape
+ */
+export declare class RightConnectionShape extends Measurable {
+    height: number;
+    width: number;
+    /**
+     * @param constants The rendering constants provider.
+     * @internal
+     */
+    constructor(constants: ConstantProvider);
+}
+//# sourceMappingURL=row_elements.d.ts.map

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

@@ -0,0 +1,31 @@
+/**
+ * @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.
+ *
+ * @alias Blockly.zelos.TopRow
+ */
+export declare class TopRow extends BaseTopRow {
+    /**
+     * @param constants The rendering constants provider.
+     * @internal
+     */
+    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,84 @@
+/**
+ * @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.
+ *
+ * @alias Blockly.zelos.PathObject
+ */
+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: null;
+    /** @internal */
+    constants: ConstantProvider;
+    /**
+     * @param root The root SVG element.
+     * @param style The style object to use for colouring.
+     * @param constants The renderer's constants.
+     * @internal
+     */
+    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.
+     *
+     * @internal
+     */
+    beginDrawing(): void;
+    /**
+     * Method that's called when the drawer is done drawing.
+     *
+     * @internal
+     */
+    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.
+     * @internal
+     */
+    setOutlinePath(name: string, pathString: string): void;
+    /**
+     * Create's an outline path for the specified input.
+     *
+     * @param name The input name.
+     * @returns The SVG outline path.
+     */
+    private getOutlinePath_;
+    /**
+     * 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,82 @@
+/**
+ * @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 { InsertionMarkerManager } from '../../insertion_marker_manager.js';
+import type { Marker } from '../../keyboard_nav/marker.js';
+import type { RenderedConnection } from '../../rendered_connection.js';
+import type { BlockStyle } from '../../theme.js';
+import type { WorkspaceSvg } from '../../workspace_svg.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 { MarkerSvg } from './marker_svg.js';
+import { PathObject } from './path_object.js';
+/**
+ * The zelos renderer.
+ *
+ * @alias Blockly.zelos.Renderer
+ */
+export declare class Renderer extends BaseRenderer {
+    protected constants_: ConstantProvider;
+    /**
+     * @param name The renderer name.
+     * @internal
+     */
+    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 the renderer's cursor drawer.
+     *
+     * @param workspace The workspace the cursor belongs to.
+     * @param marker The marker.
+     * @returns The object in charge of drawing the marker.
+     * @internal
+     */
+    makeMarkerDrawer(workspace: WorkspaceSvg, marker: Marker): MarkerSvg;
+    /**
+     * 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.
+     * @internal
+     */
+    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;
+    shouldHighlightConnection(conn: Connection): boolean;
+    getConnectionPreviewMethod(closest: RenderedConnection, local: RenderedConnection, topBlock: BlockSvg): InsertionMarkerManager.PREVIEW_TYPE;
+}
+//# sourceMappingURL=renderer.d.ts.map

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

@@ -0,0 +1,13 @@
+/** @file Re-exports of Blockly.zelos.* modules. */
+import { ConstantProvider } from './constants.js';
+import { Drawer } from './drawer.js';
+import { RenderInfo } from './info.js';
+import { MarkerSvg } from './marker_svg.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, MarkerSvg, PathObject, Renderer, RenderInfo, RightConnectionShape, StatementInput, TopRow, };
+//# sourceMappingURL=zelos.d.ts.map