blockly 8.0.5 → 9.0.0-beta.0

package/core/renderers/measurables/types.ts

@@ -0,0 +1,332 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Measurable types.
+ */
+
+/**
+ * Measurable types.
+ * @namespace Blockly.blockRendering.Types
+ */
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.blockRendering.Types');
+
+import type {Measurable} from './base.js';
+import type {Row} from './row.js';
+
+
+/**
+ * Types of rendering elements.
+ * @alias Blockly.blockRendering.Types
+ */
+class TypesContainer {
+  [index: string]: number|Function;
+
+  NONE = 0;                       // None
+  FIELD = 1 << 0;                 // Field.
+  HAT = 1 << 1;                   // Hat.
+  ICON = 1 << 2;                  // Icon.
+  SPACER = 1 << 3;                // Spacer.
+  BETWEEN_ROW_SPACER = 1 << 4;    // Between Row Spacer.
+  IN_ROW_SPACER = 1 << 5;         // In Row Spacer.
+  EXTERNAL_VALUE_INPUT = 1 << 6;  // External Value Input.
+  INPUT = 1 << 7;                 // Input.
+  INLINE_INPUT = 1 << 8;          // Inline Input.
+  STATEMENT_INPUT = 1 << 9;       // Statement Input.
+  CONNECTION = 1 << 10;           // Connection.
+  PREVIOUS_CONNECTION = 1 << 11;  // Previous Connection.
+  NEXT_CONNECTION = 1 << 12;      // Next Connection.
+  OUTPUT_CONNECTION = 1 << 13;    // Output Connection.
+  CORNER = 1 << 14;               // Corner.
+  LEFT_SQUARE_CORNER = 1 << 15;   // Square Corner.
+  LEFT_ROUND_CORNER = 1 << 16;    // Round Corner.
+  RIGHT_SQUARE_CORNER = 1 << 17;  // Right Square Corner.
+  RIGHT_ROUND_CORNER = 1 << 18;   // Right Round Corner.
+  JAGGED_EDGE = 1 << 19;          // Jagged Edge.
+  ROW = 1 << 20;                  // Row.
+  TOP_ROW = 1 << 21;              // Top Row.
+  BOTTOM_ROW = 1 << 22;           // Bottom Row.
+  INPUT_ROW = 1 << 23;            // Input Row.
+
+  /**
+   * A Left Corner Union Type.
+   * @internal
+   */
+  LEFT_CORNER = this.LEFT_SQUARE_CORNER | this.LEFT_ROUND_CORNER;
+
+  /**
+   * A Right Corner Union Type.
+   * @internal
+   */
+  RIGHT_CORNER = this.RIGHT_SQUARE_CORNER | this.RIGHT_ROUND_CORNER;
+
+  /**
+   * 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_ = 1 << 24;
+
+  /**
+   * Get the enum flag value of an existing type or register a new type.
+   * @param type The name of the type.
+   * @return The enum flag value associated with that type.
+   * @internal
+   */
+  getType(type: string): number {
+    if (!Object.prototype.hasOwnProperty.call(this, type)) {
+      this[type] = this.nextTypeValue_;
+      this.nextTypeValue_ <<= 1;
+    }
+    return this[type] as number;
+  }
+
+  /**
+   * Whether a measurable stores information about a field.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a field.
+   * @internal
+   */
+  isField(elem: Measurable): number {
+    return elem.type & this.FIELD;
+  }
+
+  /**
+   * Whether a measurable stores information about a hat.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a hat.
+   * @internal
+   */
+  isHat(elem: Measurable): number {
+    return elem.type & this.HAT;
+  }
+
+  /**
+   * Whether a measurable stores information about an icon.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about an icon.
+   * @internal
+   */
+  isIcon(elem: Measurable): number {
+    return elem.type & this.ICON;
+  }
+
+  /**
+   * Whether a measurable stores information about a spacer.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a spacer.
+   * @internal
+   */
+  isSpacer(elem: Measurable|Row): number {
+    return elem.type & this.SPACER;
+  }
+
+  /**
+   * Whether a measurable stores information about an in-row spacer.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about an in-row spacer.
+   * @internal
+   */
+  isInRowSpacer(elem: Measurable): number {
+    return elem.type & this.IN_ROW_SPACER;
+  }
+
+  /**
+   * Whether a measurable stores information about an input.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about an input.
+   * @internal
+   */
+  isInput(elem: Measurable): number {
+    return elem.type & this.INPUT;
+  }
+
+  /**
+   * Whether a measurable stores information about an external input.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about an external input.
+   * @internal
+   */
+  isExternalInput(elem: Measurable): number {
+    return elem.type & this.EXTERNAL_VALUE_INPUT;
+  }
+
+  /**
+   * Whether a measurable stores information about an inline input.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about an inline input.
+   * @internal
+   */
+  isInlineInput(elem: Measurable): number {
+    return elem.type & this.INLINE_INPUT;
+  }
+
+  /**
+   * Whether a measurable stores information about a statement input.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a statement input.
+   * @internal
+   */
+  isStatementInput(elem: Measurable): number {
+    return elem.type & this.STATEMENT_INPUT;
+  }
+
+  /**
+   * Whether a measurable stores information about a previous connection.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a previous connection.
+   * @internal
+   */
+  isPreviousConnection(elem: Measurable): number {
+    return elem.type & this.PREVIOUS_CONNECTION;
+  }
+
+  /**
+   * Whether a measurable stores information about a next connection.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a next connection.
+   * @internal
+   */
+  isNextConnection(elem: Measurable): number {
+    return elem.type & this.NEXT_CONNECTION;
+  }
+
+  /**
+   * Whether a measurable stores information about a previous or next
+   * connection.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a previous or next
+   *     connection.
+   * @internal
+   */
+  isPreviousOrNextConnection(elem: Measurable): number {
+    return elem.type & (this.PREVIOUS_CONNECTION | this.NEXT_CONNECTION);
+  }
+
+  /**
+   * Whether a measurable stores information about a left round corner.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a left round corner.
+   * @internal
+   */
+  isLeftRoundedCorner(elem: Measurable): number {
+    return elem.type & this.LEFT_ROUND_CORNER;
+  }
+
+  /**
+   * Whether a measurable stores information about a right round corner.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a right round corner.
+   * @internal
+   */
+  isRightRoundedCorner(elem: Measurable): number {
+    return elem.type & this.RIGHT_ROUND_CORNER;
+  }
+
+  /**
+   * Whether a measurable stores information about a left square corner.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a left square corner.
+   * @internal
+   */
+  isLeftSquareCorner(elem: Measurable): number {
+    return elem.type & this.LEFT_SQUARE_CORNER;
+  }
+
+  /**
+   * Whether a measurable stores information about a right square corner.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a right square corner.
+   * @internal
+   */
+  isRightSquareCorner(elem: Measurable): number {
+    return elem.type & this.RIGHT_SQUARE_CORNER;
+  }
+
+  /**
+   * Whether a measurable stores information about a corner.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a corner.
+   * @internal
+   */
+  isCorner(elem: Measurable): number {
+    return elem.type & this.CORNER;
+  }
+
+  /**
+   * Whether a measurable stores information about a jagged edge.
+   * @param elem The element to check.
+   * @return 1 if the object stores information about a jagged edge.
+   * @internal
+   */
+  isJaggedEdge(elem: Measurable): number {
+    return elem.type & this.JAGGED_EDGE;
+  }
+
+  /**
+   * Whether a measurable stores information about a row.
+   * @param row The row to check.
+   * @return 1 if the object stores information about a row.
+   * @internal
+   */
+  isRow(row: Row): number {
+    return row.type & this.ROW;
+  }
+
+  /**
+   * Whether a measurable stores information about a between-row spacer.
+   * @param row The row to check.
+   * @return 1 if the object stores information about a between-row spacer.
+   * @internal
+   */
+  isBetweenRowSpacer(row: Row): number {
+    return row.type & this.BETWEEN_ROW_SPACER;
+  }
+
+  /**
+   * Whether a measurable stores information about a top row.
+   * @param row The row to check.
+   * @return 1 if the object stores information about a top row.
+   * @internal
+   */
+  isTopRow(row: Row): number {
+    return row.type & this.TOP_ROW;
+  }
+
+  /**
+   * Whether a measurable stores information about a bottom row.
+   * @param row The row to check.
+   * @return 1 if the object stores information about a bottom row.
+   * @internal
+   */
+  isBottomRow(row: Row): number {
+    return row.type & this.BOTTOM_ROW;
+  }
+
+  /**
+   * Whether a measurable stores information about a top or bottom row.
+   * @param row The row to check.
+   * @return 1 if the object stores information about a top or bottom row.
+   * @internal
+   */
+  isTopOrBottomRow(row: Row): number {
+    return row.type & (this.TOP_ROW | this.BOTTOM_ROW);
+  }
+
+  /**
+   * Whether a measurable stores information about an input row.
+   * @param row The row to check.
+   * @return 1 if the object stores information about an input row.
+   * @internal
+   */
+  isInputRow(row: Row): number {
+    return row.type & this.INPUT_ROW;
+  }
+}
+
+export const Types = new TypesContainer();

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

