refactor inventory_multiselector and remove inventory_iuse_selector (#55072)

mqrause · mqrause · web-flow · commit df59d8707de1 · 2022-02-04T13:53:08.000-08:00
Co-authored-by: mqrause &lt;martin@qrause.de&gt;
diff --git a/src/inventory_ui.cpp b/src/inventory_ui.cpp
@@ -2633,10 +2633,13 @@ void inventory_selector::highlight()
 
 inventory_multiselector::inventory_multiselector( Character &p,
         const inventory_selector_preset &preset,
-        const std::string &selection_column_title, const bool allow_select_contained ) :
+        const std::string &selection_column_title,
+        const GetStats &get_stats,
+        const bool allow_select_contained ) :
     inventory_selector( p, preset ),
     allow_select_contained( allow_select_contained ),
-    selection_col( new selection_column( "SELECTION_COLUMN", selection_column_title ) )
+    selection_col( new selection_column( "SELECTION_COLUMN", selection_column_title ) ),
+    get_stats( get_stats )
 {
     ctxt.register_action( "TOGGLE_ENTRY", to_translation( "Mark/unmark selected item" ) );
     ctxt.register_action( "MARK_WITH_COUNT",
@@ -2787,6 +2790,38 @@ void inventory_multiselector::toggle_entries( int &count, const toggle_mode mode
     on_toggle();
 }
 
+drop_locations inventory_multiselector::execute()
+{
+    shared_ptr_fast<ui_adaptor> ui = create_or_get_ui_adaptor();
+
+    while( true ) {
+        ui_manager::redraw();
+
+        const inventory_input input = get_input();
+
+        if( input.action == "CONFIRM" ) {
+            if( to_use.empty() ) {
+                popup_getkey( _( "No items were selected.  Use %s to select them." ),
+                              ctxt.get_desc( "TOGGLE_ENTRY" ) );
+                continue;
+            }
+            break;
+        }
+
+        if( input.action == "QUIT" ) {
+            return drop_locations();
+        }
+
+        on_input( input );
+    }
+    drop_locations dropped_pos_and_qty;
+    for( const std::pair<item_location, int> &drop_pair : to_use ) {
+        dropped_pos_and_qty.push_back( drop_pair );
+    }
+
+    return dropped_pos_and_qty;
+}
+
 inventory_compare_selector::inventory_compare_selector( Character &p ) :
     inventory_multiselector( p, default_preset, _( "ITEMS TO COMPARE" ) ) {}
 
@@ -2824,7 +2859,7 @@ std::pair<const item *, const item *> inventory_compare_selector::execute()
         } else if( input.action == "TOGGLE_FAVORITE" ) {
             // TODO: implement favoriting in multi selection menus while maintaining selection
         } else {
-            on_input( input );
+            inventory_selector::on_input( input );
         }
 
         if( compared.size() == 2 ) {
@@ -2855,79 +2890,7 @@ void inventory_compare_selector::toggle_entry( inventory_entry *entry )
     on_change( *entry );
 }
 
-inventory_iuse_selector::inventory_iuse_selector(
-    Character &p,
-    const std::string &selector_title,
-    const inventory_selector_preset &preset,
-    const GetStats &get_st
-) :
-    inventory_multiselector( p, preset, selector_title, /*allow_select_contained=*/true ),
-    get_stats( get_st )
-{}
-
-drop_locations inventory_iuse_selector::execute()
-{
-    shared_ptr_fast<ui_adaptor> ui = create_or_get_ui_adaptor();
-
-    auto is_entry = []( const inventory_entry & elem ) {
-        return elem.is_selectable();
-    };
-    for( inventory_column *col : get_all_columns() ) {
-        if( col->allows_selecting() ) {
-            for( inventory_entry *ie : col->get_entries( is_entry ) ) {
-                for( item_location const &x : ie->locations ) {
-                    usable_locs.push_back( x );
-                }
-            }
-        }
-    }
-    int count = 0;
-    while( true ) {
-        ui_manager::redraw();
-
-        const bool noMarkCountBound = ctxt.keys_bound_to( "MARK_WITH_COUNT" ).empty();
-        const inventory_input input = get_input();
-
-        if( input.entry != nullptr ) { // Single Item from mouse
-            highlight( input.entry->any_item() );
-            toggle_entries( count );
-        } else if( input.action == "TOGGLE_NON_FAVORITE" ) {
-            toggle_entries( count, toggle_mode::NON_FAVORITE_NON_WORN );
-        } else if( input.action == "MARK_WITH_COUNT" ) {  // Set count and mark selected with specific key
-            int query_result = query_count();
-            if( query_result < 0 ) {
-                continue; // Skip selecting any if invalid result or user canceled prompt
-            }
-            toggle_entries( query_result, toggle_mode::SELECTED );
-        } else if( noMarkCountBound && input.ch >= '0' && input.ch <= '9' ) {
-            count = std::min( count, INT_MAX / 10 - 10 );
-            count *= 10;
-            count += input.ch - '0';
-        } else if( input.action == "TOGGLE_ENTRY" ) { // Mark selected
-            toggle_entries( count, toggle_mode::SELECTED );
-        } else if( input.action == "CONFIRM" ) {
-            if( to_use.empty() ) {
-                popup_getkey( _( "No items were selected.  Use %s to select them." ),
-                              ctxt.get_desc( "TOGGLE_ENTRY" ) );
-                continue;
-            }
-            break;
-        } else if( input.action == "QUIT" ) {
-            return drop_locations();
-        } else {
-            on_input( input );
-        }
-    }
-    drop_locations dropped_pos_and_qty;
-
-    for( const std::pair<const item_location, int> use_pair : to_use ) {
-        dropped_pos_and_qty.push_back( use_pair );
-    }
-
-    return dropped_pos_and_qty;
-}
-
-inventory_selector::stats inventory_iuse_selector::get_raw_stats() const
+inventory_selector::stats inventory_multiselector::get_raw_stats() const
 {
     if( get_stats ) {
         return get_stats( to_use );
@@ -2985,7 +2948,7 @@ void inventory_multiselector::deselect_contained_items()
     }
 }
 
-void inventory_drop_selector::on_input( const inventory_input &input )
+void inventory_multiselector::on_input( const inventory_input &input )
 {
     bool const noMarkCountBound = ctxt.keys_bound_to( "MARK_WITH_COUNT" ).empty();
 
@@ -3007,7 +2970,7 @@ void inventory_drop_selector::on_input( const inventory_input &input )
     } else if( input.action == "TOGGLE_ENTRY" ) { // Mark selected
         toggle_entries( count, toggle_mode::SELECTED );
     } else {
-        inventory_multiselector::on_input( input );
+        inventory_selector::on_input( input );
     }
 }
 
