The Battle for Wesnoth  1.19.5+dev
filter.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2014 - 2024
3  by Chris Beck <render787@gmail.com>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #include "units/filter.hpp"
17 
18 #include "log.hpp"
19 
20 #include "display_context.hpp"
21 #include "config.hpp"
22 #include "game_data.hpp"
23 #include "game_version.hpp" // for version_info
24 #include "map/map.hpp"
25 #include "map/location.hpp"
26 #include "scripting/game_lua_kernel.hpp" //Needed for lua kernel
27 #include "side_filter.hpp"
28 #include "team.hpp"
29 #include "terrain/filter.hpp"
30 #include "units/unit.hpp"
31 #include "units/types.hpp"
32 #include "variable.hpp" // needed for vconfig, scoped unit
33 #include "formula/callable_objects.hpp"
34 #include "formula/formula.hpp"
36 #include "formula/string_utils.hpp"
37 #include "resources.hpp"
38 #include "deprecation.hpp"
39 
40 static lg::log_domain log_config("config");
41 #define ERR_CF LOG_STREAM(err, log_config)
42 #define WRN_CF LOG_STREAM(warn, log_config)
43 #define DBG_CF LOG_STREAM(debug, log_config)
44 
45 static lg::log_domain log_wml("wml");
46 #define ERR_WML LOG_STREAM(err, log_wml)
47 
48 using namespace unit_filter_impl;
49 
51  : cfg_(cfg)
52  , fc_(resources::filter_con)
53  , use_flat_tod_(false)
54  , impl_(cfg_)
55  , max_matches_(-1)
56 {
57 }
58 
59 bool unit_filter::matches(const unit& u) const {
61 }
62 
63 bool unit_filter::matches(const unit & u, const unit & u2) const {
65 }
66 
67 std::vector<const unit *> unit_filter::all_matches_on_map(const map_location* loc, const unit* other_unit) const
68 {
69  std::vector<const unit *> ret;
70  int max_matches = max_matches_;
71 
72  for (const unit & u : fc_->get_disp_context().units()) {
73  if (impl_.matches(unit_filter_impl::unit_filter_args{u, loc ? *loc : u.get_location(), other_unit, fc_, use_flat_tod_})) {
74  if(max_matches == 0) {
75  return ret;
76  }
77  --max_matches;
78  ret.push_back(&u);
79  }
80  }
81  return ret;
82 }
83 
85  const unit_map & units = fc_->get_disp_context().units();
86  for(unit_map::const_iterator u = units.begin(); u != units.end(); ++u) {
87  if (matches(*u, u->get_location())) {
88  return u.get_shared_ptr();
89  }
90  }
91  return unit_const_ptr();
92 }
93 
94 namespace {
95 
96 struct unit_filter_xy : public unit_filter_base
97 {
98  unit_filter_xy(const std::string& x, const std::string& y) : x_(x), y_(y) {}
99 
100  virtual bool matches(const unit_filter_args& args) const override
101  {
104 
105  if(x.empty() && y.empty()) {
106  return false;
107  }
108  else if(x == "recall" && y == "recall") {
109  return !args.context().get_disp_context().map().on_board(args.loc);
110  }
111  else {
112  return args.loc.matches_range(x, y);
113  }
114  }
115 
116  const std::string x_;
117  const std::string y_;
118 };
119 
120 struct unit_filter_adjacent : public unit_filter_base
121 {
122  unit_filter_adjacent(const vconfig& cfg)
123  : child_(cfg)
124  , cfg_(cfg)
125  {
126  }
127 
128  virtual bool matches(const unit_filter_args& args) const override
129  {
130  const unit_map& units = args.context().get_disp_context().units();
131  const auto adjacent = get_adjacent_tiles(args.loc);
132  int match_count=0;
133 
134  config::attribute_value i_adjacent = cfg_["adjacent"];
135  std::vector<map_location::direction> dirs;
136  if (i_adjacent.empty()) {
138  } else {
139  dirs = map_location::parse_directions(i_adjacent);
140  }
141  for (map_location::direction dir : dirs) {
142  unit_map::const_iterator unit_itor = units.find(adjacent[static_cast<int>(dir)]);
143  if (unit_itor == units.end() || !child_.matches(unit_filter_args{*unit_itor, unit_itor->get_location(), &args.u, args.fc, args.use_flat_tod} )) {
144  continue;
145  }
146  auto is_enemy = cfg_["is_enemy"];
147  if (!is_enemy.empty() && is_enemy.to_bool() != args.context().get_disp_context().get_team(args.u.side()).is_enemy(unit_itor->side())) {
148  continue;
149  }
150  ++match_count;
151  }
152 
153  static std::vector<std::pair<int,int>> default_counts = utils::parse_ranges_unsigned("1-6");
154  config::attribute_value i_count = cfg_["count"];
155  return in_ranges(match_count, !i_count.blank() ? utils::parse_ranges_unsigned(i_count) : default_counts);
156  }
157 
158  const unit_filter_compound child_;
159  const vconfig cfg_;
160 };
161 
162 
163 template<typename F>
164 struct unit_filter_child_literal : public unit_filter_base
165 {
166  unit_filter_child_literal(const vconfig& v, const F& f) : v_(v) , f_(f) {}
167  virtual bool matches(const unit_filter_args& args) const override
168  {
169  return f_(v_, args);
170  }
171  vconfig v_;
172  F f_;
173 };
174 
175 template<typename T, typename F>
176 struct unit_filter_attribute_parsed : public unit_filter_base
177 {
178  unit_filter_attribute_parsed(T&& v, F&& f) : v_(std::move(v)), f_(std::move(f)) {}
179  virtual bool matches(const unit_filter_args& args) const override
180  {
181  return f_(v_, args);
182  }
183  T v_;
184  F f_;
185 };
186 
187 template<typename C, typename F>
188 struct unit_filter_attribute_literal : public unit_filter_base
189 {
190  unit_filter_attribute_literal(std::string&& v, C&& c, F&& f) : v_(std::move(v)), c_(std::move(c)), f_(std::move(f)) {}
191  virtual bool matches(const unit_filter_args& args) const override
192  {
195  return f_(c_(v), args);
196  }
197  std::string v_;
198  C c_;
199  F f_;
200 };
201 
202 class contains_dollar_visitor
203 #ifdef USING_BOOST_VARIANT
204  : public boost::static_visitor<bool>
205 #endif
206 {
207 public:
208  contains_dollar_visitor() {}
209 
210 
211  template<typename T>
212  bool operator()(const T&) const { return false; }
213 
214  bool operator()(const t_string&) const { return true; }
215 
216  bool operator()(const std::string& s) const
217  {
218  return s.find('$') != std::string::npos;
219  }
220 };
221 
222 }
223 
224 
225 unit_filter_compound::unit_filter_compound(vconfig cfg)
226  : children_()
227  , cond_children_()
228 {
229  fill(cfg);
230 }
231 
233 {
234  bool res;
235 
236  if(args.loc.valid()) {
237  scoped_xy_unit auto_store("this_unit", args.u.get_location(), args.context().get_disp_context().units());
238  if (args.u2) {
239  const map_location& loc2 = args.u2->get_location();
240  scoped_xy_unit u2_auto_store("other_unit", loc2, args.context().get_disp_context().units());
241  res = filter_impl(args);
242  } else {
243  res = filter_impl(args);
244  }
245  } else {
246  // If loc is invalid, then this is a recall list unit (already been scoped)
247  res = filter_impl(args);
248  }
249 
250  // Handle [and], [or], and [not] with in-order precedence
251  for(const auto & filter : cond_children_) {
252  switch (filter.first) {
253  case conditional_type::type::filter_and:
254  res = res && filter.second.matches(args);
255  break;
256  case conditional_type::type::filter_or:
257  res = res || filter.second.matches(args);
258  break;
259  case conditional_type::type::filter_not:
260  res = res && !filter.second.matches(args);
261  break;
262  }
263  }
264  return res;
265 }
266 
268 {
269  for(const auto & filter : children_) {
270  if (!filter->matches(args)) {
271  return false;
272  }
273  }
274  return true;
275 }
276 
277 template<typename F>
279 {
280  children_.emplace_back(new unit_filter_child_literal<F>(c, func));
281 }
282 
283 template<typename C, typename F>
285 {
286  if(v.blank()) {
287  }
288  else if(v.apply_visitor(contains_dollar_visitor())) {
289  children_.emplace_back(new unit_filter_attribute_literal<C, F>(std::move(v.str()), std::move(conv), std::move(func)));
290  }
291  else {
292  children_.emplace_back(new unit_filter_attribute_parsed<decltype(conv(v)), F>(std::move(conv(v)), std::move(func)));
293  }
294 }
295 
296 namespace {
297 
298  struct ability_match
299  {
300  std::string tag_name;
301  const config* cfg;
302  };
303 
304  void get_ability_children_id(std::vector<ability_match>& id_result,
305  const config& parent, const std::string& id) {
306  for (const auto [key, cfg] : parent.all_children_view())
307  {
308  if(cfg["id"] == id) {
309  ability_match special = { key, &cfg };
310  id_result.push_back(special);
311  }
312  }
313  }
314 }
315 
317  {
318  const config& literal = cfg.get_config();
319 
320  //optimisation
321  if(literal.empty()) { return; }
322 
323  create_attribute(literal["name"],
324  [](const config::attribute_value& c) { return c.t_str(); },
325  [](const t_string& str, const unit_filter_args& args) { return str == args.u.name(); }
326  );
327 
328  create_attribute(literal["id"],
329  [](const config::attribute_value& c) { return utils::split(c.str()); },
330  [](const std::vector<std::string>& id_list, const unit_filter_args& args)
331  {
332  return std::find(id_list.begin(), id_list.end(), args.u.id()) != id_list.end();
333  }
334  );
335 
336  create_attribute(literal["type"],
337  [](const config::attribute_value& c) { return utils::split(c.str()); },
338  [](const std::vector<std::string>& types, const unit_filter_args& args)
339  {
340  return std::find(types.begin(), types.end(), args.u.type_id()) != types.end();
341  }
342  );
343 
344  create_attribute(literal["type_adv_tree"],
345  [](const config::attribute_value& c) { return utils::split(c.str()); },
346  [](const std::vector<std::string>& types, const unit_filter_args& args)
347  {
348  std::set<std::string> types_expanded;
349  for(const std::string& type : types) {
350  if(types_expanded.count(type)) {
351  continue;
352  }
353  if(const unit_type* ut = unit_types.find(type)) {
354  const auto& tree = ut->advancement_tree();
355  types_expanded.insert(tree.begin(), tree.end());
356  types_expanded.insert(type);
357  }
358  }
359  return types_expanded.find(args.u.type_id()) != types_expanded.end();
360  }
361  );
362 
363  create_attribute(literal["variation"],
364  [](const config::attribute_value& c) { return utils::split(c.str()); },
365  [](const std::vector<std::string>& types, const unit_filter_args& args)
366  {
367  return std::find(types.begin(), types.end(), args.u.variation()) != types.end();
368  }
369  );
370 
371  create_attribute(literal["has_variation"],
372  [](const config::attribute_value& c) { return utils::split(c.str()); },
373  [](const std::vector<std::string>& types, const unit_filter_args& args)
374  {
375  // If this unit is a variation itself then search in the base unit's variations.
376  const unit_type* const type = args.u.variation().empty() ? &args.u.type() : unit_types.find(args.u.type().parent_id());
377  assert(type);
378 
379  for(const std::string& variation_id : types) {
380  if (type->has_variation(variation_id)) {
381  return true;
382  }
383  }
384  return false;
385  }
386  );
387 
388  create_attribute(literal["ability"],
389  [](const config::attribute_value& c) { return utils::split(c.str()); },
390  [](const std::vector<std::string>& abilities, const unit_filter_args& args)
391  {
392  for(const std::string& ability_id : abilities) {
393  if (args.u.has_ability_by_id(ability_id)) {
394  return true;
395  }
396  }
397  return false;
398  }
399  );
400 
401  create_attribute(literal["ability_type"],
402  [](const config::attribute_value& c) { return utils::split(c.str()); },
403  [](const std::vector<std::string>& abilities, const unit_filter_args& args)
404  {
405  for(const std::string& ability : abilities) {
406  if (args.u.has_ability_type(ability)) {
407  return true;
408  }
409  }
410  return false;
411  }
412  );
413 
414  create_attribute(literal["ability_id_active"],
415  [](const config::attribute_value& c) { return utils::split(c.str()); },
416  [](const std::vector<std::string>& abilities, const unit_filter_args& args)
417  {
418  const unit_map& units = args.context().get_disp_context().units();
419  for(const std::string& ability : abilities) {
420  std::vector<ability_match> ability_id_matches_self;
421  get_ability_children_id(ability_id_matches_self, args.u.abilities(), ability);
422  for(const ability_match& entry : ability_id_matches_self) {
423  if (args.u.get_self_ability_bool(*entry.cfg, entry.tag_name, args.loc)) {
424  return true;
425  }
426  }
427 
428  const auto adjacent = get_adjacent_tiles(args.loc);
429  for(unsigned i = 0; i < adjacent.size(); ++i) {
430  const unit_map::const_iterator it = units.find(adjacent[i]);
431  if (it == units.end() || it->incapacitated())
432  continue;
433  if (&*it == (args.u.shared_from_this()).get())
434  continue;
435 
436  std::vector<ability_match> ability_id_matches_adj;
437  get_ability_children_id(ability_id_matches_adj, it->abilities(), ability);
438  for(const ability_match& entry : ability_id_matches_adj) {
439  if (args.u.get_adj_ability_bool(*entry.cfg, entry.tag_name,i, args.loc, *it)) {
440  return true;
441  }
442  }
443  }
444  }
445  return false;
446  }
447  );
448 
449  create_attribute(literal["ability_type_active"],
450  [](const config::attribute_value& c) { return utils::split(c.str()); },
451  [](const std::vector<std::string>& abilities, const unit_filter_args& args)
452  {
453  for(const std::string& ability : abilities) {
454  if (!args.u.get_abilities(ability, args.loc).empty()) {
455  return true;
456  }
457  }
458  return false;
459  }
460  );
461 
462  create_attribute(literal["trait"],
463  [](const config::attribute_value& c)
464  {
465  auto res = utils::split(c.str());
466  std::sort(res.begin(), res.end());
467  return res;
468 
469  },
470  [](const std::vector<std::string>& check_traits, const unit_filter_args& args)
471  {
472 
473  std::vector<std::string> have_traits = args.u.get_traits_list();
474  std::vector<std::string> isect;
475  std::sort(have_traits.begin(), have_traits.end());
476  std::set_intersection(check_traits.begin(), check_traits.end(), have_traits.begin(), have_traits.end(), std::back_inserter(isect));
477  return !isect.empty();
478  }
479  );
480 
481  create_attribute(literal["race"],
482  [](const config::attribute_value& c) { return utils::split(c.str()); },
483  [](const std::vector<std::string>& races, const unit_filter_args& args)
484  {
485  return std::find(races.begin(), races.end(), args.u.race()->id()) != races.end();
486  }
487  );
488 
489  create_attribute(literal["gender"],
490  [](const config::attribute_value& c) { return string_gender(c.str()); },
491  [](unit_race::GENDER gender, const unit_filter_args& args)
492  {
493  return gender == args.u.gender();
494  }
495  );
496 
497  create_attribute(literal["upkeep"],
499  {
500  try {
501  return c.apply_visitor(unit::upkeep_parser_visitor());
502  } catch(std::invalid_argument&) {
503  return unit::upkeep_full();
504  }
505  },
506  [](unit::upkeep_t upkeep, const unit_filter_args& args)
507  {
508  return args.u.upkeep() == utils::visit(unit::upkeep_value_visitor{args.u}, upkeep);
509  }
510  );
511 
512  create_attribute(literal["side"],
513  [](const config::attribute_value& c)
514  {
515  std::vector<int> res;
516  for(const std::string& s : utils::split(c.str())) {
517  try {
518  res.push_back(std::stoi(s));
519  } catch(std::invalid_argument&) {
520  WRN_CF << "ignored invalid side='" << s << "' in filter";
521  }
522  }
523  return res;
524  },
525  [](const std::vector<int>& sides, const unit_filter_args& args)
526  {
527  return std::find(sides.begin(), sides.end(), args.u.side()) != sides.end();
528  }
529  );
530 
531  create_attribute(literal["status"],
532  [](const config::attribute_value& c) { return utils::split(c.str()); },
533  [](const std::vector<std::string>& statuses, const unit_filter_args& args)
534  {
535  for(const std::string& status : statuses) {
536  if (args.u.get_state(status)) {
537  return true;
538  }
539  }
540  return false;
541  }
542  );
543 
544  create_attribute(literal["has_weapon"],
545  [](const config::attribute_value& c) { return c.str(); },
546  [](const std::string& weapon, const unit_filter_args& args)
547  {
548 
549  for(const attack_type& a : args.u.attacks()) {
550  if(a.id() == weapon) {
551  return true;
552  }
553  }
554  return false;
555  }
556  );
557 
558  create_attribute(literal["role"],
559  [](const config::attribute_value& c) { return c.str(); },
560  [](const std::string& role, const unit_filter_args& args)
561  {
562  return args.u.get_role() == role;
563  }
564  );
565 
566  create_attribute(literal["alignment"],
567  [](const config::attribute_value& c) { return c.str(); },
568  [](const std::string& alignment, const unit_filter_args& args)
569  {
570  return unit_alignments::get_string(args.u.alignment()) == alignment;
571  }
572  );
573 
574  create_attribute(literal["ai_special"],
575  [](const config::attribute_value& c) { return c.str(); },
576  [](const std::string& ai_special, const unit_filter_args& args)
577  {
578  return (ai_special == "guardian") == args.u.get_state(unit::STATE_GUARDIAN);
579  }
580  );
581 
582  create_attribute(literal["usage"],
583  [](const config::attribute_value& c) { return utils::split(c.str()); },
584  [](const std::vector<std::string>& usages, const unit_filter_args& args)
585  {
586  for(const std::string& usage : usages) {
587  if(args.u.usage() == usage) {
588  return true;
589  }
590  }
591  return false;
592  }
593  );
594 
595  create_attribute(literal["canrecruit"],
596  [](const config::attribute_value& c) { return c.to_bool(); },
597  [](bool canrecruit, const unit_filter_args& args)
598  {
599  return args.u.can_recruit() == canrecruit;
600  }
601  );
602 
603  create_attribute(literal["recall_cost"],
604  [](const config::attribute_value& c) { return utils::parse_ranges_unsigned(c.str()); },
605  [](const std::vector<std::pair<int,int>>& ranges, const unit_filter_args& args)
606  {
607  return in_ranges(args.u.recall_cost(), ranges);
608  }
609  );
610 
611  create_attribute(literal["level"],
612  [](const config::attribute_value& c) { return utils::parse_ranges_unsigned(c.str()); },
613  [](const std::vector<std::pair<int,int>>& ranges, const unit_filter_args& args)
614  {
615  return in_ranges(args.u.level(), ranges);
616  }
617  );
618 
619  create_attribute(literal["defense"],
620  [](const config::attribute_value& c) { return utils::parse_ranges_unsigned(c.str()); },
621  [](const std::vector<std::pair<int,int>>& ranges, const unit_filter_args& args)
622  {
623  int actual_defense = args.u.defense_modifier(args.context().get_disp_context().map().get_terrain(args.loc));
624  return in_ranges(actual_defense, ranges);
625  }
626  );
627 
628  create_attribute(literal["movement_cost"],
629  [](const config::attribute_value& c) { return utils::parse_ranges_unsigned(c.str()); },
630  [](const std::vector<std::pair<int,int>>& ranges, const unit_filter_args& args)
631  {
632  int actual_cost = args.u.movement_cost(args.context().get_disp_context().map().get_terrain(args.loc));
633  return in_ranges(actual_cost, ranges);
634  }
635  );
636 
637  create_attribute(literal["vision_cost"],
638  [](const config::attribute_value& c) { return utils::parse_ranges_unsigned(c.str()); },
639  [](const std::vector<std::pair<int,int>>& ranges, const unit_filter_args& args)
640  {
641  int actual_cost = args.u.vision_cost(args.context().get_disp_context().map().get_terrain(args.loc));
642  return in_ranges(actual_cost, ranges);
643  }
644  );
645 
646  create_attribute(literal["jamming_cost"],
647  [](const config::attribute_value& c) { return utils::parse_ranges_unsigned(c.str()); },
648  [](const std::vector<std::pair<int,int>>& ranges, const unit_filter_args& args)
649  {
650  int actual_cost = args.u.jamming_cost(args.context().get_disp_context().map().get_terrain(args.loc));
651  return in_ranges(actual_cost, ranges);
652  }
653  );
654 
655  create_attribute(literal["lua_function"],
656  [](const config::attribute_value& c) { return c.str(); },
657  [](const std::string& lua_function, const unit_filter_args& args)
658  {
659  if (game_lua_kernel * lk = args.context().get_lua_kernel()) {
660  return lk->run_filter(lua_function.c_str(), args.u);
661  }
662  return true;
663  }
664  );
665 
666  create_attribute(literal["formula"],
667  [](const config::attribute_value& c)
668  {
669  //TODO: catch syntax error.
671  },
672  [](const wfl::formula& form, const unit_filter_args& args)
673  {
674  try {
675  const wfl::unit_callable main(args.loc, args.u);
676  wfl::map_formula_callable callable(main.fake_ptr());
677  if (args.u2) {
678  auto secondary = std::make_shared<wfl::unit_callable>(*args.u2);
679  callable.add("other", wfl::variant(secondary));
680  // It's not destroyed upon scope exit because the variant holds a reference
681  }
682  if(!form.evaluate(callable).as_bool()) {
683  return false;
684  }
685  return true;
686  } catch(const wfl::formula_error& e) {
687  lg::log_to_chat() << "Formula error in unit filter: " << e.type << " at " << e.filename << ':' << e.line << ")\n";
688  ERR_WML << "Formula error in unit filter: " << e.type << " at " << e.filename << ':' << e.line << ")";
689  // Formulae with syntax errors match nothing
690  return false;
691  }
692  }
693  );
694 
695  create_attribute(literal["find_in"],
696  [](const config::attribute_value& c) { return c.str(); },
697  [](const std::string& find_in, const unit_filter_args& args)
698  {
699  // Allow filtering by searching a stored variable of units
700  if (const game_data * gd = args.context().get_game_data()) {
701  try
702  {
703  for (const config& c : gd->get_variable_access_read(find_in).as_array())
704  {
705  if(c["id"] == args.u.id()) {
706  return true;
707  }
708  }
709  return false;
710  }
711  catch(const invalid_variablename_exception&)
712  {
713  return false;
714  }
715  }
716  return true;
717  }
718  );
719 
720  if (!literal["x"].blank() || !literal["y"].blank()) {
721  children_.emplace_back(new unit_filter_xy(literal["x"], literal["y"]));
722  }
723 
724  for(auto child : cfg.all_ordered()) {
725  auto cond = conditional_type::get_enum(child.first);
726  if(cond) {
727  cond_children_.emplace_back(std::piecewise_construct_t(), std::tuple(*cond), std::tuple(child.second));
728  }
729  else if (child.first == "filter_wml") {
730  create_child(child.second, [](const vconfig& c, const unit_filter_args& args) {
731  config fwml = c.get_parsed_config();
732 
733  /* Check if the filter only cares about variables.
734  If so, no need to serialize the whole unit. */
735  config::all_children_itors ci = fwml.all_children_range();
736  if (fwml.all_children_count() == 1 && fwml.attribute_count() == 1 && ci.front().key == "variables") {
737  return args.u.variables().matches(ci.front().cfg);
738  } else {
739  config ucfg;
740  args.u.write(ucfg);
741  return ucfg.matches(fwml);
742  }
743  });
744  }
745  else if (child.first == "filter_vision") {
746  create_child(child.second, [](const vconfig& c, const unit_filter_args& args) {
747  std::set<int> viewers;
748  side_filter ssf(c, args.fc);
749  std::vector<int> sides = ssf.get_teams();
750  viewers.insert(sides.begin(), sides.end());
751 
752  for (const int viewer : viewers) {
753  bool fogged = args.context().get_disp_context().get_team(viewer).fogged(args.loc);
754  // Check is_enemy() before invisible() to prevent infinite recursion in [abilities][hides][filter_self][filter_vision]
755  bool hiding = args.context().get_disp_context().get_team(viewer).is_enemy(args.u.side()) && args.u.invisible(args.loc);
756  bool unit_hidden = fogged || hiding;
757  if (c["visible"].to_bool(true) != unit_hidden) {
758  return true;
759  }
760  }
761  return false;
762  });
763  }
764  else if (child.first == "filter_adjacent") {
765  children_.emplace_back(new unit_filter_adjacent(child.second));
766  }
767  else if (child.first == "filter_location") {
768  create_child(child.second, [](const vconfig& c, const unit_filter_args& args) {
769  return terrain_filter(c, args.fc, args.use_flat_tod).match(args.loc);
770  });
771  }
772  else if (child.first == "filter_side") {
773  create_child(child.second, [](const vconfig& c, const unit_filter_args& args) {
774  return side_filter(c, args.fc).match(args.u.side());
775  });
776  }
777  else if ((child.first == "filter_ability") || (child.first == "experimental_filter_ability")) {
778  if(child.first == "experimental_filter_ability"){
779  deprecated_message("experimental_filter_ability", DEP_LEVEL::INDEFINITE, "", "Use filter_ability instead.");
780  }
781  create_child(child.second, [](const vconfig& c, const unit_filter_args& args) {
782  if(!(c.get_parsed_config())["active"].to_bool()){
783  for(const auto [key, cfg] : args.u.abilities().all_children_view()) {
784  if(args.u.ability_matches_filter(cfg, key, c.get_parsed_config())) {
785  return true;
786  }
787  }
788  } else {
789  const unit_map& units = args.context().get_disp_context().units();
790  for(const auto [key, cfg] : args.u.abilities().all_children_view()) {
791  if(args.u.ability_matches_filter(cfg, key, c.get_parsed_config())) {
792  if (args.u.get_self_ability_bool(cfg, key, args.loc)) {
793  return true;
794  }
795  }
796  }
797 
798  const auto adjacent = get_adjacent_tiles(args.loc);
799  for(unsigned i = 0; i < adjacent.size(); ++i) {
800  const unit_map::const_iterator it = units.find(adjacent[i]);
801  if (it == units.end() || it->incapacitated())
802  continue;
803  if (&*it == (args.u.shared_from_this()).get())
804  continue;
805 
806  for(const auto [key, cfg] : it->abilities().all_children_view()) {
807  if(it->ability_matches_filter(cfg, key, c.get_parsed_config())) {
808  if (args.u.get_adj_ability_bool(cfg, key, i, args.loc, *it)) {
809  return true;
810  }
811  }
812  }
813  }
814  }
815  return false;
816  });
817  }
818  else if (child.first == "has_attack") {
819  create_child(child.second, [](const vconfig& c, const unit_filter_args& args) {
820  for(const attack_type& a : args.u.attacks()) {
821  if(a.matches_filter(c.get_parsed_config())) {
822  return true;
823  }
824  }
825  return false;
826  });
827  }
828  else {
829  std::stringstream errmsg;
830  errmsg << "encountered a child [" << child.first << "] of a standard unit filter, it is being ignored";
831  DBG_CF << errmsg.str();
832  }
833 
834  }
835  }
Variant for storing WML attributes.
std::string str(const std::string &fallback="") const
auto apply_visitor(const V &visitor) const
Visitor support: Applies a visitor to the underlying variant.
bool blank() const
Tests for an attribute that was never set.
bool empty() const
Tests for an attribute that either was never set or was set to "".
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:172
auto all_children_view() const
In-order iteration over all children.
Definition: config.hpp:810
bool empty() const
Definition: config.cpp:849
const team & get_team(int side) const
This getter takes a 1-based side number, not a 0-based team number.
virtual const gamemap & map() const =0
virtual const unit_map & units() const =0
virtual const display_context & get_disp_context() const =0
virtual game_lua_kernel * get_lua_kernel() const =0
virtual const game_data * get_game_data() const =0
terrain_code get_terrain(const map_location &loc) const
Looks up terrain at a particular location.
Definition: map.cpp:302
bool on_board(const map_location &loc) const
Tell if a location is on the map.
Definition: map.cpp:385
bool is_enemy(int n) const
Definition: team.hpp:229
Visitor helper class to parse the upkeep value from a config.
Definition: unit.hpp:1239
Visitor helper class to fetch the appropriate upkeep value.
Definition: unit.hpp:1189
bool empty() const
Definition: unit.hpp:90
const filter_context * fc_
Definition: filter.hpp:183
int max_matches_
Definition: filter.hpp:186
bool use_flat_tod_
Definition: filter.hpp:184
bool matches(const unit &u, const map_location &loc) const
Determine if *this matches filter at a specified location.
Definition: filter.hpp:123
std::vector< const unit * > all_matches_on_map(const map_location *loc=nullptr, const unit *other_unit=nullptr) const
Definition: filter.cpp:67
unit_const_ptr first_match_on_map() const
Definition: filter.cpp:84
unit_filter(vconfig cfg)
Definition: filter.cpp:50
unit_filter_impl::unit_filter_compound impl_
Definition: filter.hpp:185
Container associating units to locations.
Definition: map.hpp:98
unit_iterator end()
Definition: map.hpp:428
unit_iterator find(std::size_t id)
Definition: map.cpp:302
unit_iterator begin()
Definition: map.hpp:418
const std::string & id() const
Definition: race.hpp:36
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:1265
A single unit type that the player may recruit.
Definition: types.hpp:43
const std::string & parent_id() const
The id of the original type from which this (variation) descended.
Definition: types.hpp:145
This class represents a single unit of a specific type.
Definition: unit.hpp:133
A variable-expanding proxy for the config class.
Definition: variable.hpp:45
const config & get_config() const
Definition: variable.hpp:75
static variant evaluate(const const_formula_ptr &f, const formula_callable &variables, formula_debugger *fdb=nullptr, variant default_res=variant(0))
Definition: formula.hpp:40
bool as_bool() const
Returns a boolean state of the variant value.
Definition: variant.cpp:313
Definitions for the interface to Wesnoth Markup Language (WML).
std::string deprecated_message(const std::string &elem_name, DEP_LEVEL level, const version_info &version, const std::string &detail)
Definition: deprecation.cpp:29
std::size_t i
Definition: function.cpp:1028
Interfaces for manipulating version numbers of engine, add-ons, etc.
bool has_ability_type(const std::string &ability) const
Check if the unit has an ability of a specific type.
Definition: abilities.cpp:556
unit_ability_list get_abilities(const std::string &tag_name, const map_location &loc) const
Gets the unit's active abilities of a particular type if it were on a specified location.
Definition: abilities.cpp:216
bool get_self_ability_bool(const config &cfg, const std::string &ability, const map_location &loc) const
Checks whether this unit currently possesses a given ability, and that that ability is active.
Definition: abilities.cpp:1715
bool has_ability_by_id(const std::string &ability) const
Check if the unit has an ability of a specific ID.
Definition: unit.cpp:1468
const config & abilities() const
Definition: unit.hpp:1807
bool get_adj_ability_bool(const config &cfg, const std::string &ability, int dir, const map_location &loc, const unit &from) const
Checks whether this unit is affected by a given ability, and that that ability is active.
Definition: abilities.cpp:1725
unit_alignments::type alignment() const
The alignment of this unit.
Definition: unit.hpp:475
int level() const
The current level of this unit.
Definition: unit.hpp:559
std::string usage() const
Gets this unit's usage.
Definition: unit.hpp:686
const std::string & get_role() const
Gets this unit's role.
Definition: unit.hpp:669
int recall_cost() const
How much gold it costs to recall this unit, or -1 if the side's default recall cost is used.
Definition: unit.hpp:640
const std::string & variation() const
The ID of the variation of this unit's type.
Definition: unit.hpp:572
bool get_state(const std::string &state) const
Check if the unit is affected by a status effect.
Definition: unit.cpp:1386
const std::string & type_id() const
The id of this unit's type.
Definition: unit.cpp:1932
const unit_race * race() const
Gets this unit's race.
Definition: unit.hpp:493
const unit_type & type() const
This unit's type, accounting for gender and variation.
Definition: unit.hpp:355
bool can_recruit() const
Whether this unit can recruit other units - ie, are they a leader unit.
Definition: unit.hpp:612
const std::string & id() const
Gets this unit's id.
Definition: unit.hpp:380
int side() const
The side this unit belongs to.
Definition: unit.hpp:343
unit_race::GENDER gender() const
The gender of this unit.
Definition: unit.hpp:465
const t_string & name() const
Gets this unit's translatable display name.
Definition: unit.hpp:403
@ STATE_GUARDIAN
The unit cannot be healed.
Definition: unit.hpp:866
int defense_modifier(const t_translation::terrain_code &terrain) const
The unit's defense on a given terrain.
Definition: unit.cpp:1716
attack_itors attacks()
Gets an iterator over this unit's attacks.
Definition: unit.hpp:933
const map_location & get_location() const
The current map location this unit is at.
Definition: unit.hpp:1404
int movement_cost(const t_translation::terrain_code &terrain) const
Get the unit's movement cost on a particular terrain.
Definition: unit.hpp:1487
int vision_cost(const t_translation::terrain_code &terrain) const
Get the unit's vision cost on a particular terrain.
Definition: unit.hpp:1497
int jamming_cost(const t_translation::terrain_code &terrain) const
Get the unit's jamming cost on a particular terrain.
Definition: unit.hpp:1507
int upkeep() const
Gets the amount of gold this unit costs a side per turn.
Definition: unit.cpp:1690
utils::variant< upkeep_full, upkeep_loyal, int > upkeep_t
Definition: unit.hpp:1182
std::vector< std::string > get_traits_list() const
Gets a list of the traits this unit currently has, including hidden traits.
Definition: unit.hpp:1135
void get_adjacent_tiles(const map_location &a, map_location *res)
Function which, given a location, will place all adjacent locations in res.
Definition: location.cpp:479
Standard logging facilities (interface).
bool in_ranges(const Cmp c, const std::vector< std::pair< Cmp, Cmp >> &ranges)
Definition: math.hpp:87
std::vector< std::pair< int, int > > default_counts
std::stringstream & log_to_chat()
Use this to show WML errors in the ingame chat.
Definition: log.cpp:543
std::function< int(lua_State *)> lua_function
game_data * gamedata
Definition: resources.cpp:22
filter_context * filter_con
Definition: resources.cpp:23
std::string interpolate_variables_into_string(const std::string &str, const string_map *const symbols)
Function which will interpolate variables, starting with '$' in the string 'str' with the equivalent ...
std::vector< std::pair< int, int > > parse_ranges_unsigned(const std::string &str)
Handles a comma-separated list of inputs to parse_range, in a context that does not expect negative v...
std::vector< std::string > split(const config_attribute_value &val)
std::shared_ptr< const unit > unit_const_ptr
Definition: ptr.hpp:27
pump_impl & impl_
Definition: pump.cpp:131
unit_race::GENDER string_gender(const std::string &str, unit_race::GENDER def)
Definition: race.cpp:149
int main(int, char **)
Definition: sdl2.cpp:25
Encapsulates the map of the game.
Definition: location.hpp:45
static std::vector< direction > parse_directions(const std::string &str)
Parse_directions takes a comma-separated list, and filters out any invalid directions.
Definition: location.cpp:138
static std::vector< direction > all_directions()
Definition: location.cpp:61
bool valid() const
Definition: location.hpp:110
direction
Valid directions which can be moved in our hexagonal world.
Definition: location.hpp:47
bool matches_range(const std::string &xloc, const std::string &yloc) const
Definition: location.cpp:322
static std::string get_string(enum_type key)
Converts a enum to its string equivalent.
Definition: enum_base.hpp:46
static constexpr utils::optional< enum_type > get_enum(const std::string_view value)
Converts a string into its enum equivalent.
Definition: enum_base.hpp:57
const filter_context & context() const
Definition: filter.hpp:62
virtual bool matches(const unit_filter_args &) const =0
bool filter_impl(const unit_filter_args &u) const
Definition: filter.cpp:267
void create_child(const vconfig &c, F func)
Definition: filter.cpp:278
void create_attribute(const config::attribute_value c, C conv, F func)
Definition: filter.cpp:284
std::vector< std::pair< conditional_type::type, unit_filter_compound > > cond_children_
Definition: filter.hpp:97
virtual bool matches(const unit_filter_args &u) const override
Definition: filter.cpp:232
std::vector< std::shared_ptr< unit_filter_base > > children_
Definition: filter.hpp:96
mock_char c
static map_location::direction s
unit_type_data unit_types
Definition: types.cpp:1500
#define DBG_CF
Definition: filter.cpp:43
#define ERR_WML
Definition: filter.cpp:46
static lg::log_domain log_wml("wml")
static lg::log_domain log_config("config")
#define e
#define f