@@ -0,0 +1,14 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { ConstantProvider as BaseConstantProvider } from '../common/constants.js';
+/**
+ * An object that provides constants for rendering blocks in the sample.
+ * @alias Blockly.minimalist.ConstantProvider
+ */
+export declare class ConstantProvider extends BaseConstantProvider {
+    /** @internal */
+    constructor();
+}

package/core/renderers/minimalist/{constants.js → constants.ts}

@@ -8,30 +8,25 @@
  * @fileoverview An object that provides constants for rendering blocks in the
  * minimalist renderer.
  */
-'use strict';
 
 /**
  * An object that provides constants for rendering blocks in the
  * minimalist renderer.
  * @class
  */
-goog.module('Blockly.minimalist.ConstantProvider');
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.minimalist.ConstantProvider');
 
-const {ConstantProvider: BaseConstantProvider} = goog.require('Blockly.blockRendering.ConstantProvider');
+import {ConstantProvider as BaseConstantProvider} from '../common/constants.js';
 
 
 /**
  * An object that provides constants for rendering blocks in the sample.
- * @extends {BaseConstantProvider}
  * @alias Blockly.minimalist.ConstantProvider
  */
-class ConstantProvider extends BaseConstantProvider {
-  /**
-   * @package
-   */
+export class ConstantProvider extends BaseConstantProvider {
+  /** @internal */
   constructor() {
     super();
   }
 }
-
-exports.ConstantProvider = ConstantProvider;

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

@@ -0,0 +1,21 @@
+/**
+ * @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 { RenderInfo } from './info.js';
+/**
+ * An object that draws a block based on the given rendering information.
+ * @alias Blockly.minimalist.Drawer
+ */
+export declare class Drawer extends BaseDrawer {
+    /**
+     * @param block The block to render.
+     * @param info An object containing all information needed to render this
+     *     block.
+     * @internal
+     */
+    constructor(block: BlockSvg, info: RenderInfo);
+}

package/core/renderers/minimalist/drawer.ts

@@ -0,0 +1,38 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Minimalist rendering drawer.
+ */
+
+/**
+ * Minimalist rendering drawer.
+ * @class
+ */
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.minimalist.Drawer');
+
+import type {BlockSvg} from '../../block_svg.js';
+import {Drawer as BaseDrawer} from '../common/drawer.js';
+
+import type {RenderInfo} from './info.js';
+
+
+/**
+ * An object that draws a block based on the given rendering information.
+ * @alias Blockly.minimalist.Drawer
+ */
+export class Drawer extends BaseDrawer {
+  /**
+   * @param block The block to render.
+   * @param info An object containing all information needed to render this
+   *     block.
+   * @internal
+   */
+  constructor(block: BlockSvg, info: RenderInfo) {
+    super(block, info);
+  }
+}

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

@@ -0,0 +1,30 @@
+/**
+ * @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 { 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.minimalist.RenderInfo
+ */
+export declare class RenderInfo extends BaseRenderInfo {
+    /**
+     * @param renderer The renderer in use.
+     * @param block The block to measure.
+     * @internal
+     */
+    constructor(renderer: Renderer, block: BlockSvg);
+    /**
+     * Get the block renderer in use.
+     * @return The block renderer in use.
+     * @internal
+     */
+    getRenderer(): Renderer;
+}

package/core/renderers/minimalist/info.ts

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Minimalist render info object.
+ */
+
+/**
+ * Minimalist render info object.
+ * @class
+ */
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.minimalist.RenderInfo');
+
+import type {BlockSvg} from '../../block_svg.js';
+import {RenderInfo as BaseRenderInfo} from '../common/info.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.minimalist.RenderInfo
+ */
+export class RenderInfo extends BaseRenderInfo {
+  /**
+   * @param renderer The renderer in use.
+   * @param block The block to measure.
+   * @internal
+   */
+  constructor(renderer: Renderer, block: BlockSvg) {
+    super(renderer, block);
+  }
+
+  /**
+   * Get the block renderer in use.
+   * @return The block renderer in use.
+   * @internal
+   */
+  override getRenderer(): Renderer {
+    // AnyDuringMigration because:  Property 'renderer_' does not exist on type
+    // 'RenderInfo'.
+    return (this as AnyDuringMigration).renderer_ as Renderer;
+  }
+}

package/core/renderers/minimalist/minimalist.d.ts

@@ -0,0 +1,6 @@
+/** @fileoverview Re-exports of Blockly.minimalist.* modules. */
+import { ConstantProvider } from './constants.js';
+import { Drawer } from './drawer.js';
+import { RenderInfo } from './info.js';
+import { Renderer } from './renderer.js';
+export { ConstantProvider, Drawer, Renderer, RenderInfo };

package/core/renderers/minimalist/minimalist.ts

@@ -0,0 +1,22 @@
+/** @fileoverview Re-exports of Blockly.minimalist.* modules. */
+
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * Re-exports of Blockly.minimalist.* modules.
+ * @namespace Blockly.minimalist
+ */
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.minimalist');
+
+import {ConstantProvider} from './constants.js';
+import {Drawer} from './drawer.js';
+import {RenderInfo} from './info.js';
+import {Renderer} from './renderer.js';
+
+
+export {ConstantProvider, Drawer, Renderer, RenderInfo};

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

@@ -0,0 +1,41 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { BlockSvg } from '../../block_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';
+/**
+ * The minimalist renderer.
+ * @alias Blockly.minimalist.Renderer
+ */
+export declare class Renderer extends BaseRenderer {
+    /**
+     * @param name The renderer name.
+     * @internal
+     */
+    constructor(name: string);
+    /**
+     * Create a new instance of the renderer's constant provider.
+     * @return The constant provider.
+     */
+    protected makeConstants_(): ConstantProvider;
+    /**
+     * Create a new instance of the renderer's render info object.
+     * @param block The block to measure.
+     * @return 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.
+     * @return The drawer.
+     */
+    protected makeDrawer_(block: BlockSvg, info: BaseRenderInfo): Drawer;
+}

package/core/renderers/minimalist/renderer.ts

@@ -0,0 +1,71 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Minimalist renderer.
+ */
+
+/**
+ * Minimalist renderer.
+ * @class
+ */
+import * as goog from '../../../closure/goog/goog.js';
+goog.declareModuleId('Blockly.minimalist.Renderer');
+
+import type {BlockSvg} from '../../block_svg.js';
+import * as blockRendering from '../common/block_rendering.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';
+
+
+/**
+ * The minimalist renderer.
+ * @alias Blockly.minimalist.Renderer
+ */
+export class Renderer extends BaseRenderer {
+  /**
+   * @param name The renderer name.
+   * @internal
+   */
+  constructor(name: string) {
+    super(name);
+  }
+
+  /**
+   * Create a new instance of the renderer's constant provider.
+   * @return The constant provider.
+   */
+  protected override makeConstants_(): ConstantProvider {
+    return new ConstantProvider();
+  }
+
+  /**
+   * Create a new instance of the renderer's render info object.
+   * @param block The block to measure.
+   * @return The render info object.
+   */
+  protected override makeRenderInfo_(block: BlockSvg): RenderInfo {
+    return new RenderInfo(this, block);
+  }
+
+  /**
+   * 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.
+   * @return The drawer.
+   */
+  protected override makeDrawer_(block: BlockSvg, info: BaseRenderInfo):
+      Drawer {
+    return new Drawer(block, (info as RenderInfo));
+  }
+}
+
+blockRendering.register('minimalist', Renderer);