From b0860208dab71b9e6490ab2ba00d3aed165ca393 Mon Sep 17 00:00:00 2001
From: "Johnny C. Lam" <jlam88@gmail.com>
Date: Thu, 18 Apr 2013 23:43:41 +0000
Subject: [PATCH] Sanity check that all functions called within the script are
 defined.

Create a new debugging toggle that reports undefined functions to the chat
window when a script is compiled.

git-svn-id: svn://svn.curseforge.net/wow/ovale/mainline/trunk@903 d5049fe3-3747-40f7-a4b5-f36d6801af5f
---
 OvaleCompile.lua |   23 +++++++++++++++++++++++
 OvaleOptions.lua |    6 ++++++
 2 files changed, 29 insertions(+)

diff --git a/OvaleCompile.lua b/OvaleCompile.lua
index 0518114..8455c48 100644
--- a/OvaleCompile.lua
+++ b/OvaleCompile.lua
@@ -43,6 +43,8 @@ local self_pool = OvalePool:NewPool("OvaleCompile_pool")
 local self_defines = {}
 local self_customFunctions = {}
 local self_missingSpellList = {}
+-- table of functions called within the script: self_functionCalls[functionName] = node
+local self_functionCalls = {}
 
 -- Whether to trigger a script compilation if items or stances change.
 local self_compileOnItems = false
@@ -50,7 +52,16 @@ local self_compileOnStances = false
 
 local OVALE_COMPILE_DEBUG = "compile"
 local OVALE_MISSING_SPELL_DEBUG = "missing_spells"
+local OVALE_UNKNOWN_FUNCTION_DEBUG = "unknown_function"
 local OVALE_UNKNOWN_SPELL_DEBUG = "unknown_spells"
+
+-- Known script functions other than conditions.
+local OVALE_FUNCTIONS = {
+	item = true,
+	macro = true,
+	spell = true,
+	texture = true,
+}
 --</private-static-properties>
 
 --<public-static-properties>
@@ -199,6 +210,7 @@ local function ParseFunction(prefix, func, params)
 	end
 	
 	if self_customFunctions[func] then
+		self_functionCalls[func] = self_customFunctions[func]
 		return self_customFunctions[func]
 	end
 	
@@ -222,6 +234,7 @@ local function ParseFunction(prefix, func, params)
 	node.func = func
 	node.params = paramList
 	local nodeName = AddNode(node)
+	self_functionCalls[func] = node
 
 	local mine = true
 	if paramList.any then
@@ -699,6 +712,7 @@ local function CompileScript(text)
 
 	wipe(self_defines)
 	wipe(self_missingSpellList)
+	wipe(self_functionCalls)
 
 	-- Return all existing nodes to the node pool.
 	local node 
@@ -738,6 +752,15 @@ local function CompileScript(text)
 		end
 	end
 
+	-- Verify that all the functions called within the script are defined.
+	-- Not an error if a function is undefined (might be unreachable code), but complain
+	-- at run-time during compilation.
+	for p, v in pairs(self_functionCalls) do
+		if not (OVALE_FUNCTIONS[p] or self_customFunctions[p] or OvaleCondition.conditions[p]) then
+			Ovale:DebugPrintf(OVALE_UNKNOWN_FUNCTION_DEBUG, "Unknown function call: %s (node%s)", p, v.nodeId)
+		end
+	end
+
 	-- Add any missing spells found while compiling the script into the spellbook.
 	for k, v in pairs(self_missingSpellList) do
 		OvaleData.spellList[k] = v
diff --git a/OvaleOptions.lua b/OvaleOptions.lua
index f9f73db..fc49030 100644
--- a/OvaleOptions.lua
+++ b/OvaleOptions.lua
@@ -415,6 +415,12 @@ local self_options =
 							desc = L["Debug missing spells"],
 							type = "toggle",
 						},
+						unknown_function =
+						{
+							name = "Unknown functions",
+							desc = L["Debug unknown functions"],
+							type = "toggle",
+						},
 						unknown_spells =
 						{
 							name = "Unknown spells",
-- 
1.7.9.5