blockly 12.4.0 → 12.5.0

package/core/utils/keycodes.ts

@@ -1,154 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.utils.KeyCodes
-
-/* eslint-disable @typescript-eslint/no-duplicate-enum-values */
-
-/**
- * Key codes for common characters.
- *
- * Copied from Closure's goog.events.KeyCodes
- *
- * This list is not localized and therefore some of the key codes are not
- * correct for non US keyboard layouts. See comments below.
- */
-export enum KeyCodes {
-  WIN_KEY_FF_LINUX = 0,
-  MAC_ENTER = 3,
-  BACKSPACE = 8,
-  TAB = 9,
-  NUM_CENTER = 12, // NUMLOCK on FF/Safari Mac
-  ENTER = 13,
-  SHIFT = 16,
-  CTRL = 17,
-  ALT = 18,
-  PAUSE = 19,
-  CAPS_LOCK = 20,
-  ESC = 27,
-  SPACE = 32,
-  PAGE_UP = 33, // also NUM_NORTH_EAST
-  PAGE_DOWN = 34, // also NUM_SOUTH_EAST
-  END = 35, // also NUM_SOUTH_WEST
-  HOME = 36, // also NUM_NORTH_WEST
-  LEFT = 37, // also NUM_WEST
-  UP = 38, // also NUM_NORTH
-  RIGHT = 39, // also NUM_EAST
-  DOWN = 40, // also NUM_SOUTH
-  PLUS_SIGN = 43, // NOT numpad plus
-  PRINT_SCREEN = 44,
-  INSERT = 45, // also NUM_INSERT
-  DELETE = 46, // also NUM_DELETE
-  ZERO = 48,
-  ONE = 49,
-  TWO = 50,
-  THREE = 51,
-  FOUR = 52,
-  FIVE = 53,
-  SIX = 54,
-  SEVEN = 55,
-  EIGHT = 56,
-  NINE = 57,
-  FF_SEMICOLON = 59, // Firefox (Gecko) fires this for semicolon instead of 186
-  FF_EQUALS = 61, // Firefox (Gecko) fires this for equals instead of 187
-  FF_DASH = 173, // Firefox (Gecko) fires this for dash instead of 189
-  // Firefox (Gecko) fires this for # on UK keyboards, rather than
-  // Shift+SINGLE_QUOTE.
-  FF_HASH = 163,
-  QUESTION_MARK = 63, // needs localization
-  AT_SIGN = 64,
-  A = 65,
-  B = 66,
-  C = 67,
-  D = 68,
-  E = 69,
-  F = 70,
-  G = 71,
-  H = 72,
-  I = 73,
-  J = 74,
-  K = 75,
-  L = 76,
-  M = 77,
-  N = 78,
-  O = 79,
-  P = 80,
-  Q = 81,
-  R = 82,
-  S = 83,
-  T = 84,
-  U = 85,
-  V = 86,
-  W = 87,
-  X = 88,
-  Y = 89,
-  Z = 90,
-  META = 91, // WIN_KEY_LEFT
-  WIN_KEY_RIGHT = 92,
-  CONTEXT_MENU = 93,
-  NUM_ZERO = 96,
-  NUM_ONE = 97,
-  NUM_TWO = 98,
-  NUM_THREE = 99,
-  NUM_FOUR = 100,
-  NUM_FIVE = 101,
-  NUM_SIX = 102,
-  NUM_SEVEN = 103,
-  NUM_EIGHT = 104,
-  NUM_NINE = 105,
-  NUM_MULTIPLY = 106,
-  NUM_PLUS = 107,
-  NUM_MINUS = 109,
-  NUM_PERIOD = 110,
-  NUM_DIVISION = 111,
-  F1 = 112,
-  F2 = 113,
-  F3 = 114,
-  F4 = 115,
-  F5 = 116,
-  F6 = 117,
-  F7 = 118,
-  F8 = 119,
-  F9 = 120,
-  F10 = 121,
-  F11 = 122,
-  F12 = 123,
-  NUMLOCK = 144,
-  SCROLL_LOCK = 145,
-
-  // OS-specific media keys like volume controls and browser controls.
-  FIRST_MEDIA_KEY = 166,
-  LAST_MEDIA_KEY = 183,
-
-  SEMICOLON = 186, // needs localization
-  DASH = 189, // needs localization
-  EQUALS = 187, // needs localization
-  COMMA = 188, // needs localization
-  PERIOD = 190, // needs localization
-  SLASH = 191, // needs localization
-  APOSTROPHE = 192, // needs localization
-  TILDE = 192, // needs localization
-  SINGLE_QUOTE = 222, // needs localization
-  OPEN_SQUARE_BRACKET = 219, // needs localization
-  BACKSLASH = 220, // needs localization
-  CLOSE_SQUARE_BRACKET = 221, // needs localization
-  WIN_KEY = 224,
-  MAC_FF_META = 224, // Firefox (Gecko) fires this for the meta key instead of 91
-  MAC_WK_CMD_LEFT = 91, // WebKit Left Command key fired, same as META
-  MAC_WK_CMD_RIGHT = 93, // WebKit Right Command key fired, different from META
-  WIN_IME = 229,
-
-  // "Reserved for future use". Some programs (e.g. the SlingPlayer 2.4 ActiveX
-  // control) fire this as a hacky way to disable screensavers.
-  VK_NONAME = 252,
-
-  // We've seen users whose machines fire this keycode at regular one
-  // second intervals. The common thread among these users is that
-  // they're all using Dell Inspiron laptops, so we suspect that this
-  // indicates a hardware/bios problem.
-  // http://en.community.dell.com/support-forums/laptop/f/3518/p/19285957/19523128.aspx
-  PHANTOM = 255,
-}

