[FL-3893] JS modules (#3841)

* feat: backport js_gpio from unleashed
* feat: backport js_keyboard, TextInputModel::minimum_length from unleashed
* fix: api version inconsistency
* style: js_gpio
* build: fix submodule ._ .
* refactor: js_gpio
* docs: type declarations for gpio
* feat: gpio interrupts
* fix: js_gpio freeing, resetting and minor stylistic changes
* style: js_gpio
* style: mlib array, fixme's
* feat: js_gpio adc
* feat: js_event_loop
* docs: js_event_loop
* feat: js_event_loop subscription cancellation
* feat: js_event_loop + js_gpio integration
* fix: js_event_loop memory leak
* feat: stop event loop on back button
* test: js: basic, math, event_loop
* feat: js_event_loop queue
* feat: js linkage to previously loaded plugins
* build: fix ci errors
* feat: js module ordered teardown
* feat: js_gui_defer_free
* feat: basic hourglass view
* style: JS ASS (Argument Schema for Scripts)
* fix: js_event_loop mem leaks and lifetime problems
* fix: crashing test and pvs false positives
* feat: mjs custom obj destructors, gui submenu view
* refactor: yank js_gui_defer_free (yuck)
* refactor: maybe_unsubscribe
* empty_screen, docs, typing fix-ups
* docs: navigation event & demo
* feat: submenu setHeader
* feat: text_input
* feat: text_box
* docs: text_box availability
* ci: silence irrelevant pvs low priority warning
* style: use furistring
* style: _get_at -> _safe_get
* fix: built-in module name assignment
* feat: js_dialog; refactor, optimize: js_gui
* docs: js_gui
* ci: silence pvs warning: Memory allocation is infallible
* style: fix storage spelling
* feat: foreign pointer signature checks
* feat: js_storage
* docs: js_storage
* fix: my unit test was breaking other tests ;_;
* ci: fix ci?
* Make doxygen happy
* docs: flipper, math, notification, global
* style: review suggestions
* style: review fixups
* fix: badusb demo script
* docs: badusb
* ci: add nofl
* ci: make linter happy
* Bump api version

Co-authored-by: Aleksandr Kutuzov <alleteam@gmail.com>

applications/system/js_app/examples/apps/Scripts/badusb_demo.js

@@ -1,33 +1,58 @@
 let badusb = require("badusb");
 let notify = require("notification");
 let flipper = require("flipper");
-let dialog = require("dialog");
+let eventLoop = require("event_loop");
+let gui = require("gui");
+let dialog = require("gui/dialog");
 
-badusb.setup({ vid: 0xAAAA, pid: 0xBBBB, mfr_name: "Flipper", prod_name: "Zero" });
-dialog.message("BadUSB demo", "Press OK to start");
+let views = {
+    dialog: dialog.makeWith({
+        header: "BadUSB demo",
+        text: "Press OK to start",
+        center: "Start",
+    }),
+};
 
-if (badusb.isConnected()) {
-    notify.blink("green", "short");
-    print("USB is connected");
+badusb.setup({ vid: 0xAAAA, pid: 0xBBBB, mfrName: "Flipper", prodName: "Zero" });
 
-    badusb.println("Hello, world!");
+eventLoop.subscribe(views.dialog.input, function (_sub, button, eventLoop, gui) {
+    if (button !== "center")
+        return;
 
-    badusb.press("CTRL", "a");
-    badusb.press("CTRL", "c");
-    badusb.press("DOWN");
-    delay(1000);
-    badusb.press("CTRL", "v");
-    delay(1000);
-    badusb.press("CTRL", "v");
+    gui.viewDispatcher.sendTo("back");
 
-    badusb.println("1234", 200);
+    if (badusb.isConnected()) {
+        notify.blink("green", "short");
+        print("USB is connected");
 
-    badusb.println("Flipper Model: " + flipper.getModel());
-    badusb.println("Flipper Name: " + flipper.getName());
-    badusb.println("Battery level: " + to_string(flipper.getBatteryCharge()) + "%");
+        badusb.println("Hello, world!");
 
-    notify.success();
-} else {
-    print("USB not connected");
-    notify.error();
-}
+        badusb.press("CTRL", "a");
+        badusb.press("CTRL", "c");
+        badusb.press("DOWN");
+        delay(1000);
+        badusb.press("CTRL", "v");
+        delay(1000);
+        badusb.press("CTRL", "v");
+
+        badusb.println("1234", 200);
+
+        badusb.println("Flipper Model: " + flipper.getModel());
+        badusb.println("Flipper Name: " + flipper.getName());
+        badusb.println("Battery level: " + toString(flipper.getBatteryCharge()) + "%");
+
+        notify.success();
+    } else {
+        print("USB not connected");
+        notify.error();
+    }
+
+    eventLoop.stop();
+}, eventLoop, gui);
+
+eventLoop.subscribe(gui.viewDispatcher.navigation, function (_sub, _item, eventLoop) {
+    eventLoop.stop();
+}, eventLoop);
+
+gui.viewDispatcher.switchTo(views.dialog);
+eventLoop.run();

applications/system/js_app/examples/apps/Scripts/delay.js

@@ -6,4 +6,4 @@ print("2");
 delay(1000)
 print("3");
 delay(1000)
-print("end");
+print("end");

applications/system/js_app/examples/apps/Scripts/dialog.js

@@ -1,19 +0,0 @@
-let dialog = require("dialog");
-
-let result1 = dialog.message("Dialog demo", "Press OK to start");
-print(result1);
-
-let dialog_params = ({
-    header: "Test_header",
-    text: "Test_text",
-    button_left: "Left",
-    button_right: "Right",
-    button_center: "OK"
-});
-
-let result2 = dialog.custom(dialog_params);
-if (result2 === "") {
-    print("Back is pressed");
-} else {
-    print(result2, "is pressed");
-}

applications/system/js_app/examples/apps/Scripts/event_loop.js

@@ -0,0 +1,25 @@
+let eventLoop = require("event_loop");
+
+// print a string after 1337 milliseconds
+eventLoop.subscribe(eventLoop.timer("oneshot", 1337), function (_subscription, _item) {
+    print("Hi after 1337 ms");
+});
+
+// count up to 5 with a delay of 100ms between increments
+eventLoop.subscribe(eventLoop.timer("periodic", 100), function (subscription, _item, counter) {
+    print("Counter two:", counter);
+    if (counter === 5)
+        subscription.cancel();
+    return [counter + 1];
+}, 0);
+
+// count up to 15 with a delay of 100ms between increments
+// and stop the program when the count reaches 15
+eventLoop.subscribe(eventLoop.timer("periodic", 100), function (subscription, _item, event_loop, counter) {
+    print("Counter one:", counter);
+    if (counter === 15)
+        event_loop.stop();
+    return [event_loop, counter + 1];
+}, eventLoop, 0);
+
+eventLoop.run();

applications/system/js_app/examples/apps/Scripts/gpio.js

@@ -0,0 +1,57 @@
+let eventLoop = require("event_loop");
+let gpio = require("gpio");
+
+// initialize pins
+let led = gpio.get("pc3"); // same as `gpio.get(7)`
+let pot = gpio.get("pc0"); // same as `gpio.get(16)`
+let button = gpio.get("pc1"); // same as `gpio.get(15)`
+led.init({ direction: "out", outMode: "push_pull" });
+pot.init({ direction: "in", inMode: "analog" });
+button.init({ direction: "in", pull: "up", inMode: "interrupt", edge: "falling" });
+
+// blink led
+print("Commencing blinking (PC3)");
+eventLoop.subscribe(eventLoop.timer("periodic", 1000), function (_, _item, led, state) {
+    led.write(state);
+    return [led, !state];
+}, led, true);
+
+// read potentiometer when button is pressed
+print("Press the button (PC1)");
+eventLoop.subscribe(button.interrupt(), function (_, _item, pot) {
+    print("PC0 is at", pot.read_analog(), "mV");
+}, pot);
+
+// the program will just exit unless this is here
+eventLoop.run();
+
+// possible pins https://docs.flipper.net/gpio-and-modules#miFsS
+// "PA7" aka 2
+// "PA6" aka 3
+// "PA4" aka 4
+// "PB3" aka 5
+// "PB2" aka 6
+// "PC3" aka 7
+// "PA14" aka 10
+// "PA13" aka 12
+// "PB6" aka 13
+// "PB7" aka 14
+// "PC1" aka 15
+// "PC0" aka 16
+// "PB14" aka 17
+
+// possible modes
+// { direction: "out", outMode: "push_pull" }
+// { direction: "out", outMode: "open_drain" }
+// { direction: "out", outMode: "push_pull", altFn: true }
+// { direction: "out", outMode: "open_drain", altFn: true }
+// { direction: "in", inMode: "analog" }
+// { direction: "in", inMode: "plain_digital" }
+// { direction: "in", inMode: "interrupt", edge: "rising" }
+// { direction: "in", inMode: "interrupt", edge: "falling" }
+// { direction: "in", inMode: "interrupt", edge: "both" }
+// { direction: "in", inMode: "event", edge: "rising" }
+// { direction: "in", inMode: "event", edge: "falling" }
+// { direction: "in", inMode: "event", edge: "both" }
+// all variants support an optional `pull` field which can either be undefined,
+// "up" or "down"

applications/system/js_app/examples/apps/Scripts/gui.js

@@ -0,0 +1,77 @@
+// import modules
+let eventLoop = require("event_loop");
+let gui = require("gui");
+let loadingView = require("gui/loading");
+let submenuView = require("gui/submenu");
+let emptyView = require("gui/empty_screen");
+let textInputView = require("gui/text_input");
+let textBoxView = require("gui/text_box");
+let dialogView = require("gui/dialog");
+
+// declare view instances
+let views = {
+    loading: loadingView.make(),
+    empty: emptyView.make(),
+    keyboard: textInputView.makeWith({
+        header: "Enter your name",
+        minLength: 0,
+        maxLength: 32,
+    }),
+    helloDialog: dialogView.makeWith({
+        center: "Hi Flipper! :)",
+    }),
+    longText: textBoxView.makeWith({
+        text: "This is a very long string that demonstrates the TextBox view. Use the D-Pad to scroll backwards and forwards.\nLorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse rhoncus est malesuada quam egestas ultrices. Maecenas non eros a nulla eleifend vulputate et ut risus. Quisque in mauris mattis, venenatis risus eget, aliquam diam. Fusce pretium feugiat mauris, ut faucibus ex volutpat in. Phasellus volutpat ex sed gravida consectetur. Aliquam sed lectus feugiat, tristique lectus et, bibendum lacus. Ut sit amet augue eu sapien elementum aliquam quis vitae tortor. Vestibulum quis commodo odio. In elementum fermentum massa, eu pellentesque nibh cursus at. Integer eleifend lacus nec purus elementum sodales. Nulla elementum neque urna, non vulputate massa semper sed. Fusce ut nisi vitae dui blandit congue pretium vitae turpis.",
+    }),
+    demos: submenuView.makeWith({
+        header: "Choose a demo",
+        items: [
+            "Hourglass screen",
+            "Empty screen",
+            "Text input & Dialog",
+            "Text box",
+            "Exit app",
+        ],
+    }),
+};
+
+// demo selector
+eventLoop.subscribe(views.demos.chosen, function (_sub, index, gui, eventLoop, views) {
+    if (index === 0) {
+        gui.viewDispatcher.switchTo(views.loading);
+        // the loading view captures all back events, preventing our navigation callback from firing
+        // switch to the demo chooser after a second
+        eventLoop.subscribe(eventLoop.timer("oneshot", 1000), function (_sub, _, gui, views) {
+            gui.viewDispatcher.switchTo(views.demos);
+        }, gui, views);
+    } else if (index === 1) {
+        gui.viewDispatcher.switchTo(views.empty);
+    } else if (index === 2) {
+        gui.viewDispatcher.switchTo(views.keyboard);
+    } else if (index === 3) {
+        gui.viewDispatcher.switchTo(views.longText);
+    } else if (index === 4) {
+        eventLoop.stop();
+    }
+}, gui, eventLoop, views);
+
+// say hi after keyboard input
+eventLoop.subscribe(views.keyboard.input, function (_sub, name, gui, views) {
+    views.helloDialog.set("text", "Hi " + name + "! :)");
+    gui.viewDispatcher.switchTo(views.helloDialog);
+}, gui, views);
+
+// go back after the greeting dialog
+eventLoop.subscribe(views.helloDialog.input, function (_sub, button, gui, views) {
+    if (button === "center")
+        gui.viewDispatcher.switchTo(views.demos);
+}, gui, views);
+
+// go to the demo chooser screen when the back key is pressed
+eventLoop.subscribe(gui.viewDispatcher.navigation, function (_sub, _, gui, views) {
+    gui.viewDispatcher.switchTo(views.demos);
+}, gui, views);
+
+// run UI
+gui.viewDispatcher.switchTo(views.demos);
+eventLoop.run();

applications/system/js_app/examples/apps/Scripts/load.js

@@ -1,3 +1,3 @@
 let math = load("/ext/apps/Scripts/load_api.js");
 let result = math.add(5, 10);
-print(result);
+print(result);

applications/system/js_app/examples/apps/Scripts/load_api.js

@@ -1,3 +1,3 @@
 ({
     add: function (a, b) { return a + b; },
-})
+})

