The Battle for Wesnoth  1.15.1+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 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 /**
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  , persistent_(cfg["persistent"].to_bool(true))
84 {
85  if(cfg.has_attribute("needs_select")) {
86  deprecated_message("needs_select", DEP_LEVEL::INDEFINITE, {1, 15, 0});
87  }
88  gui2::legacy_menu_item parsed(cfg["description"].str(), "Multiple columns in [set_menu_item] are no longer supported; the image is specified by image=.");
89  if(parsed.contained_markup()) {
90  description_ = parsed.label();
91  if(!parsed.description().empty()) {
92  description_ += " " + parsed.description();
93  }
94  }
95 }
96 
97 // Constructor for items defined in an event.
98 wml_menu_item::wml_menu_item(const std::string& id, const vconfig& definition)
99  : item_id_(id)
100  , event_name_(make_item_name(id))
101  , hotkey_id_(make_item_hotkey(id))
102  , image_()
103  , description_()
104  , needs_select_(false)
105  , show_if_(vconfig::empty_vconfig())
106  , filter_location_(vconfig::empty_vconfig())
107  , command_()
108  , default_hotkey_()
109  , use_hotkey_(true)
110  , use_wml_menu_(true)
111  , is_synced_(true)
112  , persistent_(true)
113 {
114  // On the off-chance that update() doesn't do it, add the hotkey here.
115  // (Update can always modify it.)
117 
118  // Apply WML.
119  update(definition);
120 }
121 
122 // Constructor for items modified by an event.
123 wml_menu_item::wml_menu_item(const std::string& id, const vconfig& definition, const wml_menu_item& original)
124  : item_id_(id)
125  , event_name_(make_item_name(id))
126  , hotkey_id_(make_item_hotkey(id))
127  , image_(original.image_)
128  , description_(original.description_)
129  , needs_select_(original.needs_select_)
130  , show_if_(original.show_if_)
132  , command_(original.command_)
133  , default_hotkey_(original.default_hotkey_)
134  , use_hotkey_(original.use_hotkey_)
135  , use_wml_menu_(original.use_wml_menu_)
136  , is_synced_(original.is_synced_)
137  , persistent_(original.persistent_)
138 {
139  // Apply WML.
140  update(definition);
141 }
142 
143 const std::string& wml_menu_item::image() const
144 {
145  // Default the image?
146  return image_.empty() ? game_config::images::wml_menu : image_;
147 }
148 
149 
151 {
152  // Failing the [show_if] tag means no show.
154  return false;
155  }
156 
157  // Failing the [fiter_location] tag means no show.
158  if(!filter_location_.empty() && !terrain_filter(filter_location_, &filter_con)(hex)) {
159  return false;
160  }
161 
162  // Failing to have a required selection means no show.
163  if(needs_select_ && !data.last_selected.valid()) {
164  return false;
165  }
166 
167  // Passed all tests.
168  return true;
169 }
170 
171 void wml_menu_item::fire_event(const map_location& event_hex, const game_data& data) const
172 {
173  if(!this->is_synced()) {
174  // It is possible to for example show a help menu during a [delay] of a synced event.
176  assert(resources::game_events != nullptr);
178  return;
179  }
180 
181  const map_location& last_select = data.last_selected;
182 
183  // No new player-issued commands allowed while this is firing.
184  const events::command_disabler disable_commands;
185 
186  // instead of adding a second "select" event like it was done before, we just fire the select event again, and this
187  // time in a synced context.
188  // note that there couldn't be a user choice during the last "select" event because it didn't run in a synced
189  // context.
190  if(needs_select_ && last_select.valid()) {
192  "fire_event", replay_helper::get_event(event_name_, event_hex, &last_select));
193  } else {
195  "fire_event", replay_helper::get_event(event_name_, event_hex, nullptr));
196  }
197 }
198 
200 {
201  if(!command_.empty()) {
202  assert(resources::game_events);
204  }
205 
206  // Hotkey support
207  if(use_hotkey_) {
209  }
210 }
211 
213 {
214  // If this menu item has a [command], add a handler for it.
215  if(!command_.empty()) {
216  assert(resources::game_events);
218  }
219 
220  // Hotkey support
221  if(use_hotkey_) {
223  }
224 }
225 
227 {
228  cfg["id"] = item_id_;
229  cfg["image"] = image_;
230  cfg["description"] = description_;
231  cfg["needs_select"] = needs_select_;
232  cfg["synced"] = is_synced_;
233 
234  if(use_hotkey_ && use_wml_menu_) {
235  cfg["use_hotkey"] = true;
236  }
237 
238  if(use_hotkey_ && !use_wml_menu_) {
239  cfg["use_hotkey"] = "only";
240  }
241 
242  if(!use_hotkey_ && use_wml_menu_) {
243  cfg["use_hotkey"] = false;
244  }
245 
246  if(!use_hotkey_ && !use_wml_menu_) {
247  ERR_NG << "Bad data: wml_menu_item with both use_wml_menu and use_hotkey set to false is not supposed to be "
248  "possible.";
249  cfg["use_hotkey"] = false;
250  }
251 
252  if(!show_if_.empty()) {
253  cfg.add_child("show_if", show_if_.get_config());
254  }
255 
256  if(!filter_location_.empty()) {
257  cfg.add_child("filter_location", filter_location_.get_config());
258  }
259 
260  if(!command_.empty()) {
261  cfg.add_child("command", command_);
262  }
263 
264  if(!default_hotkey_.empty()) {
265  cfg.add_child("default_hotkey", default_hotkey_);
266  }
267 }
268 
270 {
271  const bool old_use_hotkey = use_hotkey_;
272  // Tracks whether or not the hotkey has been updated.
273  bool hotkey_updated = false;
274 
275  if(vcfg.has_attribute("image")) {
276  image_ = vcfg["image"].str();
277  }
278 
279  if(vcfg.has_attribute("description")) {
280  gui2::legacy_menu_item parsed(vcfg["description"].str(), "Multiple columns in [set_menu_item] are no longer supported; the image is specified by image=.");
281  if(parsed.contained_markup()) {
282  description_ = parsed.label();
283  if(!parsed.description().empty()) {
284  description_ += " " + parsed.description();
285  }
286  } else {
287  description_ = vcfg["description"].t_str();
288  }
289  hotkey_updated = true;
290  }
291 
292  if(vcfg.has_attribute("needs_select")) {
293  deprecated_message("needs_select", DEP_LEVEL::INDEFINITE, {1, 15, 0});
294  needs_select_ = vcfg["needs_select"].to_bool();
295  }
296 
297  if(vcfg.has_attribute("synced")) {
298  is_synced_ = vcfg["synced"].to_bool(true);
299  }
300 
301  if(vcfg.has_attribute("persistent")) {
302  persistent_ = vcfg["persistent"].to_bool(true);
303  }
304 
305  if(const vconfig& child = vcfg.child("show_if")) {
306  show_if_ = child;
308  }
309 
310  if(const vconfig& child = vcfg.child("filter_location")) {
311  filter_location_ = child;
313  }
314 
315  if(const vconfig& child = vcfg.child("default_hotkey")) {
316  default_hotkey_ = child.get_parsed_config();
317  hotkey_updated = true;
318  }
319 
320  if(vcfg.has_attribute("use_hotkey")) {
321  const config::attribute_value& use_hotkey_av = vcfg["use_hotkey"];
322 
323  use_hotkey_ = use_hotkey_av.to_bool(true);
324  use_wml_menu_ = use_hotkey_av.str() != "only";
325  }
326 
327  if(const vconfig& cmd = vcfg.child("command")) {
328  const bool delayed = cmd["delayed_variable_substitution"].to_bool(true);
329  update_command(delayed ? cmd.get_config() : cmd.get_parsed_config());
330  }
331 
332  // Update the registered hotkey?
333 
334  if(use_hotkey_ && !old_use_hotkey) {
335  // The hotkey needs to be enabled.
337 
338  } else if(use_hotkey_ && hotkey_updated) {
339  // The hotkey needs to be updated.
341 
342  } else if(!use_hotkey_ && old_use_hotkey) {
343  // The hotkey needs to be disabled.
345  }
346 }
347 
348 void wml_menu_item::update_command(const config& new_command)
349 {
350  // If there is an old command, remove it from the event handlers.
351  if(!command_.empty()) {
352  assert(resources::game_events);
353 
355  if(ptr->is_menu_item()) {
356  LOG_NG << "Removing command for " << event_name_ << ".\n";
357  man.remove_event_handler(command_["id"].str());
358  }
359  });
360  }
361 
362  // Update our stored command.
363  if(new_command.empty()) {
364  command_.clear();
365  } else {
366  command_ = new_command;
367 
368  // Set some fields required by event processing.
369  config::attribute_value& event_id = command_["id"];
370  if(event_id.empty() && !item_id_.empty()) {
371  event_id = item_id_;
372  }
373 
374  command_["name"] = event_name_;
375  command_["first_time_only"] = false;
376 
377  // Register the event.
378  LOG_NG << "Setting command for " << event_name_ << " to:\n" << command_;
379  assert(resources::game_events);
380  resources::game_events->add_event_handler(command_, true);
381  }
382 }
383 
384 } // end namespace game_events
void remove_event_handler(const std::string &id)
Removes an event handler.
Definition: manager.cpp:74
void to_config(config &cfg) const
Writes *this to the provided config.
Definition: menu_item.cpp:226
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:89
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:213
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:171
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:143
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:150
void clear()
Definition: config.cpp:863
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:199
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:212
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:68
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
bool persistent_
If true, keep this menu item in later scenarios.
Definition: menu_item.hpp:194
config & add_child(config_key_type key)
Definition: config.cpp:476
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:486
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:348
void update(const vconfig &vcfg)
Updates *this based on vcfg.
Definition: menu_item.cpp:269
game_events::wml_event_pump & pump()
Definition: manager.cpp:229
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:92
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:161
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:884
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