Merge lp:~majcherlk/widelands/seafaring-check into lp:widelands

[Lukasz]

Now according to suggestion #1449420 seafaring tag is calculated automatically (tag is set only when map has at least 2 port spaces) and I have question: I was trying to remove seafaring checkbox but I couldn't find it in code, it exists?

[Lukasz (majcherlk)]

I changed a way of testing whether the map is seafaring (two port spaces constraint is not enough strong - we can have two port spaces incident to two different water tanks and a seafaring is still impossible). Now tag is set when there are at least two port spaces that are reachable to each other.

[GunChleoc (gunchleoc)]

I have recently done the same in a branch that isn't quite ready yet: http://bazaar.launchpad.net/~widelands-dev/widelands/bug-1390793/revision/7415

Your function is a lot better. I have delete_tag instead of remove_tag, which has an additional check in it:

void Map::delete_tag(const std::string& tag) {
       if (has_tag(tag)) {
               m_tags.erase(m_tags.find(tag));
        }
}

I have also added some diff comments.

[Lukasz (majcherlk)]

I've made some changes according to your suggestions.

[GunChleoc (gunchleoc)]

Thanks - I will merge this now :)

review: Approve

[SirVer (sirver)]

Thanks Lukasz! Great addition!

I added you to ~widelands-dev. Could you push your branches in the future to ~widelands-dev/widelands/<branch name> so that collaboration becomes easier? Others can add commits to this branch then too.

Also, feel free to pick up other peoples merge request and look through them. Ideally every contributor also reviews code - it is the best way to spread knowledge and establish a consistent style in the code base.

=== modified file 'src/editor/ui_menus/editor_main_menu_save_map.cc'
--- src/editor/ui_menus/editor_main_menu_save_map.cc	2015-01-27 20:43:52 +0000
+++ src/editor/ui_menus/editor_main_menu_save_map.cc	2015-07-25 21:18:13 +0000
@@ -188,6 +188,13 @@
 				  filename.substr(0, filename_size - 4) : filename)
 				 .c_str());
 		}
+
+		// check if map has at least two port spaces that are reachable for each other
+		if (map.allows_seafaring())
+			map.add_tag("seafaring");
+		else
+			map.delete_tag("seafaring");
+
 		if
 			(save_map
 			 	(filename,

=== modified file 'src/logic/map.cc'
--- src/logic/map.cc	2015-02-24 13:51:38 +0000
+++ src/logic/map.cc	2015-07-25 21:18:13 +0000
@@ -580,6 +580,12 @@
 	m_tags.insert(tag);
 }
 
+void Map::delete_tag(const std::string& tag) {
+	if (has_tag(tag)) {
+		m_tags.erase(m_tags.find(tag));
+	}
+}
+
 NodeCaps Map::get_max_nodecaps(const World& world, FCoords & fc) {
 	NodeCaps caps = _calc_nodecaps_pass1(world, fc, false);
 	caps = _calc_nodecaps_pass2(world, fc, false, caps);
@@ -1991,6 +1997,60 @@
 			check_neighbour_heights(n[i], area);
 }
 
+/*
+===========
+Map::allows_seafaring()
+
+This function checks if there are two ports that are reachable
+for each other - then the map is seafaring.
+=============
+*/
+bool Map::allows_seafaring() {
+	Map::PortSpacesSet port_spaces = get_port_spaces();
+	std::vector<Coords> portdocks;
+	std::set<Coords, Coords::OrderingFunctor> swim_coords;
+
+	for (const Coords& c : port_spaces) {
+		std::queue<Coords> q_positions;
+		std::set<Coords, Coords::OrderingFunctor> visited_positions;
+		FCoords fc = get_fcoords(c);
+		portdocks = find_portdock(fc);
+
+		/* remove the port space if it is not longer valid port space */
+		if ((fc.field->get_caps() & BUILDCAPS_SIZEMASK) != BUILDCAPS_BIG || portdocks.empty()) {
+			set_port_space(c, false);
+			continue;
+		}
+
+		for (const Coords& portdock: portdocks) {
+			visited_positions.insert(portdock);
+			q_positions.push(portdock);
+		}
+
+		while (!q_positions.empty()) {
+			const Coords& swim_coord = q_positions.front();
+			q_positions.pop();
+			for (uint8_t i = 1; i <= 6; ++i) {
+				FCoords neighbour;
+				get_neighbour(get_fcoords(swim_coord), i, &neighbour);
+				if ((neighbour.field->get_caps() & (MOVECAPS_SWIM | MOVECAPS_WALK)) == MOVECAPS_SWIM) {
+					if (visited_positions.count(neighbour) == 0) {
+						visited_positions.insert(neighbour);
+						q_positions.push(neighbour);
+					}
+				}
+			}
+		}
+
+		for (const Coords& swim_coord: visited_positions)
+			if (swim_coords.count(swim_coord) == 0)
+				swim_coords.insert(swim_coord);
+			else
+				return true;
+	}
+	return false;
+}
+
 
 #define MAX_RADIUS 32
 MilitaryInfluence Map::calc_influence

=== modified file 'src/logic/map.h'
--- src/logic/map.h	2015-06-10 06:46:40 +0000
+++ src/logic/map.h	2015-07-25 21:18:13 +0000
@@ -200,6 +200,7 @@
 	void set_hint       (const std::string& hint);
 	void set_background (const std::string& image_path);
 	void add_tag        (const std::string& tag);
+	void delete_tag     (const std::string& tag);
 	void set_scenario_types(ScenarioTypes t) {m_scenario_types = t;}
 
 	// Allows access to the filesystem of the map to access auxiliary files.
@@ -216,7 +217,7 @@
 
 	using Tags = std::set<std::string>;
 	const Tags & get_tags() const {return m_tags;}
-	bool has_tag(std::string & s) const {return m_tags.count(s);}
+	bool has_tag(const std::string & s) const {return m_tags.count(s);}
 
 	const std::vector<SuggestedTeamLineup>& get_suggested_teams() const {return m_suggested_teams;}
 
@@ -387,6 +388,7 @@
 	void set_port_space(Coords c, bool allowed);
 	const PortSpacesSet& get_port_spaces() {return m_port_spaces;}
 	std::vector<Coords> find_portdock(const Widelands::Coords& c) const;
+	bool allows_seafaring();
 
 protected: /// These functions are needed in Testclasses
 	void set_size(uint32_t w, uint32_t h);