blockly 9.0.0-beta.0 → 9.0.0-beta.2

package/core/names.ts

@@ -1,267 +0,0 @@
-/**
- * @license
- * Copyright 2012 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Utility functions for handling variable and procedure names.
- */
-
-/**
- * Utility functions for handling variable and procedure names.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Names');
-
-// Unused import preserved for side-effects. Remove if unneeded.
-// import './procedures.js';
-
-import {Msg} from './msg.js';
-// import * as Procedures from './procedures.js';
-import type {VariableMap} from './variable_map.js';
-import * as Variables from './variables.js';
-import type {Workspace} from './workspace.js';
-
-
-/**
- * Class for a database of entity names (variables, procedures, etc).
- * @alias Blockly.Names
- */
-export class Names {
-  static DEVELOPER_VARIABLE_TYPE: NameType;
-  private readonly variablePrefix_: string;
-
-  /** A set of reserved words. */
-  private readonly reservedWords: Set<string>;
-
-  /**
-   * A map from type (e.g. name, procedure) to maps from names to generated
-   * names.
-   */
-  private readonly db = new Map<string, Map<string, string>>();
-
-  /** A set of used names to avoid collisions. */
-  private readonly dbReverse = new Set<string>();
-
-  /**
-   * The variable map from the workspace, containing Blockly variable models.
-   */
-  private variableMap_: VariableMap|null = null;
-
-  /**
-   * @param reservedWordsList A comma-separated string of words that are illegal
-   *     for use as names in a language (e.g. 'new,if,this,...').
-   * @param opt_variablePrefix Some languages need a '$' or a namespace before
-   *     all variable names (but not procedure names).
-   */
-  constructor(reservedWordsList: string, opt_variablePrefix?: string) {
-    /** The prefix to attach to variable names in generated code. */
-    this.variablePrefix_ = opt_variablePrefix || '';
-
-    this.reservedWords =
-        new Set<string>(reservedWordsList ? reservedWordsList.split(',') : []);
-  }
-
-  /**
-   * Empty the database and start from scratch.  The reserved words are kept.
-   */
-  reset() {
-    this.db.clear();
-    this.dbReverse.clear();
-    this.variableMap_ = null;
-  }
-
-  /**
-   * Set the variable map that maps from variable name to variable object.
-   * @param map The map to track.
-   */
-  setVariableMap(map: VariableMap) {
-    this.variableMap_ = map;
-  }
-
-  /**
-   * Get the name for a user-defined variable, based on its ID.
-   * This should only be used for variables of NameType VARIABLE.
-   * @param id The ID to look up in the variable map.
-   * @return The name of the referenced variable, or null if there was no
-   *     variable map or the variable was not found in the map.
-   */
-  private getNameForUserVariable_(id: string): string|null {
-    if (!this.variableMap_) {
-      console.warn(
-          'Deprecated call to Names.prototype.getName without ' +
-          'defining a variable map. To fix, add the following code in your ' +
-          'generator\'s init() function:\n' +
-          'Blockly.YourGeneratorName.nameDB_.setVariableMap(' +
-          'workspace.getVariableMap());');
-      return null;
-    }
-    const variable = this.variableMap_.getVariableById(id);
-    if (variable) {
-      return variable.name;
-    }
-    return null;
-  }
-
-  /**
-   * Generate names for user variables, but only ones that are being used.
-   * @param workspace Workspace to generate variables from.
-   */
-  populateVariables(workspace: Workspace) {
-    const variables = Variables.allUsedVarModels(workspace);
-    for (let i = 0; i < variables.length; i++) {
-      this.getName(variables[i].getId(), NameType.VARIABLE);
-    }
-  }
-
-  /**
-   * Generate names for procedures.
-   * @param workspace Workspace to generate procedures from.
-   */
-  populateProcedures(workspace: Workspace) {
-    throw new Error(
-        'The implementation of populateProcedures should be ' +
-        'monkey-patched in by blockly.ts');
-  }
-
-  /**
-   * Convert a Blockly entity name to a legal exportable entity name.
-   * @param nameOrId The Blockly entity name (no constraints) or variable ID.
-   * @param type The type of the name in Blockly ('VARIABLE', 'PROCEDURE',
-   *     'DEVELOPER_VARIABLE', etc...).
-   * @return An entity name that is legal in the exported language.
-   */
-  getName(nameOrId: string, type: NameType|string): string {
-    let name = nameOrId;
-    if (type === NameType.VARIABLE) {
-      const varName = this.getNameForUserVariable_(nameOrId);
-      if (varName) {
-        // Successful ID lookup.
-        name = varName;
-      }
-    }
-    const normalizedName = name.toLowerCase();
-
-    const isVar =
-        type === NameType.VARIABLE || type === NameType.DEVELOPER_VARIABLE;
-
-    const prefix = isVar ? this.variablePrefix_ : '';
-    if (!this.db.has(type)) {
-      this.db.set(type, new Map<string, string>());
-    }
-    const typeDb = this.db.get(type);
-    if (typeDb!.has(normalizedName)) {
-      return prefix + typeDb!.get(normalizedName);
-    }
-    const safeName = this.getDistinctName(name, type);
-    typeDb!.set(normalizedName, safeName.substr(prefix.length));
-    return safeName;
-  }
-
-  /**
-   * Return a list of all known user-created names of a specified name type.
-   * @param type The type of entity in Blockly ('VARIABLE', 'PROCEDURE',
-   *     'DEVELOPER_VARIABLE', etc...).
-   * @return A list of Blockly entity names (no constraints).
-   */
-  getUserNames(type: NameType|string): string[] {
-    const userNames = this.db.get(type)?.keys();
-    return userNames ? Array.from(userNames) : [];
-  }
-
-  /**
-   * Convert a Blockly entity name to a legal exportable entity name.
-   * Ensure that this is a new name not overlapping any previously defined name.
-   * Also check against list of reserved words for the current language and
-   * ensure name doesn't collide.
-   * @param name The Blockly entity name (no constraints).
-   * @param type The type of entity in Blockly ('VARIABLE', 'PROCEDURE',
-   *     'DEVELOPER_VARIABLE', etc...).
-   * @return An entity name that is legal in the exported language.
-   */
-  getDistinctName(name: string, type: NameType|string): string {
-    let safeName = this.safeName_(name);
-    let i = '';
-    while (this.dbReverse.has(safeName + i) ||
-           this.reservedWords.has(safeName + i)) {
-      // Collision with existing name.  Create a unique name.
-      // AnyDuringMigration because:  Type 'string | 2' is not assignable to
-      // type 'string'.
-      i = (i ? i + 1 : 2) as AnyDuringMigration;
-    }
-    safeName += i;
-    this.dbReverse.add(safeName);
-    const isVar =
-        type === NameType.VARIABLE || type === NameType.DEVELOPER_VARIABLE;
-    const prefix = isVar ? this.variablePrefix_ : '';
-    return prefix + safeName;
-  }
-
-  /**
-   * Given a proposed entity name, generate a name that conforms to the
-   * [_A-Za-z][_A-Za-z0-9]* format that most languages consider legal for
-   * variable and function names.
-   * @param name Potentially illegal entity name.
-   * @return Safe entity name.
-   */
-  private safeName_(name: string): string {
-    if (!name) {
-      name = Msg['UNNAMED_KEY'] || 'unnamed';
-    } else {
-      // Unfortunately names in non-latin characters will look like
-      // _E9_9F_B3_E4_B9_90 which is pretty meaningless.
-      // https://github.com/google/blockly/issues/1654
-      name = encodeURI(name.replace(/ /g, '_')).replace(/[^\w]/g, '_');
-      // Most languages don't allow names with leading numbers.
-      if ('0123456789'.indexOf(name[0]) !== -1) {
-        name = 'my_' + name;
-      }
-    }
-    return name;
-  }
-
-  /**
-   * Do the given two entity names refer to the same entity?
-   * Blockly names are case-insensitive.
-   * @param name1 First name.
-   * @param name2 Second name.
-   * @return True if names are the same.
-   */
-  static equals(name1: string, name2: string): boolean {
-    // name1.localeCompare(name2) is slower.
-    return name1.toLowerCase() === name2.toLowerCase();
-  }
-}
-
-export namespace Names {
-  /**
-   * Enum for the type of a name. Different name types may have different rules
-   * about collisions.
-   * When JavaScript (or most other languages) is generated, variable 'foo' and
-   * procedure 'foo' would collide.  However, Blockly has no such problems since
-   * variable get 'foo' and procedure call 'foo' are unambiguous.
-   * Therefore, Blockly keeps a separate name type to disambiguate.
-   * getName('foo', 'VARIABLE') -> 'foo'
-   * getName('foo', 'PROCEDURE') -> 'foo2'
-   * @alias Blockly.Names.NameType
-   */
-  export enum NameType {
-    DEVELOPER_VARIABLE = 'DEVELOPER_VARIABLE',
-    VARIABLE = 'VARIABLE',
-    PROCEDURE = 'PROCEDURE',
-  }
-}
-
-export type NameType = Names.NameType;
-export const NameType = Names.NameType;
-
-/**
- * Constant to separate developer variable names from user-defined variable
- * names when running generators.
- * A developer variable will be declared as a global in the generated code, but
- * will never be shown to the user in the workspace or stored in the variable
- * map.
- */
-Names.DEVELOPER_VARIABLE_TYPE = NameType.DEVELOPER_VARIABLE;

