Merge pull request #557 from gabriel-roth/aliases

Add user-defined aliases for modules

Author: danngreen

firmware/lib/patch-serial

@@ -16,7 +16,8 @@ get_full_element_name(unsigned module_id, unsigned element_idx, ElementType type
 	FullElementName fullname{"?", "?"};
 
 	if (module_id < patch.module_slugs.size()) {
-		fullname.module_name = ModuleFactory::getModuleDisplayName(patch.module_slugs[module_id]);
+		auto alias = patch.get_module_alias(static_cast<uint16_t>(module_id));
+		fullname.module_name = alias.empty() ? ModuleFactory::getModuleDisplayName(patch.module_slugs[module_id]) : alias;
 
 		auto &info = ModuleFactory::getModuleInfo(patch.module_slugs[module_id]);
 

firmware/src/gui/elements/element_name.cc

@@ -22,8 +22,11 @@ struct KeyboardEntry {
 		kb_popup.init(parent_obj, parent_group);
 	}
 
-	void show_keyboard(lv_obj_t *textarea_field, FunctionSized<16, void(std::string_view)> save_callback) {
+	void show_keyboard(lv_obj_t *textarea_field,
+					   FunctionSized<16, void(std::string_view)> save_callback,
+					   bool hide_field_on_dismiss = false) {
 		text_field = textarea_field;
+		hide_on_dismiss = hide_field_on_dismiss;
 
 		save_cb = save_callback;
 
@@ -78,6 +81,8 @@ struct KeyboardEntry {
 			if (text_field) {
 				lv_obj_clear_state(text_field, LV_STATE_USER_1);
 				lv_group_focus_obj(text_field);
+				if (hide_on_dismiss)
+					lv_hide(text_field);
 			}
 			lv_group_remove_obj(ui_Keyboard);
 			lv_hide(ui_Keyboard);
@@ -123,6 +128,7 @@ private:
 	lv_obj_t *text_field = nullptr;
 
 	bool kb_visible = false;
+	bool hide_on_dismiss = false;
 	ConfirmPopup kb_popup;
 
 	FunctionSized<16, void(std::string_view)> save_cb;

firmware/src/gui/pages/keyboard_entry.hh

@@ -1,8 +1,10 @@
 #pragma once
+#include "CoreModules/moduleFactory.hh"
 #include "fat_file_io.hh"
 #include "gui/gui_state.hh"
 #include "gui/helpers/lv_helpers.hh"
 #include "gui/notify/queue.hh"
+#include "gui/pages/keyboard_entry.hh"
 #include "gui/pages/module_view/automap.hh"
 #include "gui/pages/page_list.hh"
 #include "gui/pages/roller_popup.hh"
@@ -44,11 +46,27 @@ public:
 		, reset_params_{patch_mod_queue}
 		, group(lv_group_create())
 		, moduleViewActionPresetBut{create_lv_list_button(ui_ModuleViewActionMenu, "Presets")}
-		, moduleViewActionBypassBut{create_lv_list_button(ui_ModuleViewActionMenu, "Bypass: Off")} {
+		, moduleViewActionBypassBut{create_lv_list_button(ui_ModuleViewActionMenu, "Bypass: Off")}
+		, moduleViewActionRenameBut{create_lv_list_button(ui_ModuleViewActionMenu, "Rename...")}
+		, moduleViewActionResetNameBut{create_lv_list_button(ui_ModuleViewActionMenu, "Reset name")} {
 		lv_obj_set_parent(ui_ModuleViewActionMenu, lv_layer_top());
 		lv_show(ui_ModuleViewActionMenu);
 		lv_show(moduleViewActionPresetBut);
 		lv_show(moduleViewActionBypassBut);
+		lv_show(moduleViewActionRenameBut);
+		lv_hide(moduleViewActionResetNameBut);
+
+		rename_textarea = lv_textarea_create(lv_layer_top());
+		lv_hide(rename_textarea);
+		lv_textarea_set_max_length(rename_textarea, AliasNameString::capacity);
+		lv_textarea_set_one_line(rename_textarea, true);
+		lv_obj_set_width(rename_textarea, 300); // screen width (320) minus 10px margin each side
+		lv_obj_set_style_bg_opa(rename_textarea, LV_OPA_COVER, 0);
+		lv_obj_set_style_border_color(rename_textarea, lv_color_white(), LV_PART_CURSOR | LV_STATE_DEFAULT);
+		lv_obj_set_style_border_opa(rename_textarea, LV_OPA_COVER, LV_PART_CURSOR | LV_STATE_DEFAULT);
+		lv_obj_set_style_border_width(rename_textarea, 1, LV_PART_CURSOR | LV_STATE_DEFAULT);
+		lv_obj_set_style_border_side(rename_textarea, LV_BORDER_SIDE_LEFT, LV_PART_CURSOR | LV_STATE_DEFAULT);
+		lv_obj_add_event_cb(rename_textarea, textarea_changed_cb, LV_EVENT_VALUE_CHANGED, this);
 		lv_obj_set_x(ui_ModuleViewActionMenu, 160);
 		lv_obj_set_height(ui_ModuleViewActionMenu, 240);
 
@@ -64,6 +82,8 @@ public:
 		lv_obj_add_event_cb(ui_ModuleViewActionResetBut, reset_but_cb, LV_EVENT_CLICKED, this);
 		lv_obj_add_event_cb(ui_ModuleViewActionMidiBut, midi_but_cb, LV_EVENT_CLICKED, this);
 		lv_obj_add_event_cb(moduleViewActionBypassBut, bypass_but_cb, LV_EVENT_CLICKED, this);
+		lv_obj_add_event_cb(moduleViewActionRenameBut, rename_but_cb, LV_EVENT_CLICKED, this);
+		lv_obj_add_event_cb(moduleViewActionResetNameBut, reset_name_but_cb, LV_EVENT_CLICKED, this);
 
 		lv_group_add_obj(group, ui_ModuleViewActionAutopatchBut);
 		lv_group_add_obj(group, ui_ModuleViewActionAutoKnobSet);
@@ -72,6 +92,8 @@ public:
 		lv_group_add_obj(group, ui_ModuleViewActionMidiBut);
 		lv_group_add_obj(group, moduleViewActionPresetBut);
 		lv_group_add_obj(group, moduleViewActionBypassBut);
+		lv_group_add_obj(group, moduleViewActionRenameBut);
+		lv_group_add_obj(group, moduleViewActionResetNameBut);
 		lv_group_add_obj(group, ui_ModuleViewActionDeleteBut);
 		lv_group_set_wrap(group, false);
 	}
@@ -80,6 +102,8 @@ public:
 		this->module_idx = module_idx;
 		base_group = parent_group;
 		confirm_popup.init(lv_layer_top(), group);
+		reset_name_popup.init(lv_layer_top(), base_group);
+		keyboard_entry.prepare_focus(lv_layer_top(), base_group);
 
 		const auto module_slug = std::string{patches.get_view_patch()->module_slugs[module_idx]};
 		const auto module_name = module_slug.substr(module_slug.find_first_of(':') + 1);
@@ -129,8 +153,12 @@ public:
 			preset_popup.hide();
 		} else if (confirm_popup.is_visible()) {
 			confirm_popup.hide();
+		} else if (reset_name_popup.is_visible()) {
+			reset_name_popup.hide();
 		} else if (auto_map.is_visible()) {
 			auto_map.hide();
+		} else if (keyboard_entry.is_visible()) {
+			keyboard_entry.back();
 		} else if (visible) {
 			hide();
 		}
@@ -139,6 +167,7 @@ public:
 	void hide() {
 		preset_popup.hide();
 		confirm_popup.hide();
+		reset_name_popup.hide();
 		hide_menu();
 	}
 
@@ -154,6 +183,7 @@ public:
 
 	void show() {
 		update_bypass_text();
+		update_reset_name_visibility();
 		lv_group_focus_obj(ui_ModuleViewActionAutopatchBut);
 
 		if (!visible) {
@@ -170,6 +200,11 @@ public:
 		return visible;
 	}
 
+	bool keyboard_visible() {
+		// also covers reset_name_popup which intercepts back button -- consider renaming to modal_visible()
+		return keyboard_entry.is_visible() || reset_name_popup.is_visible();
+	}
+
 	void reactivate_group() {
 		lv_group_activate(group);
 	}
@@ -333,6 +368,11 @@ private:
 			lv_label_set_text(label, bypassed ? "Bypass: On" : "Bypass: Off");
 	}
 
+	void update_reset_name_visibility() {
+		auto alias = patches.get_view_patch()->get_module_alias(static_cast<uint16_t>(module_idx));
+		lv_show(moduleViewActionResetNameBut, !alias.empty());
+	}
+
 	static void bypass_but_cb(lv_event_t *event) {
 		if (!event || !event->user_data)
 			return;
@@ -351,6 +391,83 @@ private:
 			lv_label_set_text(label, new_state ? "Bypass: On" : "Bypass: Off");
 	}
 
+	static void reset_name_but_cb(lv_event_t *event) {
+		if (!event || !event->user_data)
+			return;
+		auto page = static_cast<ModuleViewActionMenu *>(event->user_data);
+		std::string msg;
+		{
+			auto *pd = page->patches.get_view_patch();
+			auto default_name = ModuleFactory::getModuleDisplayName(pd->module_slugs[page->module_idx]);
+			msg = "Reset module name to '" + std::string{default_name} + "'?";
+		}
+
+		page->hide_menu();
+		page->reset_name_popup.show(
+			[page](unsigned choice) {
+				if (choice == 1) {
+					auto *pd = page->patches.get_view_patch();
+					pd->set_module_alias(static_cast<uint16_t>(page->module_idx), "");
+					page->patches.mark_view_patch_modified();
+					auto display = ModuleFactory::getModuleDisplayName(pd->module_slugs[page->module_idx]);
+					lv_label_set_text(ui_ElementRollerModuleName, display.data());
+				}
+			},
+			msg.c_str(),
+			"Reset");
+	}
+
+	static void textarea_changed_cb(lv_event_t *event) {
+		if (!event || !event->user_data)
+			return;
+		auto page = static_cast<ModuleViewActionMenu *>(event->user_data);
+		std::string_view text = lv_textarea_get_text(page->rename_textarea);
+		auto *pd = page->patches.get_view_patch();
+		std::string_view display = text.empty()
+			? (page->pending_alias.empty()
+				? ModuleFactory::getModuleDisplayName(pd->module_slugs[page->module_idx])
+				: std::string_view{page->pending_alias})
+			: text;
+		lv_label_set_text(ui_ElementRollerModuleName, display.data());
+	}
+
+	static void rename_but_cb(lv_event_t *event) {
+		if (!event || !event->user_data)
+			return;
+		auto page = static_cast<ModuleViewActionMenu *>(event->user_data);
+
+		auto *pd = page->patches.get_view_patch();
+		auto alias = pd->get_module_alias(static_cast<uint16_t>(page->module_idx));
+
+		// Show current alias (or module name) as greyed-out placeholder; don't pre-fill
+		std::string_view placeholder = alias.empty()
+			? ModuleFactory::getModuleDisplayName(pd->module_slugs[page->module_idx])
+			: alias;
+		lv_textarea_set_placeholder_text(page->rename_textarea, placeholder.data());
+		lv_textarea_set_text(page->rename_textarea, "");
+		lv_label_set_text(ui_ElementRollerModuleName, placeholder.data());
+
+		page->hide_menu();
+		page->pending_alias = alias;
+		page->keyboard_entry.show_keyboard(
+			page->rename_textarea,
+			[page](std::string_view text) {
+				auto *pd = page->patches.get_view_patch();
+				// Empty text means user didn't type anything — preserve existing alias
+				std::string_view actual = text.empty() ? std::string_view{page->pending_alias} : text;
+				pd->set_module_alias(static_cast<uint16_t>(page->module_idx), actual);
+				page->patches.mark_view_patch_modified();
+
+				std::string_view display = actual.empty()
+					? ModuleFactory::getModuleDisplayName(pd->module_slugs[page->module_idx])
+					: actual;
+				lv_label_set_text(ui_ElementRollerModuleName, display.data());
+			},
+			/*hide_field_on_dismiss=*/true);
+		lv_show(page->rename_textarea);
+		lv_obj_align_to(page->rename_textarea, ui_Keyboard, LV_ALIGN_OUT_TOP_MID, 0, -4);
+	}
+
 	FatFileIO &ramdisk;
 	OpenPatchManager &patches;
 	PageList &page_list;
@@ -360,6 +477,7 @@ private:
 	NotificationQueue &notify_queue;
 
 	ConfirmPopup confirm_popup;
+	ConfirmPopup reset_name_popup;
 
 	ModuleViewAutoMapDialog auto_map;
 	RandomizeParams randomizer;
@@ -372,6 +490,11 @@ private:
 
 	lv_obj_t *moduleViewActionPresetBut;
 	lv_obj_t *moduleViewActionBypassBut;
+	lv_obj_t *moduleViewActionRenameBut;
+	lv_obj_t *moduleViewActionResetNameBut;
+	lv_obj_t *rename_textarea = nullptr;
+	std::string pending_alias{};
+	KeyboardEntry keyboard_entry;
 	std::string preset_path{};
 	uint16_t cur_preset_idx{};
 	std::string presets{};

firmware/src/gui/pages/module_view/action_menu.hh

@@ -178,7 +178,8 @@ private:
 	void name_knobset_by_modulename(uint16_t knobset_id) {
 		if (knobset_id < patch->knob_sets.size()) {
 			if (module_idx < patch->module_slugs.size()) {
-				auto module_display_name = ModuleFactory::getModuleDisplayName(patch->module_slugs[module_idx]);
+				auto alias = patch->get_module_alias(static_cast<uint16_t>(module_idx));
+				auto module_display_name = alias.empty() ? ModuleFactory::getModuleDisplayName(patch->module_slugs[module_idx]) : alias;
 				patch->knob_sets[knobset_id].name = module_display_name;
 			}
 		}

firmware/src/gui/pages/module_view/automap.hh

@@ -100,7 +100,8 @@ struct ModuleViewMappingPane {
 		args.detail_mode = true;
 
 		auto slug = patch->module_slugs[this_module_id];
-		auto display_name = ModuleFactory::getModuleDisplayName(slug);
+		auto alias = patch->get_module_alias(static_cast<uint16_t>(this_module_id));
+		auto display_name = alias.empty() ? ModuleFactory::getModuleDisplayName(slug) : alias;
 
 		// Knob name label
 		lv_label_set_text(ui_Module_Name, display_name.data());

firmware/src/gui/pages/module_view/mapping_pane.hh

@@ -116,8 +116,9 @@ struct ModuleViewPage : PageBase {
 			return;
 		}
 
-		auto module_display_name = ModuleFactory::getModuleDisplayName(slug);
-		lv_label_set_text(ui_ElementRollerModuleName, module_display_name.data());
+		auto alias = patch->get_module_alias(static_cast<uint16_t>(this_module_id));
+		auto display = alias.empty() ? ModuleFactory::getModuleDisplayName(slug) : alias;
+		lv_label_set_text(ui_ElementRollerModuleName, display.data());
 
 		has_context_menu = module_context_menu.create_options_menu(this_module_id);
 
@@ -166,7 +167,7 @@ struct ModuleViewPage : PageBase {
 		// Back button
 		if (gui_state.back_button.is_just_released()) {
 
-			if (action_menu.is_visible()) {
+			if (action_menu.is_visible() || action_menu.keyboard_visible()) {
 				action_menu.back();
 
 			} else if (settings_menu.is_visible()) {

firmware/src/gui/pages/module_view/module_view.hh

@@ -708,7 +708,10 @@ private:
 		page->highlighted_module_obj = this_module_obj;
 
 		const auto this_slug = page->patch->module_slugs[module_id];
-		if (auto display_name = ModuleFactory::getModuleDisplayName(this_slug); display_name.length()) {
+		auto alias = page->patch->get_module_alias(static_cast<uint16_t>(module_id));
+		if (!alias.empty()) {
+			lv_label_set_text(ui_ModuleName, alias.data());
+		} else if (auto display_name = ModuleFactory::getModuleDisplayName(this_slug); display_name.length()) {
 			lv_label_set_text(ui_ModuleName, display_name.data());
 		} else {
 			lv_label_set_text(ui_ModuleName, "");