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

package/core/keyboard_nav/basic_cursor.ts

@@ -1,214 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The class representing a basic cursor.
- * Used to demo switching between different cursors.
- */
-
-/**
- * The class representing a basic cursor.
- * Used to demo switching between different cursors.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.BasicCursor');
-
-import * as registry from '../registry.js';
-
-import {ASTNode} from './ast_node.js';
-import {Cursor} from './cursor.js';
-
-
-/**
- * Class for a basic cursor.
- * This will allow the user to get to all nodes in the AST by hitting next or
- * previous.
- * @alias Blockly.BasicCursor
- */
-export class BasicCursor extends Cursor {
-  /** Name used for registering a basic cursor. */
-  static readonly registrationName = 'basicCursor';
-
-  /** @alias Blockly.BasicCursor */
-  constructor() {
-    super();
-  }
-
-  /**
-   * Find the next node in the pre order traversal.
-   * @return The next node, or null if the current node is not set or there is
-   *     no next value.
-   */
-  override next(): ASTNode|null {
-    const curNode = this.getCurNode();
-    if (!curNode) {
-      return null;
-    }
-    const newNode = this.getNextNode_(curNode, this.validNode_);
-
-    if (newNode) {
-      this.setCurNode(newNode);
-    }
-    return newNode;
-  }
-
-  /**
-   * For a basic cursor we only have the ability to go next and previous, so
-   * in will also allow the user to get to the next node in the pre order
-   * traversal.
-   * @return The next node, or null if the current node is not set or there is
-   *     no next value.
-   */
-  override in(): ASTNode|null {
-    return this.next();
-  }
-
-  /**
-   * Find the previous node in the pre order traversal.
-   * @return The previous node, or null if the current node is not set or there
-   *     is no previous value.
-   */
-  override prev(): ASTNode|null {
-    const curNode = this.getCurNode();
-    if (!curNode) {
-      return null;
-    }
-    const newNode = this.getPreviousNode_(curNode, this.validNode_);
-
-    if (newNode) {
-      this.setCurNode(newNode);
-    }
-    return newNode;
-  }
-
-  /**
-   * For a basic cursor we only have the ability to go next and previous, so
-   * out will allow the user to get to the previous node in the pre order
-   * traversal.
-   * @return The previous node, or null if the current node is not set or there
-   *     is no previous value.
-   */
-  override out(): ASTNode|null {
-    return this.prev();
-  }
-
-  /**
-   * Uses pre order traversal to navigate the Blockly AST. This will allow
-   * a user to easily navigate the entire Blockly AST without having to go in
-   * and out levels on the tree.
-   * @param node The current position in the AST.
-   * @param isValid A function true/false depending on whether the given node
-   *     should be traversed.
-   * @return The next node in the traversal.
-   */
-  protected getNextNode_(
-      node: ASTNode|null, isValid: (p1: ASTNode|null) => boolean): ASTNode
-      |null {
-    if (!node) {
-      return null;
-    }
-    const newNode = node.in() || node.next();
-    if (isValid(newNode)) {
-      return newNode;
-    } else if (newNode) {
-      return this.getNextNode_(newNode, isValid);
-    }
-    const siblingOrParent = this.findSiblingOrParent_(node.out());
-    // AnyDuringMigration because:  Argument of type 'ASTNode | null' is not
-    // assignable to parameter of type 'ASTNode'.
-    if (isValid(siblingOrParent as AnyDuringMigration)) {
-      return siblingOrParent;
-    } else if (siblingOrParent) {
-      return this.getNextNode_(siblingOrParent, isValid);
-    }
-    return null;
-  }
-
-  /**
-   * Reverses the pre order traversal in order to find the previous node. This
-   * will allow a user to easily navigate the entire Blockly AST without having
-   * to go in and out levels on the tree.
-   * @param node The current position in the AST.
-   * @param isValid A function true/false depending on whether the given node
-   *     should be traversed.
-   * @return The previous node in the traversal or null if no previous node
-   *     exists.
-   */
-  protected getPreviousNode_(
-      node: ASTNode|null, isValid: (p1: ASTNode|null) => boolean): ASTNode
-      |null {
-    if (!node) {
-      return null;
-    }
-    let newNode: ASTNode|null = node.prev();
-
-    if (newNode) {
-      newNode = this.getRightMostChild_(newNode);
-    } else {
-      newNode = node.out();
-    }
-    if (isValid(newNode)) {
-      return newNode;
-    } else if (newNode) {
-      return this.getPreviousNode_(newNode, isValid);
-    }
-    return null;
-  }
-
-  /**
-   * Decides what nodes to traverse and which ones to skip. Currently, it
-   * skips output, stack and workspace nodes.
-   * @param node The AST node to check whether it is valid.
-   * @return True if the node should be visited, false otherwise.
-   */
-  protected validNode_(node: ASTNode|null): boolean {
-    let isValid = false;
-    const type = node && node.getType();
-    if (type === ASTNode.types.OUTPUT || type === ASTNode.types.INPUT ||
-        type === ASTNode.types.FIELD || type === ASTNode.types.NEXT ||
-        type === ASTNode.types.PREVIOUS || type === ASTNode.types.WORKSPACE) {
-      isValid = true;
-    }
-    return isValid;
-  }
-
-  /**
-   * From the given node find either the next valid sibling or parent.
-   * @param node The current position in the AST.
-   * @return The parent AST node or null if there are no valid parents.
-   */
-  private findSiblingOrParent_(node: ASTNode|null): ASTNode|null {
-    if (!node) {
-      return null;
-    }
-    const nextNode = node.next();
-    if (nextNode) {
-      return nextNode;
-    }
-    return this.findSiblingOrParent_(node.out());
-  }
-
-  /**
-   * Get the right most child of a node.
-   * @param node The node to find the right most child of.
-   * @return The right most child of the given node, or the node if no child
-   *     exists.
-   */
-  private getRightMostChild_(node: ASTNode|null): ASTNode|null {
-    if (!node!.in()) {
-      return node;
-    }
-    let newNode = node!.in();
-    while (newNode && newNode.next()) {
-      newNode = newNode.next();
-    }
-    return this.getRightMostChild_(newNode);
-  }
-}
-
-registry.register(
-    registry.Type.CURSOR, BasicCursor.registrationName, BasicCursor);

