Merge pull request #137 from wesnoth/elseif_branch

Implementing [elseif], plus sanity checks in ConditionalActionsWML
wesnoth · Apr 4, 2014 · ea5d219 · ea5d219
2 parents 9d35946 + 0aa53a0
commit ea5d219
Show file tree

Hide file tree

Showing 4 changed files with 181 additions and 34 deletions.
diff --git a/changelog b/changelog
@@ -29,6 +29,9 @@ Version 1.13.0-dev:
  * WML engine:
    * Added customizable recall costs for unit types and individual units,
      using the new recall_cost attribute in [unit_type] and [unit].
+   * Added support for [elseif] tags inside [if]
+   * Implemented checks for missing [then] inside [if], missing [do] inside
+     [while] and missing [case], variable= and value= inside [switch]
  * Miscellaneous and bug fixes:
    * Fix Fisher-Yates implemenation of Lua helper.shuffle (bug #21706)
    * Fixed issues with the ~BG() image path function not always working with

diff --git a/data/lua/wml-tags.lua b/data/lua/wml-tags.lua
@@ -329,45 +329,88 @@ end
 
 wml_actions.command = handle_event_commands
 
-local function if_while_handler(max_iter, pass, fail, cfg)
-	for i = 1, max_iter do
-		local t = wesnoth.eval_conditional(cfg) and pass or fail
-		if not t then return end
-		for v in helper.child_range(cfg, t) do
-			handle_event_commands(v)
-		end
+-- since if and while are Lua keywords, we can't create functions with such names
+-- instead, we store the following anonymous functions directly into
+-- the table, using the [] operator, rather than by using the point syntax
+
+wml_actions["if"] = function( cfg )
+	-- raise error if [then] is missing
+	if not helper.get_child( cfg, "then" ) then
+		helper.wml_error "[if] missing required [then] tag"
 	end
-end
 
-local function if_handler(cfg)
-	if_while_handler(1, "then", "else", cfg)
+	if wesnoth.eval_conditional( cfg ) then -- evalutate [if] tag
+		for then_child in helper.child_range ( cfg, "then" ) do
+			handle_event_commands( then_child )
+		end
+		return -- stop after executing [then] tags
+	else
+		for elseif_child in helper.child_range ( cfg, "elseif" ) do
+			-- there's no point in executing [elseif] without [then]
+			if not helper.get_child( elseif_child, "then" ) then
+				helper.wml_error "[elseif] missing required [then] tag"
+			end
+			if wesnoth.eval_conditional( elseif_child ) then -- we'll evalutate the [elseif] tags one by one
+				for then_tag in helper.child_range( elseif_child, "then" ) do
+					handle_event_commands( then_tag )
+				end
+				return -- stop on first matched condition
+			end
+		end
+		-- no matched condition, try the [else] tags
+		for else_child in helper.child_range ( cfg, "else" ) do
+			handle_event_commands( else_child )
+		end
+	end
 end
 
-local function while_handler(cfg)
-	if_while_handler(65536, "do", nil, cfg)
+wml_actions["while"] = function( cfg )
+	-- check if the [do] sub-tag is missing, and raise error if so
+	if not helper.get_child( cfg, "do" ) then
+		helper.wml_error "[while] missing required [do] tag"
+	end
+	-- we have at least one [do], execute them up to 65536 times
+	for i = 1, 65536 do
+		if wesnoth.eval_conditional( cfg ) then
+			for do_child in helper.child_range( cfg, "do" ) do
+				handle_event_commands( do_child )
+			end
+		else return end
+	end
 end
 
-wml_actions["if"] = if_handler
-wml_actions["while"] = while_handler
-
 function wml_actions.switch(cfg)
-	local value = wesnoth.get_variable(cfg.variable)
+	-- check if variable= is missing
+	if not cfg.variable then
+		helper.wml_error "[switch] missing required variable= attribute"
+	end 
+	local variable = wesnoth.get_variable(cfg.variable)
 	local found = false
+
+	-- check if the [case] sub-tag is missing, and raise error if so
+	if not helper.get_child( cfg, "case" ) then
+		helper.wml_error "[switch] missing required [case] tag"
+	end
+
 	-- Execute all the [case]s where the value matches.
-	for v in helper.child_range(cfg, "case") do
+	for case_child in helper.child_range(cfg, "case") do
+		-- warn if value= isn't present; it may be false, so check only for nil
+		if case_child.value == nil then
+			helper.wml_error "[case] missing required value= attribute"
+		end
 		local match = false
-		for w in string.gmatch(v.value, "[^%s,][^,]*") do
-			if w == tostring(value) then match = true ; break end
+		for w in string.gmatch(case_child.value, "[^%s,][^,]*") do
+			if w == tostring(variable) then match = true ; break end
 		end
 		if match then
-			handle_event_commands(v)
+			handle_event_commands(case_child)
 			found = true
 		end
 	end
 	-- Otherwise execute [else] statements.
 	if not found then
-		for v in helper.child_range(cfg, "else") do
-			handle_event_commands(v)
+		for else_child in helper.child_range(cfg, "else") do
+			handle_event_commands(else_child)
 		end
 	end
 end

diff --git a/src/storyscreen/controller.cpp b/src/storyscreen/controller.cpp
@@ -75,22 +75,72 @@ void controller::resolve_wml(const vconfig& cfg)
 		}
 		// [if]
 		else if(key == "if") {
-			const std::string branch_label =
-				game_events::conditional_passed(node) ?
-				"then" : "else";
-			if(node.has_child(branch_label)) {
-				const vconfig branch = node.child(branch_label);
-				resolve_wml(branch);
+			// check if the [if] tag has a [then] child;
+			// if not, raise a WML error and exit to make the mistake as much evident as possible
+			// if we try to execute a non-existing [then], we get a segfault
+			if (!node.has_child("then")) {
+				lg::wml_error << "[if] missing required [then] tag\n";
+				return;
+			}
+			else {
+				// condition passed, execute [then]
+				if (game_events::conditional_passed(node)) {
+					resolve_wml(node.child("then"));
+				}
+				// condition not passed, check [elseif] and [else]
+				else {
+					// get all [elseif] children and set a flag
+					vconfig::child_list elseif_children = node.get_children("elseif");
+					bool elseif_flag = false;
+					// for each [elseif]: test if it has a [then] child
+					// if not, raise a WML error and exit
+					// if yes, check condition; if matches, execute [then] and raise flag
+					for (vconfig::child_list::const_iterator elseif = elseif_children.begin(); elseif != elseif_children.end(); ++elseif) {
+						if (!elseif->has_child("then")) {
+							lg::wml_error << "[elseif] missing required [then] tag\n";
+							return;
+						}
+						else {
+							if (game_events::conditional_passed(*elseif)) {
+								resolve_wml(elseif->child("then"));
+								elseif_flag = true;
+								break;
+							}
+						}
+					}
+					// if we have an [else] tag and no [elseif] was successful (flag not raised), execute it
+					if (node.has_child("else") && !elseif_flag) {
+						resolve_wml(node.child("else"));
+					}
+				}
 			}
 		}
 		// [switch]
 		else if(key == "switch") {
+			// raise a WML error and exit if variable= is missing
+			if (!node.has_attribute("variable")) {
+				lg::wml_error << "[switch] missing required variable= attribute\n";
+				return;
+			}
 			const std::string var_name = node["variable"];
 			const std::string var_actual_value = resources::gamedata->get_variable_const(var_name);
 			bool case_not_found = true;
 
+			// check if the [switch] tag has a [case] child;
+			// if not, raise a WML error and exit to make the mistake as much evident as possible
+			if (!node.has_child("case")) {
+				lg::wml_error << "[switch] missing required [case] tag\n";
+				return;
+			}
+
 			for(vconfig::all_children_iterator j = node.ordered_begin(); j != node.ordered_end(); ++j) {
 				if(j->first != "case") continue;
+
+				// raise a WML error and exit if value= is missing
+				if (!(j->second).has_attribute("value")) {
+					lg::wml_error << "[case] missing required value= attribute\n";
+					return;
+				}
 
 				// Enter all matching cases.
 				const std::string var_expected_value = (j->second)["value"];

diff --git a/src/storyscreen/part.cpp b/src/storyscreen/part.cpp
@@ -268,25 +268,76 @@ void part::resolve_wml(const vconfig &cfg)
 		}
 		// [if]
 		else if(key == "if") {
-			const std::string branch_label =
-				game_events::conditional_passed(node) ?
-				"then" : "else";
-			if(node.has_child(branch_label)) {
-				const vconfig branch = node.child(branch_label);
-				resolve_wml(branch);
+			// check if the [if] tag has a [then] child;
+			// if not, raise a WML error and exit to make the mistake as much evident as possible
+			// if we try to execute a non-existing [then], we get a segfault
+			if (!node.has_child("then")) {
+				lg::wml_error << "[if] missing required [then] tag\n";
+				return;
+			}
+			else {
+				// condition passed, execute [then]
+				if (game_events::conditional_passed(node)) {
+					resolve_wml(node.child("then"));
+				}
+				// condition not passed, check [elseif] and [else]
+				else {
+					// get all [elseif] children and set a flag
+					vconfig::child_list elseif_children = node.get_children("elseif");
+					bool elseif_flag = false;
+					// for each [elseif]: test if it has a [then] child
+					// if not, raise a WML error and exit
+					// if yes, check condition; if matches, execute [then] and raise flag
+					for (vconfig::child_list::const_iterator elseif = elseif_children.begin(); elseif != elseif_children.end(); ++elseif) {
+						if (!elseif->has_child("then")) {
+							lg::wml_error << "[elseif] missing required [then] tag\n";
+							return;
+						}
+						else {
+							if (game_events::conditional_passed(*elseif)) {
+								resolve_wml(elseif->child("then"));
+								elseif_flag = true;
+								break;
+							}
+						}
+					}
+					// if we have an [else] tag and no [elseif] was successful (flag not raised), execute it
+					if (node.has_child("else") && !elseif_flag) {
+						resolve_wml(node.child("else"));
+					}
+				}
 			}
 		}
 		// [switch]
 		else if(key == "switch") {
+			// raise a WML error and exit if variable= is missing
+			if (!node.has_attribute("variable")) {
+				lg::wml_error << "[switch] missing required variable= attribute\n";
+				return;
+			}
 			const std::string var_name = node["variable"];
 			const std::string var_actual_value = resources::gamedata->get_variable_const(var_name);
 			bool case_not_found = true;
+
+			// check if the [switch] tag has a [case] child;
+			// if not, raise a WML error and exit to make the mistake as much evident as possible
+			if (!node.has_child("case")) {
+				lg::wml_error << "[switch] missing required [case] tag\n";
+				return;
+			}
 
 			for(vconfig::all_children_iterator j = node.ordered_begin(); j != node.ordered_end(); ++j) {
 				if(j->first != "case") continue;
+
+				// raise a WML error and exit if value= is missing
+				if (!(j->second).has_attribute("value")) {
+					lg::wml_error << "[case] missing required value= attribute\n";
+					return;
+				}
 
 				// Enter all matching cases.
 				const std::string var_expected_value = (j->second)["value"];
+
 			    if(var_actual_value == var_expected_value) {
 					case_not_found = false;
 					resolve_wml(j->second);