blockly 7.20211209.2 → 8.0.0

package/blocks/blocks.js

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright 2021 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview All the blocks.  (Entry point for blocks_compressed.js.)
+ * @suppress {extraRequire}
+ */
+'use strict';
+
+goog.module('Blockly.libraryBlocks');
+goog.module.declareLegacyNamespace();
+
+const colour = goog.require('Blockly.libraryBlocks.colour');
+const lists = goog.require('Blockly.libraryBlocks.lists');
+const logic = goog.require('Blockly.libraryBlocks.logic');
+const loops = goog.require('Blockly.libraryBlocks.loops');
+const math = goog.require('Blockly.libraryBlocks.math');
+const procedures = goog.require('Blockly.libraryBlocks.procedures');
+const texts = goog.require('Blockly.libraryBlocks.texts');
+const variables = goog.require('Blockly.libraryBlocks.variables');
+const variablesDynamic = goog.require('Blockly.libraryBlocks.variablesDynamic');
+/* eslint-disable-next-line no-unused-vars */
+const {BlockDefinition} = goog.requireType('Blockly.blocks');
+
+
+exports.colour = colour;
+exports.lists = lists;
+exports.logic = logic;
+exports.loops = loops;
+exports.math = math;
+exports.procedures = procedures;
+exports.texts = texts;
+exports.variables = variables;
+exports.variablesDynamic = variablesDynamic;
+
+/**
+ * A dictionary of the block definitions provided by all the
+ * Blockly.libraryBlocks.* modules.
+ * @type {!Object<string, !BlockDefinition>}
+ */
+const blocks = Object.assign(
+    {}, colour.blocks, lists.blocks, logic.blocks, loops.blocks, math.blocks,
+    procedures.blocks, variables.blocks, variablesDynamic.blocks);
+exports.blocks = blocks;

package/blocks/colour.js

@@ -9,14 +9,20 @@
  */
 'use strict';
 
-goog.module('Blockly.blocks.colour');
+goog.module('Blockly.libraryBlocks.colour');
 
-const {defineBlocksWithJsonArray} = goog.require('Blockly.common');
+/* eslint-disable-next-line no-unused-vars */
+const {BlockDefinition} = goog.requireType('Blockly.blocks');
+const {createBlockDefinitionsFromJsonArray, defineBlocks} = goog.require('Blockly.common');
 /** @suppress {extraRequire} */
 goog.require('Blockly.FieldColour');
 
 
