android: Visualize disabled home options

Allow for displaying options in the home options that are disabled with messages that explain why they are disabled.

This includes reasoning for the GPU driver installation button.

.ci/scripts/windows/docker.sh

@@ -56,7 +56,6 @@ for i in package/*.exe; do
   x86_64-w64-mingw32-strip "${i}"
 done
 
-pip3 install pefile
 python3 .ci/scripts/windows/scan_dll.py package/*.exe package/imageformats/*.dll "package/"
 
 # copy FFmpeg libraries

.github/workflows/android-build.yml

@@ -10,6 +10,7 @@ on:
 jobs:
   android:
     runs-on: ubuntu-latest
+    if: ${{ github.repository == 'yuzu-emu/yuzu-android' }}
     steps:
       - uses: actions/checkout@v3
         with:

.github/workflows/verify.yml

@@ -85,16 +85,17 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-msvc-
       - name: Install dependencies
-        # due to how chocolatey works, only cmd.exe is supported here
-        shell: cmd
+        shell: pwsh
         run: |
-          choco install wget
-          call refreshenv
-          wget https://github.com/mbitsnbites/buildcache/releases/download/v0.27.6/buildcache-windows.zip
-          7z x buildcache-windows.zip
-          copy buildcache\bin\buildcache.exe C:\ProgramData\chocolatey\bin
-          rmdir buildcache
-          echo %PATH% >> %GITHUB_PATH%
+          $ErrorActionPreference = "Stop"
+          $BuildCacheVer = "v0.28.4"
+          $File = "buildcache-windows.zip"
+          $Uri = "https://github.com/mbitsnbites/buildcache/releases/download/$BuildCacheVer/$File"
+          $WebClient = New-Object System.Net.WebClient
+          $WebClient.DownloadFile($Uri, $File)
+          7z x $File
+          $CurrentDir = Convert-Path .
+          echo "$CurrentDir/buildcache/bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
       - name: Install Vulkan SDK
         shell: pwsh
         run: .\.ci\scripts\windows\install-vulkan-sdk.ps1

src/android/app/src/main/AndroidManifest.xml

@@ -22,7 +22,7 @@ SPDX-License-Identifier: GPL-3.0-or-later
         android:label="@string/app_name_suffixed"
         android:icon="@drawable/ic_launcher"
         android:allowBackup="true"
-        android:hasFragileUserData="true"
+        android:hasFragileUserData="false"
         android:supportsRtl="true"
         android:isGame="true"
         android:localeConfig="@xml/locales_config"

src/android/app/src/main/java/org/yuzu/yuzu_emu/adapters/HomeSettingAdapter.kt

@@ -12,6 +12,7 @@ import androidx.core.content.res.ResourcesCompat
 import androidx.recyclerview.widget.RecyclerView
 import org.yuzu.yuzu_emu.R
 import org.yuzu.yuzu_emu.databinding.CardHomeOptionBinding
+import org.yuzu.yuzu_emu.fragments.MessageDialogFragment
 import org.yuzu.yuzu_emu.model.HomeSetting
 
 class HomeSettingAdapter(private val activity: AppCompatActivity, var options: List<HomeSetting>) :
@@ -34,7 +35,14 @@ class HomeSettingAdapter(private val activity: AppCompatActivity, var options: L
 
     override fun onClick(view: View) {
         val holder = view.tag as HomeOptionViewHolder
-        holder.option.onClick.invoke()
+        if (holder.option.isEnabled.invoke()) {
+            holder.option.onClick.invoke()
+        } else {
+            MessageDialogFragment.newInstance(
+                holder.option.disabledTitleId,
+                holder.option.disabledMessageId
+            ).show(activity.supportFragmentManager, MessageDialogFragment.TAG)
+        }
     }
 
     inner class HomeOptionViewHolder(val binding: CardHomeOptionBinding) :
@@ -65,6 +73,12 @@ class HomeSettingAdapter(private val activity: AppCompatActivity, var options: L
                             R.drawable.premium_background
                         )
             }
+
+            if (!option.isEnabled.invoke()) {
+                binding.optionTitle.alpha = 0.5f
+                binding.optionDescription.alpha = 0.5f
+                binding.optionIcon.alpha = 0.5f
+            }
         }
     }
 }

src/android/app/src/main/java/org/yuzu/yuzu_emu/fragments/HomeSettingsFragment.kt

@@ -73,102 +73,113 @@ class HomeSettingsFragment : Fragment() {
                 HomeSetting(
                     R.string.advanced_settings,
                     R.string.settings_description,
-                    R.drawable.ic_settings
-                ) { SettingsActivity.launch(requireContext(), SettingsFile.FILE_NAME_CONFIG, "") }
+                    R.drawable.ic_settings,
+                    { SettingsActivity.launch(requireContext(), SettingsFile.FILE_NAME_CONFIG, "") }
+                )
             )
             add(
                 HomeSetting(
                     R.string.open_user_folder,
                     R.string.open_user_folder_description,
-                    R.drawable.ic_folder_open
-                ) { openFileManager() }
+                    R.drawable.ic_folder_open,
+                    { openFileManager() }
+                )
             )
             add(
                 HomeSetting(
                     R.string.preferences_theme,
                     R.string.theme_and_color_description,
-                    R.drawable.ic_palette
-                ) { SettingsActivity.launch(requireContext(), Settings.SECTION_THEME, "") }
-            )
-
-            if (GpuDriverHelper.supportsCustomDriverLoading()) {
-                add(
-                    HomeSetting(
-                        R.string.install_gpu_driver,
-                        R.string.install_gpu_driver_description,
-                        R.drawable.ic_exit
-                    ) { driverInstaller() }
+                    R.drawable.ic_palette,
+                    { SettingsActivity.launch(requireContext(), Settings.SECTION_THEME, "") }
                 )
-            }
-
+            )
+            add(
+                HomeSetting(
+                    R.string.install_gpu_driver,
+                    R.string.install_gpu_driver_description,
+                    R.drawable.ic_exit,
+                    { driverInstaller() },
+                    { GpuDriverHelper.supportsCustomDriverLoading() },
+                    R.string.custom_driver_not_supported,
+                    R.string.custom_driver_not_supported_description
+                )
+            )
             add(
                 HomeSetting(
                     R.string.install_amiibo_keys,
                     R.string.install_amiibo_keys_description,
-                    R.drawable.ic_nfc
-                ) { mainActivity.getAmiiboKey.launch(arrayOf("*/*")) }
+                    R.drawable.ic_nfc,
+                    { mainActivity.getAmiiboKey.launch(arrayOf("*/*")) }
+                )
             )
             add(
                 HomeSetting(
                     R.string.install_game_content,
                     R.string.install_game_content_description,
-                    R.drawable.ic_system_update_alt
-                ) { mainActivity.installGameUpdate.launch(arrayOf("*/*")) }
+                    R.drawable.ic_system_update_alt,
+                    { mainActivity.installGameUpdate.launch(arrayOf("*/*")) }
+                )
             )
             add(
                 HomeSetting(
                     R.string.select_games_folder,
                     R.string.select_games_folder_description,
-                    R.drawable.ic_add
-                ) {
-                    mainActivity.getGamesDirectory.launch(
-                        Intent(Intent.ACTION_OPEN_DOCUMENT_TREE).data
-                    )
-                }
+                    R.drawable.ic_add,
+                    {
+                        mainActivity.getGamesDirectory.launch(
+                            Intent(Intent.ACTION_OPEN_DOCUMENT_TREE).data
+                        )
+                    }
+                )
             )
             add(
                 HomeSetting(
                     R.string.manage_save_data,
                     R.string.import_export_saves_description,
-                    R.drawable.ic_save
-                ) {
-                    ImportExportSavesFragment().show(
-                        parentFragmentManager,
-                        ImportExportSavesFragment.TAG
-                    )
-                }
+                    R.drawable.ic_save,
+                    {
+                        ImportExportSavesFragment().show(
+                            parentFragmentManager,
+                            ImportExportSavesFragment.TAG
+                        )
+                    }
+                )
             )
             add(
                 HomeSetting(
                     R.string.install_prod_keys,
                     R.string.install_prod_keys_description,
-                    R.drawable.ic_unlock
-                ) { mainActivity.getProdKey.launch(arrayOf("*/*")) }
+                    R.drawable.ic_unlock,
+                    { mainActivity.getProdKey.launch(arrayOf("*/*")) }
+                )
             )
             add(
                 HomeSetting(
                     R.string.install_firmware,
                     R.string.install_firmware_description,
-                    R.drawable.ic_firmware
-                ) { mainActivity.getFirmware.launch(arrayOf("application/zip")) }
+                    R.drawable.ic_firmware,
+                    { mainActivity.getFirmware.launch(arrayOf("application/zip")) }
+                )
             )
             add(
                 HomeSetting(
                     R.string.share_log,
                     R.string.share_log_description,
-                    R.drawable.ic_log
-                ) { shareLog() }
+                    R.drawable.ic_log,
+                    { shareLog() }
+                )
             )
             add(
                 HomeSetting(
                     R.string.about,
                     R.string.about_description,
-                    R.drawable.ic_info_outline
-                ) {
-                    exitTransition = MaterialSharedAxis(MaterialSharedAxis.X, true)
-                    parentFragmentManager.primaryNavigationFragment?.findNavController()
-                        ?.navigate(R.id.action_homeSettingsFragment_to_aboutFragment)
-                }
+                    R.drawable.ic_info_outline,
+                    {
+                        exitTransition = MaterialSharedAxis(MaterialSharedAxis.X, true)
+                        parentFragmentManager.primaryNavigationFragment?.findNavController()
+                            ?.navigate(R.id.action_homeSettingsFragment_to_aboutFragment)
+                    }
+                )
             )
         }
 
