blockly 7.20211209.2 → 8.0.0

package/core/variable_model.js

@@ -26,70 +26,71 @@ goog.require('Blockly.Events.VarCreate');
 /**
  * Class for a variable model.
  * Holds information for the variable including name, ID, and type.
- * @param {!Workspace} workspace The variable's workspace.
- * @param {string} name The name of the variable.  This is the user-visible name
- *     (e.g. 'my var' or '私の変数'), not the generated name.
- * @param {string=} opt_type The type of the variable like 'int' or 'string'.
- *     Does not need to be unique. Field_variable can filter variables based on
- *     their type. This will default to '' which is a specific type.
- * @param {string=} opt_id The unique ID of the variable. This will default to
- *     a UUID.
  * @see {Blockly.FieldVariable}
- * @constructor
  * @alias Blockly.VariableModel
  */
-const VariableModel = function(workspace, name, opt_type, opt_id) {
+class VariableModel {
   /**
-   * The workspace the variable is in.
-   * @type {!Workspace}
+   * @param {!Workspace} workspace The variable's workspace.
+   * @param {string} name The name of the variable.  This is the user-visible
+   *     name (e.g. 'my var' or '私の変数'), not the generated name.
+   * @param {string=} opt_type The type of the variable like 'int' or 'string'.
+   *     Does not need to be unique. Field_variable can filter variables based
+   * on their type. This will default to '' which is a specific type.
+   * @param {string=} opt_id The unique ID of the variable. This will default to
+   *     a UUID.
    */
-  this.workspace = workspace;
+  constructor(workspace, name, opt_type, opt_id) {
+    /**
+     * The workspace the variable is in.
+     * @type {!Workspace}
+     */
+    this.workspace = workspace;
 
-  /**
-   * The name of the variable, typically defined by the user.  It may be
-   * changed by the user.
-   * @type {string}
-   */
-  this.name = name;
+    /**
+     * The name of the variable, typically defined by the user.  It may be
+     * changed by the user.
+     * @type {string}
+     */
+    this.name = name;
+
+    /**
+     * The type of the variable, such as 'int' or 'sound_effect'. This may be
+     * used to build a list of variables of a specific type. By default this is
+     * the empty string '', which is a specific type.
+     * @see {Blockly.FieldVariable}
+     * @type {string}
+     */
+    this.type = opt_type || '';
 
+    /**
+     * A unique ID for the variable. This should be defined at creation and
+     * not change, even if the name changes. In most cases this should be a
+     * UUID.
+     * @type {string}
+     * @private
+     */
+    this.id_ = opt_id || idGenerator.genUid();
+
+    eventUtils.fire(new (eventUtils.get(eventUtils.VAR_CREATE))(this));
+  }
   /**
-   * The type of the variable, such as 'int' or 'sound_effect'. This may be
-   * used to build a list of variables of a specific type. By default this is
-   * the empty string '', which is a specific type.
-   * @see {Blockly.FieldVariable}
-   * @type {string}
+   * @return {string} The ID for the variable.
    */
-  this.type = opt_type || '';
-
+  getId() {
+    return this.id_;
+  }
   /**
-   * A unique ID for the variable. This should be defined at creation and
-   * not change, even if the name changes. In most cases this should be a
-   * UUID.
-   * @type {string}
-   * @private
+   * A custom compare function for the VariableModel objects.
+   * @param {VariableModel} var1 First variable to compare.
+   * @param {VariableModel} var2 Second variable to compare.
+   * @return {number} -1 if name of var1 is less than name of var2, 0 if equal,
+   *     and 1 if greater.
+   * @package
    */
-  this.id_ = opt_id || idGenerator.genUid();
-
-  eventUtils.fire(new (eventUtils.get(eventUtils.VAR_CREATE))(this));
-};
-
-/**
- * @return {string} The ID for the variable.
- */
-VariableModel.prototype.getId = function() {
-  return this.id_;
-};
-
-/**
- * A custom compare function for the VariableModel objects.
- * @param {VariableModel} var1 First variable to compare.
- * @param {VariableModel} var2 Second variable to compare.
- * @return {number} -1 if name of var1 is less than name of var2, 0 if equal,
- *     and 1 if greater.
- * @package
- */
-VariableModel.compareByName = function(var1, var2) {
-  return var1.name.localeCompare(var2.name, undefined, {sensitivity: 'base'});
-};
+  static compareByName(var1, var2) {
+    return var1.name.localeCompare(var2.name, undefined, {sensitivity: 'base'});
+  }
+}
 
 exports.VariableModel = VariableModel;

