The Battle for Wesnoth  1.15.0-dev
menu_item.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2018 by David White <dave@whitevine.net>
3  Part of the Battle for Wesnoth Project http://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 /**
16  * @file
17  * Definitions for a class that implements WML-defined (right-click) menu items.
18  */
19 
21 
23 #include "game_events/handlers.hpp"
24 #include "game_events/pump.hpp"
25 
26 #include "game_config.hpp"
28 #include "log.hpp"
29 #include "replay_helper.hpp"
30 #include "resources.hpp"
31 #include "synced_context.hpp"
32 #include "terrain/filter.hpp"
33 #include "deprecation.hpp"
35 
36 static lg::log_domain log_engine("engine");
37 #define ERR_NG LOG_STREAM(err, log_engine)
38 #define LOG_NG LOG_STREAM(info, log_engine)
39 
40 // This file is in the game_events namespace.
41 namespace game_events
42 {
43 namespace
44 { // Some helpers for construction.
45 
46 /**
47  * Build the event name associated with the given menu item id.
48  * This is a separate function so it can be easily shared by multiple
49  * constructors.
50  */
51 inline std::string make_item_name(const std::string& id)
52 {
53  return std::string("menu item") + (id.empty() ? "" : ' ' + id);
54 }
55 
56 /**
57  * Build the hotkey id associated with the given menu item id.
58  * This is a separate function so it can be easily shared by multiple
59  * constructors.
60  */
61 inline std::string make_item_hotkey(const std::string& id)
62 {
64 }
65 
66 } // anonymous namespace
67 
68 // Constructor for reading from a saved config.
69 wml_menu_item::wml_menu_item(const std::string& id, const config& cfg)
70  : item_id_(id)
71  , event_name_(make_item_name(id))
72  , hotkey_id_(make_item_hotkey(id))
73  , image_(cfg["image"].str())
74  , description_(cfg["description"].t_str())
75  , needs_select_(cfg["needs_select"].to_bool(false))
76  , show_if_(cfg.child_or_empty("show_if"), true)
77  , filter_location_(cfg.child_or_empty("filter_location"), true)
78  , command_(cfg.child_or_empty("command"))
79  , default_hotkey_(cfg.child_or_empty("default_hotkey"))
80  , use_hotkey_(cfg["use_hotkey"].to_bool(true))
81  , use_wml_menu_(cfg["use_hotkey"].str() != "only")
82  , is_synced_(cfg["synced"].to_bool(true))
83 {
84  if(cfg.has_attribute("needs_select")) {
85  deprecated_message("needs_select", DEP_LEVEL::INDEFINITE, {1, 15, 0});
86  }
87  gui2::legacy_menu_item parsed(cfg["description"].str(), "Multiple columns in [set_menu_item] are no longer supported; the image is specified by image=.");
88  if(parsed.contained_markup()) {
89  description_ = parsed.label();
90  if(!parsed.description().empty()) {
91  description_ += " " + parsed.description();
92  }
93  }
94 }
95 
96 // Constructor for items defined in an event.
97 wml_menu_item::wml_menu_item(const std::string& id, const vconfig& definition)
98  : item_id_(id)
99  , event_name_(make_item_name(id))
100  , hotkey_id_(make_item_hotkey(id))
101  , image_()
102  , description_()
103  , needs_select_(false)
104  , show_if_(vconfig::empty_vconfig())
105  , filter_location_(vconfig::empty_vconfig())
106  , command_()
107  , default_hotkey_()
108  , use_hotkey_(true)
109  , use_wml_menu_(true)
110  , is_synced_(true)
111 {
112  // On the off-chance that update() doesn't do it, add the hotkey here.
113  // (Update can always modify it.)
115 
116  // Apply WML.
117  update(definition);
118 }
119 
120 // Constructor for items modified by an event.
121 wml_menu_item::wml_menu_item(const std::string& id, const vconfig& definition, const wml_menu_item& original)
122  : item_id_(id)
123  , event_name_(make_item_name(id))
124  , hotkey_id_(make_item_hotkey(id))
125  , image_(original.image_)
126  , description_(original.description_)
127  , needs_select_(original.needs_select_)
128  , show_if_(original.show_if_)
130  , command_(original.command_)
131  , default_hotkey_(original.default_hotkey_)
132  , use_hotkey_(original.use_hotkey_)
133  , use_wml_menu_(original.use_wml_menu_)
134  , is_synced_(original.is_synced_)
135 {
136  // Apply WML.
137  update(definition);
138 }
139 
140 const std::string& wml_menu_item::image() const
141 {
142  // Default the image?
143  return image_.empty() ? game_config::images::wml_menu : image_;
144 }
145 
146 
148 {
149  // Failing the [show_if] tag means no show.
151  return false;
152  }
153 
154  // Failing the [fiter_location] tag means no show.
155  if(!filter_location_.empty() && !terrain_filter(filter_location_, &filter_con)(hex)) {
156  return false;
157  }
158 
159  // Failing to have a required selection means no show.
160  if(needs_select_ && !data.last_selected.valid()) {
161  return false;
162  }
163 
164  // Passed all tests.
165  return true;
166 }
167 
168 void wml_menu_item::fire_event(const map_location& event_hex, const game_data& data) const
169 {
170  if(!this->is_synced()) {
171  // It is possible to for example show a help menu during a [delay] of a synced event.
173  assert(resources::game_events != nullptr);
175  return;
176  }
177 
178  const map_location& last_select = data.last_selected;
179 
180  // No new player-issued commands allowed while this is firing.
181  const events::command_disabler disable_commands;
182 
183  // instead of adding a second "select" event like it was done before, we just fire the select event again, and this
184  // time in a synced context.
185  // note that there couldn't be a user choice during the last "select" event because it didn't run in a synced
186  // context.
187  if(needs_select_ && last_select.valid()) {
189  "fire_event", replay_helper::get_event(event_name_, event_hex, &last_select));
190  } else {
192  "fire_event", replay_helper::get_event(event_name_, event_hex, nullptr));
193  }
194 }
195 
197 {
198  if(!command_.empty()) {
199  assert(resources::game_events);
201  }
202 
203  // Hotkey support
204  if(use_hotkey_) {
206  }
207 }
208 
210 {
211  // If this menu item has a [command], add a handler for it.
212  if(!command_.empty()) {
213  assert(resources::game_events);
215  }
216 
217  // Hotkey support
218  if(use_hotkey_) {
220  }
221 }
222 
224 {
225  cfg["id"] = item_id_;
226  cfg["image"] = image_;
227  cfg["description"] = description_;
228  cfg["needs_select"] = needs_select_;
229  cfg["synced"] = is_synced_;
230 
231  if(use_hotkey_ && use_wml_menu_) {
232  cfg["use_hotkey"] = true;
233  }
234 
235  if(use_hotkey_ && !use_wml_menu_) {
236  cfg["use_hotkey"] = "only";
237  }
238 
239  if(!use_hotkey_ && use_wml_menu_) {
240  cfg["use_hotkey"] = false;
241  }
242 
243  if(!use_hotkey_ && !use_wml_menu_) {
244  ERR_NG << "Bad data: wml_menu_item with both use_wml_menu and use_hotkey set to false is not supposed to be "
245  "possible.";
246  cfg["use_hotkey"] = false;
247  }
248 
249  if(!show_if_.empty()) {
250  cfg.add_child("show_if", show_if_.get_config());
251  }
252 
253  if(!filter_location_.empty()) {
254  cfg.add_child("filter_location", filter_location_.get_config());
255  }
256 
257  if(!command_.empty()) {
258  cfg.add_child("command", command_);
259  }
260 
261  if(!default_hotkey_.empty()) {
262  cfg.add_child("default_hotkey", default_hotkey_);
263  }
264 }
265 
267 {
268  const bool old_use_hotkey = use_hotkey_;
269  // Tracks whether or not the hotkey has been updated.
270  bool hotkey_updated = false;
271 
272  if(vcfg.has_attribute("image")) {
273  image_ = vcfg["image"].str();
274  }
275 
276  if(vcfg.has_attribute("description")) {
277  gui2::legacy_menu_item parsed(vcfg["description"].str(), "Multiple columns in [set_menu_item] are no longer supported; the image is specified by image=.");
278  if(parsed.contained_markup()) {
279  description_ = parsed.label();
280  if(!parsed.description().empty()) {
281  description_ += " " + parsed.description();
282  }
283  } else {
284  description_ = vcfg["description"].t_str();
285  }
286  hotkey_updated = true;
287  }
288 
289  if(vcfg.has_attribute("needs_select")) {
290  deprecated_message("needs_select", DEP_LEVEL::INDEFINITE, {1, 15, 0});
291  needs_select_ = vcfg["needs_select"].to_bool();
292  }
293 
294  if(vcfg.has_attribute("synced")) {
295  is_synced_ = vcfg["synced"].to_bool(true);
296  }
297 
298  if(const vconfig& child = vcfg.child("show_if")) {
299  show_if_ = child;
301  }
302 
303  if(const vconfig& child = vcfg.child("filter_location")) {
304  filter_location_ = child;
306  }
307 
308  if(const vconfig& child = vcfg.child("default_hotkey")) {
309  default_hotkey_ = child.get_parsed_config();
310  hotkey_updated = true;
311  }
312 
313  if(vcfg.has_attribute("use_hotkey")) {
314  const config::attribute_value& use_hotkey_av = vcfg["use_hotkey"];
315 
316  use_hotkey_ = use_hotkey_av.to_bool(true);
317  use_wml_menu_ = use_hotkey_av.str() != "only";
318  }
319 
320  if(const vconfig& cmd = vcfg.child("command")) {
321  const bool delayed = cmd["delayed_variable_substitution"].to_bool(true);
322  update_command(delayed ? cmd.get_config() : cmd.get_parsed_config());
323  }
324 
325  // Update the registered hotkey?
326 
327  if(use_hotkey_ && !old_use_hotkey) {
328  // The hotkey needs to be enabled.
330 
331  } else if(use_hotkey_ && hotkey_updated) {
332  // The hotkey needs to be updated.
334 
335  } else if(!use_hotkey_ && old_use_hotkey) {
336  // The hotkey needs to be disabled.
338  }
339 }
340 
341 void wml_menu_item::update_command(const config& new_command)
342 {
343  // If there is an old command, remove it from the event handlers.
344  if(!command_.empty()) {
345  assert(resources::game_events);
346 
348  if(ptr->is_menu_item()) {
349  LOG_NG << "Removing command for " << event_name_ << ".\n";
350  man.remove_event_handler(command_["id"].str());
351  }
352  });
353  }
354 
355  // Update our stored command.
356  if(new_command.empty()) {
357  command_.clear();
358  } else {
359  command_ = new_command;
360 
361  // Set some fields required by event processing.
362  config::attribute_value& event_id = command_["id"];
363  if(event_id.empty() && !item_id_.empty()) {
364  event_id = item_id_;
365  }
366 
367  command_["name"] = event_name_;
368  command_["first_time_only"] = false;
369 
370  // Register the event.
371  LOG_NG << "Setting command for " << event_name_ << " to:\n" << command_;
372  assert(resources::game_events);
373  resources::game_events->add_event_handler(command_, true);
374  }
375 }
376 
377 } // end namespace game_events
void remove_event_handler(const std::string &id)
Removes an event handler.
Definition: manager.cpp:73
void to_config(config &cfg) const
Writes *this to the provided config.
Definition: menu_item.cpp:223
bool needs_select_
Whether or not this event says it makes use of the last selected unit.
Definition: menu_item.hpp:157
bool empty() const
Tests for an attribute that either was never set or was set to "".
map_location last_selected
the last location where a select event fired.
Definition: game_data.hpp:83
vconfig child(const std::string &key) const
Returns a child of *this whose key is key.
Definition: variable.cpp:252
vconfig filter_location_
A location filter to be applied to the hex where the menu is invoked.
Definition: menu_item.hpp:173
Variant for storing WML attributes.
config command_
Actions to take when this item is chosen.
Definition: menu_item.hpp:176
bool has_attribute(config_key_type key) const
Definition: config.cpp:217
void fire_event(const map_location &event_hex, const game_data &data) const
Causes the event associated with this item to fire.
Definition: menu_item.cpp:168
bool has_attribute(const std::string &key) const
< Synonym for operator[]
Definition: variable.hpp:99
t_string description_
The text to display in the menu for this item.
Definition: menu_item.hpp:154
void add_wml_hotkey(const std::string &id, const t_string &description, const config &default_hotkey)
adds a new wml hotkey to the list, but only if there is no hotkey with that id yet on the list...
const std::string & image() const
The image associated with this menu item.
Definition: menu_item.cpp:140
std::string image_
The image to display in the menu next to this item&#39;s description.
Definition: menu_item.hpp:151
bool can_show(const map_location &hex, const game_data &data, filter_context &context) const
Returns whether or not *this is applicable given the context.
Definition: menu_item.cpp:147
void clear()
Definition: config.cpp:816
an object to leave the synced context during draw or unsynced wml items when we don’t know whether w...
This file implements all the hotkey handling and menu details for play controller.
bool empty() const
Definition: variable.hpp:100
void finish_handler() const
Removes the implicit event handler for an inlined [command].
Definition: menu_item.cpp:196
const vconfig & make_safe() const
instruct the vconfig to make a private copy of its underlying data.
Definition: variable.cpp:127
vconfig show_if_
A condition that must hold in order for this menu item to be visible.
Definition: menu_item.hpp:165
std::string deprecated_message(const std::string &elem_name, DEP_LEVEL level, const version_info &version, const std::string &detail)
Definition: deprecation.cpp:29
filter_context * filter_con
Definition: resources.cpp:23
bool valid() const
Definition: location.hpp:93
bool contained_markup() const
Definition: old_markup.hpp:64
const std::string item_id_
The id of this menu item.
Definition: menu_item.hpp:142
game_events::manager * game_events
Definition: resources.cpp:24
static const std::string wml_menu_hotkey_prefix
Encapsulates the map of the game.
Definition: location.hpp:42
void init_handler() const
Initializes the implicit event handler for an inlined [command].
Definition: menu_item.cpp:209
Domain specific events.
Definition: action_wml.cpp:88
Define conditionals for the game&#39;s events mechanism, a.k.a.
void add_event_handler(const config &handler, bool is_menu_item=false)
Create an event handler.
Definition: manager.cpp:67
bool is_synced_
If true, this item will be sent to the clients.
Definition: menu_item.hpp:191
const std::string & label() const
Definition: old_markup.hpp:49
Define the game&#39;s event mechanism.
bool to_bool(bool def=false) const
The game event manager loads the scenario configuration object, and ensures that events are handled a...
Definition: manager.hpp:43
config & add_child(config_key_type key)
Definition: config.cpp:479
pump_result_t fire(const std::string &event, const entity_location &loc1=entity_location::null_entity, const entity_location &loc2=entity_location::null_entity, const config &data=config())
Function to fire an event.
Definition: pump.cpp:491
bool use_hotkey_
If true, allow using a hotkey to trigger this item.
Definition: menu_item.hpp:182
static bool run_and_throw(const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function)
bool conditional_passed(const vconfig &cond)
Define the handlers for the game&#39;s events mechanism.
static bool run_in_synced_context_if_not_already(const std::string &commandname, const config &data, bool use_undo=true, bool show=true, synced_command::error_handler_function error_handler=default_error_function)
checks whether we are currently running in a synced context, and if not we enters it...
A variable-expanding proxy for the config class.
Definition: variable.hpp:42
const config & get_config() const
Definition: variable.hpp:75
Standard logging facilities (interface).
bool use_wml_menu_
If true, allow using the menu to trigger this item.
Definition: menu_item.hpp:185
Implements simple parsing of legacy GUI1 item markup.
Definition: old_markup.hpp:25
wml_menu_item(const std::string &id, const config &cfg)
Constructor for reading from a saved config.
Definition: menu_item.cpp:69
void update_command(const config &new_command)
Updates our command to new_command.
Definition: menu_item.cpp:341
void update(const vconfig &vcfg)
Updates *this based on vcfg.
Definition: menu_item.cpp:266
game_events::wml_event_pump & pump()
Definition: manager.cpp:228
std::shared_ptr< event_handler > handler_ptr
Definition: fwd.hpp:24
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:68
static config get_event(const std::string &name, const map_location &loc, const map_location *last_select_loc)
std::string wml_menu
void execute_on_events(const std::string &event_id, event_func_t func)
Definition: manager.cpp:160
bool remove_wml_hotkey(const std::string &id)
removes a wml hotkey with the given id, returns true if the deletion was successful ...
const std::string event_name_
The name of this item&#39;s event(s); based on the item&#39;s id.
Definition: menu_item.hpp:145
bool empty() const
Definition: config.cpp:837
std::string str(const std::string &fallback="") const
const std::string hotkey_id_
The id for this item&#39;s hotkey; based on the item&#39;s id.
Definition: menu_item.hpp:148
config default_hotkey_
Config object containing the default hotkey.
Definition: menu_item.hpp:179
const std::string & description() const
Definition: old_markup.hpp:54