scratch-blocks 2.0.0-beta.1 → 2.0.0-spork.1

package/blockly-rc/core/layer_manager.ts

@@ -1,186 +0,0 @@
-/**
- * @license
- * Copyright 2023 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {WorkspaceSvg} from './workspace_svg.js';
-import * as dom from './utils/dom.js';
-import {Svg} from './utils/svg.js';
-import {IRenderedElement} from './interfaces/i_rendered_element.js';
-import * as layerNums from './layers.js';
-import {Coordinate} from './utils/coordinate.js';
-
-/** @internal */
-export class LayerManager {
-  /** The layer elements being dragged are appended to. */
-  private dragLayer: SVGGElement | undefined;
-  /** The layer elements being animated are appended to. */
-  private animationLayer: SVGGElement | undefined;
-  /** The layers elements not being dragged are appended to.  */
-  private layers = new Map<number, SVGGElement>();
-
-  /** @internal */
-  constructor(private workspace: WorkspaceSvg) {
-    const injectionDiv = workspace.getInjectionDiv();
-    // `getInjectionDiv` is actually nullable. We hit this if the workspace
-    // is part of a flyout and the workspace the flyout is attached to hasn't
-    // been appended yet.
-    if (injectionDiv) {
-      this.dragLayer = this.createDragLayer(injectionDiv);
-      this.animationLayer = this.createAnimationLayer(injectionDiv);
-    }
-
-    // We construct these manually so we can add the css class for backwards
-    // compatibility.
-    const blockLayer = this.createLayer(layerNums.BLOCK);
-    dom.addClass(blockLayer, 'blocklyBlockCanvas');
-    const bubbleLayer = this.createLayer(layerNums.BUBBLE);
-    dom.addClass(bubbleLayer, 'blocklyBubbleCanvas');
-  }
-
-  private createDragLayer(injectionDiv: Element) {
-    const svg = dom.createSvgElement(Svg.SVG, {
-      'class': 'blocklyBlockDragSurface',
-      'xmlns': dom.SVG_NS,
-      'xmlns:html': dom.HTML_NS,
-      'xmlns:xlink': dom.XLINK_NS,
-      'version': '1.1',
-    });
-    injectionDiv.append(svg);
-    return dom.createSvgElement(Svg.G, {}, svg);
-  }
-
-  private createAnimationLayer(injectionDiv: Element) {
-    const svg = dom.createSvgElement(Svg.SVG, {
-      'class': 'blocklyAnimationLayer',
-      'xmlns': dom.SVG_NS,
-      'xmlns:html': dom.HTML_NS,
-      'xmlns:xlink': dom.XLINK_NS,
-      'version': '1.1',
-    });
-    injectionDiv.append(svg);
-    return dom.createSvgElement(Svg.G, {}, svg);
-  }
-
-  /**
-   * Appends the element to the animation layer. The animation layer doesn't
-   * move when the workspace moves, so e.g. delete animations don't move
-   * when a block delete triggers a workspace resize.
-   *
-   * @internal
-   */
-  appendToAnimationLayer(elem: IRenderedElement) {
-    const currentTransform = this.dragLayer?.getAttribute('transform');
-    // Only update the current transform when appending, so animations don't
-    // move if the workspace moves.
-    if (currentTransform) {
-      this.animationLayer?.setAttribute('transform', currentTransform);
-    }
-    this.animationLayer?.appendChild(elem.getSvgRoot());
-  }
-
-  /**
-   * Translates layers when the workspace is dragged or zoomed.
-   *
-   * @internal
-   */
-  translateLayers(newCoord: Coordinate, newScale: number) {
-    const translation = `translate(${newCoord.x}, ${newCoord.y}) scale(${newScale})`;
-    this.dragLayer?.setAttribute('transform', translation);
-    for (const [_, layer] of this.layers) {
-      layer.setAttribute('transform', translation);
-    }
-  }
-
-  /**
-   * Moves the given element to the drag layer, which exists on top of all other
-   * layers, and the drag surface.
-   *
-   * @internal
-   */
-  moveToDragLayer(elem: IRenderedElement) {
-    this.dragLayer?.appendChild(elem.getSvgRoot());
-  }
-
-  /**
-   * Moves the given element off of the drag layer.
-   *
-   * @internal
-   */
-  moveOffDragLayer(elem: IRenderedElement, layerNum: number) {
-    this.append(elem, layerNum);
-  }
-
-  /**
-   * Appends the given element to a layer. If the layer does not exist, it is
-   * created.
-   *
-   * @internal
-   */
-  append(elem: IRenderedElement, layerNum: number) {
-    if (!this.layers.has(layerNum)) {
-      this.createLayer(layerNum);
-    }
-    this.layers.get(layerNum)?.appendChild(elem.getSvgRoot());
-  }
-
-  /**
-   * Creates a layer and inserts it at the proper place given the layer number.
-   *
-   * More positive layers exist later in the dom and are rendered ontop of
-   * less positive layers. Layers are added to the layer map as a side effect.
-   */
-  private createLayer(layerNum: number): SVGGElement {
-    const parent = this.workspace.getSvgGroup();
-    const layer = dom.createSvgElement(Svg.G, {});
-
-    let inserted = false;
-    const sortedLayers = [...this.layers].sort((a, b) => a[0] - b[0]);
-    for (const [num, sib] of sortedLayers) {
-      if (layerNum < num) {
-        parent.insertBefore(layer, sib);
-        inserted = true;
-        break;
-      }
-    }
-    if (!inserted) {
-      parent.appendChild(layer);
-    }
-    this.layers.set(layerNum, layer);
-    return layer;
-  }
-
-  /**
-   * Returns true if the given element is a layer managed by the layer manager.
-   * False otherwise.
-   *
-   * @internal
-   */
-  hasLayer(elem: SVGElement) {
-    return (
-      elem === this.dragLayer ||
-      new Set(this.layers.values()).has(elem as SVGGElement)
-    );
-  }
-
-  /**
-   * We need to be able to access this layer explicitly for backwards
-   * compatibility.
-   *
-   * @internal
-   */
-  getBlockLayer(): SVGGElement {
-    return this.layers.get(layerNums.BLOCK)!;
-  }
-
-  /**
-   * We need to be able to access this layer explicitly for backwards
-   * compatibility.
-   *
-   * @internal
-   */
-  getBubbleLayer(): SVGGElement {
-    return this.layers.get(layerNums.BUBBLE)!;
-  }
-}

