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

package/core/variables_dynamic.ts

@@ -1,133 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Utility functions for handling typed variables.
- */
-
-/**
- * Utility functions for handling typed variables.
- *
- * @namespace Blockly.VariablesDynamic
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.VariablesDynamic');
-
-import {Blocks} from './blocks.js';
-import {Msg} from './msg.js';
-import * as xml from './utils/xml.js';
-import {VariableModel} from './variable_model.js';
-import * as Variables from './variables.js';
-import type {Workspace} from './workspace.js';
-import type {WorkspaceSvg} from './workspace_svg.js';
-
-
-/**
- * String for use in the "custom" attribute of a category in toolbox XML.
- * This string indicates that the category should be dynamically populated with
- * variable blocks.
- * See also Blockly.Variables.CATEGORY_NAME and
- * Blockly.Procedures.CATEGORY_NAME.
- * @alias Blockly.VariablesDynamic.CATEGORY_NAME
- */
-export const CATEGORY_NAME = 'VARIABLE_DYNAMIC';
-
-function stringButtonClickHandler(button: AnyDuringMigration) {
-  Variables.createVariableButtonHandler(
-      button.getTargetWorkspace(), undefined, 'String');
-}
-export const onCreateVariableButtonClick_String = stringButtonClickHandler;
-function numberButtonClickHandler(button: AnyDuringMigration) {
-  Variables.createVariableButtonHandler(
-      button.getTargetWorkspace(), undefined, 'Number');
-}
-export const onCreateVariableButtonClick_Number = numberButtonClickHandler;
-
-function colourButtonClickHandler(button: AnyDuringMigration) {
-  Variables.createVariableButtonHandler(
-      button.getTargetWorkspace(), undefined, 'Colour');
-}
-export const onCreateVariableButtonClick_Colour = colourButtonClickHandler;
-
-/**
- * Construct the elements (blocks and button) required by the flyout for the
- * variable category.
- * @param workspace The workspace containing variables.
- * @return Array of XML elements.
- * @alias Blockly.VariablesDynamic.flyoutCategory
- */
-export function flyoutCategory(workspace: WorkspaceSvg): Element[] {
-  let xmlList = new Array<Element>();
-  let button = document.createElement('button');
-  button.setAttribute('text', Msg['NEW_STRING_VARIABLE']);
-  button.setAttribute('callbackKey', 'CREATE_VARIABLE_STRING');
-  xmlList.push(button);
-  button = document.createElement('button');
-  button.setAttribute('text', Msg['NEW_NUMBER_VARIABLE']);
-  button.setAttribute('callbackKey', 'CREATE_VARIABLE_NUMBER');
-  xmlList.push(button);
-  button = document.createElement('button');
-  button.setAttribute('text', Msg['NEW_COLOUR_VARIABLE']);
-  button.setAttribute('callbackKey', 'CREATE_VARIABLE_COLOUR');
-  xmlList.push(button);
-
-  workspace.registerButtonCallback(
-      'CREATE_VARIABLE_STRING', stringButtonClickHandler);
-  workspace.registerButtonCallback(
-      'CREATE_VARIABLE_NUMBER', numberButtonClickHandler);
-  workspace.registerButtonCallback(
-      'CREATE_VARIABLE_COLOUR', colourButtonClickHandler);
-
-  // AnyDuringMigration because:  Argument of type 'WorkspaceSvg' is not
-  // assignable to parameter of type 'Workspace'.
-  const blockList = flyoutCategoryBlocks(workspace as AnyDuringMigration);
-  xmlList = xmlList.concat(blockList);
-  return xmlList;
-}
-
-/**
- * Construct the blocks required by the flyout for the variable category.
- * @param workspace The workspace containing variables.
- * @return Array of XML block elements.
- * @alias Blockly.VariablesDynamic.flyoutCategoryBlocks
- */
-export function flyoutCategoryBlocks(workspace: Workspace): Element[] {
-  const variableModelList = workspace.getAllVariables();
-
-  const xmlList = [];
-  if (variableModelList.length > 0) {
-    if (Blocks['variables_set_dynamic']) {
-      const firstVariable = variableModelList[variableModelList.length - 1];
-      const block = xml.createElement('block');
-      block.setAttribute('type', 'variables_set_dynamic');
-      // AnyDuringMigration because:  Argument of type 'number' is not
-      // assignable to parameter of type 'string'.
-      block.setAttribute('gap', 24 as AnyDuringMigration);
-      // AnyDuringMigration because:  Argument of type 'Element | null' is not
-      // assignable to parameter of type 'Node'.
-      block.appendChild(
-          Variables.generateVariableFieldDom(firstVariable) as
-          AnyDuringMigration);
-      xmlList.push(block);
-    }
-    if (Blocks['variables_get_dynamic']) {
-      variableModelList.sort(VariableModel.compareByName);
-      for (let i = 0, variable; variable = variableModelList[i]; i++) {
-        const block = xml.createElement('block');
-        block.setAttribute('type', 'variables_get_dynamic');
-        // AnyDuringMigration because:  Argument of type 'number' is not
-        // assignable to parameter of type 'string'.
-        block.setAttribute('gap', 8 as AnyDuringMigration);
-        // AnyDuringMigration because:  Argument of type 'Element | null' is not
-        // assignable to parameter of type 'Node'.
-        block.appendChild(
-            Variables.generateVariableFieldDom(variable) as AnyDuringMigration);
-        xmlList.push(block);
-      }
-    }
-  }
-  return xmlList;
-}

