First step for "instances", acceptably working, but not finished.

Instances are to be used for Blocks that need to create an "instance" of something that can then be used for creating custom-made field dropdowns.

Updated with the stepper block, as it was using a similar concept, but now can be used by any blocks.

Still need to fix some bugs with the "unique naming" from flyout to the workspace. And cleanup the code, comment documentation, etc.

Author: carlosperate

blockly/blockly_uncompressed.js

@@ -7,15 +7,9 @@
  * @fileoverview Blocks for Arduino Stepper library.
  *     The Arduino Servo functions syntax can be found in the following URL:
  *     http://arduino.cc/en/Reference/Stepper
- *     Additional functions apart from the normal generators have been added to
- *     be able to generate the 'set' drop down menu with all current instances
- *     of the Stepper class:
- *         Blockly.Blocks.stepper.stepperInstances
- *         Blockly.Blocks.stepper.FieldStepperInstance
- *         Blockly.Blocks.stepper.stepperDropdownList
- *
- * TODO: Still need to had some kind of handler to refresh the "set" drop down
- *     menu values if an instance in a 'configure' block is renamed.
+ *     Note that this block uses the Blockly.FieldInstance instead of
+ *     Blockly.FieldDropdown which generates a unique instance per setup block
+ *     in the workspace.
  */
 'use strict';
 
@@ -39,8 +33,11 @@ Blockly.Blocks['stepper_config'] = {
     this.setColour(Blockly.Blocks.stepper.HUE);
     this.appendDummyInput()
         .appendField(Blockly.Msg.ARD_STEPPER_SETUP)
-        .appendField(new Blockly.Blocks.ComponentFieldVariable(
-        Blockly.Msg.ARD_STEPPER_DEFAULT_NAME, 'Stepper'), 'STEPPER_NAME')
+        .appendField(
+            new Blockly.FieldInstance('Stepper',
+                                      Blockly.Msg.ARD_STEPPER_DEFAULT_NAME,
+                                      true, true, false),
+            'STEPPER_NAME')
         .appendField(Blockly.Msg.ARD_STEPPER_MOTOR);
     this.appendDummyInput()
         .setAlign(Blockly.ALIGN_RIGHT)
@@ -60,43 +57,6 @@ Blockly.Blocks['stepper_config'] = {
         .appendField(Blockly.Msg.ARD_STEPPER_SPEED);
     this.setTooltip(Blockly.Msg.ARD_STEPPER_SETUP_TIP);
   },
-  /**
-   * Return the name of the component defined in this block
-   * @return {!<string>} The name of the component
-   * @this Blockly.Block
-   */
-  getComponentName: function() {
-    return 'Stepper';
-  },
-  /**
-   * Return all variables referenced by this block.
-   * @return {!Array.<string>} List of variable names.
-   * @this Blockly.Block
-   */
-  getVars: function() {
-    return [this.getFieldValue('STEPPER_NAME')];
-  },
-  /**
-   * Notification that a variable is renaming.
-   * If the name matches one of this block's variables, rename it.
-   * @param {string} oldName Previous name of variable.
-   * @param {string} newName Renamed variable.
-   * @this Blockly.Block
-   */
-  renameVar: function(oldName, newName) {
-    if (Blockly.Names.equals(oldName, this.getFieldValue('STEPPER_NAME'))) {
-      this.setFieldValue(newName, 'STEPPER_NAME');
-    }
-  },
-  /**
-   * Gets the variable type required.
-   * @param {!string} varName Name of the variable selected in this block to
-   *     check.
-   * @return {string} String to indicate the variable type.
-   */
-  getVarType: function(varName) {
-    return Blockly.Types.ARRAY;
-  },
   /**
    * Updates the content of the the pin related fields.
    * @this Blockly.Block
@@ -119,8 +79,11 @@ Blockly.Blocks['stepper_step'] = {
     this.setColour(Blockly.Blocks.stepper.HUE);
     this.appendDummyInput()
         .appendField(Blockly.Msg.ARD_STEPPER_STEP)
-        .appendField(new Blockly.Blocks.ComponentFieldVariable(
-        Blockly.Msg.ARD_STEPPER_DEFAULT_NAME, 'Stepper'), 'STEPPER_NAME')
+        .appendField(
+            new Blockly.FieldInstance('Stepper',
+                                      Blockly.Msg.ARD_STEPPER_DEFAULT_NAME,
+                                      false, true, false),
+            'STEPPER_NAME');
     this.appendValueInput('STEPPER_STEPS')
         .setCheck(Blockly.Types.NUMBER.checkList);
     this.appendDummyInput()
@@ -129,50 +92,23 @@ Blockly.Blocks['stepper_step'] = {
     this.setNextStatement(true);
     this.setTooltip(Blockly.Msg.ARD_STEPPER_STEP_TIP);
   },
-  /**
-   * Return all variables referenced by this block.
-   * @return {!Array.<string>} List of variable names.
-   * @this Blockly.Block
-   */
-  getVars: function() {
-    return [this.getFieldValue('STEPPER_NAME')];
-  },
-  /**
-   * Notification that a variable is renaming.
-   * If the name matches one of this block's variables, rename it.
-   * @param {string} oldName Previous name of variable.
-   * @param {string} newName Renamed variable.
-   * @this Blockly.Block
-   */
-  renameVar: function(oldName, newName) {
-    if (Blockly.Names.equals(oldName, this.getFieldValue('STEPPER_NAME'))) {
-      this.setFieldValue(newName, 'STEPPER_NAME');
-    }
-  },
-  /**
-   * Gets the variable type required.
-   * @param {!string} varName Name of the variable selected in this block to
-   *     check.
-   * @return {string} String to indicate the variable type.
-   */
-  getVarType: function(varName) {
-    return Blockly.Types.ARRAY;
-  },
   /**
    * Called whenever anything on the workspace changes.
-   * It checks the instances of stepper_config and attaches a warning to this
-   * block if not valid data is found.
+   * It checks/warns if the selected stepper instance has a config block.
    * @this Blockly.Block
    */
   onchange: function() {
-    if (!this.workspace) { return; }  // Block has been deleted.
+    if (!this.workspace) return;  // Block has been deleted.
 
-    var currentDropdown = this.getFieldValue('STEPPER_NAME');
-    if (Blockly.Blocks.ComponentFieldVariable.CheckSetupPresent(this.workspace, currentDropdown, 'Stepper')) {
+    var instanceName = this.getFieldValue('STEPPER_NAME')
+    if (Blockly.Instances.isInstancePresent(instanceName, 'Stepper', this)) {
       this.setWarningText(null);
     } else {
-      // Set a warning to select a valid stepper config
-      this.setWarningText(Blockly.Msg.ARD_COMPONENT_WARN1.replace('%1', Blockly.Msg.ARD_STEPPER_COMPONENT).replace('%1', Blockly.Msg.ARD_STEPPER_COMPONENT));
+      // Set a warning to select a valid stepper config block
+      this.setWarningText(
+        Blockly.Msg.ARD_COMPONENT_WARN1.replace(
+            '%1', Blockly.Msg.ARD_STEPPER_COMPONENT).replace(
+                '%2', instanceName));
     }
   }
 };