Merge lp:~widelands-dev/widelands/bug-1408775 into lp:widelands

[GunChleoc]

Win conditions order is now determined by an init.lua file.

I kept the file names in case a change would break savegames.

[SirVer (sirver)]

> I kept the file names in case a change would break savegames.

Should be save I think - win conditions are loaded on game start and then are part of the Lua state and are therefore persisted with the savegame. If the display logic in the menus is not trying to load the files nothing should. I'd say rename the files, but drop the numbers.

review: Needs Fixing

[GunChleoc (gunchleoc)]

I have some code duplication because of the circular dependency with lua_table.h

Shall we wait until you have figured out separating this?

[SirVer (sirver)]

> Shall we wait until you have figured out separating this?

Done. Merge request is here:
https://code.launchpad.net/~widelands-dev/widelands/split_lua_table

[GunChleoc (gunchleoc)]

Common code now resides in GameSettings.

review: Needs Resubmitting

[SirVer (sirver)]

lgtm.

review: Approve

=== renamed file 'scripting/win_conditions/02_collectors.lua' => 'scripting/win_conditions/collectors.lua'
=== renamed file 'scripting/win_conditions/01_defeat_all.lua' => 'scripting/win_conditions/defeat_all.lua'
=== renamed file 'scripting/win_conditions/00_endless_game.lua' => 'scripting/win_conditions/endless_game.lua'
=== renamed file 'scripting/win_conditions/05_endless_game_fogless.lua' => 'scripting/win_conditions/endless_game_fogless.lua'
=== added file 'scripting/win_conditions/init.lua'
--- scripting/win_conditions/init.lua	1970-01-01 00:00:00 +0000
+++ scripting/win_conditions/init.lua	2015-02-06 16:48:18 +0000
@@ -0,0 +1,12 @@
+-- This config file sets the order of the starting conditions
+dirname = path.dirname(__file__)
+
+return {
+	dirname .. "collectors.lua",
+	dirname .. "wood_gnome.lua",
+	dirname .. "territorial_time.lua",
+	dirname .. "territorial_lord.lua",
+	dirname .. "defeat_all.lua",
+	dirname .. "endless_game.lua",
+	dirname .. "endless_game_fogless.lua",
+}

=== renamed file 'scripting/win_conditions/03_territorial_lord.lua' => 'scripting/win_conditions/territorial_lord.lua'
=== renamed file 'scripting/win_conditions/03_territorial_time.lua' => 'scripting/win_conditions/territorial_time.lua'
=== renamed file 'scripting/win_conditions/04_wood_gnome.lua' => 'scripting/win_conditions/wood_gnome.lua'
=== modified file 'src/logic/game_settings.h'
--- src/logic/game_settings.h	2014-09-20 09:37:47 +0000
+++ src/logic/game_settings.h	2015-02-06 16:48:18 +0000
@@ -20,11 +20,15 @@
 #ifndef WL_LOGIC_GAME_SETTINGS_H
 #define WL_LOGIC_GAME_SETTINGS_H
 
+#include <memory>
 #include <string>
 #include <vector>
 
+#include "io/filesystem/layered_filesystem.h"
 #include "logic/tribe_basic_info.h"
 #include "logic/widelands.h"
+#include "scripting/lua_interface.h"
+#include "scripting/lua_table.h"
 
 namespace Widelands {
 enum class PlayerEndResult : uint8_t;
@@ -82,7 +86,18 @@
 		scenario(false),
 		multiplayer(false),
 		savegame(false)
-	{}
+	{
+		std::unique_ptr<LuaTable> win_conditions(
+					(new LuaInterface)->run_script("scripting/win_conditions/init.lua"));
+		for (const int key : win_conditions->keys<int>()) {
+			std::string filename = win_conditions->get_string(key);
+			if (g_fs->file_exists(filename)) {
+				win_condition_scripts.push_back(filename);
+			} else {
+				throw wexception("Win condition file \"%s\" does not exist", filename.c_str());
+			}
+		}
+	}
 
 	/// Number of player position
 	int16_t playernum;
@@ -95,6 +110,8 @@
 
 	/// Lua file defining the win condition to use.
 	std::string win_condition_script;
+	/// An ordered list of all win condition script files.
+	std::vector<std::string> win_condition_scripts;
 
 	/// Is map a scenario
 	bool scenario;

=== modified file 'src/network/netclient.cc'
--- src/network/netclient.cc	2015-01-31 16:03:59 +0000
+++ src/network/netclient.cc	2015-02-06 16:48:18 +0000
@@ -124,12 +124,8 @@
 	d->desiredspeed = 1000;
 	file = nullptr;
 
-	// Temporarily register win condition scripts to get the default
-	std::set<std::string> win_condition_scripts =
-		filter(g_fs->list_directory("scripting/win_conditions"),
-	          [](const std::string& fn) {return boost::ends_with(fn, ".lua");});
-	assert(win_condition_scripts.size());
-	d->settings.win_condition_script = *win_condition_scripts.begin();
+	// Get the default win condition script
+	d->settings.win_condition_script = d->settings.win_condition_scripts.front();
 }
 
 NetClient::~NetClient ()