applications/system/js_app/examples/apps/Scripts/math.js

@@ -22,48 +22,3 @@ print("math.sign(-5):", math.sign(-5));
 print("math.sin(math.PI/2):", math.sin(math.PI / 2));
 print("math.sqrt(25):", math.sqrt(25));
 print("math.trunc(5.7):", math.trunc(5.7));
-
-// Unit tests. Please add more if you have time and knowledge.
-// math.EPSILON on Flipper Zero is 2.22044604925031308085e-16
-
-let succeeded = 0;
-let failed = 0;
-
-function test(text, result, expected, epsilon) {
-    let is_equal = math.is_equal(result, expected, epsilon);
-    if (is_equal)  {
-        succeeded += 1;
-    } else {
-        failed += 1;
-        print(text, "expected", expected, "got", result);
-    }
-}
-
-test("math.abs(5)", math.abs(-5), 5, math.EPSILON);
-test("math.abs(0.5)", math.abs(-0.5), 0.5, math.EPSILON);
-test("math.abs(5)", math.abs(5), 5, math.EPSILON);
-test("math.abs(-0.5)", math.abs(0.5), 0.5, math.EPSILON);
-test("math.acos(0.5)", math.acos(0.5), 1.0471975511965976, math.EPSILON);
-test("math.acosh(2)", math.acosh(2), 1.3169578969248166, math.EPSILON);
-test("math.asin(0.5)", math.asin(0.5), 0.5235987755982988, math.EPSILON);
-test("math.asinh(2)", math.asinh(2), 1.4436354751788103, math.EPSILON);
-test("math.atan(1)", math.atan(1), 0.7853981633974483, math.EPSILON);
-test("math.atan2(1, 1)", math.atan2(1, 1), 0.7853981633974483, math.EPSILON);
-test("math.atanh(0.5)", math.atanh(0.5), 0.5493061443340549, math.EPSILON);
-test("math.cbrt(27)", math.cbrt(27), 3, math.EPSILON);
-test("math.ceil(5.3)", math.ceil(5.3), 6, math.EPSILON);
-test("math.clz32(1)", math.clz32(1), 31, math.EPSILON);
-test("math.floor(5.7)", math.floor(5.7), 5, math.EPSILON);
-test("math.max(3, 5)", math.max(3, 5), 5, math.EPSILON);
-test("math.min(3, 5)", math.min(3, 5), 3, math.EPSILON);
-test("math.pow(2, 3)", math.pow(2, 3), 8, math.EPSILON);
-test("math.sign(-5)", math.sign(-5), -1, math.EPSILON);
-test("math.sqrt(25)", math.sqrt(25), 5, math.EPSILON);
-test("math.trunc(5.7)", math.trunc(5.7), 5, math.EPSILON);
-test("math.cos(math.PI)", math.cos(math.PI), -1, math.EPSILON * 18); // Error 3.77475828372553223744e-15
-test("math.exp(1)", math.exp(1), 2.718281828459045, math.EPSILON * 2); // Error 4.44089209850062616169e-16
-test("math.sin(math.PI / 2)", math.sin(math.PI / 2), 1, math.EPSILON * 4.5); // Error 9.99200722162640886381e-16
-
-if (failed > 0) {
-    print("!!!", failed, "Unit tests failed !!!");
-}

