Xiiph@0: --- AceConfigRegistry-3.0 handles central registration of options tables in use by addons and modules.\\
Xiiph@0: -- Options tables can be registered as raw tables, OR as function refs that return a table.\\
Xiiph@0: -- Such functions receive three arguments: "uiType", "uiName", "appName". \\
Xiiph@0: -- * Valid **uiTypes**: "cmd", "dropdown", "dialog". This is verified by the library at call time. \\
Xiiph@0: -- * The **uiName** field is expected to contain the full name of the calling addon, including version, e.g. "FooBar-1.0". This is verified by the library at call time.\\
Xiiph@0: -- * The **appName** field is the options table name as given at registration time \\
Xiiph@0: -- 
Xiiph@0: -- :IterateOptionsTables() (and :GetOptionsTable() if only given one argument) return a function reference that the requesting config handling addon must call with valid "uiType", "uiName".
Xiiph@0: -- @class file
Xiiph@0: -- @name AceConfigRegistry-3.0
Xiiph@0: -- @release $Id: AceConfigRegistry-3.0.lua 921 2010-05-09 15:49:14Z nevcairiel $
Xiiph@0: local MAJOR, MINOR = "AceConfigRegistry-3.0", 12
Xiiph@0: local AceConfigRegistry = LibStub:NewLibrary(MAJOR, MINOR)
Xiiph@0: 
Xiiph@0: if not AceConfigRegistry then return end
Xiiph@0: 
Xiiph@0: AceConfigRegistry.tables = AceConfigRegistry.tables or {}
Xiiph@0: 
Xiiph@0: local CallbackHandler = LibStub:GetLibrary("CallbackHandler-1.0")
Xiiph@0: 
Xiiph@0: if not AceConfigRegistry.callbacks then
Xiiph@0: 	AceConfigRegistry.callbacks = CallbackHandler:New(AceConfigRegistry)
Xiiph@0: end
Xiiph@0: 
Xiiph@0: -- Lua APIs
Xiiph@0: local tinsert, tconcat = table.insert, table.concat
Xiiph@0: local strfind, strmatch = string.find, string.match
Xiiph@0: local type, tostring, select, pairs = type, tostring, select, pairs
Xiiph@0: local error, assert = error, assert
Xiiph@0: 
Xiiph@0: -----------------------------------------------------------------------
Xiiph@0: -- Validating options table consistency:
Xiiph@0: 
Xiiph@0: 
Xiiph@0: AceConfigRegistry.validated = {
Xiiph@0: 	-- list of options table names ran through :ValidateOptionsTable automatically. 
Xiiph@0: 	-- CLEARED ON PURPOSE, since newer versions may have newer validators
Xiiph@0: 	cmd = {},
Xiiph@0: 	dropdown = {},
Xiiph@0: 	dialog = {},
Xiiph@0: }
Xiiph@0: 
Xiiph@0: 
Xiiph@0: 
Xiiph@0: local function err(msg, errlvl, ...)
Xiiph@0: 	local t = {}
Xiiph@0: 	for i=select("#",...),1,-1 do
Xiiph@0: 		tinsert(t, (select(i, ...)))
Xiiph@0: 	end
Xiiph@0: 	error(MAJOR..":ValidateOptionsTable(): "..tconcat(t,".")..msg, errlvl+2)
Xiiph@0: end
Xiiph@0: 
Xiiph@0: 
Xiiph@0: local isstring={["string"]=true, _="string"}
Xiiph@0: local isstringfunc={["string"]=true,["function"]=true, _="string or funcref"}
Xiiph@0: local istable={["table"]=true,   _="table"}
Xiiph@0: local ismethodtable={["table"]=true,["string"]=true,["function"]=true,   _="methodname, funcref or table"}
Xiiph@0: local optstring={["nil"]=true,["string"]=true, _="string"}
Xiiph@0: local optstringfunc={["nil"]=true,["string"]=true,["function"]=true, _="string or funcref"}
Xiiph@0: local optnumber={["nil"]=true,["number"]=true, _="number"}
Xiiph@0: local optmethod={["nil"]=true,["string"]=true,["function"]=true, _="methodname or funcref"}
Xiiph@0: local optmethodfalse={["nil"]=true,["string"]=true,["function"]=true,["boolean"]={[false]=true},  _="methodname, funcref or false"}
Xiiph@0: local optmethodnumber={["nil"]=true,["string"]=true,["function"]=true,["number"]=true,  _="methodname, funcref or number"}
Xiiph@0: local optmethodtable={["nil"]=true,["string"]=true,["function"]=true,["table"]=true,  _="methodname, funcref or table"}
Xiiph@0: local optmethodbool={["nil"]=true,["string"]=true,["function"]=true,["boolean"]=true,  _="methodname, funcref or boolean"}
Xiiph@0: local opttable={["nil"]=true,["table"]=true,  _="table"}
Xiiph@0: local optbool={["nil"]=true,["boolean"]=true,  _="boolean"}
Xiiph@0: local optboolnumber={["nil"]=true,["boolean"]=true,["number"]=true,  _="boolean or number"}
Xiiph@0: 
Xiiph@0: local basekeys={
Xiiph@0: 	type=isstring,
Xiiph@0: 	name=isstringfunc,
Xiiph@0: 	desc=optstringfunc,
Xiiph@0: 	descStyle=optstring,
Xiiph@0: 	order=optmethodnumber,
Xiiph@0: 	validate=optmethodfalse,
Xiiph@0: 	confirm=optmethodbool,
Xiiph@0: 	confirmText=optstring,
Xiiph@0: 	disabled=optmethodbool,
Xiiph@0: 	hidden=optmethodbool,
Xiiph@0: 		guiHidden=optmethodbool,
Xiiph@0: 		dialogHidden=optmethodbool,
Xiiph@0: 		dropdownHidden=optmethodbool,
Xiiph@0: 	cmdHidden=optmethodbool,
Xiiph@0: 	icon=optstringfunc,
Xiiph@0: 	iconCoords=optmethodtable,
Xiiph@0: 	handler=opttable,
Xiiph@0: 	get=optmethodfalse,
Xiiph@0: 	set=optmethodfalse,
Xiiph@0: 	func=optmethodfalse,
Xiiph@0: 	arg={["*"]=true},
Xiiph@0: 	width=optstring,
Xiiph@0: }
Xiiph@0: 
Xiiph@0: local typedkeys={
Xiiph@0: 	header={},
Xiiph@0: 	description={
Xiiph@0: 		image=optstringfunc,
Xiiph@0: 		imageCoords=optmethodtable,
Xiiph@0: 		imageHeight=optnumber,
Xiiph@0: 		imageWidth=optnumber,
Xiiph@0: 		fontSize=optstringfunc,
Xiiph@0: 	},
Xiiph@0: 	group={
Xiiph@0: 		args=istable,
Xiiph@0: 		plugins=opttable,
Xiiph@0: 		inline=optbool,
Xiiph@0: 			cmdInline=optbool,
Xiiph@0: 			guiInline=optbool,
Xiiph@0: 			dropdownInline=optbool,
Xiiph@0: 			dialogInline=optbool,
Xiiph@0: 		childGroups=optstring,
Xiiph@0: 	},
Xiiph@0: 	execute={
Xiiph@0: 		image=optstringfunc,
Xiiph@0: 		imageCoords=optmethodtable,
Xiiph@0: 		imageHeight=optnumber,
Xiiph@0: 		imageWidth=optnumber,
Xiiph@0: 	},
Xiiph@0: 	input={
Xiiph@0: 		pattern=optstring,
Xiiph@0: 		usage=optstring,
Xiiph@0: 		control=optstring,
Xiiph@0: 		dialogControl=optstring,
Xiiph@0: 		dropdownControl=optstring,
Xiiph@0: 		multiline=optboolnumber,
Xiiph@0: 	},
Xiiph@0: 	toggle={
Xiiph@0: 		tristate=optbool,
Xiiph@0: 		image=optstringfunc,
Xiiph@0: 		imageCoords=optmethodtable,
Xiiph@0: 	},
Xiiph@0: 	tristate={
Xiiph@0: 	},
Xiiph@0: 	range={
Xiiph@0: 		min=optnumber,
Xiiph@0: 		softMin=optnumber,
Xiiph@0: 		max=optnumber,
Xiiph@0: 		softMax=optnumber,
Xiiph@0: 		step=optnumber,
Xiiph@0: 		bigStep=optnumber,
Xiiph@0: 		isPercent=optbool,
Xiiph@0: 	},
Xiiph@0: 	select={
Xiiph@0: 		values=ismethodtable,
Xiiph@0: 		style={
Xiiph@0: 			["nil"]=true, 
Xiiph@0: 			["string"]={dropdown=true,radio=true}, 
Xiiph@0: 			_="string: 'dropdown' or 'radio'"
Xiiph@0: 		},
Xiiph@0: 		control=optstring,
Xiiph@0: 		dialogControl=optstring,
Xiiph@0: 		dropdownControl=optstring,
Xiiph@0: 	},
Xiiph@0: 	multiselect={
Xiiph@0: 		values=ismethodtable,
Xiiph@0: 		style=optstring,
Xiiph@0: 		tristate=optbool,
Xiiph@0: 		control=optstring,
Xiiph@0: 		dialogControl=optstring,
Xiiph@0: 		dropdownControl=optstring,
Xiiph@0: 	},
Xiiph@0: 	color={
Xiiph@0: 		hasAlpha=optbool,
Xiiph@0: 	},
Xiiph@0: 	keybinding={
Xiiph@0: 		-- TODO
Xiiph@0: 	},
Xiiph@0: }
Xiiph@0: 
Xiiph@0: local function validateKey(k,errlvl,...)
Xiiph@0: 	errlvl=(errlvl or 0)+1
Xiiph@0: 	if type(k)~="string" then
Xiiph@0: 		err("["..tostring(k).."] - key is not a string", errlvl,...)
Xiiph@0: 	end
Xiiph@0: 	if strfind(k, "[%c\127]") then
Xiiph@0: 		err("["..tostring(k).."] - key name contained control characters", errlvl,...)
Xiiph@0: 	end
Xiiph@0: end
Xiiph@0: 
Xiiph@0: local function validateVal(v, oktypes, errlvl,...)
Xiiph@0: 	errlvl=(errlvl or 0)+1
Xiiph@0: 	local isok=oktypes[type(v)] or oktypes["*"]
Xiiph@0: 
Xiiph@0: 	if not isok then
Xiiph@0: 		err(": expected a "..oktypes._..", got '"..tostring(v).."'", errlvl,...)
Xiiph@0: 	end
Xiiph@0: 	if type(isok)=="table" then		-- isok was a table containing specific values to be tested for!
Xiiph@0: 		if not isok[v] then
Xiiph@0: 			err(": did not expect "..type(v).." value '"..tostring(v).."'", errlvl,...)
Xiiph@0: 		end
Xiiph@0: 	end
Xiiph@0: end
Xiiph@0: 
Xiiph@0: local function validate(options,errlvl,...)
Xiiph@0: 	errlvl=(errlvl or 0)+1
Xiiph@0: 	-- basic consistency
Xiiph@0: 	if type(options)~="table" then
Xiiph@0: 		err(": expected a table, got a "..type(options), errlvl,...)
Xiiph@0: 	end
Xiiph@0: 	if type(options.type)~="string" then
Xiiph@0: 		err(".type: expected a string, got a "..type(options.type), errlvl,...)
Xiiph@0: 	end
Xiiph@0: 	
Xiiph@0: 	-- get type and 'typedkeys' member
Xiiph@0: 	local tk = typedkeys[options.type]
Xiiph@0: 	if not tk then
Xiiph@0: 		err(".type: unknown type '"..options.type.."'", errlvl,...)
Xiiph@0: 	end
Xiiph@0: 	
Xiiph@0: 	-- make sure that all options[] are known parameters
Xiiph@0: 	for k,v in pairs(options) do
Xiiph@0: 		if not (tk[k] or basekeys[k]) then
Xiiph@0: 			err(": unknown parameter", errlvl,tostring(k),...)
Xiiph@0: 		end
Xiiph@0: 	end
Xiiph@0: 
Xiiph@0: 	-- verify that required params are there, and that everything is the right type
Xiiph@0: 	for k,oktypes in pairs(basekeys) do
Xiiph@0: 		validateVal(options[k], oktypes, errlvl,k,...)
Xiiph@0: 	end
Xiiph@0: 	for k,oktypes in pairs(tk) do
Xiiph@0: 		validateVal(options[k], oktypes, errlvl,k,...)
Xiiph@0: 	end
Xiiph@0: 
Xiiph@0: 	-- extra logic for groups
Xiiph@0: 	if options.type=="group" then
Xiiph@0: 		for k,v in pairs(options.args) do
Xiiph@0: 			validateKey(k,errlvl,"args",...)
Xiiph@0: 			validate(v, errlvl,k,"args",...)
Xiiph@0: 		end
Xiiph@0: 		if options.plugins then
Xiiph@0: 			for plugname,plugin in pairs(options.plugins) do
Xiiph@0: 				if type(plugin)~="table" then
Xiiph@0: 					err(": expected a table, got '"..tostring(plugin).."'", errlvl,tostring(plugname),"plugins",...)
Xiiph@0: 				end
Xiiph@0: 				for k,v in pairs(plugin) do
Xiiph@0: 					validateKey(k,errlvl,tostring(plugname),"plugins",...)
Xiiph@0: 					validate(v, errlvl,k,tostring(plugname),"plugins",...)
Xiiph@0: 				end
Xiiph@0: 			end
Xiiph@0: 		end
Xiiph@0: 	end
Xiiph@0: end
Xiiph@0: 
Xiiph@0: 
Xiiph@0: --- Validates basic structure and integrity of an options table \\
Xiiph@0: -- Does NOT verify that get/set etc actually exist, since they can be defined at any depth
Xiiph@0: -- @param options The table to be validated
Xiiph@0: -- @param name The name of the table to be validated (shown in any error message)
Xiiph@0: -- @param errlvl (optional number) error level offset, default 0 (=errors point to the function calling :ValidateOptionsTable)
Xiiph@0: function AceConfigRegistry:ValidateOptionsTable(options,name,errlvl)
Xiiph@0: 	errlvl=(errlvl or 0)+1
Xiiph@0: 	name = name or "Optionstable"
Xiiph@0: 	if not options.name then
Xiiph@0: 		options.name=name	-- bit of a hack, the root level doesn't really need a .name :-/
Xiiph@0: 	end
Xiiph@0: 	validate(options,errlvl,name)
Xiiph@0: end
Xiiph@0: 
Xiiph@0: --- Fires a "ConfigTableChange" callback for those listening in on it, allowing config GUIs to refresh.
Xiiph@0: -- You should call this function if your options table changed from any outside event, like a game event
Xiiph@0: -- or a timer.
Xiiph@0: -- @param appName The application name as given to `:RegisterOptionsTable()`
Xiiph@0: function AceConfigRegistry:NotifyChange(appName)
Xiiph@0: 	if not AceConfigRegistry.tables[appName] then return end
Xiiph@0: 	AceConfigRegistry.callbacks:Fire("ConfigTableChange", appName)
Xiiph@0: end
Xiiph@0: 
Xiiph@0: -- -------------------------------------------------------------------
Xiiph@0: -- Registering and retreiving options tables:
Xiiph@0: 
Xiiph@0: 
Xiiph@0: -- validateGetterArgs: helper function for :GetOptionsTable (or, rather, the getter functions returned by it)
Xiiph@0: 
Xiiph@0: local function validateGetterArgs(uiType, uiName, errlvl)
Xiiph@0: 	errlvl=(errlvl or 0)+2
Xiiph@0: 	if uiType~="cmd" and uiType~="dropdown" and uiType~="dialog" then
Xiiph@0: 		error(MAJOR..": Requesting options table: 'uiType' - invalid configuration UI type, expected 'cmd', 'dropdown' or 'dialog'", errlvl)
Xiiph@0: 	end
Xiiph@0: 	if not strmatch(uiName, "[A-Za-z]%-[0-9]") then	-- Expecting e.g. "MyLib-1.2"
Xiiph@0: 		error(MAJOR..": Requesting options table: 'uiName' - badly formatted or missing version number. Expected e.g. 'MyLib-1.2'", errlvl)
Xiiph@0: 	end
Xiiph@0: end
Xiiph@0: 
Xiiph@0: --- Register an options table with the config registry.
Xiiph@0: -- @param appName The application name as given to `:RegisterOptionsTable()`
Xiiph@0: -- @param options The options table, OR a function reference that generates it on demand. \\
Xiiph@0: -- See the top of the page for info on arguments passed to such functions.
Xiiph@0: function AceConfigRegistry:RegisterOptionsTable(appName, options)
Xiiph@0: 	if type(options)=="table" then
Xiiph@0: 		if options.type~="group" then	-- quick sanity checker
Xiiph@0: 			error(MAJOR..": RegisterOptionsTable(appName, options): 'options' - missing type='group' member in root group", 2)
Xiiph@0: 		end
Xiiph@0: 		AceConfigRegistry.tables[appName] = function(uiType, uiName, errlvl)
Xiiph@0: 			errlvl=(errlvl or 0)+1
Xiiph@0: 			validateGetterArgs(uiType, uiName, errlvl)
Xiiph@0: 			if not AceConfigRegistry.validated[uiType][appName] then
Xiiph@0: 				AceConfigRegistry:ValidateOptionsTable(options, appName, errlvl)	-- upgradable
Xiiph@0: 				AceConfigRegistry.validated[uiType][appName] = true
Xiiph@0: 			end
Xiiph@0: 			return options 
Xiiph@0: 		end
Xiiph@0: 	elseif type(options)=="function" then
Xiiph@0: 		AceConfigRegistry.tables[appName] = function(uiType, uiName, errlvl)
Xiiph@0: 			errlvl=(errlvl or 0)+1
Xiiph@0: 			validateGetterArgs(uiType, uiName, errlvl)
Xiiph@0: 			local tab = assert(options(uiType, uiName, appName))
Xiiph@0: 			if not AceConfigRegistry.validated[uiType][appName] then
Xiiph@0: 				AceConfigRegistry:ValidateOptionsTable(tab, appName, errlvl)	-- upgradable
Xiiph@0: 				AceConfigRegistry.validated[uiType][appName] = true
Xiiph@0: 			end
Xiiph@0: 			return tab
Xiiph@0: 		end
Xiiph@0: 	else
Xiiph@0: 		error(MAJOR..": RegisterOptionsTable(appName, options): 'options' - expected table or function reference", 2)
Xiiph@0: 	end
Xiiph@0: end
Xiiph@0: 
Xiiph@0: --- Returns an iterator of ["appName"]=funcref pairs
Xiiph@0: function AceConfigRegistry:IterateOptionsTables()
Xiiph@0: 	return pairs(AceConfigRegistry.tables)
Xiiph@0: end
Xiiph@0: 
Xiiph@0: 
Xiiph@0: 
Xiiph@0: 
Xiiph@0: --- Query the registry for a specific options table.
Xiiph@0: -- If only appName is given, a function is returned which you
Xiiph@0: -- can call with (uiType,uiName) to get the table.\\
Xiiph@0: -- If uiType&uiName are given, the table is returned.
Xiiph@0: -- @param appName The application name as given to `:RegisterOptionsTable()`
Xiiph@0: -- @param uiType The type of UI to get the table for, one of "cmd", "dropdown", "dialog"
Xiiph@0: -- @param uiName The name of the library/addon querying for the table, e.g. "MyLib-1.0"
Xiiph@0: function AceConfigRegistry:GetOptionsTable(appName, uiType, uiName)
Xiiph@0: 	local f = AceConfigRegistry.tables[appName]
Xiiph@0: 	if not f then
Xiiph@0: 		return nil
Xiiph@0: 	end
Xiiph@0: 	
Xiiph@0: 	if uiType then
Xiiph@0: 		return f(uiType,uiName,1)	-- get the table for us
Xiiph@0: 	else
Xiiph@0: 		return f	-- return the function
Xiiph@0: 	end
Xiiph@0: end