blockly 12.4.0 → 12.4.1

package/core/variables_dynamic.ts

@@ -1,230 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.VariablesDynamic
-
-import {Blocks} from './blocks.js';
-import type {FlyoutButton} from './flyout_button.js';
-import {Msg} from './msg.js';
-import * as deprecation from './utils/deprecation.js';
-import type {FlyoutItemInfo} from './utils/toolbox.js';
-import * as xml from './utils/xml.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.
- */
-export const CATEGORY_NAME = 'VARIABLE_DYNAMIC';
-
-/**
- * Click handler for a button that creates String variables.
- *
- * @param button
- */
-function stringButtonClickHandler(button: FlyoutButton) {
-  Variables.createVariableButtonHandler(
-    button.getTargetWorkspace(),
-    undefined,
-    'String',
-  );
-}
-// eslint-disable-next-line camelcase
-export const onCreateVariableButtonClick_String = stringButtonClickHandler;
-
-/**
- * Click handler for a button that creates Number variables.
- *
- * @param button
- */
-function numberButtonClickHandler(button: FlyoutButton) {
-  Variables.createVariableButtonHandler(
-    button.getTargetWorkspace(),
-    undefined,
-    'Number',
-  );
-}
-// eslint-disable-next-line camelcase
-export const onCreateVariableButtonClick_Number = numberButtonClickHandler;
-
-/**
- * Click handler for a button that creates Colour variables.
- *
- * @param button
- */
-function colourButtonClickHandler(button: FlyoutButton) {
-  Variables.createVariableButtonHandler(
-    button.getTargetWorkspace(),
-    undefined,
-    'Colour',
-  );
-}
-// eslint-disable-next-line camelcase
-export const onCreateVariableButtonClick_Colour = colourButtonClickHandler;
-
-/**
- * Internal wrapper that returns the contents of the dynamic variables category.
- *
- * @internal
- * @param workspace The workspace to populate variable blocks for.
- */
-export function internalFlyoutCategory(
-  workspace: WorkspaceSvg,
-): FlyoutItemInfo[] {
-  return flyoutCategory(workspace, false);
-}
-
-export function flyoutCategory(
-  workspace: WorkspaceSvg,
-  useXml: true,
-): Element[];
-export function flyoutCategory(
-  workspace: WorkspaceSvg,
-  useXml: false,
-): FlyoutItemInfo[];
-/**
- * Construct the elements (blocks and button) required by the flyout for the
- * dynamic variables category.
- *
- * @param useXml True to return the contents as XML, false to use JSON.
- * @returns List of flyout contents as either XML or JSON.
- */
-export function flyoutCategory(
-  workspace: WorkspaceSvg,
-  useXml = true,
-): Element[] | FlyoutItemInfo[] {
-  if (!Blocks['variables_set_dynamic'] && !Blocks['variables_get_dynamic']) {
-    console.warn(
-      'There are no dynamic variable blocks, but there is a dynamic variable category.',
-    );
-  }
-
-  if (useXml) {
-    deprecation.warn(
-      'The XML return value of Blockly.VariablesDynamic.flyoutCategory()',
-      'v12',
-      'v13',
-      'the same method, but handle a return type of FlyoutItemInfo[] (JSON) instead.',
-    );
-    return xmlFlyoutCategory(workspace);
-  }
-
-  workspace.registerButtonCallback(
-    'CREATE_VARIABLE_STRING',
-    stringButtonClickHandler,
-  );
-  workspace.registerButtonCallback(
-    'CREATE_VARIABLE_NUMBER',
-    numberButtonClickHandler,
-  );
-  workspace.registerButtonCallback(
-    'CREATE_VARIABLE_COLOUR',
-    colourButtonClickHandler,
-  );
-
-  return [
-    {
-      'kind': 'button',
-      'text': Msg['NEW_STRING_VARIABLE'],
-      'callbackkey': 'CREATE_VARIABLE_STRING',
-    },
-    {
-      'kind': 'button',
-      'text': Msg['NEW_NUMBER_VARIABLE'],
-      'callbackkey': 'CREATE_VARIABLE_NUMBER',
-    },
-    {
-      'kind': 'button',
-      'text': Msg['NEW_COLOUR_VARIABLE'],
-      'callbackkey': 'CREATE_VARIABLE_COLOUR',
-    },
-    ...Variables.jsonFlyoutCategoryBlocks(
-      workspace,
-      workspace.getVariableMap().getAllVariables(),
-      false,
-      'variables_get_dynamic',
-      'variables_set_dynamic',
-    ),
-  ];
-}
-
-/**
- * Construct the elements (blocks and button) required by the flyout for the
- * variable category.
- *
- * @param workspace The workspace containing variables.
- * @returns Array of XML elements.
- */
-function xmlFlyoutCategory(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,
-  );
-
-  const blockList = flyoutCategoryBlocks(workspace);
-  xmlList = xmlList.concat(blockList);
-  return xmlList;
-}
-
-/**
- * Construct the blocks required by the flyout for the variable category.
- *
- * @param workspace The workspace containing variables.
- * @returns Array of XML block elements.
- */
-export function flyoutCategoryBlocks(workspace: Workspace): Element[] {
-  const variableModelList = workspace.getVariableMap().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');
-      block.setAttribute('gap', '24');
-      block.appendChild(Variables.generateVariableFieldDom(firstVariable));
-      xmlList.push(block);
-    }
-    if (Blocks['variables_get_dynamic']) {
-      variableModelList.sort(Variables.compareByName);
-      for (let i = 0, variable; (variable = variableModelList[i]); i++) {
-        const block = xml.createElement('block');
-        block.setAttribute('type', 'variables_get_dynamic');
-        block.setAttribute('gap', '8');
-        block.appendChild(Variables.generateVariableFieldDom(variable));
-        xmlList.push(block);
-      }
-    }
-  }
-  return xmlList;
-}

