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

package/core/workspace_audio.ts

@@ -1,156 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Object in charge of loading, storing, and playing audio for a
- *     workspace.
- */
-
-/**
- * Object in charge of loading, storing, and playing audio for a
- *     workspace.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.WorkspaceAudio');
-
-import * as userAgent from './utils/useragent.js';
-import type {WorkspaceSvg} from './workspace_svg.js';
-
-
-/**
- * Prevent a sound from playing if another sound preceded it within this many
- * milliseconds.
- */
-const SOUND_LIMIT = 100;
-
-/**
- * Class for loading, storing, and playing audio for a workspace.
- * @alias Blockly.WorkspaceAudio
- */
-export class WorkspaceAudio {
-  /** Database of pre-loaded sounds. */
-  private sounds = new Map<string, HTMLAudioElement>();
-
-  /** Time that the last sound was played. */
-  // AnyDuringMigration because:  Type 'null' is not assignable to type 'Date'.
-  private lastSound_: Date = null as AnyDuringMigration;
-
-  /**
-   * @param parentWorkspace The parent of the workspace this audio object
-   *     belongs to, or null.
-   */
-  constructor(private parentWorkspace: WorkspaceSvg) {}
-
-  /**
-   * Dispose of this audio manager.
-   * @internal
-   */
-  dispose() {
-    // AnyDuringMigration because:  Type 'null' is not assignable to type
-    // 'WorkspaceSvg'.
-    this.parentWorkspace = null as AnyDuringMigration;
-    this.sounds.clear();
-  }
-
-  /**
-   * Load an audio file.  Cache it, ready for instantaneous playing.
-   * @param filenames List of file types in decreasing order of preference (i.e.
-   *     increasing size).  E.g. ['media/go.mp3', 'media/go.wav'] Filenames
-   *     include path from Blockly's root.  File extensions matter.
-   * @param name Name of sound.
-   */
-  load(filenames: string[], name: string) {
-    if (!filenames.length) {
-      return;
-    }
-    let audioTest;
-    try {
-      audioTest = new globalThis['Audio']();
-    } catch (e) {
-      // No browser support for Audio.
-      // IE can throw an error even if the Audio object exists.
-      return;
-    }
-    let sound;
-    for (let i = 0; i < filenames.length; i++) {
-      const filename = filenames[i];
-      const ext = filename.match(/\.(\w+)$/);
-      if (ext && audioTest.canPlayType('audio/' + ext[1])) {
-        // Found an audio format we can play.
-        sound = new globalThis['Audio'](filename);
-        break;
-      }
-    }
-    if (sound) {
-      this.sounds.set(name, sound);
-    }
-  }
-
-  /**
-   * Preload all the audio files so that they play quickly when asked for.
-   * @internal
-   */
-  preload() {
-    for (const sound of this.sounds.values()) {
-      sound.volume = 0.01;
-      const playPromise = sound.play();
-      // Edge does not return a promise, so we need to check.
-      if (playPromise !== undefined) {
-        // If we don't wait for the play request to complete before calling
-        // pause() we will get an exception: (DOMException: The play() request
-        // was interrupted) See more:
-        // https://developers.google.com/web/updates/2017/06/play-request-was-interrupted
-        playPromise.then(sound.pause)
-            .catch(
-                // Play without user interaction was prevented.
-                function() {});
-      } else {
-        sound.pause();
-      }
-
-      // iOS can only process one sound at a time.  Trying to load more than one
-      // corrupts the earlier ones.  Just load one and leave the others
-      // uncached.
-      if (userAgent.IPAD || userAgent.IPHONE) {
-        break;
-      }
-    }
-  }
-
-  /**
-   * Play a named sound at specified volume.  If volume is not specified,
-   * use full volume (1).
-   * @param name Name of sound.
-   * @param opt_volume Volume of sound (0-1).
-   */
-  play(name: string, opt_volume?: number) {
-    const sound = this.sounds.get(name);
-    if (sound) {
-      // Don't play one sound on top of another.
-      const now = new Date();
-      if (this.lastSound_ !== null &&
-          now.getTime() - this.lastSound_.getTime() < SOUND_LIMIT) {
-        return;
-      }
-      this.lastSound_ = now;
-      let mySound;
-      if (userAgent.IPAD || userAgent.ANDROID) {
-        // Creating a new audio node causes lag in Android and iPad.  Android
-        // refetches the file from the server, iPad uses a singleton audio
-        // node which must be deleted and recreated for each new audio tag.
-        mySound = sound;
-      } else {
-        mySound = sound.cloneNode() as HTMLAudioElement;
-      }
-      mySound.volume = opt_volume === undefined ? 1 : opt_volume;
-      mySound.play();
-    } else if (this.parentWorkspace) {
-      // Maybe a workspace on a lower level knows about this sound.
-      this.parentWorkspace.getAudioManager().play(name, opt_volume);
-    }
-  }
-}