package/core/keyboard_nav/cursor.ts

@@ -1,134 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The class representing a cursor.
- * Used primarily for keyboard navigation.
- */
-
-/**
- * The class representing a cursor.
- * Used primarily for keyboard navigation.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Cursor');
-
-import * as registry from '../registry.js';
-
-import {ASTNode} from './ast_node.js';
-import {Marker} from './marker.js';
-
-
-/**
- * Class for a cursor.
- * A cursor controls how a user navigates the Blockly AST.
- * @alias Blockly.Cursor
- */
-export class Cursor extends Marker {
-  override type = 'cursor';
-
-  /** @alias Blockly.Cursor */
-  constructor() {
-    super();
-  }
-
-  /**
-   * Find the next connection, field, or block.
-   * @return The next element, or null if the current node is not set or there
-   *     is no next value.
-   */
-  next(): ASTNode|null {
-    const curNode = this.getCurNode();
-    if (!curNode) {
-      return null;
-    }
-
-    let newNode = curNode.next();
-    while (newNode && newNode.next() &&
-           (newNode.getType() === ASTNode.types.NEXT ||
-            newNode.getType() === ASTNode.types.BLOCK)) {
-      newNode = newNode.next();
-    }
-
-    if (newNode) {
-      this.setCurNode(newNode);
-    }
-    return newNode;
-  }
-
-  /**
-   * Find the in connection or field.
-   * @return The in element, or null if the current node is not set or there is
-   *     no in value.
-   */
-  in(): ASTNode|null {
-    let curNode: ASTNode|null = this.getCurNode();
-    if (!curNode) {
-      return null;
-    }
-    // If we are on a previous or output connection, go to the block level
-    // before performing next operation.
-    if (curNode.getType() === ASTNode.types.PREVIOUS ||
-        curNode.getType() === ASTNode.types.OUTPUT) {
-      curNode = curNode.next();
-    }
-    const newNode = curNode?.in() ?? null;
-
-    if (newNode) {
-      this.setCurNode(newNode);
-    }
-    return newNode;
-  }
-
-  /**
-   * Find the previous connection, field, or block.
-   * @return The previous element, or null if the current node is not set or
-   *     there is no previous value.
-   */
-  prev(): ASTNode|null {
-    const curNode = this.getCurNode();
-    if (!curNode) {
-      return null;
-    }
-    let newNode = curNode.prev();
-
-    while (newNode && newNode.prev() &&
-           (newNode.getType() === ASTNode.types.NEXT ||
-            newNode.getType() === ASTNode.types.BLOCK)) {
-      newNode = newNode.prev();
-    }
-
-    if (newNode) {
-      this.setCurNode(newNode);
-    }
-    return newNode;
-  }
-
-  /**
-   * Find the out connection, field, or block.
-   * @return The out element, or null if the current node is not set or there is
-   *     no out value.
-   */
-  out(): ASTNode|null {
-    const curNode = this.getCurNode();
-    if (!curNode) {
-      return null;
-    }
-    let newNode = curNode.out();
-
-    if (newNode && newNode.getType() === ASTNode.types.BLOCK) {
-      newNode = newNode.prev() || newNode;
-    }
-
-    if (newNode) {
-      this.setCurNode(newNode);
-    }
-    return newNode;
-  }
-}
-
-registry.register(registry.Type.CURSOR, registry.DEFAULT, Cursor);

