Use makeLegalName to make names unique when mechanisms, components, and events are dragged into the holder.

Use makeLegalName to validate parameter names.

Author: lizlooney

src/blocks/mrc_mechanism_component_holder.ts

@@ -22,7 +22,7 @@
 import * as Blockly from 'blockly';
 
 import { MRC_STYLE_MECHANISMS } from '../themes/styles';
-import { getLegalName } from './utils/python';
+import { makeLegalName } from './utils/validator';
 import { Editor } from '../editor/editor';
 import { ExtendedPythonGenerator } from '../editor/extended_python_generator';
 import * as storageModule from '../storage/module';
@@ -220,14 +220,16 @@ const MECHANISM_COMPONENT_HOLDER = {
    */
   setNameOfChildBlock(this: MechanismComponentHolderBlock, child: Blockly.Block): void {
     const otherNames: string[] = []
-    const descendants = this.getDescendants(true);
-    descendants
+    this.getDescendants(true)
         .filter(descendant => descendant.id !== child.id)
         .forEach(descendant => {
           otherNames.push(descendant.getFieldValue('NAME'));
         });
     const currentName = child.getFieldValue('NAME');
-    const legalName = getLegalName(currentName, otherNames);
+    // mechanism and component names must be valid python identifiers.
+    // event names do not need to be valid python identifiers.
+    const mustBeValidPythonIdentifier = (child.type === MRC_MECHANISM_NAME || child.type === MRC_COMPONENT_NAME);
+    const legalName = makeLegalName(currentName, otherNames, mustBeValidPythonIdentifier);
     if (legalName !== currentName) {
       child.setFieldValue(legalName, 'NAME');
     }

src/blocks/mrc_param_container.ts

@@ -21,7 +21,7 @@
  */
 import * as Blockly from 'blockly';
 import { MRC_STYLE_CLASS_BLOCKS } from '../themes/styles';
-import { getLegalName } from './utils/python';
+import { makeLegalName } from './utils/validator';
 
 export const PARAM_CONTAINER_BLOCK_NAME = 'mrc_param_container';
 const PARAM_ITEM_BLOCK_NAME = 'mrc_param_item';
@@ -85,13 +85,16 @@ const PARAM_ITEM = {
     const rootBlock: Blockly.Block | null = this.getRootBlock();
     if (rootBlock) {
       const otherNames: string[] = []
-      rootBlock!.getDescendants(true)?.forEach(itemBlock => {
-        if (itemBlock != this) {
-          otherNames.push(itemBlock.getFieldValue(FIELD_NAME));
-        }
-      });
+      rootBlock.getDescendants(true)
+          .filter(descendant => descendant.type === PARAM_ITEM_BLOCK_NAME && descendant !== this)
+          .forEach(itemBlock => {
+            if (itemBlock != this) {
+              otherNames.push(itemBlock.getFieldValue(FIELD_NAME));
+            }
+          });
       const currentName = this.getFieldValue(FIELD_NAME);
-      this.setFieldValue(getLegalName(currentName, otherNames), FIELD_NAME);
+      const legalName = makeLegalName(currentName, otherNames, /* mustBeValidPythonIdentifier */ true);
+      this.setFieldValue(legalName, FIELD_NAME);
       updateMutatorFlyout(this.workspace);
     }
   },

src/blocks/utils/python.ts

@@ -281,30 +281,6 @@ export function getOutputCheck(type: string): string {
   return type;
 }
 
-// Function to return a legal name based off of proposed names and making sure it doesn't conflict
-// This is a legal name for python methods and variables. 
-export function getLegalName(proposedName: string, existingNames: string[]){
-  let newName = proposedName.trim().replace(' ', '_');
-
-  // TODO: Allow the user to put numbers in the name.
-  
-  if (!/^[A-Za-z_]/.test(newName)){
-      newName = "_" + newName;
-  }
-      
-  while (existingNames.includes(newName)){
-      const match = /(.*?)(\d+)$/.exec(newName)
-
-      if (match) {
-          let lastNumber  = +match[2]
-          newName = match[1] + (lastNumber + 1)
-      } else {
-          newName += "2"
-      }
-  }
-  return newName;
-}
-
 export function isExistingPythonModule(moduleName: string): boolean {
   for (const pythonData of allPythonData) {
     // Process modules.