(WiiU) Add new "Allow Wii U HOME menu" setting

Users who prefer the old legacy behaviour of the Home button opening the RetroArch menu, they can disable the HBM here.

Author: ashquarky

config.def.h

@@ -943,6 +943,12 @@
 #define DEFAULT_ALL_USERS_CONTROL_MENU false
 #endif
 
+#if defined(WIIU)
+/* On Wii U, whether the HOME button should open the OS's HOME menu, or simply toggle the RetroArch menu (as it did in
+ * older HBL/Tiramisu builds of RetroArch) */
+#define DEFAULT_WIIU_ENABLE_HBM true
+#endif
+
 #define DEFAULT_QUIT_PRESS_TWICE true
 
 #define DEFAULT_LOG_TO_FILE false

configuration.c

@@ -2103,6 +2103,9 @@ static struct config_bool_setting *populate_settings_bool(
 #endif
 #if defined(HAVE_DINPUT) || defined(HAVE_WINRAWINPUT)
    SETTING_BOOL("input_nowinkey_enable",         &settings->bools.input_nowinkey_enable, true, false, false);
+#endif
+#ifdef WIIU
+   SETTING_BOOL("input_wiiu_enable_hbm",         &settings->bools.input_wiiu_enable_hbm, true, DEFAULT_WIIU_ENABLE_HBM, false);
 #endif
    SETTING_BOOL("input_sensors_enable",          &settings->bools.input_sensors_enable, true, DEFAULT_INPUT_SENSORS_ENABLE, false);
    SETTING_BOOL("vibrate_on_keypress",           &settings->bools.vibrate_on_keypress, true, DEFAULT_VIBRATE_ON_KEYPRESS, false);

configuration.h

@@ -704,6 +704,9 @@ typedef struct settings
       bool input_touch_vmouse_trackball;
       bool input_touch_vmouse_gesture;
 #endif
+#ifdef WIIU
+        bool input_wiiu_enable_hbm;
+#endif
 
       /* Frame time counter */
       bool frame_time_counter_reset_after_fastforwarding;

frontend/drivers/platform_wiiu.c

@@ -47,6 +47,7 @@
 #include <whb/log_udp.h>
 #include <whb/log_cafe.h>
 
+#include "../configuration.h"
 #include "../frontend.h"
 #include "../frontend_driver.h"
 #include "../../file_path_special.h"
@@ -596,13 +597,25 @@ static bool swap_is_pending(void *start_time)
    return last_vsync < *(OSTime *)start_time;
 }
 
+static bool in_main = false;
+static uint32_t proc_home_button_deny(void *context)
+{
+   /* Don't toggle the menu in, like, the middle of a core switch */
+   if (in_main)
+      command_event(CMD_EVENT_MENU_TOGGLE, NULL);
+
+   return 0;
+}
+
 static void main_loop(void)
 {
    OSTime start_time;
    ProcUIStatus os_status;
    int status;
+   settings_t *settings = config_get_ptr();
 
-   OSEnableHomeButtonMenu(TRUE);
+   ProcUIRegisterCallback(PROCUI_CALLBACK_HOME_BUTTON_DENIED, &proc_home_button_deny, NULL, 1000);
+   in_main = true;
 
    while ((os_status = ProcUIProcessMessages(TRUE)) != PROCUI_STATUS_EXITING)
    {
@@ -631,8 +644,12 @@ static void main_loop(void)
          }
          ProcUIDrawDoneRelease();
       }
+
+      if (OSIsHomeButtonMenuEnabled() != settings->bools.input_wiiu_enable_hbm)
+         OSEnableHomeButtonMenu(settings->bools.input_wiiu_enable_hbm);
    }
 
+   in_main = false;
    OSEnableHomeButtonMenu(FALSE);
 }
 #endif

intl/msg_hash_lbl.h

@@ -1852,6 +1852,12 @@ MSG_HASH(
         "input_android_physical_keyboard"
 )
 #endif