applications/system/js_app/examples/apps/Scripts/notify.js

@@ -6,4 +6,4 @@ delay(1000);
 for (let i = 0; i < 10; i++) {
     notify.blink("red", "short");
     delay(500);
-}
+}

applications/system/js_app/examples/apps/Scripts/submenu.js

@@ -1,11 +0,0 @@
-let submenu = require("submenu");
-
-submenu.addItem("Item 1", 0);
-submenu.addItem("Item 2", 1);
-submenu.addItem("Item 3", 2);
-
-submenu.setHeader("Select an option:");
-
-let result = submenu.show();
-// Returns undefined when pressing back
-print("Result:", result);

applications/system/js_app/examples/apps/Scripts/textbox.js

@@ -1,30 +0,0 @@
-let textbox = require("textbox");
-
-// You should set config before adding text
-// Focus (start / end), Font (text / hex)
-textbox.setConfig("end", "text");
-
-// Can make sure it's cleared before showing, in case of reusing in same script
-// (Closing textbox already clears the text, but maybe you added more in a loop for example)
-textbox.clearText();
-
-// Add default text
-textbox.addText("Example dynamic updating textbox\n");
-
-// Non-blocking, can keep updating text after, can close in JS or in GUI
-textbox.show();
-
-let i = 0;
-while (textbox.isOpen() && i < 20) {
-    print("console", i++);
-
-    // Add text to textbox buffer
-    textbox.addText("textbox " + to_string(i) + "\n");
-
-    delay(500);
-}
-
-// If not closed by user (instead i < 20 is false above), close forcefully
-if (textbox.isOpen()) {
-    textbox.close();
-}

applications/system/js_app/examples/apps/Scripts/uart_echo.js

@@ -6,6 +6,6 @@ while (1) {
     if (rx_data !== undefined) {
         serial.write(rx_data);
         let data_view = Uint8Array(rx_data);
-        print("0x" + to_hex_string(data_view[0]));
+        print("0x" + toString(data_view[0], 16));
     }
 }