package/core/utils/math.ts

@@ -1,50 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.utils.math
-
-/**
- * Converts degrees to radians.
- * Copied from Closure's goog.math.toRadians.
- *
- * @param angleDegrees Angle in degrees.
- * @returns Angle in radians.
- */
-export function toRadians(angleDegrees: number): number {
-  return (angleDegrees * Math.PI) / 180;
-}
-
-/**
- * Converts radians to degrees.
- * Copied from Closure's goog.math.toDegrees.
- *
- * @param angleRadians Angle in radians.
- * @returns Angle in degrees.
- */
-export function toDegrees(angleRadians: number): number {
-  return (angleRadians * 180) / Math.PI;
-}
-
-/**
- * Clamp the provided number between the lower bound and the upper bound.
- *
- * @param lowerBound The desired lower bound.
- * @param number The number to clamp.
- * @param upperBound The desired upper bound.
- * @returns The clamped number.
- */
-export function clamp(
-  lowerBound: number,
-  number: number,
-  upperBound: number,
-): number {
-  if (upperBound < lowerBound) {
-    const temp = upperBound;
-    upperBound = lowerBound;
-    lowerBound = temp;
-  }
-  return Math.max(lowerBound, Math.min(number, upperBound));
-}

package/core/utils/metrics.ts