@@ -178,12 +189,13 @@ class HomeSettingsFragment : Fragment() {
                 HomeSetting(
                     R.string.get_early_access,
                     R.string.get_early_access_description,
-                    R.drawable.ic_diamond
-                ) {
-                    exitTransition = MaterialSharedAxis(MaterialSharedAxis.X, true)
-                    parentFragmentManager.primaryNavigationFragment?.findNavController()
-                        ?.navigate(R.id.action_homeSettingsFragment_to_earlyAccessFragment)
-                }
+                    R.drawable.ic_diamond,
+                    {
+                        exitTransition = MaterialSharedAxis(MaterialSharedAxis.X, true)
+                        parentFragmentManager.primaryNavigationFragment?.findNavController()
+                            ?.navigate(R.id.action_homeSettingsFragment_to_earlyAccessFragment)
+                    }
+                )
             )
         }
 

src/android/app/src/main/java/org/yuzu/yuzu_emu/model/HomeSetting.kt

@@ -7,5 +7,8 @@ data class HomeSetting(
     val titleId: Int,
     val descriptionId: Int,
     val iconId: Int,
-    val onClick: () -> Unit
+    val onClick: () -> Unit,
+    val isEnabled: () -> Boolean = { true },
+    val disabledTitleId: Int = 0,
+    val disabledMessageId: Int = 0
 )

