CodingPirates/blockly
1
0
Fork 0
mirror of https://github.com/google/blockly.git synced 2026-01-07 00:50:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactor(generators): Restructure generator modules to contain side effects (#7173)

Browse Source 
* refactor(generators): Move lang.js -> lang/lang_gernator.js

  Move the LangGenerator definitions into their respective
  subdirectories and add a _generator suffix to their filenames,
  i.e. generators/javascript.js  becomes
  generators/javascript/javascript_generator.js.

  This is to keep related code together and allow the `lang/all.js`
  entrypoints to be moved to the top level generators/ directory.

  No goog module IDs were changed, so playground and test code
  that accesses this modules by filename does not need to be modified.

* refactor(generators) Move lang/all.js -> lang.js

  - Move the entrypoints in generators/*/all.js to correspondingly-named
    files in generators/ instead—i.e., generators/javascript/all.js
    becomes generators/javascript.js.

  - Update build_tasks.js accordingly.

* fix(generators): Add missing exports for LuaGenerator, PhpGenerator

  These were inadvertently omitted from #7161 and #7162, respectively.

* refactor(generators): Make block generator modules side-effect free

  - Move declaration of <lang>Generator instance from
    generators/<lang>/<lang>_generator.js to generators/<lang>.js.
  - Move .addReservedWords() calls from generators/<lang>/*.js to
    generators/<lang>.js
  - Modify generators/<lang>/*.js to export block generator functions
    individually, rather than installing on <lang>Generator instance.
  - Modify generators/<lang>.js to import and install block generator
    functions on <lang>Generator instance.

* fix(tests): Fix tests broken by restructuring of generators

  Where these tests needed block generator functions preinstalled
  they should have been importing the Blockly.<Lang>.all module.

  Where they do not need the provided block generator functions
  they can now create their own empty <Lang>Generator instances.

* chore: Update renamings file

  - Fix a malformation in previous entries that was not detected by
    the renaming file validator test.
  - Add entries describing the work done in this and related recent
    PRs.

* fix: Correct minor errors in PR #7173

  - Fix a search-and-replace error in renamings.json5
  - Fix an incorrect-but-usable import in generator_test.js
This commit is contained in:
Christopher Allen
2023-06-20 23:22:44 +01:00
committed by GitHub
parent 021a560ef0
commit 130989763c
64 changed files with 2120 additions and 2046 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
generators/php/all.js
View File

@@ -1,26 +0,0 @@
/**
* @license
* Copyright 2021 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Complete helper functions for generating PHP for
* blocks. This is the entrypoint for php_compressed.js.
* @suppress {extraRequire}
*/
import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.PHP.all');
import './colour.js';
import './lists.js';
import './logic.js';
import './loops.js';
import './math.js';
import './procedures.js';
import './text.js';
import './variables.js';
import './variables_dynamic.js';
export * from '../php.js';

10
generators/php/colour.js
View File

