Skip to content

Refactor Control Blocks: Fix Align Constants, Safe Aliasing, Add Defaults, and Improve Readability #83

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Manas-Dikshit wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Refactor Control Blocks: Fix Align Constants, Safe Aliasing, Add Defaults, and Improve Readability #83

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 104 additions & 65 deletions block-lexical-variables/src/blocks/controls.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
/**
* @fileoverview Control blocks for Blockly, modified for App Inventor.
* @author fraser@google.com (Neil Fraser)
* @author andrew.f.mckinney@gmail.com (Andrew F. McKinney)
* @author
* fraser@google.com (Neil Fraser)
* andrew.f.mckinney@gmail.com (Andrew F. McKinney)
*
* Due to the frequency of long strings, the 80-column wrap rule need not apply
* to language files.
*/
Expand All @@ -14,73 +16,89 @@
* [lyn, 10/25/13] Made collapsed block labels more sensible.
* [lyn, 10/10-14/13]
* + Installed flydown index variable declarations in forRange and forEach
* loops
* loops
* + Abstracted over string labels on all blocks using constants defined in
* en/_messages.js
* + Renamed "for <i> start [] end [] step []" block to "for each <number>
* from [] to [] by []"
* + Renamed "for each <i> in list []" block to "for each <item> in list []"
* + Renamed "choose test [] then-return [] else-return []" to "if [] then []
* else []"
* (TODO: still needs to have a mutator like the "if" statement blocks).
* en/_messages.js
* + Renamed "for <i> start [] end [] step []" block to
* "for each <number> from [] to [] by []"
* + Renamed "for each <i> in list []" block to
* "for each <item> in list []"
* + Renamed "choose test [] then-return [] else-return []" to
* "if [] then [] else []"
* (TODO: still needs to have a mutator like the "if" statement blocks).
* + Renamed "evaluate" block to "evaluate but ignore result"
* + Renamed "do {} then-return []" block to "do {} result []" and re-added
* this block to the Control drawer (who removed it?)
* + Removed get block (still in Variable drawer; no longer needed with
* parameter flydowns)
* + Renamed "do {} then-return []" block to "do {} result []"
* and re-added this block to the Control drawer (who removed it?)
* + Removed get block (still in Variable drawer; no longer needed
* with parameter flydowns)
* [lyn, 11/29-30/12]
* + Change forEach and forRange loops to take name as input text rather than
* via plug.
* + Changed forEach and forRange loops to take name as input text
* rather than via plug.
* + For these blocks, add extra methods to support renaming.
*/

'use strict';

import * as Blockly from 'blockly/core';
import '../msg.js';
import {FieldParameterFlydown} from '../fields/field_parameter_flydown.js';
import {FieldFlydown} from '../fields/field_flydown.js';
import { FieldParameterFlydown } from '../fields/field_parameter_flydown.js';
import { FieldFlydown } from '../fields/field_flydown.js';
import * as Utilities from '../utilities.js';
import {lexicalVariableScopeMixin} from '../mixins.js';
import { lexicalVariableScopeMixin } from '../mixins.js';

