The Battle for Wesnoth  1.19.4+dev
game_stats.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2016 - 2024
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 
19 #include "gui/widgets/listbox.hpp"
20 #include "gui/widgets/label.hpp"
22 #include "gui/widgets/window.hpp"
23 #include "formatter.hpp"
24 #include "game_classification.hpp"
25 #include "map/map.hpp"
26 #include "play_controller.hpp"
27 #include "resources.hpp"
28 #include "units/map.hpp"
29 #include "units/unit.hpp"
30 
31 #include <functional>
32 
33 static lg::log_domain log_display("display");
34 #define LOG_DP LOG_STREAM(info, log_display)
35 
36 namespace gui2::dialogs
37 {
38 
39 REGISTER_DIALOG(game_stats)
40 
41 game_stats::game_stats(const display_context& board, const int viewing_team, int& selected_side_number)
42  : modal_dialog(window_id())
43  , board_(board)
44  , viewing_team_(board_.teams()[viewing_team])
45  , selected_side_number_(selected_side_number)
46 {
47 }
48 
50 {
52 
53  if(leader != board_.units().end()) {
54  return leader.get_shared_ptr();
55  }
56 
57  return nullptr;
58 }
59 
60 static std::string controller_name(const team& t)
61 {
62  static const side_controller::sized_array<t_string> names {_("controller^Idle"), _("controller^Human"), _("controller^AI"), _("controller^Reserved")};
63  return "<span color='#808080'><small>" + names[static_cast<int>(t.controller())] + "</small></span>";
64 }
65 
67 {
68  listbox& stats_list = find_widget<listbox>("game_stats_list");
69  listbox& settings_list = find_widget<listbox>("scenario_settings_list");
70 
71  for(const auto& team : board_.teams()) {
72  if(team.hidden()) {
73  continue;
74  }
75 
76  team_data_.emplace_back(board_, team);
77 
78  widget_data row_data_stats;
79  widget_item column_stats;
80 
81  const bool known = viewing_team_.knows_about_team(team.side() - 1);
82  const bool enemy = viewing_team_.is_enemy(team.side());
83 
84  const team_data& data = team_data_.back();
85 
86  unit_const_ptr leader = get_leader(team.side());
87 
88  std::string leader_name;
89  std::string leader_image;
90 
92  if(leader) {
93  const bool visible = leader->is_visible_to_team(leader->get_location(), viewing_team_, see_all);
94 
95  // Add leader image. If it's fogged/[hides], show only a random leader image.
96  if(visible || known) {
97  leader_image = leader->absolute_image() + leader->image_mods();
98  leader_name = leader->name();
99  } else {
100  leader_image = formatter() << "units/unknown-unit.png" << "~RC(magenta>" << team.color() << ")";
101  leader_name = _("Unknown");
102  }
103 
105  if(resources::controller->get_classification().is_multiplayer()) {
106  leader_name = team.side_name();
107  }
108  }
109 
110  leader_name = "<span color='" + team::get_side_highlight_pango(team.side()) + "'>" + leader_name + "</span>";
111  }
112 
113  //
114  // Status list
115  //
116  column_stats["use_markup"] = "true";
117 
118  column_stats["label"] = leader_image;
119  row_data_stats.emplace("team_leader_image", column_stats);
120 
121  column_stats["label"] = leader_name + "\n" + controller_name(team);
122  column_stats["tooltip"] = team::get_side_color_name_for_UI(team.side());
123  row_data_stats.emplace("team_leader_name", column_stats);
124  column_stats.erase("tooltip");
125 
126  column_stats["label"] = team.user_team_name().empty() ? team.team_name() : team.user_team_name().str();
127  row_data_stats.emplace("team_name", column_stats);
128 
129  // Only fill in the rest of the info if the side is known...
130  if(known || see_all) {
131  std::string gold_str;
132  if(see_all || !enemy || !viewing_team_.uses_fog()) {
133  gold_str = utils::half_signed_value(team.gold());
134  }
135 
136  column_stats["label"] = team.gold() < 0 ? "<span color='#ff0000'>" + gold_str + "</span>" : gold_str;
137  row_data_stats.emplace("team_gold", column_stats);
138 
139  std::string village_count = std::to_string(team.villages().size());
141  village_count += "/" + std::to_string(board_.map().villages().size());
142  }
143 
144  column_stats["label"] = village_count;
145  row_data_stats.emplace("team_villages", column_stats);
146 
147  column_stats["label"] = std::to_string(data.units);
148  row_data_stats.emplace("team_units", column_stats);
149 
150  column_stats["label"] = std::to_string(data.upkeep);
151  row_data_stats.emplace("team_upkeep", column_stats);
152 
153  const std::string income = utils::signed_value(data.net_income);
154  column_stats["label"] = data.net_income < 0 ? "<span color='#ff0000'>" + income + "</span>" : income;
155  row_data_stats.emplace("team_income", column_stats);
156  }
157 
158  stats_list.add_row(row_data_stats);
159 
160  //
161  // Settings list
162  //
163  widget_data row_data_settings;
164  widget_item column_settings;
165 
166  column_settings["use_markup"] = "true";
167 
168  column_settings["label"] = leader_image;
169  row_data_settings.emplace("team_leader_image", column_settings);
170 
171  column_settings["label"] = leader_name + "\n" + controller_name(team);
172  row_data_settings.emplace("team_leader_name", column_settings);
173 
174  column_settings["label"] = std::to_string(team.side());
175  row_data_settings.emplace("team_side", column_settings);
176 
177  column_settings["label"] = std::to_string(team.start_gold());
178  row_data_settings.emplace("team_start_gold", column_settings);
179 
180  column_settings["label"] = std::to_string(team.base_income());
181  row_data_settings.emplace("team_base_income", column_settings);
182 
183  column_settings["label"] = std::to_string(team.village_gold());
184  row_data_settings.emplace("team_village_gold", column_settings);
185 
186  column_settings["label"] = std::to_string(team.village_support());
187  row_data_settings.emplace("team_village_support", column_settings);
188 
189  column_settings["label"] = team.uses_fog() ? _("yes") : _("no");
190  row_data_settings.emplace("team_fog", column_settings);
191 
192  column_settings["label"] = team.uses_shroud() ? _("yes") : _("no");
193  row_data_settings.emplace("team_shroud", column_settings);
194 
195  settings_list.add_row(row_data_settings);
196  }
197 
198  // Sorting options for the status list
199  stats_list.register_translatable_sorting_option(0, [this](const int i) {
200  unit_const_ptr leader = get_leader(i + 1);
201  return leader ? leader->name().str() : "";
202  });
203 
204  stats_list.register_translatable_sorting_option(1, [this](const int i) {
205  return board_.teams()[i].user_team_name().str(); });
206  stats_list.register_sorting_option(2, [this](const int i) { return board_.teams()[i].gold(); });
207  stats_list.register_sorting_option(3, [this](const int i) { return board_.teams()[i].villages(); });
208  stats_list.register_sorting_option(4, [this](const int i) { return team_data_[i].units; });
209  stats_list.register_sorting_option(5, [this](const int i) { return team_data_[i].upkeep; });
210  stats_list.register_sorting_option(6, [this](const int i) { return team_data_[i].net_income; });
211 
212  // Sorting options for the settings list
213  settings_list.register_translatable_sorting_option(0, [this](const int i) {
214  unit_const_ptr leader = get_leader(i + 1);
215  return leader ? leader->name().str() : "";
216  });
217 
218  settings_list.register_sorting_option(1, [this](const int i) { return board_.teams()[i].side(); });
219  settings_list.register_sorting_option(2, [this](const int i) { return board_.teams()[i].start_gold(); });
220  settings_list.register_sorting_option(3, [this](const int i) { return board_.teams()[i].base_income(); });
221  settings_list.register_sorting_option(4, [this](const int i) { return board_.teams()[i].village_gold(); });
222  settings_list.register_sorting_option(5, [this](const int i) { return board_.teams()[i].village_support(); });
223  settings_list.register_sorting_option(6, [this](const int i) { return board_.teams()[i].uses_fog(); });
224  settings_list.register_sorting_option(7, [this](const int i) { return board_.teams()[i].uses_shroud(); });
225 
226  //
227  // Set up tab control
228  //
229  listbox& tab_bar = find_widget<listbox>("tab_bar");
230 
231  keyboard_capture(&tab_bar);
232 
233  connect_signal_notify_modified(tab_bar, std::bind(&game_stats::on_tab_select, this));
234 
235  on_tab_select();
236 }
237 
239 {
240  const int i = find_widget<listbox>("tab_bar").get_selected_row();
241 
242  find_widget<stacked_widget>("pager").select_layer(i);
243 
244  // There are only two tabs, so this is simple
245  find_widget<label>("title").set_label(
246  i == 0 ? _("Current Status") : _("Scenario Settings")
247  );
248 }
249 
251 {
252  if(get_retval() == retval::OK) {
253  const int selected_tab = find_widget<listbox>("tab_bar").get_selected_row();
254 
255  const std::string list_id = selected_tab == 0 ? "game_stats_list" : "scenario_settings_list";
256  selected_side_number_ = team_data_[find_widget<listbox>(list_id).get_selected_row()].side;
257  }
258 }
259 
260 } // namespace dialogs
double t
Definition: astarsearch.cpp:63
std::vector< std::string > names
Definition: build_info.cpp:67
Abstract class for exposing game data that doesn't depend on the GUI, however which for historical re...
virtual const gamemap & map() const =0
virtual const std::vector< team > & teams() const =0
virtual const unit_map & units() const =0
bool show_everything() const
Definition: display.hpp:105
std::ostringstream wrapper.
Definition: formatter.hpp:40
const std::vector< map_location > & villages() const
Return a list of the locations of villages on the map.
Definition: map.hpp:237
unit_const_ptr get_leader(const int side)
Definition: game_stats.cpp:49
const team & viewing_team_
Definition: game_stats.hpp:49
virtual void post_show() override
Actions to be taken after the window has been shown.
Definition: game_stats.cpp:250
std::vector< team_data > team_data_
Definition: game_stats.hpp:51
const display_context & board_
Definition: game_stats.hpp:47
virtual void pre_show() override
Actions to be taken before showing the window.
Definition: game_stats.cpp:66
Abstract base class for all modal dialogs.
int get_retval() const
Returns the cached window exit code.
The listbox class.
Definition: listbox.hpp:43
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:58
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:612
void register_sorting_option(const int col, const Func &f)
Definition: listbox.hpp:260
void keyboard_capture(widget *widget)
Definition: window.cpp:1219
game_display & get_display() override
Get a reference to a display member a derived class uses.
bool empty() const
Definition: tstring.hpp:186
const std::string & str() const
Definition: tstring.hpp:190
This class stores all the data for a single 'side' (in game nomenclature).
Definition: team.hpp:74
static std::string get_side_highlight_pango(int side)
Definition: team.cpp:1030
bool uses_shroud() const
Definition: team.hpp:303
const std::string & color() const
Definition: team.hpp:242
const std::string & side_name() const
Definition: team.hpp:293
int side() const
Definition: team.hpp:174
int village_support() const
Definition: team.hpp:185
const std::string & team_name() const
Definition: team.hpp:282
int village_gold() const
Definition: team.hpp:178
bool is_enemy(int n) const
Definition: team.hpp:229
const std::set< map_location > & villages() const
Definition: team.hpp:170
bool knows_about_team(std::size_t index) const
Definition: team.cpp:703
int gold() const
Definition: team.hpp:175
static const t_string get_side_color_name_for_UI(unsigned side)
Definition: team.cpp:998
int start_gold() const
Definition: team.hpp:176
int base_income() const
Definition: team.hpp:177
bool uses_fog() const
Definition: team.hpp:304
bool hidden() const
Definition: team.hpp:333
const t_string & user_team_name() const
Definition: team.hpp:283
unit_iterator end()
Definition: map.hpp:428
unit_iterator find_leader(int side)
Definition: map.cpp:320
std::size_t i
Definition: function.cpp:1023
static lg::log_domain log_display("display")
static std::string _(const char *str)
Definition: gettext.hpp:93
This file contains the window object, this object is a top level container which has the event manage...
const bool & debug
Definition: game_config.cpp:92
static std::string controller_name(const team &t)
Definition: game_stats.cpp:60
REGISTER_DIALOG(editor_edit_unit)
void connect_signal_notify_modified(dispatcher &dispatcher, const signal_notification &signal)
Connects a signal handler for getting a notification upon modification.
Definition: dispatcher.cpp:203
std::map< std::string, widget_item > widget_data
Definition: widget.hpp:36
std::map< std::string, t_string > widget_item
Definition: widget.hpp:33
@ OK
Dialog was closed with the OK button.
Definition: retval.hpp:35
play_controller * controller
Definition: resources.cpp:21
std::string half_signed_value(int val)
Sign with Unicode "−" if negative.
std::string signed_value(int val)
Convert into a signed value (using the Unicode "−" and +0 convention.
@ enemy
Belongs to a non-friendly side; normally visualised by not displaying an orb.
std::string_view data
Definition: picture.cpp:178
std::shared_ptr< const unit > unit_const_ptr
Definition: ptr.hpp:27
std::array< T, size()> sized_array
Provide a alias template for an array of matching size.
Definition: enum_base.hpp:92
pointer get_shared_ptr() const
This is exactly the same as operator-> but it's slightly more readable, and can replace &*iter syntax...
Definition: map.hpp:217