package/core/warning.ts

@@ -1,161 +0,0 @@
-/**
- * @license
- * Copyright 2012 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Object representing a warning.
- */
-
-/**
- * Object representing a warning.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Warning');
-
-// Unused import preserved for side-effects. Remove if unneeded.
-import './events/events_bubble_open.js';
-
-import type {BlockSvg} from './block_svg.js';
-import {Bubble} from './bubble.js';
-import * as eventUtils from './events/utils.js';
-import {Icon} from './icon.js';
-import type {Coordinate} from './utils/coordinate.js';
-import * as dom from './utils/dom.js';
-import {Svg} from './utils/svg.js';
-
-
-/**
- * Class for a warning.
- * @alias Blockly.Warning
- */
-export class Warning extends Icon {
-  text_: AnyDuringMigration;
-
-  /** The top-level node of the warning text, or null if not created. */
-  private paragraphElement_: SVGTextElement|null = null;
-
-  /** Does this icon get hidden when the block is collapsed? */
-  override collapseHidden = false;
-  override bubble_: AnyDuringMigration;
-
-  /** @param block The block associated with this warning. */
-  constructor(block: BlockSvg) {
-    super(block);
-    this.createIcon();
-    // The text_ object can contain multiple warnings.
-    this.text_ = Object.create(null);
-  }
-
-  /**
-   * Draw the warning icon.
-   * @param group The icon group.
-   */
-  protected override drawIcon_(group: Element) {
-    // Triangle with rounded corners.
-    dom.createSvgElement(
-        Svg.PATH, {
-          'class': 'blocklyIconShape',
-          'd': 'M2,15Q-1,15 0.5,12L6.5,1.7Q8,-1 9.5,1.7L15.5,12Q17,15 14,15z',
-        },
-        group);
-    // Can't use a real '!' text character since different browsers and
-    // operating systems render it differently. Body of exclamation point.
-    dom.createSvgElement(
-        Svg.PATH, {
-          'class': 'blocklyIconSymbol',
-          'd': 'm7,4.8v3.16l0.27,2.27h1.46l0.27,-2.27v-3.16z',
-        },
-        group);
-    // Dot of exclamation point.
-    dom.createSvgElement(
-        Svg.RECT, {
-          'class': 'blocklyIconSymbol',
-          'x': '7',
-          'y': '11',
-          'height': '2',
-          'width': '2',
-        },
-        group);
-  }
-
-  /**
-   * Show or hide the warning bubble.
-   * @param visible True if the bubble should be visible.
-   */
-  override setVisible(visible: boolean) {
-    if (visible === this.isVisible()) {
-      return;
-    }
-    // AnyDuringMigration because:  Property 'block_' does not exist on type
-    // 'Warning'.
-    eventUtils.fire(new (eventUtils.get(eventUtils.BUBBLE_OPEN))!
-                    ((this as AnyDuringMigration).block_, visible, 'warning'));
-    if (visible) {
-      this.createBubble_();
-    } else {
-      this.disposeBubble_();
-    }
-  }
-
-  /** Show the bubble. */
-  private createBubble_() {
-    this.paragraphElement_ = Bubble.textToDom(this.getText());
-    // AnyDuringMigration because:  Property 'block_' does not exist on type
-    // 'Warning'.
-    this.bubble_ = Bubble.createNonEditableBubble(
-        this.paragraphElement_, (this as AnyDuringMigration).block_ as BlockSvg,
-        this.iconXY_ as Coordinate);
-    this.applyColour();
-  }
-
-  /** Dispose of the bubble and references to it. */
-  private disposeBubble_() {
-    this.bubble_.dispose();
-    this.bubble_ = null;
-    this.paragraphElement_ = null;
-  }
-
-  /**
-   * Set this warning's text.
-   * @param text Warning text (or '' to delete). This supports linebreaks.
-   * @param id An ID for this text entry to be able to maintain multiple
-   *     warnings.
-   */
-  setText(text: string, id: string) {
-    if (this.text_[id] === text) {
-      return;
-    }
-    if (text) {
-      this.text_[id] = text;
-    } else {
-      delete this.text_[id];
-    }
-    if (this.isVisible()) {
-      this.setVisible(false);
-      this.setVisible(true);
-    }
-  }
-
-  /**
-   * Get this warning's texts.
-   * @return All texts concatenated into one string.
-   */
-  getText(): string {
-    const allWarnings = [];
-    for (const id in this.text_) {
-      allWarnings.push(this.text_[id]);
-    }
-    return allWarnings.join('\n');
-  }
-
-  /** Dispose of this warning. */
-  override dispose() {
-    // AnyDuringMigration because:  Property 'block_' does not exist on type
-    // 'Warning'.
-    (this as AnyDuringMigration).block_.warning = null;
-    super.dispose();
-  }
-}

