add a new color picker block (#11292)

* beginnings of new color picker block

* more color picker work

* better support for keyboard controls

* fix reading initial value

* allow extensions to contribute color picker block

* lint

Author: riknoll

ThirdPartyNotice

@@ -882,6 +882,7 @@ General Public License.
 864. @fortawesome/fontawesome-free 5.15.4 (https://www.npmjs.com/package/@fortawesome/fontawesome-free/v/5.15.4)
 865. @blockly/plugin-workspace-search 4.0.10 (https://www.npmjs.com/package/@blockly/plugin-workspace-search/v/4.0.10)
 866. @blockly/keyboard-navigation 1.0.0-beta.0 (https://www.npmjs.com/package/@blockly/keyboard-navigation/v/1.0.0-beta.0)
+867. Qix-/color-convert 5c106a633b5cd2de554d9c287ad31f9eeca7a271 (https://github.com/Qix-/color-convert)
 
 
 
@@ -28361,14 +28362,14 @@ The copyright in this software is being made available under the BSD License, in
 
 **Copyright (c) 2015, Dash Industry Forum.
 **All rights reserved.**
- 
+
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the  documentation and/or other materials provided with the distribution.
 * Neither the name of the Dash Industry Forum nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
 **THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.**
- 
+
 =========================================
 END OF dashjs 4.4.0 NOTICES AND INFORMATION
 
@@ -28955,3 +28956,30 @@ END OF @blockly/plugin-workspace-search 4.0.10 NOTICES AND INFORMATION
    limitations under the License.
 =========================================
 END OF @blockly/keyboard-navigation 1.0.0-beta.0 NOTICES AND INFORMATION
+
+
+%% Qix-/color-convert 5c106a633b5cd2de554d9c287ad31f9eeca7a271 NOTICES AND INFORMATION BEGIN HERE
+=========================================
+Copyright (c) 2011-2016 Heather Arthur <fayearthur@gmail.com>.
+Copyright (c) 2016-2021 Josh Junon <josh@junon.me>.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+=========================================
+END OF Qix-/color-convert 5c106a633b5cd2de554d9c287ad31f9eeca7a271 NOTICES AND INFORMATION

libs/pxt-common/pxt-helpers.ts

@@ -65,14 +65,14 @@ function parseInt(text: string, radix?: number): number {
     switch (text.charAt(start)) {
         case "-":
             sign = -1;
-            // fallthrough
+        // fallthrough
         case "+":
             ++start;
     }
 
     if ((!radix || radix == 16)
-            && "0" === text[start]
-            && ("x" === text[start + 1] || "X" === text[start + 1])) {
+        && "0" === text[start]
+        && ("x" === text[start + 1] || "X" === text[start + 1])) {
         radix = 16;
         start += 2;
     } else if (!radix) {
@@ -753,3 +753,170 @@ namespace __internal {
         return ms;
     }
 }
+
+
+// Converted to TS from https://github.com/Qix-/color-convert/blob/5c106a633b5cd2de554d9c287ad31f9eeca7a271/conversions.js
+// See ThirdPartyNotice in microsoft/pxt for license information
+namespace colorHelpers {
+    /**
+     * Converts a red, green, and blue color value into a single color number.
+     *
+     *
+     * @param red The red component of the color, between 0 and 255
+     * @param green The green component of the color, between 0 and 255
+     * @param blue The blue component of the color, between 0 and 255
+     * @returns The combined color as a single number
+     */
+    export function rgb(red: number, green: number, blue: number): number {
+        return (Math.clamp(0, 255, red) << 16) | (Math.clamp(0, 255, green) << 8) | Math.clamp(0, 255, blue);
+    }
+
+    /**
+     * Converts a hue, saturation, and value (HSV) color into a single color number.
+     *
+     *
+     * @param hue The hue component of the color, between 0 and 360
+     * @param saturation The saturation component of the color, between 0 and 100
+     * @param value The value component of the color, between 0 and 100
+     * @returns The combined color as a single number
+     */
+    export function hsv(hue: number, saturation: number, value: number): number {
+        hue = Math.clamp(0, 360, hue) / 60;
+        saturation = Math.clamp(0, 100, saturation) / 100;
+        value = Math.clamp(0, 100, value) / 100;
+
+        const hi = Math.floor(hue) % 6;
+
+        const f = hue - Math.floor(hue);
+        const p = 255 * value * (1 - saturation);
+        const q = 255 * value * (1 - (saturation * f));
+        const t = 255 * value * (1 - (saturation * (1 - f)));
+        value *= 255;
+
+        switch (hi) {
+            case 0:
+                return rgb(value, t, p);
+            case 1:
+                return rgb(q, value, p);
+            case 2:
+                return rgb(p, value, t);
+            case 3:
+                return rgb(p, q, value);
+            case 4:
+                return rgb(t, p, value);
+            case 5:
+                return rgb(value, p, q);
+        }
+
+        // never
+        return 0;
+    }
+
+    /**
+     * Converts a hue, saturation, and lightness (HSL) color into a single color number.
+     *
+     *
+     * @param hue The hue component of the color, between 0 and 360
+     * @param saturation The saturation component of the color, between 0 and 100
+     * @param lightness The lightness component of the color, between 0 and 100
+     * @returns The combined color as a single number
+     */
+    export function hsl(hue: number, saturation: number, lightness: number): number {
+        hue = Math.clamp(0, 360, hue) / 360;
+        saturation = Math.clamp(0, 100, saturation) / 100;
+        lightness = Math.clamp(0, 100, lightness) / 100;
+
+        let t3: number;
+        let value: number;
+
+        if (saturation === 0) {
+            value = lightness * 255;
+            return rgb(value, value, value);
+        }
+
+        const t2 = lightness < 0.5 ? lightness * (1 + saturation) : lightness + saturation - lightness * saturation;
+
+        const t1 = 2 * lightness - t2;
+
+        const channels: number[] = [0, 0, 0];
+        for (let i = 0; i < 3; i++) {
+            t3 = hue + 1 / 3 * -(i - 1);
+            if (t3 < 0) {
+                t3++;
+            }
+
+            if (t3 > 1) {
+                t3--;
+            }
+
+            if (6 * t3 < 1) {
+                value = t1 + (t2 - t1) * 6 * t3;
+            }
+            else if (2 * t3 < 1) {
+                value = t2;
+            }
+            else if (3 * t3 < 2) {
+                value = t1 + (t2 - t1) * (2 / 3 - t3) * 6;
+            }
+            else {
+                value = t1;
+            }
+
+            channels[i] = value * 255;
+        }
+
+        return rgb(channels[0], channels[1], channels[2]);
+    }
+
+    /**
+     * Converts a hexadecimal color string into a single color number. The hexadecimal string can be in the short
+     * 3-digit form ("#f0a") or the full 6-digit form ("#ff00aa").
+     *
+     *
+     * @param hex A hexadecimal color string, optionally starting with "#" and either in 3-digit or 6-digit format
+     * @returns The combined color as a single number
+     */
+    export function hex(hex: string): number {
+        if (hex.charAt(0) === "#") {
+            hex = hex.slice(1);
+        }
+
+        if (hex.length === 3) {
+            hex = hex.split("").map(c => c + c).join("");
+        }
+
+        if (hex.length !== 6) {
+            return 0;
+        }
+
+        const num = parseInt(hex, 16);
+        if (isNaN(num)) {
+            return 0;
+        }
+
+        return num;
+    }
+
+    /**
+     * Converts a CMYK color into a single color number.
+     *
+     *
+     * @param cyan The cyan component of the color, between 0 and 100
+     * @param magenta The magenta component of the color, between 0 and 100
+     * @param yellow The yellow component of the color, between 0 and 100
+     * @param black The black component of the color, between 0 and 100
+     * @returns The combined color as a single number
+     */
+    export function cmyk(cyan: number, magenta: number, yellow: number, black: number): number {
+        cyan = Math.clamp(0, 100, cyan) / 100;
+        magenta = Math.clamp(0, 100, magenta) / 100;
+        yellow = Math.clamp(0, 100, yellow) / 100;
+        black = Math.clamp(0, 100, black) / 100;
+
+        const r = 1 - Math.min(1, cyan * (1 - black) + black);
+        const g = 1 - Math.min(1, magenta * (1 - black) + black);
+        const b = 1 - Math.min(1, yellow * (1 - black) + black);
+
+        return rgb(r * 255, g * 255, b * 255);
+    }
+}

localtypings/pxtarget.d.ts

@@ -1027,6 +1027,7 @@ declare namespace ts.pxtc {
         alias?: string; // another symbol alias for this member
         pyAlias?: string; // optional python version of the alias
         blockAliasFor?: string; // qname of the function this block is an alias for
+        builtinBlockId?: string; // if present, this block is to be replaced with a builtin block in the toolbox
     }
 
     interface ParamSnippet {

pxtblocks/compiler/compiler.ts

@@ -12,6 +12,7 @@ import { FieldTilemap, FieldTextInput } from "../fields";
 import { CommonFunctionBlock } from "../plugins/functions/commonFunctionMixin";
 import { getContainingFunction } from "../plugins/duplicateOnDrag";
 import { FUNCTION_DEFINITION_BLOCK_TYPE } from "../plugins/functions/constants";
+import { COLOR_NUMBER_BLOCK_TYPE, COLOR_PICKER_BLOCK_TYPE, COLOR_STRING_BLOCK_TYPE } from "../plugins/colorpicker";
 
 
 interface Rect {
@@ -436,8 +437,8 @@ export function compileExpression(e: Environment, b: Blockly.Block, comments: st
         case "math_number":
         case "math_integer":
         case "math_whole_number":
-            expr = compileNumber(e, b, comments); break;
         case "math_number_minmax":
+        case COLOR_NUMBER_BLOCK_TYPE:
             expr = compileNumber(e, b, comments); break;
         case "math_op2":
             expr = compileMathOp2(e, b, comments); break;
@@ -457,6 +458,7 @@ export function compileExpression(e: Environment, b: Blockly.Block, comments: st
         case "variables_get_reporter":
             expr = compileVariableGet(e, b); break;
         case "text":
+        case COLOR_STRING_BLOCK_TYPE:
             expr = compileText(e, b, comments); break;
         case "text_join":
             expr = compileTextJoin(e, b, comments); break;
@@ -480,6 +482,9 @@ export function compileExpression(e: Environment, b: Blockly.Block, comments: st
             break;
         case "function_call_output":
             expr = compileFunctionCall(e, b, comments, false); break;
+        case COLOR_PICKER_BLOCK_TYPE:
+            expr = compileColorPicker(e, b, comments);
+            break;
         default:
             let call = e.stdCallTable[b.type];
             if (call) {
@@ -1338,13 +1343,13 @@ function compileWorkspaceComment(c: Blockly.comments.RenderedWorkspaceComment):
 }
 
 function isLiteral(e: Environment, b: Blockly.Block) {
-    return isNumericLiteral(e, b) || b.type === "logic_boolean" || b.type === "text";
+    return isNumericLiteral(e, b) || b.type === "logic_boolean" || b.type === "text" || b.type === COLOR_STRING_BLOCK_TYPE;
 }
 
 function isNumericLiteral(e: Environment, b: Blockly.Block): boolean {
     if (!b) return false;
 
-    if (b.type === "math_number" || b.type === "math_integer" || b.type === "math_number_minmax" || b.type === "math_whole_number") {
+    if (b.type === "math_number" || b.type === "math_integer" || b.type === "math_number_minmax" || b.type === "math_whole_number" || b.type === COLOR_NUMBER_BLOCK_TYPE) {
         return true;
     }
 
@@ -1388,6 +1393,35 @@ function compileNumber(e: Environment, b: Blockly.Block, comments: string[]): px
     return pxt.blocks.H.mkNumberLiteral(extractNumber(b));
 }
 
+function compileColorPicker(e: Environment, b: Blockly.Block, comments: string[]): pxt.blocks.JsNode {
+    const format = b.getFieldValue("FORMAT");
+
+    if (format === "hex") {
+        return pxt.blocks.H.namespaceCall(
+            "colorHelpers",
+            "hex",
+            [compileExpression(e, getInputTargetBlock(e, b, "HEX_INPUT"), comments)],
+            false
+        );
+    }
+    else {
+        const inputs: pxt.blocks.JsNode[] = [];
+        for (let i = 0; i < 4; i++) {
+            const input = b.getInput("INPUT" + i);
+            if (input) {
+                inputs.push(compileExpression(e, getInputTargetBlock(e, b, input.name), comments));
+            }
+        }
+        return pxt.blocks.H.namespaceCall(
+            "colorHelpers",
+            format,
+            inputs,
+            false
+        );
+    }
+}
+
+
 function throwBlockError(msg: string, block: Blockly.Block) {
     let e = new Error(msg);
     (e as any).block = block;

pxtblocks/compiler/typeChecker.ts

@@ -7,6 +7,7 @@ import { CommonFunctionBlock } from "../plugins/functions/commonFunctionMixin";
 import { PXT_WARNING_ID } from "./compiler";
 import { DRAGGABLE_PARAM_INPUT_PREFIX } from "../loader";
 import { getContainingFunction } from "../plugins/duplicateOnDrag";
+import { COLOR_PICKER_BLOCK_TYPE } from "..";
 
 interface DeclaredVariable {
     name: string;
@@ -149,6 +150,22 @@ export function infer(allBlocks: Blockly.Block[], e: Environment, w: Blockly.Wor
                     break;
                 case pxtc.PAUSE_UNTIL_TYPE:
                     unionParam(e, b, "PREDICATE", pBoolean);
+                    break;
+                case COLOR_PICKER_BLOCK_TYPE:
+                    const format = b.getFieldValue("FORMAT");
+
+                    if (format === "hex") {
+                        unionParam(e, b, "HEX_INPUT", ground("string"));
+                    }
+                    else {
+                        for (let i = 0; i < 4; i++) {
+                            const input = b.getInput("INPUT" + i);
+                            if (input) {
+                                unionParam(e, b, input.name, ground("number"));
+                            }
+                        }
+                    }
+
                     break;
                 default:
                     if (b.type in e.stdCallTable) {

pxtblocks/index.ts

@@ -7,6 +7,7 @@ export * from "./plugins/renderer";
 export * from "./plugins/flyout";
 export * from "./plugins/newVariableField";
 export * from "./plugins/comments";
+export * from "./plugins/colorpicker";
 export * from "./compiler/compiler";
 export * from "./compiler/environment";
 export * from "./loader";