blockly 8.0.5 → 9.0.0-beta.0

package/core/events/events_abstract.js

@@ -1,133 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Abstract class for events fired as a result of actions in
- * Blockly's editor.
- */
-'use strict';
-
-/**
- * Abstract class for events fired as a result of actions in
- * Blockly's editor.
- * @class
- */
-goog.module('Blockly.Events.Abstract');
-
-const eventUtils = goog.require('Blockly.Events.utils');
-/* eslint-disable-next-line no-unused-vars */
-const {Workspace} = goog.requireType('Blockly.Workspace');
-
-
-/**
- * Abstract class for an event.
- * @abstract
- * @alias Blockly.Events.Abstract
- */
-class Abstract {
-  /**
-   * @alias Blockly.Events.Abstract
-   */
-  constructor() {
-    /**
-     * Whether or not the event is blank (to be populated by fromJson).
-     * @type {?boolean}
-     */
-    this.isBlank = null;
-
-    /**
-     * The workspace identifier for this event.
-     * @type {string|undefined}
-     */
-    this.workspaceId = undefined;
-
-    /**
-     * The event group id for the group this event belongs to. Groups define
-     * events that should be treated as an single action from the user's
-     * perspective, and should be undone together.
-     * @type {string}
-     */
-    this.group = eventUtils.getGroup();
-
-    /**
-     * Sets whether the event should be added to the undo stack.
-     * @type {boolean}
-     */
-    this.recordUndo = eventUtils.getRecordUndo();
-
-    /**
-     * Whether or not the event is a UI event.
-     * @type {boolean}
-     */
-    this.isUiEvent = false;
-
-    /**
-     * Type of this event.
-     * @type {string|undefined}
-     */
-    this.type = undefined;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = {'type': this.type};
-    if (this.group) {
-      json['group'] = this.group;
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    this.isBlank = false;
-    this.group = json['group'];
-  }
-
-  /**
-   * Does this event record any change of state?
-   * @return {boolean} True if null, false if something changed.
-   */
-  isNull() {
-    return false;
-  }
-
-  /**
-   * Run an event.
-   * @param {boolean} _forward True if run forward, false if run backward
-   *     (undo).
-   */
-  run(_forward) {
-    // Defined by subclasses.
-  }
-
-  /**
-   * Get workspace the event belongs to.
-   * @return {!Workspace} The workspace the event belongs to.
-   * @throws {Error} if workspace is null.
-   * @protected
-   */
-  getEventWorkspace_() {
-    let workspace;
-    if (this.workspaceId) {
-      const {Workspace} = goog.module.get('Blockly.Workspace');
-      workspace = Workspace.getById(this.workspaceId);
-    }
-    if (!workspace) {
-      throw Error(
-          'Workspace is null. Event must have been generated from real' +
-          ' Blockly events.');
-    }
-    return workspace;
-  }
-}
-
-exports.Abstract = Abstract;

package/core/events/events_block_base.js

@@ -1,70 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Base class for all types of block events.
- */
-'use strict';
-
-/**
- * Base class for all types of block events.
- * @class
- */
-goog.module('Blockly.Events.BlockBase');
-
-const {Abstract: AbstractEvent} = goog.require('Blockly.Events.Abstract');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
-
-
-/**
- * Abstract class for a block event.
- * @extends {AbstractEvent}
- * @alias Blockly.Events.BlockBase
- */
-class BlockBase extends AbstractEvent {
-  /**
-   * @param {!Block=} opt_block The block this event corresponds to.
-   *     Undefined for a blank event.
-   */
-  constructor(opt_block) {
-    super();
-    this.isBlank = typeof opt_block === 'undefined';
-
-    /**
-     * The block ID for the block this event pertains to
-     * @type {string}
-     */
-    this.blockId = this.isBlank ? '' : opt_block.id;
-
-    /**
-     * The workspace identifier for this event.
-     * @type {string}
-     */
-    this.workspaceId = this.isBlank ? '' : opt_block.workspace.id;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = super.toJson();
-    json['blockId'] = this.blockId;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    super.fromJson(json);
-    this.blockId = json['blockId'];
-  }
-}
-
-exports.BlockBase = BlockBase;

package/core/events/events_block_drag.js

@@ -1,89 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a block drag.
- */
-'use strict';
-
-/**
- * Events fired as a block drag.
- * @class
- */
-goog.module('Blockly.Events.BlockDrag');
-
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
-const {UiBase} = goog.require('Blockly.Events.UiBase');
-
-
-/**
- * Class for a block drag event.
- * @extends {UiBase}
- * @alias Blockly.Events.BlockDrag
- */
-class BlockDrag extends UiBase {
-  /**
-   * @param {!Block=} opt_block The top block in the stack that is being
-   *    dragged. Undefined for a blank event.
-   * @param {boolean=} opt_isStart Whether this is the start of a block drag.
-   *    Undefined for a blank event.
-   * @param {!Array<!Block>=} opt_blocks The blocks affected by this
-   *    drag. Undefined for a blank event.
-   */
-  constructor(opt_block, opt_isStart, opt_blocks) {
-    const workspaceId = opt_block ? opt_block.workspace.id : undefined;
-    super(workspaceId);
-    this.blockId = opt_block ? opt_block.id : null;
-
-    /**
-     * Whether this is the start of a block drag.
-     * @type {boolean|undefined}
-     */
-    this.isStart = opt_isStart;
-
-    /**
-     * The blocks affected by this drag event.
-     * @type {!Array<!Block>|undefined}
-     */
-    this.blocks = opt_blocks;
-
-    /**
-     * Type of this event.
-     * @type {string}
-     */
-    this.type = eventUtils.BLOCK_DRAG;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = super.toJson();
-    json['isStart'] = this.isStart;
-    json['blockId'] = this.blockId;
-    json['blocks'] = this.blocks;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    super.fromJson(json);
-    this.isStart = json['isStart'];
-    this.blockId = json['blockId'];
-    this.blocks = json['blocks'];
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.BLOCK_DRAG, BlockDrag);
-
-exports.BlockDrag = BlockDrag;

package/core/events/events_bubble_open.js

@@ -1,90 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of bubble open.
- */
-'use strict';
-
-/**
- * Events fired as a result of bubble open.
- * @class
- */
-goog.module('Blockly.Events.BubbleOpen');
-
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-/* eslint-disable-next-line no-unused-vars */
-const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-const {UiBase} = goog.require('Blockly.Events.UiBase');
-
-
-/**
- * Class for a bubble open event.
- * @extends {UiBase}
- * @alias Blockly.Events.BubbleOpen
- */
-class BubbleOpen extends UiBase {
-  /**
-   * @param {BlockSvg} opt_block The associated block. Undefined for a
-   *    blank event.
-   * @param {boolean=} opt_isOpen Whether the bubble is opening (false if
-   *    closing). Undefined for a blank event.
-   * @param {string=} opt_bubbleType The type of bubble. One of 'mutator',
-   *     'comment'
-   *    or 'warning'. Undefined for a blank event.
-   */
-  constructor(opt_block, opt_isOpen, opt_bubbleType) {
-    const workspaceId = opt_block ? opt_block.workspace.id : undefined;
-    super(workspaceId);
-    this.blockId = opt_block ? opt_block.id : null;
-
-    /**
-     * Whether the bubble is opening (false if closing).
-     * @type {boolean|undefined}
-     */
-    this.isOpen = opt_isOpen;
-
-    /**
-     * The type of bubble. One of 'mutator', 'comment', or 'warning'.
-     * @type {string|undefined}
-     */
-    this.bubbleType = opt_bubbleType;
-
-    /**
-     * Type of this event.
-     * @type {string}
-     */
-    this.type = eventUtils.BUBBLE_OPEN;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = super.toJson();
-    json['isOpen'] = this.isOpen;
-    json['bubbleType'] = this.bubbleType;
-    json['blockId'] = this.blockId;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    super.fromJson(json);
-    this.isOpen = json['isOpen'];
-    this.bubbleType = json['bubbleType'];
-    this.blockId = json['blockId'];
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.BUBBLE_OPEN, BubbleOpen);
-
-exports.BubbleOpen = BubbleOpen;

package/core/events/events_comment_base.js

@@ -1,121 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Base class for comment events.
- */
-'use strict';
-
-/**
- * Base class for comment events.
- * @class
- */
-goog.module('Blockly.Events.CommentBase');
-
-const Xml = goog.require('Blockly.Xml');
-const eventUtils = goog.require('Blockly.Events.utils');
-const utilsXml = goog.require('Blockly.utils.xml');
-const {Abstract: AbstractEvent} = goog.require('Blockly.Events.Abstract');
-/* eslint-disable-next-line no-unused-vars */
-const {CommentCreate} = goog.requireType('Blockly.Events.CommentCreate');
-/* eslint-disable-next-line no-unused-vars */
-const {CommentDelete} = goog.requireType('Blockly.Events.CommentDelete');
-/* eslint-disable-next-line no-unused-vars */
-const {WorkspaceComment} = goog.requireType('Blockly.WorkspaceComment');
-
-
-/**
- * Abstract class for a comment event.
- * @extends {AbstractEvent}
- * @alias Blockly.Events.CommentBase
- */
-class CommentBase extends AbstractEvent {
-  /**
-   * @param {!WorkspaceComment=} opt_comment The comment this event
-   *     corresponds to.  Undefined for a blank event.
-   */
-  constructor(opt_comment) {
-    super();
-    /**
-     * Whether or not an event is blank.
-     * @type {boolean}
-     */
-    this.isBlank = typeof opt_comment === 'undefined';
-
-    /**
-     * The ID of the comment this event pertains to.
-     * @type {string}
-     */
-    this.commentId = this.isBlank ? '' : opt_comment.id;
-
-    /**
-     * The workspace identifier for this event.
-     * @type {string}
-     */
-    this.workspaceId = this.isBlank ? '' : opt_comment.workspace.id;
-
-    /**
-     * The event group id for the group this event belongs to. Groups define
-     * events that should be treated as an single action from the user's
-     * perspective, and should be undone together.
-     * @type {string}
-     */
-    this.group = eventUtils.getGroup();
-
-    /**
-     * Sets whether the event should be added to the undo stack.
-     * @type {boolean}
-     */
-    this.recordUndo = eventUtils.getRecordUndo();
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = super.toJson();
-    if (this.commentId) {
-      json['commentId'] = this.commentId;
-    }
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    super.fromJson(json);
-    this.commentId = json['commentId'];
-  }
-
-  /**
-   * Helper function for Comment[Create|Delete]
-   * @param {!CommentCreate|!CommentDelete} event
-   *     The event to run.
-   * @param {boolean} create if True then Create, if False then Delete
-   */
-  static CommentCreateDeleteHelper(event, create) {
-    const workspace = event.getEventWorkspace_();
-    if (create) {
-      const xmlElement = utilsXml.createElement('xml');
-      xmlElement.appendChild(event.xml);
-      Xml.domToWorkspace(xmlElement, workspace);
-    } else {
-      const comment = workspace.getCommentById(event.commentId);
-      if (comment) {
-        comment.dispose();
-      } else {
-        // Only complain about root-level block.
-        console.warn(
-            'Can\'t uncreate non-existent comment: ' + event.commentId);
-      }
-    }
-  }
-}
-
-exports.CommentBase = CommentBase;

package/core/events/events_marker_move.js

@@ -1,110 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of a marker move.
- */
-'use strict';
-
-/**
- * Events fired as a result of a marker move.
- * @class
- */
-goog.module('Blockly.Events.MarkerMove');
-
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {ASTNode} = goog.require('Blockly.ASTNode');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
-const {UiBase} = goog.require('Blockly.Events.UiBase');
-/* eslint-disable-next-line no-unused-vars */
-const {Workspace} = goog.requireType('Blockly.Workspace');
-
-
-/**
- * Class for a marker move event.
- * @extends {UiBase}
- * @alias Blockly.Events.MarkerMove
- */
-class MarkerMove extends UiBase {
-  /**
-   * @param {?Block=} opt_block The affected block. Null if current node
-   *    is of type workspace. Undefined for a blank event.
-   * @param {boolean=} isCursor Whether this is a cursor event. Undefined for a
-   *    blank event.
-   * @param {?ASTNode=} opt_oldNode The old node the marker used to be on.
-   *    Undefined for a blank event.
-   * @param {!ASTNode=} opt_newNode The new node the marker is now on.
-   *    Undefined for a blank event.
-   */
-  constructor(opt_block, isCursor, opt_oldNode, opt_newNode) {
-    let workspaceId = opt_block ? opt_block.workspace.id : undefined;
-    if (opt_newNode && opt_newNode.getType() === ASTNode.types.WORKSPACE) {
-      workspaceId = (/** @type {!Workspace} */ (opt_newNode.getLocation())).id;
-    }
-    super(workspaceId);
-
-    /**
-     * The workspace identifier for this event.
-     * @type {?string}
-     */
-    this.blockId = opt_block ? opt_block.id : null;
-
-    /**
-     * The old node the marker used to be on.
-     * @type {?ASTNode|undefined}
-     */
-    this.oldNode = opt_oldNode;
-
-    /**
-     * The new node the  marker is now on.
-     * @type {ASTNode|undefined}
-     */
-    this.newNode = opt_newNode;
-
-    /**
-     * Whether this is a cursor event.
-     * @type {boolean|undefined}
-     */
-    this.isCursor = isCursor;
-
-    /**
-     * Type of this event.
-     * @type {string}
-     */
-    this.type = eventUtils.MARKER_MOVE;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = super.toJson();
-    json['isCursor'] = this.isCursor;
-    json['blockId'] = this.blockId;
-    json['oldNode'] = this.oldNode;
-    json['newNode'] = this.newNode;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    super.fromJson(json);
-    this.isCursor = json['isCursor'];
-    this.blockId = json['blockId'];
-    this.oldNode = json['oldNode'];
-    this.newNode = json['newNode'];
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.MARKER_MOVE, MarkerMove);
-
-exports.MarkerMove = MarkerMove;

package/core/events/events_selected.js

@@ -1,83 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Events fired as a result of element select action.
- */
-'use strict';
-
-/**
- * Events fired as a result of element select action.
- * @class
- */
-goog.module('Blockly.Events.Selected');
-
-const eventUtils = goog.require('Blockly.Events.utils');
-const registry = goog.require('Blockly.registry');
-const {UiBase} = goog.require('Blockly.Events.UiBase');
-
-
-/**
- * Class for a selected event.
- * @extends {UiBase}
- * @alias Blockly.Events.Selected
- */
-class Selected extends UiBase {
-  /**
-   * @param {?string=} opt_oldElementId The ID of the previously selected
-   *    element. Null if no element last selected. Undefined for a blank event.
-   * @param {?string=} opt_newElementId The ID of the selected element. Null if
-   *     no element currently selected (deselect). Undefined for a blank event.
-   * @param {string=} opt_workspaceId The workspace identifier for this event.
-   *    Null if no element previously selected. Undefined for a blank event.
-   */
-  constructor(opt_oldElementId, opt_newElementId, opt_workspaceId) {
-    super(opt_workspaceId);
-
-    /**
-     * The id of the last selected element.
-     * @type {?string|undefined}
-     */
-    this.oldElementId = opt_oldElementId;
-
-    /**
-     * The id of the selected element.
-     * @type {?string|undefined}
-     */
-    this.newElementId = opt_newElementId;
-
-    /**
-     * Type of this event.
-     * @type {string}
-     */
-    this.type = eventUtils.SELECTED;
-  }
-
-  /**
-   * Encode the event as JSON.
-   * @return {!Object} JSON representation.
-   */
-  toJson() {
-    const json = super.toJson();
-    json['oldElementId'] = this.oldElementId;
-    json['newElementId'] = this.newElementId;
-    return json;
-  }
-
-  /**
-   * Decode the JSON event.
-   * @param {!Object} json JSON representation.
-   */
-  fromJson(json) {
-    super.fromJson(json);
-    this.oldElementId = json['oldElementId'];
-    this.newElementId = json['newElementId'];
-  }
-}
-
-registry.register(registry.Type.EVENT, eventUtils.SELECTED, Selected);
-
-exports.Selected = Selected;