mixio 1.10.0

blockly/core/contextmenu_registry.js

@@ -0,0 +1,163 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+/**
+ * @fileoverview Registry for context menu option items.
+ * @author maribethb@google.com (Maribeth Bottorff)
+ */
+'use strict';
+
+/**
+ * @name Blockly.ContextMenuRegistry
+ * @namespace
+ */
+goog.provide('Blockly.ContextMenuRegistry');
+
+goog.requireType('Blockly.BlockSvg');
+goog.requireType('Blockly.WorkspaceSvg');
+
+
+/**
+ * Class for the registry of context menu items. This is intended to be a
+ * singleton. You should not create a new instance, and only access this class
+ * from Blockly.ContextMenuRegistry.registry.
+ * @constructor
+ */
+Blockly.ContextMenuRegistry = function() {
+  // Singleton instance should be registered once.
+  Blockly.ContextMenuRegistry.registry = this;
+
+  /**
+   * Registry of all registered RegistryItems, keyed by ID.
+   * @type {!Object<string, !Blockly.ContextMenuRegistry.RegistryItem>}
+   * @private
+   */
+  this.registry_ = Object.create(null);
+};
+
+/**
+ * Where this menu item should be rendered. If the menu item should be rendered in multiple
+ * scopes, e.g. on both a block and a workspace, it should be registered for each scope.
+ * @enum {string}
+ */
+Blockly.ContextMenuRegistry.ScopeType = {
+  BLOCK: 'block',
+  WORKSPACE: 'workspace',
+};
+
+/**
+ * The actual workspace/block where the menu is being rendered. This is passed to callback and
+ * displayText functions that depend on this information.
+ * @typedef {{
+ *    block: (Blockly.BlockSvg|undefined),
+ *    workspace: (Blockly.WorkspaceSvg|undefined)
+ * }}
+ */
+Blockly.ContextMenuRegistry.Scope;
+
+/**
+ * A menu item as entered in the registry.
+ * @typedef {{
+ *    callback: function(!Blockly.ContextMenuRegistry.Scope),
+ *    scopeType: !Blockly.ContextMenuRegistry.ScopeType,
+ *    displayText: ((function(!Blockly.ContextMenuRegistry.Scope):string)|string),
+ *    preconditionFn: function(!Blockly.ContextMenuRegistry.Scope):string,
+ *    weight: number,
+ *    id: string
+ * }}
+*/
+Blockly.ContextMenuRegistry.RegistryItem;
+
+/**
+ * A menu item as presented to contextmenu.js.
+ * @typedef {{
+ *    text: string,
+ *    enabled: boolean,
+ *    callback: function(!Blockly.ContextMenuRegistry.Scope),
+ *    scope: !Blockly.ContextMenuRegistry.Scope,
+ *    weight: number
+ * }}
+ */
+Blockly.ContextMenuRegistry.ContextMenuOption;
+
+/**
+ * Singleton instance of this class. All interactions with this class should be
+ * done on this object.
+ * @type {?Blockly.ContextMenuRegistry}
+ */
+Blockly.ContextMenuRegistry.registry = null;
+
+/**
+ * Registers a RegistryItem.
+ * @param {!Blockly.ContextMenuRegistry.RegistryItem} item Context menu item to register.
+ * @throws {Error} if an item with the given ID already exists.
+ */
+Blockly.ContextMenuRegistry.prototype.register = function(item) {
+  if (this.registry_[item.id]) {
+    throw Error('Menu item with ID "' + item.id + '" is already registered.');
+  }
+  this.registry_[item.id] = item;
+};
+
+/**
+ * Unregisters a RegistryItem with the given ID.
+ * @param {string} id The ID of the RegistryItem to remove.
+ * @throws {Error} if an item with the given ID does not exist.
+ */
+Blockly.ContextMenuRegistry.prototype.unregister = function(id) {
+  if (!this.registry_[id]) {
+    throw new Error('Menu item with ID "' + id + '" not found.');
+  }
+  delete this.registry_[id];
+};
+
+/**
+ * @param {string} id The ID of the RegistryItem to get.
+ * @return {?Blockly.ContextMenuRegistry.RegistryItem} RegistryItem or null if not found
+ */
+Blockly.ContextMenuRegistry.prototype.getItem = function(id) {
+  return this.registry_[id] || null;
+};
+
+/**
+ * Gets the valid context menu options for the given scope type (e.g. block or workspace) and scope.
+ * Blocks are only shown if the preconditionFn shows they should not be hidden.
+ * @param {!Blockly.ContextMenuRegistry.ScopeType} scopeType Type of scope where menu should be
+ *     shown (e.g. on a block or on a workspace)
+ * @param {!Blockly.ContextMenuRegistry.Scope} scope Current scope of context menu
+ *     (i.e., the exact workspace or block being clicked on)
+ * @return {!Array<!Blockly.ContextMenuRegistry.ContextMenuOption>} the list of ContextMenuOptions
+ */
+Blockly.ContextMenuRegistry.prototype.getContextMenuOptions = function(scopeType, scope) {
+  var menuOptions = [];
+  var registry = this.registry_;
+  Object.keys(registry).forEach(function(id) {
+    var item = registry[id];
+    if (scopeType == item.scopeType) {
+      var precondition = item.preconditionFn(scope);
+      if (precondition != 'hidden') {
+        var displayText = typeof item.displayText == 'function' ?
+                            item.displayText(scope) : item.displayText;
+        /** @type {!Blockly.ContextMenuRegistry.ContextMenuOption} */
+        var menuOption = {
+          text: displayText,
+          enabled: (precondition == 'enabled'),
+          callback: item.callback,
+          scope: scope,
+          weight: item.weight,
+        };
+        menuOptions.push(menuOption);
+      }
+    }
+  });
+  menuOptions.sort(function(a, b) {
+    return a.weight - b.weight;
+  });
+  return menuOptions;
+};
+
+// Creates and assigns the singleton instance.
+new Blockly.ContextMenuRegistry();