src/android/app/src/main/res/values/strings.xml

@@ -113,6 +113,8 @@
     <string name="install_game_content_success_install">%1$d installed successfully</string>
     <string name="install_game_content_success_overwrite">%1$d overwritten successfully</string>
     <string name="install_game_content_help_link">https://yuzu-emu.org/help/quickstart/#dumping-installed-updates</string>
+    <string name="custom_driver_not_supported">Custom drivers not supported</string>
+    <string name="custom_driver_not_supported_description">Custom driver loading isn\'t currently supported for this device.\nCheck this option again in the future to see if support was added!</string>
 
     <!-- About screen strings -->
     <string name="gaia_is_not_real">Gaia isn\'t real</string>

src/common/settings.cpp

@@ -27,8 +27,8 @@ std::string GetTimeZoneString() {
     std::string location_name;
     if (time_zone_index == 0) { // Auto
 #if __cpp_lib_chrono >= 201907L
-        const struct std::chrono::tzdb& time_zone_data = std::chrono::get_tzdb();
         try {
+            const struct std::chrono::tzdb& time_zone_data = std::chrono::get_tzdb();
             const std::chrono::time_zone* current_zone = time_zone_data.current_zone();
             std::string_view current_zone_name = current_zone->name();
             location_name = current_zone_name;

src/core/arm/arm_interface.cpp

@@ -185,7 +185,7 @@ void ARM_Interface::Run() {
         // Notify the debugger and go to sleep if a breakpoint was hit,
         // or if the thread is unable to continue for any reason.
         if (True(hr & HaltReason::InstructionBreakpoint) || True(hr & HaltReason::PrefetchAbort)) {
-            if (!True(hr & HaltReason::InstructionBreakpoint)) {
+            if (!True(hr & HaltReason::PrefetchAbort)) {
                 RewindBreakpointInstruction();
             }
             if (system.DebuggerEnabled()) {

src/input_common/drivers/sdl_driver.cpp

@@ -523,8 +523,6 @@ SDLDriver::SDLDriver(std::string input_engine_) : InputEngine(std::move(input_en
     }
 
     SDL_SetHint(SDL_HINT_JOYSTICK_HIDAPI_SWITCH_PLAYER_LED, "1");
-    // Share the same button mapping with non-Nintendo controllers
-    SDL_SetHint(SDL_HINT_GAMECONTROLLER_USE_BUTTON_LABELS, "0");
 
     // Disable hidapi driver for xbox. Already default on Windows, this causes conflict with native
     // driver on Linux.
@@ -802,9 +800,16 @@ ButtonMapping SDLDriver::GetButtonMappingForDevice(const Common::ParamPackage& p
 
     // This list is missing ZL/ZR since those are not considered buttons in SDL GameController.
     // We will add those afterwards
+    // This list also excludes Screenshot since there's not really a mapping for that
     ButtonBindings switch_to_sdl_button;
 
-    switch_to_sdl_button = GetDefaultButtonBinding(joystick);
+    if (SDL_GameControllerGetType(controller) == SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_PRO ||
+        SDL_GameControllerGetType(controller) == SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_LEFT ||
+        SDL_GameControllerGetType(controller) == SDL_CONTROLLER_TYPE_NINTENDO_SWITCH_JOYCON_RIGHT) {
+        switch_to_sdl_button = GetNintendoButtonBinding(joystick);
+    } else {
+        switch_to_sdl_button = GetDefaultButtonBinding();
+    }
 
     // Add the missing bindings for ZL/ZR
     static constexpr ZButtonBindings switch_to_sdl_axis{{
@@ -825,9 +830,32 @@ ButtonMapping SDLDriver::GetButtonMappingForDevice(const Common::ParamPackage& p
     return GetSingleControllerMapping(joystick, switch_to_sdl_button, switch_to_sdl_axis);
 }
 
-ButtonBindings SDLDriver::GetDefaultButtonBinding(
+ButtonBindings SDLDriver::GetDefaultButtonBinding() const {
+    return {
+        std::pair{Settings::NativeButton::A, SDL_CONTROLLER_BUTTON_B},
+        {Settings::NativeButton::B, SDL_CONTROLLER_BUTTON_A},
+        {Settings::NativeButton::X, SDL_CONTROLLER_BUTTON_Y},
+        {Settings::NativeButton::Y, SDL_CONTROLLER_BUTTON_X},
+        {Settings::NativeButton::LStick, SDL_CONTROLLER_BUTTON_LEFTSTICK},
+        {Settings::NativeButton::RStick, SDL_CONTROLLER_BUTTON_RIGHTSTICK},
+        {Settings::NativeButton::L, SDL_CONTROLLER_BUTTON_LEFTSHOULDER},
+        {Settings::NativeButton::R, SDL_CONTROLLER_BUTTON_RIGHTSHOULDER},
+        {Settings::NativeButton::Plus, SDL_CONTROLLER_BUTTON_START},
+        {Settings::NativeButton::Minus, SDL_CONTROLLER_BUTTON_BACK},
+        {Settings::NativeButton::DLeft, SDL_CONTROLLER_BUTTON_DPAD_LEFT},
+        {Settings::NativeButton::DUp, SDL_CONTROLLER_BUTTON_DPAD_UP},
+        {Settings::NativeButton::DRight, SDL_CONTROLLER_BUTTON_DPAD_RIGHT},
+        {Settings::NativeButton::DDown, SDL_CONTROLLER_BUTTON_DPAD_DOWN},
+        {Settings::NativeButton::SL, SDL_CONTROLLER_BUTTON_LEFTSHOULDER},
+        {Settings::NativeButton::SR, SDL_CONTROLLER_BUTTON_RIGHTSHOULDER},
+        {Settings::NativeButton::Home, SDL_CONTROLLER_BUTTON_GUIDE},
+        {Settings::NativeButton::Screenshot, SDL_CONTROLLER_BUTTON_MISC1},
+    };
+}
+
+ButtonBindings SDLDriver::GetNintendoButtonBinding(
     const std::shared_ptr<SDLJoystick>& joystick) const {
-    // Default SL/SR mapping for other controllers
+    // Default SL/SR mapping for pro controllers
     auto sl_button = SDL_CONTROLLER_BUTTON_LEFTSHOULDER;
     auto sr_button = SDL_CONTROLLER_BUTTON_RIGHTSHOULDER;
 
@@ -841,10 +869,10 @@ ButtonBindings SDLDriver::GetDefaultButtonBinding(
     }
 
     return {
-        std::pair{Settings::NativeButton::A, SDL_CONTROLLER_BUTTON_B},
-        {Settings::NativeButton::B, SDL_CONTROLLER_BUTTON_A},
-        {Settings::NativeButton::X, SDL_CONTROLLER_BUTTON_Y},
-        {Settings::NativeButton::Y, SDL_CONTROLLER_BUTTON_X},
+        std::pair{Settings::NativeButton::A, SDL_CONTROLLER_BUTTON_A},
+        {Settings::NativeButton::B, SDL_CONTROLLER_BUTTON_B},
+        {Settings::NativeButton::X, SDL_CONTROLLER_BUTTON_X},
+        {Settings::NativeButton::Y, SDL_CONTROLLER_BUTTON_Y},
         {Settings::NativeButton::LStick, SDL_CONTROLLER_BUTTON_LEFTSTICK},
         {Settings::NativeButton::RStick, SDL_CONTROLLER_BUTTON_RIGHTSTICK},
         {Settings::NativeButton::L, SDL_CONTROLLER_BUTTON_LEFTSHOULDER},

src/input_common/drivers/sdl_driver.h

@@ -100,8 +100,11 @@ private:
                                                     int axis_y, float offset_x,
                                                     float offset_y) const;
 
-    /// Returns the default button bindings list
-    ButtonBindings GetDefaultButtonBinding(const std::shared_ptr<SDLJoystick>& joystick) const;
+    /// Returns the default button bindings list for generic controllers
+    ButtonBindings GetDefaultButtonBinding() const;
+
+    /// Returns the default button bindings list for nintendo controllers
+    ButtonBindings GetNintendoButtonBinding(const std::shared_ptr<SDLJoystick>& joystick) const;
 
     /// Returns the button mappings from a single controller
     ButtonMapping GetSingleControllerMapping(const std::shared_ptr<SDLJoystick>& joystick,