add filter_context class, use in unit_filter

The filter context is, game_board + tod manager.
game_display can (and now does) implement this interface,
also game_state. This permits both animations and engine
components to use it.

src/actions/create.cpp

@@ -25,6 +25,7 @@
 
 #include "../config.hpp"
 #include "../config_assign.hpp"
+#include "../filter_context.hpp"
 #include "../game_board.hpp"
 #include "../game_display.hpp"
 #include "../game_events/pump.hpp"
@@ -434,7 +435,7 @@ namespace { // Helpers for get_recalls()
 				if ( unit_filter::matches_filter( rfilter,
 								recall_unit,
 								map_location::null_location(),
-								resources::gameboard) )
+								resources::filter_con) )
 				{
 					result.push_back(recall_unit_ptr);
 					if ( already_added != NULL )
@@ -537,7 +538,7 @@ namespace { // Helpers for check_recall_location()
 		if ( !unit_filter::matches_filter(rfilter,
 						 recall_unit,
 		                                 map_location::null_location(),
-						 resources::gameboard) )
+						 resources::filter_con) )
 			return RECRUIT_NO_ABLE_LEADER;
 
 		// Make sure the unit is on a keep.

src/ai/composite/goal.cpp

@@ -135,7 +135,7 @@ void target_unit_goal::add_targets(std::back_insert_iterator< std::vector< targe
 
 	//find the enemy leaders and explicit targets
 	BOOST_FOREACH(const unit &u, *resources::units) {
-		if (unit_filter::matches_filter(vconfig(criteria), u, u.get_location(), resources::gameboard)) {
+		if (unit_filter::matches_filter(vconfig(criteria), u, u.get_location(), resources::filter_con)) {
 			LOG_AI_GOAL << "found explicit target unit at ... " << u.get_location() << " with value: " << value() << "\n";
 			*target_list = target(u.get_location(), value(), target::EXPLICIT);
 		}
@@ -264,7 +264,7 @@ void protect_goal::add_targets(std::back_insert_iterator< std::vector< target >
 				continue;
 			}
 			//TODO: we will protect hidden units, by not testing for invisibility to current side
-			if (unit_filter::matches_filter(vconfig(criteria), u, u.get_location(), resources::gameboard)) {
+			if (unit_filter::matches_filter(vconfig(criteria), u, u.get_location(), resources::filter_con)) {
 				DBG_AI_GOAL << "side " << get_side() << ": in " << goal_type << ": " << u.get_location() << " should be protected\n";
 				items.insert(u.get_location());
 			}

src/ai/recruitment/recruitment.cpp

@@ -25,6 +25,7 @@
 #include "../manager.hpp"
 #include "../../actions/attack.hpp"
 #include "../../attack_prediction.hpp"
+#include "../../filter_context.hpp"
 #include "../../game_board.hpp"
 #include "../../game_display.hpp"
 #include "../../log.hpp"
@@ -252,7 +253,7 @@ void recruitment::execute() {
 		BOOST_FOREACH(const unit_const_ptr & recall, current_team().recall_list()) {
 			// Check if this leader is allowed to recall this unit.
 			vconfig filter = vconfig(leader->recall_filter());
-			if (!unit_filter::matches_filter(filter, *recall, map_location::null_location(), resources::gameboard)) {
+			if (!unit_filter::matches_filter(filter, *recall, map_location::null_location(), resources::filter_con)) {
 				continue;
 			}
 			data.recruits.insert(recall->type_id());
@@ -477,7 +478,7 @@ const std::string* recruitment::get_appropriate_recall(const std::string& type,
 		}
 		// Check if this leader is allowed to recall this unit.
 		vconfig filter = vconfig(leader_data.leader->recall_filter());
-		if (!unit_filter::matches_filter(filter, *recall_unit, map_location::null_location(), resources::gameboard)) {
+		if (!unit_filter::matches_filter(filter, *recall_unit, map_location::null_location(), resources::filter_con)) {
 			LOG_AI_RECRUITMENT << "Refused recall because of filter: " << recall_unit->id() << "\n";
 			continue;
 		}

src/ai/testing/aspect_attacks.cpp

@@ -76,7 +76,7 @@ boost::shared_ptr<attacks_vector> aspect_attacks::analyze_targets() const
 		std::vector<map_location> unit_locs;
 		for(unit_map::const_iterator i = units_.begin(); i != units_.end(); ++i) {
 			if (i->side() == get_side() && i->attacks_left() && !(i->can_recruit() && get_passive_leader())) {
-				if (!unit_filter::matches_filter(vconfig(filter_own_), *i, i->get_location(), resources::gameboard)) {
+				if (!unit_filter::matches_filter(vconfig(filter_own_), *i, i->get_location(), resources::filter_con)) {
 					continue;
 				}
 				unit_locs.push_back(i->get_location());
@@ -99,7 +99,7 @@ boost::shared_ptr<attacks_vector> aspect_attacks::analyze_targets() const
 		if (current_team().is_enemy(j->side()) && !j->incapacitated() &&
 		    !j->invisible(j->get_location()))
 		{
-			if (!unit_filter::matches_filter(vconfig(filter_enemy_), *j, j->get_location(), resources::gameboard)) {
+			if (!unit_filter::matches_filter(vconfig(filter_enemy_), *j, j->get_location(), resources::filter_con)) {
 				continue;
 			}
 			map_location adjacent[6];

src/display.cpp

@@ -416,6 +416,16 @@ const time_of_day & display::get_time_of_day(const map_location& /*loc*/) const
 	return tod;
 }
 
+/**
+ * Display objects don't hold a tod maanger, instead game_display objects do. If the base version of this method is called,
+ * try to get it from resources and use an assert to check for failure.
+ */
+const tod_manager & display::get_tod_man() const
+{
+	assert(resources::tod_manager);
+	return *resources::tod_manager;
+}
+
 void display::update_tod() {
 	const time_of_day& tod = get_time_of_day();
 	tod_color col = color_adjust_ + tod.color;

src/display.hpp

@@ -49,6 +49,7 @@ namespace wb {
 
 #include "animated.hpp"
 #include "display_context.hpp"
+#include "filter_context.hpp"
 #include "font.hpp"
 #include "image.hpp" //only needed for enums (!)
 #include "key.hpp"
@@ -71,7 +72,7 @@ namespace wb {
 
 class gamemap;
 
-class display
+class display : public filter_context
 {
 public:
 	display(const display_context * dc, CVideo& video, boost::weak_ptr<wb::manager> wb,
@@ -164,6 +165,7 @@ class display
 
 	void change_display_context(const display_context * dc);
 	const display_context & get_disp_context() const { return *dc_; }
+	virtual const tod_manager & get_tod_man() const; //!< This is implemented properly in game_display. The display:: impl could be pure virtual here but we decide not to.
 
 	void reset_halo_manager();
 	void reset_halo_manager(halo::manager & hm);

src/filter_context.hpp

@@ -0,0 +1,43 @@
+/*
+   Copyright (C) 2014 by Chris Beck <render787@gmail.com>
+   Part of the Battle for Wesnoth Project http://www.wesnoth.org/
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY.
+
+   See the COPYING file for more details.
+*/
+
+/**
+ *
+ * This class is an abstract base class which represents a display context
+ * (game map, units, and teams) together with a TOD manager. This, plus
+ * a lua kernel (currently a singleton) is sufficient to evaluate filters.
+ *
+ **/
+
+#ifndef FILTER_CONTEXT_HPP_INCLUDED
+#define FILTER_CONTEXT_HPP_INCLUDED
+
+#include <vector>
+
+class display_context;
+class tod_manager;
+
+class filter_context {
+public:
+	// accessors
+
+	virtual const display_context & get_disp_context() const = 0;
+	virtual const tod_manager & get_tod_man() const = 0;
+
+	// Dtor
+
+	virtual ~filter_context() {}
+};
+
+#endif

src/game_board.hpp

@@ -60,7 +60,7 @@ class game_board : public display_context {
 	friend class play_controller;
 	friend class events::mouse_handler;
 	friend class events::menu_handler;
-	friend struct game_state;
+	friend class game_state;
 
 	/**
 	 * Temporary unit move structs:

src/game_display.hpp

@@ -130,6 +130,8 @@ class game_display : public display
 
 	bool has_time_area() const;
 
+	const tod_manager & get_tod_man() const { return tod_manager_; } //<! Allows this class to properly implement filter context, used for animations
+
 protected:
 	/**
 	 * game_display pre_draw does specific things related e.g. to unit rendering

src/game_events/action_wml.cpp

@@ -406,7 +406,7 @@ namespace { // Support functions
 			speaker = units->find(event_info.loc2);
 		} else if(speaker_str != "narrator") {
 			for(speaker = units->begin(); speaker != units->end(); ++speaker){
-				if ( unit_filter::matches_filter(cfg,*speaker, resources::gameboard) )
+				if ( unit_filter::matches_filter(cfg,*speaker, resources::filter_con) )
 					break;
 			}
 		}
@@ -779,7 +779,7 @@ WML_HANDLER_FUNCTION(heal_unit, event_info, cfg)
 	std::vector<unit*> healers;
 	if (!healers_filter.null()) {
 		BOOST_FOREACH(unit& u, *units) {
-			if ( unit_filter::matches_filter(healers_filter,u, resources::gameboard) && u.has_ability_type("heals") ) {
+			if ( unit_filter::matches_filter(healers_filter,u, resources::filter_con) && u.has_ability_type("heals") ) {
 				healers.push_back(&u);
 			}
 		}
@@ -800,7 +800,7 @@ WML_HANDLER_FUNCTION(heal_unit, event_info, cfg)
 			u = units->find(event_info.loc1);
 			if(!u.valid()) return;
 		}
-		else if ( !unit_filter::matches_filter(healed_filter,*u, resources::gameboard) ) continue;
+		else if ( !unit_filter::matches_filter(healed_filter,*u, resources::filter_con) ) continue;
 
 		int heal_amount = u->max_hitpoints() - u->hitpoints();
 		if(amount.blank() || amount == "full") u->set_hitpoints(u->max_hitpoints());
@@ -859,7 +859,7 @@ WML_HANDLER_FUNCTION(kill, event_info, cfg)
 		secondary_unit = false;
 		for(unit_map::const_unit_iterator unit = resources::units->begin();
 			unit != resources::units->end(); ++unit) {
-				if ( unit_filter::matches_filter(cfg.child("secondary_unit"), *unit, resources::gameboard) )
+				if ( unit_filter::matches_filter(cfg.child("secondary_unit"), *unit, resources::filter_con) )
 				{
 					killer_loc = entity_location(*unit);
 					secondary_unit = true;
@@ -874,7 +874,7 @@ WML_HANDLER_FUNCTION(kill, event_info, cfg)
 	//Find all the dead units first, because firing events ruins unit_map iteration
 	std::vector<unit *> dead_men_walking;
 	BOOST_FOREACH(unit & u, *resources::units){
-		if ( unit_filter::matches_filter(cfg,u, resources::gameboard) ) {
+		if ( unit_filter::matches_filter(cfg,u, resources::filter_con) ) {
 			dead_men_walking.push_back(&u);
 		}
 	}
@@ -948,7 +948,7 @@ WML_HANDLER_FUNCTION(kill, event_info, cfg)
 		{
 			for(std::vector<unit_ptr>::iterator j = pi->recall_list().begin(); j != pi->recall_list().end();) { //TODO: This block is really messy, cleanup somehow...
 				scoped_recall_unit auto_store("this_unit", pi->save_id(), j - pi->recall_list().begin());
-				if (unit_filter::matches_filter(cfg, *(*j), map_location(), resources::gameboard)) {
+				if (unit_filter::matches_filter(cfg, *(*j), map_location(), resources::filter_con)) {
 					j = pi->recall_list().erase(j);
 				} else {
 					++j;
@@ -1416,7 +1416,7 @@ WML_HANDLER_FUNCTION(object, event_info, cfg)
 	map_location loc;
 	if(!filter.null()) {
 		BOOST_FOREACH(const unit &u, *resources::units) {
-			if ( unit_filter::matches_filter(filter,u, resources::gameboard) ) {
+			if ( unit_filter::matches_filter(filter,u, resources::filter_con) ) {
 				loc = u.get_location();
 				break;
 			}
@@ -1431,7 +1431,7 @@ WML_HANDLER_FUNCTION(object, event_info, cfg)
 
 	std::string command_type = "then";
 
-	if ( u != resources::units->end()  &&  (filter.null() || unit_filter::matches_filter(filter,*u, resources::gameboard)) )
+	if ( u != resources::units->end()  &&  (filter.null() || unit_filter::matches_filter(filter,*u, resources::filter_con)) )
 	{
 		///@deprecated This can be removed (and a proper duration=level implemented) after 1.11.2
 		/// Don't forget to remove it from wmllint too!
@@ -1546,7 +1546,7 @@ WML_HANDLER_FUNCTION(recall, /*event_info*/, cfg)
 		for(std::vector<unit_ptr>::iterator u = avail.begin(); u != avail.end(); ++u) {
 			DBG_NG << "checking unit against filter...\n";
 			scoped_recall_unit auto_store("this_unit", player_id, u - avail.begin());
-			if (unit_filter::matches_filter(unit_filter, *(*u), map_location(), resources::gameboard)) {
+			if (unit_filter::matches_filter(unit_filter, *(*u), map_location(), resources::filter_con)) {
 				DBG_NG << (*u)->id() << " matched the filter...\n";
 				const unit_ptr to_recruit = *u;
 				const unit* pass_check = to_recruit.get();
@@ -1557,8 +1557,8 @@ WML_HANDLER_FUNCTION(recall, /*event_info*/, cfg)
 				BOOST_FOREACH(unit_map::const_unit_iterator leader, leaders) {
 					DBG_NG << "...considering " + leader->id() + " as the recalling leader...\n";
 					map_location loc = cfg_loc;
-					if ( (leader_filter.null() || unit_filter::matches_filter(leader_filter, *leader, resources::gameboard))  &&
-					     unit_filter::matches_filter(vconfig(leader->recall_filter()), *(*u),map_location(), resources::gameboard) ) {
+					if ( (leader_filter.null() || unit_filter::matches_filter(leader_filter, *leader, resources::filter_con))  &&
+					     unit_filter::matches_filter(vconfig(leader->recall_filter()), *(*u),map_location(), resources::filter_con) ) {
 						DBG_NG << "...matched the leader filter and is able to recall the unit.\n";
 						if(!resources::gameboard->map().on_board(loc))
 							loc = leader->get_location();
@@ -1726,7 +1726,7 @@ WML_HANDLER_FUNCTION(role, /*event_info*/, cfg)
 		}
 		unit_map::iterator itor;
 		BOOST_FOREACH(unit &u, *resources::units) {
-			if ( unit_filter::matches_filter(filter,u, resources::gameboard) ) {
+			if ( unit_filter::matches_filter(filter,u, resources::filter_con) ) {
 				u.set_role(cfg["role"]);
 				found = true;
 				break;
@@ -1763,7 +1763,7 @@ WML_HANDLER_FUNCTION(role, /*event_info*/, cfg)
 				for(size_t i=0; i < pi->recall_list().size(); ++i) {
 					unit_ptr u = pi->recall_list()[i];
 					scoped_recall_unit auto_store("this_unit", player_id, i); //TODO: Should this not be inside the if? Explain me.
-					if (unit_filter::matches_filter(filter, *u, map_location(), resources::gameboard)) {
+					if (unit_filter::matches_filter(filter, *u, map_location(), resources::filter_con)) {
 						u->set_role(cfg["role"]);
 						found=true;
 						break;
@@ -2287,7 +2287,7 @@ WML_HANDLER_FUNCTION(teleport, event_info, cfg)
 	const vconfig & filter = cfg.child("filter");
 	if(!filter.null()) {
 		for (u = resources::units->begin(); u != resources::units->end(); ++u){
-			if ( unit_filter::matches_filter(filter,*u, resources::gameboard) )
+			if ( unit_filter::matches_filter(filter,*u, resources::filter_con) )
 				break;
 		}
 	}

src/game_events/conditional_wml.cpp

@@ -76,7 +76,7 @@ namespace { // Support functions
 			int match_count = 0;
 			BOOST_FOREACH(const unit &i, *resources::units)
 			{
-				if ( i.hitpoints() > 0  &&  unit_filter::matches_filter(*u,i, resources::gameboard) ) {
+				if ( i.hitpoints() > 0  &&  unit_filter::matches_filter(*u,i, resources::filter_con) ) {
 					++match_count;
 					if(counts == default_counts) {
 						// by default a single match is enough, so avoid extra work
@@ -97,7 +97,7 @@ namespace { // Support functions
 							break;
 						}
 						scoped_recall_unit auto_store("this_unit", team->save_id(), t);
-						if ( unit_filter::matches_filter(*u,*team->recall_list()[t], resources::gameboard) ) {
+						if ( unit_filter::matches_filter(*u,*team->recall_list()[t], resources::filter_con) ) {
 							++match_count;
 						}
 					}

src/game_events/entity_location.cpp

@@ -101,7 +101,7 @@ bool entity_location::matches_unit_filter(const unit_map::const_iterator & un_it
 
 	// Filter the unit at the filter location (should be the unit's
 	// location if no special filter location was specified).
-	return unit_filter::matches_filter(filter, *un_it, filter_loc_, resources::gameboard)  &&
+	return unit_filter::matches_filter(filter, *un_it, filter_loc_, resources::filter_con)  &&
 	       matches_unit(un_it);
 }
 

src/game_state.hpp

@@ -17,6 +17,7 @@
 
 class config;
 
+#include "filter_context.hpp"
 #include "game_board.hpp"
 #include "game_data.hpp"
 #include "tod_manager.hpp"
@@ -25,7 +26,9 @@ class config;
 
 namespace pathfind { class manager; }
 
-struct game_state {
+class game_state : public filter_context
+{
+public:
 	const config& level_;
 	game_data gamedata_;
 	game_board board_;
@@ -43,6 +46,9 @@ struct game_state {
 	void init(int ticks, const config & replay_start);
 
 	config to_config() const;
+
+	virtual const display_context & get_disp_context() const { return board_; }
+	virtual const tod_manager & get_tod_man() const { return tod_manager_; }
 };
 
 #endif

src/pathfind/teleport.cpp

@@ -76,7 +76,7 @@ void teleport_group::get_teleport_pair(
 	vconfig filter(cfg_.child_or_empty("filter"), true);
 	vconfig source(cfg_.child_or_empty("source"), true);
 	vconfig target(cfg_.child_or_empty("target"), true);
-	if (unit_filter::matches_filter(filter, u, loc, resources::gameboard)) {
+	if (unit_filter::matches_filter(filter, u, loc, resources::filter_con)) {
 
 		scoped_xy_unit teleport_unit("teleport_unit", loc.x, loc.y, *resources::units);
 

src/play_controller.cpp

@@ -79,6 +79,7 @@ static lg::log_domain log_engine_enemies("engine/enemies");
 static void clear_resources()
 {
 	resources::controller = NULL;
+	resources::filter_con = NULL;
 	resources::gameboard = NULL;
 	resources::gamedata = NULL;
 	resources::persist = NULL;
@@ -145,7 +146,7 @@ play_controller::play_controller(const config& level, saved_game& state_of_game,
 	resources::tod_manager = &gamestate_.tod_manager_;
 	resources::undo_stack = undo_stack_.get();
 	resources::units = &gamestate_.board_.units_;
-
+	resources::filter_con = &gamestate_;
 
 	resources::classification = &saved_game_.classification();
 	resources::mp_settings = &saved_game_.mp_settings();