@@ -11,16 +11,16 @@
import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.PHP.colour');
import {phpGenerator, Order} from '../php.js';
import {Order} from './php_generator.js';
phpGenerator.forBlock['colour_picker'] = function(block, generator) {
export function colour_picker(block, generator) {
// Colour picker.
const code = generator.quote_(block.getFieldValue('COLOUR'));
return [code, Order.ATOMIC];
};
phpGenerator.forBlock['colour_random'] = function(block, generator) {
export function colour_random(block, generator) {
// Generate a random colour.
const functionName = generator.provideFunction_('colour_random', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}() {
@@ -31,7 +31,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}() {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['colour_rgb'] = function(block, generator) {
export function colour_rgb(block, generator) {
// Compose a colour from RGB components expressed as percentages.
const red = generator.valueToCode(block, 'RED', Order.NONE) || 0;
const green = generator.valueToCode(block, 'GREEN', Order.NONE) || 0;
@@ -52,7 +52,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($r, $g, $b) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['colour_blend'] = function(block, generator) {
export function colour_blend(block, generator) {
// Blend two colours together.
const c1 =
generator.valueToCode(block, 'COLOUR1', Order.NONE) || "'#000000'";

26
generators/php/lists.js
View File

@@ -24,14 +24,14 @@ goog.declareModuleId('Blockly.generator.lists');
import * as stringUtils from '../../core/utils/string.js';
import {NameType} from '../../core/names.js';
import {phpGenerator, Order} from '../php.js';
import {Order} from './php_generator.js';
phpGenerator.forBlock['lists_create_empty'] = function(block, generator) {
export function lists_create_empty(block, generator) {
// Create an empty list.
return ['array()', Order.FUNCTION_CALL];
};
phpGenerator.forBlock['lists_create_with'] = function(block, generator) {
export function lists_create_with(block, generator) {
// Create a list with any number of elements of any type.
let code = new Array(block.itemCount_);
for (let i = 0; i < block.itemCount_; i++) {
@@ -41,7 +41,7 @@ phpGenerator.forBlock['lists_create_with'] = function(block, generator) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['lists_repeat'] = function(block, generator) {
export function lists_repeat(block, generator) {
// Create a list with one element repeated.
const functionName = generator.provideFunction_('lists_repeat', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}($value, $count) {
@@ -58,7 +58,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($value, $count) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['lists_length'] = function(block, generator) {
export function lists_length(block, generator) {
// String or array length.
const functionName = generator.provideFunction_('length', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}($value) {
@@ -73,7 +73,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($value) {
return [functionName + '(' + list + ')', Order.FUNCTION_CALL];
};
phpGenerator.forBlock['lists_isEmpty'] = function(block, generator) {
export function lists_isEmpty(block, generator) {
// Is the string null or array empty?
const argument0 =
generator.valueToCode(block, 'VALUE', Order.FUNCTION_CALL)
@@ -81,7 +81,7 @@ phpGenerator.forBlock['lists_isEmpty'] = function(block, generator) {
return ['empty(' + argument0 + ')', Order.FUNCTION_CALL];
};
phpGenerator.forBlock['lists_indexOf'] = function(block, generator) {
export function lists_indexOf(block, generator) {
// Find an item in the list.
const argument0 = generator.valueToCode(block, 'FIND', Order.NONE) || "''";
const argument1 =
@@ -120,7 +120,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($haystack, $needle) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['lists_getIndex'] = function(block, generator) {
export function lists_getIndex(block, generator) {
// Get element at index.
const mode = block.getFieldValue('MODE') || 'GET';
const where = block.getFieldValue('WHERE') || 'FROM_START';
@@ -237,7 +237,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}(&$list) {
throw Error('Unhandled combination (lists_getIndex).');
};
phpGenerator.forBlock['lists_setIndex'] = function(block, generator) {
export function lists_setIndex(block, generator) {
// Set element at index.
// Note: Until February 2013 this block did not have MODE or WHERE inputs.
const mode = block.getFieldValue('MODE') || 'GET';
@@ -341,7 +341,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}(&$list, $at, $value) {
throw Error('Unhandled combination (lists_setIndex).');
};
phpGenerator.forBlock['lists_getSublist'] = function(block, generator) {
export function lists_getSublist(block, generator) {
// Get sublist.
const list = generator.valueToCode(block, 'LIST', Order.NONE) || 'array()';
const where1 = block.getFieldValue('WHERE1');
@@ -441,7 +441,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($list, $where1, $at1, $where2,
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['lists_sort'] = function(block, generator) {
export function lists_sort(block, generator) {
// Block for sorting a list.
const listCode =
generator.valueToCode(block, 'LIST', Order.NONE) || 'array()';
@@ -468,7 +468,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($list, $type, $direction) {
return [sortCode, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['lists_split'] = function(block, generator) {
export function lists_split(block, generator) {
// Block for splitting text into a list, or joining a list into text.
let value_input = generator.valueToCode(block, 'INPUT', Order.NONE);
const value_delim =
@@ -492,7 +492,7 @@ phpGenerator.forBlock['lists_split'] = function(block, generator) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['lists_reverse'] = function(block, generator) {
export function lists_reverse(block, generator) {
// Block for reversing a list.
const list = generator.valueToCode(block, 'LIST', Order.NONE) || '[]';
const code = 'array_reverse(' + list + ')';

18
generators/php/logic.js
View File

@@ -11,10 +11,10 @@
import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.PHP.logic');
import {phpGenerator, Order} from '../php.js';
import {Order} from './php_generator.js';
phpGenerator.forBlock['controls_if'] = function(block, generator) {
export function controls_if(block, generator) {
// If/elseif/else condition.
let n = 0;
let code = '', branchCode, conditionCode;
@@ -52,9 +52,9 @@ phpGenerator.forBlock['controls_if'] = function(block, generator) {
return code + '\n';
};
phpGenerator.forBlock['controls_ifelse'] = phpGenerator.forBlock['controls_if'];
export const controls_ifelse = controls_if;
phpGenerator.forBlock['logic_compare'] = function(block, generator) {
export function logic_compare(block, generator) {
// Comparison operator.
const OPERATORS =
{'EQ': '==', 'NEQ': '!=', 'LT': '<', 'LTE': '<=', 'GT': '>', 'GTE': '>='};
@@ -67,7 +67,7 @@ phpGenerator.forBlock['logic_compare'] = function(block, generator) {
return [code, order];
};
phpGenerator.forBlock['logic_operation'] = function(block, generator) {
export function logic_operation(block, generator) {
// Operations 'and', 'or'.
const operator = (block.getFieldValue('OP') === 'AND') ? '&&' : '||';
const order =
@@ -92,7 +92,7 @@ phpGenerator.forBlock['logic_operation'] = function(block, generator) {
return [code, order];
};
phpGenerator.forBlock['logic_negate'] = function(block, generator) {
export function logic_negate(block, generator) {
// Negation.
const order = Order.LOGICAL_NOT;
const argument0 = generator.valueToCode(block, 'BOOL', order) || 'true';
@@ -100,18 +100,18 @@ phpGenerator.forBlock['logic_negate'] = function(block, generator) {
return [code, order];
};
phpGenerator.forBlock['logic_boolean'] = function(block, generator) {
export function logic_boolean(block, generator) {
// Boolean values true and false.
const code = (block.getFieldValue('BOOL') === 'TRUE') ? 'true' : 'false';
return [code, Order.ATOMIC];
};
phpGenerator.forBlock['logic_null'] = function(block, generator) {
export function logic_null(block, generator) {
// Null data type.
return ['null', Order.ATOMIC];
};
phpGenerator.forBlock['logic_ternary'] = function(block, generator) {
export function logic_ternary(block, generator) {
// Ternary operator.
const value_if =
generator.valueToCode(block, 'IF', Order.CONDITIONAL) || 'false';

15
generators/php/loops.js
View File

@@ -13,10 +13,10 @@ goog.declareModuleId('Blockly.PHP.loops');
import * as stringUtils from '../../core/utils/string.js';
import {NameType} from '../../core/names.js';
import {phpGenerator, Order} from '../php.js';
import {Order} from './php_generator.js';
phpGenerator.forBlock['controls_repeat_ext'] = function(block, generator) {
export function controls_repeat_ext(block, generator) {
// Repeat n times.
let repeats;
if (block.getField('TIMES')) {
@@ -42,10 +42,9 @@ phpGenerator.forBlock['controls_repeat_ext'] = function(block, generator) {
return code;
};
phpGenerator.forBlock['controls_repeat'] =
phpGenerator.forBlock['controls_repeat_ext'];
export const controls_repeat = controls_repeat_ext;
phpGenerator.forBlock['controls_whileUntil'] = function(block, generator) {
export function controls_whileUntil(block, generator) {
// Do while/until loop.
const until = block.getFieldValue('MODE') === 'UNTIL';
let argument0 =
@@ -60,7 +59,7 @@ phpGenerator.forBlock['controls_whileUntil'] = function(block, generator) {
return 'while (' + argument0 + ') {\n' + branch + '}\n';
};
phpGenerator.forBlock['controls_for'] = function(block, generator) {
export function controls_for(block, generator) {
// For loop.
const variable0 =
generator.nameDB_.getName(block.getFieldValue('VAR'), NameType.VARIABLE);
@@ -125,7 +124,7 @@ phpGenerator.forBlock['controls_for'] = function(block, generator) {
return code;
};
phpGenerator.forBlock['controls_forEach'] = function(block, generator) {
export function controls_forEach(block, generator) {
// For each loop.
const variable0 =
generator.nameDB_.getName(
@@ -140,7 +139,7 @@ phpGenerator.forBlock['controls_forEach'] = function(block, generator) {
return code;
};
phpGenerator.forBlock['controls_flow_statements'] = function(block, generator) {
export function controls_flow_statements(block, generator) {
// Flow statements: continue, break.
let xfix = '';
if (generator.STATEMENT_PREFIX) {

30
generators/php/math.js
View File

@@ -12,10 +12,10 @@ import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.PHP.math');
import {NameType} from '../../core/names.js';
import {phpGenerator, Order} from '../php.js';
import {Order} from './php_generator.js';
phpGenerator.forBlock['math_number'] = function(block, generator) {
export function math_number(block, generator) {
// Numeric value.
let code = Number(block.getFieldValue('NUM'));
const order = code >= 0 ? Order.ATOMIC : Order.UNARY_NEGATION;
@@ -27,7 +27,7 @@ phpGenerator.forBlock['math_number'] = function(block, generator) {
return [code, order];
};
phpGenerator.forBlock['math_arithmetic'] = function(block, generator) {
export function math_arithmetic(block, generator) {
// Basic arithmetic operators, and power.
const OPERATORS = {
'ADD': [' + ', Order.ADDITION],
@@ -45,7 +45,7 @@ phpGenerator.forBlock['math_arithmetic'] = function(block, generator) {
return [code, order];
};
phpGenerator.forBlock['math_single'] = function(block, generator) {
export function math_single(block, generator) {
// Math operators with single operand.
const operator = block.getFieldValue('OP');
let code;
@@ -126,7 +126,7 @@ phpGenerator.forBlock['math_single'] = function(block, generator) {
return [code, Order.DIVISION];
};
phpGenerator.forBlock['math_constant'] = function(block, generator) {
export function math_constant(block, generator) {
// Constants: PI, E, the Golden Ratio, sqrt(2), 1/sqrt(2), INFINITY.
const CONSTANTS = {
'PI': ['M_PI', Order.ATOMIC],
@@ -139,7 +139,7 @@ phpGenerator.forBlock['math_constant'] = function(block, generator) {
return CONSTANTS[block.getFieldValue('CONSTANT')];
};
phpGenerator.forBlock['math_number_property'] = function(block, generator) {
export function math_number_property(block, generator) {
// Check if a number is even, odd, prime, whole, positive, or negative
// or if it is divisible by certain number. Returns true or false.
const PROPERTIES = {
@@ -194,7 +194,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($n) {
return [code, outputOrder];
};
phpGenerator.forBlock['math_change'] = function(block, generator) {
export function math_change(block, generator) {
// Add to a variable in place.
const argument0 =
generator.valueToCode(block, 'DELTA', Order.ADDITION) || '0';
@@ -205,11 +205,11 @@ phpGenerator.forBlock['math_change'] = function(block, generator) {
};
// Rounding functions have a single operand.
phpGenerator.forBlock['math_round'] = phpGenerator.forBlock['math_single'];
export const math_round = math_single;
// Trigonometry functions have a single operand.
phpGenerator.forBlock['math_trig'] = phpGenerator.forBlock['math_single'];
export const math_trig = math_single;
phpGenerator.forBlock['math_on_list'] = function(block, generator) {
export function math_on_list(block, generator) {
// Math functions for lists.
const func = block.getFieldValue('OP');
let list;
@@ -304,7 +304,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($list) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['math_modulo'] = function(block, generator) {
export function math_modulo(block, generator) {
// Remainder computation.
const argument0 =
generator.valueToCode(block, 'DIVIDEND', Order.MODULUS) || '0';
@@ -314,7 +314,7 @@ phpGenerator.forBlock['math_modulo'] = function(block, generator) {
return [code, Order.MODULUS];
};
phpGenerator.forBlock['math_constrain'] = function(block, generator) {
export function math_constrain(block, generator) {
// Constrain a number between two limits.
const argument0 = generator.valueToCode(block, 'VALUE', Order.NONE) || '0';
const argument1 = generator.valueToCode(block, 'LOW', Order.NONE) || '0';
@@ -325,7 +325,7 @@ phpGenerator.forBlock['math_constrain'] = function(block, generator) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['math_random_int'] = function(block, generator) {
export function math_random_int(block, generator) {
// Random integer between [X] and [Y].
const argument0 = generator.valueToCode(block, 'FROM', Order.NONE) || '0';
const argument1 = generator.valueToCode(block, 'TO', Order.NONE) || '0';
@@ -341,12 +341,12 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($a, $b) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['math_random_float'] = function(block, generator) {
export function math_random_float(block, generator) {
// Random fraction between 0 and 1.
return ['(float)rand()/(float)getrandmax()', Order.FUNCTION_CALL];
};
phpGenerator.forBlock['math_atan2'] = function(block, generator) {
export function math_atan2(block, generator) {
// Arctangent of point (X, Y) in degrees from -180 to 180.
const argument0 = generator.valueToCode(block, 'X', Order.NONE) || '0';
const argument1 = generator.valueToCode(block, 'Y', Order.NONE) || '0';

310
generators/php/php_generator.js Normal file
View File

@@ -0,0 +1,310 @@
/**
* @license
* Copyright 2015 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Helper functions for generating PHP for blocks.
* @suppress {checkTypes|globalThis}
*/
import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.PHP');
import * as stringUtils from '../../core/utils/string.js';
// import type {Block} from '../../core/block.js';
import {CodeGenerator} from '../../core/generator.js';
import {Names} from '../../core/names.js';
// import type {Workspace} from '../../core/workspace.js';
import {inputTypes} from '../../core/inputs/input_types.js';
/**
* Order of operation ENUMs.
* http://php.net/manual/en/language.operators.precedence.php
* @enum {number}
*/
export const Order = {
ATOMIC: 0, // 0 "" ...
CLONE: 1, // clone
NEW: 1, // new
MEMBER: 2.1, // []
FUNCTION_CALL: 2.2, // ()
POWER: 3, // **
INCREMENT: 4, // ++
DECREMENT: 4, // --
BITWISE_NOT: 4, // ~
CAST: 4, // (int) (float) (string) (array) ...
SUPPRESS_ERROR: 4, // @
INSTANCEOF: 5, // instanceof
LOGICAL_NOT: 6, // !
UNARY_PLUS: 7.1, // +
UNARY_NEGATION: 7.2, // -
MULTIPLICATION: 8.1, // *
DIVISION: 8.2, // /
MODULUS: 8.3, // %
ADDITION: 9.1, // +
SUBTRACTION: 9.2, // -
STRING_CONCAT: 9.3, // .
BITWISE_SHIFT: 10, // << >>
RELATIONAL: 11, // < <= > >=
EQUALITY: 12, // == != === !== <> <=>
REFERENCE: 13, // &
BITWISE_AND: 13, // &
BITWISE_XOR: 14, // ^
BITWISE_OR: 15, // |
LOGICAL_AND: 16, // &&
LOGICAL_OR: 17, // ||
IF_NULL: 18, // ??
CONDITIONAL: 19, // ?:
ASSIGNMENT: 20, // = += -= *= /= %= <<= >>= ...
LOGICAL_AND_WEAK: 21, // and
LOGICAL_XOR: 22, // xor
LOGICAL_OR_WEAK: 23, // or
NONE: 99, // (...)
};
export class PhpGenerator extends CodeGenerator {
/**
* List of outer-inner pairings that do NOT require parentheses.
* @type {!Array<!Array<number>>}
*/
ORDER_OVERRIDES = [
// (foo()).bar() -> foo().bar()
// (foo())[0] -> foo()[0]
[Order.MEMBER, Order.FUNCTION_CALL],
// (foo[0])[1] -> foo[0][1]
// (foo.bar).baz -> foo.bar.baz
[Order.MEMBER, Order.MEMBER],
// !(!foo) -> !!foo
[Order.LOGICAL_NOT, Order.LOGICAL_NOT],
// a * (b * c) -> a * b * c
[Order.MULTIPLICATION, Order.MULTIPLICATION],
// a + (b + c) -> a + b + c
[Order.ADDITION, Order.ADDITION],
// a && (b && c) -> a && b && c
[Order.LOGICAL_AND, Order.LOGICAL_AND],
// a || (b || c) -> a || b || c
[Order.LOGICAL_OR, Order.LOGICAL_OR]
];
constructor(name) {
super(name ?? 'PHP');
this.isInitialized = false;
// Copy Order values onto instance for backwards compatibility
// while ensuring they are not part of the publically-advertised
// API.
//
// TODO(#7085): deprecate these in due course. (Could initially
// replace data properties with get accessors that call
// deprecate.warn().)
for (const key in Order) {
this['ORDER_' + key] = Order[key];
}
// List of illegal variable names. This is not intended to be a
// security feature. Blockly is 100% client-side, so bypassing
// this list is trivial. This is intended to prevent users from
// accidentally clobbering a built-in object or function.
this.addReservedWords(
// http://php.net/manual/en/reserved.keywords.php
'__halt_compiler,abstract,and,array,as,break,callable,case,catch,class,' +
'clone,const,continue,declare,default,die,do,echo,else,elseif,empty,' +
'enddeclare,endfor,endforeach,endif,endswitch,endwhile,eval,exit,' +
'extends,final,for,foreach,function,global,goto,if,implements,include,' +
'include_once,instanceof,insteadof,interface,isset,list,namespace,new,' +
'or,print,private,protected,public,require,require_once,return,static,' +
'switch,throw,trait,try,unset,use,var,while,xor,' +
// http://php.net/manual/en/reserved.constants.php
'PHP_VERSION,PHP_MAJOR_VERSION,PHP_MINOR_VERSION,PHP_RELEASE_VERSION,' +
'PHP_VERSION_ID,PHP_EXTRA_VERSION,PHP_ZTS,PHP_DEBUG,PHP_MAXPATHLEN,' +
'PHP_OS,PHP_SAPI,PHP_EOL,PHP_INT_MAX,PHP_INT_SIZE,DEFAULT_INCLUDE_PATH,' +
'PEAR_INSTALL_DIR,PEAR_EXTENSION_DIR,PHP_EXTENSION_DIR,PHP_PREFIX,' +
'PHP_BINDIR,PHP_BINARY,PHP_MANDIR,PHP_LIBDIR,PHP_DATADIR,' +
'PHP_SYSCONFDIR,PHP_LOCALSTATEDIR,PHP_CONFIG_FILE_PATH,' +
'PHP_CONFIG_FILE_SCAN_DIR,PHP_SHLIB_SUFFIX,E_ERROR,E_WARNING,E_PARSE,' +
'E_NOTICE,E_CORE_ERROR,E_CORE_WARNING,E_COMPILE_ERROR,' +
'E_COMPILE_WARNING,E_USER_ERROR,E_USER_WARNING,E_USER_NOTICE,' +
'E_DEPRECATED,E_USER_DEPRECATED,E_ALL,E_STRICT,' +
'__COMPILER_HALT_OFFSET__,TRUE,FALSE,NULL,__CLASS__,__DIR__,__FILE__,' +
'__FUNCTION__,__LINE__,__METHOD__,__NAMESPACE__,__TRAIT__'
);
}
/**
* Initialise the database of variable names.
* @param {!Workspace} workspace Workspace to generate code from.
*/
init(workspace) {
super.init(workspace);
if (!this.nameDB_) {
this.nameDB_ = new Names(this.RESERVED_WORDS_, '$');
} else {
this.nameDB_.reset();
}
this.nameDB_.setVariableMap(workspace.getVariableMap());
this.nameDB_.populateVariables(workspace);
this.nameDB_.populateProcedures(workspace);
this.isInitialized = true;
};
/**
* Prepend the generated code with the variable definitions.
* @param {string} code Generated code.
* @return {string} Completed code.
*/
finish(code) {
// Convert the definitions dictionary into a list.
const definitions = Object.values(this.definitions_);
// Call Blockly.CodeGenerator's finish.
code = super.finish(code);
this.isInitialized = false;
this.nameDB_.reset();
return definitions.join('\n\n') + '\n\n\n' + code;
};
/**
* Naked values are top-level blocks with outputs that aren't plugged into
* anything. A trailing semicolon is needed to make this legal.
* @param {string} line Line of generated code.
* @return {string} Legal line of code.
*/
scrubNakedValue(line) {
return line + ';\n';
};
/**
* Encode a string as a properly escaped PHP string, complete with
* quotes.
* @param {string} string Text to encode.
* @return {string} PHP string.
* @protected
*/
quote_(string) {
string = string.replace(/\\/g, '\\\\')
.replace(/\n/g, '\\\n')
.replace(/'/g, '\\\'');
return '\'' + string + '\'';
};
/**
* Encode a string as a properly escaped multiline PHP string, complete with
* quotes.
* @param {string} string Text to encode.
* @return {string} PHP string.
* @protected
*/
multiline_quote_(string) {
const lines = string.split(/\n/g).map(this.quote_);
// Join with the following, plus a newline:
// . "\n" .
// Newline escaping only works in double-quoted strings.
return lines.join(' . \"\\n\" .\n');
};
/**
* Common tasks for generating PHP from blocks.
* Handles comments for the specified block and any connected value blocks.
* Calls any statements following this block.
* @param {!Block} block The current block.
* @param {string} code The PHP code created for this block.
* @param {boolean=} opt_thisOnly True to generate code for only this
* statement.
* @return {string} PHP code with comments and subsequent blocks added.
* @protected
*/
scrub_(block, code, opt_thisOnly) {
let commentCode = '';
// Only collect comments for blocks that aren't inline.
if (!block.outputConnection || !block.outputConnection.targetConnection) {
// Collect comment for this block.
let comment = block.getCommentText();
if (comment) {
comment = stringUtils.wrap(comment, this.COMMENT_WRAP - 3);
commentCode += this.prefixLines(comment, '// ') + '\n';
}
// Collect comments for all value arguments.
// Don't collect comments for nested statements.
for (let i = 0; i < block.inputList.length; i++) {
if (block.inputList[i].type === inputTypes.VALUE) {
const childBlock = block.inputList[i].connection.targetBlock();
if (childBlock) {
comment = this.allNestedComments(childBlock);
if (comment) {
commentCode += this.prefixLines(comment, '// ');
}
}
}
}
}
const nextBlock =
block.nextConnection && block.nextConnection.targetBlock();
const nextCode = opt_thisOnly ? '' : this.blockToCode(nextBlock);
return commentCode + code + nextCode;
};
/**
* Gets a property and adjusts the value while taking into account indexing.
* @param {!Block} block The block.
* @param {string} atId The property ID of the element to get.
* @param {number=} opt_delta Value to add.
* @param {boolean=} opt_negate Whether to negate the value.
* @param {number=} opt_order The highest order acting on this value.
* @return {string|number}
*/
getAdjusted(block, atId, opt_delta, opt_negate, opt_order) {
let delta = opt_delta || 0;
let order = opt_order || this.ORDER_NONE;
if (block.workspace.options.oneBasedIndex) {
delta--;
}
let defaultAtIndex = block.workspace.options.oneBasedIndex ? '1' : '0';
let outerOrder = order;
let innerOrder;
if (delta > 0) {
outerOrder = this.ORDER_ADDITION;
innerOrder = this.ORDER_ADDITION;
} else if (delta < 0) {
outerOrder = this.ORDER_SUBTRACTION;
innerOrder = this.ORDER_SUBTRACTION;
} else if (opt_negate) {
outerOrder = this.ORDER_UNARY_NEGATION;
innerOrder = this.ORDER_UNARY_NEGATION;
}
let at = this.valueToCode(block, atId, outerOrder) || defaultAtIndex;
if (stringUtils.isNumber(at)) {
// If the index is a naked number, adjust it right now.
at = Number(at) + delta;
if (opt_negate) {
at = -at;
}
} else {
// If the index is dynamic, adjust it in code.
if (delta > 0) {
at = at + ' + ' + delta;
} else if (delta < 0) {
at = at + ' - ' + -delta;
}
if (opt_negate) {
if (delta) {
at = '-(' + at + ')';
} else {
at = '-' + at;
}
}
innerOrder = Math.floor(innerOrder);
order = Math.floor(order);
if (innerOrder && order >= innerOrder) {
at = '(' + at + ')';
}
}
return at;
};
}

13
generators/php/procedures.js
View File

@@ -13,10 +13,10 @@ goog.declareModuleId('Blockly.PHP.procedures');
import * as Variables from '../../core/variables.js';
import {NameType} from '../../core/names.js';
import {phpGenerator, Order} from '../php.js';
import {Order} from './php_generator.js';
phpGenerator.forBlock['procedures_defreturn'] = function(block, generator) {
export function procedures_defreturn(block, generator) {
// Define a procedure with a return value.
// First, add a 'global' statement for every variable that is not shadowed by
// a local parameter.
@@ -84,10 +84,9 @@ phpGenerator.forBlock['procedures_defreturn'] = function(block, generator) {
// Defining a procedure without a return value uses the same generator as
// a procedure with a return value.
phpGenerator.forBlock['procedures_defnoreturn'] =
phpGenerator.forBlock['procedures_defreturn'];
export const procedures_defnoreturn = procedures_defreturn;
phpGenerator.forBlock['procedures_callreturn'] = function(block, generator) {
export function procedures_callreturn(block, generator) {
// Call a procedure with a return value.
const funcName =
generator.nameDB_.getName(
@@ -101,7 +100,7 @@ phpGenerator.forBlock['procedures_callreturn'] = function(block, generator) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['procedures_callnoreturn'] = function(block, generator) {
export function procedures_callnoreturn(block, generator) {
// Call a procedure with no return value.
// Generated code is for a function call as a statement is the same as a
// function call as a value, with the addition of line ending.
@@ -109,7 +108,7 @@ phpGenerator.forBlock['procedures_callnoreturn'] = function(block, generator) {
return tuple[0] + ';\n';
};
phpGenerator.forBlock['procedures_ifreturn'] = function(block, generator) {
export function procedures_ifreturn(block, generator) {
// Conditionally return value from a procedure.
const condition =
generator.valueToCode(block, 'CONDITION', Order.NONE) || 'false';

36
generators/php/text.js
View File

@@ -12,16 +12,16 @@ import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.PHP.texts');
import {NameType} from '../../core/names.js';
import {phpGenerator, Order} from '../php.js';
import {Order} from './php_generator.js';
phpGenerator.forBlock['text'] = function(block, generator) {
export function text(block, generator) {
// Text value.
const code = generator.quote_(block.getFieldValue('TEXT'));
return [code, Order.ATOMIC];
};
phpGenerator.forBlock['text_multiline'] = function(block, generator) {
export function text_multiline(block, generator) {
// Text value.
const code = generator.multiline_quote_(block.getFieldValue('TEXT'));
const order =
@@ -29,7 +29,7 @@ phpGenerator.forBlock['text_multiline'] = function(block, generator) {
return [code, order];
};
phpGenerator.forBlock['text_join'] = function(block, generator) {
export function text_join(block, generator) {
// Create a string made up of any number of elements of any type.
if (block.itemCount_ === 0) {
return ["''", Order.ATOMIC];
@@ -55,7 +55,7 @@ phpGenerator.forBlock['text_join'] = function(block, generator) {
}
};
phpGenerator.forBlock['text_append'] = function(block, generator) {
export function text_append(block, generator) {
// Append to a variable in place.
const varName =
generator.nameDB_.getName(
@@ -65,7 +65,7 @@ phpGenerator.forBlock['text_append'] = function(block, generator) {
return varName + ' .= ' + value + ';\n';
};
phpGenerator.forBlock['text_length'] = function(block, generator) {
export function text_length(block, generator) {
// String or array length.
const functionName = generator.provideFunction_('length', `
function ${generator.FUNCTION_NAME_PLACEHOLDER_}($value) {
@@ -79,13 +79,13 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($value) {
return [functionName + '(' + text + ')', Order.FUNCTION_CALL];
};
phpGenerator.forBlock['text_isEmpty'] = function(block, generator) {
export function text_isEmpty(block, generator) {
// Is the string null or array empty?
const text = generator.valueToCode(block, 'VALUE', Order.NONE) || "''";
return ['empty(' + text + ')', Order.FUNCTION_CALL];
};
phpGenerator.forBlock['text_indexOf'] = function(block, generator) {
export function text_indexOf(block, generator) {
// Search the text for a substring.
const operator =
block.getFieldValue('END') === 'FIRST' ? 'strpos' : 'strrpos';
@@ -110,7 +110,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($text, $search) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['text_charAt'] = function(block, generator) {
export function text_charAt(block, generator) {
// Get letter at index.
const where = block.getFieldValue('WHERE') || 'FROM_START';
const textOrder = (where === 'RANDOM') ? Order.NONE : Order.NONE;
@@ -147,7 +147,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($text) {
throw Error('Unhandled option (text_charAt).');
};
phpGenerator.forBlock['text_getSubstring'] = function(block, generator) {
export function text_getSubstring(block, generator) {
// Get substring.
const where1 = block.getFieldValue('WHERE1');
const where2 = block.getFieldValue('WHERE2');
@@ -186,7 +186,7 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}($text, $where1, $at1, $where2,
}
};
phpGenerator.forBlock['text_changeCase'] = function(block, generator) {
export function text_changeCase(block, generator) {
// Change capitalization.
const text = generator.valueToCode(block, 'TEXT', Order.NONE) || "''";
let code;
@@ -200,7 +200,7 @@ phpGenerator.forBlock['text_changeCase'] = function(block, generator) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['text_trim'] = function(block, generator) {
export function text_trim(block, generator) {
// Trim spaces.
const OPERATORS = {'LEFT': 'ltrim', 'RIGHT': 'rtrim', 'BOTH': 'trim'};
const operator = OPERATORS[block.getFieldValue('MODE')];
@@ -208,13 +208,13 @@ phpGenerator.forBlock['text_trim'] = function(block, generator) {
return [operator + '(' + text + ')', Order.FUNCTION_CALL];
};
phpGenerator.forBlock['text_print'] = function(block, generator) {
export function text_print(block, generator) {
// Print statement.
const msg = generator.valueToCode(block, 'TEXT', Order.NONE) || "''";
return 'print(' + msg + ');\n';
};
phpGenerator.forBlock['text_prompt_ext'] = function(block, generator) {
export function text_prompt_ext(block, generator) {
// Prompt function.
let msg;
if (block.getField('TEXT')) {
@@ -232,9 +232,9 @@ phpGenerator.forBlock['text_prompt_ext'] = function(block, generator) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['text_prompt'] = phpGenerator.forBlock['text_prompt_ext'];
export const text_prompt = text_prompt_ext;
phpGenerator.forBlock['text_count'] = function(block, generator) {
export function text_count(block, generator) {
const text = generator.valueToCode(block, 'TEXT', Order.NONE) || "''";
const sub = generator.valueToCode(block, 'SUB', Order.NONE) || "''";
const code = 'strlen(' + sub + ') === 0' +
@@ -243,7 +243,7 @@ phpGenerator.forBlock['text_count'] = function(block, generator) {
return [code, Order.CONDITIONAL];
};
phpGenerator.forBlock['text_replace'] = function(block, generator) {
export function text_replace(block, generator) {
const text = generator.valueToCode(block, 'TEXT', Order.NONE) || "''";
const from = generator.valueToCode(block, 'FROM', Order.NONE) || "''";
const to = generator.valueToCode(block, 'TO', Order.NONE) || "''";
@@ -251,7 +251,7 @@ phpGenerator.forBlock['text_replace'] = function(block, generator) {
return [code, Order.FUNCTION_CALL];
};
phpGenerator.forBlock['text_reverse'] = function(block, generator) {
export function text_reverse(block, generator) {
const text = generator.valueToCode(block, 'TEXT', Order.NONE) || "''";
const code = 'strrev(' + text + ')';
return [code, Order.FUNCTION_CALL];

6
generators/php/variables.js
View File

@@ -12,10 +12,10 @@ import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.PHP.variables');
import {NameType} from '../../core/names.js';
import {phpGenerator, Order} from '../php.js';
import {Order} from './php_generator.js';
phpGenerator.forBlock['variables_get'] = function(block, generator) {
export function variables_get(block, generator) {
// Variable getter.
const code =
generator.nameDB_.getName(
@@ -23,7 +23,7 @@ phpGenerator.forBlock['variables_get'] = function(block, generator) {
return [code, Order.ATOMIC];
};
phpGenerator.forBlock['variables_set'] = function(block, generator) {
export function variables_set(block, generator) {
// Variable setter.
const argument0 =
generator.valueToCode(block, 'VALUE', Order.ASSIGNMENT) || '0';

11
generators/php/variables_dynamic.js
View File

@@ -11,12 +11,9 @@
import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.PHP.variablesDynamic');
import {phpGenerator} from '../php.js';
import './variables.js';
// generator is dynamically typed.
phpGenerator.forBlock['variables_get_dynamic'] =
phpGenerator.forBlock['variables_get'];
phpGenerator.forBlock['variables_set_dynamic'] =
phpGenerator.forBlock['variables_set'];
export {
variables_get as variables_get_dynamic,
variables_set as variables_set_dynamic,
} from './variables.js';