package/blockly-rc/core/layers.ts

@@ -1,17 +0,0 @@
-/**
- * @license
- * Copyright 2023 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * The layer to place blocks on.
- *
- */
-export const BLOCK = 50;
-
-/**
- * The layer to place bubbles on.
- *
- */
-export const BUBBLE = 100;

package/blockly-rc/core/main.ts

@@ -1,31 +0,0 @@
-/**
- * @license
- * Copyright 2022 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @file The entrypoint for blockly_compressed.js.  Provides various
- * backwards-compatibility hacks.  Not used when loading in
- * uncompressed mode.
- */
-
-// Former goog.module ID: Blockly.main
-
-import * as Msg from './msg.js';
-
-// If Blockly is compiled with ADVANCED_COMPILATION and/or loaded as a
-// CJS or ES module there will not be a Blockly global variable
-// created.  This can cause problems because a very common way of
-// loading translations is to use a <script> tag to load one of
-// the generated msg/*.js files, which consists of lines like:
-//
-// Blockly.Msg["ADD_COMMENT"] = "Add Comment";
-// Blockly.Msg["CLEAN_UP"] = "Clean up Blocks";
-//
-// This obviously only works if Blockly.Msg is the Msg export from the
-// Blockly.Msg module - so make sure it is, but only if there is not
-// yet a Blockly global variable.
-if (!('Blockly' in globalThis)) {
-  (globalThis as any)['Blockly'] = {'Msg': Msg};
-}

package/blockly-rc/core/marker_manager.ts