package/core/widgetdiv.ts

@@ -1,257 +0,0 @@
-/**
- * @license
- * Copyright 2013 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview A div that floats on top of Blockly.  This singleton contains
- *     temporary HTML UI widgets that the user is currently interacting with.
- *     E.g. text input areas, colour pickers, context menus.
- */
-
-/**
- * A div that floats on top of Blockly.  This singleton contains
- *     temporary HTML UI widgets that the user is currently interacting with.
- *     E.g. text input areas, colour pickers, context menus.
- * @namespace Blockly.WidgetDiv
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.WidgetDiv');
-
-import * as common from './common.js';
-import * as dom from './utils/dom.js';
-import type {Rect} from './utils/rect.js';
-import type {Size} from './utils/size.js';
-import type {WorkspaceSvg} from './workspace_svg.js';
-
-
-/** The object currently using this container. */
-let owner: AnyDuringMigration = null;
-
-/** Optional cleanup function set by whichever object uses the widget. */
-// AnyDuringMigration because:  Type 'null' is not assignable to type
-// 'Function'.
-let dispose: Function = null as AnyDuringMigration;
-
-/** A class name representing the current owner's workspace renderer. */
-let rendererClassName = '';
-
-/** A class name representing the current owner's workspace theme. */
-let themeClassName = '';
-
-/** The HTML container for popup overlays (e.g. editor widgets). */
-let containerDiv: HTMLDivElement|null;
-
-/**
- * Returns the HTML container for editor widgets.
- * @return The editor widget container.
- * @alias Blockly.WidgetDiv.getDiv
- */
-export function getDiv(): HTMLDivElement|null {
-  return containerDiv;
-}
-
-/**
- * Allows unit tests to reset the div.
- * @param newDiv The new value for the DIV field.
- * @alias Blockly.WidgetDiv.testOnly_setDiv
- * @ignore
- */
-export function testOnly_setDiv(newDiv: HTMLDivElement|null) {
-  containerDiv = newDiv;
-}
-
-/**
- * Create the widget div and inject it onto the page.
- * @alias Blockly.WidgetDiv.createDom
- */
-export function createDom() {
-  if (containerDiv) {
-    return;  // Already created.
-  }
-
-  containerDiv = document.createElement('div') as HTMLDivElement;
-  containerDiv.className = 'blocklyWidgetDiv';
-  const container = common.getParentContainer() || document.body;
-  container.appendChild(containerDiv);
-}
-
-/**
- * Initialize and display the widget div.  Close the old one if needed.
- * @param newOwner The object that will be using this container.
- * @param rtl Right-to-left (true) or left-to-right (false).
- * @param newDispose Optional cleanup function to be run when the widget is
- *     closed.
- * @alias Blockly.WidgetDiv.show
- */
-export function show(
-    newOwner: AnyDuringMigration, rtl: boolean, newDispose: Function) {
-  hide();
-  owner = newOwner;
-  dispose = newDispose;
-  const div = containerDiv;
-  div!.style.direction = rtl ? 'rtl' : 'ltr';
-  div!.style.display = 'block';
-  const mainWorkspace = common.getMainWorkspace() as WorkspaceSvg;
-  rendererClassName = mainWorkspace.getRenderer().getClassName();
-  themeClassName = mainWorkspace.getTheme().getClassName();
-  // AnyDuringMigration because:  Argument of type 'HTMLDivElement | null' is
-  // not assignable to parameter of type 'Element'.
-  dom.addClass(div as AnyDuringMigration, rendererClassName);
-  // AnyDuringMigration because:  Argument of type 'HTMLDivElement | null' is
-  // not assignable to parameter of type 'Element'.
-  dom.addClass(div as AnyDuringMigration, themeClassName);
-}
-
-/**
- * Destroy the widget and hide the div.
- * @alias Blockly.WidgetDiv.hide
- */
-export function hide() {
-  if (!isVisible()) {
-    return;
-  }
-  owner = null;
-
-  const div = containerDiv;
-  div!.style.display = 'none';
-  div!.style.left = '';
-  div!.style.top = '';
-  dispose && dispose();
-  // AnyDuringMigration because:  Type 'null' is not assignable to type
-  // 'Function'.
-  dispose = null as AnyDuringMigration;
-  div!.textContent = '';
-
-  if (rendererClassName) {
-    // AnyDuringMigration because:  Argument of type 'HTMLDivElement | null' is
-    // not assignable to parameter of type 'Element'.
-    dom.removeClass(div as AnyDuringMigration, rendererClassName);
-    rendererClassName = '';
-  }
-  if (themeClassName) {
-    // AnyDuringMigration because:  Argument of type 'HTMLDivElement | null' is
-    // not assignable to parameter of type 'Element'.
-    dom.removeClass(div as AnyDuringMigration, themeClassName);
-    themeClassName = '';
-  }
-  (common.getMainWorkspace() as WorkspaceSvg).markFocused();
-}
-
-/**
- * Is the container visible?
- * @return True if visible.
- * @alias Blockly.WidgetDiv.isVisible
- */
-export function isVisible(): boolean {
-  return !!owner;
-}
-
-/**
- * Destroy the widget and hide the div if it is being used by the specified
- * object.
- * @param oldOwner The object that was using this container.
- * @alias Blockly.WidgetDiv.hideIfOwner
- */
-export function hideIfOwner(oldOwner: AnyDuringMigration) {
-  if (owner === oldOwner) {
-    hide();
-  }
-}
-/**
- * Set the widget div's position and height.  This function does nothing clever:
- * it will not ensure that your widget div ends up in the visible window.
- * @param x Horizontal location (window coordinates, not body).
- * @param y Vertical location (window coordinates, not body).
- * @param height The height of the widget div (pixels).
- */
-function positionInternal(x: number, y: number, height: number) {
-  containerDiv!.style.left = x + 'px';
-  containerDiv!.style.top = y + 'px';
-  containerDiv!.style.height = height + 'px';
-}
-
-/**
- * Position the widget div based on an anchor rectangle.
- * The widget should be placed adjacent to but not overlapping the anchor
- * rectangle.  The preferred position is directly below and aligned to the left
- * (LTR) or right (RTL) side of the anchor.
- * @param viewportBBox The bounding rectangle of the current viewport, in window
- *     coordinates.
- * @param anchorBBox The bounding rectangle of the anchor, in window
- *     coordinates.
- * @param widgetSize The size of the widget that is inside the widget div, in
- *     window coordinates.
- * @param rtl Whether the workspace is in RTL mode.  This determines horizontal
- *     alignment.
- * @alias Blockly.WidgetDiv.positionWithAnchor
- * @internal
- */
-export function positionWithAnchor(
-    viewportBBox: Rect, anchorBBox: Rect, widgetSize: Size, rtl: boolean) {
-  const y = calculateY(viewportBBox, anchorBBox, widgetSize);
-  const x = calculateX(viewportBBox, anchorBBox, widgetSize, rtl);
-
-  if (y < 0) {
-    positionInternal(x, 0, widgetSize.height + y);
-  } else {
-    positionInternal(x, y, widgetSize.height);
-  }
-}
-
-/**
- * Calculate an x position (in window coordinates) such that the widget will not
- * be offscreen on the right or left.
- * @param viewportBBox The bounding rectangle of the current viewport, in window
- *     coordinates.
- * @param anchorBBox The bounding rectangle of the anchor, in window
- *     coordinates.
- * @param widgetSize The dimensions of the widget inside the widget div.
- * @param rtl Whether the Blockly workspace is in RTL mode.
- * @return A valid x-coordinate for the top left corner of the widget div, in
- *     window coordinates.
- */
-function calculateX(
-    viewportBBox: Rect, anchorBBox: Rect, widgetSize: Size,
-    rtl: boolean): number {
-  if (rtl) {
-    // Try to align the right side of the field and the right side of widget.
-    const widgetLeft = anchorBBox.right - widgetSize.width;
-    // Don't go offscreen left.
-    const x = Math.max(widgetLeft, viewportBBox.left);
-    // But really don't go offscreen right:
-    return Math.min(x, viewportBBox.right - widgetSize.width);
-  } else {
-    // Try to align the left side of the field and the left side of widget.
-    // Don't go offscreen right.
-    const x = Math.min(anchorBBox.left, viewportBBox.right - widgetSize.width);
-    // But left is more important, because that's where the text is.
-    return Math.max(x, viewportBBox.left);
-  }
-}
-
-/**
- * Calculate a y position (in window coordinates) such that the widget will not
- * be offscreen on the top or bottom.
- * @param viewportBBox The bounding rectangle of the current viewport, in window
- *     coordinates.
- * @param anchorBBox The bounding rectangle of the anchor, in window
- *     coordinates.
- * @param widgetSize The dimensions of the widget inside the widget div.
- * @return A valid y-coordinate for the top left corner of the widget div, in
- *     window coordinates.
- */
-function calculateY(
-    viewportBBox: Rect, anchorBBox: Rect, widgetSize: Size): number {
-  // Flip the widget vertically if off the bottom.
-  // The widget could go off the top of the window, but it would also go off
-  // the bottom.  The window is just too small.
-  if (anchorBBox.bottom + widgetSize.height >= viewportBBox.bottom) {
-    // The bottom of the widget is at the top of the field.
-    return anchorBBox.top - widgetSize.height;
-  } else {
-    // The top of the widget is at the bottom of the field.
-    return anchorBBox.bottom;
-  }
-}