package/core/workspace_comment.ts

@@ -1,398 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Object representing a code comment on the workspace.
- */
-
-/**
- * Object representing a code comment on the workspace.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.WorkspaceComment');
-
-// Unused import preserved for side-effects. Remove if unneeded.
-// import './events/events_comment_change.js';
-// Unused import preserved for side-effects. Remove if unneeded.
-// import './events/events_comment_create.js';
-// Unused import preserved for side-effects. Remove if unneeded.
-// import './events/events_comment_delete.js';
-
-import type {CommentMove} from './events/events_comment_move.js';
-import * as eventUtils from './events/utils.js';
-import {Coordinate} from './utils/coordinate.js';
-import * as idGenerator from './utils/idgenerator.js';
-import * as xml from './utils/xml.js';
-import type {Workspace} from './workspace.js';
-
-
-/**
- * Class for a workspace comment.
- * @alias Blockly.WorkspaceComment
- */
-export class WorkspaceComment {
-  id: string;
-  protected xy_: Coordinate;
-  protected height_: number;
-  protected width_: number;
-  protected RTL: boolean;
-
-  private deletable_ = true;
-
-  private movable_ = true;
-
-  private editable_ = true;
-  protected content_: string;
-
-  /** Whether this comment has been disposed. */
-  protected disposed_ = false;
-  /** @internal */
-  isComment = true;
-
-  /**
-   * @param workspace The block's workspace.
-   * @param content The content of this workspace comment.
-   * @param height Height of the comment.
-   * @param width Width of the comment.
-   * @param opt_id Optional ID.  Use this ID if provided, otherwise create a new
-   *     ID.
-   */
-  constructor(
-      public workspace: Workspace, content: string, height: number,
-      width: number, opt_id?: string) {
-    this.id = opt_id && !workspace.getCommentById(opt_id) ?
-        opt_id :
-        idGenerator.genUid();
-
-    workspace.addTopComment(this);
-
-    /**
-     * The comment's position in workspace units.  (0, 0) is at the workspace's
-     * origin; scale does not change this value.
-     */
-    this.xy_ = new Coordinate(0, 0);
-
-    /**
-     * The comment's height in workspace units.  Scale does not change this
-     * value.
-     */
-    this.height_ = height;
-
-    /**
-     * The comment's width in workspace units.  Scale does not change this
-     * value.
-     */
-    this.width_ = width;
-
-    this.RTL = workspace.RTL;
-
-    this.content_ = content;
-
-    WorkspaceComment.fireCreateEvent(this);
-  }
-
-  /**
-   * Dispose of this comment.
-   * @internal
-   */
-  dispose() {
-    if (this.disposed_) {
-      return;
-    }
-
-    if (eventUtils.isEnabled()) {
-      eventUtils.fire(new (eventUtils.get(eventUtils.COMMENT_DELETE))!(this));
-    }
-    // Remove from the list of top comments and the comment database.
-    this.workspace.removeTopComment(this);
-    this.disposed_ = true;
-  }
-
-  // Height, width, x, and y are all stored on even non-rendered comments, to
-  // preserve state if you pass the contents through a headless workspace.
-
-  /**
-   * Get comment height.
-   * @return Comment height.
-   * @internal
-   */
-  getHeight(): number {
-    return this.height_;
-  }
-
-  /**
-   * Set comment height.
-   * @param height Comment height.
-   * @internal
-   */
-  setHeight(height: number) {
-    this.height_ = height;
-  }
-
-  /**
-   * Get comment width.
-   * @return Comment width.
-   * @internal
-   */
-  getWidth(): number {
-    return this.width_;
-  }
-
-  /**
-   * Set comment width.
-   * @param width comment width.
-   * @internal
-   */
-  setWidth(width: number) {
-    this.width_ = width;
-  }
-
-  /**
-   * Get stored location.
-   * @return The comment's stored location.
-   *   This is not valid if the comment is currently being dragged.
-   * @internal
-   */
-  getXY(): Coordinate {
-    return new Coordinate(this.xy_.x, this.xy_.y);
-  }
-
-  /**
-   * Move a comment by a relative offset.
-   * @param dx Horizontal offset, in workspace units.
-   * @param dy Vertical offset, in workspace units.
-   * @internal
-   */
-  moveBy(dx: number, dy: number) {
-    const event =
-        new (eventUtils.get(eventUtils.COMMENT_MOVE))!(this) as CommentMove;
-    this.xy_.translate(dx, dy);
-    event.recordNew();
-    eventUtils.fire(event);
-  }
-
-  /**
-   * Get whether this comment is deletable or not.
-   * @return True if deletable.
-   * @internal
-   */
-  isDeletable(): boolean {
-    return this.deletable_ &&
-        !(this.workspace && this.workspace.options.readOnly);
-  }
-
-  /**
-   * Set whether this comment is deletable or not.
-   * @param deletable True if deletable.
-   * @internal
-   */
-  setDeletable(deletable: boolean) {
-    this.deletable_ = deletable;
-  }
-
-  /**
-   * Get whether this comment is movable or not.
-   * @return True if movable.
-   * @internal
-   */
-  isMovable(): boolean {
-    return this.movable_ &&
-        !(this.workspace && this.workspace.options.readOnly);
-  }
-
-  /**
-   * Set whether this comment is movable or not.
-   * @param movable True if movable.
-   * @internal
-   */
-  setMovable(movable: boolean) {
-    this.movable_ = movable;
-  }
-
-  /**
-   * Get whether this comment is editable or not.
-   * @return True if editable.
-   */
-  isEditable(): boolean {
-    return this.editable_ &&
-        !(this.workspace && this.workspace.options.readOnly);
-  }
-
-  /**
-   * Set whether this comment is editable or not.
-   * @param editable True if editable.
-   */
-  setEditable(editable: boolean) {
-    this.editable_ = editable;
-  }
-
-  /**
-   * Returns this comment's text.
-   * @return Comment text.
-   * @internal
-   */
-  getContent(): string {
-    return this.content_;
-  }
-
-  /**
-   * Set this comment's content.
-   * @param content Comment content.
-   * @internal
-   */
-  setContent(content: string) {
-    if (this.content_ !== content) {
-      eventUtils.fire(new (eventUtils.get(eventUtils.COMMENT_CHANGE))!
-                      (this, this.content_, content));
-      this.content_ = content;
-    }
-  }
-
-  /**
-   * Encode a comment subtree as XML with XY coordinates.
-   * @param opt_noId True if the encoder should skip the comment ID.
-   * @return Tree of XML elements.
-   * @internal
-   */
-  toXmlWithXY(opt_noId?: boolean): Element {
-    const element = this.toXml(opt_noId);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    element.setAttribute('x', Math.round(this.xy_.x) as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    element.setAttribute('y', Math.round(this.xy_.y) as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    element.setAttribute('h', this.height_ as AnyDuringMigration);
-    // AnyDuringMigration because:  Argument of type 'number' is not assignable
-    // to parameter of type 'string'.
-    element.setAttribute('w', this.width_ as AnyDuringMigration);
-    return element;
-  }
-
-  /**
-   * Encode a comment subtree as XML, but don't serialize the XY coordinates.
-   * This method avoids some expensive metrics-related calls that are made in
-   * toXmlWithXY().
-   * @param opt_noId True if the encoder should skip the comment ID.
-   * @return Tree of XML elements.
-   * @internal
-   */
-  toXml(opt_noId?: boolean): Element {
-    const commentElement = xml.createElement('comment');
-    if (!opt_noId) {
-      commentElement.id = this.id;
-    }
-    commentElement.textContent = this.getContent();
-    return commentElement;
-  }
-
-  /**
-   * Fire a create event for the given workspace comment, if comments are
-   * enabled.
-   * @param comment The comment that was just created.
-   * @internal
-   */
-  static fireCreateEvent(comment: WorkspaceComment) {
-    if (eventUtils.isEnabled()) {
-      const existingGroup = eventUtils.getGroup();
-      if (!existingGroup) {
-        eventUtils.setGroup(true);
-      }
-      try {
-        eventUtils.fire(new (eventUtils.get(eventUtils.COMMENT_CREATE))!
-                        (comment));
-      } finally {
-        if (!existingGroup) {
-          eventUtils.setGroup(false);
-        }
-      }
-    }
-  }
-
-  /**
-   * Decode an XML comment tag and create a comment on the workspace.
-   * @param xmlComment XML comment element.
-   * @param workspace The workspace.
-   * @return The created workspace comment.
-   * @internal
-   */
-  static fromXml(xmlComment: Element, workspace: Workspace): WorkspaceComment {
-    const info = WorkspaceComment.parseAttributes(xmlComment);
-
-    const comment =
-        new WorkspaceComment(workspace, info.content, info.h, info.w, info.id);
-
-    // AnyDuringMigration because:  Argument of type 'string | null' is not
-    // assignable to parameter of type 'string'.
-    const commentX =
-        parseInt(xmlComment.getAttribute('x') as AnyDuringMigration, 10);
-    // AnyDuringMigration because:  Argument of type 'string | null' is not
-    // assignable to parameter of type 'string'.
-    const commentY =
-        parseInt(xmlComment.getAttribute('y') as AnyDuringMigration, 10);
-    if (!isNaN(commentX) && !isNaN(commentY)) {
-      comment.moveBy(commentX, commentY);
-    }
-
-    WorkspaceComment.fireCreateEvent(comment);
-    return comment;
-  }
-
-  /**
-   * Decode an XML comment tag and return the results in an object.
-   * @param xml XML comment element.
-   * @return An object containing the id, size, position, and comment string.
-   * @internal
-   */
-  static parseAttributes(xml: Element): {
-    id: string,
-    w: number,
-    h: number,
-    x: number,
-    y: number,
-    content: string
-  } {
-    const xmlH = xml.getAttribute('h');
-    const xmlW = xml.getAttribute('w');
-
-    return {
-      // @type {string}
-      // AnyDuringMigration because:  Type 'string | null' is not assignable to
-      // type 'string'.
-      id: xml.getAttribute('id') as
-          AnyDuringMigration,  // The height of the comment in workspace units,
-      // or 100 if not specified.
-      // @type {number}
-      h: xmlH ? parseInt(xmlH, 10) :
-                100,  // The width of the comment in workspace units, or 100 if
-      // not specified.
-      // @type {number}
-      w: xmlW ? parseInt(xmlW, 10) :
-                100,  // The x position of the comment in workspace coordinates,
-      // or NaN if not
-      // specified in the XML.
-      // @type {number}
-      // AnyDuringMigration because:  Argument of type 'string | null' is not
-      // assignable to parameter of type 'string'.
-      x: parseInt(
-          xml.getAttribute('x') as AnyDuringMigration,
-          10),  // The y position of the comment in workspace coordinates, or
-      // NaN if not
-      // specified in the XML.
-      // @type {number}
-      // AnyDuringMigration because:  Argument of type 'string | null' is not
-      // assignable to parameter of type 'string'.
-      y: parseInt(
-          xml.getAttribute('y') as AnyDuringMigration, 10),  // @type {string}
-      // AnyDuringMigration because:  Type 'string | null' is not assignable to
-      // type 'string'.
-      content: xml.textContent as AnyDuringMigration,
-    };
-  }
-}