The Battle for Wesnoth  1.15.0-dev
campaign_selection.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2009 - 2018 by Mark de Wever <koraq@xs4all.nl>
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/widgets/button.hpp"
21 #include "gui/widgets/image.hpp"
22 #include "gui/widgets/listbox.hpp"
26 #include "gui/widgets/settings.hpp"
30 #include "gui/widgets/window.hpp"
31 #include "lexical_cast.hpp"
32 #include "preferences/game.hpp"
33 
34 #include "utils/functional.hpp"
35 #include "utils/irdya_datetime.hpp"
36 
37 namespace gui2
38 {
39 namespace dialogs
40 {
41 /*WIKI
42  * @page = GUIWindowDefinitionWML
43  * @order = 2_campaign_selection
44  *
45  * == Campaign selection ==
46  *
47  * This shows the dialog which allows the user to choose which campaign to
48  * play.
49  *
50  * @begin{table}{dialog_widgets}
51  *
52  * campaign_tree & & tree_view & m &
53  * A tree_view that contains all available campaigns. $
54  *
55  * -icon & & image & o &
56  * The icon for the campaign. $
57  *
58  * -name & & styled_widget & o &
59  * The name of the campaign. $
60  *
61  * -victory & & image & o &
62  * The icon to show when the user finished the campaign. The engine
63  * determines whether or not the user has finished the campaign and
64  * sets the visible flag for the widget accordingly. $
65  *
66  * campaign_details & & multi_page & m &
67  * A multi page widget that shows more details for the selected
68  * campaign. $
69  *
70  * -image & & image & o &
71  * The image for the campaign. $
72  *
73  * -description & & styled_widget & o &
74  * The description of the campaign. $
75  *
76  * @end{table}
77  */
78 
79 REGISTER_DIALOG(campaign_selection)
80 
81 void campaign_selection::campaign_selected(window& window)
82 {
83  tree_view& tree = find_widget<tree_view>(&window, "campaign_tree", false);
84  if(tree.empty()) {
85  return;
86  }
87 
88  assert(tree.selected_item());
89 
90  if(!tree.selected_item()->id().empty()) {
91  auto iter = std::find(page_ids_.begin(), page_ids_.end(), tree.selected_item()->id());
92 
93  const int choice = std::distance(page_ids_.begin(), iter);
94  if(iter == page_ids_.end()) {
95  return;
96  }
97 
98  multi_page& pages = find_widget<multi_page>(&window, "campaign_details", false);
99  pages.select_page(choice);
100 
101  engine_.set_current_level(choice);
102  }
103 }
104 
106 {
107  using level_ptr = ng::create_engine::level_ptr;
108 
109  auto levels = engine_.get_levels_by_type_unfiltered(ng::level::TYPE::SP_CAMPAIGN);
110 
111  switch(order) {
112  case RANK: // Already sorted by rank
113  // This'll actually never happen, but who knows if that'll ever change...
114  if(!ascending) {
115  std::reverse(levels.begin(), levels.end());
116  }
117 
118  break;
119 
120  case DATE:
121  std::sort(levels.begin(), levels.end(), [ascending](const level_ptr& a, const level_ptr& b) {
122  auto cpn_a = std::dynamic_pointer_cast<ng::campaign>(a);
123  auto cpn_b = std::dynamic_pointer_cast<ng::campaign>(b);
124 
125  if(cpn_b == nullptr) {
126  return cpn_a != nullptr;
127  }
128 
129  if(cpn_a == nullptr) {
130  return false;
131  }
132 
133  return ascending
134  ? cpn_a->dates().first < cpn_b->dates().first
135  : cpn_a->dates().first > cpn_b->dates().first;
136  });
137 
138  break;
139 
140  case NAME:
141  std::sort(levels.begin(), levels.end(), [ascending](const level_ptr& a, const level_ptr& b) {
142  const int cmp = translation::icompare(a->name(), b->name());
143  return ascending ? cmp < 0 : cmp > 0;
144  });
145 
146  break;
147  }
148 
149  tree_view& tree = find_widget<tree_view>(&window, "campaign_tree", false);
150 
151  // Remember which campaign was selected...
152  std::string was_selected = tree.selected_item()->id();
153 
154  tree.clear();
155 
156  for(const auto& level : levels) {
157  add_campaign_to_tree(window, level->data());
158  }
159 
160  if(!was_selected.empty()) {
161  find_widget<tree_view_node>(&window, was_selected, false).select_node();
162  }
163 }
164 
166 {
167  static bool force = false;
168  if(force) {
169  return;
170  }
171 
172  if(current_sorting_ == order) {
174  currently_sorted_asc_ = false;
175  } else {
176  currently_sorted_asc_ = true;
178  }
179  } else if(current_sorting_ == RANK) {
180  currently_sorted_asc_ = true;
181  current_sorting_ = order;
182  } else {
183  currently_sorted_asc_ = true;
184  current_sorting_ = order;
185 
186  force = true;
187 
188  if(order == NAME) {
189  find_widget<toggle_button>(&window, "sort_time", false).set_value(0);
190  } else if(order == DATE) {
191  find_widget<toggle_button>(&window, "sort_name", false).set_value(0);
192  }
193 
194  force = false;
195  }
196 
198 }
199 
201 {
202  /***** Setup campaign tree. *****/
203  tree_view& tree = find_widget<tree_view>(&window, "campaign_tree", false);
204 
205  tree.set_selection_change_callback(std::bind(&campaign_selection::campaign_selected, this, std::ref(window)));
206 
207  toggle_button& sort_name = find_widget<toggle_button>(&window, "sort_name", false);
208  toggle_button& sort_time = find_widget<toggle_button>(&window, "sort_time", false);
209 
211  std::bind(&campaign_selection::toggle_sorting_selection, this, std::ref(window), NAME));
212 
214  std::bind(&campaign_selection::toggle_sorting_selection, this, std::ref(window), DATE));
215 
216  window.keyboard_capture(&tree);
217 
218  /***** Setup campaign details. *****/
219  multi_page& pages = find_widget<multi_page>(&window, "campaign_details", false);
220 
221  for(const auto& level : engine_.get_levels_by_type_unfiltered(ng::level::TYPE::SP_CAMPAIGN)) {
222  const config& campaign = level->data();
223 
224  /*** Add tree item ***/
225  add_campaign_to_tree(window, campaign);
226 
227  /*** Add detail item ***/
228  std::map<std::string, string_map> data;
229  string_map item;
230 
231  item["label"] = campaign["description"];
232  item["use_markup"] = "true";
233 
234  if(!campaign["description_alignment"].empty()) {
235  item["text_alignment"] = campaign["description_alignment"];
236  }
237 
238  data.emplace("description", item);
239 
240  item["label"] = campaign["image"];
241  data.emplace("image", item);
242 
243  pages.add_page(data);
244  page_ids_.push_back(campaign["id"]);
245  }
246 
247  //
248  // Set up Mods selection dropdown
249  //
250  multimenu_button& mods_menu = find_widget<multimenu_button>(&window, "mods_menu", false);
251 
253  std::vector<config> mod_menu_values;
254  std::vector<std::string> enabled = engine_.active_mods();
255 
257  const bool active = std::find(enabled.begin(), enabled.end(), mod->id) != enabled.end();
258 
259  mod_menu_values.emplace_back("label", mod->name, "checkbox", active);
260 
261  mod_states_.push_back(active);
262  }
263 
264  mods_menu.set_values(mod_menu_values);
265  mods_menu.select_options(mod_states_);
266 
267  connect_signal_notify_modified(mods_menu, std::bind(&campaign_selection::mod_toggled, this, std::ref(window)));
268  } else {
269  mods_menu.set_active(false);
270  mods_menu.set_label(_("active_modifications^None"));
271  }
272 
273  campaign_selected(window);
274 }
275 
277 {
278  tree_view& tree = find_widget<tree_view>(&window, "campaign_tree", false);
279  std::map<std::string, string_map> data;
280  string_map item;
281 
282  item["label"] = campaign["icon"];
283  data.emplace("icon", item);
284 
285  item["label"] = campaign["name"];
286  data.emplace("name", item);
287 
288  // We completed the campaign! Calculate the appropriate victory laurel.
289  if(campaign["completed"].to_bool()) {
290  config::const_child_itors difficulties = campaign.child_range("difficulty");
291 
292  auto did_complete_at = [](const config& c) { return c["completed_at"].to_bool(); };
293 
294  // Check for non-completion on every difficulty save the first.
295  const bool only_first_completed = difficulties.size() > 1 &&
296  std::none_of(difficulties.begin() + 1, difficulties.end(), did_complete_at);
297 
298  /*
299  * Criteria:
300  *
301  * - Use the gold laurel (hardest) for campaigns with only one difficulty OR
302  * if out of two or more difficulties, the last one has been completed.
303  *
304  * - Use the bronze laurel (easiest) only if the first difficulty out of two
305  * or more has been completed.
306  *
307  * - Use the silver laurel otherwise.
308  */
309  if(!difficulties.empty() && did_complete_at(difficulties.back())) {
311  } else if(only_first_completed && did_complete_at(difficulties.front())) {
313  } else {
314  item["label"] = game_config::images::victory_laurel;
315  }
316 
317  data.emplace("victory", item);
318  }
319 
320  tree.add_node("campaign", data).set_id(campaign["id"]);
321 }
322 
324 {
325  tree_view& tree = find_widget<tree_view>(&window, "campaign_tree", false);
326 
327  if(tree.empty()) {
328  return;
329  }
330 
331  assert(tree.selected_item());
332  if(!tree.selected_item()->id().empty()) {
333  auto iter = std::find(page_ids_.begin(), page_ids_.end(), tree.selected_item()->id());
334  if(iter != page_ids_.end()) {
335  choice_ = std::distance(page_ids_.begin(), iter);
336  }
337  }
338 
339  deterministic_ = find_widget<toggle_button>(&window, "checkbox_deterministic", false).get_value_bool();
340 
342 }
343 
345 {
346  boost::dynamic_bitset<> new_mod_states =
347  find_widget<multimenu_button>(&window, "mods_menu", false).get_toggle_states();
348 
349  // Get a mask of any mods that were toggled, regardless of new state
350  mod_states_ = mod_states_ ^ new_mod_states;
351 
352  for(unsigned i = 0; i < mod_states_.size(); i++) {
353  if(mod_states_[i]) {
354  engine_.toggle_mod(i);
355  }
356  }
357 
358  // Save the full toggle states for next time
359  mod_states_ = new_mod_states;
360 }
361 
362 } // namespace dialogs
363 } // namespace gui2
void campaign_selected(window &window)
Called when another campaign is selected.
std::string victory_laurel
std::shared_ptr< level > level_ptr
void set_selection_change_callback(std::function< void(widget &)> callback)
Definition: tree_view.hpp:105
grid & add_page(const string_map &item)
Adds single page to the grid.
Definition: multi_page.cpp:43
New lexcical_cast header.
#define a
const std::string & id() const
Definition: widget.cpp:107
This file contains the window object, this object is a top level container which has the event manage...
child_itors child_range(config_key_type key)
Definition: config.cpp:366
tree_view_node * selected_item()
Definition: tree_view.hpp:95
std::string victory_laurel_easy
Simple push button.
std::pair< irdya_date, irdya_date > dates() const
std::vector< std::pair< const std::string *, const stats * > > levels
Stats (and name) for each scenario. The pointers are never nullptr.
Definition: statistics.hpp:114
Generic file dialog.
Definition: field-fwd.hpp:22
void toggle_sorting_selection(window &window, CAMPAIGN_ORDER order)
#define b
virtual void set_label(const t_string &label)
static UNUSEDNOWARN std::string _(const char *str)
Definition: gettext.hpp:89
bool toggle_mod(int index, bool force=false)
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:248
std::string victory_laurel_hardest
This file contains the settings handling of the widget library.
std::vector< level_ptr > get_levels_by_type_unfiltered(level::TYPE type) const
virtual void post_show(window &window) override
Inherited from modal_dialog.
void sort_campaigns(window &window, CAMPAIGN_ORDER order, bool ascending)
std::vector< std::string > & active_mods()
Various uncategorised dialogs.
std::vector< std::string > page_ids_
boost::iterator_range< const_child_iterator > const_child_itors
Definition: config.hpp:238
virtual void set_active(const bool active) override
See styled_widget::set_active.
std::size_t i
Definition: function.cpp:933
virtual void pre_show(window &window) override
Inherited from modal_dialog.
void select_page(const unsigned page, const bool select=true)
Selectes a page.
Definition: multi_page.cpp:106
std::map< std::string, t_string > string_map
Definition: widget.hpp:24
static int sort(lua_State *L)
Definition: ltablib.cpp:411
The multi page class.
Definition: multi_page.hpp:35
bool find(E event, F functor)
Tests whether an event handler is available.
int icompare(const std::string &s1, const std::string &s2)
Case-insensitive lexicographical comparison.
Definition: gettext.cpp:476
bool empty() const
Definition: tree_view.cpp:119
void set_modifications(const std::vector< std::string > &value, bool mp)
Definition: game.cpp:736
void set_id(const std::string &id)
Definition: widget.cpp:95
void select_options(boost::dynamic_bitset<> states)
Set the options selected in the menu.
const std::vector< extras_metadata_ptr > & get_const_extras_by_type(const MP_EXTRA extra_type) const
void set_values(const std::vector<::config > &values)
Set the available menu options.
static void reverse(lua_State *L, StkId from, StkId to)
Definition: lapi.cpp:193
bool deterministic_
whether the player checked the "Deterministic" checkbox.
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:92
mock_char c
base class of top level items, the only item which needs to store the final canvases to draw on ...
Definition: window.hpp:63
Class for a toggle button.
tree_view_node & add_node(const std::string &id, const std::map< std::string, string_map > &data, const int index=-1)
Definition: tree_view.cpp:61
void add_campaign_to_tree(window &window, const config &campaign)