blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/inject.ts

@@ -1,390 +0,0 @@
-/**
- * @license
- * Copyright 2011 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Functions for injecting Blockly into a web page.
- */
-
-/**
- * Functions for injecting Blockly into a web page.
- * @namespace Blockly.inject
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.inject');
-
-import {BlockDragSurfaceSvg} from './block_drag_surface.js';
-import type {BlocklyOptions} from './blockly_options.js';
-import * as browserEvents from './browser_events.js';
-import * as bumpObjects from './bump_objects.js';
-import * as common from './common.js';
-import * as Css from './css.js';
-import * as dropDownDiv from './dropdowndiv.js';
-import {Grid} from './grid.js';
-import {Msg} from './msg.js';
-import {Options} from './options.js';
-import {ScrollbarPair} from './scrollbar_pair.js';
-import {ShortcutRegistry} from './shortcut_registry.js';
-import * as Tooltip from './tooltip.js';
-import * as Touch from './touch.js';
-import * as aria from './utils/aria.js';
-import * as dom from './utils/dom.js';
-import {Svg} from './utils/svg.js';
-import * as userAgent from './utils/useragent.js';
-import * as WidgetDiv from './widgetdiv.js';
-import {Workspace} from './workspace.js';
-import {WorkspaceDragSurfaceSvg} from './workspace_drag_surface_svg.js';
-import {WorkspaceSvg} from './workspace_svg.js';
-
-
-/**
- * Inject a Blockly editor into the specified container element (usually a div).
- * @param container Containing element, or its ID, or a CSS selector.
- * @param opt_options Optional dictionary of options.
- * @return Newly created main workspace.
- * @alias Blockly.inject
- */
-export function inject(
-    container: Element|string, opt_options?: BlocklyOptions): WorkspaceSvg {
-  if (typeof container === 'string') {
-    // AnyDuringMigration because:  Type 'Element | null' is not assignable to
-    // type 'string | Element'.
-    container = (document.getElementById(container) ||
-                 document.querySelector(container)) as AnyDuringMigration;
-  }
-  // Verify that the container is in document.
-  // AnyDuringMigration because:  Argument of type 'string | Element' is not
-  // assignable to parameter of type 'Node'.
-  if (!container ||
-      !dom.containsNode(document, container as AnyDuringMigration)) {
-    throw Error('Error: container is not in current document.');
-  }
-  const options = new Options(opt_options || {} as BlocklyOptions);
-  const subContainer = (document.createElement('div'));
-  subContainer.className = 'injectionDiv';
-  subContainer.tabIndex = 0;
-  aria.setState(subContainer, aria.State.LABEL, Msg['WORKSPACE_ARIA_LABEL']);
-
-  // AnyDuringMigration because:  Property 'appendChild' does not exist on type
-  // 'string | Element'.
-  (container as AnyDuringMigration).appendChild(subContainer);
-  const svg = createDom(subContainer, options);
-
-  // Create surfaces for dragging things. These are optimizations
-  // so that the browser does not repaint during the drag.
-  const blockDragSurface = new BlockDragSurfaceSvg(subContainer);
-
-  const workspaceDragSurface = new WorkspaceDragSurfaceSvg(subContainer);
-
-  const workspace =
-      createMainWorkspace(svg, options, blockDragSurface, workspaceDragSurface);
-
-  init(workspace);
-
-  // Keep focus on the first workspace so entering keyboard navigation looks
-  // correct.
-  // AnyDuringMigration because:  Argument of type 'WorkspaceSvg' is not
-  // assignable to parameter of type 'Workspace'.
-  common.setMainWorkspace(workspace as AnyDuringMigration);
-
-  common.svgResize(workspace);
-
-  subContainer.addEventListener('focusin', function() {
-    // AnyDuringMigration because:  Argument of type 'WorkspaceSvg' is not
-    // assignable to parameter of type 'Workspace'.
-    common.setMainWorkspace(workspace as AnyDuringMigration);
-  });
-
-  return workspace;
-}
-
-/**
- * Create the SVG image.
- * @param container Containing element.
- * @param options Dictionary of options.
- * @return Newly created SVG image.
- */
-function createDom(container: Element, options: Options): Element {
-  // Sadly browsers (Chrome vs Firefox) are currently inconsistent in laying
-  // out content in RTL mode.  Therefore Blockly forces the use of LTR,
-  // then manually positions content in RTL as needed.
-  container.setAttribute('dir', 'LTR');
-
-  // Load CSS.
-  Css.inject(options.hasCss, options.pathToMedia);
-
-  // Build the SVG DOM.
-  /*
-    <svg
-      xmlns="http://www.w3.org/2000/svg"
-      xmlns:html="http://www.w3.org/1999/xhtml"
-      xmlns:xlink="http://www.w3.org/1999/xlink"
-      version="1.1"
-      class="blocklySvg">
-      ...
-    </svg>
-    */
-  const svg = dom.createSvgElement(
-      Svg.SVG, {
-        'xmlns': dom.SVG_NS,
-        'xmlns:html': dom.HTML_NS,
-        'xmlns:xlink': dom.XLINK_NS,
-        'version': '1.1',
-        'class': 'blocklySvg',
-        'tabindex': '0',
-      },
-      container);
-  /*
-    <defs>
-      ... filters go here ...
-    </defs>
-    */
-  const defs = dom.createSvgElement(Svg.DEFS, {}, svg);
-  // Each filter/pattern needs a unique ID for the case of multiple Blockly
-  // instances on a page.  Browser behaviour becomes undefined otherwise.
-  // https://neil.fraser.name/news/2015/11/01/
-  const rnd = String(Math.random()).substring(2);
-
-  options.gridPattern = Grid.createDom(rnd, options.gridOptions, defs);
-  return svg;
-}
-
-/**
- * Create a main workspace and add it to the SVG.
- * @param svg SVG element with pattern defined.
- * @param options Dictionary of options.
- * @param blockDragSurface Drag surface SVG for the blocks.
- * @param workspaceDragSurface Drag surface SVG for the workspace.
- * @return Newly created main workspace.
- */
-function createMainWorkspace(
-    svg: Element, options: Options, blockDragSurface: BlockDragSurfaceSvg,
-    workspaceDragSurface: WorkspaceDragSurfaceSvg): WorkspaceSvg {
-  options.parentWorkspace = null;
-  const mainWorkspace =
-      new WorkspaceSvg(options, blockDragSurface, workspaceDragSurface);
-  const wsOptions = mainWorkspace.options;
-  mainWorkspace.scale = wsOptions.zoomOptions.startScale;
-  svg.appendChild(mainWorkspace.createDom('blocklyMainBackground'));
-
-  // Set the theme name and renderer name onto the injection div.
-  dom.addClass(
-      mainWorkspace.getInjectionDiv(),
-      mainWorkspace.getRenderer().getClassName());
-  dom.addClass(
-      mainWorkspace.getInjectionDiv(), mainWorkspace.getTheme().getClassName());
-
-  if (!wsOptions.hasCategories && wsOptions.languageTree) {
-    // Add flyout as an <svg> that is a sibling of the workspace SVG.
-    const flyout = mainWorkspace.addFlyout(Svg.SVG);
-    dom.insertAfter(flyout, svg);
-  }
-  if (wsOptions.hasTrashcan) {
-    mainWorkspace.addTrashcan();
-  }
-  if (wsOptions.zoomOptions && wsOptions.zoomOptions.controls) {
-    mainWorkspace.addZoomControls();
-  }
-  // Register the workspace svg as a UI component.
-  mainWorkspace.getThemeManager().subscribe(
-      svg, 'workspaceBackgroundColour', 'background-color');
-
-  // A null translation will also apply the correct initial scale.
-  mainWorkspace.translate(0, 0);
-
-  mainWorkspace.addChangeListener(
-      bumpObjects.bumpIntoBoundsHandler(mainWorkspace));
-
-  // The SVG is now fully assembled.
-  common.svgResize(mainWorkspace);
-  WidgetDiv.createDom();
-  dropDownDiv.createDom();
-  Tooltip.createDom();
-  return mainWorkspace;
-}
-
-/**
- * Initialize Blockly with various handlers.
- * @param mainWorkspace Newly created main workspace.
- */
-function init(mainWorkspace: WorkspaceSvg) {
-  const options = mainWorkspace.options;
-  const svg = mainWorkspace.getParentSvg();
-
-  // Suppress the browser's context menu.
-  browserEvents.conditionalBind(
-      svg.parentNode as Element, 'contextmenu', null,
-      function(e: AnyDuringMigration) {
-        if (!browserEvents.isTargetInput(e)) {
-          e.preventDefault();
-        }
-      });
-
-  const workspaceResizeHandler =
-      browserEvents.conditionalBind(window, 'resize', null, function() {
-        mainWorkspace.hideChaff(true);
-        common.svgResize(mainWorkspace);
-        bumpObjects.bumpTopObjectsIntoBounds(mainWorkspace);
-      });
-  mainWorkspace.setResizeHandlerWrapper(workspaceResizeHandler);
-
-  bindDocumentEvents();
-
-  if (options.languageTree) {
-    const toolbox = mainWorkspace.getToolbox();
-    const flyout = mainWorkspace.getFlyout(true);
-    if (toolbox) {
-      toolbox.init();
-    } else if (flyout) {
-      // Build a fixed flyout with the root blocks.
-      flyout.init(mainWorkspace);
-      flyout.show(options.languageTree);
-      if (typeof flyout.scrollToStart === 'function') {
-        flyout.scrollToStart();
-      }
-    }
-  }
-
-  if (options.hasTrashcan) {
-    mainWorkspace.trashcan.init();
-  }
-  if (options.zoomOptions && options.zoomOptions.controls) {
-    mainWorkspace.zoomControls_.init();
-  }
-
-  if (options.moveOptions && options.moveOptions.scrollbars) {
-    const horizontalScroll = options.moveOptions.scrollbars === true ||
-        !!options.moveOptions.scrollbars.horizontal;
-    const verticalScroll = options.moveOptions.scrollbars === true ||
-        !!options.moveOptions.scrollbars.vertical;
-    mainWorkspace.scrollbar = new ScrollbarPair(
-        mainWorkspace, horizontalScroll, verticalScroll,
-        'blocklyMainWorkspaceScrollbar');
-    mainWorkspace.scrollbar.resize();
-  } else {
-    mainWorkspace.setMetrics({x: 0.5, y: 0.5});
-  }
-
-  // Load the sounds.
-  if (options.hasSounds) {
-    loadSounds(options.pathToMedia, mainWorkspace);
-  }
-}
-
-/**
- * Handle a key-down on SVG drawing surface. Does nothing if the main workspace
- * is not visible.
- * @param e Key down event.
- */
-// TODO (https://github.com/google/blockly/issues/1998) handle cases where there
-// are multiple workspaces and non-main workspaces are able to accept input.
-function onKeyDown(e: KeyboardEvent) {
-  const mainWorkspace = common.getMainWorkspace() as WorkspaceSvg;
-  if (!mainWorkspace) {
-    return;
-  }
-
-  if (browserEvents.isTargetInput(e) ||
-      mainWorkspace.rendered && !mainWorkspace.isVisible()) {
-    // When focused on an HTML text input widget, don't trap any keys.
-    // Ignore keypresses on rendered workspaces that have been explicitly
-    // hidden.
-    return;
-  }
-  ShortcutRegistry.registry.onKeyDown(mainWorkspace, e);
-}
-
-/**
- * Whether event handlers have been bound. Document event handlers will only
- * be bound once, even if Blockly is destroyed and reinjected.
- */
-let documentEventsBound = false;
-
-/**
- * Bind document events, but only once.  Destroying and reinjecting Blockly
- * should not bind again.
- * Bind events for scrolling the workspace.
- * Most of these events should be bound to the SVG's surface.
- * However, 'mouseup' has to be on the whole document so that a block dragged
- * out of bounds and released will know that it has been released.
- * Also, 'keydown' has to be on the whole document since the browser doesn't
- * understand a concept of focus on the SVG image.
- */
-function bindDocumentEvents() {
-  if (!documentEventsBound) {
-    browserEvents.conditionalBind(document, 'scroll', null, function() {
-      const workspaces = common.getAllWorkspaces();
-      for (let i = 0, workspace; workspace = workspaces[i]; i++) {
-        if (workspace instanceof WorkspaceSvg) {
-          workspace.updateInverseScreenCTM();
-        }
-      }
-    });
-    browserEvents.conditionalBind(document, 'keydown', null, onKeyDown);
-    // longStop needs to run to stop the context menu from showing up.  It
-    // should run regardless of what other touch event handlers have run.
-    browserEvents.bind(document, 'touchend', null, Touch.longStop);
-    browserEvents.bind(document, 'touchcancel', null, Touch.longStop);
-    // Some iPad versions don't fire resize after portrait to landscape change.
-    if (userAgent.IPAD) {
-      browserEvents.conditionalBind(
-          window, 'orientationchange', document, function() {
-            // TODO (#397): Fix for multiple Blockly workspaces.
-            common.svgResize(common.getMainWorkspace() as WorkspaceSvg);
-          });
-    }
-  }
-  documentEventsBound = true;
-}
-
-/**
- * Load sounds for the given workspace.
- * @param pathToMedia The path to the media directory.
- * @param workspace The workspace to load sounds for.
- */
-function loadSounds(pathToMedia: string, workspace: WorkspaceSvg) {
-  const audioMgr = workspace.getAudioManager();
-  audioMgr.load(
-      [
-        pathToMedia + 'click.mp3',
-        pathToMedia + 'click.wav',
-        pathToMedia + 'click.ogg',
-      ],
-      'click');
-  audioMgr.load(
-      [
-        pathToMedia + 'disconnect.wav',
-        pathToMedia + 'disconnect.mp3',
-        pathToMedia + 'disconnect.ogg',
-      ],
-      'disconnect');
-  audioMgr.load(
-      [
-        pathToMedia + 'delete.mp3',
-        pathToMedia + 'delete.ogg',
-        pathToMedia + 'delete.wav',
-      ],
-      'delete');
-
-  // Bind temporary hooks that preload the sounds.
-  const soundBinds: AnyDuringMigration[] = [];
-  function unbindSounds() {
-    while (soundBinds.length) {
-      browserEvents.unbind(soundBinds.pop());
-    }
-    audioMgr.preload();
-  }
-
-  // These are bound on mouse/touch events with
-  // Blockly.browserEvents.conditionalBind, so they restrict the touch
-  // identifier that will be recognized.  But this is really something that
-  // happens on a click, not a drag, so that's not necessary.
-
-  // Android ignores any sound not loaded as a result of a user action.
-  soundBinds.push(browserEvents.conditionalBind(
-      document, 'mousemove', null, unbindSounds, true));
-  soundBinds.push(browserEvents.conditionalBind(
-      document, 'touchstart', null, unbindSounds, true));
-}

