From 468360873f9694711816b3b4049d09bd78b54e9c Mon Sep 17 00:00:00 2001 From: kozbial Date: Mon, 2 Aug 2021 12:51:28 -0700 Subject: [PATCH] Migrate core/options.js and core/blockly_options.js to goog.module --- core/blockly_options.js | 7 ++++-- core/options.js | 56 ++++++++++++++++++++++------------------- tests/deps.js | 4 +-- 3 files changed, 37 insertions(+), 30 deletions(-) diff --git a/core/blockly_options.js b/core/blockly_options.js index d2964385f..3c93f8784 100644 --- a/core/blockly_options.js +++ b/core/blockly_options.js @@ -10,7 +10,8 @@ */ 'use strict'; -goog.provide('Blockly.BlocklyOptions'); +goog.module('Blockly.BlocklyOptions'); +goog.module.declareLegacyNamespace(); /** * Blockly options. @@ -18,4 +19,6 @@ goog.provide('Blockly.BlocklyOptions'); * `typings/parts/blockly-interfaces.d.ts`. * @interface */ -Blockly.BlocklyOptions = function() {}; +const BlocklyOptions = function() {}; + +exports = BlocklyOptions; diff --git a/core/options.js b/core/options.js index 5dd8c24e6..2f2836f07 100644 --- a/core/options.js +++ b/core/options.js @@ -10,16 +10,18 @@ */ 'use strict'; -goog.provide('Blockly.Options'); +goog.module('Blockly.Options'); +goog.module.declareLegacyNamespace(); goog.require('Blockly.registry'); goog.require('Blockly.Theme'); goog.require('Blockly.Themes.Classic'); +goog.require('Blockly.utils.deprecation'); goog.require('Blockly.utils.IdGenerator'); -goog.require('Blockly.utils.Metrics'); goog.require('Blockly.utils.toolbox'); goog.requireType('Blockly.BlocklyOptions'); +goog.requireType('Blockly.utils.Metrics'); goog.requireType('Blockly.WorkspaceSvg'); @@ -30,7 +32,7 @@ goog.requireType('Blockly.WorkspaceSvg'); * Specification: https://developers.google.com/blockly/guides/get-started/web#configuration * @constructor */ -Blockly.Options = function(options) { +const Options = function(options) { let toolboxJsonDef = null; let hasCategories = false; let hasTrashcan = false; @@ -131,8 +133,8 @@ Blockly.Options = function(options) { this.pathToMedia = pathToMedia; /** @type {boolean} */ this.hasCategories = hasCategories; - /** @type {!Blockly.Options.MoveOptions} */ - this.moveOptions = Blockly.Options.parseMoveOptions_(options, hasCategories); + /** @type {!Options.MoveOptions} */ + this.moveOptions = Options.parseMoveOptions_(options, hasCategories); /** @deprecated January 2019 */ this.hasScrollbars = !!this.moveOptions.scrollbars; /** @type {boolean} */ @@ -147,14 +149,14 @@ Blockly.Options = function(options) { this.horizontalLayout = horizontalLayout; /** @type {?Blockly.utils.toolbox.ToolboxInfo} */ this.languageTree = toolboxJsonDef; - /** @type {!Blockly.Options.GridOptions} */ - this.gridOptions = Blockly.Options.parseGridOptions_(options); - /** @type {!Blockly.Options.ZoomOptions} */ - this.zoomOptions = Blockly.Options.parseZoomOptions_(options); + /** @type {!Options.GridOptions} */ + this.gridOptions = Options.parseGridOptions_(options); + /** @type {!Options.ZoomOptions} */ + this.zoomOptions = Options.parseZoomOptions_(options); /** @type {!Blockly.utils.toolbox.Position} */ this.toolboxPosition = toolboxPosition; /** @type {!Blockly.Theme} */ - this.theme = Blockly.Options.parseThemeOptions_(options); + this.theme = Options.parseThemeOptions_(options); /** @type {string} */ this.renderer = renderer; /** @type {?Object} */ @@ -191,17 +193,17 @@ Blockly.Options = function(options) { * spacing: number * }} */ -Blockly.Options.GridOptions; +Options.GridOptions; /** * Move Options. * @typedef {{ * drag: boolean, - * scrollbars: (boolean | !Blockly.Options.ScrollbarOptions), + * scrollbars: (boolean | !Options.ScrollbarOptions), * wheel: boolean * }} */ -Blockly.Options.MoveOptions; +Options.MoveOptions; /** * Scrollbar Options. @@ -210,7 +212,7 @@ Blockly.Options.MoveOptions; * vertical: boolean * }} */ -Blockly.Options.ScrollbarOptions; +Options.ScrollbarOptions; /** * Zoom Options. @@ -224,7 +226,7 @@ Blockly.Options.ScrollbarOptions; * wheel: boolean * }} */ -Blockly.Options.ZoomOptions; +Options.ZoomOptions; /** * If set, sets the translation of the workspace to match the scrollbars. @@ -232,23 +234,23 @@ Blockly.Options.ZoomOptions; * is a float between 0 and 1 specifying the degree of scrolling. * @return {void} */ -Blockly.Options.prototype.setMetrics; +Options.prototype.setMetrics; /** * Return an object with the metrics required to size the workspace. * @return {!Blockly.utils.Metrics} Contains size and position metrics. */ -Blockly.Options.prototype.getMetrics; +Options.prototype.getMetrics; /** * Parse the user-specified move options, using reasonable defaults where * behaviour is unspecified. * @param {!Object} options Dictionary of options. * @param {boolean} hasCategories Whether the workspace has categories or not. - * @return {!Blockly.Options.MoveOptions} Normalized move options. + * @return {!Options.MoveOptions} Normalized move options. * @private */ -Blockly.Options.parseMoveOptions_ = function(options, hasCategories) { +Options.parseMoveOptions_ = function(options, hasCategories) { const move = options['move'] || {}; const moveOptions = {}; if (move['scrollbars'] === undefined && options['scrollbars'] === undefined) { @@ -292,10 +294,10 @@ Blockly.Options.parseMoveOptions_ = function(options, hasCategories) { * behaviour is unspecified. See zoom documentation: * https://developers.google.com/blockly/guides/configure/web/zoom * @param {!Object} options Dictionary of options. - * @return {!Blockly.Options.ZoomOptions} Normalized zoom options. + * @return {!Options.ZoomOptions} Normalized zoom options. * @private */ -Blockly.Options.parseZoomOptions_ = function(options) { +Options.parseZoomOptions_ = function(options) { const zoom = options['zoom'] || {}; const zoomOptions = {}; if (zoom['controls'] === undefined) { @@ -341,10 +343,10 @@ Blockly.Options.parseZoomOptions_ = function(options) { * behaviour is unspecified. See grid documentation: * https://developers.google.com/blockly/guides/configure/web/grid * @param {!Object} options Dictionary of options. - * @return {!Blockly.Options.GridOptions} Normalized grid options. + * @return {!Options.GridOptions} Normalized grid options. * @private */ -Blockly.Options.parseGridOptions_ = function(options) { +Options.parseGridOptions_ = function(options) { const grid = options['grid'] || {}; const gridOptions = {}; gridOptions.spacing = Number(grid['spacing']) || 0; @@ -362,7 +364,7 @@ Blockly.Options.parseGridOptions_ = function(options) { * @return {!Blockly.Theme} A Blockly Theme. * @private */ -Blockly.Options.parseThemeOptions_ = function(options) { +Options.parseThemeOptions_ = function(options) { const theme = options['theme'] || Blockly.Themes.Classic; if (typeof theme == 'string') { return /** @type {!Blockly.Theme} */ ( @@ -381,11 +383,13 @@ Blockly.Options.parseThemeOptions_ = function(options) { * @return {?Node} DOM tree of blocks, or null. * @deprecated Use Blockly.utils.toolbox.parseToolboxTree. (2020 September 28) */ -Blockly.Options.parseToolboxTree = function(toolboxDef) { +Options.parseToolboxTree = function(toolboxDef) { Blockly.utils.deprecation.warn( - 'Blockly.Options.parseToolboxTree', + 'Options.parseToolboxTree', 'September 2020', 'September 2021', 'Blockly.utils.toolbox.parseToolboxTree'); return Blockly.utils.toolbox.parseToolboxTree(toolboxDef); }; + +exports = Options; diff --git a/tests/deps.js b/tests/deps.js index 40c6a7e40..c71382196 100644 --- a/tests/deps.js +++ b/tests/deps.js @@ -13,7 +13,7 @@ goog.addDependency('../../core/block_drag_surface.js', ['Blockly.BlockDragSurfac goog.addDependency('../../core/block_dragger.js', ['Blockly.BlockDragger'], ['Blockly.Events', 'Blockly.Events.BlockDrag', 'Blockly.Events.BlockMove', 'Blockly.IBlockDragger', 'Blockly.InsertionMarkerManager', 'Blockly.blockAnimations', 'Blockly.common', 'Blockly.registry', 'Blockly.utils.Coordinate', 'Blockly.utils.dom'], {'lang': 'es6', 'module': 'goog'}); goog.addDependency('../../core/block_svg.js', ['Blockly.BlockSvg'], ['Blockly.ASTNode', 'Blockly.Block', 'Blockly.ContextMenu', 'Blockly.ContextMenuRegistry', 'Blockly.Events', 'Blockly.Events.BlockMove', 'Blockly.Events.Selected', 'Blockly.IASTNodeLocationSvg', 'Blockly.IBoundedElement', 'Blockly.ICopyable', 'Blockly.IDraggable', 'Blockly.Msg', 'Blockly.RenderedConnection', 'Blockly.TabNavigateCursor', 'Blockly.Tooltip', 'Blockly.Touch', 'Blockly.Xml', 'Blockly.blockAnimations', 'Blockly.blockRendering.IPathObject', 'Blockly.browserEvents', 'Blockly.common', 'Blockly.connectionTypes', 'Blockly.constants', 'Blockly.internalConstants', 'Blockly.utils', 'Blockly.utils.Coordinate', 'Blockly.utils.Rect', 'Blockly.utils.Svg', 'Blockly.utils.deprecation', 'Blockly.utils.dom', 'Blockly.utils.object', 'Blockly.utils.userAgent'], {'lang': 'es6'}); goog.addDependency('../../core/blockly.js', ['Blockly'], ['Blockly.ComponentManager', 'Blockly.DropDownDiv', 'Blockly.Events', 'Blockly.Events.BlockCreate', 'Blockly.Events.FinishedLoading', 'Blockly.Events.Ui', 'Blockly.Events.UiBase', 'Blockly.Events.VarCreate', 'Blockly.Procedures', 'Blockly.ShortcutRegistry', 'Blockly.Tooltip', 'Blockly.Touch', 'Blockly.Variables', 'Blockly.WidgetDiv', 'Blockly.WorkspaceSvg', 'Blockly.Xml', 'Blockly.browserEvents', 'Blockly.clipboard', 'Blockly.common', 'Blockly.connectionTypes', 'Blockly.constants', 'Blockly.inject', 'Blockly.inputTypes', 'Blockly.internalConstants', 'Blockly.utils', 'Blockly.utils.Size', 'Blockly.utils.colour', 'Blockly.utils.deprecation', 'Blockly.utils.toolbox']); -goog.addDependency('../../core/blockly_options.js', ['Blockly.BlocklyOptions'], []); +goog.addDependency('../../core/blockly_options.js', ['Blockly.BlocklyOptions'], [], {'lang': 'es6', 'module': 'goog'}); goog.addDependency('../../core/blocks.js', ['Blockly.Blocks'], [], {'lang': 'es6', 'module': 'goog'}); goog.addDependency('../../core/browser_events.js', ['Blockly.browserEvents'], ['Blockly.Touch', 'Blockly.utils.global'], {'lang': 'es6', 'module': 'goog'}); goog.addDependency('../../core/bubble.js', ['Blockly.Bubble'], ['Blockly.IBubble', 'Blockly.Scrollbar', 'Blockly.Touch', 'Blockly.Workspace', 'Blockly.browserEvents', 'Blockly.utils', 'Blockly.utils.Coordinate', 'Blockly.utils.Size', 'Blockly.utils.Svg', 'Blockly.utils.dom', 'Blockly.utils.math', 'Blockly.utils.userAgent']); @@ -117,7 +117,7 @@ goog.addDependency('../../core/metrics_manager.js', ['Blockly.FlyoutMetricsManag goog.addDependency('../../core/msg.js', ['Blockly.Msg'], ['Blockly.utils.global']); goog.addDependency('../../core/mutator.js', ['Blockly.Mutator'], ['Blockly.Bubble', 'Blockly.Events', 'Blockly.Events.BlockChange', 'Blockly.Events.BubbleOpen', 'Blockly.Icon', 'Blockly.Options', 'Blockly.WorkspaceSvg', 'Blockly.Xml', 'Blockly.internalConstants', 'Blockly.utils.Svg', 'Blockly.utils.dom', 'Blockly.utils.object', 'Blockly.utils.toolbox', 'Blockly.utils.xml'], {'lang': 'es6', 'module': 'goog'}); goog.addDependency('../../core/names.js', ['Blockly.Names'], ['Blockly.Msg', 'Blockly.internalConstants']); -goog.addDependency('../../core/options.js', ['Blockly.Options'], ['Blockly.Theme', 'Blockly.Themes.Classic', 'Blockly.registry', 'Blockly.utils.IdGenerator', 'Blockly.utils.Metrics', 'Blockly.utils.toolbox']); +goog.addDependency('../../core/options.js', ['Blockly.Options'], ['Blockly.Theme', 'Blockly.Themes.Classic', 'Blockly.registry', 'Blockly.utils.IdGenerator', 'Blockly.utils.deprecation', 'Blockly.utils.toolbox'], {'lang': 'es6', 'module': 'goog'}); goog.addDependency('../../core/positionable_helpers.js', ['Blockly.uiPosition'], ['Blockly.Scrollbar', 'Blockly.utils.Rect', 'Blockly.utils.toolbox'], {'lang': 'es6', 'module': 'goog'}); goog.addDependency('../../core/procedures.js', ['Blockly.Procedures'], ['Blockly.Blocks', 'Blockly.Events', 'Blockly.Events.BlockChange', 'Blockly.Field', 'Blockly.Msg', 'Blockly.Names', 'Blockly.Workspace', 'Blockly.Xml', 'Blockly.internalConstants', 'Blockly.utils.xml']); goog.addDependency('../../core/registry.js', ['Blockly.registry'], [], {'lang': 'es6', 'module': 'goog'});