@@ -1,189 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * Object in charge of managing markers and the cursor.
- *
- * @class
- */
-// Former goog.module ID: Blockly.MarkerManager
-
-import type {Cursor} from './keyboard_nav/cursor.js';
-import type {Marker} from './keyboard_nav/marker.js';
-import type {WorkspaceSvg} from './workspace_svg.js';
-
-/**
- * Class to manage the multiple markers and the cursor on a workspace.
- */
-export class MarkerManager {
-  /** The name of the local marker. */
-  static readonly LOCAL_MARKER = 'local_marker_1';
-
-  /** The cursor. */
-  private cursor_: Cursor | null = null;
-
-  /** The cursor's SVG element. */
-  private cursorSvg_: SVGElement | null = null;
-
-  /** The map of markers for the workspace. */
-  private markers = new Map<string, Marker>();
-
-  /** The marker's SVG element. */
-  private markerSvg_: SVGElement | null = null;
-
-  /**
-   * @param workspace The workspace for the marker manager.
-   * @internal
-   */
-  constructor(private readonly workspace: WorkspaceSvg) {}
-
-  /**
-   * Register the marker by adding it to the map of markers.
-   *
-   * @param id A unique identifier for the marker.
-   * @param marker The marker to register.
-   */
-  registerMarker(id: string, marker: Marker) {
-    if (this.markers.has(id)) {
-      this.unregisterMarker(id);
-    }
-    marker.setDrawer(
-      this.workspace.getRenderer().makeMarkerDrawer(this.workspace, marker),
-    );
-    this.setMarkerSvg(marker.getDrawer().createDom());
-    this.markers.set(id, marker);
-  }
-
-  /**
-   * Unregister the marker by removing it from the map of markers.
-   *
-   * @param id The ID of the marker to unregister.
-   */
-  unregisterMarker(id: string) {
-    const marker = this.markers.get(id);
-    if (marker) {
-      marker.dispose();
-      this.markers.delete(id);
-    } else {
-      throw Error(
-        'Marker with ID ' +
-          id +
-          ' does not exist. ' +
-          'Can only unregister markers that exist.',
-      );
-    }
-  }
-
-  /**
-   * Get the cursor for the workspace.
-   *
-   * @returns The cursor for this workspace.
-   */
-  getCursor(): Cursor | null {
-    return this.cursor_;
-  }
-
-  /**
-   * Get a single marker that corresponds to the given ID.
-   *
-   * @param id A unique identifier for the marker.
-   * @returns The marker that corresponds to the given ID, or null if none
-   *     exists.
-   */
-  getMarker(id: string): Marker | null {
-    return this.markers.get(id) || null;
-  }
-
-  /**
-   * Sets the cursor and initializes the drawer for use with keyboard
-   * navigation.
-   *
-   * @param cursor The cursor used to move around this workspace.
-   */
-  setCursor(cursor: Cursor) {
-    if (this.cursor_ && this.cursor_.getDrawer()) {
-      this.cursor_.getDrawer().dispose();
-    }
-    this.cursor_ = cursor;
-    if (this.cursor_) {
-      const drawer = this.workspace
-        .getRenderer()
-        .makeMarkerDrawer(this.workspace, this.cursor_);
-      this.cursor_.setDrawer(drawer);
-      this.setCursorSvg(this.cursor_.getDrawer().createDom());
-    }
-  }
-
-  /**
-   * Add the cursor SVG to this workspace SVG group.
-   *
-   * @param cursorSvg The SVG root of the cursor to be added to the workspace
-   *     SVG group.
-   * @internal
-   */
-  setCursorSvg(cursorSvg: SVGElement | null) {
-    if (!cursorSvg) {
-      this.cursorSvg_ = null;
-      return;
-    }
-
-    this.workspace.getBlockCanvas()!.appendChild(cursorSvg);
-    this.cursorSvg_ = cursorSvg;
-  }
-
-  /**
-   * Add the marker SVG to this workspaces SVG group.
-   *
-   * @param markerSvg The SVG root of the marker to be added to the workspace
-   *     SVG group.
-   * @internal
-   */
-  setMarkerSvg(markerSvg: SVGElement | null) {
-    if (!markerSvg) {
-      this.markerSvg_ = null;
-      return;
-    }
-
-    if (this.workspace.getBlockCanvas()) {
-      if (this.cursorSvg_) {
-        this.workspace
-          .getBlockCanvas()!
-          .insertBefore(markerSvg, this.cursorSvg_);
-      } else {
-        this.workspace.getBlockCanvas()!.appendChild(markerSvg);
-      }
-    }
-  }
-
-  /**
-   * Redraw the attached cursor SVG if needed.
-   *
-   * @internal
-   */
-  updateMarkers() {
-    if (this.workspace.keyboardAccessibilityMode && this.cursorSvg_) {
-      this.workspace.getCursor()!.draw();
-    }
-  }
-
-  /**
-   * Dispose of the marker manager.
-   * Go through and delete all markers associated with this marker manager.
-   *
-   * @internal
-   */
-  dispose() {
-    const markerIds = Object.keys(this.markers);
-    for (let i = 0, markerId; (markerId = markerIds[i]); i++) {
-      this.unregisterMarker(markerId);
-    }
-    this.markers.clear();
-    if (this.cursor_) {
-      this.cursor_.dispose();
-      this.cursor_ = null;
-    }
-  }
-}