Add filter text box to new ride selection window (#19067)

* Add filter text box to new ride selection window

* update after snake_case refactor

* Change _filter to an instance variable, move textbox data assignment to OnPrepareDraw

* replace std::string_view with u8string_view

distribution/changelog.txt

@@ -16,6 +16,7 @@
 - Improved: [#19044] Added special thanks to RMC and Wiegand to the About page.
 - Improved: [#19131] Track missing objects when selecting scenery groups in console.
 - Improved: [#19253] Queue junctions drawn properly when using regular paths as queue.
+- Improved: [#19067] New Ride window now allows filtering similarly to Object Selection.
 - Change: [#19018] Renamed actions to fit the naming scheme.
 - Change: [#19091] [Plugin] Add game action information to callback arguments of custom actions.
 - Change: [#19233] Reduce lift speed minimum and maximum values for “Classic Wooden Coaster”.

src/openrct2-ui/windows/NewRide.cpp

@@ -27,6 +27,7 @@
 #include <openrct2/network/network.h>
 #include <openrct2/object/ObjectLimits.h>
 #include <openrct2/object/ObjectManager.h>
+#include <openrct2/object/ObjectRepository.h>
 #include <openrct2/object/RideObject.h>
 #include <openrct2/rct1/RCT1.h>
 #include <openrct2/ride/RideData.h>
@@ -193,6 +194,8 @@ enum
     WIDX_LAST_DEVELOPMENT_BUTTON,
     WIDX_RESEARCH_FUNDING_BUTTON,
 
+    WIDX_FILTER_TEXT_BOX,
+    WIDX_FILTER_CLEAR_BUTTON,
     WIDX_GROUP_BY_TRACK_TYPE,
 };
 
@@ -215,6 +218,8 @@ static Widget window_new_ride_widgets[] = {
     MakeWidget({  3, 124},             {290,  65},         WindowWidgetType::Groupbox, WindowColour::Tertiary,  STR_LAST_DEVELOPMENT                                          ),
     MakeWidget({265, 161},             { 24,  24},         WindowWidgetType::FlatBtn,  WindowColour::Tertiary,  0xFFFFFFFF,                      STR_RESEARCH_SHOW_DETAILS_TIP),
     MakeWidget({265,  68},             { 24,  24},         WindowWidgetType::FlatBtn,  WindowColour::Tertiary,  ImageId(SPR_FINANCE),                     STR_FINANCES_RESEARCH_TIP    ),
+    MakeWidget({  4,  46},             {211, 14},          WindowWidgetType::TextBox,  WindowColour::Secondary                          ),
+    MakeWidget({218,  46},             { 70, 14},          WindowWidgetType::Button,   WindowColour::Secondary, STR_OBJECT_SEARCH_CLEAR ),
     MakeWidget(GroupByTrackTypeOrigin, GroupTrackTypeSize, WindowWidgetType::Checkbox, WindowColour::Secondary, STR_GROUP_BY_TRACK_TYPE,         STR_GROUP_BY_TRACK_TYPE_TIP  ),
     WIDGETS_END,
 };
@@ -264,6 +269,7 @@ class NewRideWindow final : public Window
 private:
     static NewRideTabId _currentTab;
     static uint_fast16_t _windowNewRideTabScroll[RideTabCount];
+    u8string _filter;
     u8string _vehicleAvailability{};
     RideSelection _lastTrackDesignCountRideType{};
     int32_t _lastTrackDesignCount{};
@@ -285,6 +291,7 @@ public:
         widgets = window_new_ride_widgets;
         PopulateRideList();
         InitScrollWidgets();
+        _filter.clear();
 
         frame_no = 0;
         new_ride.SelectedRide = { RIDE_TYPE_NULL, OBJECT_ENTRY_INDEX_NULL };
@@ -309,6 +316,12 @@ public:
 
         WidgetInvalidate(*this, WIDX_TAB_1 + static_cast<int32_t>(_currentTab));
 
+        if (gCurrentTextBox.window.classification == classification && gCurrentTextBox.window.number == number)
+        {
+            WindowUpdateTextboxCaret();
+            WidgetInvalidate(*this, WIDX_FILTER_TEXT_BOX);
+        }
+
         if (new_ride.SelectedRide.Type != RIDE_TYPE_NULL && new_ride.selected_ride_countdown-- == 0)
         {
             RideSelect();
@@ -347,6 +360,14 @@ public:
                 ConfigSaveDefault();
                 SetPage(_currentTab);
                 break;
+            case WIDX_FILTER_TEXT_BOX:
+                WindowStartTextbox(*this, widgetIndex, STR_STRING, _filter.data(), MAX_PATH);
+                break;
+            case WIDX_FILTER_CLEAR_BUTTON:
+                _filter.clear();
+                scrolls->v_top = 0;
+                Invalidate();
+                break;
         }
     }
 
@@ -369,6 +390,8 @@ public:
 
         widgets[WIDX_TITLE].text = RideTitles[_currentTab];
         widgets[WIDX_TAB_7].type = WindowWidgetType::Tab;
+        widgets[WIDX_FILTER_TEXT_BOX].string = _filter.data();
+
         if (gScreenFlags & SCREEN_FLAGS_TRACK_DESIGNER)
             widgets[WIDX_TAB_7].type = WindowWidgetType::Empty;
 
@@ -488,6 +511,20 @@ public:
         }
     }
 
+    void OnTextInput(WidgetIndex widgetIndex, std::string_view text) override
+    {
+        if (widgetIndex != WIDX_FILTER_TEXT_BOX)
+            return;
+
+        if (text == _filter)
+            return;
+
+        _filter.assign(text);
+
+        scrolls->v_top = 0;
+        Invalidate();
+    }
+
     void SetPage(int tab)
     {
         if (tab >= TRANSPORT_TAB && tab < TAB_COUNT)
@@ -653,6 +690,11 @@ private:
                 continue;
             }
 
+            if (!IsFiltered(*rideEntry))
+            {
+                continue;
+            }
+
             highestVehiclePriority = rideEntry->BuildMenuPriority;
 
             // Determines how and where to draw a button for this ride type/vehicle.
@@ -698,6 +740,55 @@ private:
         return nextListItem;
     }
 
+    bool IsFiltered(const RideObjectEntry& rideEntry)
+    {
+        if (_filter.empty())
+            return true;
+
+        return IsFilterInRideType(rideEntry) || IsFilterInRideName(rideEntry) || IsFilterInIdentifier(rideEntry)
+            || IsFilterInAuthors(rideEntry) || IsFilterInFilename(rideEntry);
+    }
+
+    bool IsFilterInRideType(const RideObjectEntry& rideEntry)
+    {
+        auto rideTypeName = GetRideNaming(rideEntry.ride_type[0], rideEntry).Name;
+        return String::Contains(u8string_view(LanguageGetString(rideTypeName)), _filter, true);
+    }
+
+    bool IsFilterInRideName(const RideObjectEntry& rideEntry)
+    {
+        auto rideName = rideEntry.naming.Name;
+        return String::Contains(u8string_view(LanguageGetString(rideName)), _filter, true);
+    }
+
+    bool IsFilterInAuthors(const RideObjectEntry& rideEntry)
+    {
+        auto rideObject = static_cast<RideObject*>(rideEntry.obj);
+        auto authors = rideObject->GetAuthors();
+
+        for (auto author : authors)
+            if (String::Contains(author, _filter, true))
+                return true;
+
+        return false;
+    }
+
+    bool IsFilterInIdentifier(const RideObjectEntry& rideEntry)
+    {
+        auto rideObject = static_cast<RideObject*>(rideEntry.obj);
+        auto objectName = rideObject->GetObjectEntry().GetName();
+
+        return String::Contains(objectName, _filter, true);
+    }
+
+    bool IsFilterInFilename(const RideObjectEntry& rideEntry)
+    {
+        auto rideObject = static_cast<RideObject*>(rideEntry.obj);
+        auto repoItem = ObjectRepositoryFindObjectByEntry(&(rideObject->GetObjectEntry()));
+
+        return String::Contains(repoItem->Path, _filter, true);
+    }
+
     void SetPressedTab()
     {
         int32_t i{};
@@ -735,6 +826,8 @@ private:
         if (_currentTab != RESEARCH_TAB)
         {
             widgets[WIDX_RIDE_LIST].type = WindowWidgetType::Scroll;
+            widgets[WIDX_FILTER_TEXT_BOX].type = WindowWidgetType::TextBox;
+            widgets[WIDX_FILTER_CLEAR_BUTTON].type = WindowWidgetType::Button;
             widgets[WIDX_CURRENTLY_IN_DEVELOPMENT_GROUP].type = WindowWidgetType::Empty;
             widgets[WIDX_LAST_DEVELOPMENT_GROUP].type = WindowWidgetType::Empty;
             widgets[WIDX_LAST_DEVELOPMENT_BUTTON].type = WindowWidgetType::Empty;
@@ -746,6 +839,8 @@ private:
         else
         {
             widgets[WIDX_RIDE_LIST].type = WindowWidgetType::Empty;
+            widgets[WIDX_FILTER_TEXT_BOX].type = WindowWidgetType::Empty;
+            widgets[WIDX_FILTER_CLEAR_BUTTON].type = WindowWidgetType::Empty;
             widgets[WIDX_CURRENTLY_IN_DEVELOPMENT_GROUP].type = WindowWidgetType::Groupbox;
             widgets[WIDX_LAST_DEVELOPMENT_GROUP].type = WindowWidgetType::Groupbox;
             widgets[WIDX_LAST_DEVELOPMENT_BUTTON].type = WindowWidgetType::FlatBtn;