From 6af8a34d91582ce15a0341e75d3e55d847a5a47a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=BCrgen=20Doser?= <jurgen.doser@gmail.com>
Date: Sat, 8 Dec 2012 18:10:54 +0100
Subject: Basic support for configuring which mods to load for each world

settings.h: added function to return all keys used in settings, and a
function to remove a setting

mods.{h,cpp}: added class ModConfiguration that represents a subset of the installed mods.

server.{h,cpp}: server does not load add-on mods that are disabled in
the world.mt file. mods are disabled by a setting of the form
"load_mod_<modname> = false". if no load_mod_<modname> = ... setting
is found, the mod is loaded anyways for backwards compatibilty. server
also complains to errorstream about mods with unstatisfied
dependencies and about mods that are not installed.

guiConfigureWorld.{h,cpp}: shows a treeview of installed add-on mods
and modpacks with little icons in front of their name indicating their
status: a checkmark for enabled mods, a cross for disabled mods, a
question mark for "new" mods

Mods can be enabled/disabled by a checkbox. Mods also show a list of
dependencies and reverse dependencies. double-click on a mod in
dependency or reverse dependency listbox selects the corresponding
mod. Enabling a mod also enables all its dependencies. Disabling a mod
also disables all its reverse dependencies.

For modpacks, show buttons to enable/disable all mods (recursively,
including their dependencies) in it.

Button "Save" saves the current settings to the world.mt file and
returns to the main menu. Button "Cancel" returns to main menu without
saving.

basic keyboard controls (if the proper widget has keyboard focus):

up/down: scroll through tree of mods
left/right: collaps/expand a modpack
space: enable/disable the selected mod
---
 src/mods.h | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 82 insertions(+), 7 deletions(-)

(limited to 'src/mods.h')

diff --git a/src/mods.h b/src/mods.h
index d55dd6c92..37e2cd2db 100644
--- a/src/mods.h
+++ b/src/mods.h
@@ -22,8 +22,11 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #include "irrlichttypes.h"
 #include <irrList.h>
+#include <list>
 #include <set>
+#include <vector>
 #include <string>
+#include <map>
 #include <exception>
 
 class ModError : public std::exception
@@ -47,21 +50,93 @@ struct ModSpec
 {
 	std::string name;
 	std::string path;
+	//if normal mod:
 	std::set<std::string> depends;
 	std::set<std::string> unsatisfied_depends;
-
-	ModSpec(const std::string &name_="", const std::string path_="",
-			const std::set<std::string> &depends_=std::set<std::string>()):
+	// if modpack:
+	std::map<std::string,ModSpec> modpack_content;
+	ModSpec(const std::string name_="", const std::string path_="",
+			const std::set<std::string> depends_=std::set<std::string>()):
 		name(name_),
 		path(path_),
 		depends(depends_),
-		unsatisfied_depends(depends_)
+		unsatisfied_depends(depends_),
+		modpack_content()	
 	{}
 };
 
-// Get a dependency-sorted list of ModSpecs
-core::list<ModSpec> getMods(core::list<std::string> &modspaths)
-		throw(ModError);
+
+std::map<std::string,ModSpec> getModsInPath(std::string path);
+
+// expands modpack contents, but does not replace them.
+std::map<std::string, ModSpec> flattenModTree(std::map<std::string, ModSpec> mods);
+
+// replaces modpack Modspecs with their content
+std::vector<ModSpec> flattenMods(std::map<std::string,ModSpec> mods);
+
+// removes Mods mentioned in exclude_mod_names
+std::vector<ModSpec> filterMods(std::vector<ModSpec> mods,
+								std::set<std::string> exclude_mod_names);
+
+// a ModConfiguration is a subset of installed mods, expected to have
+// all dependencies fullfilled, so it can be used as a list of mods to
+// load when the game starts.
+class ModConfiguration
+{
+public:
+	ModConfiguration():
+		m_unsatisfied_mods(),
+		m_sorted_mods()
+	{}
+
+		
+	ModConfiguration(std::string worldpath);
+
+	// adds all mods in the given path. used for games, modpacks
+	// and world-specific mods (worldmods-folders)
+	void addModsInPath(std::string path)
+	{
+		addMods(flattenMods(getModsInPath(path)));
+	}
+
+	// adds all mods in the given path whose name does not appear
+	// in the exclude_mods set. 
+	void addModsInPathFiltered(std::string path, std::set<std::string> exclude_mods);
+
+	// adds all mods in the set.
+	void addMods(std::vector<ModSpec> mods);
+
+	// checks if all dependencies are fullfilled.
+	bool isConsistent()
+	{
+		return m_unsatisfied_mods.empty();
+	}
+
+	std::vector<ModSpec> getMods()
+	{
+		return m_sorted_mods;
+	}
+
+	std::list<ModSpec> getUnsatisfiedMods()
+	{
+		return m_unsatisfied_mods;
+	}
+
+private:
+
+	// mods with unmet dependencies. This is a list and not a
+	// vector because we want easy removal of elements at every
+	// position.
+	std::list<ModSpec> m_unsatisfied_mods;
+
+	// list of mods sorted such that they can be loaded in the
+	// given order with all dependencies being fullfilled. I.e.,
+	// every mod in this list has only dependencies on mods which
+	// appear earlier in the vector.
+	std::vector<ModSpec> m_sorted_mods;
+
+};
+
 
 #endif
 
-- 
cgit v1.2.3