@@ -1,86 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.utils.Metrics
-
-export interface Metrics {
-  /** Height of the visible portion of the workspace. */
-  viewHeight: number;
-
-  /** Width of the visible portion of the workspace. */
-  viewWidth: number;
-
-  /** Height of the content. */
-  contentHeight: number;
-
-  /** Width of the content. */
-  contentWidth: number;
-
-  /** Height of the scroll area. */
-  scrollHeight: number;
-
-  /** Width of the scroll area. */
-  scrollWidth: number;
-
-  /**
-   * Top-edge of the visible portion of the workspace, relative to the workspace
-   * origin.
-   */
-  viewTop: number;
-
-  /**
-   * Left-edge of the visible portion of the workspace, relative to the
-   * workspace origin.
-   */
-  viewLeft: number;
-
-  /** Top-edge of the content, relative to the workspace origin. */
-  contentTop: number;
-
-  /** Left-edge of the content relative to the workspace origin. */
-  contentLeft: number;
-
-  /** Top-edge of the scroll area, relative to the workspace origin. */
-  scrollTop: number;
-
-  /** Left-edge of the scroll area relative to the workspace origin. */
-  scrollLeft: number;
-
-  /**
-   * Top-edge of the visible portion of the workspace, relative to the
-   * blocklyDiv.
-   */
-  absoluteTop: number;
-
-  /**
-   * Left-edge of the visible portion of the workspace, relative to the
-   * blocklyDiv.
-   */
-  absoluteLeft: number;
-
-  /**
-   * Height of the Blockly div (the view + the toolbox, simple of otherwise).
-   */
-  svgHeight: number;
-
-  /** Width of the Blockly div (the view + the toolbox, simple or otherwise). */
-  svgWidth: number;
-
-  /** Width of the toolbox, if it exists.  Otherwise zero. */
-  toolboxWidth: number;
-
-  /** Height of the toolbox, if it exists.  Otherwise zero. */
-  toolboxHeight: number;
-
-  /** Top, bottom, left or right. Use TOOLBOX_AT constants to compare. */
-  toolboxPosition: number;
-
-  /** Width of the flyout if it is always open.  Otherwise zero. */
-  flyoutWidth: number;
-
-  /** Height of the flyout if it is always open.  Otherwise zero. */
-  flyoutHeight: number;
-}

package/core/utils/object.ts

@@ -1,33 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.utils.object
-
-/**
- * Complete a deep merge of all members of a source object with a target object.
- *
- * N.B. This is not a very sophisticated merge algorithm and does not
- * handle complex cases. Use with caution.
- *
- * @param target Target.
- * @param source Source.
- * @returns The resulting object.
- */
-export function deepMerge(
-  target: AnyDuringMigration,
-  source: AnyDuringMigration,
-): AnyDuringMigration {
-  for (const x in source) {
-    if (source[x] !== null && Array.isArray(source[x])) {
-      target[x] = deepMerge(target[x] || [], source[x]);
-    } else if (source[x] !== null && typeof source[x] === 'object') {
-      target[x] = deepMerge(target[x] || Object.create(null), source[x]);
-    } else {
-      target[x] = source[x];
-    }
-  }
-  return target;
-}

package/core/utils/parsing.ts

