scratch-blocks 2.0.0-spork.4 → 2.0.0-spork.5

package/src/scratch_comment_icon.ts

@@ -5,7 +5,7 @@
  */
 
 import * as Blockly from "blockly/core";
-import { ScratchCommentBubble } from "./scratch_comment_bubble.js";
+import { ScratchCommentBubble } from "./scratch_comment_bubble";
 
 interface CommentState {
   text: string;
@@ -19,7 +19,7 @@ interface CommentState {
 /**
  * Custom comment icon that draws no icon indicator, used for block comments.
  */
-class ScratchCommentIcon
+export class ScratchCommentIcon
   extends Blockly.icons.Icon
   implements Blockly.ISerializable, Blockly.IHasBubble
 {
@@ -34,9 +34,7 @@ class ScratchCommentIcon
   constructor(protected sourceBlock: Blockly.BlockSvg) {
     super(sourceBlock);
     this.commentBubble = new ScratchCommentBubble(this.sourceBlock);
-    Blockly.Events.fire(
-      new (Blockly.Events.get("block_comment_create"))(this.commentBubble)
-    );
+    this.fireCreateEvent();
     this.onTextChangedListener = this.onTextChanged.bind(this);
     this.onSizeChangedListener = this.onSizeChanged.bind(this);
     this.onCollapseListener = this.onCollapsed.bind(this);
@@ -198,10 +196,27 @@ class ScratchCommentIcon
     this.commentBubble.setCollapsed(!visible);
   }
 
+  getBubble() {
+    return this.commentBubble;
+  }
+
   dispose() {
     this.commentBubble.dispose();
     super.dispose();
   }
+
+  canBeFocused() {
+    return false;
+  }
+
+  /**
+   * Fires a block comment create event corresponding to this icon's comment.
+   */
+  fireCreateEvent() {
+    Blockly.Events.fire(
+      new (Blockly.Events.get("block_comment_create"))(this.commentBubble)
+    );
+  }
 }
 
 Blockly.registry.register(

package/src/scratch_continuous_toolbox.ts

@@ -67,4 +67,20 @@ export class ScratchContinuousToolbox extends ContinuousToolbox {
   runAfterRerender(callback: () => void) {
     this.postRenderCallbacks.push(callback);
   }
+
+  /**
+   * Returns whether or not the given item should be deselected.
+   * Prevents items from being deselected without a replacement.
+   *
+   * @param oldItem The item that was previously selected.
+   * @param newItem The item that is proposed to be selected instead.
+   * @returns True if the old item should be allowed to be deselected.
+   */
+  shouldDeselectItem_(
+    oldItem: Blockly.ISelectableToolboxItem | null,
+    newItem: Blockly.ISelectableToolboxItem | null
+  ) {
+    if (!newItem) return false;
+    return super.shouldDeselectItem_(oldItem, newItem);
+  }
 }

package/src/scratch_insertion_marker_previewer.ts

@@ -0,0 +1,45 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as Blockly from "blockly/core";
+
+/**
+ * Displays an indicator of where a block being dragged will be connected.
+ */
+class ScratchInsertionMarkerPreviewer extends Blockly.InsertionMarkerPreviewer {
+  /**
+   * Transforms the given block into a JSON representation used to construct an
+   * insertion marker.
+   *
+   * @param block The block to serialize and use as an insertion marker.
+   * @returns A JSON-formatted string corresponding to a serialized
+   *     representation of the given block suitable for use as an insertion
+   *     marker.
+   */
+  protected override serializeBlockToInsertionMarker(block: Blockly.BlockSvg) {
+    const blockJson = Blockly.serialization.blocks.save(block, {
+      addCoordinates: false,
+      addInputBlocks: true,
+      addNextBlocks: false,
+      doFullSerialization: false,
+    });
+
+    if (!blockJson) {
+      throw new Error(
+        `Failed to serialize source block. ${block.toDevString()}`
+      );
+    }
+
+    return blockJson;
+  }
+}
+
+Blockly.registry.register(
+  Blockly.registry.Type.CONNECTION_PREVIEWER,
+  Blockly.registry.DEFAULT,
+  ScratchInsertionMarkerPreviewer,
+  true
+);

package/src/status_indicator_label_flyout_inflater.ts

@@ -22,15 +22,15 @@ class StatusIndicatorLabelFlyoutInflater extends Blockly.LabelFlyoutInflater {
    */
   load(
     state: Blockly.utils.toolbox.LabelInfo,
-    flyoutWorkspace: Blockly.WorkspaceSvg
+    flyout: Blockly.IFlyout
   ): Blockly.FlyoutItem {
     const label = new StatusIndicatorLabel(
-      flyoutWorkspace,
-      flyoutWorkspace.targetWorkspace,
+      flyout.getWorkspace(),
+      flyout.targetWorkspace,
       state
     );
     label.show();
-    return new Blockly.FlyoutItem(label, STATUS_INDICATOR_LABEL_TYPE, true);
+    return new Blockly.FlyoutItem(label, STATUS_INDICATOR_LABEL_TYPE);
   }
 }
 

package/src/xml.ts

@@ -0,0 +1,57 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as Blockly from "blockly/core";
+import { ScratchVariableModel } from "./scratch_variable_model";
+
+/**
+ * Clears the workspace and loads the given serialized state.
+ *
+ * @param xml XML representation of a Blockly workspace.
+ * @param workspace The workspace to load the serialized data onto.
+ */
+export function clearWorkspaceAndLoadFromXml(
+  xml: Element,
+  workspace: Blockly.WorkspaceSvg
+): string[] {
+  workspace.setResizesEnabled(false);
+  Blockly.Events.setGroup(true);
+  workspace.clear();
+
+  // Manually load variables to include the cloud and local properties that core
+  // Blockly is unaware of.
+  for (const variable of xml.querySelectorAll("variables variable")) {
+    const id = variable.getAttribute("id");
+    if (!id) continue;
+    const type = variable.getAttribute("type");
+    const name = variable.textContent;
+    const isLocal = variable.getAttribute("islocal") === "true";
+    const isCloud = variable.getAttribute("iscloud") === "true";
+
+    const variableModel = new ScratchVariableModel(
+      workspace,
+      name,
+      type,
+      id,
+      isLocal,
+      isCloud
+    );
+    Blockly.Events.fire(
+      new (Blockly.Events.get(Blockly.Events.VAR_CREATE))(variableModel)
+    );
+    workspace.getVariableMap().addVariable(variableModel);
+  }
+
+  // Remove the `variables` element from the XML to prevent Blockly from
+  // throwing or stomping on the variables we created.
+  xml.querySelector("variables").remove();
+
+  // Defer to core for the rest of the deserialization.
+  const blockIds = Blockly.Xml.domToWorkspace(xml, workspace);
+
+  workspace.setResizesEnabled(true);
+  return blockIds;
+}