package/core/options.ts

@@ -1,365 +0,0 @@
-/**
- * @license
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Object that controls settings for the workspace.
- */
-
-/**
- * Object that controls settings for the workspace.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.Options');
-
-import type {BlocklyOptions} from './blockly_options.js';
-import * as deprecation from './utils/deprecation.js';
-import * as registry from './registry.js';
-import {Theme} from './theme.js';
-import {Classic} from './theme/classic.js';
-import * as idGenerator from './utils/idgenerator.js';
-import type {Metrics} from './utils/metrics.js';
-import * as toolbox from './utils/toolbox.js';
-import type {WorkspaceSvg} from './workspace_svg.js';
-
-
-/**
- * Parse the user-specified options, using reasonable defaults where behaviour
- * is unspecified.
- * @alias Blockly.Options
- */
-export class Options {
-  RTL: boolean;
-  oneBasedIndex: boolean;
-  collapse: boolean;
-  comments: boolean;
-  disable: boolean;
-  readOnly: boolean;
-  maxBlocks: number;
-  maxInstances: {[key: string]: number}|null;
-  pathToMedia: string;
-  hasCategories: boolean;
-  moveOptions: MoveOptions;
-  hasScrollbars: boolean;
-  hasTrashcan: boolean;
-  maxTrashcanContents: number;
-  hasSounds: boolean;
-  hasCss: boolean;
-  horizontalLayout: boolean;
-  languageTree: toolbox.ToolboxInfo|null;
-  gridOptions: GridOptions;
-  zoomOptions: ZoomOptions;
-  toolboxPosition: toolbox.Position;
-  theme: Theme;
-  renderer: string;
-  rendererOverrides: {[rendererConstant: string]: any}|null;
-
-  /**
-   * The SVG element for the grid pattern.
-   * Created during injection.
-   */
-  gridPattern: SVGElement|null = null;
-  parentWorkspace: WorkspaceSvg|null;
-  plugins: {[key: string]: (new(...p1: any[]) => any)|string};
-
-  /**
-   * If set, sets the translation of the workspace to match the scrollbars.
-   * A function that
-   *     sets the translation of the workspace to match the scrollbars. The
-   *     argument Contains an x and/or y property which is a float between 0
-   *     and 1 specifying the degree of scrolling.
-   */
-  setMetrics?: ((p1: {x: number, y: number}) => void) = undefined;
-
-  /**
-   * A function that returns a metrics
-   *     object that describes the current workspace.
-   */
-  getMetrics?: (() => Metrics) = undefined;
-
-  /**
-   * @param options Dictionary of options.
-   *     Specification:
-   * https://developers.google.com/blockly/guides/get-started/web#configuration
-   */
-  constructor(options: BlocklyOptions) {
-    let toolboxJsonDef = null;
-    let hasCategories = false;
-    let hasTrashcan = false;
-    let hasCollapse = false;
-    let hasComments = false;
-    let hasDisable = false;
-    let hasSounds = false;
-    const readOnly = !!options['readOnly'];
-    if (!readOnly) {
-      toolboxJsonDef =
-          toolbox.convertToolboxDefToJson(options['toolbox'] ?? null);
-      hasCategories = toolbox.hasCategories(toolboxJsonDef);
-      const rawHasTrashcan = options['trashcan'];
-      hasTrashcan =
-          rawHasTrashcan === undefined ? hasCategories : rawHasTrashcan;
-      const rawHasCollapse = options['collapse'];
-      hasCollapse =
-          rawHasCollapse === undefined ? hasCategories : rawHasCollapse;
-      const rawHasComments = options['comments'];
-      hasComments =
-          rawHasComments === undefined ? hasCategories : rawHasComments;
-      const rawHasDisable = options['disable'];
-      hasDisable = rawHasDisable === undefined ? hasCategories : rawHasDisable;
-      const rawHasSounds = options['sounds'];
-      hasSounds = rawHasSounds === undefined ? true : rawHasSounds;
-    }
-
-    let maxTrashcanContents = options['maxTrashcanContents'];
-    if (hasTrashcan) {
-      if (maxTrashcanContents === undefined) {
-        maxTrashcanContents = 32;
-      }
-    } else {
-      maxTrashcanContents = 0;
-    }
-    const rtl = !!options['rtl'];
-    let horizontalLayout = options['horizontalLayout'];
-    if (horizontalLayout === undefined) {
-      horizontalLayout = false;
-    }
-    const toolboxAtStart = options['toolboxPosition'] !== 'end';
-
-    let toolboxPosition: toolbox.Position;
-    if (horizontalLayout) {
-      toolboxPosition =
-          toolboxAtStart ? toolbox.Position.TOP : toolbox.Position.BOTTOM;
-    } else {
-      toolboxPosition = toolboxAtStart === rtl ? toolbox.Position.RIGHT :
-                                                 toolbox.Position.LEFT;
-    }
-
-    let hasCss = options['css'];
-    if (hasCss === undefined) {
-      hasCss = true;
-    }
-    let pathToMedia = 'https://blockly-demo.appspot.com/static/media/';
-    if (options['media']) {
-      pathToMedia = options['media'].endsWith('/') ? options['media'] :
-                                                     options['media'] + '/';
-    } else if ('path' in options) {
-      // 'path' is a deprecated option which has been replaced by 'media'.
-      deprecation.warn('path', 'Nov 2014', 'Jul 2023', 'media');
-      pathToMedia = (options as any)['path'] + 'media/';
-    }
-    let oneBasedIndex;
-    const rawOneBasedIndex = options['oneBasedIndex'];
-    oneBasedIndex = rawOneBasedIndex === undefined ? true : rawOneBasedIndex;
-    const renderer = options['renderer'] || 'geras';
-
-    const plugins = options['plugins'] || {};
-
-    this.RTL = rtl;
-    this.oneBasedIndex = oneBasedIndex;
-    this.collapse = hasCollapse;
-    this.comments = hasComments;
-    this.disable = hasDisable;
-    this.readOnly = readOnly;
-    this.maxBlocks = options['maxBlocks'] || Infinity;
-    this.maxInstances = options['maxInstances'] ?? null;
-    this.pathToMedia = pathToMedia;
-    this.hasCategories = hasCategories;
-    this.moveOptions = Options.parseMoveOptions_(options, hasCategories);
-    /** @deprecated  January 2019 */
-    this.hasScrollbars = !!this.moveOptions.scrollbars;
-    this.hasTrashcan = hasTrashcan;
-    this.maxTrashcanContents = maxTrashcanContents;
-    this.hasSounds = hasSounds;
-    this.hasCss = hasCss;
-    this.horizontalLayout = horizontalLayout;
-    this.languageTree = toolboxJsonDef;
-    this.gridOptions = Options.parseGridOptions_(options);
-    this.zoomOptions = Options.parseZoomOptions_(options);
-    this.toolboxPosition = toolboxPosition;
-    this.theme = Options.parseThemeOptions_(options);
-    this.renderer = renderer;
-    this.rendererOverrides = options['rendererOverrides'] ?? null;
-
-    /**
-     * The parent of the current workspace, or null if there is no parent
-     * workspace.  We can assert that this is of type WorkspaceSvg as opposed to
-     * Workspace as this is only used in a rendered workspace.
-     */
-    this.parentWorkspace = options['parentWorkspace'] ?? null;
-
-    /** Map of plugin type to name of registered plugin or plugin class. */
-    this.plugins = plugins;
-  }
-
-  /**
-   * Parse the user-specified move options, using reasonable defaults where
-   *    behaviour is unspecified.
-   * @param options Dictionary of options.
-   * @param hasCategories Whether the workspace has categories or not.
-   * @return Normalized move options.
-   */
-  private static parseMoveOptions_(
-      options: BlocklyOptions, hasCategories: boolean): MoveOptions {
-    const move = options['move'] || {};
-    const moveOptions = {} as MoveOptions;
-    if (move['scrollbars'] === undefined &&
-        options['scrollbars'] === undefined) {
-      moveOptions.scrollbars = hasCategories;
-    } else if (typeof move['scrollbars'] === 'object') {
-      moveOptions.scrollbars = {
-        'horizontal': !!move['scrollbars']['horizontal'],
-        'vertical': !!move['scrollbars']['vertical'],
-      };
-      // Convert scrollbars object to boolean if they have the same value.
-      // This allows us to easily check for whether any scrollbars exist using
-      // !!moveOptions.scrollbars.
-      if (moveOptions.scrollbars.horizontal &&
-          moveOptions.scrollbars.vertical) {
-        moveOptions.scrollbars = true;
-      } else if (
-          !moveOptions.scrollbars.horizontal &&
-          !moveOptions.scrollbars.vertical) {
-        moveOptions.scrollbars = false;
-      }
-    } else {
-      moveOptions.scrollbars = !!move['scrollbars'] || !!options['scrollbars'];
-    }
-
-    if (!moveOptions.scrollbars || move['wheel'] === undefined) {
-      // Defaults to true if single-direction scroll is enabled.
-      moveOptions.wheel = typeof moveOptions.scrollbars === 'object';
-    } else {
-      moveOptions.wheel = !!move['wheel'];
-    }
-    if (!moveOptions.scrollbars) {
-      moveOptions.drag = false;
-    } else if (move['drag'] === undefined) {
-      // Defaults to true if scrollbars is true.
-      moveOptions.drag = true;
-    } else {
-      moveOptions.drag = !!move['drag'];
-    }
-    return moveOptions;
-  }
-
-  /**
-   * Parse the user-specified zoom options, using reasonable defaults where
-   * behaviour is unspecified.  See zoom documentation:
-   *   https://developers.google.com/blockly/guides/configure/web/zoom
-   * @param options Dictionary of options.
-   * @return Normalized zoom options.
-   */
-  private static parseZoomOptions_(options: BlocklyOptions): ZoomOptions {
-    const zoom = options['zoom'] || {};
-    const zoomOptions = {} as ZoomOptions;
-    if (zoom['controls'] === undefined) {
-      zoomOptions.controls = false;
-    } else {
-      zoomOptions.controls = !!zoom['controls'];
-    }
-    if (zoom['wheel'] === undefined) {
-      zoomOptions.wheel = false;
-    } else {
-      zoomOptions.wheel = !!zoom['wheel'];
-    }
-    if (zoom['startScale'] === undefined) {
-      zoomOptions.startScale = 1;
-    } else {
-      zoomOptions.startScale = Number(zoom['startScale']);
-    }
-    if (zoom['maxScale'] === undefined) {
-      zoomOptions.maxScale = 3;
-    } else {
-      zoomOptions.maxScale = Number(zoom['maxScale']);
-    }
-    if (zoom['minScale'] === undefined) {
-      zoomOptions.minScale = 0.3;
-    } else {
-      zoomOptions.minScale = Number(zoom['minScale']);
-    }
-    if (zoom['scaleSpeed'] === undefined) {
-      zoomOptions.scaleSpeed = 1.2;
-    } else {
-      zoomOptions.scaleSpeed = Number(zoom['scaleSpeed']);
-    }
-    if (zoom['pinch'] === undefined) {
-      zoomOptions.pinch = zoomOptions.wheel || zoomOptions.controls;
-    } else {
-      zoomOptions.pinch = !!zoom['pinch'];
-    }
-    return zoomOptions;
-  }
-
-  /**
-   * Parse the user-specified grid options, using reasonable defaults where
-   * behaviour is unspecified. See grid documentation:
-   *   https://developers.google.com/blockly/guides/configure/web/grid
-   * @param options Dictionary of options.
-   * @return Normalized grid options.
-   */
-  private static parseGridOptions_(options: BlocklyOptions): GridOptions {
-    const grid = options['grid'] || {};
-    const gridOptions = {} as GridOptions;
-    gridOptions.spacing = Number(grid['spacing']) || 0;
-    gridOptions.colour = grid['colour'] || '#888';
-    gridOptions.length =
-        grid['length'] === undefined ? 1 : Number(grid['length']);
-    gridOptions.snap = gridOptions.spacing > 0 && !!grid['snap'];
-    return gridOptions;
-  }
-
-  /**
-   * Parse the user-specified theme options, using the classic theme as a
-   * default. https://developers.google.com/blockly/guides/configure/web/themes
-   * @param options Dictionary of options.
-   * @return A Blockly Theme.
-   */
-  private static parseThemeOptions_(options: BlocklyOptions): Theme {
-    const theme = options['theme'] || Classic;
-    if (typeof theme === 'string') {
-      return registry.getObject(registry.Type.THEME, theme) as Theme;
-    } else if (theme instanceof Theme) {
-      return theme;
-    }
-    return Theme.defineTheme(
-        theme.name || 'builtin' + idGenerator.getNextUniqueId(), theme);
-  }
-}
-
-export namespace Options {
-  export interface GridOptions {
-    colour: string;
-    length: number;
-    snap: boolean;
-    spacing: number;
-  }
-
-  export interface MoveOptions {
-    drag: boolean;
-    scrollbars: boolean|ScrollbarOptions;
-    wheel: boolean;
-  }
-
-  export interface ScrollbarOptions {
-    horizontal: boolean;
-    vertical: boolean;
-  }
-
-  export interface ZoomOptions {
-    controls: boolean;
-    maxScale: number;
-    minScale: number;
-    pinch: boolean;
-    scaleSpeed: number;
-    startScale: number;
-    wheel: boolean;
-  }
-}
-
-export type GridOptions = Options.GridOptions;
-export type MoveOptions = Options.MoveOptions;
-export type ScrollbarOptions = Options.ScrollbarOptions;
-export type ZoomOptions = Options.ZoomOptions;