=== modified file 'src/network/nethost.cc'
--- src/network/nethost.cc	2015-01-31 16:03:59 +0000
+++ src/network/nethost.cc	2015-02-06 16:48:18 +0000
@@ -58,6 +58,7 @@
 #include "network/network_system.h"
 #include "profile/profile.h"
 #include "scripting/lua_interface.h"
+#include "scripting/lua_table.h"
 #include "ui_basic/progresswindow.h"
 #include "ui_fsmenu/launch_mpg.h"
 #include "wlapplication.h"
@@ -67,11 +68,8 @@
 
 
 struct HostGameSettingsProvider : public GameSettingsProvider {
-	HostGameSettingsProvider(NetHost * const _h) : h(_h), m_lua(nullptr), m_cur_wincondition(0) {}
-	~HostGameSettingsProvider() {
-		delete m_lua;
-		m_lua = nullptr;
-	}
+	HostGameSettingsProvider(NetHost * const _h) : h(_h), m_cur_wincondition(0) {}
+	~HostGameSettingsProvider() {}
 
 	void set_scenario(bool is_scenario) override {h->set_scenario(is_scenario);}
 
@@ -294,14 +292,8 @@
 	}
 
 	void next_win_condition() override {
-		if (m_win_condition_scripts.size() < 1) {
-			if (!m_lua)
-				m_lua = new LuaInterface();
-			std::set<std::string> win_conditions =
-				filter(g_fs->list_directory("scripting/win_conditions"),
-			          [](const std::string& fn) {return boost::ends_with(fn, ".lua");});
-			m_win_condition_scripts.insert(
-			   m_win_condition_scripts.end(), win_conditions.begin(), win_conditions.end());
+		if (m_win_condition_scripts.empty()) {
+			m_win_condition_scripts = h->settings().win_condition_scripts;
 			m_cur_wincondition = -1;
 		}
 
@@ -314,7 +306,6 @@
 
 private:
 	NetHost                * h;
-	LuaInterface           * m_lua;
 	int16_t                  m_cur_wincondition;
 	std::vector<std::string> m_win_condition_scripts;
 };

=== modified file 'src/ui_fsmenu/launch_spg.cc'
--- src/ui_fsmenu/launch_spg.cc	2015-01-31 16:03:59 +0000
+++ src/ui_fsmenu/launch_spg.cc	2015-02-06 16:48:18 +0000
@@ -25,6 +25,7 @@
 
 #include "base/i18n.h"
 #include "base/warning.h"
+#include "base/wexception.h"
 #include "graphic/graphic.h"
 #include "graphic/text_constants.h"
 #include "helper.h"
@@ -126,15 +127,8 @@
 		(boost::bind
 			 (&FullscreenMenuLaunchSPG::start_clicked, boost::ref(*this)));
 
-
 	m_lua = new LuaInterface();
-	std::set<std::string> win_conditions =
-	   filter(g_fs->list_directory("scripting/win_conditions"),
-	          [](const std::string& fn) {return boost::ends_with(fn, ".lua");});
-
-	m_win_condition_scripts.insert(
-	   m_win_condition_scripts.end(), win_conditions.begin(), win_conditions.end());
-
+	m_win_condition_scripts = m_settings->settings().win_condition_scripts;
 	m_cur_wincondition = -1;
 	win_condition_clicked();