-defineBlocksWithJsonArray([
+/**
+ * A dictionary of the block definitions provided by this module.
+ * @type {!Object<string, !BlockDefinition>}
+ */
+const blocks = createBlockDefinitionsFromJsonArray([
   // Block for colour picker.
   {
     'type': 'colour_picker',
@@ -107,3 +113,7 @@ defineBlocksWithJsonArray([
     'tooltip': '%{BKY_COLOUR_BLEND_TOOLTIP}',
   },
 ]);
+exports.blocks = blocks;
+
+// Register provided blocks.
+defineBlocks(blocks);

package/blocks/lists.js

@@ -10,25 +10,30 @@
  */
 'use strict';
 
-goog.module('Blockly.blocks.lists');
+goog.module('Blockly.libraryBlocks.lists');
 
 const xmlUtils = goog.require('Blockly.utils.xml');
 const {Align} = goog.require('Blockly.Input');
 /* eslint-disable-next-line no-unused-vars */
 const {Block} = goog.requireType('Blockly.Block');
-const {Blocks} = goog.require('Blockly.blocks');
+/* eslint-disable-next-line no-unused-vars */
+const {BlockDefinition} = goog.requireType('Blockly.blocks');
 const {ConnectionType} = goog.require('Blockly.ConnectionType');
 const {FieldDropdown} = goog.require('Blockly.FieldDropdown');
 const {Msg} = goog.require('Blockly.Msg');
 const {Mutator} = goog.require('Blockly.Mutator');
 /* eslint-disable-next-line no-unused-vars */
 const {Workspace} = goog.requireType('Blockly.Workspace');
-const {defineBlocksWithJsonArray} = goog.require('Blockly.common');
+const {createBlockDefinitionsFromJsonArray, defineBlocks} = goog.require('Blockly.common');
 /** @suppress {extraRequire} */
 goog.require('Blockly.FieldDropdown');
 
 
-defineBlocksWithJsonArray([
+/**
+ * A dictionary of the block definitions provided by this module.
+ * @type {!Object<string, !BlockDefinition>}
+ */
+const blocks = createBlockDefinitionsFromJsonArray([
   // Block for creating an empty list
   // The 'list_create_with' block is preferred as it is more flexible.
   // <block type="lists_create_with">
@@ -112,8 +117,9 @@ defineBlocksWithJsonArray([
     'helpUrl': '%{BKY_LISTS_LENGTH_HELPURL}',
   },
 ]);
+exports.blocks = blocks;
 
-Blocks['lists_create_with'] = {
+blocks['lists_create_with'] = {
   /**
    * Block for creating a list with any number of elements of any type.
    * @this {Block}
@@ -255,7 +261,7 @@ Blocks['lists_create_with'] = {
   },
 };
 
-Blocks['lists_create_with_container'] = {
+blocks['lists_create_with_container'] = {
   /**
    * Mutator block for list container.
    * @this {Block}
@@ -270,7 +276,7 @@ Blocks['lists_create_with_container'] = {
   },
 };
 
-Blocks['lists_create_with_item'] = {
+blocks['lists_create_with_item'] = {
   /**
    * Mutator block for adding items.
    * @this {Block}
@@ -285,7 +291,7 @@ Blocks['lists_create_with_item'] = {
   },
 };
 
-Blocks['lists_indexOf'] = {
+blocks['lists_indexOf'] = {
   /**
    * Block for finding an item in the list.
    * @this {Block}
@@ -312,7 +318,7 @@ Blocks['lists_indexOf'] = {
   },
 };
 
-Blocks['lists_getIndex'] = {
+blocks['lists_getIndex'] = {
   /**
    * Block for getting element at index.
    * @this {Block}
@@ -516,7 +522,7 @@ Blocks['lists_getIndex'] = {
   },
 };
 
-Blocks['lists_setIndex'] = {
+blocks['lists_setIndex'] = {
   /**
    * Block for setting the element at index.
    * @this {Block}
@@ -668,7 +674,7 @@ Blocks['lists_setIndex'] = {
   },
 };
 
-Blocks['lists_getSublist'] = {
+blocks['lists_getSublist'] = {
   /**
    * Block for getting sublist.
    * @this {Block}
@@ -786,7 +792,7 @@ Blocks['lists_getSublist'] = {
   },
 };
 
-Blocks['lists_sort'] = {
+blocks['lists_sort'] = {
   /**
    * Block for sorting a list.
    * @this {Block}
@@ -826,7 +832,7 @@ Blocks['lists_sort'] = {
   },
 };
 
-Blocks['lists_split'] = {
+blocks['lists_split'] = {
   /**
    * Block for splitting text into a list, or joining a list into text.
    * @this {Block}
@@ -913,3 +919,6 @@ Blocks['lists_split'] = {
   // dropdown values.
   // XML hooks are kept for backwards compatibility.
 };
+
+// Register provided blocks.
+defineBlocks(blocks);

package/blocks/logic.js

@@ -10,7 +10,7 @@
  */
 'use strict';
 
-goog.module('Blockly.blocks.logic');
+goog.module('Blockly.libraryBlocks.logic');
 
 /* eslint-disable-next-line no-unused-vars */
 const AbstractEvent = goog.requireType('Blockly.Events.Abstract');
@@ -19,20 +19,26 @@ const Extensions = goog.require('Blockly.Extensions');
 const xmlUtils = goog.require('Blockly.utils.xml');
 /* eslint-disable-next-line no-unused-vars */
 const {Block} = goog.requireType('Blockly.Block');
+/* eslint-disable-next-line no-unused-vars */
+const {BlockDefinition} = goog.requireType('Blockly.blocks');
 const {Msg} = goog.require('Blockly.Msg');
 const {Mutator} = goog.require('Blockly.Mutator');
 /* eslint-disable-next-line no-unused-vars */
 const {RenderedConnection} = goog.requireType('Blockly.RenderedConnection');
 /* eslint-disable-next-line no-unused-vars */
 const {Workspace} = goog.requireType('Blockly.Workspace');
-const {defineBlocksWithJsonArray} = goog.require('Blockly.common');
+const {createBlockDefinitionsFromJsonArray, defineBlocks} = goog.require('Blockly.common');
 /** @suppress {extraRequire} */
 goog.require('Blockly.FieldDropdown');
 /** @suppress {extraRequire} */
 goog.require('Blockly.FieldLabel');
 
 
-defineBlocksWithJsonArray([
+/**
+ * A dictionary of the block definitions provided by this module.
+ * @type {!Object<string, !BlockDefinition>}
+ */
+const blocks = createBlockDefinitionsFromJsonArray([
   // Block for boolean data type: true and false.
   {
     'type': 'logic_boolean',
@@ -258,6 +264,7 @@ defineBlocksWithJsonArray([
     'tooltip': '%{BKY_CONTROLS_IF_ELSE_TOOLTIP}',
   },
 ]);
+exports.blocks = blocks;
 
 /**
  * Tooltip text, keyed by block OP value. Used by logic_compare and
@@ -645,3 +652,6 @@ const LOGIC_TERNARY_ONCHANGE_MIXIN = {
 };
 
 Extensions.registerMixin('logic_ternary', LOGIC_TERNARY_ONCHANGE_MIXIN);
+
+// Register provided blocks.
+defineBlocks(blocks);

package/blocks/loops.js

@@ -10,7 +10,7 @@
  */
 'use strict';
 
-goog.module('Blockly.blocks.loops');
+goog.module('Blockly.libraryBlocks.loops');
 
 /* eslint-disable-next-line no-unused-vars */
 const AbstractEvent = goog.requireType('Blockly.Events.Abstract');
@@ -18,11 +18,13 @@ const ContextMenu = goog.require('Blockly.ContextMenu');
 const Events = goog.require('Blockly.Events');
 const Extensions = goog.require('Blockly.Extensions');
 const Variables = goog.require('Blockly.Variables');
-const common = goog.require('Blockly.common');
 const xmlUtils = goog.require('Blockly.utils.xml');
 /* eslint-disable-next-line no-unused-vars */
 const {Block} = goog.requireType('Blockly.Block');
+/* eslint-disable-next-line no-unused-vars */
+const {BlockDefinition} = goog.requireType('Blockly.blocks');
 const {Msg} = goog.require('Blockly.Msg');
+const {createBlockDefinitionsFromJsonArray, defineBlocks} = goog.require('Blockly.common');
 /** @suppress {extraRequire} */
 goog.require('Blockly.FieldDropdown');
 /** @suppress {extraRequire} */
@@ -35,7 +37,11 @@ goog.require('Blockly.FieldVariable');
 goog.require('Blockly.Warning');
 
 
-common.defineBlocksWithJsonArray([
+/**
+ * A dictionary of the block definitions provided by this module.
+ * @type {!Object<string, !BlockDefinition>}
+ */
+const blocks = createBlockDefinitionsFromJsonArray([
   // Block for repeat n times (external number).
   {
     'type': 'controls_repeat_ext',
@@ -205,6 +211,7 @@ common.defineBlocksWithJsonArray([
     ],
   },
 ]);
+exports.blocks = blocks;
 
 /**
  * Tooltips for the 'controls_whileUntil' block, keyed by MODE value.
@@ -287,21 +294,24 @@ Extensions.register(
  *
  * // If using the Blockly npm package and es6 import syntax:
  * import {loopTypes} from 'blockly/blocks';
- * loopTypes.push('custom_loop');
+ * loopTypes.add('custom_loop');
  *
  * // Else if using Closure Compiler and goog.modules:
- * const {loopTypes} = goog.require('Blockly.blocks.loops');
- * loopTypes.push('custom_loop');
+ * const {loopTypes} = goog.require('Blockly.libraryBlocks.loops');
+ * loopTypes.add('custom_loop');
  *
- * @type {!Array<string>}
+ * // Else if using blockly_compressed + blockss_compressed.js in browser:
+ * Blockly.libraryBlocks.loopTypes.add('custom_loop');
+ *
+ * @type {!Set<string>}
  */
-const loopTypes = [
+const loopTypes = new Set([
   'controls_repeat',
   'controls_repeat_ext',
   'controls_forEach',
   'controls_for',
   'controls_whileUntil',
-];
+]);
 exports.loopTypes = loopTypes;
 
 /**
@@ -321,7 +331,7 @@ const CONTROL_FLOW_IN_LOOP_CHECK_MIXIN = {
   getSurroundLoop: function() {
     let block = this;
     do {
-      if (loopTypes.includes(block.type)) {
+      if (loopTypes.has(block.type)) {
         return block;
       }
       block = block.getSurroundParent();
@@ -332,7 +342,7 @@ const CONTROL_FLOW_IN_LOOP_CHECK_MIXIN = {
   /**
    * Called whenever anything on the workspace changes.
    * Add warning if this flow block is not nested inside a loop.
-   * @param {!AbstractEvent} e Change event.
+   * @param {!AbstractEvent} e Move event.
    * @this {Block}
    */
   onchange: function(e) {
@@ -358,3 +368,6 @@ const CONTROL_FLOW_IN_LOOP_CHECK_MIXIN = {
 
 Extensions.registerMixin(
     'controls_flow_in_loop_check', CONTROL_FLOW_IN_LOOP_CHECK_MIXIN);
+
+// Register provided blocks.
+defineBlocks(blocks);

package/blocks/math.js

@@ -10,7 +10,7 @@
  */
 'use strict';
 
-goog.module('Blockly.blocks.math');
+goog.module('Blockly.libraryBlocks.math');
 
 const Extensions = goog.require('Blockly.Extensions');
 // N.B.: Blockly.FieldDropdown needed for type AND side-effects.
@@ -20,7 +20,8 @@ const xmlUtils = goog.require('Blockly.utils.xml');
 /* eslint-disable-next-line no-unused-vars */
 const {Block} = goog.requireType('Blockly.Block');
 /* eslint-disable-next-line no-unused-vars */
-const {defineBlocksWithJsonArray} = goog.require('Blockly.common');
+const {BlockDefinition} = goog.requireType('Blockly.blocks');
+const {createBlockDefinitionsFromJsonArray, defineBlocks} = goog.require('Blockly.common');
 /** @suppress {extraRequire} */
 goog.require('Blockly.FieldLabel');
 /** @suppress {extraRequire} */
@@ -29,7 +30,11 @@ goog.require('Blockly.FieldNumber');
 goog.require('Blockly.FieldVariable');
 
 
-defineBlocksWithJsonArray([
+/**
+ * A dictionary of the block definitions provided by this module.
+ * @type {!Object<string, !BlockDefinition>}
+ */
+const blocks = createBlockDefinitionsFromJsonArray([
   // Block for numeric value.
   {
     'type': 'math_number',
@@ -384,6 +389,7 @@ defineBlocksWithJsonArray([
     'helpUrl': '%{BKY_MATH_ATAN2_HELPURL}',
   },
 ]);
+exports.blocks = blocks;
 
 /**
  * Mapping of math block OP value to tooltip message for blocks
@@ -581,3 +587,6 @@ const LIST_MODES_MUTATOR_EXTENSION = function() {
 Extensions.registerMutator(
     'math_modes_of_list_mutator', LIST_MODES_MUTATOR_MIXIN,
     LIST_MODES_MUTATOR_EXTENSION);
+
+// Register provided blocks.
+defineBlocks(blocks);

package/blocks/procedures.js

@@ -10,7 +10,7 @@
  */
 'use strict';
 
-goog.module('Blockly.blocks.procedures');
+goog.module('Blockly.libraryBlocks.procedures');
 
 /* eslint-disable-next-line no-unused-vars */
 const AbstractEvent = goog.requireType('Blockly.Events.Abstract');
@@ -19,12 +19,13 @@ const Events = goog.require('Blockly.Events');
 const Procedures = goog.require('Blockly.Procedures');
 const Variables = goog.require('Blockly.Variables');
 const Xml = goog.require('Blockly.Xml');
-const internalConstants = goog.require('Blockly.internalConstants');
 const xmlUtils = goog.require('Blockly.utils.xml');
 const {Align} = goog.require('Blockly.Input');
 /* eslint-disable-next-line no-unused-vars */
 const {Block} = goog.requireType('Blockly.Block');
-const {Blocks} = goog.require('Blockly.blocks');
+/* eslint-disable-next-line no-unused-vars */
+const {BlockDefinition} = goog.requireType('Blockly.blocks');
+const {config} = goog.require('Blockly.config');
 /* eslint-disable-next-line no-unused-vars */
 const {FieldCheckbox} = goog.require('Blockly.FieldCheckbox');
 const {FieldLabel} = goog.require('Blockly.FieldLabel');
@@ -36,12 +37,20 @@ const {Names} = goog.require('Blockly.Names');
 const {VariableModel} = goog.requireType('Blockly.VariableModel');
 /* eslint-disable-next-line no-unused-vars */
 const {Workspace} = goog.requireType('Blockly.Workspace');
+const {defineBlocks} = goog.require('Blockly.common');
 /** @suppress {extraRequire} */
 goog.require('Blockly.Comment');
 /** @suppress {extraRequire} */
 goog.require('Blockly.Warning');
 
 
+/**
+ * A dictionary of the block definitions provided by this module.
+ * @type {!Object<string, !BlockDefinition>}
+ */
+const blocks = {};
+exports.blocks = blocks;
+
 /**
  * Common properties for the procedure_defnoreturn and
  * procedure_defreturn blocks.
@@ -434,10 +443,9 @@ const PROCEDURE_DEF_COMMON = {
       }
     }
   },
-  callType_: 'procedures_callnoreturn',
 };
 
-Blocks['procedures_defnoreturn'] = {
+blocks['procedures_defnoreturn'] = {
   ...PROCEDURE_DEF_COMMON,
   /**
    * Block for defining a procedure with no return value.
@@ -477,9 +485,10 @@ Blocks['procedures_defnoreturn'] = {
   getProcedureDef: function() {
     return [this.getFieldValue('NAME'), this.arguments_, false];
   },
+  callType_: 'procedures_callnoreturn',
 };
 
-Blocks['procedures_defreturn'] = {
+blocks['procedures_defreturn'] = {
   ...PROCEDURE_DEF_COMMON,
   /**
    * Block for defining a procedure with a return value.
@@ -522,9 +531,10 @@ Blocks['procedures_defreturn'] = {
   getProcedureDef: function() {
     return [this.getFieldValue('NAME'), this.arguments_, true];
   },
+  callType_: 'procedures_callreturn',
 };
 
-Blocks['procedures_mutatorcontainer'] = {
+blocks['procedures_mutatorcontainer'] = {
   /**
    * Mutator block for procedure container.
    * @this {Block}
@@ -542,7 +552,7 @@ Blocks['procedures_mutatorcontainer'] = {
   },
 };
 
-Blocks['procedures_mutatorarg'] = {
+blocks['procedures_mutatorarg'] = {
   /**
    * Mutator block for procedure argument.
    * @this {Block}
@@ -950,19 +960,18 @@ const PROCEDURE_CALL_COMMON = {
         const block = xmlUtils.createElement('block');
         block.setAttribute('type', this.defType_);
         const xy = this.getRelativeToSurfaceXY();
-        const x = xy.x + internalConstants.SNAP_RADIUS * (this.RTL ? -1 : 1);
-        const y = xy.y + internalConstants.SNAP_RADIUS * 2;
+        const x = xy.x + config.snapRadius * (this.RTL ? -1 : 1);
+        const y = xy.y + config.snapRadius * 2;
         block.setAttribute('x', x);
         block.setAttribute('y', y);
         const mutation = this.mutationToDom();
         block.appendChild(mutation);
         const field = xmlUtils.createElement('field');
         field.setAttribute('name', 'NAME');
-        let callName = this.getProcedureCall();
-        if (!callName) {
-          // Rename if name is empty string.
-          callName = Procedures.findLegalName('', this);
-          this.renameProcedure('', callName);
+        const callName = this.getProcedureCall();
+        const newName = Procedures.findLegalName(callName, this);
+        if (callName !== newName) {
+          this.renameProcedure(callName, newName);
         }
         field.appendChild(xmlUtils.createTextNode(callName));
         block.appendChild(field);
@@ -1033,7 +1042,7 @@ const PROCEDURE_CALL_COMMON = {
   },
 };
 
-Blocks['procedures_callnoreturn'] = {
+blocks['procedures_callnoreturn'] = {
   ...PROCEDURE_CALL_COMMON,
   /**
    * Block for calling a procedure with no return value.
@@ -1056,7 +1065,7 @@ Blocks['procedures_callnoreturn'] = {
   defType_: 'procedures_defnoreturn',
 };
 
-Blocks['procedures_callreturn'] = {
+blocks['procedures_callreturn'] = {
   ...PROCEDURE_CALL_COMMON,
   /**
    * Block for calling a procedure with a return value.
@@ -1078,7 +1087,7 @@ Blocks['procedures_callreturn'] = {
   defType_: 'procedures_defreturn',
 };
 
-Blocks['procedures_ifreturn'] = {
+blocks['procedures_ifreturn'] = {
   /**
    * Block for conditionally returning a value from a procedure.
    * @this {Block}
@@ -1130,11 +1139,12 @@ Blocks['procedures_ifreturn'] = {
   /**
    * Called whenever anything on the workspace changes.
    * Add warning if this flow block is not nested inside a loop.
-   * @param {!AbstractEvent} _e Change event.
+   * @param {!AbstractEvent} e Move event.
    * @this {Block}
    */
-  onchange: function(_e) {
-    if (this.workspace.isDragging && this.workspace.isDragging()) {
+  onchange: function(e) {
+    if (this.workspace.isDragging && this.workspace.isDragging() ||
+        e.type !== Events.BLOCK_MOVE) {
       return;  // Don't change state at the start of a drag.
     }
     let legal = false;
@@ -1162,14 +1172,15 @@ Blocks['procedures_ifreturn'] = {
         this.hasReturnValue_ = true;
       }
       this.setWarningText(null);
-      if (!this.isInFlyout) {
-        this.setEnabled(true);
-      }
     } else {
       this.setWarningText(Msg['PROCEDURES_IFRETURN_WARNING']);
-      if (!this.isInFlyout && !this.getInheritedDisabled()) {
-        this.setEnabled(false);
-      }
+    }
+    if (!this.isInFlyout) {
+      const group = Events.getGroup();
+      // Makes it so the move and the disable event get undone together.
+      Events.setGroup(e.group);
+      this.setEnabled(legal);
+      Events.setGroup(group);
     }
   },
   /**
@@ -1179,3 +1190,6 @@ Blocks['procedures_ifreturn'] = {
    */
   FUNCTION_TYPES: ['procedures_defnoreturn', 'procedures_defreturn'],
 };
+
+// Register provided blocks.
+defineBlocks(blocks);