The Battle for Wesnoth  1.17.10+dev
unit_list.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2016 - 2022
3  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
15 #define GETTEXT_DOMAIN "wesnoth-lib"
16 
18 
20 #include "gui/core/log.hpp"
21 #include "gui/dialogs/message.hpp"
22 #include "gui/widgets/listbox.hpp"
23 #include "gui/widgets/settings.hpp"
24 #include "gui/widgets/button.hpp"
25 #include "gui/widgets/image.hpp"
26 #include "gui/widgets/label.hpp"
29 #include "gui/widgets/window.hpp"
30 #include "display.hpp"
31 #include "font/text_formatting.hpp"
32 #include "formatter.hpp"
33 #include "units/map.hpp"
34 #include "units/ptr.hpp"
35 #include "units/unit.hpp"
36 
37 #include <functional>
38 
39 static lg::log_domain log_display("display");
40 #define LOG_DP LOG_STREAM(info, log_display)
41 
42 namespace gui2::dialogs
43 {
44 
45 REGISTER_DIALOG(unit_list)
46 
48  : modal_dialog(window_id())
49  , unit_list_(unit_list)
50  , scroll_to_(scroll_to)
51 {
52 }
53 
54 static std::string format_level_string(const int level)
55 {
56  std::string lvl = std::to_string(level);
57 
58  if(level < 1) {
59  return "<span color='#969696'>" + lvl + "</span>";
60  } else if(level == 1) {
61  return lvl;
62  } else if(level == 2) {
63  return "<b>" + lvl + "</b>";
64  } else { // level must be > 2
65  return"<b><span color='#ffffff'>" + lvl + "</span></b>";
66  }
67 
68 }
69 
70 static std::string format_if_leader(unit_const_ptr u, const std::string& str)
71 {
72  return (*u).can_recruit() ? "<span color='#cdad00'>" + str + "</span>" : str;
73 }
74 
76 {
77  const int moves_left = (*u).movement_left();
78  const int moves_max = (*u).total_movement();
79 
80  std::string color = "#00ff00";
81 
82  if(moves_left == 0) {
83  color = "#ff0000";
84  } else if(moves_left < moves_max) {
85  color = "#ffff00";
86  }
87 
88  return formatter() << "<span color='" << color << "'>" << moves_left << "/" << moves_max << "</span>";
89 }
90 
92 {
93  listbox& list = find_widget<listbox>(&window, "units_list", false);
94 
96 
97  list.clear();
98 
99  window.keyboard_capture(&list);
100 
101  for(const unit_const_ptr& unit : unit_list_) {
102  widget_data row_data;
103  widget_item column;
104 
105  column["use_markup"] = "true";
106 
107  column["label"] = format_if_leader(unit, unit->type_name());
108  row_data.emplace("unit_type", column);
109 
110  const std::string& name = !unit->name().empty() ? format_if_leader(unit, unit->name().str()) : font::unicode_en_dash;
111  column["label"] = name;
112  row_data.emplace("unit_name", column);
113 
114  column["label"] = format_movement_string(unit);
115  row_data.emplace("unit_moves", column);
116 
117  std::stringstream hp_str;
118  hp_str << font::span_color(unit->hp_color()) << unit->hitpoints() << "/" << unit->max_hitpoints() << "</span>";
119 
120  column["label"] = hp_str.str();
121  row_data.emplace("unit_hp", column);
122 
123  column["label"] = format_level_string(unit->level());
124  row_data.emplace("unit_level", column);
125 
126  std::stringstream exp_str;
127  exp_str << font::span_color(unit->xp_color());
128  if(unit->can_advance()) {
129  exp_str << unit->experience() << "/" << unit->max_experience();
130  } else {
131  exp_str << font::unicode_en_dash;
132  }
133  exp_str << "</span>";
134 
135  column["label"] = exp_str.str();
136  row_data.emplace("unit_experience", column);
137 
138  column["label"] = utils::join(unit->trait_names(), ", ");
139  row_data.emplace("unit_traits", column);
140 
141  grid* row_grid = &list.add_row(row_data);
142 
143  // NOTE: this needs to be done *after* the row is added
144  // TODO: show custom statuses
146  find_widget<image>(row_grid, "unit_status_petrified", false).set_visible(widget::visibility::invisible);
147  }
148 
150  find_widget<image>(row_grid, "unit_status_poisoned", false).set_visible(widget::visibility::invisible);
151  }
152 
154  find_widget<image>(row_grid, "unit_status_slowed", false).set_visible(widget::visibility::invisible);
155  }
156 
157  if(!unit->invisible(unit->get_location(), false)) {
158  find_widget<image>(row_grid, "unit_status_invisible", false).set_visible(widget::visibility::invisible);
159  }
160  }
161 
162  list.register_translatable_sorting_option(0, [this](const int i) { return unit_list_[i]->type_name().str(); });
163  list.register_translatable_sorting_option(1, [this](const int i) { return unit_list_[i]->name().str(); });
164  list.register_sorting_option(2, [this](const int i) { return unit_list_[i]->movement_left(); });
165  list.register_sorting_option(3, [this](const int i) { return unit_list_[i]->hitpoints(); });
166  list.register_sorting_option(4, [this](const int i) {
167  const unit& u = *unit_list_[i];
168  return std::tuple(u.level(), -static_cast<int>(u.experience_to_advance()));
169  });
170  list.register_sorting_option(5, [this](const int i) { return unit_list_[i]->experience(); });
171  list.register_translatable_sorting_option(6, [this](const int i) {
172  return !unit_list_[i]->trait_names().empty() ? unit_list_[i]->trait_names().front().str() : ""; });
173 
175 }
176 
178 {
179  const int selected_row
180  = find_widget<listbox>(get_window(), "units_list", false).get_selected_row();
181 
182  if(selected_row == -1) {
183  return;
184  }
185 
186  find_widget<unit_preview_pane>(get_window(), "unit_details", false)
187  .set_displayed_unit(*unit_list_[selected_row].get());
188 }
189 
191 {
192  if(get_retval() == retval::OK) {
193  const int selected_row = find_widget<listbox>(&window, "units_list", false).get_selected_row();
194 
195  scroll_to_ = unit_list_[selected_row]->get_location();
196  }
197 }
198 
200 {
201  std::vector<unit_const_ptr> unit_list;
202  map_location scroll_to;
203 
204  const unit_map& units = gui.get_units();
205  for(unit_map::const_iterator i = units.begin(); i != units.end(); ++i) {
206  if(i->side() != gui.viewing_side()) {
207  continue;
208  }
209 
210  unit_list.push_back(i.get_shared_ptr());
211  }
212 
213  if(unit_list::execute(unit_list, scroll_to)) {
214  gui.scroll_to_tile(scroll_to, display::WARP);
215  gui.select_hex(scroll_to);
216  }
217 }
218 
219 } // namespace dialogs
Define the common log macros for the gui toolkit.
window(const builder_window::window_resolution &definition)
< Needs to be initialized in show.
Definition: window.cpp:263
virtual void select_hex(map_location hex)
Definition: display.cpp:1534
void list_item_clicked()
Callbacks.
Definition: unit_list.cpp:177
unit_iterator end()
Definition: map.hpp:429
This class represents a single unit of a specific type.
Definition: unit.hpp:133
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
Definition: unit_list.cpp:190
std::string join(const T &v, const std::string &s=",")
Generates a new string joining container items in a list.
bool get_state(const std::string &state) const
Check if the unit is affected by a status effect.
Definition: unit.cpp:1316
int hitpoints() const
The current number of hitpoints this unit has.
Definition: unit.hpp:502
std::vector< unit_const_ptr > & unit_list_
Definition: unit_list.hpp:49
This file contains the window object, this object is a top level container which has the event manage...
void show_unit_list(display &gui)
Definition: unit_list.cpp:199
General purpose widgets.
unit_iterator begin()
Definition: map.hpp:419
The unit is slowed - it moves slower and does less damage.
Definition: unit.hpp:864
const unit_map & get_units() const
Definition: display.hpp:131
grid & add_row(const widget_item &item, const int index=-1)
When an item in the list is selected by the user we need to update the state.
Definition: listbox.cpp:61
int viewing_side() const
Definition: display.hpp:113
The unit is poisoned - it loses health each turn.
Definition: unit.hpp:865
void register_translatable_sorting_option(const int col, translatable_sorter_func_t f)
Registers a special sorting function specifically for translatable values.
Definition: listbox.cpp:615
STL namespace.
static std::string format_movement_string(unit_const_ptr u)
Definition: unit_list.cpp:75
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
Definition: unit_list.cpp:91
map_location & scroll_to_
Definition: unit_list.hpp:51
color_t hp_color() const
Color for this unit&#39;s current hitpoints.
Definition: unit.cpp:1087
unsigned int experience_to_advance() const
The number of experience points this unit needs to level up, or 0 if current XP > max XP...
Definition: unit.hpp:544
std::shared_ptr< const unit > unit_const_ptr
Definition: ptr.hpp:27
The listbox class.
Definition: listbox.hpp:45
static std::string format_level_string(const int level)
Definition: unit_list.cpp:54
std::string span_color(const color_t &color)
Returns a Pango formatting string using the provided color_t object.
Base container class.
Definition: grid.hpp:31
std::map< std::string, t_string > widget_item
Definition: widget.hpp:32
This file contains the settings handling of the widget library.
std::ostringstream wrapper.
Definition: formatter.hpp:39
void clear()
Removes all the rows in the listbox, clearing it.
Definition: listbox.cpp:120
void set_visible(const visibility visible)
Definition: widget.cpp:456
color_t xp_color() const
Color for this unit&#39;s XP.
Definition: unit.cpp:1141
const t_string & name() const
Gets this unit&#39;s translatable display name.
Definition: unit.hpp:406
static std::string format_if_leader(unit_const_ptr u, const std::string &str)
Definition: unit_list.cpp:70
int max_experience() const
The max number of experience points this unit can have.
Definition: unit.hpp:532
int level() const
The current level of this unit.
Definition: unit.hpp:562
map_display and display: classes which take care of displaying the map and game-data on the screen...
int moves_left
Definition: pathfind.cpp:156
const std::vector< t_string > & trait_names() const
Gets the names of the currently registered traits.
Definition: unit.hpp:1084
const t_string & type_name() const
Gets the translatable name of this unit&#39;s type.
Definition: unit.hpp:372
window * get_window()
Returns a pointer to the dialog&#39;s window.
Encapsulates the map of the game.
Definition: location.hpp:38
bool invisible(const map_location &loc, bool see_all=true) const
Definition: unit.cpp:2437
static lg::log_domain log_display("display")
std::size_t i
Definition: function.cpp:967
const std::string unicode_en_dash
Definition: constants.cpp:43
void scroll_to_tile(const map_location &loc, SCROLL_TYPE scroll_type=ONSCREEN, bool check_fogged=true, bool force=true)
Scroll such that location loc is on-screen.
Definition: display.cpp:2056
int max_hitpoints() const
The max number of hitpoints this unit can have.
Definition: unit.hpp:508
The user set the widget invisible, that means:
static bool execute(std::vector< unit_const_ptr > &units, map_location &scroll_to)
Definition: unit_list.hpp:38
int get_retval() const
Returns the cached window exit code.
bool empty() const
Definition: tstring.hpp:187
int experience() const
The current number of experience points this unit has.
Definition: unit.hpp:526
const map_location & get_location() const
The current map location this unit is at.
Definition: unit.hpp:1358
Abstract base class for all modal dialogs.
bool can_advance() const
Checks whether this unit has any options to advance to.
Definition: unit.hpp:275
Container associating units to locations.
Definition: map.hpp:98
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:35
Dialog was closed with the OK button.
Definition: retval.hpp:35
void register_sorting_option(const int col, const Func &f)
Definition: listbox.hpp:263
const std::string & str() const
Definition: tstring.hpp:191
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:66
void connect_signal_notify_modified(dispatcher &dispatcher, const signal_notification &signal)
Connects a signal handler for getting a notification upon modification.
Definition: dispatcher.cpp:205
unit_list(std::vector< unit_const_ptr > &unit_list, map_location &scroll_to)
Definition: unit_list.cpp:47