6953: use native locale when comparing command names

src/cascadia/TerminalApp/CommandPalette.cpp

@@ -30,6 +30,8 @@ namespace winrt::TerminalApp::implementation
         _allCommands = winrt::single_threaded_vector<Command>();
         _tabActions = winrt::single_threaded_vector<Command>();
 
+        _userLocale = _loadUserLocale();
+
         _switchToMode(CommandPaletteMode::ActionMode);
 
         if (CommandPaletteShadow())
@@ -97,6 +99,33 @@ namespace winrt::TerminalApp::implementation
         _filteredActionsView().SelectionChanged({ this, &CommandPalette::_selectedCommandChanged });
     }
 
+    // Method Description:
+    // - Attempts to load user locale, to further use it when sorting the actions in the filtered view
+    // Return Value:
+    // - The user level locale, upon failure returns a default locale
+    std::locale CommandPalette::_loadUserLocale()
+    {
+        try
+        {
+            // Loading user locale name explicitly using GetUserDefaultLocaleName,
+            // as std:locale("") crashes on some setups.
+            wchar_t userLocaleName[LOCALE_NAME_MAX_LENGTH + 1];
+            auto localeNameSize = GetUserDefaultLocaleName(userLocaleName, ARRAYSIZE(userLocaleName));
+            if (localeNameSize == 0)
+            {
+                LOG_LAST_ERROR();
+                return std::locale();
+            }
+
+            std::wstring loadedLocale{ userLocaleName, gsl::narrow<unsigned int>(localeNameSize) };
+            return std::locale::locale(til::u16u8(loadedLocale));
+        }
+        CATCH_LOG();
+
+        // if something went wrong e.g., the required locale cannot be created, use the default one
+        return std::locale();
+    }
+
     // Method Description:
     // - Moves the focus up or down the list of commands. If we're at the top,
     //   we'll loop around to the bottom, and vice-versa.
@@ -778,11 +807,14 @@ namespace winrt::TerminalApp::implementation
     }
 
     // This is a helper to aid in sorting commands by their `Name`s, alphabetically.
-    static bool _compareCommandNames(const Command& lhs, const Command& rhs)
+    bool CommandPalette::_compareCommandNames(const Command& lhs, const Command& rhs)
     {
-        std::wstring_view leftName{ lhs.Name() };
-        std::wstring_view rightName{ rhs.Name() };
-        return leftName.compare(rightName) < 0;
+        // Pay attention that obtaining the facet involves a critical section.
+        // Irrelevant concern for now as no contention is expected.
+        const auto& userLocaleFacet = std::use_facet<std::collate<wchar_t>>(_userLocale);
+        const auto lhsName = lhs.Name();
+        const auto rhsName = rhs.Name();
+        return userLocaleFacet.compare(lhsName.data(), lhsName.data() + lhsName.size(), rhsName.data(), rhsName.data() + rhsName.size()) < 0;
     }
 
     // This is a helper struct to aid in sorting Commands by a given weighting.
@@ -791,6 +823,7 @@ namespace winrt::TerminalApp::implementation
         Command command;
         int weight;
         int inOrderCounter;
+        std::function<bool(const Command&, const Command&)> pfnCompareCommandNames;
 
         bool operator<(const WeightedCommand& other) const
         {
@@ -805,7 +838,7 @@ namespace winrt::TerminalApp::implementation
                 }
                 else
                 {
-                    return !_compareCommandNames(command, other.command);
+                    return !pfnCompareCommandNames(command, other.command);
                 }
             }
             return weight < other.weight;
@@ -828,6 +861,7 @@ namespace winrt::TerminalApp::implementation
         const bool addAll = searchText.empty();
 
         auto commandsToFilter = _commandsToFilter();
+        auto pfnCompareCommandNames = std::bind(&CommandPalette::_compareCommandNames, this, std::placeholders::_1, std::placeholders::_2);
 
         // If there's no filter text, then just add all the commands in order to the list.
         // - TODO GH#6647:Possibly add the MRU commands first in order, followed
@@ -856,7 +890,7 @@ namespace winrt::TerminalApp::implementation
             }
             std::sort(sortedCommands.begin(),
                       sortedCommands.end(),
-                      _compareCommandNames);
+                      pfnCompareCommandNames);
 
             for (auto action : sortedCommands)
             {
@@ -884,6 +918,7 @@ namespace winrt::TerminalApp::implementation
         // TODO GH#7205: Find a better way to ensure that WCs of the same
         // weight and name stay in the order in which they were pushed onto
         // the PQ.
+
         uint32_t counter = 0;
         for (auto action : commandsToFilter)
         {
@@ -894,6 +929,7 @@ namespace winrt::TerminalApp::implementation
                 wc.command = action;
                 wc.weight = weight;
                 wc.inOrderCounter = counter++;
+                wc.pfnCompareCommandNames = pfnCompareCommandNames;
 
                 heap.push(wc);
             }

src/cascadia/TerminalApp/CommandPalette.h

@@ -58,6 +58,9 @@ namespace winrt::TerminalApp::implementation
         Windows::Foundation::Collections::IVector<Microsoft::Terminal::Settings::Model::Command> _nestedActionStack{ nullptr };
 
         winrt::TerminalApp::ShortcutActionDispatch _dispatch;
+        std::locale _userLocale;
+
+        static std::locale _loadUserLocale();
         Windows::Foundation::Collections::IVector<Microsoft::Terminal::Settings::Model::Command> _commandsToFilter();
 
         bool _lastFilterTextWasEmpty{ true };
@@ -108,6 +111,8 @@ namespace winrt::TerminalApp::implementation
         void _dispatchCommand(const Microsoft::Terminal::Settings::Model::Command& command);
         void _dispatchCommandline();
         void _dismissPalette();
+
+        bool _compareCommandNames(const Microsoft::Terminal::Settings::Model::Command& lhs, const Microsoft::Terminal::Settings::Model::Command& rhs);
     };
 }