@@ -1,286 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-// Former goog.module ID: Blockly.utils.parsing
-
-import {Msg} from '../msg.js';
-import * as colourUtils from './colour.js';
-
-/**
- * Internal implementation of the message reference and interpolation token
- * parsing used by tokenizeInterpolation() and replaceMessageReferences().
- *
- * @param message Text which might contain string table references and
- *     interpolation tokens.
- * @param parseInterpolationTokens Option to parse numeric interpolation
- *     tokens (%1, %2, ...) when true.
- * @param tokenizeNewlines Split individual newline characters into separate
- *     tokens when true.
- * @returns Array of strings and numbers.
- */
-function tokenizeInterpolationInternal(
-  message: string,
-  parseInterpolationTokens: boolean,
-  tokenizeNewlines: boolean,
-): (string | number)[] {
-  const tokens = [];
-  const chars = message.split('');
-  chars.push(''); // End marker.
-  // Parse the message with a finite state machine.
-  // 0 - Base case.
-  // 1 - % found.
-  // 2 - Digit found.
-  // 3 - Message ref found.
-  let state = 0;
-  const buffer = new Array<string>();
-  let number = null;
-  for (let i = 0; i < chars.length; i++) {
-    const c = chars[i];
-    if (state === 0) {
-      // Start escape.
-      if (c === '%') {
-        const text = buffer.join('');
-        if (text) {
-          tokens.push(text);
-        }
-        buffer.length = 0;
-        state = 1;
-      } else if (tokenizeNewlines && c === '\n') {
-        // Output newline characters as single-character tokens, to be replaced
-        // with endOfRow dummies during interpolation.
-        const text = buffer.join('');
-        if (text) {
-          tokens.push(text);
-        }
-        buffer.length = 0;
-        tokens.push(c);
-      } else {
-        buffer.push(c); // Regular char.
-      }
-    } else if (state === 1) {
-      if (c === '%') {
-        buffer.push(c); // Escaped %: %%
-        state = 0;
-      } else if (parseInterpolationTokens && '0' <= c && c <= '9') {
-        state = 2;
-        number = c;
-        const text = buffer.join('');
-        if (text) {
-          tokens.push(text);
-        }
-        buffer.length = 0;
-      } else if (c === '{') {
-        state = 3;
-      } else {
-        buffer.push('%', c); // Not recognized. Return as literal.
-        state = 0;
-      }
-    } else if (state === 2) {
-      if ('0' <= c && c <= '9') {
-        number += c; // Multi-digit number.
-      } else {
-        tokens.push(parseInt(number ?? '', 10));
-        i--; // Parse this char again.
-        state = 0;
-      }
-    } else if (state === 3) {
-      // String table reference
-      if (c === '') {
-        // Premature end before closing '}'
-        buffer.splice(0, 0, '%{'); // Re-insert leading delimiter
-        i--; // Parse this char again.
-        state = 0; // and parse as string literal.
-      } else if (c !== '}') {
-        buffer.push(c);
-      } else {
-        const rawKey = buffer.join('');
-        if (/[A-Z]\w*/i.test(rawKey)) {
-          // Strict matching
-          // Found a valid string key. Attempt case insensitive match.
-          const keyUpper = rawKey.toUpperCase();
-
-          // BKY_ is the prefix used to namespace the strings used in
-          // Blockly core files and the predefined blocks in ../blocks/.
-          // These strings are defined in ../msgs/ files.
-          const bklyKey = keyUpper.startsWith('BKY_')
-            ? keyUpper.substring(4)
-            : null;
-          if (bklyKey && bklyKey in Msg) {
-            const rawValue = Msg[bklyKey];
-            if (typeof rawValue === 'string') {
-              // Attempt to dereference substrings, too, appending to the
-              // end.
-              Array.prototype.push.apply(
-                tokens,
-                tokenizeInterpolationInternal(
-                  rawValue,
-                  parseInterpolationTokens,
-                  tokenizeNewlines,
-                ),
-              );
-            } else if (parseInterpolationTokens) {
-              // When parsing interpolation tokens, numbers are special
-              // placeholders (%1, %2, etc). Make sure all other values are
-              // strings.
-              tokens.push(`${rawValue}`);
-            } else {
-              tokens.push(rawValue);
-            }
-          } else {
-            // No entry found in the string table. Pass reference as string.
-            tokens.push('%{' + rawKey + '}');
-          }
-          buffer.length = 0; // Clear the array
-          state = 0;
-        } else {
-          tokens.push('%{' + rawKey + '}');
-          buffer.length = 0;
-          state = 0; // and parse as string literal.
-        }
-      }
-    }
-  }
-  let text = buffer.join('');
-  if (text) {
-    tokens.push(text);
-  }
-
-  // Merge adjacent text tokens into a single string (but if newlines should be
-  // tokenized, don't merge those with adjacent text).
-  const mergedTokens = [];
-  buffer.length = 0;
-  for (let i = 0; i < tokens.length; i++) {
-    if (
-      typeof tokens[i] === 'string' &&
-      !(tokenizeNewlines && tokens[i] === '\n')
-    ) {
-      buffer.push(tokens[i] as string);
-    } else {
-      text = buffer.join('');
-      if (text) {
-        mergedTokens.push(text);
-      }
-      buffer.length = 0;
-      mergedTokens.push(tokens[i]);
-    }
-  }
-  text = buffer.join('');
-  if (text) {
-    mergedTokens.push(text);
-  }
-  buffer.length = 0;
-
-  return mergedTokens;
-}
-
-/**
- * Parse a string with any number of interpolation tokens (%1, %2, ...).
- * It will also replace string table references (e.g., %{bky_my_msg} and
- * %{BKY_MY_MSG} will both be replaced with the value in
- * Msg['MY_MSG']). Percentage sign characters '%' may be self-escaped
- * (e.g., '%%'). Newline characters will also be output as string tokens
- * containing a single newline character.
- *
- * @param message Text which might contain string table references and
- *     interpolation tokens.
- * @returns Array of strings and numbers.
- */
-export function tokenizeInterpolation(message: string): (string | number)[] {
-  return tokenizeInterpolationInternal(message, true, true);
-}
-
-/**
- * Replaces string table references in a message, if the message is a string.
- * For example, "%{bky_my_msg}" and "%{BKY_MY_MSG}" will both be replaced with
- * the value in Msg['MY_MSG'].
- *
- * @param message Message, which may be a string that contains
- *     string table references.
- * @returns String with message references replaced.
- */
-export function replaceMessageReferences(message: string | any): string {
-  if (typeof message !== 'string') {
-    return message;
-  }
-  const interpolatedResult = tokenizeInterpolationInternal(
-    message,
-    false,
-    false,
-  );
-  // When parseInterpolationTokens and tokenizeNewlines are false,
-  // interpolatedResult should be at most length 1.
-  return interpolatedResult.length ? String(interpolatedResult[0]) : '';
-}
-
-/**
- * Validates that any %{MSG_KEY} references in the message refer to keys of
- * the Msg string table.
- *
- * @param message Text which might contain string table references.
- * @returns True if all message references have matching values.
- *     Otherwise, false.
- */
-export function checkMessageReferences(message: string): boolean {
-  let validSoFar = true;
-
-  const msgTable = Msg;
-  // TODO (#1169): Implement support for other string tables,
-  // prefixes other than BKY_.
-  const m = message.match(/%{BKY_[A-Z]\w*}/gi);
-  if (m) {
-    for (let i = 0; i < m.length; i++) {
-      const msgKey = m[i].toUpperCase();
-      if (msgTable[msgKey.slice(6, -1)] === undefined) {
-        console.warn('No message string for ' + m[i] + ' in ' + message);
-        validSoFar = false; // Continue to report other errors.
-      }
-    }
-  }
-
-  return validSoFar;
-}
-
-/**
- * Parse a block colour from a number or string, as provided in a block
- * definition.
- *
- * @param colour HSV hue value (0 to 360), #RRGGBB string,
- *     or a message reference string pointing to one of those two values.
- * @returns An object containing the colour as
- *     a #RRGGBB string, and the hue if the input was an HSV hue value.
- * @throws {Error} If the colour cannot be parsed.
- */
-export function parseBlockColour(colour: number | string): {
-  hue: number | null;
-  hex: string;
-} {
-  const dereferenced =
-    typeof colour === 'string' ? replaceMessageReferences(colour) : colour;
-
-  const hue = Number(dereferenced);
-  if (!isNaN(hue) && 0 <= hue && hue <= 360) {
-    return {
-      hue: hue,
-      hex: colourUtils.hsvToHex(
-        hue,
-        colourUtils.getHsvSaturation(),
-        colourUtils.getHsvValue() * 255,
-      ),
-    };
-  } else {
-    const hex = colourUtils.parse(dereferenced);
-    if (hex) {
-      // Only store hue if colour is set as a hue.
-      return {hue: null, hex: hex};
-    } else {
-      let errorMsg = 'Invalid colour: "' + dereferenced + '"';
-      if (colour !== dereferenced) {
-        errorMsg += ' (from "' + colour + '")';
-      }
-      throw Error(errorMsg);
-    }
-  }
-}