package/core/variables.js

@@ -23,6 +23,8 @@ const {Msg} = goog.require('Blockly.Msg');
 const {VariableModel} = goog.require('Blockly.VariableModel');
 /* eslint-disable-next-line no-unused-vars */
 const {Workspace} = goog.requireType('Blockly.Workspace');
+/* eslint-disable-next-line no-unused-vars */
+const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
 
 /**
  * String for use in the "custom" attribute of a category in toolbox XML.
@@ -118,7 +120,7 @@ exports.allDeveloperVariables = allDeveloperVariables;
 /**
  * Construct the elements (blocks and button) required by the flyout for the
  * variable category.
- * @param {!Workspace} workspace The workspace containing variables.
+ * @param {!WorkspaceSvg} workspace The workspace containing variables.
  * @return {!Array<!Element>} Array of XML elements.
  * @alias Blockly.Variables.flyoutCategory
  */
@@ -526,7 +528,12 @@ const createVariable = function(workspace, id, opt_name, opt_type) {
   const potentialVariableMap = workspace.getPotentialVariableMap();
   // Variables without names get uniquely named for this workspace.
   if (!opt_name) {
-    const ws = workspace.isFlyout ? workspace.targetWorkspace : workspace;
+    const ws =
+        /** @type {!Workspace} */ (
+            workspace.isFlyout ?
+                /** @type {!WorkspaceSvg} */ (workspace).targetWorkspace :
+                workspace);
+    // Must call version on exports to allow for mocking in tests. See #5321
     opt_name = exports.generateUniqueName(ws);
   }
 

package/core/variables_dynamic.js

@@ -24,6 +24,8 @@ const {Msg} = goog.require('Blockly.Msg');
 const {VariableModel} = goog.require('Blockly.VariableModel');
 /* eslint-disable-next-line no-unused-vars */
 const {Workspace} = goog.requireType('Blockly.Workspace');
+/* eslint-disable-next-line no-unused-vars */
+const {WorkspaceSvg} = goog.requireType('Blockly.WorkspaceSvg');
 
 
 /**
@@ -59,7 +61,7 @@ exports.onCreateVariableButtonClick_Colour = colourButtonClickHandler;
 /**
  * Construct the elements (blocks and button) required by the flyout for the
  * variable category.
- * @param {!Workspace} workspace The workspace containing variables.
+ * @param {!WorkspaceSvg} workspace The workspace containing variables.
  * @return {!Array<!Element>} Array of XML elements.
  * @alias Blockly.VariablesDynamic.flyoutCategory
  */

package/core/warning.js

@@ -17,11 +17,8 @@ goog.module('Blockly.Warning');
 
 const dom = goog.require('Blockly.utils.dom');
 const eventUtils = goog.require('Blockly.Events.utils');
-const object = goog.require('Blockly.utils.object');
 /* eslint-disable-next-line no-unused-vars */
 const {BlockSvg} = goog.requireType('Blockly.BlockSvg');
-/* eslint-disable-next-line no-unused-vars */
-const {Block} = goog.requireType('Blockly.Block');
 const {Bubble} = goog.require('Blockly.Bubble');
 /* eslint-disable-next-line no-unused-vars */
 const {Coordinate} = goog.requireType('Blockly.utils.Coordinate');
@@ -33,137 +30,146 @@ goog.require('Blockly.Events.BubbleOpen');
 
 /**
  * Class for a warning.
- * @param {!Block} block The block associated with this warning.
  * @extends {Icon}
- * @constructor
  * @alias Blockly.Warning
  */
-const Warning = function(block) {
-  Warning.superClass_.constructor.call(this, block);
-  this.createIcon();
-  // The text_ object can contain multiple warnings.
-  this.text_ = Object.create(null);
-};
-object.inherits(Warning, Icon);
-
-/**
- * Does this icon get hidden when the block is collapsed.
- */
-Warning.prototype.collapseHidden = false;
+class Warning extends Icon {
+  /**
+   * @param {!BlockSvg} block The block associated with this warning.
+   */
+  constructor(block) {
+    super(block);
+    this.createIcon();
+    // The text_ object can contain multiple warnings.
+    this.text_ = Object.create(null);
 
-/**
- * Draw the warning icon.
- * @param {!Element} group The icon group.
- * @protected
- */
-Warning.prototype.drawIcon_ = function(group) {
-  // Triangle with rounded corners.
-  dom.createSvgElement(
-      Svg.PATH, {
-        'class': 'blocklyIconShape',
-        'd': 'M2,15Q-1,15 0.5,12L6.5,1.7Q8,-1 9.5,1.7L15.5,12Q17,15 14,15z',
-      },
-      group);
-  // Can't use a real '!' text character since different browsers and operating
-  // systems render it differently.
-  // Body of exclamation point.
-  dom.createSvgElement(
-      Svg.PATH, {
-        'class': 'blocklyIconSymbol',
-        'd': 'm7,4.8v3.16l0.27,2.27h1.46l0.27,-2.27v-3.16z',
-      },
-      group);
-  // Dot of exclamation point.
-  dom.createSvgElement(
-      Svg.RECT, {
-        'class': 'blocklyIconSymbol',
-        'x': '7',
-        'y': '11',
-        'height': '2',
-        'width': '2',
-      },
-      group);
-};
+    /**
+     * The top-level node of the warning text, or null if not created.
+     * @type {?SVGTextElement}
+     * @private
+     */
+    this.paragraphElement_ = null;
 
-/**
- * Show or hide the warning bubble.
- * @param {boolean} visible True if the bubble should be visible.
- */
-Warning.prototype.setVisible = function(visible) {
-  if (visible === this.isVisible()) {
-    return;
-  }
-  eventUtils.fire(new (eventUtils.get(eventUtils.BUBBLE_OPEN))(
-      this.block_, visible, 'warning'));
-  if (visible) {
-    this.createBubble_();
-  } else {
-    this.disposeBubble_();
+    /**
+     * Does this icon get hidden when the block is collapsed?
+     * @type {boolean}
+     */
+    this.collapseHidden = false;
   }
-};
 
-/**
- * Show the bubble.
- * @private
- */
-Warning.prototype.createBubble_ = function() {
-  this.paragraphElement_ = Bubble.textToDom(this.getText());
-  this.bubble_ = Bubble.createNonEditableBubble(
-      this.paragraphElement_, /** @type {!BlockSvg} */ (this.block_),
-      /** @type {!Coordinate} */ (this.iconXY_));
-  this.applyColour();
-};
+  /**
+   * Draw the warning icon.
+   * @param {!Element} group The icon group.
+   * @protected
+   */
+  drawIcon_(group) {
+    // Triangle with rounded corners.
+    dom.createSvgElement(
+        Svg.PATH, {
+          'class': 'blocklyIconShape',
+          'd': 'M2,15Q-1,15 0.5,12L6.5,1.7Q8,-1 9.5,1.7L15.5,12Q17,15 14,15z',
+        },
+        group);
+    // Can't use a real '!' text character since different browsers and
+    // operating systems render it differently. Body of exclamation point.
+    dom.createSvgElement(
+        Svg.PATH, {
+          'class': 'blocklyIconSymbol',
+          'd': 'm7,4.8v3.16l0.27,2.27h1.46l0.27,-2.27v-3.16z',
+        },
+        group);
+    // Dot of exclamation point.
+    dom.createSvgElement(
+        Svg.RECT, {
+          'class': 'blocklyIconSymbol',
+          'x': '7',
+          'y': '11',
+          'height': '2',
+          'width': '2',
+        },
+        group);
+  }
 
-/**
- * Dispose of the bubble and references to it.
- * @private
- */
-Warning.prototype.disposeBubble_ = function() {
-  this.bubble_.dispose();
-  this.bubble_ = null;
-  this.paragraphElement_ = null;
-};
+  /**
+   * Show or hide the warning bubble.
+   * @param {boolean} visible True if the bubble should be visible.
+   */
+  setVisible(visible) {
+    if (visible === this.isVisible()) {
+      return;
+    }
+    eventUtils.fire(new (eventUtils.get(eventUtils.BUBBLE_OPEN))(
+        this.block_, visible, 'warning'));
+    if (visible) {
+      this.createBubble_();
+    } else {
+      this.disposeBubble_();
+    }
+  }
 
-/**
- * Set this warning's text.
- * @param {string} text Warning text (or '' to delete). This supports
- *    linebreaks.
- * @param {string} id An ID for this text entry to be able to maintain
- *     multiple warnings.
- */
-Warning.prototype.setText = function(text, id) {
-  if (this.text_[id] === text) {
-    return;
+  /**
+   * Show the bubble.
+   * @private
+   */
+  createBubble_() {
+    this.paragraphElement_ = Bubble.textToDom(this.getText());
+    this.bubble_ = Bubble.createNonEditableBubble(
+        this.paragraphElement_, /** @type {!BlockSvg} */ (this.block_),
+        /** @type {!Coordinate} */ (this.iconXY_));
+    this.applyColour();
   }
-  if (text) {
-    this.text_[id] = text;
-  } else {
-    delete this.text_[id];
+
+  /**
+   * Dispose of the bubble and references to it.
+   * @private
+   */
+  disposeBubble_() {
+    this.bubble_.dispose();
+    this.bubble_ = null;
+    this.paragraphElement_ = null;
   }
-  if (this.isVisible()) {
-    this.setVisible(false);
-    this.setVisible(true);
+
+  /**
+   * Set this warning's text.
+   * @param {string} text Warning text (or '' to delete). This supports
+   *    linebreaks.
+   * @param {string} id An ID for this text entry to be able to maintain
+   *     multiple warnings.
+   */
+  setText(text, id) {
+    if (this.text_[id] === text) {
+      return;
+    }
+    if (text) {
+      this.text_[id] = text;
+    } else {
+      delete this.text_[id];
+    }
+    if (this.isVisible()) {
+      this.setVisible(false);
+      this.setVisible(true);
+    }
   }
-};
 
-/**
- * Get this warning's texts.
- * @return {string} All texts concatenated into one string.
- */
-Warning.prototype.getText = function() {
-  const allWarnings = [];
-  for (const id in this.text_) {
-    allWarnings.push(this.text_[id]);
+  /**
+   * Get this warning's texts.
+   * @return {string} All texts concatenated into one string.
+   */
+  getText() {
+    const allWarnings = [];
+    for (const id in this.text_) {
+      allWarnings.push(this.text_[id]);
+    }
+    return allWarnings.join('\n');
   }
-  return allWarnings.join('\n');
-};
 
-/**
- * Dispose of this warning.
- */
-Warning.prototype.dispose = function() {
-  this.block_.warning = null;
-  Icon.prototype.dispose.call(this);
-};
+  /**
+   * Dispose of this warning.
+   */
+  dispose() {
+    this.block_.warning = null;
+    Icon.prototype.dispose.call(this);
+  }
+}
 
 exports.Warning = Warning;

package/core/widgetdiv.js

@@ -56,13 +56,13 @@ let themeClassName = '';
 
 /**
  * The HTML container for popup overlays (e.g. editor widgets).
- * @type {?Element}
+ * @type {?HTMLDivElement}
  */
 let DIV;
 
 /**
  * Returns the HTML container for editor widgets.
- * @return {?Element} The editor widget container.
+ * @return {?HTMLDivElement} The editor widget container.
  * @alias Blockly.WidgetDiv.getDiv
  */
 const getDiv = function() {
@@ -72,7 +72,7 @@ exports.getDiv = getDiv;
 
 /**
  * Allows unit tests to reset the div.
- * @param {?Element} newDiv The new value for the DIV field.
+ * @param {?HTMLDivElement} newDiv The new value for the DIV field.
  * @alias Blockly.WidgetDiv.testOnly_setDiv
  * @ignore
  */
@@ -109,7 +109,7 @@ const createDom = function() {
     return;  // Already created.
   }
 
-  DIV = document.createElement('div');
+  DIV = /** @type {!HTMLDivElement} */ (document.createElement('div'));
   DIV.className = 'blocklyWidgetDiv';
   const container = common.getParentContainer() || document.body;
   container.appendChild(DIV);