Change ids when copying a module (#201)

* Add methodId to extra state of mrc_class_method_def block.

* Add componentId to extra state of mrc_component block.

* Add eventId to extra state of mrc_event block.
Fixed indentation in onBlockChanged and getEvent methods.

* Add mechanismId to extra state of mrc_mechanism block.

* Rename blockId to methodId in Method.
Rename blockId to mechanismId in MechanismInRobot.
Rename blockId to componentId in Component.
Rename blockId to eventId in Event.

In parseModuleContentText rename blockId fields when parsing old text.

Add changeIds to change the ids stored in mechanisms, components, events, and methods of ModuleContent. Update blocks by calling mrcChangeIds on blocks that implement it.

* In mrc_call_python_function.ts:
Update comments that describe otherBlockId.
Change component.blockId to component.componentId.
Change robotMethod.blockId to robotMethod.methodId.
Change mechanismMethod.blockId to mechanismMethod.methodId.
Change mechanismInRobot.blockId to mechanismInRobot.mechanismId.
Change method.blockId to method.methodId.
Change event.blockId to event.eventId.
Change renameMethodCaller function parameter blockId to id.
Change getMethodCallers function parameter otherBlockId to id.
Change renameMethodCallers function parameter blockId to id.
Change mutateMethodCallers function parameter blockId to id.
Add mrcChangeIds to change mrcBlockId and mrcMechanismBlockId.

* In project.ts renameOrCopyModule function to change the ids in the copy.

* In mrc_event_handler.ts:
Update comments that describe otherBlockId.
Change robotEvent.blockId to robotEvent.eventId.
Change event.blockId to event.eventId.
Add mrcChangeIds to change mrcBlockId and mrcMechanismBlockId.

* Fixed errors.

* Updated mrc_event_handler.ts:
In EventHandlerMixin: Changed mrcOtherBlockId to mrcEventId and mrcMechanismBlockId to mrcMechanismId.
In EventHandlerExtraState: Changed otherBlockId to eventId and mechanismBlockId to mechanismId.

Updated mrc_call_python_function.ts:
In CallPythonFunctionMixin: Changed mrcOtherBlockId to multiple fields mrcMethodId, mrcComponentId, and mrcEventId. Changed mrcMechanismBlockId to mrcMechanismId.
In CallPythonFunctionExtraState: Changed otherBlockId to multiple fields methodId, componentId, and eventId. Changed mechanismBlockId to mechanismId.

* Removed ids from modules starter blocks.

* Added comment about handling when a mechansim, component, or event is removed from the holder.

* Moved code that register a custom toolbox categories into the function that returns the category.
Pass the editor to getToolboxJSON and other toolbox functions that need the editor or the blockly workspace or the current module type.

* Fixed ModuleContent.changeIds.

Author: lizlooney

src/blocks/mrc_call_python_function.ts

@@ -46,6 +46,7 @@ type Parameter = {
 
 export type ClassMethodDefBlock = Blockly.Block & ClassMethodDefMixin & Blockly.BlockSvg;
 interface ClassMethodDefMixin extends ClassMethodDefMixinType {
+    mrcMethodId: string,
     mrcCanChangeSignature: boolean,
     mrcCanBeCalledWithinClass: boolean,
     mrcCanBeCalledOutsideClass: boolean,
@@ -58,6 +59,10 @@ type ClassMethodDefMixinType = typeof CLASS_METHOD_DEF;
 
 /** Extra state for serialising call_python_* blocks. */
 type ClassMethodDefExtraState = {
+    /**
+     * The id that identifies this method definition.
+     */
+    methodId?: string,
     /**
      * Can change name and parameters and return type
      */
@@ -109,6 +114,7 @@ const CLASS_METHOD_DEF = {
     saveExtraState: function (
         this: ClassMethodDefBlock): ClassMethodDefExtraState {
         const extraState: ClassMethodDefExtraState = {
+            methodId: this.mrcMethodId,
             canChangeSignature: this.mrcCanChangeSignature,
             canBeCalledWithinClass: this.mrcCanBeCalledWithinClass,
             canBeCalledOutsideClass: this.mrcCanBeCalledOutsideClass,
@@ -134,6 +140,7 @@ const CLASS_METHOD_DEF = {
         this: ClassMethodDefBlock,
         extraState: ClassMethodDefExtraState
     ): void {
+        this.mrcMethodId = extraState.methodId ? extraState.methodId : this.id;
         this.mrcCanChangeSignature = extraState.canChangeSignature;
         this.mrcCanBeCalledWithinClass = extraState.canBeCalledWithinClass;
         this.mrcCanBeCalledOutsideClass = extraState.canBeCalledOutsideClass;
@@ -196,7 +203,7 @@ const CLASS_METHOD_DEF = {
         if (this.mrcCanBeCalledWithinClass) {
           const methodForWithin = this.getMethodForWithin();
           if (methodForWithin) {
-            mutateMethodCallers(this.workspace, this.id, methodForWithin);
+            mutateMethodCallers(this.workspace, this.mrcMethodId, methodForWithin);
           }
         }
     },
@@ -263,13 +270,13 @@ const CLASS_METHOD_DEF = {
         const oldName = nameField.getValue();
         if (oldName && oldName !== name && oldName !== legalName) {
             // Rename any callers.
-            renameMethodCallers(this.workspace, this.id, legalName);
+            renameMethodCallers(this.workspace, this.mrcMethodId, legalName);
         }
         return legalName;
     },
     getMethod: function (this: ClassMethodDefBlock): storageModuleContent.Method | null {
         const method: storageModuleContent.Method = {
-            blockId: this.id,
+            methodId: this.mrcMethodId,
             visibleName: this.getFieldValue(FIELD_METHOD_NAME),
             pythonName: this.mrcFuncName ? this.mrcFuncName : '',
             returnType: this.mrcReturnType,
@@ -307,6 +314,14 @@ const CLASS_METHOD_DEF = {
     getMethodName: function (this: ClassMethodDefBlock): string {
         return this.getFieldValue(FIELD_METHOD_NAME);
     },
+    /**
+     * mrcChangeIds is called when a module is copied so that the copy has different ids than the original.
+     */
+    mrcChangeIds: function (this: ClassMethodDefBlock, oldIdToNewId: { [oldId: string]: string }): void {
+        if (this.mrcMethodId in oldIdToNewId) {
+            this.mrcMethodId = oldIdToNewId[this.mrcMethodId];
+        }
+    },
 };
 
 /**

src/blocks/mrc_class_method_def.ts

@@ -49,6 +49,7 @@ type ConstructorArg = {
 };
 
 type ComponentExtraState = {
+  componentId?: string,
   importModule?: string,
   // If staticFunctionName is not present, generate the constructor.
   staticFunctionName?: string,
@@ -57,6 +58,7 @@ type ComponentExtraState = {
 
 export type ComponentBlock = Blockly.Block & ComponentMixin;
 interface ComponentMixin extends ComponentMixinType {
+  mrcComponentId: string,
   mrcArgs: ConstructorArg[],
   mrcImportModule: string,
   mrcStaticFunctionName: string,
@@ -84,6 +86,7 @@ const COMPONENT = {
     */
   saveExtraState: function (this: ComponentBlock): ComponentExtraState {
     const extraState: ComponentExtraState = {
+      componentId: this.mrcComponentId,
     };
     extraState.params = [];
     if (this.mrcArgs){
@@ -106,6 +109,7 @@ const COMPONENT = {
    * Applies the given state to this block.
    */
   loadExtraState: function (this: ComponentBlock, extraState: ComponentExtraState): void {
+    this.mrcComponentId = extraState.componentId ? extraState.componentId : this.id;
     this.mrcImportModule = extraState.importModule ? extraState.importModule : '';
     this.mrcStaticFunctionName = extraState.staticFunctionName ? extraState.staticFunctionName : '';
     this.mrcArgs = [];
@@ -146,7 +150,7 @@ const COMPONENT = {
     const oldName = nameField.getValue();
     if (oldName && oldName !== name && oldName !== legalName) {
       // Rename any callers.
-      renameMethodCallers(this.workspace, this.id, legalName);
+      renameMethodCallers(this.workspace, this.mrcComponentId, legalName);
     }
     return legalName;
   },
@@ -156,7 +160,7 @@ const COMPONENT = {
     const ports: {[port: string]: string} = {};
     this.getComponentPorts(ports);
     return {
-      blockId: this.id,
+      componentId: this.mrcComponentId,
       name: componentName,
       className: componentType,
       ports: ports,
@@ -172,7 +176,15 @@ const COMPONENT = {
       ports[argName] = this.mrcArgs[i].type;
     }
   },
-}
+  /**
+   * mrcChangeIds is called when a module is copied so that the copy has different ids than the original.
+   */
+  mrcChangeIds: function (this: ComponentBlock, oldIdToNewId: { [oldId: string]: string }): void {
+    if (this.mrcComponentId in oldIdToNewId) {
+      this.mrcComponentId = oldIdToNewId[this.mrcComponentId];
+    }
+  },
+};
 
 export const setup = function () {
   Blockly.Blocks[BLOCK_NAME] = COMPONENT;

src/blocks/mrc_component.ts

@@ -41,20 +41,22 @@ type Parameter = {
 };
 
 type EventExtraState = {
+  eventId?: string,
   params?: Parameter[],
 }
 
 export type EventBlock = Blockly.Block & EventMixin & Blockly.BlockSvg;
 
 interface EventMixin extends EventMixinType {
+  mrcEventId: string,
   mrcParameters: Parameter[],
 }
 type EventMixinType = typeof EVENT;
 
 const EVENT = {
   /**
-    * Block initialization.
-    */
+   * Block initialization.
+   */
   init: function (this: EventBlock): void {
     this.setStyle(MRC_STYLE_EVENTS);
     this.appendDummyInput("TITLE")
@@ -66,10 +68,11 @@ const EVENT = {
   },
 
   /**
-    * Returns the state of this block as a JSON serializable object.
-    */
+   * Returns the state of this block as a JSON serializable object.
+   */
   saveExtraState: function (this: EventBlock): EventExtraState {
     const extraState: EventExtraState = {
+      eventId: this.mrcEventId,
     };
     extraState.params = [];
     if (this.mrcParameters) {
@@ -83,9 +86,10 @@ const EVENT = {
     return extraState;
   },
   /**
-  * Applies the given state to this block.
-  */
+   * Applies the given state to this block.
+   */
   loadExtraState: function (this: EventBlock, extraState: EventExtraState): void {
+    this.mrcEventId = extraState.eventId ? extraState.eventId : this.id;
     this.mrcParameters = [];
 
     if (extraState.params) {
@@ -100,8 +104,8 @@ const EVENT = {
     this.updateBlock_();
   },
   /**
-     * Update the block to reflect the newly loaded extra state.
-     */
+   * Update the block to reflect the newly loaded extra state.
+   */
   updateBlock_: function (this: EventBlock): void {
     const name = this.getFieldValue(FIELD_EVENT_NAME);
     const input = this.getInput('TITLE');
@@ -136,7 +140,7 @@ const EVENT = {
         paramBlock.nextConnection && paramBlock.nextConnection.targetBlock();
     }
     this.mrcUpdateParams();
-    mutateMethodCallers(this.workspace, this.id, this.getEvent());
+    mutateMethodCallers(this.workspace, this.mrcEventId, this.getEvent());
   },
   decompose: function (this: EventBlock, workspace: Blockly.Workspace) {
     // This is a special sub-block that only gets created in the mutator UI.
@@ -189,42 +193,50 @@ const EVENT = {
     const oldName = nameField.getValue();
     if (oldName && oldName !== name && oldName !== legalName) {
       // Rename any callers.
-      renameMethodCallers(this.workspace, this.id, legalName);
+      renameMethodCallers(this.workspace, this.mrcEventId, legalName);
     }
     return legalName;
   },
   onBlockChanged(block: Blockly.BlockSvg, blockEvent: Blockly.Events.BlockBase): void {
-      const blockBlock = block as Blockly.Block;
+    const blockBlock = block as Blockly.Block;
 
-      if (blockEvent.type === Blockly.Events.BLOCK_MOVE) {
-        const parent = ChangeFramework.getParentOfType(block, MRC_MECHANISM_COMPONENT_HOLDER);
+    if (blockEvent.type === Blockly.Events.BLOCK_MOVE) {
+      const parent = ChangeFramework.getParentOfType(block, MRC_MECHANISM_COMPONENT_HOLDER);
 
-        if (parent) {
-              // If it is, we allow it to stay.
-              blockBlock.setWarningText(null);
-              return;
-            }
-        // If we end up here it shouldn't be allowed
-        block.unplug(true);
-        blockBlock.setWarningText('Events can only go in the events section of the robot or mechanism');
-        blockBlock.getIcon(Blockly.icons.IconType.WARNING)!.setBubbleVisible(true);
+      if (parent) {
+        // If it is, we allow it to stay.
+        blockBlock.setWarningText(null);
+        return;
       }
-    },
-    getEvent: function (this: EventBlock): storageModuleContent.Event {
-      const event: storageModuleContent.Event = {
-        blockId: this.id,
-        name: this.getFieldValue(FIELD_EVENT_NAME),
-        args: [],
-      };
-      this.mrcParameters.forEach(param => {
-        event.args.push({
-          name: param.name,
-          type: param.type ? param.type : '',
-        });
+      // If we end up here it shouldn't be allowed
+      block.unplug(true);
+      blockBlock.setWarningText('Events can only go in the events section of the robot or mechanism');
+      blockBlock.getIcon(Blockly.icons.IconType.WARNING)!.setBubbleVisible(true);
+    }
+  },
+  getEvent: function (this: EventBlock): storageModuleContent.Event {
+    const event: storageModuleContent.Event = {
+      eventId: this.mrcEventId,
+      name: this.getFieldValue(FIELD_EVENT_NAME),
+      args: [],
+    };
+    this.mrcParameters.forEach(param => {
+      event.args.push({
+        name: param.name,
+        type: param.type ? param.type : '',
       });
-      return event;
-    },
-}
+    });
+    return event;
+  },
+  /**
+   * mrcChangeIds is called when a module is copied so that the copy has different ids than the original.
+   */
+  mrcChangeIds: function (this: EventBlock, oldIdToNewId: { [oldId: string]: string }): void {
+    if (this.mrcEventId in oldIdToNewId) {
+      this.mrcEventId = oldIdToNewId[this.mrcEventId];
+    }
+  },
+};
 
 export const setup = function () {
   Blockly.Blocks[BLOCK_NAME] = EVENT;