package/core/keyboard_nav/marker.ts

@@ -1,115 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The class representing a marker.
- * Used primarily for keyboard navigation to show a marked location.
- */
-
-/**
- * The class representing a marker.
- * Used primarily for keyboard navigation to show a marked location.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Marker');
-
-/* eslint-disable-next-line no-unused-vars */
-import type {MarkerSvg} from '../renderers/common/marker_svg.js';
-
-import type {ASTNode} from './ast_node.js';
-
-
-/**
- * Class for a marker.
- * This is used in keyboard navigation to save a location in the Blockly AST.
- * @alias Blockly.Marker
- */
-export class Marker {
-  /** The colour of the marker. */
-  colour: string|null = null;
-
-  /** The current location of the marker. */
-  // AnyDuringMigration because:  Type 'null' is not assignable to type
-  // 'ASTNode'.
-  private curNode_: ASTNode = null as AnyDuringMigration;
-
-  /**
-   * The object in charge of drawing the visual representation of the current
-   * node.
-   */
-  // AnyDuringMigration because:  Type 'null' is not assignable to type
-  // 'MarkerSvg'.
-  private drawer_: MarkerSvg = null as AnyDuringMigration;
-
-  /** The type of the marker. */
-  type = 'marker';
-
-  /** Constructs a new Marker instance. */
-  constructor() {}
-
-  /**
-   * Sets the object in charge of drawing the marker.
-   * @param drawer The object in charge of drawing the marker.
-   */
-  setDrawer(drawer: MarkerSvg) {
-    this.drawer_ = drawer;
-  }
-
-  /**
-   * Get the current drawer for the marker.
-   * @return The object in charge of drawing the marker.
-   */
-  getDrawer(): MarkerSvg {
-    return this.drawer_;
-  }
-
-  /**
-   * Gets the current location of the marker.
-   * @return The current field, connection, or block the marker is on.
-   */
-  getCurNode(): ASTNode {
-    return this.curNode_;
-  }
-
-  /**
-   * Set the location of the marker and call the update method.
-   * Setting isStack to true will only work if the newLocation is the top most
-   * output or previous connection on a stack.
-   * @param newNode The new location of the marker.
-   */
-  setCurNode(newNode: ASTNode) {
-    const oldNode = this.curNode_;
-    this.curNode_ = newNode;
-    if (this.drawer_) {
-      this.drawer_.draw(oldNode, this.curNode_);
-    }
-  }
-
-  /**
-   * Redraw the current marker.
-   * @internal
-   */
-  draw() {
-    if (this.drawer_) {
-      this.drawer_.draw(this.curNode_, this.curNode_);
-    }
-  }
-
-  /** Hide the marker SVG. */
-  hide() {
-    if (this.drawer_) {
-      this.drawer_.hide();
-    }
-  }
-
-  /** Dispose of this marker. */
-  dispose() {
-    if (this.getDrawer()) {
-      this.getDrawer().dispose();
-    }
-  }
-}

package/core/keyboard_nav/tab_navigate_cursor.ts

@@ -1,48 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview The class representing a cursor that is used to navigate
- * between tab navigable fields.
- */
-
-/**
- * The class representing a cursor that is used to navigate
- * between tab navigable fields.
- * @class
- */
-import * as goog from '../../closure/goog/goog.js';
-goog.declareModuleId('Blockly.TabNavigateCursor');
-
-import type {Field} from '../field.js';
-
-import {ASTNode} from './ast_node.js';
-import {BasicCursor} from './basic_cursor.js';
-
-
-/**
- * A cursor for navigating between tab navigable fields.
- * @alias Blockly.TabNavigateCursor
- */
-export class TabNavigateCursor extends BasicCursor {
-  /**
-   * Skip all nodes except for tab navigable fields.
-   * @param node The AST node to check whether it is valid.
-   * @return True if the node should be visited, false otherwise.
-   */
-  override validNode_(node: ASTNode|null): boolean {
-    let isValid = false;
-    const type = node && node.getType();
-    if (node) {
-      const location = node.getLocation() as Field;
-      if (type === ASTNode.types.FIELD && location &&
-          location.isTabNavigable() && location.isClickable()) {
-        isValid = true;
-      }
-    }
-    return isValid;
-  }
-}