package/core/input.ts

@@ -1,309 +0,0 @@
-/**
- * @license
- * Copyright 2012 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Object representing an input (value, statement, or dummy).
- */
-
-/**
- * Object representing an input (value, statement, or dummy).
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Input');
-
-// Unused import preserved for side-effects. Remove if unneeded.
-import './field_label.js';
-
-import type {Block} from './block.js';
-import type {BlockSvg} from './block_svg.js';
-import type {Connection} from './connection.js';
-import type {Field} from './field.js';
-import * as fieldRegistry from './field_registry.js';
-import {inputTypes} from './input_types.js';
-import type {RenderedConnection} from './rendered_connection.js';
-
-
-/**
- * Class for an input with an optional field.
- * @alias Blockly.Input
- */
-export class Input {
-  private sourceBlock_: Block;
-  fieldRow: Field[] = [];
-  align: Align;
-
-  /** Is the input visible? */
-  private visible_ = true;
-
-  /**
-   * @param type The type of the input.
-   * @param name Language-neutral identifier which may used to find this input
-   *     again.
-   * @param block The block containing this input.
-   * @param connection Optional connection for this input.
-   */
-  constructor(
-      public type: number, public name: string, block: Block,
-      public connection: Connection|null) {
-    if (type !== inputTypes.DUMMY && !name) {
-      throw Error(
-          'Value inputs and statement inputs must have non-empty name.');
-    }
-    this.sourceBlock_ = block;
-
-    /** Alignment of input's fields (left, right or centre). */
-    this.align = Align.LEFT;
-  }
-
-  /**
-   * Get the source block for this input.
-   * @return The source block, or null if there is none.
-   */
-  getSourceBlock(): Block {
-    return this.sourceBlock_;
-  }
-
-  /**
-   * Add a field (or label from string), and all prefix and suffix fields, to
-   * the end of the input's field row.
-   * @param field Something to add as a field.
-   * @param opt_name Language-neutral identifier which may used to find this
-   *     field again.  Should be unique to the host block.
-   * @return The input being append to (to allow chaining).
-   */
-  appendField(field: string|Field, opt_name?: string): Input {
-    this.insertFieldAt(this.fieldRow.length, field, opt_name);
-    return this;
-  }
-
-  /**
-   * Inserts a field (or label from string), and all prefix and suffix fields,
-   * at the location of the input's field row.
-   * @param index The index at which to insert field.
-   * @param field Something to add as a field.
-   * @param opt_name Language-neutral identifier which may used to find this
-   *     field again.  Should be unique to the host block.
-   * @return The index following the last inserted field.
-   */
-  insertFieldAt(index: number, field: string|Field, opt_name?: string): number {
-    if (index < 0 || index > this.fieldRow.length) {
-      throw Error('index ' + index + ' out of bounds.');
-    }
-    // Falsy field values don't generate a field, unless the field is an empty
-    // string and named.
-    if (!field && !(field === '' && opt_name)) {
-      return index;
-    }
-
-    // Generate a FieldLabel when given a plain text field.
-    if (typeof field === 'string') {
-      field = fieldRegistry.fromJson({
-        'type': 'field_label',
-        'text': field,
-      }) as Field;
-    }
-
-    field.setSourceBlock(this.sourceBlock_);
-    if (this.sourceBlock_.rendered) {
-      field.init();
-      field.applyColour();
-    }
-    field.name = opt_name;
-    field.setVisible(this.isVisible());
-
-    if (field.prefixField) {
-      // Add any prefix.
-      index = this.insertFieldAt(index, field.prefixField);
-    }
-    // Add the field to the field row.
-    this.fieldRow.splice(index, 0, field);
-    index++;
-    if (field.suffixField) {
-      // Add any suffix.
-      index = this.insertFieldAt(index, field.suffixField);
-    }
-
-    if (this.sourceBlock_.rendered) {
-      (this.sourceBlock_ as BlockSvg).render();
-      // Adding a field will cause the block to change shape.
-      this.sourceBlock_.bumpNeighbours();
-    }
-    return index;
-  }
-
-  /**
-   * Remove a field from this input.
-   * @param name The name of the field.
-   * @param opt_quiet True to prevent an error if field is not present.
-   * @return True if operation succeeds, false if field is not present and
-   *     opt_quiet is true.
-   * @throws {Error} if the field is not present and opt_quiet is false.
-   */
-  removeField(name: string, opt_quiet?: boolean): boolean {
-    for (let i = 0, field; field = this.fieldRow[i]; i++) {
-      if (field.name === name) {
-        field.dispose();
-        this.fieldRow.splice(i, 1);
-        if (this.sourceBlock_.rendered) {
-          (this.sourceBlock_ as BlockSvg).render();
-          // Removing a field will cause the block to change shape.
-          this.sourceBlock_.bumpNeighbours();
-        }
-        return true;
-      }
-    }
-    if (opt_quiet) {
-      return false;
-    }
-    throw Error('Field "' + name + '" not found.');
-  }
-
-  /**
-   * Gets whether this input is visible or not.
-   * @return True if visible.
-   */
-  isVisible(): boolean {
-    return this.visible_;
-  }
-
-  /**
-   * Sets whether this input is visible or not.
-   * Should only be used to collapse/uncollapse a block.
-   * @param visible True if visible.
-   * @return List of blocks to render.
-   * @internal
-   */
-  setVisible(visible: boolean): BlockSvg[] {
-    // Note: Currently there are only unit tests for block.setCollapsed()
-    // because this function is package. If this function goes back to being a
-    // public API tests (lots of tests) should be added.
-    let renderList: AnyDuringMigration[] = [];
-    if (this.visible_ === visible) {
-      return renderList;
-    }
-    this.visible_ = visible;
-
-    for (let y = 0, field; field = this.fieldRow[y]; y++) {
-      field.setVisible(visible);
-    }
-    if (this.connection) {
-      const renderedConnection = this.connection as RenderedConnection;
-      // Has a connection.
-      if (visible) {
-        renderList = renderedConnection.startTrackingAll();
-      } else {
-        renderedConnection.stopTrackingAll();
-      }
-      const child = renderedConnection.targetBlock();
-      if (child) {
-        child.getSvgRoot().style.display = visible ? 'block' : 'none';
-      }
-    }
-    return renderList;
-  }
-
-  /**
-   * Mark all fields on this input as dirty.
-   * @internal
-   */
-  markDirty() {
-    for (let y = 0, field; field = this.fieldRow[y]; y++) {
-      field.markDirty();
-    }
-  }
-
-  /**
-   * Change a connection's compatibility.
-   * @param check Compatible value type or list of value types.  Null if all
-   *     types are compatible.
-   * @return The input being modified (to allow chaining).
-   */
-  setCheck(check: string|string[]|null): Input {
-    if (!this.connection) {
-      throw Error('This input does not have a connection.');
-    }
-    this.connection.setCheck(check);
-    return this;
-  }
-
-  /**
-   * Change the alignment of the connection's field(s).
-   * @param align One of the values of Align.  In RTL mode directions
-   *     are reversed, and Align.RIGHT aligns to the left.
-   * @return The input being modified (to allow chaining).
-   */
-  setAlign(align: Align): Input {
-    this.align = align;
-    if (this.sourceBlock_.rendered) {
-      const sourceBlock = this.sourceBlock_ as BlockSvg;
-      sourceBlock.render();
-    }
-    return this;
-  }
-
-  /**
-   * Changes the connection's shadow block.
-   * @param shadow DOM representation of a block or null.
-   * @return The input being modified (to allow chaining).
-   */
-  setShadowDom(shadow: Element|null): Input {
-    if (!this.connection) {
-      throw Error('This input does not have a connection.');
-    }
-    this.connection.setShadowDom(shadow);
-    return this;
-  }
-
-  /**
-   * Returns the XML representation of the connection's shadow block.
-   * @return Shadow DOM representation of a block or null.
-   */
-  getShadowDom(): Element|null {
-    if (!this.connection) {
-      throw Error('This input does not have a connection.');
-    }
-    return this.connection.getShadowDom();
-  }
-
-  /** Initialize the fields on this input. */
-  init() {
-    if (!this.sourceBlock_.workspace.rendered) {
-      return;  // Headless blocks don't need fields initialized.
-    }
-    for (let i = 0; i < this.fieldRow.length; i++) {
-      this.fieldRow[i].init();
-    }
-  }
-
-  /**
-   * Sever all links to this input.
-   * @suppress {checkTypes}
-   */
-  dispose() {
-    for (let i = 0, field; field = this.fieldRow[i]; i++) {
-      field.dispose();
-    }
-    if (this.connection) {
-      this.connection.dispose();
-    }
-  }
-}
-
-export namespace Input {
-  /**
-   * Enum for alignment of inputs.
-   * @alias Blockly.Input.Align
-   */
-  export enum Align {
-    LEFT = -1,
-    CENTRE = 0,
-    RIGHT = 1,
-  }
-}
-
-export type Align = Input.Align;
-export const Align = Input.Align;