package/core/widgetdiv.ts

@@ -1,349 +0,0 @@
-/**
- * @license
- * Copyright 2013 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.WidgetDiv
-
-import * as browserEvents from './browser_events.js';
-import * as common from './common.js';
-import {Field} from './field.js';
-import {ReturnEphemeralFocus, getFocusManager} from './focus_manager.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: unknown = null;
-
-/** The workspace associated with the owner currently using this container. */
-let ownerWorkspace: WorkspaceSvg | null = null;
-
-/** Optional cleanup function set by whichever object uses the widget. */
-let dispose: (() => void) | null = null;
-
-/** A class name representing the current owner's workspace container. */
-const containerClassName = 'blocklyWidgetDiv';
-
-/** 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;
-
-/** Callback to FocusManager to return ephemeral focus when the div closes. */
-let returnEphemeralFocus: ReturnEphemeralFocus | null = null;
-
-/**
- * Returns the HTML container for editor widgets.
- *
- * @returns The editor widget container.
- */
-export function getDiv(): HTMLDivElement | null {
-  return containerDiv;
-}
-
-/**
- * Allows unit tests to reset the div. Do not use outside of tests.
- *
- * @param newDiv The new value for the DIV field.
- * @internal
- */
-export function testOnly_setDiv(newDiv: HTMLDivElement | null) {
-  containerDiv = newDiv;
-  if (newDiv === null) {
-    document.querySelector('.' + containerClassName)?.remove();
-  }
-}
-
-/**
- * Create the widget div and inject it onto the page.
- */
-export function createDom() {
-  const container = common.getParentContainer() || document.body;
-
-  const existingContainer = document.querySelector('div.' + containerClassName);
-  if (existingContainer) {
-    containerDiv = existingContainer as HTMLDivElement;
-  } else {
-    containerDiv = document.createElement('div');
-    containerDiv.className = containerClassName;
-    containerDiv.tabIndex = -1;
-  }
-
-  browserEvents.conditionalBind(
-    containerDiv,
-    'keydown',
-    null,
-    common.globalShortcutHandler,
-  );
-
-  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.
- * @param workspace The workspace associated with the widget owner.
- * @param manageEphemeralFocus Whether ephemeral focus should be managed
- *     according to the widget div's lifetime. Note that if a false value is
- *     passed in here then callers should manage ephemeral focus directly
- *     otherwise focus may not properly restore when the widget closes. Defaults
- *     to true.
- */
-export function show(
-  newOwner: unknown,
-  rtl: boolean,
-  newDispose: () => void,
-  workspace?: WorkspaceSvg | null,
-  manageEphemeralFocus: boolean = true,
-) {
-  hide();
-  owner = newOwner;
-  dispose = newDispose;
-  const div = containerDiv;
-  if (!div) return;
-  div.style.direction = rtl ? 'rtl' : 'ltr';
-  div.style.display = 'block';
-  if (!workspace && newOwner instanceof Field) {
-    // For backward compatibility with plugin fields that do not provide a
-    // workspace to this function, attempt to derive it from the field.
-    workspace = (newOwner as Field).getSourceBlock()?.workspace as WorkspaceSvg;
-  }
-  ownerWorkspace = workspace ?? null;
-  const rendererWorkspace =
-    workspace ?? (common.getMainWorkspace() as WorkspaceSvg);
-  rendererClassName = rendererWorkspace.getRenderer().getClassName();
-  themeClassName = rendererWorkspace.getTheme().getClassName();
-  if (rendererClassName) {
-    dom.addClass(div, rendererClassName);
-  }
-  if (themeClassName) {
-    dom.addClass(div, themeClassName);
-  }
-  if (manageEphemeralFocus) {
-    returnEphemeralFocus = getFocusManager().takeEphemeralFocus(div);
-  }
-}
-
-/**
- * Destroy the widget and hide the div.
- */
-export function hide() {
-  if (!isVisible()) {
-    return;
-  }
-  owner = null;
-
-  const div = containerDiv;
-  if (!div) return;
-  div.style.display = 'none';
-  div.style.left = '';
-  div.style.top = '';
-  if (dispose) {
-    dispose();
-    dispose = null;
-  }
-  div.textContent = '';
-
-  if (rendererClassName) {
-    dom.removeClass(div, rendererClassName);
-    rendererClassName = '';
-  }
-  if (themeClassName) {
-    dom.removeClass(div, themeClassName);
-    themeClassName = '';
-  }
-  (common.getMainWorkspace() as WorkspaceSvg).markFocused();
-
-  if (returnEphemeralFocus) {
-    returnEphemeralFocus();
-    returnEphemeralFocus = null;
-  }
-}
-
-/**
- * Is the container visible?
- *
- * @returns True if visible.
- */
-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.
- */
-export function hideIfOwner(oldOwner: unknown) {
-  if (owner === oldOwner) {
-    hide();
-  }
-}
-
-/**
- * Destroy the widget and hide the div if it is being used by an object in the
- * specified workspace, or if it is used by an unknown workspace.
- *
- * @param workspace The workspace that was using this container.
- */
-export function hideIfOwnerIsInWorkspace(workspace: WorkspaceSvg) {
-  let ownerIsInWorkspace = ownerWorkspace === null;
-  // Check if the given workspace is a parent workspace of the one containing
-  // our owner.
-  let currentWorkspace: WorkspaceSvg | null = workspace;
-  while (!ownerIsInWorkspace && currentWorkspace) {
-    if (currentWorkspace === workspace) {
-      ownerIsInWorkspace = true;
-      break;
-    }
-    currentWorkspace = workspace.options.parentWorkspace;
-  }
-
-  if (ownerIsInWorkspace) {
-    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.
- * @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.
- * @returns 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.
- * @returns 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;
-  }
-}
-
-/**
- * Determine if the owner is a field for purposes of repositioning.
- * We can't simply check `instanceof Field` as that would introduce a circular
- * dependency.
- */
-function isRepositionable(item: any): item is Field {
-  return !!item?.repositionForWindowResize;
-}
-
-/**
- * Reposition the widget div if the owner of it says to.
- * If the owner isn't a field, just give up and hide it.
- */
-export function repositionForWindowResize(): void {
-  if (!isRepositionable(owner) || !owner.repositionForWindowResize()) {
-    // If the owner is not a Field, or if the owner returns false from the
-    // reposition method, we should hide the widget div. Otherwise, we'll assume
-    // the owner handled any needed resize.
-    hide();
-  }
-}