@@ -3104,31 +3067,12 @@ drop_locations pickup_selector::execute()
 {
     shared_ptr_fast<ui_adaptor> ui = create_or_get_ui_adaptor();
 
-    int count = 0;
     while( true ) {
         ui_manager::redraw();
 
-        const bool noMarkCountBound = ctxt.keys_bound_to( "MARK_WITH_COUNT" ).empty();
         const inventory_input input = get_input();
 
-        if( input.entry != nullptr ) { // Single Item from mouse
-            highlight( input.entry->any_item() );
-            toggle_entries( count );
-        } else if( input.action == "TOGGLE_NON_FAVORITE" ) {
-            toggle_entries( count, toggle_mode::NON_FAVORITE_NON_WORN );
-        } else if( input.action == "MARK_WITH_COUNT" ) { // Set count and mark selected with specific key
-            int query_result = query_count();
-            if( query_result < 0 ) {
-                continue; // Skip selecting any if invalid result or user canceled prompt
-            }
-            toggle_entries( query_result );
-        } else if( noMarkCountBound && input.ch >= '0' && input.ch <= '9' ) {
-            count = std::min( count, INT_MAX / 10 - 10 );
-            count *= 10;
-            count += input.ch - '0';
-        } else if( input.action == "TOGGLE_ENTRY" ) { // Mark selected
-            toggle_entries( count );
-        } else if( input.action == "CONFIRM" ) {
+        if( input.action == "CONFIRM" ) {
             if( to_use.empty() ) {
                 popup_getkey( _( "No items were selected.  Use %s to select them." ),
                               ctxt.get_desc( "TOGGLE_ENTRY" ) );
@@ -3145,10 +3089,6 @@ drop_locations pickup_selector::execute()
             }
         } else if( input.action == "QUIT" ) {
             return drop_locations();
-        } else if( input.action == "INVENTORY_FILTER" ) {
-            query_set_filter();
-        } else if( input.action == "TOGGLE_FAVORITE" ) {
-            // TODO: implement favoriting in multi selection menus while maintaining selection
         } else {
             on_input( input );
         }
diff --git a/src/inventory_ui.h b/src/inventory_ui.h
@@ -842,10 +842,13 @@ class inventory_pick_selector : public inventory_selector
 class inventory_multiselector : public inventory_selector
 {
     public:
+        using GetStats = std::function<stats( const std::vector<std::pair<item_location, int>> )>;
         explicit inventory_multiselector( Character &p,
                                           const inventory_selector_preset &preset = default_preset,
                                           const std::string &selection_column_title = "",
+                                          const GetStats & = {},
                                           bool allow_select_contained = false );
+        drop_locations execute();
     protected:
         void rearrange_columns( size_t client_width ) override;
         size_t max_chosen_count;
@@ -856,8 +859,12 @@ class inventory_multiselector : public inventory_selector
         std::vector<item_location> usable_locs;
         bool allow_select_contained;
         virtual void on_toggle() {};
+        void on_input( const inventory_input &input );
+        int count = 0;
+        stats get_raw_stats() const override;
     private:
         std::unique_ptr<inventory_column> selection_col;
+        GetStats get_stats;
 };
 
 class inventory_compare_selector : public inventory_multiselector
@@ -871,25 +878,6 @@ class inventory_compare_selector : public inventory_multiselector
         void toggle_entry( inventory_entry *entry );
 };
 
-// This and inventory_drop_selectors should probably both inherit from a higher-abstraction "action selector".
-// Should accept a function to calculate dummy values.
-class inventory_iuse_selector : public inventory_multiselector
-{
-    public:
-        using GetStats = std::function<stats( const std::vector<std::pair<item_location, int>> )>;
-        inventory_iuse_selector( Character &p,
-                                 const std::string &selector_title,
-                                 const inventory_selector_preset &preset = default_preset,
-                                 const GetStats & = {} );
-        drop_locations execute();
-
-    protected:
-        stats get_raw_stats() const override;
-
-    private:
-        GetStats get_stats;
-};
-
 class inventory_drop_selector : public inventory_multiselector
 {
     public:
@@ -899,13 +887,11 @@ class inventory_drop_selector : public inventory_multiselector
             const std::string &selection_column_title = _( "ITEMS TO DROP" ),
             bool warn_liquid = true );
         drop_locations execute();
-        void on_input( const inventory_input &input );
     protected:
         stats get_raw_stats() const override;
 
     private:
         bool warn_liquid;
-        int count = 0;
 };
 
 class pickup_selector : public inventory_multiselector
diff --git a/src/iuse.cpp b/src/iuse.cpp
@@ -9684,7 +9684,8 @@ cata::optional<int> iuse::wash_items( Character *p, bool soft_items, bool hard_i
                 display_stat( _( "Cleanser" ), required.cleanser, available_cleanser, to_string )
             }};
     };
-    inventory_iuse_selector inv_s( *p, _( "ITEMS TO CLEAN" ), preset, make_raw_stats );
+    inventory_multiselector inv_s( *p, preset, _( "ITEMS TO CLEAN" ),
+                                   make_raw_stats, /*allow_select_contained=*/true );
     inv_s.set_invlet_type( inventory_selector::SELECTOR_INVLET_ALPHA );
     inv_s.add_character_items( *p );
     inv_s.add_nearby_items( PICKUP_RANGE );
