Files
blockly/generators/php/colour.js
Christopher Allen f9c865b1b3 refactor(generators)!: CodeGenerator per-block-type generator function dictionary (#7150)
* feat(generators): Add block generator function dictionary

  Add a dictionary of block generator functions, provisionally
  called .forBlock.  Look up generator functions there first, but
  fall back to looking up on 'this' (with deprecation notice)
  for backwards compatibility.

  Also tweak error message generation to use template literal.

* refactor(generators)!: Update generator definitions to use dictionary

* fix(tests): Have blockToCodeTest clean up after itself

  Have the blockToCodeTest helper function delete the block generator
  functions it adds to generator once the test is done.

* refactor(tests): Use generator dictionary in insertion marker test

  The use of generators in insertion_marker_test.js was overlooked
  in the earlier commit making such updates, and some test here
  were failing due to lack of cleanup in
  cleanup in the generator_test.js.

BREAKING CHANGE: this PR moves the generator functions we provide
from their previous location directly on the CodeGenerator instances
to the new .forBlock dictionary on each instance. This does not oblige
external developers to do the same for their custom generators, but
they will need to update any code that references the generator
functions we provide (in generators/*/*, i.e. on javascriptGenerator,
dartGenerator etc.) e.g. to replace the implementation or reuse the
implementation for a different block type.
2023-06-13 20:41:14 +01:00

82 lines
2.8 KiB
JavaScript

/**
* @license
* Copyright 2015 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* @fileoverview Generating PHP for colour blocks.
*/
import * as goog from '../../closure/goog/goog.js';
goog.declareModuleId('Blockly.PHP.colour');
import {phpGenerator as PHP} from '../php.js';
PHP.forBlock['colour_picker'] = function(block) {
// Colour picker.
const code = PHP.quote_(block.getFieldValue('COLOUR'));
return [code, PHP.ORDER_ATOMIC];
};
PHP.forBlock['colour_random'] = function(block) {
// Generate a random colour.
const functionName = PHP.provideFunction_('colour_random', `
function ${PHP.FUNCTION_NAME_PLACEHOLDER_}() {
return '#' . str_pad(dechex(mt_rand(0, 0xFFFFFF)), 6, '0', STR_PAD_LEFT);
}
`);
const code = functionName + '()';
return [code, PHP.ORDER_FUNCTION_CALL];
};
PHP.forBlock['colour_rgb'] = function(block) {
// Compose a colour from RGB components expressed as percentages.
const red = PHP.valueToCode(block, 'RED', PHP.ORDER_NONE) || 0;
const green = PHP.valueToCode(block, 'GREEN', PHP.ORDER_NONE) || 0;
const blue = PHP.valueToCode(block, 'BLUE', PHP.ORDER_NONE) || 0;
const functionName = PHP.provideFunction_('colour_rgb', `
function ${PHP.FUNCTION_NAME_PLACEHOLDER_}($r, $g, $b) {
$r = round(max(min($r, 100), 0) * 2.55);
$g = round(max(min($g, 100), 0) * 2.55);
$b = round(max(min($b, 100), 0) * 2.55);
$hex = '#';
$hex .= str_pad(dechex($r), 2, '0', STR_PAD_LEFT);
$hex .= str_pad(dechex($g), 2, '0', STR_PAD_LEFT);
$hex .= str_pad(dechex($b), 2, '0', STR_PAD_LEFT);
return $hex;
}
`);
const code = functionName + '(' + red + ', ' + green + ', ' + blue + ')';
return [code, PHP.ORDER_FUNCTION_CALL];
};
PHP.forBlock['colour_blend'] = function(block) {
// Blend two colours together.
const c1 = PHP.valueToCode(block, 'COLOUR1', PHP.ORDER_NONE) || "'#000000'";
const c2 = PHP.valueToCode(block, 'COLOUR2', PHP.ORDER_NONE) || "'#000000'";
const ratio = PHP.valueToCode(block, 'RATIO', PHP.ORDER_NONE) || 0.5;
const functionName = PHP.provideFunction_('colour_blend', `
function ${PHP.FUNCTION_NAME_PLACEHOLDER_}($c1, $c2, $ratio) {
$ratio = max(min($ratio, 1), 0);
$r1 = hexdec(substr($c1, 1, 2));
$g1 = hexdec(substr($c1, 3, 2));
$b1 = hexdec(substr($c1, 5, 2));
$r2 = hexdec(substr($c2, 1, 2));
$g2 = hexdec(substr($c2, 3, 2));
$b2 = hexdec(substr($c2, 5, 2));
$r = round($r1 * (1 - $ratio) + $r2 * $ratio);
$g = round($g1 * (1 - $ratio) + $g2 * $ratio);
$b = round($b1 * (1 - $ratio) + $b2 * $ratio);
$hex = '#';
$hex .= str_pad(dechex($r), 2, '0', STR_PAD_LEFT);
$hex .= str_pad(dechex($g), 2, '0', STR_PAD_LEFT);
$hex .= str_pad(dechex($b), 2, '0', STR_PAD_LEFT);
return $hex;
}
`);
const code = functionName + '(' + c1 + ', ' + c2 + ', ' + ratio + ')';
return [code, PHP.ORDER_FUNCTION_CALL];
};