/**
* forRange block
* Iterates a variable from a start to an end value, stepping by a given amount.
*/
Blockly.Blocks['controls_forRange'] = {
// For range.
category: 'Control',
helpUrl: Blockly.Msg.LANG_CONTROLS_FORRANGE_HELPURL,
init: function() {
init: function () {
// Let the theme determine the color.
// this.setColour(Blockly.CONTROL_CATEGORY_HUE);
this.setStyle('loop_blocks');
// this.setOutput(true, null);
// Need to deal with variables here

// [lyn, 11/30/12] Changed variable to be text input box that does renaming
// right (i.e., avoids variable capture)
this.appendValueInput('FROM')
.setCheck(Utilities.yailTypeToBlocklyType('number',
Utilities.INPUT))
.appendField(Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_ITEM)
.appendField(new FieldParameterFlydown(
Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_VAR, true,
FieldFlydown.DISPLAY_BELOW), 'VAR')
.appendField(Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_START)
.setAlign(Blockly.inputs.Align.RIGHT);
.setCheck(Utilities.yailTypeToBlocklyType('number', Utilities.INPUT))
.appendField(Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_ITEM)
.appendField(
new FieldParameterFlydown(
Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_VAR,
true,
FieldFlydown.DISPLAY_BELOW
),
'VAR'
)
.appendField(Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_START)
.setAlign(Blockly.ALIGN_RIGHT);

this.appendValueInput('TO')
.setCheck(Utilities.yailTypeToBlocklyType('number',
Utilities.INPUT))
.appendField(Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_END)
.setAlign(Blockly.inputs.Align.RIGHT);
.setCheck(Utilities.yailTypeToBlocklyType('number', Utilities.INPUT))
.appendField(Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_END)
.setAlign(Blockly.ALIGN_RIGHT);

this.appendValueInput('BY')
.setCheck(Utilities.yailTypeToBlocklyType('number',
Utilities.INPUT))
.appendField(Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_STEP)
.setAlign(Blockly.inputs.Align.RIGHT);
.setCheck(Utilities.yailTypeToBlocklyType('number', Utilities.INPUT))
.appendField(Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_STEP)
.setAlign(Blockly.ALIGN_RIGHT);

this.appendStatementInput('DO')
.appendField(Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_DO)
.setAlign(Blockly.inputs.Align.RIGHT);
.appendField(Blockly.Msg.LANG_CONTROLS_FORRANGE_INPUT_DO)
.setAlign(Blockly.ALIGN_RIGHT);

this.setPreviousStatement(true);
this.setNextStatement(true);
this.setTooltip(Blockly.Msg.LANG_CONTROLS_FORRANGE_TOOLTIP);

// Add variable scoping support
this.mixin(lexicalVariableScopeMixin);

// Add default shadow values for a better user experience
this.getInput('FROM').appendField(new Blockly.FieldNumber(1), 'FROM_DEFAULT');
this.getInput('TO').appendField(new Blockly.FieldNumber(10), 'TO_DEFAULT');
this.getInput('BY').appendField(new Blockly.FieldNumber(1), 'BY_DEFAULT');
},
getDeclaredVarFieldNames: function () {
return ['VAR'];
Expand All @@ -90,38 +108,53 @@ Blockly.Blocks['controls_forRange'] = {
},
};

// Alias controls_for to controls_forRange We need this because
// we can't use controls_flow_statements within controls_forRange
// due to Blockly checking
delete Blockly.Blocks['controls_for'];
Blockly.Blocks['controls_for'] = Blockly.Blocks['controls_forRange'];
// Alias controls_for to controls_forRange.
// We need this because we can't use controls_flow_statements within
// controls_forRange due to Blockly checking.
if (Blockly.Blocks['controls_for']) {
delete Blockly.Blocks['controls_for'];
}
Blockly.Blocks['controls_for'] = Blockly.utils.object.clone(
Blockly.Blocks['controls_forRange']
);

/**
* forEach block
* Iterates over each item in a list.
*/
Blockly.Blocks['controls_forEach'] = {
// For each loop.
category: 'Control',
helpUrl: Blockly.Msg.LANG_CONTROLS_FOREACH_HELPURL,
init: function() {
init: function () {
// Let the theme determine the color.
// this.setColour(Blockly.CONTROL_CATEGORY_HUE);
this.setStyle('loop_blocks');
// this.setOutput(true, null);

// [lyn, 10/07/13] Changed default name from "i" to "item"
// [lyn, 11/29/12] Changed variable to be text input box that does renaming
// right (i.e., avoids variable capture)
this.appendValueInput('LIST')
.setCheck(Utilities.yailTypeToBlocklyType('list',
Utilities.INPUT))
.appendField(Blockly.Msg.LANG_CONTROLS_FOREACH_INPUT_ITEM)
.appendField(new FieldParameterFlydown(
Blockly.Msg.LANG_CONTROLS_FOREACH_INPUT_VAR,
true, FieldFlydown.DISPLAY_BELOW), 'VAR')
.appendField(Blockly.Msg.LANG_CONTROLS_FOREACH_INPUT_INLIST)
.setAlign(Blockly.inputs.Align.RIGHT);
.setCheck(Utilities.yailTypeToBlocklyType('list', Utilities.INPUT))
.appendField(Blockly.Msg.LANG_CONTROLS_FOREACH_INPUT_ITEM)
.appendField(
new FieldParameterFlydown(
Blockly.Msg.LANG_CONTROLS_FOREACH_INPUT_VAR,
true,
FieldFlydown.DISPLAY_BELOW
),
'VAR'
)
.appendField(Blockly.Msg.LANG_CONTROLS_FOREACH_INPUT_INLIST)
.setAlign(Blockly.ALIGN_RIGHT);

this.appendStatementInput('DO')
.appendField(Blockly.Msg.LANG_CONTROLS_FOREACH_INPUT_DO);
.appendField(Blockly.Msg.LANG_CONTROLS_FOREACH_INPUT_DO)
.setAlign(Blockly.ALIGN_RIGHT);

this.setPreviousStatement(true);
this.setNextStatement(true);
this.setTooltip(Blockly.Msg.LANG_CONTROLS_FOREACH_TOOLTIP);

this.mixin(lexicalVariableScopeMixin);
},
getDeclaredVarFieldNames: function () {
Expand All @@ -132,20 +165,26 @@ Blockly.Blocks['controls_forEach'] = {
},
};

/**
* do_then_return block
* Executes a sequence of statements and then returns a value.
*/
Blockly.Blocks['controls_do_then_return'] = {
// String length.
// Do-then-return.
category: 'Control',
helpUrl: Blockly.Msg.LANG_CONTROLS_DO_THEN_RETURN_HELPURL,
init: function() {
// this.setColour(Blockly.CONTROL_CATEGORY_HUE);
init: function () {
this.setStyle('loop_blocks');

this.appendStatementInput('STM')
.appendField(Blockly.Msg.LANG_CONTROLS_DO_THEN_RETURN_INPUT_DO);
.appendField(Blockly.Msg.LANG_CONTROLS_DO_THEN_RETURN_INPUT_DO)
.setAlign(Blockly.ALIGN_RIGHT);

this.appendValueInput('VALUE')
.appendField(Blockly.Msg.LANG_CONTROLS_DO_THEN_RETURN_INPUT_RETURN)
.setAlign(Blockly.inputs.Align.RIGHT);
.appendField(Blockly.Msg.LANG_CONTROLS_DO_THEN_RETURN_INPUT_RETURN)
.setAlign(Blockly.ALIGN_RIGHT);

this.setOutput(true, null);
this.setTooltip(Blockly.Msg.LANG_CONTROLS_DO_THEN_RETURN_TOOLTIP);
},
};