The Battle for Wesnoth  1.19.0-dev
faction_select.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 "formatter.hpp"
20 #include "gettext.hpp"
22 #include "gui/widgets/button.hpp"
23 #include "gui/widgets/drawing.hpp"
24 #include "gui/widgets/label.hpp"
25 #include "gui/widgets/listbox.hpp"
28 #include "gui/widgets/window.hpp"
29 #include "help/help.hpp"
30 #include "preferences/game.hpp" // for encountered_units
31 #include "units/types.hpp"
32 
33 #include <functional>
34 
35 namespace gui2::dialogs
36 {
37 
38 REGISTER_DIALOG(faction_select)
39 
40 faction_select::faction_select(ng::flg_manager& flg_manager, const std::string& color, const int side)
41  : modal_dialog(window_id())
42  , flg_manager_(flg_manager)
43  , tc_color_(color)
44  , side_(side)
45  , last_faction_(flg_manager.current_faction_index())
46  , last_leader_(flg_manager.current_leader_index())
47  , last_gender_(flg_manager.current_gender_index())
48 {
49 }
50 
52 {
53  find_widget<label>(&window, "starting_pos", false).set_label(std::to_string(side_));
54 
55  //
56  // Set up gender radio buttons
57  //
58  toggle_button& gender_rand = find_widget<toggle_button>(&window, "gender_random", false);
59  toggle_button& gender_male = find_widget<toggle_button>(&window, "gender_male", false);
60  toggle_button& gender_female = find_widget<toggle_button>(&window, "gender_female", false);
61 
62  gender_toggle_.add_member(&gender_rand, "random");
65 
67 
69  std::bind(&faction_select::on_gender_select, this, std::placeholders::_2));
70 
71  //
72  // Set up leader menu button
73  //
74  connect_signal_notify_modified(find_widget<menu_button>(&window, "leader_menu", false),
75  std::bind(&faction_select::on_leader_select, this));
76 
77  // Leader's profile button
78  find_widget<button>(&window, "type_profile", false).connect_click_handler(
79  std::bind(&faction_select::profile_button_callback, this));
80 
81  //
82  // Set up faction list
83  //
84  listbox& list = find_widget<listbox>(&window, "faction_list", false);
85 
86  window.keyboard_capture(&list);
87 
89  std::bind(&faction_select::on_faction_select, this));
90 
91  for(const config *s : flg_manager_.choosable_factions()) {
92  const config& side = *s;
93 
96 
97  const std::string name = side["name"].str();
98  // flag_rgb here is unrelated to any handling in the unit class
99  const std::string flag_rgb = !side["flag_rgb"].empty() ? side["flag_rgb"].str() : "magenta";
100 
101  item["label"] = (formatter() << side["image"] << "~RC(" << flag_rgb << ">" << tc_color_ << ")").str();
102  data.emplace("faction_image", item);
103 
104  item["label"] = name;
105  data.emplace("faction_name", item);
106 
107  list.add_row(data);
108  }
109 
111 
113 }
114 
116 {
117  const int selected_row = find_widget<listbox>(get_window(), "faction_list", false).get_selected_row();
118 
119  if(selected_row == -1) {
120  return;
121  }
122 
123  // Since set_current_faction overrides the current leader, save a copy of the previous leader index so the
124  // leader dropdown can be set to the appropriate initial selection.
125  const int previous_leader_selection = flg_manager_.current_leader_index();
126 
127  flg_manager_.set_current_faction(selected_row);
128 
129  std::vector<config> leaders;
130 
131  for(const std::string& leader : flg_manager_.choosable_leaders()) {
132  const unit_type* unit = unit_types.find(leader);
133 
134  if(unit) {
135  const std::string icon = formatter() << unit->image() << "~RC(" << unit->flag_rgb() << ">" << tc_color_ << ")";
136  leaders.emplace_back("label", unit->type_name(), "icon", icon);
137  } else if(leader == "random") {
138  leaders.emplace_back("label", _("Random"), "icon", ng::random_enemy_picture);
139  } else if(leader == "null") {
140  leaders.emplace_back("label", font::unicode_em_dash);
141  } else {
142  leaders.emplace_back("label", "?");
143  }
144  }
145 
146  menu_button& leader_dropdown = find_widget<menu_button>(get_window(), "leader_menu", false);
147 
148  leader_dropdown.set_values(leaders, std::min<int>(leaders.size() - 1, previous_leader_selection));
149  leader_dropdown.set_active(leaders.size() > 1 && !flg_manager_.is_saved_game());
150 
152 
153  // Print recruits
154  const std::vector<std::string> recruit_list = utils::split(flg_manager_.current_faction()["recruit"]);
155  std::vector<t_string> recruit_names;
156 
157  for(const auto& recruit : recruit_list) {
158  if(const unit_type* rt = unit_types.find(recruit)) {
159  recruit_names.push_back(font::unicode_bullet + " " + rt->type_name());
160  }
161  }
162 
163  std::sort(recruit_names.begin(), recruit_names.end(), [](const std::string& s1, const std::string& s2) {
164  return translation::compare(s1, s2) < 0;
165  });
166 
167  find_widget<styled_widget>(get_window(), "recruits", false).set_label(utils::join(recruit_names, "\n"));
168 }
169 
171 {
172  flg_manager_.set_current_leader(find_widget<menu_button>(get_window(), "leader_menu", false).get_value());
173 
174  // TODO: should we decouple this from the flg manager and instead just check the unit type directly?
175  // If that's done so, we'd need to come up with a different check for Random availability.
176  gender_toggle_.set_members_enabled([this](const std::string& gender)->bool {
177  const std::vector<std::string>& genders = flg_manager_.choosable_genders();
178  return std::find(genders.begin(), genders.end(), gender) != genders.end();
179  });
180 
182 
183  // Disable the profile button if leader_type is dash or "Random"
184  button& profile_button = find_widget<button>(get_window(), "type_profile", false);
185  const std::string& leader_type = find_widget<menu_button>(get_window(), "leader_menu", false).get_value_string();
186  profile_button.set_active(unit_types.find(leader_type) != nullptr);
187 }
188 
190 {
191  const std::string& leader_type = find_widget<menu_button>(get_window(), "leader_menu", false).get_value_string();
192  const unit_type* ut = unit_types.find(leader_type);
193  if(ut != nullptr) {
194  preferences::encountered_units().insert(ut->id());
196  }
197 }
198 
199 void faction_select::on_gender_select(const std::string val)
200 {
202 
204 }
205 
207 {
208  std::string leader_image = ng::random_enemy_picture;
209 
212  leader_image = formatter() << utg.image() << "~RC(" << utg.flag_rgb() << ">" << tc_color_ << ")";
213  }
214 
215  find_widget<drawing>(get_window(), "leader_image", false).set_label(leader_image);
216 }
217 
219 {
220  //
221  // If we're canceling, restore the previous selections. It might be worth looking
222  // into only making selections at all here in post_show, but that would require a
223  // refactor of the flg_manager class.
224  //
225  // Also, note it's important to set these in the order of faction -> leader -> gender
226  // or the saved indices will be invalid!
227  //
228  // -- vultraz, 2018-06-16
229  //
230  if(get_retval() != retval::OK) {
234  }
235 }
236 
237 } // namespace dialogs
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:159
bool empty() const
Definition: config.cpp:852
std::ostringstream wrapper.
Definition: formatter.hpp:40
Simple push button.
Definition: button.hpp:36
virtual void set_active(const bool active) override
See styled_widget::set_active.
Definition: button.cpp:63
void on_gender_select(const std::string val)
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
group< std::string > gender_toggle_
Abstract base class for all modal dialogs.
int get_retval() const
Returns the cached window exit code.
window * get_window()
Returns a pointer to the dialog's window.
void add_member(selectable_item *w, const T &value)
Adds a widget/value pair to the group map.
Definition: group.hpp:42
void set_member_states(const T &value)
Sets the toggle values for all widgets besides the one associated with the specified value to false.
Definition: group.hpp:111
void set_callback_on_value_change(std::function< void(widget &, const T)> func)
Sets a common callback function for all members.
Definition: group.hpp:121
void set_members_enabled(std::function< bool(const T &)> predicate)
Wrapper for enabling or disabling member widgets.
Definition: group.hpp:150
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:59
bool select_row(const unsigned row, const bool select=true)
Selects a row.
Definition: listbox.cpp:243
A menu_button is a styled_widget to choose an element from a list of elements.
Definition: menu_button.hpp:59
void set_values(const std::vector<::config > &values, unsigned selected=0)
virtual void set_active(const bool active) override
See styled_widget::set_active.
Definition: menu_button.cpp:74
Class for a toggle button.
base class of top level items, the only item which needs to store the final canvases to draw on.
Definition: window.hpp:63
void keyboard_capture(widget *widget)
Definition: window.cpp:1221
const std::vector< const config * > & choosable_factions() const
Definition: flg_manager.hpp:61
const std::string & current_gender() const
Definition: flg_manager.hpp:71
void set_current_faction(const unsigned index)
const std::vector< std::string > & choosable_genders() const
Definition: flg_manager.hpp:65
bool is_saved_game() const
Definition: flg_manager.hpp:52
int current_leader_index() const
Definition: flg_manager.hpp:79
const std::vector< std::string > & choosable_leaders() const
Definition: flg_manager.hpp:63
void set_current_leader(const unsigned index)
int current_faction_index() const
void set_current_gender(const unsigned index)
const config & current_faction() const
Definition: flg_manager.hpp:67
const std::string & current_leader() const
Definition: flg_manager.hpp:69
static const std::string s_female
Standard string id (not translatable) for FEMALE.
Definition: race.hpp:28
static const std::string s_male
Standard string id (not translatable) for MALE.
Definition: race.hpp:29
const unit_type * find(const std::string &key, unit_type::BUILD_STATUS status=unit_type::FULL) const
Finds a unit_type by its id() and makes sure it is built to the specified level.
Definition: types.cpp:1267
A single unit type that the player may recruit.
Definition: types.hpp:43
const std::string & image() const
Definition: types.hpp:176
const std::string & id() const
The id for this unit_type.
Definition: types.hpp:141
const std::string & flag_rgb() const
Definition: types.cpp:720
const unit_type & get_gender_unit_type(std::string gender) const
Returns a gendered variant of this unit_type.
Definition: types.cpp:453
This class represents a single unit of a specific type.
Definition: unit.hpp:133
static std::string _(const char *str)
Definition: gettext.hpp:93
const t_string & type_name() const
Gets the translatable name of this unit's type.
Definition: unit.hpp:369
const std::string & flag_rgb() const
Get the source color palette to use when recoloring the unit's image.
Definition: unit.cpp:1066
This file contains the window object, this object is a top level container which has the event manage...
const std::string unicode_em_dash
Definition: constants.cpp:44
const std::string unicode_bullet
Definition: constants.cpp:47
std::string flag_rgb
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:34
std::map< std::string, t_string > widget_item
Definition: widget.hpp:31
@ OK
Dialog was closed with the OK button.
Definition: retval.hpp:35
std::pair< std::string, unsigned > item
Definition: help_impl.hpp:412
void show_unit_description(const unit &u)
Definition: help.cpp:71
const std::string random_enemy_picture("units/random-dice.png")
std::set< std::string > & encountered_units()
Definition: game.cpp:913
std::string join(const T &v, const std::string &s=",")
Generates a new string joining container items in a list.
std::vector< std::string > split(const config_attribute_value &val)
std::string_view data
Definition: picture.cpp:194
static map_location::DIRECTION s
unit_type_data unit_types
Definition: types.cpp:1486