Changed blocks to not assume they are BlockSvg (#337)

* Changed blocks (except the ones that are used in mutators) to not assume they are BlockSvg.

* Added comment.

Author: lizlooney

src/blocks/mrc_call_python_function.ts

@@ -70,7 +70,7 @@ type FunctionArg = {
 
 const WARNING_ID_FUNCTION_CHANGED = 'function changed';
 
-export type CallPythonFunctionBlock = Blockly.Block & CallPythonFunctionMixin & Blockly.BlockSvg;
+export type CallPythonFunctionBlock = Blockly.Block & CallPythonFunctionMixin;
 interface CallPythonFunctionMixin extends CallPythonFunctionMixinType {
   mrcFunctionKind: FunctionKind,
   mrcReturnType: string,
@@ -871,7 +871,9 @@ const CALL_PYTHON_FUNCTION = {
       if (icon) {
         icon.setBubbleVisible(true);
       }
-      this.bringToFront();
+      if (this.rendered) {
+        (this as unknown as Blockly.BlockSvg).bringToFront();
+      }
     } else {
       // Clear the existing warning on the block.
       this.setWarningText(null, WARNING_ID_FUNCTION_CHANGED);

src/blocks/mrc_class_method_def.ts

@@ -58,7 +58,7 @@ export interface Parameter {
   type?: string;
 }
 
-export type ClassMethodDefBlock = Blockly.Block & ClassMethodDefMixin & Blockly.BlockSvg;
+export type ClassMethodDefBlock = Blockly.Block & ClassMethodDefMixin;
 interface ClassMethodDefMixin extends ClassMethodDefMixinType {
   mrcMethodId: string,
   mrcCanChangeSignature: boolean,
@@ -182,12 +182,18 @@ const CLASS_METHOD_DEF = {
     if (this.mrcCanChangeSignature) {
       const nameField = new Blockly.FieldTextInput(name);
       input.insertFieldAt(0, nameField, FIELD_METHOD_NAME);
-      this.setMutator(paramContainer.getMutatorIcon(this));
+      if (this.rendered) {
+        this.setMutator(paramContainer.getMutatorIcon(this as unknown as Blockly.BlockSvg));
+      }
       nameField.setValidator(this.mrcNameFieldValidator.bind(this, nameField));
     } else {
       input.insertFieldAt(0, createFieldNonEditableText(name), FIELD_METHOD_NAME);
-      // Case because a current bug in blockly where it won't allow passing null to Blockly.Block.setMutator makes it necessary.
-      (this as Blockly.BlockSvg).setMutator(null);
+      // Block.setMutator is defined as setMutator(_mutator: MutatorIcon) and BlockSvg.setMutator
+      // is defined as setMutator(mutator: MutatorIcon | null).
+      // Therefore, to call setMutator(null), this must be casted to BlockSvg.
+      if (this.rendered) {
+        (this as unknown as Blockly.BlockSvg).setMutator(null);
+      }
     }
     this.mrcUpdateParams();
     this.mrcUpdateReturnInput();
@@ -231,7 +237,9 @@ const CLASS_METHOD_DEF = {
    * mrcOnMutatorOpen is called when the mutator on a ClassMethodDefBlock is opened.
    */
   mrcOnMutatorOpen: function(this: ClassMethodDefBlock): void {
-    paramContainer.onMutatorOpen(this);
+    if (this.rendered) {
+      paramContainer.onMutatorOpen(this as unknown as Blockly.BlockSvg);
+    }
   },
   mrcRenameParameter: function (this: ClassMethodDefBlock, oldName: string, newName: string) {
     const nextBlock = this.getInputTargetBlock(INPUT_STACK);

src/blocks/mrc_event.ts

@@ -50,7 +50,7 @@ type EventExtraState = {
   params?: Parameter[],
 }
 
-export type EventBlock = Blockly.Block & EventMixin & Blockly.BlockSvg;
+export type EventBlock = Blockly.Block & EventMixin;
 
 interface EventMixin extends EventMixinType {
   mrcEventId: string,
@@ -130,7 +130,9 @@ const EVENT = {
 
     const nameField = new Blockly.FieldTextInput(name);
     input.insertFieldAt(0, nameField, FIELD_EVENT_NAME);
-    this.setMutator(paramContainer.getMutatorIcon(this));
+    if (this.rendered) {
+      this.setMutator(paramContainer.getMutatorIcon(this as unknown as Blockly.BlockSvg));
+    }
     nameField.setValidator(this.mrcNameFieldValidator.bind(this, nameField));
 
     this.mrcUpdateParams();
@@ -225,7 +227,9 @@ const EVENT = {
    * mrcOnMutatorOpen is called when the mutator on an EventBlock is opened.
    */
   mrcOnMutatorOpen: function(this: EventBlock): void {
-    paramContainer.onMutatorOpen(this);
+    if (this.rendered) {
+      paramContainer.onMutatorOpen(this as unknown as Blockly.BlockSvg);
+    }
   },
   checkBlockIsInHolder: function(this: EventBlock): void {
     const rootBlock: Blockly.Block | null = this.getRootBlock();

src/blocks/mrc_event_handler.ts

@@ -51,7 +51,7 @@ export enum SenderType {
 const SENDER_VALUE_ROBOT = 'robot';
 const WARNING_ID_EVENT_CHANGED = 'event changed';
 
-export type EventHandlerBlock = Blockly.Block & EventHandlerMixin & Blockly.BlockSvg;
+export type EventHandlerBlock = Blockly.Block & EventHandlerMixin;
 
 interface EventHandlerMixin extends EventHandlerMixinType {
   mrcSenderType: SenderType;
@@ -292,7 +292,9 @@ const EVENT_HANDLER = {
       if (icon) {
         icon.setBubbleVisible(true);
       }
-      this.bringToFront();
+      if (this.rendered) {
+        (this as unknown as Blockly.BlockSvg).bringToFront();
+      }
     } else {
       // Clear the existing warning on the block.
       this.setWarningText(null, WARNING_ID_EVENT_CHANGED);

src/blocks/mrc_get_parameter.ts

@@ -39,7 +39,7 @@ const FIELD_PARAMETER_NAME = 'PARAMETER_NAME';
 const WARNING_ID_NOT_IN_METHOD = 'not in method';
 
 
-type GetParameterBlock = Blockly.Block & Blockly.BlockSvg & GetParameterMixin;
+type GetParameterBlock = Blockly.Block & GetParameterMixin;
 
 interface GetParameterMixin extends GetParameterMixinType {
   // TODO(lizlooney): currently mrcParameterType is never set to anything other than '' because

src/blocks/mrc_jump_to_step.ts

@@ -34,7 +34,7 @@ const FIELD_STEP_NAME = 'STEP_NAME';
 const WARNING_ID_NOT_IN_STEP = 'not in step';
 
 
-type JumpToStepBlock = Blockly.Block & Blockly.BlockSvg & JumpToStepMixin;
+type JumpToStepBlock = Blockly.Block & JumpToStepMixin;
 
 interface JumpToStepMixin extends JumpToStepMixinType {
   mrcHasWarning: boolean,

src/blocks/mrc_mechanism.ts

@@ -63,7 +63,7 @@ type MechanismExtraState = {
 const WARNING_ID_NOT_IN_HOLDER = 'not in holder';
 const WARNING_ID_MECHANISM_CHANGED = 'mechanism changed';
 
-export type MechanismBlock = Blockly.Block & MechanismMixin & Blockly.BlockSvg;
+export type MechanismBlock = Blockly.Block & MechanismMixin;
 interface MechanismMixin extends MechanismMixinType {
   mrcMechanismModuleId: string
   mrcMechanismId: string,
@@ -402,7 +402,9 @@ const MECHANISM = {
       if (icon) {
         icon.setBubbleVisible(true);
       }
-      this.bringToFront();
+      if (this.rendered) {
+        (this as unknown as Blockly.BlockSvg).bringToFront();
+      }
     } else {
       // Clear the existing warning on the block.
       this.setWarningText(null, WARNING_ID_MECHANISM_CHANGED);

src/blocks/mrc_steps.ts

@@ -46,7 +46,7 @@ type StepsExtraState = {
   stepNames: string[],
 };
 
-export type StepsBlock = Blockly.Block & StepsMixin & Blockly.BlockSvg;
+export type StepsBlock = Blockly.Block & StepsMixin;
 interface StepsMixin extends StepsMixinType {
   mrcStepNames: string[];
 }
@@ -62,7 +62,9 @@ const STEPS = {
       .appendField(Blockly.Msg.STEPS);
     this.setInputsInline(false);
     this.setStyle(MRC_STYLE_STEPS);
-    this.setMutator(stepContainer.getMutatorIcon(this));
+    if (this.rendered) {
+      this.setMutator(stepContainer.getMutatorIcon(this as unknown as Blockly.BlockSvg));
+    }
   },
   ...NONCOPYABLE_BLOCK,
   saveExtraState: function (this: StepsBlock): StepsExtraState {
@@ -155,7 +157,9 @@ const STEPS = {
    * mrcOnMutatorOpen is called when the mutator on an StepsBlock is opened.
    */
   mrcOnMutatorOpen: function (this: StepsBlock): void {
-    stepContainer.onMutatorOpen(this);
+    if (this.rendered) {
+      stepContainer.onMutatorOpen(this as unknown as Blockly.BlockSvg);
+    }
   },
   mrcUpdateStepName: function (this: StepsBlock, step: number, newName: string): string {
     const oldName = this.mrcStepNames[step];