+#ifdef WIIU
+MSG_HASH(
+   MENU_ENUM_LABEL_INPUT_WIIU_ENABLE_HBM,
+   "input_wiiu_enable_hbm"
+   )
+#endif
 MSG_HASH(
    MENU_ENUM_LABEL_INPUT_SENSORS_ENABLE,
    "input_sensors_enable"

intl/msg_hash_us.h

@@ -3613,6 +3613,16 @@ MSG_HASH(
    MENU_ENUM_SUBLABEL_INPUT_ALL_USERS_CONTROL_MENU,
    "Allow any user to control the menu. If disabled, only User 1 can control the menu."
    )
+#ifdef WIIU
+MSG_HASH(
+   MENU_ENUM_LABEL_VALUE_INPUT_WIIU_ENABLE_HBM,
+   "Allow Wii U HOME menu"
+   )
+MSG_HASH(
+   MENU_ENUM_SUBLABEL_INPUT_WIIU_ENABLE_HBM,
+   "Enable the Wii U's HOME menu overlay. If disabled, the Home button toggles the RetroArch menu."
+   )
+#endif
 
 /* Settings > Input > Hotkeys */
 

menu/cbs/menu_cbs_sublabel.c

@@ -534,6 +534,9 @@ DEFAULT_SUBLABEL_MACRO(action_bind_sublabel_location_allow,                MENU_
 DEFAULT_SUBLABEL_MACRO(action_bind_sublabel_input_max_users,               MENU_ENUM_SUBLABEL_INPUT_MAX_USERS)
 DEFAULT_SUBLABEL_MACRO(action_bind_sublabel_input_poll_type_behavior,      MENU_ENUM_SUBLABEL_INPUT_POLL_TYPE_BEHAVIOR)
 DEFAULT_SUBLABEL_MACRO(action_bind_sublabel_input_all_users_control_menu,  MENU_ENUM_SUBLABEL_INPUT_ALL_USERS_CONTROL_MENU)
+#ifdef WIIU
+DEFAULT_SUBLABEL_MACRO(action_bind_sublabel_input_wiiu_enable_hbm,         MENU_ENUM_SUBLABEL_INPUT_WIIU_ENABLE_HBM)
+#endif
 DEFAULT_SUBLABEL_MACRO(action_bind_sublabel_input_bind_timeout,            MENU_ENUM_SUBLABEL_INPUT_BIND_TIMEOUT)
 DEFAULT_SUBLABEL_MACRO(action_bind_sublabel_input_bind_hold,               MENU_ENUM_SUBLABEL_INPUT_BIND_HOLD)
 DEFAULT_SUBLABEL_MACRO(action_bind_sublabel_audio_volume,                  MENU_ENUM_SUBLABEL_AUDIO_VOLUME)
@@ -4597,6 +4600,11 @@ int menu_cbs_init_bind_sublabel(menu_file_list_cbs_t *cbs,
          case MENU_ENUM_LABEL_INPUT_ALL_USERS_CONTROL_MENU:
             BIND_ACTION_SUBLABEL(cbs, action_bind_sublabel_input_all_users_control_menu);
             break;
+#ifdef WIIU
+         case MENU_ENUM_LABEL_INPUT_WIIU_ENABLE_HBM:
+            BIND_ACTION_SUBLABEL(cbs, action_bind_sublabel_input_wiiu_enable_hbm);
+            break;
+#endif
          case MENU_ENUM_LABEL_INPUT_POLL_TYPE_BEHAVIOR:
             BIND_ACTION_SUBLABEL(cbs, action_bind_sublabel_input_poll_type_behavior);
             break;

menu/menu_displaylist.c

@@ -7839,6 +7839,9 @@ unsigned menu_displaylist_build_list(
                {MENU_ENUM_LABEL_MENU_INPUT_SWAP_OK_CANCEL,         PARSE_ONLY_BOOL,     true  },
                {MENU_ENUM_LABEL_MENU_INPUT_SWAP_SCROLL,            PARSE_ONLY_BOOL,     true  },
                {MENU_ENUM_LABEL_INPUT_ALL_USERS_CONTROL_MENU,      PARSE_ONLY_BOOL,     true  },
+#ifdef WIIU
+               {MENU_ENUM_LABEL_INPUT_WIIU_ENABLE_HBM,             PARSE_ONLY_BOOL,     true  },
+#endif
                {MENU_ENUM_LABEL_MENU_SCROLL_FAST,                  PARSE_ONLY_BOOL,     true  },
                {MENU_ENUM_LABEL_MENU_SCROLL_DELAY,                 PARSE_ONLY_UINT,     true  },
                {MENU_ENUM_LABEL_INPUT_DISABLE_INFO_BUTTON,         PARSE_ONLY_BOOL,     true  },

menu/menu_setting.c

@@ -15204,6 +15204,24 @@ static bool setting_append_list(
                   SD_FLAG_NONE
                   );
 
+#ifdef WIIU
+            CONFIG_BOOL(
+                  list, list_info,
+                  &settings->bools.input_wiiu_enable_hbm,
+                  MENU_ENUM_LABEL_INPUT_WIIU_ENABLE_HBM,
+                  MENU_ENUM_LABEL_VALUE_INPUT_WIIU_ENABLE_HBM,
+                  DEFAULT_WIIU_ENABLE_HBM,
+                  MENU_ENUM_LABEL_VALUE_OFF,
+                  MENU_ENUM_LABEL_VALUE_ON,
+                  &group_info,
+                  &subgroup_info,
+                  parent_group,
+                  general_write_handler,
+                  general_read_handler,
+                  SD_FLAG_NONE
+                  );
+#endif
+
             CONFIG_BOOL(
                   list, list_info,
                   &settings->bools.input_remap_binds_enable,

msg_hash.h

@@ -1346,6 +1346,8 @@ enum msg_hash_enums
 
    MENU_LABEL(ANDROID_INPUT_DISCONNECT_WORKAROUND),
 
+   MENU_LABEL(INPUT_WIIU_ENABLE_HBM),
+
    MENU_ENUM_LABEL_VALUE_QUIT_ON_CLOSE_CONTENT_DISABLED,
    MENU_ENUM_LABEL_VALUE_QUIT_ON_CLOSE_CONTENT_ENABLED,
    MENU_ENUM_LABEL_VALUE_QUIT_ON_CLOSE_CONTENT_CLI,