[FL-3947] Pinning of settings options (#4077)

* feat: pinning settings in favorites

* include archive in unit tests fw

* change settings icon

* update text with suggestions from the ui team

* Small touch of constness

---------

Co-authored-by: あく <alleteam@gmail.com>
Co-authored-by: hedger <hedger@users.noreply.github.com>
Co-authored-by: hedger <hedger@nanode.su>

lib/toolbox/settings_helpers/submenu_based.c

@@ -0,0 +1,103 @@
+#include "submenu_based.h"
+#include <archive/helpers/archive_favorites.h>
+
+struct SubmenuSettingsHelper {
+    const SubmenuSettingsHelperDescriptor* descriptor;
+    ViewDispatcher* view_dispatcher;
+    SceneManager* scene_manager;
+    Submenu* submenu;
+    uint32_t submenu_view_id;
+    uint32_t main_scene_id;
+};
+
+SubmenuSettingsHelper*
+    submenu_settings_helpers_alloc(const SubmenuSettingsHelperDescriptor* descriptor) {
+    furi_check(descriptor);
+    SubmenuSettingsHelper* helper = malloc(sizeof(SubmenuSettingsHelper));
+    helper->descriptor = descriptor;
+    return helper;
+}
+
+void submenu_settings_helpers_assign_objects(
+    SubmenuSettingsHelper* helper,
+    ViewDispatcher* view_dispatcher,
+    SceneManager* scene_manager,
+    Submenu* submenu,
+    uint32_t submenu_view_id,
+    uint32_t main_scene_id) {
+    furi_check(helper);
+    furi_check(view_dispatcher);
+    furi_check(scene_manager);
+    furi_check(submenu);
+    helper->view_dispatcher = view_dispatcher;
+    helper->scene_manager = scene_manager;
+    helper->submenu = submenu;
+    helper->submenu_view_id = submenu_view_id;
+    helper->main_scene_id = main_scene_id;
+}
+
+void submenu_settings_helpers_free(SubmenuSettingsHelper* helper) {
+    free(helper);
+}
+
+bool submenu_settings_helpers_app_start(SubmenuSettingsHelper* helper, void* arg) {
+    furi_check(helper);
+    if(!arg) return false;
+
+    const char* option = arg;
+    for(size_t i = 0; i < helper->descriptor->options_cnt; i++) {
+        if(strcmp(helper->descriptor->options[i].name, option) == 0) {
+            scene_manager_next_scene(
+                helper->scene_manager, helper->descriptor->options[i].scene_id);
+            return true;
+        }
+    }
+
+    return false;
+}
+
+static void
+    submenu_settings_helpers_callback(void* context, InputType input_type, uint32_t index) {
+    SubmenuSettingsHelper* helper = context;
+    if(input_type == InputTypeShort) {
+        view_dispatcher_send_custom_event(helper->view_dispatcher, index);
+    } else if(input_type == InputTypeLong) {
+        archive_favorites_handle_setting_pin_unpin(
+            helper->descriptor->app_name, helper->descriptor->options[index].name);
+    }
+}
+
+void submenu_settings_helpers_scene_enter(SubmenuSettingsHelper* helper) {
+    furi_check(helper);
+    for(size_t i = 0; i < helper->descriptor->options_cnt; i++) {
+        submenu_add_item_ex(
+            helper->submenu,
+            helper->descriptor->options[i].name,
+            i,
+            submenu_settings_helpers_callback,
+            helper);
+    }
+
+    submenu_set_selected_item(
+        helper->submenu,
+        scene_manager_get_scene_state(helper->scene_manager, helper->main_scene_id));
+    view_dispatcher_switch_to_view(helper->view_dispatcher, helper->submenu_view_id);
+}
+
+bool submenu_settings_helpers_scene_event(SubmenuSettingsHelper* helper, SceneManagerEvent event) {
+    furi_check(helper);
+
+    if(event.type == SceneManagerEventTypeCustom) {
+        scene_manager_next_scene(
+            helper->scene_manager, helper->descriptor->options[event.event].scene_id);
+        scene_manager_set_scene_state(helper->scene_manager, helper->main_scene_id, event.event);
+        return true;
+    }
+
+    return false;
+}
+
+void submenu_settings_helpers_scene_exit(SubmenuSettingsHelper* helper) {
+    furi_check(helper);
+    submenu_reset(helper->submenu);
+}

lib/toolbox/settings_helpers/submenu_based.h

@@ -0,0 +1,89 @@
+#include <gui/modules/submenu.h>
+#include <gui/view_dispatcher.h>
+#include <gui/scene_manager.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef void (*SubmenuSettingsHelpherCallback)(void* context, uint32_t index);
+
+typedef struct {
+    const char* name;
+    uint32_t scene_id;
+} SubmenuSettingsHelperOption;
+
+typedef struct {
+    const char* app_name;
+    size_t options_cnt;
+    SubmenuSettingsHelperOption options[];
+} SubmenuSettingsHelperDescriptor;
+
+typedef struct SubmenuSettingsHelper SubmenuSettingsHelper;
+
+/**
+ * @brief Allocates a submenu-based settings helper
+ * @param descriptor settings descriptor
+ */
+SubmenuSettingsHelper*
+    submenu_settings_helpers_alloc(const SubmenuSettingsHelperDescriptor* descriptor);
+
+/**
+ * @brief Assigns dynamic objects to the submenu-based settings helper
+ * @param helper          helper object
+ * @param view_dispatcher ViewDispatcher
+ * @param scene_manager   SceneManager
+ * @param submenu         Submenu
+ * @param submenu_view_id Submenu view id in the ViewDispatcher
+ * @param main_scene_id   Main scene id in the SceneManager
+ */
+void submenu_settings_helpers_assign_objects(
+    SubmenuSettingsHelper* helper,
+    ViewDispatcher* view_dispatcher,
+    SceneManager* scene_manager,
+    Submenu* submenu,
+    uint32_t submenu_view_id,
+    uint32_t main_scene_id);
+
+/**
+ * @brief Frees a submenu-based settings helper
+ * @param helper helper object
+ */
+void submenu_settings_helpers_free(SubmenuSettingsHelper* helper);
+
+/**
+ * @brief App start callback for the submenu-based settings helper
+ * 
+ * If an argument containing one of the options was provided, launches the
+ * corresponding scene.
+ * 
+ * @param helper helper object
+ * @param arg app argument, may be NULL
+ * @returns true if a setting name was provided in the argument, false if normal
+ *          app operation shall commence
+ */
+bool submenu_settings_helpers_app_start(SubmenuSettingsHelper* helper, void* arg);
+
+/**
+ * @brief Main scene enter callback for the submenu-based settings helper
+ * @param helper helper object
+ */
+void submenu_settings_helpers_scene_enter(SubmenuSettingsHelper* helper);
+
+/**
+ * @brief Main scene event callback for the submenu-based settings helper
+ * @param helper helper object
+ * @param event  event data
+ * @returns true if the event was consumed, false otherwise
+ */
+bool submenu_settings_helpers_scene_event(SubmenuSettingsHelper* helper, SceneManagerEvent event);
+
+/**
+ * @brief Main scene exit callback for the submenu-based settings helper
+ * @param helper helper object
+ */
+void submenu_settings_helpers_scene_exit(SubmenuSettingsHelper* helper);
+
+#ifdef __cplusplus
+}
+#endif