Rename mrcValidate to mrcOnModuleCurrent because it is called when the module becomes the current module.

Author: lizlooney

src/blocks/mrc_call_python_function.ts

@@ -340,7 +340,7 @@ const CALL_PYTHON_FUNCTION = {
     this.mrcMechanismId = extraState.mechanismId ? extraState.mechanismId : '';
     this.mrcComponentClassName = extraState.componentClassName ? extraState.componentClassName : '';
     this.mrcMechanismClassName = extraState.mechanismClassName ? extraState.mechanismClassName : '';
-    // Initialize mrcMapComponentNameToId here. It will be filled during mrcValidate.
+    // Initialize mrcMapComponentNameToId here. It will be filled during checkFunction.
     this.mrcMapComponentNameToId = {};
     this.updateBlock_();
   },
@@ -426,7 +426,7 @@ const CALL_PYTHON_FUNCTION = {
                 .appendField('.');
           }
           // Here we create a text field for the component name.
-          // Later, in mrcValidate, we will replace it with a dropdown.
+          // Later, in checkFunction, we will replace it with a dropdown.
           titleInput
               .appendField(createFieldNonEditableText(''), FIELD_COMPONENT_NAME)
               .appendField('.')
@@ -586,18 +586,25 @@ const CALL_PYTHON_FUNCTION = {
     }
     return components;
   },
+
+  /**
+   * mrcOnModuleCurrent is called for each CallPythonFunctionBlock when the module becomes the current module.
+   */
+  mrcOnModuleCurrent: function(this: CallPythonFunctionBlock): void {
+    this.checkFunction();
+  },
   /**
    * mrcOnLoad is called for each CallPythonFunctionBlock when the blocks are loaded in the blockly
    * workspace.
    */
   mrcOnLoad: function(this: CallPythonFunctionBlock): void {
-    this.mrcValidate();
+    this.checkFunction();
   },
   /**
-   * mrcValidate checks the block, updates it, and/or adds a warning balloon if necessary.
-   * It is called from mrcOnLoad above and from Editor.makeCurrent.
+   * checkFunction checks the block, updates it, and/or adds a warning balloon if necessary.
+   * It is called from mrcOnModuleCurrent and mrcOnLoad above.
    */
-  mrcValidate: function(this: CallPythonFunctionBlock): void {
+  checkFunction: function(this: CallPythonFunctionBlock): void {
     const editor = Editor.getEditorForBlocklyWorkspace(this.workspace, true /* returnCurrentIfNotFound */);
     if (!editor) {
       return;

src/blocks/mrc_event_handler.ts

@@ -167,18 +167,24 @@ const EVENT_HANDLER = {
     });
   },
 
+  /**
+   * mrcOnModuleCurrent is called for each EventHandlerBlock when the module becomes the current module.
+   */
+  mrcOnModuleCurrent: function(this: EventHandlerBlock): void {
+    this.checkEvent();
+  },
   /**
    * mrcOnLoad is called for each EventHandlerBlock when the blocks are loaded in the blockly
    * workspace.
    */
   mrcOnLoad: function(this: EventHandlerBlock): void {
-    this.mrcValidate();
+    this.checkEvent();
   },
   /**
-   * mrcValidate checks the block, updates it, and/or adds a warning balloon if necessary.
-   * It is called from mrcOnLoad above and from Editor.makeCurrent.
+   * checkEvent checks the block, updates it, and/or adds a warning balloon if necessary.
+   * It is called from mrcOnModuleCurrent and mrcOnLoad above.
    */
-  mrcValidate: function(this: EventHandlerBlock): void {
+  checkEvent: function(this: EventHandlerBlock): void {
     const warnings: string[] = [];
 
     const editor = Editor.getEditorForBlocklyWorkspace(this.workspace, true /* returnCurrentIfNotFound */);

src/blocks/mrc_mechanism.ts

@@ -175,18 +175,24 @@ const MECHANISM = {
     };
   },
 
+  /**
+   * mrcOnModuleCurrent is called for each MechanismBlock when the module becomes the current module.
+   */
+  mrcOnModuleCurrent: function(this: MechanismBlock): void {
+    this.checkMechanism();
+  },
   /**
    * mrcOnLoad is called for each MechanismBlock when the blocks are loaded in the blockly
    * workspace.
    */
   mrcOnLoad: function(this: MechanismBlock): void {
-    this.mrcValidate();
+    this.checkMechanism();
   },
   /**
-   * mrcValidate checks the block, updates it, and/or adds a warning balloon if necessary.
-   * It is called from mrcOnLoad above and from Editor.makeCurrent.
+   * checkMechanism checks the block, updates it, and/or adds a warning balloon if necessary.
+   * It is called from mrcOnModuleCurrent and mrcOnLoad above.
    */
-  mrcValidate: function(this: MechanismBlock): void {
+  checkMechanism: function(this: MechanismBlock): void {
     const warnings: string[] = [];
 
     const editor = Editor.getEditorForBlocklyWorkspace(this.workspace, true /* returnCurrentIfNotFound */);

src/editor/editor.ts

@@ -41,7 +41,7 @@ const EMPTY_TOOLBOX: Blockly.utils.toolbox.ToolboxInfo = {
 const MRC_ON_LOAD = 'mrcOnLoad';
 const MRC_ON_MOVE = 'mrcOnMove';
 const MRC_ON_ANCESTOR_MOVE = 'mrcOnAncestorMove';
-const MRC_VALIDATE = 'mrcValidate';
+const MRC_ON_MODULE_CURRENT = 'mrcOnModuleCurrent';
 
 export class Editor {
   private static workspaceIdToEditor: { [workspaceId: string]: Editor } = {};
@@ -152,10 +152,10 @@ export class Editor {
     this.parseModules(project, modulePathToContentText);
     this.updateToolboxImpl();
 
-    // Go through all the blocks in the workspace and call their mrcValidate method.
+    // Go through all the blocks in the workspace and call their mrcOnModuleCurrent method.
     this.blocklyWorkspace.getAllBlocks().forEach(block => {
-      if (MRC_VALIDATE in block && typeof block[MRC_VALIDATE] === 'function') {
-        block[MRC_VALIDATE]();
+      if (MRC_ON_MODULE_CURRENT in block && typeof block[MRC_ON_MODULE_CURRENT] === 'function') {
+        block[MRC_ON_MODULE_CURRENT]();
       }
     });
   }