The Battle for Wesnoth  1.17.0-dev
faction_select.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2016 - 2021
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 "game_config_manager.hpp"
21 #include "gettext.hpp"
23 #include "gui/core/log.hpp"
24 #include "gui/widgets/button.hpp"
25 #include "gui/widgets/drawing.hpp"
26 #include "gui/widgets/label.hpp"
27 #include "gui/widgets/listbox.hpp"
29 #include "gui/widgets/settings.hpp"
31 #include "gui/widgets/window.hpp"
32 #include "help/help.hpp"
33 #include "preferences/game.hpp" // for encountered_units
34 #include "units/types.hpp"
35 
36 #include <functional>
37 
38 namespace gui2::dialogs
39 {
40 
41 REGISTER_DIALOG(faction_select)
42 
43 faction_select::faction_select(ng::flg_manager& flg_manager, const std::string& color, const int side)
44  : flg_manager_(flg_manager)
45  , tc_color_(color)
46  , side_(side)
47  , last_faction_(flg_manager.current_faction_index())
48  , last_leader_(flg_manager.current_leader_index())
49  , last_gender_(flg_manager.current_gender_index())
50 {
51 }
52 
54 {
55  find_widget<label>(&window, "starting_pos", false).set_label(std::to_string(side_));
56 
57  //
58  // Set up gender radio buttons
59  //
60  toggle_button& gender_rand = find_widget<toggle_button>(&window, "gender_random", false);
61  toggle_button& gender_male = find_widget<toggle_button>(&window, "gender_male", false);
62  toggle_button& gender_female = find_widget<toggle_button>(&window, "gender_female", false);
63 
64  gender_toggle_.add_member(&gender_rand, "random");
67 
69 
71  std::bind(&faction_select::on_gender_select, this));
72 
73  //
74  // Set up leader menu button
75  //
76  connect_signal_notify_modified(find_widget<menu_button>(&window, "leader_menu", false),
77  std::bind(&faction_select::on_leader_select, this));
78 
79  // Leader's profile button
80  find_widget<button>(&window, "type_profile", false).connect_click_handler(
81  std::bind(&faction_select::profile_button_callback, this));
82 
83  //
84  // Set up faction list
85  //
86  listbox& list = find_widget<listbox>(&window, "faction_list", false);
87 
88  window.keyboard_capture(&list);
89 
91  std::bind(&faction_select::on_faction_select, this));
92 
93  for(const config *s : flg_manager_.choosable_factions()) {
94  const config& side = *s;
95 
96  std::map<std::string, string_map> data;
98 
99  const std::string name = side["name"].str();
100  // flag_rgb here is unrelated to any handling in the unit class
101  const std::string flag_rgb = !side["flag_rgb"].empty() ? side["flag_rgb"].str() : "magenta";
102 
103  item["label"] = (formatter() << side["image"] << "~RC(" << flag_rgb << ">" << tc_color_ << ")").str();
104  data.emplace("faction_image", item);
105 
106  item["label"] = name;
107  data.emplace("faction_name", item);
108 
109  list.add_row(data);
110  }
111 
112  list.select_row(flg_manager_.current_faction_index());
113 
115 }
116 
118 {
119  const int selected_row = find_widget<listbox>(get_window(), "faction_list", false).get_selected_row();
120 
121  if(selected_row == -1) {
122  return;
123  }
124 
125  // Since set_current_faction overrides the current leader, save a copy of the previous leader index so the
126  // leader dropdown can be set to the appropriate initial selection.
127  const int previous_leader_selection = flg_manager_.current_leader_index();
128 
129  flg_manager_.set_current_faction(selected_row);
130 
131  std::vector<config> leaders;
132 
133  for(const std::string& leader : flg_manager_.choosable_leaders()) {
134  const unit_type* unit = unit_types.find(leader);
135 
136  if(unit) {
137  const std::string icon = formatter() << unit->image() << "~RC(" << unit->flag_rgb() << ">" << tc_color_ << ")";
138  leaders.emplace_back("label", unit->type_name(), "icon", icon);
139  } else if(leader == "random") {
140  leaders.emplace_back("label", _("Random"), "icon", ng::random_enemy_picture);
141  } else if(leader == "null") {
142  leaders.emplace_back("label", font::unicode_em_dash);
143  } else {
144  leaders.emplace_back("label", "?");
145  }
146  }
147 
148  menu_button& leader_dropdown = find_widget<menu_button>(get_window(), "leader_menu", false);
149 
150  leader_dropdown.set_values(leaders, std::min<int>(leaders.size() - 1, previous_leader_selection));
151  leader_dropdown.set_active(leaders.size() > 1 && !flg_manager_.is_saved_game());
152 
154 
155  // Print recruits
156  const std::vector<std::string> recruit_list = utils::split(flg_manager_.current_faction()["recruit"]);
157  std::vector<t_string> recruit_names;
158 
159  for(const auto& recruit : recruit_list) {
160  if(const unit_type* rt = unit_types.find(recruit)) {
161  recruit_names.push_back(font::unicode_bullet + " " + rt->type_name());
162  }
163  }
164 
165  std::sort(recruit_names.begin(), recruit_names.end(), [](const std::string& s1, const std::string& s2) {
166  return translation::compare(s1, s2) < 0;
167  });
168 
169  find_widget<styled_widget>(get_window(), "recruits", false).set_label(utils::join(recruit_names, "\n"));
170 }
171 
173 {
174  flg_manager_.set_current_leader(find_widget<menu_button>(get_window(), "leader_menu", false).get_value());
175 
176  // TODO: should we decouple this from the flg manager and instead just check the unit type directly?
177  // If that's done so, we'd need to come up with a different check for Random availability.
178  gender_toggle_.set_members_enabled([this](const std::string& gender)->bool {
179  const std::vector<std::string>& genders = flg_manager_.choosable_genders();
180  return std::find(genders.begin(), genders.end(), gender) != genders.end();
181  });
182 
184 
185  // Disable the profile button if leader_type is dash or "Random"
186  button& profile_button = find_widget<button>(get_window(), "type_profile", false);
187  const std::string& leader_type = find_widget<menu_button>(get_window(), "leader_menu", false).get_value_string();
188  profile_button.set_active(unit_types.find(leader_type) != nullptr);
189 }
190 
192 {
193  const std::string& leader_type = find_widget<menu_button>(get_window(), "leader_menu", false).get_value_string();
194  const unit_type* ut = unit_types.find(leader_type);
195  if(ut != nullptr) {
196  preferences::encountered_units().insert(ut->id());
198  }
199 }
200 
202 {
204 
206 }
207 
209 {
210  std::string leader_image = ng::random_enemy_picture;
211 
214  leader_image = formatter() << utg.image() << "~RC(" << utg.flag_rgb() << ">" << tc_color_ << ")";
215  }
216 
217  find_widget<drawing>(get_window(), "leader_image", false).set_label(leader_image);
218 }
219 
221 {
222  //
223  // If we're canceling, restore the previous selections. It might be worth looking
224  // into only making selections at all here in post_show, but that would require a
225  // refactor of the flg_manager class.
226  //
227  // Also, note it's important to set these in the order of faction -> leader -> gender
228  // or the saved indices will be invalid!
229  //
230  // -- vultraz, 2018-06-16
231  //
232  if(get_retval() != retval::OK) {
236  }
237 }
238 
239 } // namespace dialogs
Define the common log macros for the gui toolkit.
const std::vector< std::string > & choosable_genders() const
Definition: flg_manager.hpp:65
int current_faction_index() const
static const std::string s_male
Standard string id (not translatable) for MALE.
Definition: race.hpp:29
virtual void post_show(window &window) override
Actions to be taken after the window has been shown.
void on_faction_select()
Callbacks.
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:1262
This class represents a single unit of a specific type.
Definition: unit.hpp:121
A menu_button is a styled_widget to choose an element from a list of elements.
Definition: menu_button.hpp:61
std::string join(const T &v, const std::string &s=",")
Generates a new string joining container items in a list.
const std::string & current_gender() const
Definition: flg_manager.hpp:71
T get_active_member_value()
Returns the value paired with the currently actively toggled member of the group. ...
Definition: group.hpp:96
int compare(const std::string &s1, const std::string &s2)
Case-sensitive lexicographical comparison.
Definition: gettext.cpp:473
const std::string & flag_rgb() const
Definition: types.cpp:723
This file contains the window object, this object is a top level container which has the event manage...
void set_members_enabled(std::function< bool(const T &)> predicate)
Wrapper for enabling or disabling member widgets.
Definition: group.hpp:143
unit_type_data unit_types
Definition: types.cpp:1481
void set_current_leader(const unsigned index)
STL namespace.
window * get_window() const
Returns a pointer to the dialog&#39;s window.
int current_leader_index() const
Definition: flg_manager.hpp:79
void set_current_gender(const unsigned index)
static std::string _(const char *str)
Definition: gettext.hpp:93
A single unit type that the player may recruit.
Definition: types.hpp:45
const std::vector< const config * > & choosable_factions() const
Definition: flg_manager.hpp:61
static const std::string s_female
Standard string id (not translatable) for FEMALE.
Definition: race.hpp:28
The listbox class.
Definition: listbox.hpp:43
const std::vector< std::string > & choosable_leaders() const
Definition: flg_manager.hpp:63
void connect_signal_notify_modified(dispatcher &dispatcher, const signal_notification_function &signal)
Connects a signal handler for getting a notification upon modification.
Definition: dispatcher.cpp:187
This file contains the settings handling of the widget library.
std::ostringstream wrapper.
Definition: formatter.hpp:39
const t_string & type_name() const
The name of the unit in the current language setting.
Definition: types.hpp:141
const std::string & current_leader() const
Definition: flg_manager.hpp:69
void set_values(const std::vector<::config > &values, unsigned selected=0)
const std::string & id() const
The id for this unit_type.
Definition: types.hpp:144
bool is_saved_game() const
Definition: flg_manager.hpp:52
void show_unit_description(const unit &u)
Definition: help.cpp:75
std::string flag_rgb
void set_current_faction(const unsigned index)
void add_member(selectable_item *w, const T &value)
Adds a widget/value pair to the group map.
Definition: group.hpp:42
const config & current_faction() const
Definition: flg_manager.hpp:67
static map_location::DIRECTION s
std::map< std::string, t_string > string_map
Definition: widget.hpp:26
std::set< std::string > & encountered_units()
Definition: game.cpp:930
const std::string unicode_bullet
Definition: constants.cpp:47
static int sort(lua_State *L)
Definition: ltablib.cpp:397
const std::string random_enemy_picture("units/random-dice.png")
const std::string & image() const
Definition: types.hpp:179
int get_retval() const
Returns the cached window exit code.
virtual void set_active(const bool active) override
See styled_widget::set_active.
Definition: button.cpp:63
std::vector< std::string > split(const config_attribute_value &val)
const std::string unicode_em_dash
Definition: constants.cpp:44
Simple push button.
Definition: button.hpp:36
group< std::string > gender_toggle_
const unit_type & get_gender_unit_type(std::string gender) const
Returns a gendered variant of this unit_type.
Definition: types.cpp:456
virtual void set_active(const bool active) override
See styled_widget::set_active.
Definition: menu_button.cpp:75
Dialog was closed with the OK button.
Definition: retval.hpp:35
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:61
virtual void pre_show(window &window) override
Actions to be taken before showing the window.
base class of top level items, the only item which needs to store the final canvases to draw on...
Definition: window.hpp:65
bool empty() const
Definition: config.cpp:941
Class for a toggle button.
std::pair< std::string, unsigned > item
Definition: help_impl.hpp:410
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 &)> func)
Sets a common callback function for all members.
Definition: group.hpp:121