mirror of
https://github.com/google/blockly.git
synced 2026-01-06 00:20:37 +01:00
chore: Migrate core/ to Typescript, actually (#6299)
* fix: convert files to typescript * fix: add alias for AnyDuringMigration so that tsc will run * chore: format * chore: enable ts for the clang-format workflow (#6233) * chore: Restore @fileoverview comment locations (#6237) * chore: add declareModuleId (#6238) * fix: Revert comment change to app_controller.js (#6241) * fix: Add missing import goog statements (#6240) I've added the import statement immediately before the goog.declareModuleId calls that depend on it. There is an argument to be made that we should put the import statement in their normal place amongst any other imports, and move the declareModuleId statement to below the double blank line below the imports, but as these are so tightly coupled, replace the previous goog.module calls, and will both be deleted at the same time once the transition to TypeScript is fully complete I think it's fine (and certainly much easier) to do it this way. * chore: Fix whitespace (#6243) * fix: Remove spurious blank lines Remove extraneous blank lines introduced by deletion of 'use strict'; pragmas. Also fix the location of the goog.declareModuleId call in core/utils/array.ts. * fix: Add missing double-blank-line before body of modules Our convention is to have two blank lines between the imports (or module ID, if there are no imports) and the beginning of the body of the module. Enforce this. * fix: one addition format error for PR #6243 * fix(build): Skip npm prepare when running in CI (#6244) Have npm prepare do nothing when running in CI. We don't need to do any building, because npm test will build everything needed in the workflows in which it is run, and we don't want to build anything in other workflows because a tsc error would prevent those workflows from completing. * fix: re-add `@package` annotations as `@internal` annotations (#6232) * fix: add ~70% of internal attributes * fix: work on manually adding more @internal annotations * fix: add more manual internal annotations * fix: rename package typos to internal * fix: final manual fixes for internal annotations * chore: format * chore: make unnecessary multiline jsdoc a single line * fix: fix internal tags in serialization exceptions * fix: tsc errors picked up from develop (#6224) * fix: relative path for deprecation utils * fix: checking if properties exist in svg_math * fix: set all timeout PIDs to AnyDuringMigration * fix: make nullability errors explicity in block drag surface * fix: make null check in events_block_change explicit * fix: make getEventWorkspace_ internal so we can access it from CommentCreateDeleteHelper * fix: rename DIV -> containerDiv in tooltip * fix: ignore backwards compat check in category * fix: set block styles to AnyDuringMigration * fix: type typo in KeyboardShortcut * fix: constants name in row measurables * fix: typecast in mutator * fix: populateProcedures type of flattened array * fix: ignore errors related to workspace comment deserialization * chore: format files * fix: renaming imports missing file extensions * fix: remove check for sound.play * fix: temporarily remove bad requireType. All `export type` statements are stripped when tsc is run. This means that when we attempt to require BlockDefinition from the block files, we get an error because it does not exist. We decided to temporarily remove the require, because this will no longer be a problem when we conver the blocks to typescript, and everything gets compiled together. * fix: bad jsdoc in array * fix: silence missing property errors Closure was complaining about inexistant properties, but they actually do exist, they're just not being transpiled by tsc in a way that closure understands. I.E. if things are initialized in a function called by the constructor, rather than in a class field or in the custructor itself, closure would error. It would also error on enums, because they are transpiled to a weird IIFE. * fix: context menu action handler not knowing the type of this. this: TypeX information gets stripped when tsc is run, so closure could not know that this was not global. Fixed this by reorganizing to use the option object directly instead of passing it to onAction to be bound to this. * fix: readd getDeveloperVars checks (should not be part of migration) This was found because ALL_DEVELOPER_VARS_WARNINGS_BY_BLOCK_TYPE was no longer being accessed. * fix: silence closure errors about overriding supertype props We propertly define the overrides in typescript, but these get removed from the compiled output, so closure doesn't know they exist. * fix: silence globalThis errors this: TypeX annotations get stripped from the compiled output, so closure can't know that we're accessing the correct things. However, typescript makes sure that this always has the correct properties, so silencing this should be fine. * fix: bad jsdoc name * chore: attempt compiling with blockly.js * fix: attempt moving the import statement above the namespace line * chore: add todo comments to block def files * chore: remove todo from context menu * chore: add comments abotu disabled errors * chore: move comments back to their correct positions (#6249) * fix: work on fixing comments * chore: finish moving all comments * chore: format * chore: move some other messed up comments * chore: format * fix: Correct enum formatting, use merged `namespace`s for types that are class static members (#6246) * fix: formatting of enum KeyCodes * fix: Use merged namespace for ContextMenuRegistry static types - Create a namespace to be merged with the ContextMenuRegistry class containing the types that were formerly declared as static properties on that class. - Use type aliases to export them individually as well, for compatibility with the changes made by MigranTS (and/or @gonfunko) to how other modules in core/ now import these types. - Update renamings.json5 to reflect the availability of the direct exports for modules that import this module directly (though they are not available to, and will not be used by, code that imports only via blockly.js/blockly.ts.) * fix: Use merged namespace for Input.Align - Create a merged namespace for the Input.Align enum. - Use type/const aliases to export it as Input too. - Update renamings.json5 to reflect the availability of the direct export. * fix: Use merged namespace for Names.NameType - Create a merged namespace for the Names.NameType enum. - Use type/const aliases to export it as NameType too. - Update renamings.json5 to reflect the availability of the direct export. (This ought to have happened in an earlier version as it was already available by both routes.) * chore: Fix minor issues for PR #6246 - Use `Align` instead of `Input.Align` where possible. * fix(build): Suppress irrelevant JSC_UNUSED_LOCAL_ASSIGNMENT errors tsc generates code for merged namespaces that looks like: (function (ClassName) { let EnumName; (function (EnumName) { EnumName[EnumNameAlign["v1"] = 0] = "v1"; // etc. })(EnumName = ClassName.EnumName || (ClassName.EnumName = {})); })(ClassName || (ClassName = {})); and Closure Compiler complains about the fact that the EnumName let binding is initialised but never used. (It exists so that any other code that was in the namespace could see the enum.) Suppress this message, since it is not actionable and lint and/or tsc should tell us if we have actual unused variables in our .ts files. * chore(build): Suppress spurious warnings from closure-make-deps (#6253) A little bit of an ugly hack, but it works: pipe stderr through grep -v to suppress error output starting with "WARNING in". * fix: remaining enums that weren't properly exported (#6251) * fix: remaining enums that weren't properly exported * chore: format * fix: add enum value exports * chore: format * fix: properly export interfaces that were typedefs (#6250) * fix: properly export interfaces that were typedefs * fix: allowCollsion -> allowCollision * fix: convert unconverted enums * fix: enums that were/are instance properties * fix: revert changes to property enums * fix: renamed protected parameter properties (#6252) * fix: bad protected parameter properties * chore:format * fix: gesture constructor * fix: overridden properties that were renamed * refactor: Migrate `blockly.js` to TypeScript (#6261) * chore: Apply changes to blockly.js to blockly.ts * fix: Build using core/blockly.ts instead of .js Compiles and runs in compressed mode correctly! * fix(build): Don't depend on execSync running bash (#6262) For some reason on Github CI servers execSync uses /bin/sh, which is (on Ubuntu) dash rather than bash, and does not understand the pipefail option. So remove the grep pipe on stderr and just discard all error output at all. This is not ideal as errors in test deps will go unreported AND not even cause test failure, but it's not clear that it's worth investing more time to fix this at the moment. * chore: use `import type` where possible (#6279) * chore: automatically change imports to import types * chore: revert changes that actually need to be imports * chore: format * chore: add more import type statements based on importsNotUsedAsValues * chore: fix tsconfig * chore: add link to compiler issue * fix: add type information to blockly options (#6283) * fix: add type information to blockly options * chore: format * chore: remove erroneous comment * fix: bugs revealed by getting the built output working (#6282) * fix: types of compose and decompose in block * fix: workspace naming in toolbox * chore: add jsdoc * chore: restore registry comments to better positions * chore: pr comments' * fix(variables): Revert inadvertent change to allDeveloperVariables (#6290) It appears that a function call got modified incorrectly (probably in an effort to fix a typing issue). This fix trivially reverts the line in question to match the original JS version from develop. This causes the generator tests to pass. * fix: circular dependencies (#6281) * chore: fix circular dependencies w/ static workspace funcs * remove preserved imports that aren't currently necessary (probably) * fix circular dependency with workspaces and block using stub * fix dependency between variables and xml by moving function to utils * add stub for trashcan as well * fix line endings from rebase * fix goog/base order * add trashcan patch * fix: types of compose and decompose in block * fix: workspace naming in toolbox * chore: add jsdoc * chore: restore registry comments to better positions * chore: remove implementations in goog.js * chore: fix types of stubs * chore: remove added AnyDuringMigration casts * chore: remove modifications to xml and variables * chore: format * chore: remove event requirements in workspace comments * chore: fix circular dependency with xml and workspace comments * fixup remove ContextMenu import * chore: fix dependency between mutator and workspace * chore: break circular dependency between names and procedures * chore: get tests to run? * chore: pr comments' * chore: fix stubbing field registry fromJson * chore: fix spying on fire * chore: fix stubbing parts of connection checker * chore: fix stubbing dialog * chore: fix stubbing style * chore: fix spying on duplicate * chore: fix stubbing variables * chore: fix stubbing copy * chore: fix stubbing in workspace * chore: remove unnecessary stubs * chore: fix formatting * chore: fix other formatting * chore: add backwards compatible static properties to workspace * chore: move static type properties * chore: move and comment stubs * chore: add newlines at EOF * chore: improve errors for monkey patched functions * chore: update comment with a pointer to the doc * chore: update comment with a pointer to the doc * chore: format * chore: revert changes to playground used for testing (#6292) * chore: get mocha tests to pass. (#6291) * chore: fix undo and empty code blocks * chore: skip IE test * chore: fix gesture test * chore: fix replace message references test * chore: fix string table interpolation * chore: skip getById tests * chore: fix field tests * chore: fix console errors by making workspace nullable * chore: format * chore: fix definition overwrite warning * chore: update metadata * chore: temporarily modify the the advanced compile test * chore: fix gestures by fixing test instead Co-authored-by: Neil Fraser <fraser@google.com> Co-authored-by: Christopher Allen <cpcallen+git@google.com>
This commit is contained in:
Beka Westberg
GitHub
315
core/registry.ts
315
core/registry.ts
@@ -8,156 +8,118 @@
|
||||
* @fileoverview This file is a universal registry that provides generic methods
|
||||
* for registering and unregistering different types of classes.
|
||||
*/
|
||||
'use strict';
|
||||
|
||||
/**
|
||||
* This file is a universal registry that provides generic methods
|
||||
* for registering and unregistering different types of classes.
|
||||
* @namespace Blockly.registry
|
||||
*/
|
||||
goog.module('Blockly.registry');
|
||||
import * as goog from '../closure/goog/goog.js';
|
||||
goog.declareModuleId('Blockly.registry');
|
||||
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {Abstract} = goog.requireType('Blockly.Events.Abstract');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {Cursor} = goog.requireType('Blockly.Cursor');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {Field} = goog.requireType('Blockly.Field');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {IBlockDragger} = goog.requireType('Blockly.IBlockDragger');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {IConnectionChecker} = goog.requireType('Blockly.IConnectionChecker');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {IFlyout} = goog.requireType('Blockly.IFlyout');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {IMetricsManager} = goog.requireType('Blockly.IMetricsManager');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {ISerializer} = goog.requireType('Blockly.serialization.ISerializer');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {IToolbox} = goog.requireType('Blockly.IToolbox');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {Options} = goog.requireType('Blockly.Options');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {Renderer} = goog.requireType('Blockly.blockRendering.Renderer');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {Theme} = goog.requireType('Blockly.Theme');
|
||||
/* eslint-disable-next-line no-unused-vars */
|
||||
const {ToolboxItem} = goog.requireType('Blockly.ToolboxItem');
|
||||
import type {Abstract} from './events/events_abstract.js';
|
||||
import type {Field} from './field.js';
|
||||
import type {IBlockDragger} from './interfaces/i_block_dragger.js';
|
||||
import type {IConnectionChecker} from './interfaces/i_connection_checker.js';
|
||||
import type {IFlyout} from './interfaces/i_flyout.js';
|
||||
import type {IMetricsManager} from './interfaces/i_metrics_manager.js';
|
||||
import type {ISerializer} from './interfaces/i_serializer.js';
|
||||
import type {IToolbox} from './interfaces/i_toolbox.js';
|
||||
import type {Cursor} from './keyboard_nav/cursor.js';
|
||||
import type {Options} from './options.js';
|
||||
import type {Renderer} from './renderers/common/renderer.js';
|
||||
import type {Theme} from './theme.js';
|
||||
import type {ToolboxItem} from './toolbox/toolbox_item.js';
|
||||
|
||||
|
||||
/**
|
||||
* A map of maps. With the keys being the type and name of the class we are
|
||||
* registering and the value being the constructor function.
|
||||
* e.g. {'field': {'field_angle': Blockly.FieldAngle}}
|
||||
*
|
||||
* @type {!Object<string, !Object<string, (function(new:?)|!Object)>>}
|
||||
*/
|
||||
const typeMap = Object.create(null);
|
||||
exports.TEST_ONLY = {typeMap};
|
||||
const typeMap: {
|
||||
[key: string]:
|
||||
{[key: string]: (new () => AnyDuringMigration)|AnyDuringMigration}
|
||||
} = Object.create(null);
|
||||
export const TEST_ONLY = {typeMap};
|
||||
|
||||
/**
|
||||
* A map of maps. With the keys being the type and caseless name of the class we
|
||||
* are registring, and the value being the most recent cased name for that
|
||||
* registration.
|
||||
* @type {!Object<string, !Object<string, string>>}
|
||||
*/
|
||||
const nameMap = Object.create(null);
|
||||
const nameMap: {[key: string]: {[key: string]: string}} = Object.create(null);
|
||||
|
||||
/**
|
||||
* The string used to register the default class for a type of plugin.
|
||||
* @type {string}
|
||||
* @alias Blockly.registry.DEFAULT
|
||||
*/
|
||||
const DEFAULT = 'default';
|
||||
exports.DEFAULT = DEFAULT;
|
||||
export const DEFAULT = 'default';
|
||||
|
||||
/**
|
||||
* A name with the type of the element stored in the generic.
|
||||
* @template T
|
||||
* @alias Blockly.registry.Type
|
||||
*/
|
||||
class Type {
|
||||
/**
|
||||
* @param {string} name The name of the registry type.
|
||||
*/
|
||||
constructor(name) {
|
||||
/**
|
||||
* @type {string}
|
||||
* @private
|
||||
*/
|
||||
this.name_ = name;
|
||||
}
|
||||
export class Type<T> {
|
||||
/** @param name The name of the registry type. */
|
||||
constructor(private readonly name: string) {}
|
||||
|
||||
/**
|
||||
* Returns the name of the type.
|
||||
* @return {string} The name.
|
||||
* @return The name.
|
||||
*/
|
||||
toString() {
|
||||
return this.name_;
|
||||
toString(): string {
|
||||
return this.name;
|
||||
}
|
||||
|
||||
static CONNECTION_CHECKER = new Type<IConnectionChecker>('connectionChecker');
|
||||
|
||||
static CURSOR = new Type<Cursor>('cursor');
|
||||
|
||||
static EVENT = new Type<Abstract>('event');
|
||||
|
||||
static FIELD = new Type<Field>('field');
|
||||
|
||||
static RENDERER = new Type<Renderer>('renderer');
|
||||
|
||||
static TOOLBOX = new Type<IToolbox>('toolbox');
|
||||
|
||||
static THEME = new Type<Theme>('theme');
|
||||
|
||||
static TOOLBOX_ITEM = new Type<ToolboxItem>('toolboxItem');
|
||||
|
||||
static FLYOUTS_VERTICAL_TOOLBOX = new Type<IFlyout>('flyoutsVerticalToolbox');
|
||||
|
||||
static FLYOUTS_HORIZONTAL_TOOLBOX =
|
||||
new Type<IFlyout>('flyoutsHorizontalToolbox');
|
||||
|
||||
static METRICS_MANAGER = new Type<IMetricsManager>('metricsManager');
|
||||
|
||||
static BLOCK_DRAGGER = new Type<IBlockDragger>('blockDragger');
|
||||
|
||||
/** @internal */
|
||||
static SERIALIZER = new Type<ISerializer>('serializer');
|
||||
}
|
||||
exports.Type = Type;
|
||||
|
||||
|
||||
/** @type {!Type<IConnectionChecker>} */
|
||||
Type.CONNECTION_CHECKER = new Type('connectionChecker');
|
||||
|
||||
/** @type {!Type<Cursor>} */
|
||||
Type.CURSOR = new Type('cursor');
|
||||
|
||||
/** @type {!Type<Abstract>} */
|
||||
Type.EVENT = new Type('event');
|
||||
|
||||
/** @type {!Type<Field>} */
|
||||
Type.FIELD = new Type('field');
|
||||
|
||||
/** @type {!Type<Renderer>} */
|
||||
Type.RENDERER = new Type('renderer');
|
||||
|
||||
/** @type {!Type<IToolbox>} */
|
||||
Type.TOOLBOX = new Type('toolbox');
|
||||
|
||||
/** @type {!Type<Theme>} */
|
||||
Type.THEME = new Type('theme');
|
||||
|
||||
/** @type {!Type<ToolboxItem>} */
|
||||
Type.TOOLBOX_ITEM = new Type('toolboxItem');
|
||||
|
||||
/** @type {!Type<IFlyout>} */
|
||||
Type.FLYOUTS_VERTICAL_TOOLBOX = new Type('flyoutsVerticalToolbox');
|
||||
|
||||
/** @type {!Type<IFlyout>} */
|
||||
Type.FLYOUTS_HORIZONTAL_TOOLBOX = new Type('flyoutsHorizontalToolbox');
|
||||
|
||||
/** @type {!Type<IMetricsManager>} */
|
||||
Type.METRICS_MANAGER = new Type('metricsManager');
|
||||
|
||||
/** @type {!Type<IBlockDragger>} */
|
||||
Type.BLOCK_DRAGGER = new Type('blockDragger');
|
||||
|
||||
/**
|
||||
* @type {!Type<ISerializer>}
|
||||
* @package
|
||||
*/
|
||||
Type.SERIALIZER = new Type('serializer');
|
||||
|
||||
/**
|
||||
* Registers a class based on a type and name.
|
||||
* @param {string|!Type<T>} type The type of the plugin.
|
||||
* @param type The type of the plugin.
|
||||
* (e.g. Field, Renderer)
|
||||
* @param {string} name The plugin's name. (Ex. field_angle, geras)
|
||||
* @param {?function(new:T, ...?)|Object} registryItem The class or object to
|
||||
* register.
|
||||
* @param {boolean=} opt_allowOverrides True to prevent an error when overriding
|
||||
* an already registered item.
|
||||
* @param name The plugin's name. (Ex. field_angle, geras)
|
||||
* @param registryItem The class or object to register.
|
||||
* @param opt_allowOverrides True to prevent an error when overriding an already
|
||||
* registered item.
|
||||
* @throws {Error} if the type or name is empty, a name with the given type has
|
||||
* already been registered, or if the given class or object is not valid for
|
||||
* its type.
|
||||
* @template T
|
||||
* @alias Blockly.registry.register
|
||||
*/
|
||||
const register = function(type, name, registryItem, opt_allowOverrides) {
|
||||
if ((!(type instanceof Type) && typeof type !== 'string') ||
|
||||
export function register<T>(
|
||||
type: string|Type<T>, name: string,
|
||||
registryItem: (new (...p1: AnyDuringMigration[]) => T)|null|
|
||||
AnyDuringMigration,
|
||||
opt_allowOverrides?: boolean): void {
|
||||
if (!(type instanceof Type) && typeof type !== 'string' ||
|
||||
String(type).trim() === '') {
|
||||
throw Error(
|
||||
'Invalid type "' + type + '". The type must be a' +
|
||||
@@ -165,7 +127,7 @@ const register = function(type, name, registryItem, opt_allowOverrides) {
|
||||
}
|
||||
type = String(type).toLowerCase();
|
||||
|
||||
if ((typeof name !== 'string') || (name.trim() === '')) {
|
||||
if (typeof name !== 'string' || name.trim() === '') {
|
||||
throw Error(
|
||||
'Invalid name "' + name + '". The name must be a' +
|
||||
' non-empty string.');
|
||||
@@ -193,17 +155,16 @@ const register = function(type, name, registryItem, opt_allowOverrides) {
|
||||
}
|
||||
typeRegistry[caselessName] = registryItem;
|
||||
nameRegistry[caselessName] = name;
|
||||
};
|
||||
exports.register = register;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks the given registry item for properties that are required based on the
|
||||
* type.
|
||||
* @param {string} type The type of the plugin. (e.g. Field, Renderer)
|
||||
* @param {Function|Object} registryItem A class or object that we are checking
|
||||
* for the required properties.
|
||||
* @param type The type of the plugin. (e.g. Field, Renderer)
|
||||
* @param registryItem A class or object that we are checking for the required
|
||||
* properties.
|
||||
*/
|
||||
const validate = function(type, registryItem) {
|
||||
function validate(type: string, registryItem: Function|AnyDuringMigration) {
|
||||
switch (type) {
|
||||
case String(Type.FIELD):
|
||||
if (typeof registryItem.fromJson !== 'function') {
|
||||
@@ -211,17 +172,16 @@ const validate = function(type, registryItem) {
|
||||
}
|
||||
break;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Unregisters the registry item with the given type and name.
|
||||
* @param {string|!Type<T>} type The type of the plugin.
|
||||
* @param type The type of the plugin.
|
||||
* (e.g. Field, Renderer)
|
||||
* @param {string} name The plugin's name. (Ex. field_angle, geras)
|
||||
* @template T
|
||||
* @param name The plugin's name. (Ex. field_angle, geras)
|
||||
* @alias Blockly.registry.unregister
|
||||
*/
|
||||
const unregister = function(type, name) {
|
||||
export function unregister<T>(type: string|Type<T>, name: string) {
|
||||
type = String(type).toLowerCase();
|
||||
name = name.toLowerCase();
|
||||
const typeRegistry = typeMap[type];
|
||||
@@ -233,22 +193,22 @@ const unregister = function(type, name) {
|
||||
}
|
||||
delete typeMap[type][name];
|
||||
delete nameMap[type][name];
|
||||
};
|
||||
exports.unregister = unregister;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the registry item for the given name and type. This can be either a
|
||||
* class or an object.
|
||||
* @param {string|!Type<T>} type The type of the plugin.
|
||||
* @param type The type of the plugin.
|
||||
* (e.g. Field, Renderer)
|
||||
* @param {string} name The plugin's name. (Ex. field_angle, geras)
|
||||
* @param {boolean=} opt_throwIfMissing Whether or not to throw an error if we
|
||||
* are unable to find the plugin.
|
||||
* @return {?function(new:T, ...?)|Object} The class or object with the given
|
||||
* name and type or null if none exists.
|
||||
* @template T
|
||||
* @param name The plugin's name. (Ex. field_angle, geras)
|
||||
* @param opt_throwIfMissing Whether or not to throw an error if we are unable
|
||||
* to find the plugin.
|
||||
* @return The class or object with the given name and type or null if none
|
||||
* exists.
|
||||
*/
|
||||
const getItem = function(type, name, opt_throwIfMissing) {
|
||||
function getItem<T>(
|
||||
type: string|Type<T>, name: string, opt_throwIfMissing?: boolean):
|
||||
(new (...p1: AnyDuringMigration[]) => T)|null|AnyDuringMigration {
|
||||
type = String(type).toLowerCase();
|
||||
name = name.toLowerCase();
|
||||
const typeRegistry = typeMap[type];
|
||||
@@ -263,77 +223,74 @@ const getItem = function(type, name, opt_throwIfMissing) {
|
||||
return null;
|
||||
}
|
||||
return typeRegistry[name];
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether or not the registry contains an item with the given type and
|
||||
* name.
|
||||
* @param {string|!Type<T>} type The type of the plugin.
|
||||
* @param type The type of the plugin.
|
||||
* (e.g. Field, Renderer)
|
||||
* @param {string} name The plugin's name. (Ex. field_angle, geras)
|
||||
* @return {boolean} True if the registry has an item with the given type and
|
||||
* name, false otherwise.
|
||||
* @template T
|
||||
* @param name The plugin's name. (Ex. field_angle, geras)
|
||||
* @return True if the registry has an item with the given type and name, false
|
||||
* otherwise.
|
||||
* @alias Blockly.registry.hasItem
|
||||
*/
|
||||
const hasItem = function(type, name) {
|
||||
export function hasItem<T>(type: string|Type<T>, name: string): boolean {
|
||||
type = String(type).toLowerCase();
|
||||
name = name.toLowerCase();
|
||||
const typeRegistry = typeMap[type];
|
||||
if (!typeRegistry) {
|
||||
return false;
|
||||
}
|
||||
return !!(typeRegistry[name]);
|
||||
};
|
||||
exports.hasItem = hasItem;
|
||||
return !!typeRegistry[name];
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the class for the given name and type.
|
||||
* @param {string|!Type<T>} type The type of the plugin.
|
||||
* @param type The type of the plugin.
|
||||
* (e.g. Field, Renderer)
|
||||
* @param {string} name The plugin's name. (Ex. field_angle, geras)
|
||||
* @param {boolean=} opt_throwIfMissing Whether or not to throw an error if we
|
||||
* are unable to find the plugin.
|
||||
* @return {?function(new:T, ...?)} The class with the given name and type or
|
||||
* null if none exists.
|
||||
* @template T
|
||||
* @param name The plugin's name. (Ex. field_angle, geras)
|
||||
* @param opt_throwIfMissing Whether or not to throw an error if we are unable
|
||||
* to find the plugin.
|
||||
* @return The class with the given name and type or null if none exists.
|
||||
* @alias Blockly.registry.getClass
|
||||
*/
|
||||
const getClass = function(type, name, opt_throwIfMissing) {
|
||||
return /** @type {?function(new:T, ...?)} */ (
|
||||
getItem(type, name, opt_throwIfMissing));
|
||||
};
|
||||
exports.getClass = getClass;
|
||||
export function getClass<T>(
|
||||
type: string|Type<T>, name: string, opt_throwIfMissing?: boolean):
|
||||
(new (...p1: AnyDuringMigration[]) => T)|null {
|
||||
return getItem(type, name, opt_throwIfMissing) as (
|
||||
new (...p1: AnyDuringMigration[]) => T) |
|
||||
null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the object for the given name and type.
|
||||
* @param {string|!Type<T>} type The type of the plugin.
|
||||
* @param type The type of the plugin.
|
||||
* (e.g. Category)
|
||||
* @param {string} name The plugin's name. (Ex. logic_category)
|
||||
* @param {boolean=} opt_throwIfMissing Whether or not to throw an error if we
|
||||
* are unable to find the object.
|
||||
* @return {?T} The object with the given name and type or null if none exists.
|
||||
* @template T
|
||||
* @param name The plugin's name. (Ex. logic_category)
|
||||
* @param opt_throwIfMissing Whether or not to throw an error if we are unable
|
||||
* to find the object.
|
||||
* @return The object with the given name and type or null if none exists.
|
||||
* @alias Blockly.registry.getObject
|
||||
*/
|
||||
const getObject = function(type, name, opt_throwIfMissing) {
|
||||
return /** @type {T} */ (getItem(type, name, opt_throwIfMissing));
|
||||
};
|
||||
exports.getObject = getObject;
|
||||
export function getObject<T>(
|
||||
type: string|Type<T>, name: string, opt_throwIfMissing?: boolean): T|null {
|
||||
return getItem(type, name, opt_throwIfMissing) as T;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a map of items registered with the given type.
|
||||
* @param {string|!Type<T>} type The type of the plugin. (e.g. Category)
|
||||
* @param {boolean} opt_cased Whether or not to return a map with cased keys
|
||||
* (rather than caseless keys). False by default.
|
||||
* @param {boolean=} opt_throwIfMissing Whether or not to throw an error if we
|
||||
* are unable to find the object. False by default.
|
||||
* @return {?Object<string, ?T|?function(new:T, ...?)>} A map of objects with
|
||||
* the given type, or null if none exists.
|
||||
* @template T
|
||||
* @param type The type of the plugin. (e.g. Category)
|
||||
* @param opt_cased Whether or not to return a map with cased keys (rather than
|
||||
* caseless keys). False by default.
|
||||
* @param opt_throwIfMissing Whether or not to throw an error if we are unable
|
||||
* to find the object. False by default.
|
||||
* @return A map of objects with the given type, or null if none exists.
|
||||
* @alias Blockly.registry.getAllItems
|
||||
*/
|
||||
const getAllItems = function(type, opt_cased, opt_throwIfMissing) {
|
||||
export function getAllItems<T>(
|
||||
type: string|Type<T>, opt_cased: boolean, opt_throwIfMissing?: boolean):
|
||||
{[key: string]: T|null|(new (...p1: AnyDuringMigration[]) => T)}|null {
|
||||
type = String(type).toLowerCase();
|
||||
const typeRegistry = typeMap[type];
|
||||
if (!typeRegistry) {
|
||||
@@ -356,22 +313,21 @@ const getAllItems = function(type, opt_cased, opt_throwIfMissing) {
|
||||
casedRegistry[nameRegistry[key]] = typeRegistry[key];
|
||||
}
|
||||
return casedRegistry;
|
||||
};
|
||||
exports.getAllItems = getAllItems;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the class from Blockly options for the given type.
|
||||
* This is used for plugins that override a built in feature. (e.g. Toolbox)
|
||||
* @param {!Type<T>} type The type of the plugin.
|
||||
* @param {!Options} options The option object to check for the given
|
||||
* plugin.
|
||||
* @param {boolean=} opt_throwIfMissing Whether or not to throw an error if we
|
||||
* are unable to find the plugin.
|
||||
* @return {?function(new:T, ...?)} The class for the plugin.
|
||||
* @template T
|
||||
* @param type The type of the plugin.
|
||||
* @param options The option object to check for the given plugin.
|
||||
* @param opt_throwIfMissing Whether or not to throw an error if we are unable
|
||||
* to find the plugin.
|
||||
* @return The class for the plugin.
|
||||
* @alias Blockly.registry.getClassFromOptions
|
||||
*/
|
||||
const getClassFromOptions = function(type, options, opt_throwIfMissing) {
|
||||
export function getClassFromOptions<T>(
|
||||
type: Type<T>, options: Options, opt_throwIfMissing?: boolean):
|
||||
(new (...p1: AnyDuringMigration[]) => T)|null {
|
||||
const typeName = type.toString();
|
||||
const plugin = options.plugins[typeName] || DEFAULT;
|
||||
|
||||
@@ -380,5 +336,4 @@ const getClassFromOptions = function(type, options, opt_throwIfMissing) {
|
||||
return plugin;
|
||||
}
|
||||
return getClass(type, plugin, opt_throwIfMissing);
|
||||
};
|
||||
exports.getClassFromOptions = getClassFromOptions;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user