feat: implement scene manager based implementation

Author: Alex4386

README.md

@@ -50,3 +50,19 @@ Here are the resources for developing applications for Flipper Zero:
 - [Flipper Zero Firmware Docs](https://developer.flipper.net/flipperzero/doxygen/)
   - [`struct` list](https://developer.flipper.net/flipperzero/doxygen/annotated.html) ([index](https://developer.flipper.net/flipperzero/doxygen/classes.html))
 - [Flipper Zero code examples](https://github.com/m1ch3al/flipper-zero-dev-tutorial)
+- [Lopaka, Graphics Editor for Embedded Devices](https://lopaka.app/)  
+  Note that Flipper Zero has screen dimension of `128x64`.  
+  
+
+### How to use `SceneManager` with this project?
+This template implements `SceneManager`, A "Scene" based framework for programming flipper zero GUIs.
+
+Here is how you can add/modify scenes in this repository:
+1. Goto [`./src/scenes/list.h`](/src/scenes/list.h).  
+2. Add your own scene by using macro: `SCENE_ACTION`.
+   (e.g. If you want to make new scene called `Store`, You should type `SCENE_ACTION(Store)`)
+3. Implement `_on_enter`, `_on_event`, `_on_exit`, `_get_view`, `_alloc`, `_free` accordingly. Refer to [`./src/scenes/home/main.c`](/src/scenes/home/main.c) for more info.    
+   (F0 doesn't make sure the precendence of `_on_exit` and `_free`. Please make sure those two are independent by checking each other's free'd state)
+4. Add headers to export those functions.
+5. Include your header in [`./src/scenes/import.h`](/src/scenes/import.h).  
+

application.fam

@@ -5,14 +5,15 @@ App(
     appid="demo_app",  # Must be unique
     name="Demo Application",  # Displayed in UI
     apptype=FlipperAppType.EXTERNAL,
-    entry_point="main_entrypoint",
+    entry_point="entrypoint",
     stack_size=2 * 1024, # size of memory stack it will allocate
 
     # source code settings
-    sources=["src/*.c*", "src/*/*.c*"], # Due to limitation of the fbt,
-                                        # you need to specify nested directories
-                                        # manually since it doesn't support
-                                        # recurse globbing such as "src/**/*.c*"
+    sources=[            # Due to limitation of the fbt,
+      "src/*.c*",        # you need to specify nested directories
+      "src/*/*.c*",      # manually since it doesn't support
+      "src/*/*/*.c*"     # recurse globbing such as "src/**/*.c*"
+    ], 
 
     # Dependencies
     requires=[

src/entrypoint.c

@@ -0,0 +1,19 @@
+#include "main.h"
+
+bool scene_handler_event_forwarder(void* context, uint32_t event_id) {
+    App* app = (App*)context;
+    if(app == NULL || app->scene_manager == NULL) {
+        return false;
+    }
+
+    return scene_manager_handle_custom_event(app->scene_manager, event_id);
+}
+
+bool scene_handler_navigation_forwarder(void* context) {
+    App* app = (App*)context;
+    if(app == NULL || app->scene_manager == NULL) {
+        return false;
+    }
+
+    return scene_manager_handle_back_event(app->scene_manager);
+}

src/events.c

@@ -1,27 +1,36 @@
 #include <stdio.h>
 #include <furi.h>
 #include <gui/gui.h>
-#include "events.h"
-#include "utils/gui.h"
+#include "main.h"
+#include "scenes/register.h"
 
 int main() {
-    // 1. Provision the InputHandlers
-    // Handle input event
-    InputEvent event;
-    GUISetupData* gui_setup = setup_gui(on_draw, on_input);
-
-    // 2. Main EventLoop
-    while(true) {
-        // 4.1. Read input event from the message queue
-        furi_check(
-            furi_message_queue_get(gui_setup->msg_queue, &event, FuriWaitForever) == FuriStatusOk);
-
-        // 4.2. check if the event is a quit event
-        if(event.key == InputKeyBack) {
-            break;
-        }
-    }
-
-    // 3. Free the resources
-    free_gui(gui_setup);
+    App* app = malloc(sizeof(App));
+    furi_assert(app != NULL, "Failed to allocate memory for the app");
+
+    Gui* gui = furi_record_open(RECORD_GUI);
+    furi_assert(gui != NULL, "Failed to open the GUI record");
+
+    register_scenes(app);
+    view_dispatcher_attach_to_gui(app->view_dispatcher, gui, ViewDispatcherTypeFullscreen);
+
+    // The default scene is always the first one!
+    scene_manager_next_scene(app->scene_manager, 0);
+    view_dispatcher_switch_to_view(app->view_dispatcher, 0);
+
+    view_dispatcher_run(app->view_dispatcher);
+
+    FURI_LOG_I("DemoApp", "Exiting application.");
+    free_scenes(app);
+
+    FURI_LOG_I("DemoApp", "Freed app.");
+
+    return 0;
+}
+
+// Stub entrypoint due to gcc complaining about
+// mismatching main function signature.
+int32_t entrypoint(void* p) {
+    UNUSED(p);
+    return main();
 }

src/events.h

@@ -1,3 +1,29 @@
 #pragma once
 
-int main();
+#include <gui/scene_manager.h>
+#include <gui/view_dispatcher.h>
+#include "scenes/import.h"
+
+typedef struct App {
+    SceneManager* scene_manager;
+    ViewDispatcher* view_dispatcher;
+
+    void** allocated_scenes;
+} App;
+
+/**
+ * Enum for scenes.
+ */
+typedef enum {
+#define SCENE_ACTION(scene) scene,
+#include "scenes/list.h"
+#undef SCENE_ACTION
+
+    AppSceneNum, // This should be the last element in the enumeration.
+} AppViews;
+
+/**
+ * Header definition for handler.c
+ */
+bool scene_handler_event_forwarder(void* context, uint32_t event_id);
+bool scene_handler_navigation_forwarder(void* context);

src/handler.c

@@ -0,0 +1,72 @@
+#include <gui/view.h>
+#include <gui/modules/submenu.h>
+#include "../../main.h"
+#include "main.h"
+
+#define THIS_SCENE About
+
+void About_on_draw(Canvas* canvas, void* context);
+AppAbout* About_alloc() {
+    AppAbout* about = (AppAbout*)malloc(sizeof(AppAbout));
+    about->view = view_alloc();
+    view_set_draw_callback(about->view, About_on_draw);
+
+    return about;
+}
+
+void About_on_draw(Canvas* canvas, void* context) {
+    UNUSED(context);
+
+    canvas_clear(canvas);
+
+    canvas_set_bitmap_mode(canvas, true);
+    canvas_set_font(canvas, FontPrimary);
+    canvas_draw_str(canvas, 67, 11, "f0-template");
+    canvas_set_font(canvas, FontSecondary);
+    canvas_draw_str(canvas, 72, 20, "by Alex4386");
+    canvas_draw_line(canvas, 54, 25, 124, 25);
+    canvas_draw_str(canvas, 71, 39, "Protected by");
+    canvas_set_font(canvas, FontPrimary);
+    canvas_draw_str(canvas, 61, 51, "Fantasy Seal");
+    canvas_draw_str(canvas, 69, 61, "Technology");
+}
+
+void About_free(void* ptr) {
+    AppAbout* home = (AppAbout*)ptr;
+    FURI_LOG_I("DemoApp", "Triggering Free for view");
+
+    view_free(home->view);
+    home->view = NULL;
+
+    free(home);
+}
+
+View* About_get_view(void* ptr) {
+    AppAbout* home = (AppAbout*)ptr;
+    return home->view;
+}
+
+void About_on_enter(void* context) {
+    UNUSED(context);
+}
+
+bool About_on_event(void* context, SceneManagerEvent event) {
+    UNUSED(context);
+    UNUSED(event);
+
+    if(event.type == SceneManagerEventTypeBack) {
+        return false;
+    }
+
+    return true;
+}
+
+void About_on_exit(void* context) {
+    App* app = (App*)context;
+    if(app == NULL) {
+        return;
+    }
+
+    if(app->view_dispatcher) view_dispatcher_switch_to_view(app->view_dispatcher, Home);
+    if(app->scene_manager) scene_manager_previous_scene(app->scene_manager);
+}

src/main.c

@@ -0,0 +1,15 @@
+#pragma once
+#include <gui/view.h>
+#include <gui/modules/submenu.h>
+
+typedef struct AppAbout {
+    View* view;
+    Canvas* canvas;
+} AppAbout;
+
+AppAbout* About_alloc();
+void About_free(void* ptr);
+View* About_get_view(void* ptr);
+void About_on_enter(void* context);
+bool About_on_event(void* context, SceneManagerEvent event);
+void About_on_exit(void* context);