blockly 9.0.0-beta.0 → 9.0.0-beta.1

package/core/field_variable.ts

@@ -1,545 +0,0 @@
-/**
- * @license
- * Copyright 2012 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Variable input field.
- */
-
-/**
- * Variable input field.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.FieldVariable');
-
-// Unused import preserved for side-effects. Remove if unneeded.
-import './events/events_block_change.js';
-
-import type {Block} from './block.js';
-import {Field, FieldConfig} from './field.js';
-import {FieldDropdown} from './field_dropdown.js';
-import * as fieldRegistry from './field_registry.js';
-import * as internalConstants from './internal_constants.js';
-import type {Menu} from './menu.js';
-import type {MenuItem} from './menuitem.js';
-import {Msg} from './msg.js';
-import * as parsing from './utils/parsing.js';
-import type {Sentinel} from './utils/sentinel.js';
-import {Size} from './utils/size.js';
-import {VariableModel} from './variable_model.js';
-import * as Variables from './variables.js';
-import * as Xml from './xml.js';
-
-
-/**
- * Class for a variable's dropdown field.
- * @alias Blockly.FieldVariable
- */
-export class FieldVariable extends FieldDropdown {
-  protected override menuGenerator_: AnyDuringMigration[][]|
-      ((this: FieldDropdown) => AnyDuringMigration[][]);
-  defaultVariableName: string;
-
-  /** The type of the default variable for this field. */
-  private defaultType_ = '';
-
-  /**
-   * All of the types of variables that will be available in this field's
-   * dropdown.
-   */
-  variableTypes: string[]|null = [];
-  protected override size_: Size;
-
-  /** The variable model associated with this field. */
-  private variable_: VariableModel|null = null;
-
-  /**
-   * Serializable fields are saved by the serializer, non-serializable fields
-   * are not. Editable fields should also be serializable.
-   */
-  override SERIALIZABLE = true;
-
-  /**
-   * @param varName The default name for the variable.
-   *     If null, a unique variable name will be generated.
-   *     Also accepts Field.SKIP_SETUP if you wish to skip setup (only used by
-   * subclasses that want to handle configuration and setting the field value
-   * after their own constructors have run).
-   * @param opt_validator A function that is called to validate changes to the
-   *     field's value. Takes in a variable ID  & returns a validated variable
-   *     ID, or null to abort the change.
-   * @param opt_variableTypes A list of the types of variables to include in the
-   *     dropdown. Will only be used if opt_config is not provided.
-   * @param opt_defaultType The type of variable to create if this field's value
-   *     is not explicitly set.  Defaults to ''. Will only be used if opt_config
-   *     is not provided.
-   * @param opt_config A map of options used to configure the field.
-   *    See the [field creation documentation]{@link
-   * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/variable#creation}
-   * for a list of properties this parameter supports.
-   */
-  constructor(
-      varName: string|null|Sentinel, opt_validator?: Function,
-      opt_variableTypes?: string[], opt_defaultType?: string,
-      opt_config?: FieldVariableConfig) {
-    super(Field.SKIP_SETUP);
-
-    /**
-     * An array of options for a dropdown list,
-     * or a function which generates these options.
-     */
-    // AnyDuringMigration because:  Type '(this: FieldVariable) => any[][]' is
-    // not assignable to type 'any[][] | ((this: FieldDropdown) => any[][])'.
-    this.menuGenerator_ = FieldVariable.dropdownCreate as AnyDuringMigration;
-
-    /**
-     * The initial variable name passed to this field's constructor, or an
-     * empty string if a name wasn't provided. Used to create the initial
-     * variable.
-     */
-    this.defaultVariableName = typeof varName === 'string' ? varName : '';
-
-    /** The size of the area rendered by the field. */
-    this.size_ = new Size(0, 0);
-
-    if (varName === Field.SKIP_SETUP) {
-      return;
-    }
-
-    if (opt_config) {
-      this.configure_(opt_config);
-    } else {
-      this.setTypes_(opt_variableTypes, opt_defaultType);
-    }
-    if (opt_validator) {
-      this.setValidator(opt_validator);
-    }
-  }
-
-  /**
-   * Configure the field based on the given map of options.
-   * @param config A map of options to configure the field based on.
-   */
-  protected override configure_(config: FieldVariableConfig) {
-    super.configure_(config);
-    this.setTypes_(config.variableTypes, config.defaultType);
-  }
-
-  /**
-   * Initialize the model for this field if it has not already been initialized.
-   * If the value has not been set to a variable by the first render, we make up
-   * a variable rather than let the value be invalid.
-   * @internal
-   */
-  override initModel() {
-    if (this.variable_) {
-      return;  // Initialization already happened.
-    }
-    const variable = Variables.getOrCreateVariablePackage(
-        this.sourceBlock_.workspace, null, this.defaultVariableName,
-        this.defaultType_);
-    // Don't call setValue because we don't want to cause a rerender.
-    this.doValueUpdate_(variable.getId());
-  }
-
-  override shouldAddBorderRect_() {
-    return super.shouldAddBorderRect_() &&
-        (!this.getConstants()!.FIELD_DROPDOWN_NO_BORDER_RECT_SHADOW ||
-         this.sourceBlock_.type !== 'variables_get');
-  }
-
-  /**
-   * Initialize this field based on the given XML.
-   * @param fieldElement The element containing information about the variable
-   *     field's state.
-   */
-  override fromXml(fieldElement: Element) {
-    const id = fieldElement.getAttribute('id');
-    const variableName = fieldElement.textContent;
-    // 'variabletype' should be lowercase, but until July 2019 it was sometimes
-    // recorded as 'variableType'.  Thus we need to check for both.
-    const variableType = fieldElement.getAttribute('variabletype') ||
-        fieldElement.getAttribute('variableType') || '';
-
-    // AnyDuringMigration because:  Argument of type 'string | null' is not
-    // assignable to parameter of type 'string | undefined'.
-    const variable = Variables.getOrCreateVariablePackage(
-        this.sourceBlock_.workspace, id, variableName as AnyDuringMigration,
-        variableType);
-
-    // This should never happen :)
-    if (variableType !== null && variableType !== variable.type) {
-      throw Error(
-          'Serialized variable type with id \'' + variable.getId() +
-          '\' had type ' + variable.type + ', and ' +
-          'does not match variable field that references it: ' +
-          Xml.domToText(fieldElement) + '.');
-    }
-
-    this.setValue(variable.getId());
-  }
-
-  /**
-   * Serialize this field to XML.
-   * @param fieldElement The element to populate with info about the field's
-   *     state.
-   * @return The element containing info about the field's state.
-   */
-  override toXml(fieldElement: Element): Element {
-    // Make sure the variable is initialized.
-    this.initModel();
-
-    fieldElement.id = this.variable_!.getId();
-    fieldElement.textContent = this.variable_!.name;
-    if (this.variable_!.type) {
-      fieldElement.setAttribute('variabletype', this.variable_!.type);
-    }
-    return fieldElement;
-  }
-
-  /**
-   * Saves this field's value.
-   * @param doFullSerialization If true, the variable field will serialize the
-   *     full state of the field being referenced (ie ID, name, and type) rather
-   *     than just a reference to it (ie ID).
-   * @return The state of the variable field.
-   * @internal
-   */
-  override saveState(doFullSerialization?: boolean): AnyDuringMigration {
-    const legacyState = this.saveLegacyState(FieldVariable);
-    if (legacyState !== null) {
-      return legacyState;
-    }
-    // Make sure the variable is initialized.
-    this.initModel();
-    const state = {'id': this.variable_!.getId()};
-    if (doFullSerialization) {
-      (state as AnyDuringMigration)['name'] = this.variable_!.name;
-      (state as AnyDuringMigration)['type'] = this.variable_!.type;
-    }
-    return state;
-  }
-
-  /**
-   * Sets the field's value based on the given state.
-   * @param state The state of the variable to assign to this variable field.
-   * @internal
-   */
-  override loadState(state: AnyDuringMigration) {
-    if (this.loadLegacyState(FieldVariable, state)) {
-      return;
-    }
-    // This is necessary so that blocks in the flyout can have custom var names.
-    const variable = Variables.getOrCreateVariablePackage(
-        this.sourceBlock_.workspace, state['id'] || null, state['name'],
-        state['type'] || '');
-    this.setValue(variable.getId());
-  }
-
-  /**
-   * Attach this field to a block.
-   * @param block The block containing this field.
-   */
-  override setSourceBlock(block: Block) {
-    if (block.isShadow()) {
-      throw Error('Variable fields are not allowed to exist on shadow blocks.');
-    }
-    super.setSourceBlock(block);
-  }
-
-  /**
-   * Get the variable's ID.
-   * @return Current variable's ID.
-   */
-  override getValue(): string|null {
-    return this.variable_ ? this.variable_.getId() : null;
-  }
-
-  /**
-   * Get the text from this field, which is the selected variable's name.
-   * @return The selected variable's name, or the empty string if no variable is
-   *     selected.
-   */
-  override getText(): string {
-    return this.variable_ ? this.variable_.name : '';
-  }
-
-  /**
-   * Get the variable model for the selected variable.
-   * Not guaranteed to be in the variable map on the workspace (e.g. if accessed
-   * after the variable has been deleted).
-   * @return The selected variable, or null if none was selected.
-   * @internal
-   */
-  getVariable(): VariableModel|null {
-    return this.variable_;
-  }
-
-  /**
-   * Gets the validation function for this field, or null if not set.
-   * Returns null if the variable is not set, because validators should not
-   * run on the initial setValue call, because the field won't be attached to
-   * a block and workspace at that point.
-   * @return Validation function, or null.
-   */
-  override getValidator(): Function|null {
-    // Validators shouldn't operate on the initial setValue call.
-    // Normally this is achieved by calling setValidator after setValue, but
-    // this is not a possibility with variable fields.
-    if (this.variable_) {
-      return this.validator_;
-    }
-    return null;
-  }
-
-  /**
-   * Ensure that the ID belongs to a valid variable of an allowed type.
-   * @param opt_newValue The ID of the new variable to set.
-   * @return The validated ID, or null if invalid.
-   */
-  protected override doClassValidation_(opt_newValue?: AnyDuringMigration):
-      string|null {
-    if (opt_newValue === null) {
-      return null;
-    }
-    const newId = opt_newValue as string;
-    const variable = Variables.getVariable(this.sourceBlock_.workspace, newId);
-    if (!variable) {
-      console.warn(
-          'Variable id doesn\'t point to a real variable! ' +
-          'ID was ' + newId);
-      return null;
-    }
-    // Type Checks.
-    const type = variable.type;
-    if (!this.typeIsAllowed_(type)) {
-      console.warn(
-          'Variable type doesn\'t match this field!  Type was ' + type);
-      return null;
-    }
-    return newId;
-  }
-
-  /**
-   * Update the value of this variable field, as well as its variable and text.
-   *
-   * The variable ID should be valid at this point, but if a variable field
-   * validator returns a bad ID, this could break.
-   * @param newId The value to be saved.
-   */
-  protected override doValueUpdate_(newId: AnyDuringMigration) {
-    this.variable_ =
-        Variables.getVariable(this.sourceBlock_.workspace, newId as string);
-    super.doValueUpdate_(newId);
-  }
-
-  /**
-   * Check whether the given variable type is allowed on this field.
-   * @param type The type to check.
-   * @return True if the type is in the list of allowed types.
-   */
-  private typeIsAllowed_(type: string): boolean {
-    const typeList = this.getVariableTypes_();
-    if (!typeList) {
-      return true;  // If it's null, all types are valid.
-    }
-    for (let i = 0; i < typeList.length; i++) {
-      if (type === typeList[i]) {
-        return true;
-      }
-    }
-    return false;
-  }
-
-  /**
-   * Return a list of variable types to include in the dropdown.
-   * @return Array of variable types.
-   * @throws {Error} if variableTypes is an empty array.
-   */
-  private getVariableTypes_(): string[] {
-    // TODO (#1513): Try to avoid calling this every time the field is edited.
-    let variableTypes = this.variableTypes;
-    if (variableTypes === null) {
-      // If variableTypes is null, return all variable types.
-      if (this.sourceBlock_ && !this.sourceBlock_.disposed) {
-        return this.sourceBlock_.workspace.getVariableTypes();
-      }
-    }
-    variableTypes = variableTypes || [''];
-    if (variableTypes.length === 0) {
-      // Throw an error if variableTypes is an empty list.
-      const name = this.getText();
-      throw Error(
-          '\'variableTypes\' of field variable ' + name + ' was an empty list');
-    }
-    return variableTypes;
-  }
-
-  /**
-   * Parse the optional arguments representing the allowed variable types and
-   * the default variable type.
-   * @param opt_variableTypes A list of the types of variables to include in the
-   *     dropdown.  If null or undefined, variables of all types will be
-   *     displayed in the dropdown.
-   * @param opt_defaultType The type of the variable to create if this field's
-   *     value is not explicitly set.  Defaults to ''.
-   */
-  private setTypes_(opt_variableTypes?: string[], opt_defaultType?: string) {
-    // If you expected that the default type would be the same as the only entry
-    // in the variable types array, tell the Blockly team by commenting on
-    // #1499.
-    const defaultType = opt_defaultType || '';
-    let variableTypes;
-    // Set the allowable variable types.  Null means all types on the workspace.
-    if (opt_variableTypes === null || opt_variableTypes === undefined) {
-      variableTypes = null;
-    } else if (Array.isArray(opt_variableTypes)) {
-      variableTypes = opt_variableTypes;
-      // Make sure the default type is valid.
-      let isInArray = false;
-      for (let i = 0; i < variableTypes.length; i++) {
-        if (variableTypes[i] === defaultType) {
-          isInArray = true;
-        }
-      }
-      if (!isInArray) {
-        throw Error(
-            'Invalid default type \'' + defaultType + '\' in ' +
-            'the definition of a FieldVariable');
-      }
-    } else {
-      throw Error(
-          '\'variableTypes\' was not an array in the definition of ' +
-          'a FieldVariable');
-    }
-    // Only update the field once all checks pass.
-    this.defaultType_ = defaultType;
-    this.variableTypes = variableTypes;
-  }
-
-  /**
-   * Refreshes the name of the variable by grabbing the name of the model.
-   * Used when a variable gets renamed, but the ID stays the same. Should only
-   * be called by the block.
-   * @internal
-   */
-  override refreshVariableName() {
-    this.forceRerender();
-  }
-
-  /**
-   * Handle the selection of an item in the variable dropdown menu.
-   * Special case the 'Rename variable...' and 'Delete variable...' options.
-   * In the rename case, prompt the user for a new name.
-   * @param menu The Menu component clicked.
-   * @param menuItem The MenuItem selected within menu.
-   */
-  protected override onItemSelected_(menu: Menu, menuItem: MenuItem) {
-    const id = menuItem.getValue();
-    // Handle special cases.
-    if (this.sourceBlock_ && !this.sourceBlock_.disposed) {
-      if (id === internalConstants.RENAME_VARIABLE_ID) {
-        // Rename variable.
-        Variables.renameVariable(
-            this.sourceBlock_.workspace, this.variable_ as VariableModel);
-        return;
-      } else if (id === internalConstants.DELETE_VARIABLE_ID) {
-        // Delete variable.
-        this.sourceBlock_.workspace.deleteVariableById(this.variable_!.getId());
-        return;
-      }
-    }
-    // Handle unspecial case.
-    this.setValue(id);
-  }
-
-  /**
-   * Overrides referencesVariables(), indicating this field refers to a
-   * variable.
-   * @return True.
-   * @internal
-   */
-  override referencesVariables(): boolean {
-    return true;
-  }
-
-  /**
-   * Construct a FieldVariable from a JSON arg object,
-   * dereferencing any string table references.
-   * @param options A JSON object with options (variable, variableTypes, and
-   *     defaultType).
-   * @return The new field instance.
-   * @nocollapse
-   * @internal
-   */
-  static override fromJson(options: FieldVariableFromJsonConfig):
-      FieldVariable {
-    const varName = parsing.replaceMessageReferences(options.variable);
-    // `this` might be a subclass of FieldVariable if that class doesn't
-    // override the static fromJson method.
-    return new this(varName, undefined, undefined, undefined, options);
-  }
-
-  /**
-   * Return a sorted list of variable names for variable dropdown menus.
-   * Include a special option at the end for creating a new variable name.
-   * @return Array of variable names/id tuples.
-   */
-  static dropdownCreate(this: FieldVariable): AnyDuringMigration[][] {
-    if (!this.variable_) {
-      throw Error(
-          'Tried to call dropdownCreate on a variable field with no' +
-          ' variable selected.');
-    }
-    const name = this.getText();
-    let variableModelList: AnyDuringMigration[] = [];
-    if (this.sourceBlock_ && !this.sourceBlock_.disposed) {
-      const variableTypes = this.getVariableTypes_();
-      // Get a copy of the list, so that adding rename and new variable options
-      // doesn't modify the workspace's list.
-      for (let i = 0; i < variableTypes.length; i++) {
-        const variableType = variableTypes[i];
-        const variables =
-            this.sourceBlock_.workspace.getVariablesOfType(variableType);
-        variableModelList = variableModelList.concat(variables);
-      }
-    }
-    variableModelList.sort(VariableModel.compareByName);
-
-    const options = [];
-    for (let i = 0; i < variableModelList.length; i++) {
-      // Set the UUID as the internal representation of the variable.
-      options[i] = [variableModelList[i].name, variableModelList[i].getId()];
-    }
-    options.push(
-        [Msg['RENAME_VARIABLE'], internalConstants.RENAME_VARIABLE_ID]);
-    if (Msg['DELETE_VARIABLE']) {
-      options.push([
-        Msg['DELETE_VARIABLE'].replace('%1', name),
-        internalConstants.DELETE_VARIABLE_ID,
-      ]);
-    }
-
-    return options;
-  }
-}
-
-fieldRegistry.register('field_variable', FieldVariable);
-
-/**
- * Config options for the variable field.
- */
-export interface FieldVariableConfig extends FieldConfig {
-  variableTypes?: string[];
-  defaultType?: string;
-}
-
-/**
- * fromJson config options for the variable field.
- */
-export interface FieldVariableFromJsonConfig extends FieldVariableConfig {
-  variable?: string;
-}