diff --git a/.pkgmeta b/.pkgmeta index 94a1c0a..3329965 100644 --- a/.pkgmeta +++ b/.pkgmeta @@ -4,7 +4,9 @@ enable-nolib-creation: no ignore: # Files and directories beginning with a dot (such as .git) are automatically ignored, as is the pgkmeta file itself. - README.md -tools-used: - - libdatabroker-1-1 - - libstub - - callbackhandler +externals: + Libs/AceConfig-3.0: https://repos.wowace.com/wow/ace3/trunk/AceConfig-3.0 + Libs/CallbackHandler-1.0: https://repos.wowace.com/wow/callbackhandler/trunk/CallbackHandler-1.0 + Libs/LibDataBroker-1.1: https://repos.wowace.com/wow/libdatabroker-1-1 + Libs/LibDBIcon-1.0: https://repos.wowace.com/wow/libdbicon-1-0/trunk + Libs/LibStub: https://repos.wowace.com/wow/libstub/trunk diff --git a/Broker_RaidMakeup.lua b/Broker_RaidMakeup.lua index 8215e47..330ffaf 100644 --- a/Broker_RaidMakeup.lua +++ b/Broker_RaidMakeup.lua @@ -39,6 +39,53 @@ BRM.Frame, BRM.Events = CreateFrame("Frame"), {} --######################################### +--# Slash command options and settings +--######################################### + +BRM.OptionsTable = { + type = "group", + args = { + showcounts = { + name = "Show counts in tooltip", + desc = "Show the role counts in the tooltip as well as in the broker display", + type = "toggle", + set = function(info,val) BRM.DB.ShowCountInTooltip = val end, + get = function(info) return BRM.DB.ShowCountInTooltip end, + descStyle = "inline", + width = "full", + }, + minimapicon = { + name = "Show minimap icon", + desc = "Show a minimap icon for " .. BRM.USER_ADDON_NAME, + type = "toggle", + set = function(info,val) BRM:SetMinimapButton(val) end, + get = function(info) return (not BRM.DB.MinimapSettings.hide) end, + descStyle = "inline", + width = "full", + }, -- minimapicon + debug = { + name = "Enable debug output", + desc = "Prints extensive debugging output about everything " .. BRM.USER_ADDON_NAME .. " does", + type = "toggle", + set = function(info,val) BRM:SetDebugMode(val) end, + get = function(info) return BRM.DebugMode end, + descStyle = "inline", + width = "full", + hidden = true, + }, -- debug + } -- args +} -- BRM.OptionsTable + + +-- Process the options and create the AceConfig options table +BRM.AceConfig = LibStub("AceConfig-3.0") +BRM.AceConfig:RegisterOptionsTable(BRM.ADDON_NAME, BRM.OptionsTable, {"brm"}) + +-- Create the frame to set the options and add it to the Blizzard settings +BRM.ConfigFrame = LibStub("AceConfigDialog-3.0"):AddToBlizOptions(BRM.ADDON_NAME, BRM.USER_ADDON_NAME) + + +--######################################### --# Debugging setup --######################################### @@ -109,6 +156,13 @@ function BRM:DumpTable(tab, indent) end -- BRM:DumpTable() +-- Sets the debug mode and writes the setting to the DB +function BRM:SetDebugMode(setting) + BRM.DebugMode = setting + BRM.DB.DebugMode = setting +end + + --######################################### --# Icon class setup --######################################### @@ -263,40 +317,6 @@ BRM.FACTION_HORDE = "Horde" BRM.Version = "@project-version@" ---@alpha@ ---######################################### ---# Slash command handling - only for testing ---######################################### - -SLASH_BRM1 = "/brm" -SlashCmdList.BRM = function (...) BRM:HandleCommandLine(...) end - -function BRM:HandleCommandLine(arg1, arg2) - BRM:DebugPrint("Slash arg1 is " .. arg1) - if "debug" == string.lower(arg1) then - BRM.DebugMode = not BRM.DebugMode - BRM.DB.DebugMode = BRM.DebugMode - BRM:ChatPrint("Printing debug statements is now " .. (BRM.DebugMode and "on" or "off") .. ".") - elseif "mm" == string.lower(arg1) then - BRM:DebugPrint("Initial BRM.DB.MinimapSettings.hide state is " .. (BRM.DB.MinimapSettings.hide and "true" or "false")) - - if BRM.DB.MinimapSettings.hide then - -- turn on minimap icon - BRM:DebugPrint("Turning on minimap icon") - BRM.DB.MinimapSettings.hide = false - BRM:ShowMinimapButton() - else - -- turn off minimap icon - BRM:DebugPrint("Turning off minimap icon") - BRM.DB.MinimapSettings.hide = true - BRM:HideMinimapButton() - end - end - -end ---@end-alpha@ - - --######################################### --# Variables for tracking raid members --######################################### @@ -342,7 +362,7 @@ function BRM:IncrementRole(role) end BRM.TotalCount = BRM.TotalCount + 1 -end +end -- BRM:IncrementRole() function BRM:UpdateComposition() @@ -489,8 +509,38 @@ BRM.LDO = _G.LibStub("LibDataBroker-1.1"):NewDataObject(BRM.ADDON_NAME, { return end BRM:DebugPrint("Showing tooltip") + + -- delete existing lines + tooltip:ClearLines() + + -- headline tooltip:AddLine(BRM.USER_ADDON_NAME) + + -- If the user wants the counts in the tooltip, add them. + if BRM.DB.ShowCountInTooltip then + BRM:DebugPrint("Preparing tooltip") + + local DisplayString = "" + + -- faction handling + if BRM.FACTION_HORDE == BRM.Faction then + DisplayString = BRM.HordeIcon:GetIconString() + elseif BRM.FACTION_ALLIANCE == BRM.Faction then + DisplayString = BRM.AllianceIcon:GetIconString() + else + -- What the hell? + BRM:DebugPrint("Unknown faction detected - " .. BRM.Faction) + DisplayString = BRM.MainIcon:GetIconString() + end + + DisplayString = DisplayString .. BRM:GetDisplayString() + + tooltip:AddLine(DisplayString) + end + + -- Add instructions tooltip:AddLine("Click to refresh") + tooltip:AddLine("Right click for options") end, }) -- BRM.LDO creation @@ -504,6 +554,12 @@ function BRM.LDO:OnClick(button) BRM:RefreshCounts() elseif button == "RightButton" then BRM:DebugPrint("Got right button") + -- toggle showing the count + InterfaceOptionsFrame_OpenToCategory(BRM.ConfigFrame) + InterfaceOptionsFrame_OpenToCategory(BRM.ConfigFrame) + -- Yes, this should be here twice. Workaround for a Blizzard bug. + -- When you first open the options panel, it opens to the Game control tab, not the Addons control tab. + -- Calling this twice bypasses that. else BRM:DebugPrint("Got some other button") end @@ -537,6 +593,15 @@ function BRM:HideMinimapButton() BRM.MinimapIcon:Hide(BRM.ADDON_NAME) end -- BRM:HideMinimapButton() +-- This function is for calling from the options panel. Pass in true to show the icon, false to hide it (which matches the values of the checkbox in the config panel) +function BRM:SetMinimapButton(state) + if true == state then + BRM:ShowMinimapButton() + else + BRM:HideMinimapButton() + end +end -- BRM:SetMinimapButton() + --######################################### --# Load saved settings @@ -552,6 +617,7 @@ function BRM.LoadSettings() -- These situations should only occur during development or upgrade situations if not BRM.DB.MinimapSettings then BRM.DB.MinimapSettings = {} end + if not BRM.DB.ShowCountInTooltip then BRM.DB.ShowCountInTooltip = false end if not BRM.DB.DebugMode then BRM.DB.DebugMode = false end else -- Initialize settings on first use @@ -559,6 +625,7 @@ function BRM.LoadSettings() BRM.DB = {} BRM.DB.Version = 1 BRM.DB.MinimapSettings = {} + BRM.DB.ShowCountInTooltip = false BRM.DB.DebugMode = false end @@ -592,11 +659,10 @@ function BRM.Events:ADDON_LOADED(addon) -- Minimap button for LDB object BRM:CreateMinimapButton() - - -- Creating the minimap icon requires somewhere to save the data. - -- We don't load that until this event. - -- So, this is the earliest point we can create the minimap icon. - -- Note that initial state of whether to display the icon is handled auto-magically by the LDBIcon library, based on the variable storage you pass it. + -- Creating the minimap icon requires somewhere to save the data - namely, the addon DB. + -- We don't load that until this event. + -- So, this is the earliest point we can create the minimap icon. + -- Note that initial state of whether to display the icon is handled auto-magically by the LDBIcon library, based on the variable storage you pass it. end -- BRM.Events:ADDON_LOADED() @@ -626,6 +692,7 @@ function BRM.Events:PLAYER_ENTERING_WORLD(...) BRM:UpdateComposition() -- Get the main app icon based on the player's faction + BRM:DebugPrint("Determining faction") BRM.Faction, _ = UnitFactionGroup("player") if not BRM.Faction then diff --git a/Libs/AceConfig-3.0/AceConfig-3.0.lua b/Libs/AceConfig-3.0/AceConfig-3.0.lua new file mode 100644 index 0000000..c2ac7cc --- /dev/null +++ b/Libs/AceConfig-3.0/AceConfig-3.0.lua @@ -0,0 +1,58 @@ +--- AceConfig-3.0 wrapper library. +-- Provides an API to register an options table with the config registry, +-- as well as associate it with a slash command. +-- @class file +-- @name AceConfig-3.0 +-- @release $Id: AceConfig-3.0.lua 1161 2017-08-12 14:30:16Z funkydude $ + +--[[ +AceConfig-3.0 + +Very light wrapper library that combines all the AceConfig subcomponents into one more easily used whole. + +]] + +local cfgreg = LibStub("AceConfigRegistry-3.0") +local cfgcmd = LibStub("AceConfigCmd-3.0") + +local MAJOR, MINOR = "AceConfig-3.0", 3 +local AceConfig = LibStub:NewLibrary(MAJOR, MINOR) + +if not AceConfig then return end + +--TODO: local cfgdlg = LibStub("AceConfigDialog-3.0", true) +--TODO: local cfgdrp = LibStub("AceConfigDropdown-3.0", true) + +-- Lua APIs +local pcall, error, type, pairs = pcall, error, type, pairs + +-- ------------------------------------------------------------------- +-- :RegisterOptionsTable(appName, options, slashcmd, persist) +-- +-- - appName - (string) application name +-- - options - table or function ref, see AceConfigRegistry +-- - slashcmd - slash command (string) or table with commands, or nil to NOT create a slash command + +--- Register a option table with the AceConfig registry. +-- You can supply a slash command (or a table of slash commands) to register with AceConfigCmd directly. +-- @paramsig appName, options [, slashcmd] +-- @param appName The application name for the config table. +-- @param options The option table (or a function to generate one on demand). http://www.wowace.com/addons/ace3/pages/ace-config-3-0-options-tables/ +-- @param slashcmd A slash command to register for the option table, or a table of slash commands. +-- @usage +-- local AceConfig = LibStub("AceConfig-3.0") +-- AceConfig:RegisterOptionsTable("MyAddon", myOptions, {"/myslash", "/my"}) +function AceConfig:RegisterOptionsTable(appName, options, slashcmd) + local ok,msg = pcall(cfgreg.RegisterOptionsTable, self, appName, options) + if not ok then error(msg, 2) end + + if slashcmd then + if type(slashcmd) == "table" then + for _,cmd in pairs(slashcmd) do + cfgcmd:CreateChatCommand(cmd, appName) + end + else + cfgcmd:CreateChatCommand(slashcmd, appName) + end + end +end diff --git a/Libs/AceConfig-3.0/AceConfig-3.0.xml b/Libs/AceConfig-3.0/AceConfig-3.0.xml new file mode 100644 index 0000000..84c8d03 --- /dev/null +++ b/Libs/AceConfig-3.0/AceConfig-3.0.xml @@ -0,0 +1,8 @@ +<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/ +..\FrameXML\UI.xsd"> + <Include file="AceConfigRegistry-3.0\AceConfigRegistry-3.0.xml"/> + <Include file="AceConfigCmd-3.0\AceConfigCmd-3.0.xml"/> + <Include file="AceConfigDialog-3.0\AceConfigDialog-3.0.xml"/> + <!--<Include file="AceConfigDropdown-3.0\AceConfigDropdown-3.0.xml"/>--> + <Script file="AceConfig-3.0.lua"/> +</Ui> diff --git a/Libs/AceConfig-3.0/AceConfigCmd-3.0/AceConfigCmd-3.0.lua b/Libs/AceConfig-3.0/AceConfigCmd-3.0/AceConfigCmd-3.0.lua new file mode 100644 index 0000000..7902fd1 --- /dev/null +++ b/Libs/AceConfig-3.0/AceConfigCmd-3.0/AceConfigCmd-3.0.lua @@ -0,0 +1,794 @@ +--- AceConfigCmd-3.0 handles access to an options table through the "command line" interface via the ChatFrames. +-- @class file +-- @name AceConfigCmd-3.0 +-- @release $Id: AceConfigCmd-3.0.lua 1161 2017-08-12 14:30:16Z funkydude $ + +--[[ +AceConfigCmd-3.0 + +Handles commandline optionstable access + +REQUIRES: AceConsole-3.0 for command registration (loaded on demand) + +]] + +-- TODO: plugin args + +local cfgreg = LibStub("AceConfigRegistry-3.0") + +local MAJOR, MINOR = "AceConfigCmd-3.0", 14 +local AceConfigCmd = LibStub:NewLibrary(MAJOR, MINOR) + +if not AceConfigCmd then return end + +AceConfigCmd.commands = AceConfigCmd.commands or {} +local commands = AceConfigCmd.commands + +local AceConsole -- LoD +local AceConsoleName = "AceConsole-3.0" + +-- Lua APIs +local strsub, strsplit, strlower, strmatch, strtrim = string.sub, string.split, string.lower, string.match, string.trim +local format, tonumber, tostring = string.format, tonumber, tostring +local tsort, tinsert = table.sort, table.insert +local select, pairs, next, type = select, pairs, next, type +local error, assert = error, assert + +-- WoW APIs +local _G = _G + +-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded +-- List them here for Mikk's FindGlobals script +-- GLOBALS: LibStub, SELECTED_CHAT_FRAME, DEFAULT_CHAT_FRAME + + +local L = setmetatable({}, { -- TODO: replace with proper locale + __index = function(self,k) return k end +}) + + + +local function print(msg) + (SELECTED_CHAT_FRAME or DEFAULT_CHAT_FRAME):AddMessage(msg) +end + +-- constants used by getparam() calls below + +local handlertypes = {["table"]=true} +local handlermsg = "expected a table" + +local functypes = {["function"]=true, ["string"]=true} +local funcmsg = "expected function or member name" + + +-- pickfirstset() - picks the first non-nil value and returns it + +local function pickfirstset(...) + for i=1,select("#",...) do + if select(i,...)~=nil then + return select(i,...) + end + end +end + + +-- err() - produce real error() regarding malformed options tables etc + +local function err(info,inputpos,msg ) + local cmdstr=" "..strsub(info.input, 1, inputpos-1) + error(MAJOR..": /" ..info[0] ..cmdstr ..": "..(msg or "malformed options table"), 2) +end + + +-- usererr() - produce chatframe message regarding bad slash syntax etc + +local function usererr(info,inputpos,msg ) + local cmdstr=strsub(info.input, 1, inputpos-1); + print("/" ..info[0] .. " "..cmdstr ..": "..(msg or "malformed options table")) +end + + +-- callmethod() - call a given named method (e.g. "get", "set") with given arguments + +local function callmethod(info, inputpos, tab, methodtype, ...) + local method = info[methodtype] + if not method then + err(info, inputpos, "'"..methodtype.."': not set") + end + + info.arg = tab.arg + info.option = tab + info.type = tab.type + + if type(method)=="function" then + return method(info, ...) + elseif type(method)=="string" then + if type(info.handler[method])~="function" then + err(info, inputpos, "'"..methodtype.."': '"..method.."' is not a member function of "..tostring(info.handler)) + end + return info.handler[method](info.handler, info, ...) + else + assert(false) -- type should have already been checked on read + end +end + +-- callfunction() - call a given named function (e.g. "name", "desc") with given arguments + +local function callfunction(info, tab, methodtype, ...) + local method = tab[methodtype] + + info.arg = tab.arg + info.option = tab + info.type = tab.type + + if type(method)=="function" then + return method(info, ...) + else + assert(false) -- type should have already been checked on read + end +end + +-- do_final() - do the final step (set/execute) along with validation and confirmation + +local function do_final(info, inputpos, tab, methodtype, ...) + if info.validate then + local res = callmethod(info,inputpos,tab,"validate",...) + if type(res)=="string" then + usererr(info, inputpos, "'"..strsub(info.input, inputpos).."' - "..res) + return + end + end + -- console ignores .confirm + + callmethod(info,inputpos,tab,methodtype, ...) +end + + +-- getparam() - used by handle() to retreive and store "handler", "get", "set", etc + +local function getparam(info, inputpos, tab, depth, paramname, types, errormsg) + local old,oldat = info[paramname], info[paramname.."_at"] + local val=tab[paramname] + if val~=nil then + if val==false then + val=nil + elseif not types[type(val)] then + err(info, inputpos, "'" .. paramname.. "' - "..errormsg) + end + info[paramname] = val + info[paramname.."_at"] = depth + end + return old,oldat +end + + +-- iterateargs(tab) - custom iterator that iterates both t.args and t.plugins.* +local dummytable={} + +local function iterateargs(tab) + if not tab.plugins then + return pairs(tab.args) + end + + local argtabkey,argtab=next(tab.plugins) + local v + + return function(_, k) + while argtab do + k,v = next(argtab, k) + if k then return k,v end + if argtab==tab.args then + argtab=nil + else + argtabkey,argtab = next(tab.plugins, argtabkey) + if not argtabkey then + argtab=tab.args + end + end + end + end +end + +local function checkhidden(info, inputpos, tab) + if tab.cmdHidden~=nil then + return tab.cmdHidden + end + local hidden = tab.hidden + if type(hidden) == "function" or type(hidden) == "string" then + info.hidden = hidden + hidden = callmethod(info, inputpos, tab, 'hidden') + info.hidden = nil + end + return hidden +end + +local function showhelp(info, inputpos, tab, depth, noHead) + if not noHead then + print("|cff33ff99"..info.appName.."|r: Arguments to |cffffff78/"..info[0].."|r "..strsub(info.input,1,inputpos-1)..":") + end + + local sortTbl = {} -- [1..n]=name + local refTbl = {} -- [name]=tableref + + for k,v in iterateargs(tab) do + if not refTbl[k] then -- a plugin overriding something in .args + tinsert(sortTbl, k) + refTbl[k] = v + end + end + + tsort(sortTbl, function(one, two) + local o1 = refTbl[one].order or 100 + local o2 = refTbl[two].order or 100 + if type(o1) == "function" or type(o1) == "string" then + info.order = o1 + info[#info+1] = one + o1 = callmethod(info, inputpos, refTbl[one], "order") + info[#info] = nil + info.order = nil + end + if type(o2) == "function" or type(o1) == "string" then + info.order = o2 + info[#info+1] = two + o2 = callmethod(info, inputpos, refTbl[two], "order") + info[#info] = nil + info.order = nil + end + if o1<0 and o2<0 then return o1<o2 end + if o2<0 then return true end + if o1<0 then return false end + if o1==o2 then return tostring(one)<tostring(two) end -- compare names + return o1<o2 + end) + + for i = 1, #sortTbl do + local k = sortTbl[i] + local v = refTbl[k] + if not checkhidden(info, inputpos, v) then + if v.type ~= "description" and v.type ~= "header" then + -- recursively show all inline groups + local name, desc = v.name, v.desc + if type(name) == "function" then + name = callfunction(info, v, 'name') + end + if type(desc) == "function" then + desc = callfunction(info, v, 'desc') + end + if v.type == "group" and pickfirstset(v.cmdInline, v.inline, false) then + print(" "..(desc or name)..":") + local oldhandler,oldhandler_at = getparam(info, inputpos, v, depth, "handler", handlertypes, handlermsg) + showhelp(info, inputpos, v, depth, true) + info.handler,info.handler_at = oldhandler,oldhandler_at + else + local key = k:gsub(" ", "_") + print(" |cffffff78"..key.."|r - "..(desc or name or "")) + end + end + end + end +end + + +local function keybindingValidateFunc(text) + if text == nil or text == "NONE" then + return nil + end + text = text:upper() + local shift, ctrl, alt + local modifier + while true do + if text == "-" then + break + end + modifier, text = strsplit('-', text, 2) + if text then + if modifier ~= "SHIFT" and modifier ~= "CTRL" and modifier ~= "ALT" then + return false + end + if modifier == "SHIFT" then + if shift then + return false + end + shift = true + end + if modifier == "CTRL" then + if ctrl then + return false + end + ctrl = true + end + if modifier == "ALT" then + if alt then + return false + end + alt = true + end + else + text = modifier + break + end + end + if text == "" then + return false + end + if not text:find("^F%d+$") and text ~= "CAPSLOCK" and text:len() ~= 1 and (text:byte() < 128 or text:len() > 4) and not _G["KEY_" .. text] then + return false + end + local s = text + if shift then + s = "SHIFT-" .. s + end + if ctrl then + s = "CTRL-" .. s + end + if alt then + s = "ALT-" .. s + end + return s +end + +-- handle() - selfrecursing function that processes input->optiontable +-- - depth - starts at 0 +-- - retfalse - return false rather than produce error if a match is not found (used by inlined groups) + +local function handle(info, inputpos, tab, depth, retfalse) + + if not(type(tab)=="table" and type(tab.type)=="string") then err(info,inputpos) end + + ------------------------------------------------------------------- + -- Grab hold of handler,set,get,func,etc if set (and remember old ones) + -- Note that we do NOT validate if method names are correct at this stage, + -- the handler may change before they're actually used! + + local oldhandler,oldhandler_at = getparam(info,inputpos,tab,depth,"handler",handlertypes,handlermsg) + local oldset,oldset_at = getparam(info,inputpos,tab,depth,"set",functypes,funcmsg) + local oldget,oldget_at = getparam(info,inputpos,tab,depth,"get",functypes,funcmsg) + local oldfunc,oldfunc_at = getparam(info,inputpos,tab,depth,"func",functypes,funcmsg) + local oldvalidate,oldvalidate_at = getparam(info,inputpos,tab,depth,"validate",functypes,funcmsg) + --local oldconfirm,oldconfirm_at = getparam(info,inputpos,tab,depth,"confirm",functypes,funcmsg) + + ------------------------------------------------------------------- + -- Act according to .type of this table + + if tab.type=="group" then + ------------ group -------------------------------------------- + + if type(tab.args)~="table" then err(info, inputpos) end + if tab.plugins and type(tab.plugins)~="table" then err(info,inputpos) end + + -- grab next arg from input + local _,nextpos,arg = (info.input):find(" *([^ ]+) *", inputpos) + if not arg then + showhelp(info, inputpos, tab, depth) + return + end + nextpos=nextpos+1 + + -- loop .args and try to find a key with a matching name + for k,v in iterateargs(tab) do + if not(type(k)=="string" and type(v)=="table" and type(v.type)=="string") then err(info,inputpos, "options table child '"..tostring(k).."' is malformed") end + + -- is this child an inline group? if so, traverse into it + if v.type=="group" and pickfirstset(v.cmdInline, v.inline, false) then + info[depth+1] = k + if handle(info, inputpos, v, depth+1, true)==false then + info[depth+1] = nil + -- wasn't found in there, but that's ok, we just keep looking down here + else + return -- done, name was found in inline group + end + -- matching name and not a inline group + elseif strlower(arg)==strlower(k:gsub(" ", "_")) then + info[depth+1] = k + return handle(info,nextpos,v,depth+1) + end + end + + -- no match + if retfalse then + -- restore old infotable members and return false to indicate failure + info.handler,info.handler_at = oldhandler,oldhandler_at + info.set,info.set_at = oldset,oldset_at + info.get,info.get_at = oldget,oldget_at + info.func,info.func_at = oldfunc,oldfunc_at + info.validate,info.validate_at = oldvalidate,oldvalidate_at + --info.confirm,info.confirm_at = oldconfirm,oldconfirm_at + return false + end + + -- couldn't find the command, display error + usererr(info, inputpos, "'"..arg.."' - " .. L["unknown argument"]) + return + end + + local str = strsub(info.input,inputpos); + + if tab.type=="execute" then + ------------ execute -------------------------------------------- + do_final(info, inputpos, tab, "func") + + + + elseif tab.type=="input" then + ------------ input -------------------------------------------- + + local res = true + if tab.pattern then + if not(type(tab.pattern)=="string") then err(info, inputpos, "'pattern' - expected a string") end + if not strmatch(str, tab.pattern) then + usererr(info, inputpos, "'"..str.."' - " .. L["invalid input"]) + return + end + end + + do_final(info, inputpos, tab, "set", str) + + + + elseif tab.type=="toggle" then + ------------ toggle -------------------------------------------- + local b + local str = strtrim(strlower(str)) + if str=="" then + b = callmethod(info, inputpos, tab, "get") + + if tab.tristate then + --cycle in true, nil, false order + if b then + b = nil + elseif b == nil then + b = false + else + b = true + end + else + b = not b + end + + elseif str==L["on"] then + b = true + elseif str==L["off"] then + b = false + elseif tab.tristate and str==L["default"] then + b = nil + else + if tab.tristate then + usererr(info, inputpos, format(L["'%s' - expected 'on', 'off' or 'default', or no argument to toggle."], str)) + else + usererr(info, inputpos, format(L["'%s' - expected 'on' or 'off', or no argument to toggle."], str)) + end + return + end + + do_final(info, inputpos, tab, "set", b) + + + elseif tab.type=="range" then + ------------ range -------------------------------------------- + local val = tonumber(str) + if not val then + usererr(info, inputpos, "'"..str.."' - "..L["expected number"]) + return + end + if type(info.step)=="number" then + val = val- (val % info.step) + end + if type(info.min)=="number" and val<info.min then + usererr(info, inputpos, val.." - "..format(L["must be equal to or higher than %s"], tostring(info.min)) ) + return + end + if type(info.max)=="number" and val>info.max then + usererr(info, inputpos, val.." - "..format(L["must be equal to or lower than %s"], tostring(info.max)) ) + return + end + + do_final(info, inputpos, tab, "set", val) + + + elseif tab.type=="select" then + ------------ select ------------------------------------ + local str = strtrim(strlower(str)) + + local values = tab.values + if type(values) == "function" or type(values) == "string" then + info.values = values + values = callmethod(info, inputpos, tab, "values") + info.values = nil + end + + if str == "" then + local b = callmethod(info, inputpos, tab, "get") + local fmt = "|cffffff78- [%s]|r %s" + local fmt_sel = "|cffffff78- [%s]|r %s |cffff0000*|r" + print(L["Options for |cffffff78"..info[#info].."|r:"]) + for k, v in pairs(values) do + if b == k then + print(fmt_sel:format(k, v)) + else + print(fmt:format(k, v)) + end + end + return + end + + local ok + for k,v in pairs(values) do + if strlower(k)==str then + str = k -- overwrite with key (in case of case mismatches) + ok = true + break + end + end + if not ok then + usererr(info, inputpos, "'"..str.."' - "..L["unknown selection"]) + return + end + + do_final(info, inputpos, tab, "set", str) + + elseif tab.type=="multiselect" then + ------------ multiselect ------------------------------------------- + local str = strtrim(strlower(str)) + + local values = tab.values + if type(values) == "function" or type(values) == "string" then + info.values = values + values = callmethod(info, inputpos, tab, "values") + info.values = nil + end + + if str == "" then + local fmt = "|cffffff78- [%s]|r %s" + local fmt_sel = "|cffffff78- [%s]|r %s |cffff0000*|r" + print(L["Options for |cffffff78"..info[#info].."|r (multiple possible):"]) + for k, v in pairs(values) do + if callmethod(info, inputpos, tab, "get", k) then + print(fmt_sel:format(k, v)) + else + print(fmt:format(k, v)) + end + end + return + end + + --build a table of the selections, checking that they exist + --parse for =on =off =default in the process + --table will be key = true for options that should toggle, key = [on|off|default] for options to be set + local sels = {} + for v in str:gmatch("[^ ]+") do + --parse option=on etc + local opt, val = v:match('(.+)=(.+)') + --get option if toggling + if not opt then + opt = v + end + + --check that the opt is valid + local ok + for k,v in pairs(values) do + if strlower(k)==opt then + opt = k -- overwrite with key (in case of case mismatches) + ok = true + break + end + end + + if not ok then + usererr(info, inputpos, "'"..opt.."' - "..L["unknown selection"]) + return + end + + --check that if val was supplied it is valid + if val then + if val == L["on"] or val == L["off"] or (tab.tristate and val == L["default"]) then + --val is valid insert it + sels[opt] = val + else + if tab.tristate then + usererr(info, inputpos, format(L["'%s' '%s' - expected 'on', 'off' or 'default', or no argument to toggle."], v, val)) + else + usererr(info, inputpos, format(L["'%s' '%s' - expected 'on' or 'off', or no argument to toggle."], v, val)) + end + return + end + else + -- no val supplied, toggle + sels[opt] = true + end + end + + for opt, val in pairs(sels) do + local newval + + if (val == true) then + --toggle the option + local b = callmethod(info, inputpos, tab, "get", opt) + + if tab.tristate then + --cycle in true, nil, false order + if b then + b = nil + elseif b == nil then + b = false + else + b = true + end + else + b = not b + end + newval = b + else + --set the option as specified + if val==L["on"] then + newval = true + elseif val==L["off"] then + newval = false + elseif val==L["default"] then + newval = nil + end + end + + do_final(info, inputpos, tab, "set", opt, newval) + end + + + elseif tab.type=="color" then + ------------ color -------------------------------------------- + local str = strtrim(strlower(str)) + if str == "" then + --TODO: Show current value + return + end + + local r, g, b, a + + local hasAlpha = tab.hasAlpha + if type(hasAlpha) == "function" or type(hasAlpha) == "string" then + info.hasAlpha = hasAlpha + hasAlpha = callmethod(info, inputpos, tab, 'hasAlpha') + info.hasAlpha = nil + end + + if hasAlpha then + if str:len() == 8 and str:find("^%x*$") then + --parse a hex string + r,g,b,a = tonumber(str:sub(1, 2), 16) / 255, tonumber(str:sub(3, 4), 16) / 255, tonumber(str:sub(5, 6), 16) / 255, tonumber(str:sub(7, 8), 16) / 255 + else + --parse seperate values + r,g,b,a = str:match("^([%d%.]+) ([%d%.]+) ([%d%.]+) ([%d%.]+)$") + r,g,b,a = tonumber(r), tonumber(g), tonumber(b), tonumber(a) + end + if not (r and g and b and a) then + usererr(info, inputpos, format(L["'%s' - expected 'RRGGBBAA' or 'r g b a'."], str)) + return + end + + if r >= 0.0 and r <= 1.0 and g >= 0.0 and g <= 1.0 and b >= 0.0 and b <= 1.0 and a >= 0.0 and a <= 1.0 then + --values are valid + elseif r >= 0 and r <= 255 and g >= 0 and g <= 255 and b >= 0 and b <= 255 and a >= 0 and a <= 255 then + --values are valid 0..255, convert to 0..1 + r = r / 255 + g = g / 255 + b = b / 255 + a = a / 255 + else + --values are invalid + usererr(info, inputpos, format(L["'%s' - values must all be either in the range 0..1 or 0..255."], str)) + end + else + a = 1.0 + if str:len() == 6 and str:find("^%x*$") then + --parse a hex string + r,g,b = tonumber(str:sub(1, 2), 16) / 255, tonumber(str:sub(3, 4), 16) / 255, tonumber(str:sub(5, 6), 16) / 255 + else + --parse seperate values + r,g,b = str:match("^([%d%.]+) ([%d%.]+) ([%d%.]+)$") + r,g,b = tonumber(r), tonumber(g), tonumber(b) + end + if not (r and g and b) then + usererr(info, inputpos, format(L["'%s' - expected 'RRGGBB' or 'r g b'."], str)) + return + end + if r >= 0.0 and r <= 1.0 and g >= 0.0 and g <= 1.0 and b >= 0.0 and b <= 1.0 then + --values are valid + elseif r >= 0 and r <= 255 and g >= 0 and g <= 255 and b >= 0 and b <= 255 then + --values are valid 0..255, convert to 0..1 + r = r / 255 + g = g / 255 + b = b / 255 + else + --values are invalid + usererr(info, inputpos, format(L["'%s' - values must all be either in the range 0-1 or 0-255."], str)) + end + end + + do_final(info, inputpos, tab, "set", r,g,b,a) + + elseif tab.type=="keybinding" then + ------------ keybinding -------------------------------------------- + local str = strtrim(strlower(str)) + if str == "" then + --TODO: Show current value + return + end + local value = keybindingValidateFunc(str:upper()) + if value == false then + usererr(info, inputpos, format(L["'%s' - Invalid Keybinding."], str)) + return + end + + do_final(info, inputpos, tab, "set", value) + + elseif tab.type=="description" then + ------------ description -------------------- + -- ignore description, GUI config only + else + err(info, inputpos, "unknown options table item type '"..tostring(tab.type).."'") + end +end + +--- Handle the chat command. +-- This is usually called from a chat command handler to parse the command input as operations on an aceoptions table.\\ +-- AceConfigCmd uses this function internally when a slash command is registered with `:CreateChatCommand` +-- @param slashcmd The slash command WITHOUT leading slash (only used for error output) +-- @param appName The application name as given to `:RegisterOptionsTable()` +-- @param input The commandline input (as given by the WoW handler, i.e. without the command itself) +-- @usage +-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceConsole-3.0") +-- -- Use AceConsole-3.0 to register a Chat Command +-- MyAddon:RegisterChatCommand("mychat", "ChatCommand") +-- +-- -- Show the GUI if no input is supplied, otherwise handle the chat input. +-- function MyAddon:ChatCommand(input) +-- -- Assuming "MyOptions" is the appName of a valid options table +-- if not input or input:trim() == "" then +-- LibStub("AceConfigDialog-3.0"):Open("MyOptions") +-- else +-- LibStub("AceConfigCmd-3.0").HandleCommand(MyAddon, "mychat", "MyOptions", input) +-- end +-- end +function AceConfigCmd:HandleCommand(slashcmd, appName, input) + + local optgetter = cfgreg:GetOptionsTable(appName) + if not optgetter then + error([[Usage: HandleCommand("slashcmd", "appName", "input"): 'appName' - no options table "]]..tostring(appName)..[[" has been registered]], 2) + end + local options = assert( optgetter("cmd", MAJOR) ) + + local info = { -- Don't try to recycle this, it gets handed off to callbacks and whatnot + [0] = slashcmd, + appName = appName, + options = options, + input = input, + self = self, + handler = self, + uiType = "cmd", + uiName = MAJOR, + } + + handle(info, 1, options, 0) -- (info, inputpos, table, depth) +end + +--- Utility function to create a slash command handler. +-- Also registers tab completion with AceTab +-- @param slashcmd The slash command WITHOUT leading slash (only used for error output) +-- @param appName The application name as given to `:RegisterOptionsTable()` +function AceConfigCmd:CreateChatCommand(slashcmd, appName) + if not AceConsole then + AceConsole = LibStub(AceConsoleName) + end + if AceConsole.RegisterChatCommand(self, slashcmd, function(input) + AceConfigCmd.HandleCommand(self, slashcmd, appName, input) -- upgradable + end, + true) then -- succesfully registered so lets get the command -> app table in + commands[slashcmd] = appName + end +end + +--- Utility function that returns the options table that belongs to a slashcommand. +-- Designed to be used for the AceTab interface. +-- @param slashcmd The slash command WITHOUT leading slash (only used for error output) +-- @return The options table associated with the slash command (or nil if the slash command was not registered) +function AceConfigCmd:GetChatCommandOptions(slashcmd) + return commands[slashcmd] +end diff --git a/Libs/AceConfig-3.0/AceConfigCmd-3.0/AceConfigCmd-3.0.xml b/Libs/AceConfig-3.0/AceConfigCmd-3.0/AceConfigCmd-3.0.xml new file mode 100644 index 0000000..c8caf34 --- /dev/null +++ b/Libs/AceConfig-3.0/AceConfigCmd-3.0/AceConfigCmd-3.0.xml @@ -0,0 +1,4 @@ +<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/ +..\FrameXML\UI.xsd"> + <Script file="AceConfigCmd-3.0.lua"/> +</Ui> diff --git a/Libs/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.lua b/Libs/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.lua new file mode 100644 index 0000000..23c134d --- /dev/null +++ b/Libs/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.lua @@ -0,0 +1,1974 @@ +--- AceConfigDialog-3.0 generates AceGUI-3.0 based windows based on option tables. +-- @class file +-- @name AceConfigDialog-3.0 +-- @release $Id: AceConfigDialog-3.0.lua 1163 2017-08-14 14:04:39Z nevcairiel $ + +local LibStub = LibStub +local gui = LibStub("AceGUI-3.0") +local reg = LibStub("AceConfigRegistry-3.0") + +local MAJOR, MINOR = "AceConfigDialog-3.0", 64 +local AceConfigDialog, oldminor = LibStub:NewLibrary(MAJOR, MINOR) + +if not AceConfigDialog then return end + +AceConfigDialog.OpenFrames = AceConfigDialog.OpenFrames or {} +AceConfigDialog.Status = AceConfigDialog.Status or {} +AceConfigDialog.frame = AceConfigDialog.frame or CreateFrame("Frame") + +AceConfigDialog.frame.apps = AceConfigDialog.frame.apps or {} +AceConfigDialog.frame.closing = AceConfigDialog.frame.closing or {} +AceConfigDialog.frame.closeAllOverride = AceConfigDialog.frame.closeAllOverride or {} + +-- Lua APIs +local tconcat, tinsert, tsort, tremove, tsort = table.concat, table.insert, table.sort, table.remove, table.sort +local strmatch, format = string.match, string.format +local assert, loadstring, error = assert, loadstring, error +local pairs, next, select, type, unpack, wipe, ipairs = pairs, next, select, type, unpack, wipe, ipairs +local rawset, tostring, tonumber = rawset, tostring, tonumber +local math_min, math_max, math_floor = math.min, math.max, math.floor + +-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded +-- List them here for Mikk's FindGlobals script +-- GLOBALS: NORMAL_FONT_COLOR, GameTooltip, StaticPopupDialogs, ACCEPT, CANCEL, StaticPopup_Show +-- GLOBALS: PlaySound, GameFontHighlight, GameFontHighlightSmall, GameFontHighlightLarge +-- GLOBALS: CloseSpecialWindows, InterfaceOptions_AddCategory, geterrorhandler + +local emptyTbl = {} + +--[[ + xpcall safecall implementation +]] +local xpcall = xpcall + +local function errorhandler(err) + return geterrorhandler()(err) +end + +local function CreateDispatcher(argCount) + local code = [[ + local xpcall, eh = ... + local method, ARGS + local function call() return method(ARGS) end + + local function dispatch(func, ...) + method = func + if not method then return end + ARGS = ... + return xpcall(call, eh) + end + + return dispatch + ]] + + local ARGS = {} + for i = 1, argCount do ARGS[i] = "arg"..i end + code = code:gsub("ARGS", tconcat(ARGS, ", ")) + return assert(loadstring(code, "safecall Dispatcher["..argCount.."]"))(xpcall, errorhandler) +end + +local Dispatchers = setmetatable({}, {__index=function(self, argCount) + local dispatcher = CreateDispatcher(argCount) + rawset(self, argCount, dispatcher) + return dispatcher +end}) +Dispatchers[0] = function(func) + return xpcall(func, errorhandler) +end + +local function safecall(func, ...) + return Dispatchers[select("#", ...)](func, ...) +end + +local width_multiplier = 170 + +--[[ +Group Types + Tree - All Descendant Groups will all become nodes on the tree, direct child options will appear above the tree + - Descendant Groups with inline=true and thier children will not become nodes + + Tab - Direct Child Groups will become tabs, direct child options will appear above the tab control + - Grandchild groups will default to inline unless specified otherwise + + Select- Same as Tab but with entries in a dropdown rather than tabs + + + Inline Groups + - Will not become nodes of a select group, they will be effectivly part of thier parent group seperated by a border + - If declared on a direct child of a root node of a select group, they will appear above the group container control + - When a group is displayed inline, all descendants will also be inline members of the group + +]] + +-- Recycling functions +local new, del, copy +--newcount, delcount,createdcount,cached = 0,0,0 +do + local pool = setmetatable({},{__mode="k"}) + function new() + --newcount = newcount + 1 + local t = next(pool) + if t then + pool[t] = nil + return t + else + --createdcount = createdcount + 1 + return {} + end + end + function copy(t) + local c = new() + for k, v in pairs(t) do + c[k] = v + end + return c + end + function del(t) + --delcount = delcount + 1 + wipe(t) + pool[t] = true + end +-- function cached() +-- local n = 0 +-- for k in pairs(pool) do +-- n = n + 1 +-- end +-- return n +-- end +end + +-- picks the first non-nil value and returns it +local function pickfirstset(...) + for i=1,select("#",...) do + if select(i,...)~=nil then + return select(i,...) + end + end +end + +--gets an option from a given group, checking plugins +local function GetSubOption(group, key) + if group.plugins then + for plugin, t in pairs(group.plugins) do + if t[key] then + return t[key] + end + end + end + + return group.args[key] +end + +--Option member type definitions, used to decide how to access it + +--Is the member Inherited from parent options +local isInherited = { + set = true, + get = true, + func = true, + confirm = true, + validate = true, + disabled = true, + hidden = true +} + +--Does a string type mean a literal value, instead of the default of a method of the handler +local stringIsLiteral = { + name = true, + desc = true, + icon = true, + usage = true, + width = true, + image = true, + fontSize = true, +} + +--Is Never a function or method +local allIsLiteral = { + type = true, + descStyle = true, + imageWidth = true, + imageHeight = true, +} + +--gets the value for a member that could be a function +--function refs are called with an info arg +--every other type is returned +local function GetOptionsMemberValue(membername, option, options, path, appName, ...) + --get definition for the member + local inherits = isInherited[membername] + + + --get the member of the option, traversing the tree if it can be inherited + local member + + if inherits then + local group = options + if group[membername] ~= nil then + member = group[membername] + end + for i = 1, #path do + group = GetSubOption(group, path[i]) + if group[membername] ~= nil then + member = group[membername] + end + end + else + member = option[membername] + end + + --check if we need to call a functon, or if we have a literal value + if ( not allIsLiteral[membername] ) and ( type(member) == "function" or ((not stringIsLiteral[membername]) and type(member) == "string") ) then + --We have a function to call + local info = new() + --traverse the options table, picking up the handler and filling the info with the path + local handler + local group = options + handler = group.handler or handler + + for i = 1, #path do + group = GetSubOption(group, path[i]) + info[i] = path[i] + handler = group.handler or handler + end + + info.options = options + info.appName = appName + info[0] = appName + info.arg = option.arg + info.handler = handler + info.option = option + info.type = option.type + info.uiType = "dialog" + info.uiName = MAJOR + + local a, b, c ,d + --using 4 returns for the get of a color type, increase if a type needs more + if type(member) == "function" then + --Call the function + a,b,c,d = member(info, ...) + else + --Call the method + if handler and handler[member] then + a,b,c,d = handler[member](handler, info, ...) + else + error(format("Method %s doesn't exist in handler for type %s", member, membername)) + end + end + del(info) + return a,b,c,d + else + --The value isnt a function to call, return it + return member + end +end + +--[[calls an options function that could be inherited, method name or function ref +local function CallOptionsFunction(funcname ,option, options, path, appName, ...) + local info = new() + + local func + local group = options + local handler + + --build the info table containing the path + -- pick up functions while traversing the tree + if group[funcname] ~= nil then + func = group[funcname] + end + handler = group.handler or handler + + for i, v in ipairs(path) do + group = GetSubOption(group, v) + info[i] = v + if group[funcname] ~= nil then + func = group[funcname] + end + handler = group.handler or handler + end + + info.options = options + info[0] = appName + info.arg = option.arg + + local a, b, c ,d + if type(func) == "string" then + if handler and handler[func] then + a,b,c,d = handler[func](handler, info, ...) + else + error(string.format("Method %s doesn't exist in handler for type func", func)) + end + elseif type(func) == "function" then + a,b,c,d = func(info, ...) + end + del(info) + return a,b,c,d +end +--]] + +--tables to hold orders and names for options being sorted, will be created with new() +--prevents needing to call functions repeatedly while sorting +local tempOrders +local tempNames + +local function compareOptions(a,b) + if not a then + return true + end + if not b then + return false + end + local OrderA, OrderB = tempOrders[a] or 100, tempOrders[b] or 100 + if OrderA == OrderB then + local NameA = (type(tempNames[a]) == "string") and tempNames[a] or "" + local NameB = (type(tempNames[b]) == "string") and tempNames[b] or "" + return NameA:upper() < NameB:upper() + end + if OrderA < 0 then + if OrderB > 0 then + return false + end + else + if OrderB < 0 then + return true + end + end + return OrderA < OrderB +end + + + +--builds 2 tables out of an options group +-- keySort, sorted keys +-- opts, combined options from .plugins and args +local function BuildSortedOptionsTable(group, keySort, opts, options, path, appName) + tempOrders = new() + tempNames = new() + + if group.plugins then + for plugin, t in pairs(group.plugins) do + for k, v in pairs(t) do + if not opts[k] then + tinsert(keySort, k) + opts[k] = v + + path[#path+1] = k + tempOrders[k] = GetOptionsMemberValue("order", v, options, path, appName) + tempNames[k] = GetOptionsMemberValue("name", v, options, path, appName) + path[#path] = nil + end + end + end + end + + for k, v in pairs(group.args) do + if not opts[k] then + tinsert(keySort, k) + opts[k] = v + + path[#path+1] = k + tempOrders[k] = GetOptionsMemberValue("order", v, options, path, appName) + tempNames[k] = GetOptionsMemberValue("name", v, options, path, appName) + path[#path] = nil + end + end + + tsort(keySort, compareOptions) + + del(tempOrders) + del(tempNames) +end + +local function DelTree(tree) + if tree.children then + local childs = tree.children + for i = 1, #childs do + DelTree(childs[i]) + del(childs[i]) + end + del(childs) + end +end + +local function CleanUserData(widget, event) + + local user = widget:GetUserDataTable() + + if user.path then + del(user.path) + end + + if widget.type == "TreeGroup" then + local tree = user.tree + widget:SetTree(nil) + if tree then + for i = 1, #tree do + DelTree(tree[i]) + del(tree[i]) + end + del(tree) + end + end + + if widget.type == "TabGroup" then + widget:SetTabs(nil) + if user.tablist then + del(user.tablist) + end + end + + if widget.type == "DropdownGroup" then + widget:SetGroupList(nil) + if user.grouplist then + del(user.grouplist) + end + if user.orderlist then + del(user.orderlist) + end + end +end + +-- - Gets a status table for the given appname and options path. +-- @param appName The application name as given to `:RegisterOptionsTable()` +-- @param path The path to the options (a table with all group keys) +-- @return +function AceConfigDialog:GetStatusTable(appName, path) + local status = self.Status + + if not status[appName] then + status[appName] = {} + status[appName].status = {} + status[appName].children = {} + end + + status = status[appName] + + if path then + for i = 1, #path do + local v = path[i] + if not status.children[v] then + status.children[v] = {} + status.children[v].status = {} + status.children[v].children = {} + end + status = status.children[v] + end + end + + return status.status +end + +--- Selects the specified path in the options window. +-- The path specified has to match the keys of the groups in the table. +-- @param appName The application name as given to `:RegisterOptionsTable()` +-- @param ... The path to the key that should be selected +function AceConfigDialog:SelectGroup(appName, ...) + local path = new() + + + local app = reg:GetOptionsTable(appName) + if not app then + error(("%s isn't registed with AceConfigRegistry, unable to open config"):format(appName), 2) + end + local options = app("dialog", MAJOR) + local group = options + local status = self:GetStatusTable(appName, path) + if not status.groups then + status.groups = {} + end + status = status.groups + local treevalue + local treestatus + + for n = 1, select("#",...) do + local key = select(n, ...) + + if group.childGroups == "tab" or group.childGroups == "select" then + --if this is a tab or select group, select the group + status.selected = key + --children of this group are no longer extra levels of a tree + treevalue = nil + else + --tree group by default + if treevalue then + --this is an extra level of a tree group, build a uniquevalue for it + treevalue = treevalue.."\001"..key + else + --this is the top level of a tree group, the uniquevalue is the same as the key + treevalue = key + if not status.groups then + status.groups = {} + end + --save this trees status table for any extra levels or groups + treestatus = status + end + --make sure that the tree entry is open, and select it. + --the selected group will be overwritten if a child is the final target but still needs to be open + treestatus.selected = treevalue + treestatus.groups[treevalue] = true + + end + + --move to the next group in the path + group = GetSubOption(group, key) + if not group then + break + end + tinsert(path, key) + status = self:GetStatusTable(appName, path) + if not status.groups then + status.groups = {} + end + status = status.groups + end + + del(path) + reg:NotifyChange(appName) +end + +local function OptionOnMouseOver(widget, event) + --show a tooltip/set the status bar to the desc text + local user = widget:GetUserDataTable() + local opt = user.option + local options = user.options + local path = user.path + local appName = user.appName + + GameTooltip:SetOwner(widget.frame, "ANCHOR_TOPRIGHT") + local name = GetOptionsMemberValue("name", opt, options, path, appName) + local desc = GetOptionsMemberValue("desc", opt, options, path, appName) + local usage = GetOptionsMemberValue("usage", opt, options, path, appName) + local descStyle = opt.descStyle + + if descStyle and descStyle ~= "tooltip" then return end + + GameTooltip:SetText(name, 1, .82, 0, true) + + if opt.type == "multiselect" then + GameTooltip:AddLine(user.text, 0.5, 0.5, 0.8, true) + end + if type(desc) == "string" then + GameTooltip:AddLine(desc, 1, 1, 1, true) + end + if type(usage) == "string" then + GameTooltip:AddLine("Usage: "..usage, NORMAL_FONT_COLOR.r, NORMAL_FONT_COLOR.g, NORMAL_FONT_COLOR.b, true) + end + + GameTooltip:Show() +end + +local function OptionOnMouseLeave(widget, event) + GameTooltip:Hide() +end + +local function GetFuncName(option) + local type = option.type + if type == "execute" then + return "func" + else + return "set" + end +end +local function confirmPopup(appName, rootframe, basepath, info, message, func, ...) + if not StaticPopupDialogs["ACECONFIGDIALOG30_CONFIRM_DIALOG"] then + StaticPopupDialogs["ACECONFIGDIALOG30_CONFIRM_DIALOG"] = {} + end + local t = StaticPopupDialogs["ACECONFIGDIALOG30_CONFIRM_DIALOG"] + for k in pairs(t) do + t[k] = nil + end + t.text = message + t.button1 = ACCEPT + t.button2 = CANCEL + t.preferredIndex = STATICPOPUP_NUMDIALOGS + local dialog, oldstrata + t.OnAccept = function() + safecall(func, unpack(t)) + if dialog and oldstrata then + dialog:SetFrameStrata(oldstrata) + end + AceConfigDialog:Open(appName, rootframe, unpack(basepath or emptyTbl)) + del(info) + end + t.OnCancel = function() + if dialog and oldstrata then + dialog:SetFrameStrata(oldstrata) + end + AceConfigDialog:Open(appName, rootframe, unpack(basepath or emptyTbl)) + del(info) + end + for i = 1, select("#", ...) do + t[i] = select(i, ...) or false + end + t.timeout = 0 + t.whileDead = 1 + t.hideOnEscape = 1 + + dialog = StaticPopup_Show("ACECONFIGDIALOG30_CONFIRM_DIALOG") + if dialog then + oldstrata = dialog:GetFrameStrata() + dialog:SetFrameStrata("TOOLTIP") + end +end + +local function validationErrorPopup(message) + if not StaticPopupDialogs["ACECONFIGDIALOG30_VALIDATION_ERROR_DIALOG"] then + StaticPopupDialogs["ACECONFIGDIALOG30_VALIDATION_ERROR_DIALOG"] = {} + end + local t = StaticPopupDialogs["ACECONFIGDIALOG30_VALIDATION_ERROR_DIALOG"] + t.text = message + t.button1 = OKAY + t.preferredIndex = STATICPOPUP_NUMDIALOGS + local dialog, oldstrata + t.OnAccept = function() + if dialog and oldstrata then + dialog:SetFrameStrata(oldstrata) + end + end + t.timeout = 0 + t.whileDead = 1 + t.hideOnEscape = 1 + + dialog = StaticPopup_Show("ACECONFIGDIALOG30_VALIDATION_ERROR_DIALOG") + if dialog then + oldstrata = dialog:GetFrameStrata() + dialog:SetFrameStrata("TOOLTIP") + end +end + +local function ActivateControl(widget, event, ...) + --This function will call the set / execute handler for the widget + --widget:GetUserDataTable() contains the needed info + local user = widget:GetUserDataTable() + local option = user.option + local options = user.options + local path = user.path + local info = new() + + local func + local group = options + local funcname = GetFuncName(option) + local handler + local confirm + local validate + --build the info table containing the path + -- pick up functions while traversing the tree + if group[funcname] ~= nil then + func = group[funcname] + end + handler = group.handler or handler + confirm = group.confirm + validate = group.validate + for i = 1, #path do + local v = path[i] + group = GetSubOption(group, v) + info[i] = v + if group[funcname] ~= nil then + func = group[funcname] + end + handler = group.handler or handler + if group.confirm ~= nil then + confirm = group.confirm + end + if group.validate ~= nil then + validate = group.validate + end + end + + info.options = options + info.appName = user.appName + info.arg = option.arg + info.handler = handler + info.option = option + info.type = option.type + info.uiType = "dialog" + info.uiName = MAJOR + + local name + if type(option.name) == "function" then + name = option.name(info) + elseif type(option.name) == "string" then + name = option.name + else + name = "" + end + local usage = option.usage + local pattern = option.pattern + + local validated = true + + if option.type == "input" then + if type(pattern)=="string" then + if not strmatch(..., pattern) then + validated = false + end + end + end + + local success + if validated and option.type ~= "execute" then + if type(validate) == "string" then + if handler and handler[validate] then + success, validated = safecall(handler[validate], handler, info, ...) + if not success then validated = false end + else + error(format("Method %s doesn't exist in handler for type execute", validate)) + end + elseif type(validate) == "function" then + success, validated = safecall(validate, info, ...) + if not success then validated = false end + end + end + + local rootframe = user.rootframe + if not validated or type(validated) == "string" then + if not validated then + if usage then + validated = name..": "..usage + else + if pattern then + validated = name..": Expected "..pattern + else + validated = name..": Invalid Value" + end + end + end + + -- show validate message + if rootframe.SetStatusText then + rootframe:SetStatusText(validated) + else + validationErrorPopup(validated) + end + PlaySound(PlaySoundKitID and "igPlayerInviteDecline" or 882) -- SOUNDKIT.IG_PLAYER_INVITE_DECLINE || XXX _DECLINE is actually missing from the table + del(info) + return true + else + + local confirmText = option.confirmText + --call confirm func/method + if type(confirm) == "string" then + if handler and handler[confirm] then + success, confirm = safecall(handler[confirm], handler, info, ...) + if success and type(confirm) == "string" then + confirmText = confirm + confirm = true + elseif not success then + confirm = false + end + else + error(format("Method %s doesn't exist in handler for type confirm", confirm)) + end + elseif type(confirm) == "function" then + success, confirm = safecall(confirm, info, ...) + if success and type(confirm) == "string" then + confirmText = confirm + confirm = true + elseif not success then + confirm = false + end + end + + --confirm if needed + if type(confirm) == "boolean" then + if confirm then + if not confirmText then + local name, desc = option.name, option.desc + if type(name) == "function" then + name = name(info) + end + if type(desc) == "function" then + desc = desc(info) + end + confirmText = name + if desc then + confirmText = confirmText.." - "..desc + end + end + + local iscustom = user.rootframe:GetUserData("iscustom") + local rootframe + + if iscustom then + rootframe = user.rootframe + end + local basepath = user.rootframe:GetUserData("basepath") + if type(func) == "string" then + if handler and handler[func] then + confirmPopup(user.appName, rootframe, basepath, info, confirmText, handler[func], handler, info, ...) + else + error(format("Method %s doesn't exist in handler for type func", func)) + end + elseif type(func) == "function" then + confirmPopup(user.appName, rootframe, basepath, info, confirmText, func, info, ...) + end + --func will be called and info deleted when the confirm dialog is responded to + return + end + end + + --call the function + if type(func) == "string" then + if handler and handler[func] then + safecall(handler[func],handler, info, ...) + else + error(format("Method %s doesn't exist in handler for type func", func)) + end + elseif type(func) == "function" then + safecall(func,info, ...) + end + + + + local iscustom = user.rootframe:GetUserData("iscustom") + local basepath = user.rootframe:GetUserData("basepath") or emptyTbl + --full refresh of the frame, some controls dont cause this on all events + if option.type == "color" then + if event == "OnValueConfirmed" then + + if iscustom then + AceConfigDialog:Open(user.appName, user.rootframe, unpack(basepath)) + else + AceConfigDialog:Open(user.appName, unpack(basepath)) + end + end + elseif option.type == "range" then + if event == "OnMouseUp" then + if iscustom then + AceConfigDialog:Open(user.appName, user.rootframe, unpack(basepath)) + else + AceConfigDialog:Open(user.appName, unpack(basepath)) + end + end + --multiselects don't cause a refresh on 'OnValueChanged' only 'OnClosed' + elseif option.type == "multiselect" then + user.valuechanged = true + else + if iscustom then + AceConfigDialog:Open(user.appName, user.rootframe, unpack(basepath)) + else + AceConfigDialog:Open(user.appName, unpack(basepath)) + end + end + + end + del(info) +end + +local function ActivateSlider(widget, event, value) + local option = widget:GetUserData("option") + local min, max, step = option.min or (not option.softMin and 0 or nil), option.max or (not option.softMax and 100 or nil), option.step + if min then + if step then + value = math_floor((value - min) / step + 0.5) * step + min + end + value = math_max(value, min) + end + if max then + value = math_min(value, max) + end + ActivateControl(widget,event,value) +end + +--called from a checkbox that is part of an internally created multiselect group +--this type is safe to refresh on activation of one control +local function ActivateMultiControl(widget, event, ...) + ActivateControl(widget, event, widget:GetUserData("value"), ...) + local user = widget:GetUserDataTable() + local iscustom = user.rootframe:GetUserData("iscustom") + local basepath = user.rootframe:GetUserData("basepath") or emptyTbl + if iscustom then + AceConfigDialog:Open(user.appName, user.rootframe, unpack(basepath)) + else + AceConfigDialog:Open(user.appName, unpack(basepath)) + end +end + +local function MultiControlOnClosed(widget, event, ...) + local user = widget:GetUserDataTable() + if user.valuechanged then + local iscustom = user.rootframe:GetUserData("iscustom") + local basepath = user.rootframe:GetUserData("basepath") or emptyTbl + if iscustom then + AceConfigDialog:Open(user.appName, user.rootframe, unpack(basepath)) + else + AceConfigDialog:Open(user.appName, unpack(basepath)) + end + end +end + +local function FrameOnClose(widget, event) + local appName = widget:GetUserData("appName") + AceConfigDialog.OpenFrames[appName] = nil + gui:Release(widget) +end + +local function CheckOptionHidden(option, options, path, appName) + --check for a specific boolean option + local hidden = pickfirstset(option.dialogHidden,option.guiHidden) + if hidden ~= nil then + return hidden + end + + return GetOptionsMemberValue("hidden", option, options, path, appName) +end + +local function CheckOptionDisabled(option, options, path, appName) + --check for a specific boolean option + local disabled = pickfirstset(option.dialogDisabled,option.guiDisabled) + if disabled ~= nil then + return disabled + end + + return GetOptionsMemberValue("disabled", option, options, path, appName) +end +--[[ +local function BuildTabs(group, options, path, appName) + local tabs = new() + local text = new() + local keySort = new() + local opts = new() + + BuildSortedOptionsTable(group, keySort, opts, options, path, appName) + + for i = 1, #keySort do + local k = keySort[i] + local v = opts[k] + if v.type == "group" then + path[#path+1] = k + local inline = pickfirstset(v.dialogInline,v.guiInline,v.inline, false) + local hidden = CheckOptionHidden(v, options, path, appName) + if not inline and not hidden then + tinsert(tabs, k) + text[k] = GetOptionsMemberValue("name", v, options, path, appName) + end + path[#path] = nil + end + end + + del(keySort) + del(opts) + + return tabs, text +end +]] +local function BuildSelect(group, options, path, appName) + local groups = new() + local order = new() + local keySort = new() + local opts = new() + + BuildSortedOptionsTable(group, keySort, opts, options, path, appName) + + for i = 1, #keySort do + local k = keySort[i] + local v = opts[k] + if v.type == "group" then + path[#path+1] = k + local inline = pickfirstset(v.dialogInline,v.guiInline,v.inline, false) + local hidden = CheckOptionHidden(v, options, path, appName) + if not inline and not hidden then + groups[k] = GetOptionsMemberValue("name", v, options, path, appName) + tinsert(order, k) + end + path[#path] = nil + end + end + + del(opts) + del(keySort) + + return groups, order +end + +local function BuildSubGroups(group, tree, options, path, appName) + local keySort = new() + local opts = new() + + BuildSortedOptionsTable(group, keySort, opts, options, path, appName) + + for i = 1, #keySort do + local k = keySort[i] + local v = opts[k] + if v.type == "group" then + path[#path+1] = k + local inline = pickfirstset(v.dialogInline,v.guiInline,v.inline, false) + local hidden = CheckOptionHidden(v, options, path, appName) + if not inline and not hidden then + local entry = new() + entry.value = k + entry.text = GetOptionsMemberValue("name", v, options, path, appName) + entry.icon = GetOptionsMemberValue("icon", v, options, path, appName) + entry.iconCoords = GetOptionsMemberValue("iconCoords", v, options, path, appName) + entry.disabled = CheckOptionDisabled(v, options, path, appName) + if not tree.children then tree.children = new() end + tinsert(tree.children,entry) + if (v.childGroups or "tree") == "tree" then + BuildSubGroups(v,entry, options, path, appName) + end + end + path[#path] = nil + end + end + + del(keySort) + del(opts) +end + +local function BuildGroups(group, options, path, appName, recurse) + local tree = new() + local keySort = new() + local opts = new() + + BuildSortedOptionsTable(group, keySort, opts, options, path, appName) + + for i = 1, #keySort do + local k = keySort[i] + local v = opts[k] + if v.type == "group" then + path[#path+1] = k + local inline = pickfirstset(v.dialogInline,v.guiInline,v.inline, false) + local hidden = CheckOptionHidden(v, options, path, appName) + if not inline and not hidden then + local entry = new() + entry.value = k + entry.text = GetOptionsMemberValue("name", v, options, path, appName) + entry.icon = GetOptionsMemberValue("icon", v, options, path, appName) + entry.disabled = CheckOptionDisabled(v, options, path, appName) + tinsert(tree,entry) + if recurse and (v.childGroups or "tree") == "tree" then + BuildSubGroups(v,entry, options, path, appName) + end + end + path[#path] = nil + end + end + del(keySort) + del(opts) + return tree +end + +local function InjectInfo(control, options, option, path, rootframe, appName) + local user = control:GetUserDataTable() + for i = 1, #path do + user[i] = path[i] + end + user.rootframe = rootframe + user.option = option + user.options = options + user.path = copy(path) + user.appName = appName + control:SetCallback("OnRelease", CleanUserData) + control:SetCallback("OnLeave", OptionOnMouseLeave) + control:SetCallback("OnEnter", OptionOnMouseOver) +end + + +--[[ + options - root of the options table being fed + container - widget that controls will be placed in + rootframe - Frame object the options are in + path - table with the keys to get to the group being fed +--]] + +local function FeedOptions(appName, options,container,rootframe,path,group,inline) + local keySort = new() + local opts = new() + + BuildSortedOptionsTable(group, keySort, opts, options, path, appName) + + for i = 1, #keySort do + local k = keySort[i] + local v = opts[k] + tinsert(path, k) + local hidden = CheckOptionHidden(v, options, path, appName) + local name = GetOptionsMemberValue("name", v, options, path, appName) + if not hidden then + if v.type == "group" then + if inline or pickfirstset(v.dialogInline,v.guiInline,v.inline, false) then + --Inline group + local GroupContainer + if name and name ~= "" then + GroupContainer = gui:Create("InlineGroup") + GroupContainer:SetTitle(name or "") + else + GroupContainer = gui:Create("SimpleGroup") + end + + GroupContainer.width = "fill" + GroupContainer:SetLayout("flow") + container:AddChild(GroupContainer) + FeedOptions(appName,options,GroupContainer,rootframe,path,v,true) + end + else + --Control to feed + local control + + local name = GetOptionsMemberValue("name", v, options, path, appName) + + if v.type == "execute" then + + local imageCoords = GetOptionsMemberValue("imageCoords",v, options, path, appName) + local image, width, height = GetOptionsMemberValue("image",v, options, path, appName) + + if type(image) == "string" or type(image) == "number" then + control = gui:Create("Icon") + if not width then + width = GetOptionsMemberValue("imageWidth",v, options, path, appName) + end + if not height then + height = GetOptionsMemberValue("imageHeight",v, options, path, appName) + end + if type(imageCoords) == "table" then + control:SetImage(image, unpack(imageCoords)) + else + control:SetImage(image) + end + if type(width) ~= "number" then + width = 32 + end + if type(height) ~= "number" then + height = 32 + end + control:SetImageSize(width, height) + control:SetLabel(name) + else + control = gui:Create("Button") + control:SetText(name) + end + control:SetCallback("OnClick",ActivateControl) + + elseif v.type == "input" then + local controlType = v.dialogControl or v.control or (v.multiline and "MultiLineEditBox") or "EditBox" + control = gui:Create(controlType) + if not control then + geterrorhandler()(("Invalid Custom Control Type - %s"):format(tostring(controlType))) + control = gui:Create(v.multiline and "MultiLineEditBox" or "EditBox") + end + + if v.multiline and control.SetNumLines then + control:SetNumLines(tonumber(v.multiline) or 4) + end + control:SetLabel(name) + control:SetCallback("OnEnterPressed",ActivateControl) + local text = GetOptionsMemberValue("get",v, options, path, appName) + if type(text) ~= "string" then + text = "" + end + control:SetText(text) + + elseif v.type == "toggle" then + control = gui:Create("CheckBox") + control:SetLabel(name) + control:SetTriState(v.tristate) + local value = GetOptionsMemberValue("get",v, options, path, appName) + control:SetValue(value) + control:SetCallback("OnValueChanged",ActivateControl) + + if v.descStyle == "inline" then + local desc = GetOptionsMemberValue("desc", v, options, path, appName) + control:SetDescription(desc) + end + + local image = GetOptionsMemberValue("image", v, options, path, appName) + local imageCoords = GetOptionsMemberValue("imageCoords", v, options, path, appName) + + if type(image) == "string" or type(image) == "number" then + if type(imageCoords) == "table" then + control:SetImage(image, unpack(imageCoords)) + else + control:SetImage(image) + end + end + elseif v.type == "range" then + control = gui:Create("Slider") + control:SetLabel(name) + control:SetSliderValues(v.softMin or v.min or 0, v.softMax or v.max or 100, v.bigStep or v.step or 0) + control:SetIsPercent(v.isPercent) + local value = GetOptionsMemberValue("get",v, options, path, appName) + if type(value) ~= "number" then + value = 0 + end + control:SetValue(value) + control:SetCallback("OnValueChanged",ActivateSlider) + control:SetCallback("OnMouseUp",ActivateSlider) + + elseif v.type == "select" then + local values = GetOptionsMemberValue("values", v, options, path, appName) + if v.style == "radio" then + local disabled = CheckOptionDisabled(v, options, path, appName) + local width = GetOptionsMemberValue("width",v,options,path,appName) + control = gui:Create("InlineGroup") + control:SetLayout("Flow") + control:SetTitle(name) + control.width = "fill" + + control:PauseLayout() + local optionValue = GetOptionsMemberValue("get",v, options, path, appName) + local t = {} + for value, text in pairs(values) do + t[#t+1]=value + end + tsort(t) + for k, value in ipairs(t) do + local text = values[value] + local radio = gui:Create("CheckBox") + radio:SetLabel(text) + radio:SetUserData("value", value) + radio:SetUserData("text", text) + radio:SetDisabled(disabled) + radio:SetType("radio") + radio:SetValue(optionValue == value) + radio:SetCallback("OnValueChanged", ActivateMultiControl) + InjectInfo(radio, options, v, path, rootframe, appName) + control:AddChild(radio) + if width == "double" then + radio:SetWidth(width_multiplier * 2) + elseif width == "half" then + radio:SetWidth(width_multiplier / 2) + elseif width == "full" then + radio.width = "fill" + else + radio:SetWidth(width_multiplier) + end + end + control:ResumeLayout() + control:DoLayout() + else + local controlType = v.dialogControl or v.control or "Dropdown" + control = gui:Create(controlType) + if not control then + geterrorhandler()(("Invalid Custom Control Type - %s"):format(tostring(controlType))) + control = gui:Create("Dropdown") + end + local itemType = v.itemControl + if itemType and not gui:GetWidgetVersion(itemType) then + geterrorhandler()(("Invalid Custom Item Type - %s"):format(tostring(itemType))) + itemType = nil + end + control:SetLabel(name) + control:SetList(values, nil, itemType) + local value = GetOptionsMemberValue("get",v, options, path, appName) + if not values[value] then + value = nil + end + control:SetValue(value) + control:SetCallback("OnValueChanged", ActivateControl) + end + + elseif v.type == "multiselect" then + local values = GetOptionsMemberValue("values", v, options, path, appName) + local disabled = CheckOptionDisabled(v, options, path, appName) + + local controlType = v.dialogControl or v.control + + local valuesort = new() + if values then + for value, text in pairs(values) do + tinsert(valuesort, value) + end + end + tsort(valuesort) + + if controlType then + control = gui:Create(controlType) + if not control then + geterrorhandler()(("Invalid Custom Control Type - %s"):format(tostring(controlType))) + end + end + if control then + control:SetMultiselect(true) + control:SetLabel(name) + control:SetList(values) + control:SetDisabled(disabled) + control:SetCallback("OnValueChanged",ActivateControl) + control:SetCallback("OnClosed", MultiControlOnClosed) + local width = GetOptionsMemberValue("width",v,options,path,appName) + if width == "double" then + control:SetWidth(width_multiplier * 2) + elseif width == "half" then + control:SetWidth(width_multiplier / 2) + elseif width == "full" then + control.width = "fill" + else + control:SetWidth(width_multiplier) + end + --check:SetTriState(v.tristate) + for i = 1, #valuesort do + local key = valuesort[i] + local value = GetOptionsMemberValue("get",v, options, path, appName, key) + control:SetItemValue(key,value) + end + else + control = gui:Create("InlineGroup") + control:SetLayout("Flow") + control:SetTitle(name) + control.width = "fill" + + control:PauseLayout() + local width = GetOptionsMemberValue("width",v,options,path,appName) + for i = 1, #valuesort do + local value = valuesort[i] + local text = values[value] + local check = gui:Create("CheckBox") + check:SetLabel(text) + check:SetUserData("value", value) + check:SetUserData("text", text) + check:SetDisabled(disabled) + check:SetTriState(v.tristate) + check:SetValue(GetOptionsMemberValue("get",v, options, path, appName, value)) + check:SetCallback("OnValueChanged",ActivateMultiControl) + InjectInfo(check, options, v, path, rootframe, appName) + control:AddChild(check) + if width == "double" then + check:SetWidth(width_multiplier * 2) + elseif width == "half" then + check:SetWidth(width_multiplier / 2) + elseif width == "full" then + check.width = "fill" + else + check:SetWidth(width_multiplier) + end + end + control:ResumeLayout() + control:DoLayout() + + + end + + del(valuesort) + + elseif v.type == "color" then + control = gui:Create("ColorPicker") + control:SetLabel(name) + control:SetHasAlpha(GetOptionsMemberValue("hasAlpha",v, options, path, appName)) + control:SetColor(GetOptionsMemberValue("get",v, options, path, appName)) + control:SetCallback("OnValueChanged",ActivateControl) + control:SetCallback("OnValueConfirmed",ActivateControl) + + elseif v.type == "keybinding" then + control = gui:Create("Keybinding") + control:SetLabel(name) + control:SetKey(GetOptionsMemberValue("get",v, options, path, appName)) + control:SetCallback("OnKeyChanged",ActivateControl) + + elseif v.type == "header" then + control = gui:Create("Heading") + control:SetText(name) + control.width = "fill" + + elseif v.type == "description" then + control = gui:Create("Label") + control:SetText(name) + + local fontSize = GetOptionsMemberValue("fontSize",v, options, path, appName) + if fontSize == "medium" then + control:SetFontObject(GameFontHighlight) + elseif fontSize == "large" then + control:SetFontObject(GameFontHighlightLarge) + else -- small or invalid + control:SetFontObject(GameFontHighlightSmall) + end + + local imageCoords = GetOptionsMemberValue("imageCoords",v, options, path, appName) + local image, width, height = GetOptionsMemberValue("image",v, options, path, appName) + + if type(image) == "string" or type(image) == "number" then + if not width then + width = GetOptionsMemberValue("imageWidth",v, options, path, appName) + end + if not height then + height = GetOptionsMemberValue("imageHeight",v, options, path, appName) + end + if type(imageCoords) == "table" then + control:SetImage(image, unpack(imageCoords)) + else + control:SetImage(image) + end + if type(width) ~= "number" then + width = 32 + end + if type(height) ~= "number" then + height = 32 + end + control:SetImageSize(width, height) + end + local width = GetOptionsMemberValue("width",v,options,path,appName) + control.width = not width and "fill" + end + + --Common Init + if control then + if control.width ~= "fill" then + local width = GetOptionsMemberValue("width",v,options,path,appName) + if width == "double" then + control:SetWidth(width_multiplier * 2) + elseif width == "half" then + control:SetWidth(width_multiplier / 2) + elseif width == "full" then + control.width = "fill" + else + control:SetWidth(width_multiplier) + end + end + if control.SetDisabled then + local disabled = CheckOptionDisabled(v, options, path, appName) + control:SetDisabled(disabled) + end + + InjectInfo(control, options, v, path, rootframe, appName) + container:AddChild(control) + end + + end + end + tremove(path) + end + container:ResumeLayout() + container:DoLayout() + del(keySort) + del(opts) +end + +local function BuildPath(path, ...) + for i = 1, select("#",...) do + tinsert(path, (select(i,...))) + end +end + + +local function TreeOnButtonEnter(widget, event, uniquevalue, button) + local user = widget:GetUserDataTable() + if not user then return end + local options = user.options + local option = user.option + local path = user.path + local appName = user.appName + + local feedpath = new() + for i = 1, #path do + feedpath[i] = path[i] + end + + BuildPath(feedpath, ("\001"):split(uniquevalue)) + local group = options + for i = 1, #feedpath do + if not group then return end + group = GetSubOption(group, feedpath[i]) + end + + local name = GetOptionsMemberValue("name", group, options, feedpath, appName) + local desc = GetOptionsMemberValue("desc", group, options, feedpath, appName) + + GameTooltip:SetOwner(button, "ANCHOR_NONE") + if widget.type == "TabGroup" then + GameTooltip:SetPoint("BOTTOM",button,"TOP") + else + GameTooltip:SetPoint("LEFT",button,"RIGHT") + end + + GameTooltip:SetText(name, 1, .82, 0, true) + + if type(desc) == "string" then + GameTooltip:AddLine(desc, 1, 1, 1, true) + end + + GameTooltip:Show() +end + +local function TreeOnButtonLeave(widget, event, value, button) + GameTooltip:Hide() +end + + +local function GroupExists(appName, options, path, uniquevalue) + if not uniquevalue then return false end + + local feedpath = new() + local temppath = new() + for i = 1, #path do + feedpath[i] = path[i] + end + + BuildPath(feedpath, ("\001"):split(uniquevalue)) + + local group = options + for i = 1, #feedpath do + local v = feedpath[i] + temppath[i] = v + group = GetSubOption(group, v) + + if not group or group.type ~= "group" or CheckOptionHidden(group, options, temppath, appName) then + del(feedpath) + del(temppath) + return false + end + end + del(feedpath) + del(temppath) + return true +end + +local function GroupSelected(widget, event, uniquevalue) + + local user = widget:GetUserDataTable() + + local options = user.options + local option = user.option + local path = user.path + local rootframe = user.rootframe + + local feedpath = new() + for i = 1, #path do + feedpath[i] = path[i] + end + + BuildPath(feedpath, ("\001"):split(uniquevalue)) + local group = options + for i = 1, #feedpath do + group = GetSubOption(group, feedpath[i]) + end + widget:ReleaseChildren() + AceConfigDialog:FeedGroup(user.appName,options,widget,rootframe,feedpath) + + del(feedpath) +end + + + +--[[ +-- INTERNAL -- +This function will feed one group, and any inline child groups into the given container +Select Groups will only have the selection control (tree, tabs, dropdown) fed in +and have a group selected, this event will trigger the feeding of child groups + +Rules: + If the group is Inline, FeedOptions + If the group has no child groups, FeedOptions + + If the group is a tab or select group, FeedOptions then add the Group Control + If the group is a tree group FeedOptions then + its parent isnt a tree group: then add the tree control containing this and all child tree groups + if its parent is a tree group, its already a node on a tree +--]] + +function AceConfigDialog:FeedGroup(appName,options,container,rootframe,path, isRoot) + local group = options + --follow the path to get to the curent group + local inline + local grouptype, parenttype = options.childGroups, "none" + + + for i = 1, #path do + local v = path[i] + group = GetSubOption(group, v) + inline = inline or pickfirstset(v.dialogInline,v.guiInline,v.inline, false) + parenttype = grouptype + grouptype = group.childGroups + end + + if not parenttype then + parenttype = "tree" + end + + --check if the group has child groups + local hasChildGroups + for k, v in pairs(group.args) do + if v.type == "group" and not pickfirstset(v.dialogInline,v.guiInline,v.inline, false) and not CheckOptionHidden(v, options, path, appName) then + hasChildGroups = true + end + end + if group.plugins then + for plugin, t in pairs(group.plugins) do + for k, v in pairs(t) do + if v.type == "group" and not pickfirstset(v.dialogInline,v.guiInline,v.inline, false) and not CheckOptionHidden(v, options, path, appName) then + hasChildGroups = true + end + end + end + end + + container:SetLayout("flow") + local scroll + + --Add a scrollframe if we are not going to add a group control, this is the inverse of the conditions for that later on + if (not (hasChildGroups and not inline)) or (grouptype ~= "tab" and grouptype ~= "select" and (parenttype == "tree" and not isRoot)) then + if container.type ~= "InlineGroup" and container.type ~= "SimpleGroup" then + scroll = gui:Create("ScrollFrame") + scroll:SetLayout("flow") + scroll.width = "fill" + scroll.height = "fill" + container:SetLayout("fill") + container:AddChild(scroll) + container = scroll + end + end + + FeedOptions(appName,options,container,rootframe,path,group,nil) + + if scroll then + container:PerformLayout() + local status = self:GetStatusTable(appName, path) + if not status.scroll then + status.scroll = {} + end + scroll:SetStatusTable(status.scroll) + end + + if hasChildGroups and not inline then + local name = GetOptionsMemberValue("name", group, options, path, appName) + if grouptype == "tab" then + + local tab = gui:Create("TabGroup") + InjectInfo(tab, options, group, path, rootframe, appName) + tab:SetCallback("OnGroupSelected", GroupSelected) + tab:SetCallback("OnTabEnter", TreeOnButtonEnter) + tab:SetCallback("OnTabLeave", TreeOnButtonLeave) + + local status = AceConfigDialog:GetStatusTable(appName, path) + if not status.groups then + status.groups = {} + end + tab:SetStatusTable(status.groups) + tab.width = "fill" + tab.height = "fill" + + local tabs = BuildGroups(group, options, path, appName) + tab:SetTabs(tabs) + tab:SetUserData("tablist", tabs) + + for i = 1, #tabs do + local entry = tabs[i] + if not entry.disabled then + tab:SelectTab((GroupExists(appName, options, path,status.groups.selected) and status.groups.selected) or entry.value) + break + end + end + + container:AddChild(tab) + + elseif grouptype == "select" then + + local select = gui:Create("DropdownGroup") + select:SetTitle(name) + InjectInfo(select, options, group, path, rootframe, appName) + select:SetCallback("OnGroupSelected", GroupSelected) + local status = AceConfigDialog:GetStatusTable(appName, path) + if not status.groups then + status.groups = {} + end + select:SetStatusTable(status.groups) + local grouplist, orderlist = BuildSelect(group, options, path, appName) + select:SetGroupList(grouplist, orderlist) + select:SetUserData("grouplist", grouplist) + select:SetUserData("orderlist", orderlist) + + local firstgroup = orderlist[1] + if firstgroup then + select:SetGroup((GroupExists(appName, options, path,status.groups.selected) and status.groups.selected) or firstgroup) + end + + select.width = "fill" + select.height = "fill" + + container:AddChild(select) + + --assume tree group by default + --if parenttype is tree then this group is already a node on that tree + elseif (parenttype ~= "tree") or isRoot then + local tree = gui:Create("TreeGroup") + InjectInfo(tree, options, group, path, rootframe, appName) + tree:EnableButtonTooltips(false) + + tree.width = "fill" + tree.height = "fill" + + tree:SetCallback("OnGroupSelected", GroupSelected) + tree:SetCallback("OnButtonEnter", TreeOnButtonEnter) + tree:SetCallback("OnButtonLeave", TreeOnButtonLeave) + + local status = AceConfigDialog:GetStatusTable(appName, path) + if not status.groups then + status.groups = {} + end + local treedefinition = BuildGroups(group, options, path, appName, true) + tree:SetStatusTable(status.groups) + + tree:SetTree(treedefinition) + tree:SetUserData("tree",treedefinition) + + for i = 1, #treedefinition do + local entry = treedefinition[i] + if not entry.disabled then + tree:SelectByValue((GroupExists(appName, options, path,status.groups.selected) and status.groups.selected) or entry.value) + break + end + end + + container:AddChild(tree) + end + end +end + +local old_CloseSpecialWindows + + +local function RefreshOnUpdate(this) + for appName in pairs(this.closing) do + if AceConfigDialog.OpenFrames[appName] then + AceConfigDialog.OpenFrames[appName]:Hide() + end + if AceConfigDialog.BlizOptions and AceConfigDialog.BlizOptions[appName] then + for key, widget in pairs(AceConfigDialog.BlizOptions[appName]) do + if not widget:IsVisible() then + widget:ReleaseChildren() + end + end + end + this.closing[appName] = nil + end + + if this.closeAll then + for k, v in pairs(AceConfigDialog.OpenFrames) do + if not this.closeAllOverride[k] then + v:Hide() + end + end + this.closeAll = nil + wipe(this.closeAllOverride) + end + + for appName in pairs(this.apps) do + if AceConfigDialog.OpenFrames[appName] then + local user = AceConfigDialog.OpenFrames[appName]:GetUserDataTable() + AceConfigDialog:Open(appName, unpack(user.basepath or emptyTbl)) + end + if AceConfigDialog.BlizOptions and AceConfigDialog.BlizOptions[appName] then + for key, widget in pairs(AceConfigDialog.BlizOptions[appName]) do + local user = widget:GetUserDataTable() + if widget:IsVisible() then + AceConfigDialog:Open(widget:GetUserData("appName"), widget, unpack(user.basepath or emptyTbl)) + end + end + end + this.apps[appName] = nil + end + this:SetScript("OnUpdate", nil) +end + +-- Upgrade the OnUpdate script as well, if needed. +if AceConfigDialog.frame:GetScript("OnUpdate") then + AceConfigDialog.frame:SetScript("OnUpdate", RefreshOnUpdate) +end + +--- Close all open options windows +function AceConfigDialog:CloseAll() + AceConfigDialog.frame.closeAll = true + AceConfigDialog.frame:SetScript("OnUpdate", RefreshOnUpdate) + if next(self.OpenFrames) then + return true + end +end + +--- Close a specific options window. +-- @param appName The application name as given to `:RegisterOptionsTable()` +function AceConfigDialog:Close(appName) + if self.OpenFrames[appName] then + AceConfigDialog.frame.closing[appName] = true + AceConfigDialog.frame:SetScript("OnUpdate", RefreshOnUpdate) + return true + end +end + +-- Internal -- Called by AceConfigRegistry +function AceConfigDialog:ConfigTableChanged(event, appName) + AceConfigDialog.frame.apps[appName] = true + AceConfigDialog.frame:SetScript("OnUpdate", RefreshOnUpdate) +end + +reg.RegisterCallback(AceConfigDialog, "ConfigTableChange", "ConfigTableChanged") + +--- Sets the default size of the options window for a specific application. +-- @param appName The application name as given to `:RegisterOptionsTable()` +-- @param width The default width +-- @param height The default height +function AceConfigDialog:SetDefaultSize(appName, width, height) + local status = AceConfigDialog:GetStatusTable(appName) + if type(width) == "number" and type(height) == "number" then + status.width = width + status.height = height + end +end + +--- Open an option window at the specified path (if any). +-- This function can optionally feed the group into a pre-created container +-- instead of creating a new container frame. +-- @paramsig appName [, container][, ...] +-- @param appName The application name as given to `:RegisterOptionsTable()` +-- @param container An optional container frame to feed the options into +-- @param ... The path to open after creating the options window (see `:SelectGroup` for details) +function AceConfigDialog:Open(appName, container, ...) + if not old_CloseSpecialWindows then + old_CloseSpecialWindows = CloseSpecialWindows + CloseSpecialWindows = function() + local found = old_CloseSpecialWindows() + return self:CloseAll() or found + end + end + local app = reg:GetOptionsTable(appName) + if not app then + error(("%s isn't registed with AceConfigRegistry, unable to open config"):format(appName), 2) + end + local options = app("dialog", MAJOR) + + local f + + local path = new() + local name = GetOptionsMemberValue("name", options, options, path, appName) + + --If an optional path is specified add it to the path table before feeding the options + --as container is optional as well it may contain the first element of the path + if type(container) == "string" then + tinsert(path, container) + container = nil + end + for n = 1, select("#",...) do + tinsert(path, (select(n, ...))) + end + + local option = options + if type(container) == "table" and container.type == "BlizOptionsGroup" and #path > 0 then + for i = 1, #path do + option = options.args[path[i]] + end + name = format("%s - %s", name, GetOptionsMemberValue("name", option, options, path, appName)) + end + + --if a container is given feed into that + if container then + f = container + f:ReleaseChildren() + f:SetUserData("appName", appName) + f:SetUserData("iscustom", true) + if #path > 0 then + f:SetUserData("basepath", copy(path)) + end + local status = AceConfigDialog:GetStatusTable(appName) + if not status.width then + status.width = 700 + end + if not status.height then + status.height = 500 + end + if f.SetStatusTable then + f:SetStatusTable(status) + end + if f.SetTitle then + f:SetTitle(name or "") + end + else + if not self.OpenFrames[appName] then + f = gui:Create("Frame") + self.OpenFrames[appName] = f + else + f = self.OpenFrames[appName] + end + f:ReleaseChildren() + f:SetCallback("OnClose", FrameOnClose) + f:SetUserData("appName", appName) + if #path > 0 then + f:SetUserData("basepath", copy(path)) + end + f:SetTitle(name or "") + local status = AceConfigDialog:GetStatusTable(appName) + f:SetStatusTable(status) + end + + self:FeedGroup(appName,options,f,f,path,true) + if f.Show then + f:Show() + end + del(path) + + if AceConfigDialog.frame.closeAll then + -- close all is set, but thats not good, since we're just opening here, so force it + AceConfigDialog.frame.closeAllOverride[appName] = true + end +end + +-- convert pre-39 BlizOptions structure to the new format +if oldminor and oldminor < 39 and AceConfigDialog.BlizOptions then + local old = AceConfigDialog.BlizOptions + local new = {} + for key, widget in pairs(old) do + local appName = widget:GetUserData("appName") + if not new[appName] then new[appName] = {} end + new[appName][key] = widget + end + AceConfigDialog.BlizOptions = new +else + AceConfigDialog.BlizOptions = AceConfigDialog.BlizOptions or {} +end + +local function FeedToBlizPanel(widget, event) + local path = widget:GetUserData("path") + AceConfigDialog:Open(widget:GetUserData("appName"), widget, unpack(path or emptyTbl)) +end + +local function ClearBlizPanel(widget, event) + local appName = widget:GetUserData("appName") + AceConfigDialog.frame.closing[appName] = true + AceConfigDialog.frame:SetScript("OnUpdate", RefreshOnUpdate) +end + +--- Add an option table into the Blizzard Interface Options panel. +-- You can optionally supply a descriptive name to use and a parent frame to use, +-- as well as a path in the options table.\\ +-- If no name is specified, the appName will be used instead. +-- +-- If you specify a proper `parent` (by name), the interface options will generate a +-- tree layout. Note that only one level of children is supported, so the parent always +-- has to be a head-level note. +-- +-- This function returns a reference to the container frame registered with the Interface +-- Options. You can use this reference to open the options with the API function +-- `InterfaceOptionsFrame_OpenToCategory`. +-- @param appName The application name as given to `:RegisterOptionsTable()` +-- @param name A descriptive name to display in the options tree (defaults to appName) +-- @param parent The parent to use in the interface options tree. +-- @param ... The path in the options table to feed into the interface options panel. +-- @return The reference to the frame registered into the Interface Options. +function AceConfigDialog:AddToBlizOptions(appName, name, parent, ...) + local BlizOptions = AceConfigDialog.BlizOptions + + local key = appName + for n = 1, select("#", ...) do + key = key.."\001"..select(n, ...) + end + + if not BlizOptions[appName] then + BlizOptions[appName] = {} + end + + if not BlizOptions[appName][key] then + local group = gui:Create("BlizOptionsGroup") + BlizOptions[appName][key] = group + group:SetName(name or appName, parent) + + group:SetTitle(name or appName) + group:SetUserData("appName", appName) + if select("#", ...) > 0 then + local path = {} + for n = 1, select("#",...) do + tinsert(path, (select(n, ...))) + end + group:SetUserData("path", path) + end + group:SetCallback("OnShow", FeedToBlizPanel) + group:SetCallback("OnHide", ClearBlizPanel) + InterfaceOptions_AddCategory(group.frame) + return group.frame + else + error(("%s has already been added to the Blizzard Options Window with the given path"):format(appName), 2) + end +end diff --git a/Libs/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.xml b/Libs/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.xml new file mode 100644 index 0000000..068be6f --- /dev/null +++ b/Libs/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.xml @@ -0,0 +1,4 @@ +<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/ +..\FrameXML\UI.xsd"> + <Script file="AceConfigDialog-3.0.lua"/> +</Ui> diff --git a/Libs/AceConfig-3.0/AceConfigRegistry-3.0/AceConfigRegistry-3.0.lua b/Libs/AceConfig-3.0/AceConfigRegistry-3.0/AceConfigRegistry-3.0.lua new file mode 100644 index 0000000..a0d2e58 --- /dev/null +++ b/Libs/AceConfig-3.0/AceConfigRegistry-3.0/AceConfigRegistry-3.0.lua @@ -0,0 +1,349 @@ +--- AceConfigRegistry-3.0 handles central registration of options tables in use by addons and modules.\\ +-- Options tables can be registered as raw tables, OR as function refs that return a table.\\ +-- Such functions receive three arguments: "uiType", "uiName", "appName". \\ +-- * Valid **uiTypes**: "cmd", "dropdown", "dialog". This is verified by the library at call time. \\ +-- * 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.\\ +-- * The **appName** field is the options table name as given at registration time \\ +-- +-- :IterateOptionsTables() (and :GetOptionsTable() if only given one argument) return a function reference that the requesting config handling addon must call with valid "uiType", "uiName". +-- @class file +-- @name AceConfigRegistry-3.0 +-- @release $Id: AceConfigRegistry-3.0.lua 1161 2017-08-12 14:30:16Z funkydude $ +local CallbackHandler = LibStub("CallbackHandler-1.0") + +local MAJOR, MINOR = "AceConfigRegistry-3.0", 17 +local AceConfigRegistry = LibStub:NewLibrary(MAJOR, MINOR) + +if not AceConfigRegistry then return end + +AceConfigRegistry.tables = AceConfigRegistry.tables or {} + +if not AceConfigRegistry.callbacks then + AceConfigRegistry.callbacks = CallbackHandler:New(AceConfigRegistry) +end + +-- Lua APIs +local tinsert, tconcat = table.insert, table.concat +local strfind, strmatch = string.find, string.match +local type, tostring, select, pairs = type, tostring, select, pairs +local error, assert = error, assert + +----------------------------------------------------------------------- +-- Validating options table consistency: + + +AceConfigRegistry.validated = { + -- list of options table names ran through :ValidateOptionsTable automatically. + -- CLEARED ON PURPOSE, since newer versions may have newer validators + cmd = {}, + dropdown = {}, + dialog = {}, +} + + + +local function err(msg, errlvl, ...) + local t = {} + for i=select("#",...),1,-1 do + tinsert(t, (select(i, ...))) + end + error(MAJOR..":ValidateOptionsTable(): "..tconcat(t,".")..msg, errlvl+2) +end + + +local isstring={["string"]=true, _="string"} +local isstringfunc={["string"]=true,["function"]=true, _="string or funcref"} +local istable={["table"]=true, _="table"} +local ismethodtable={["table"]=true,["string"]=true,["function"]=true, _="methodname, funcref or table"} +local optstring={["nil"]=true,["string"]=true, _="string"} +local optstringfunc={["nil"]=true,["string"]=true,["function"]=true, _="string or funcref"} +local optstringnumberfunc={["nil"]=true,["string"]=true,["number"]=true,["function"]=true, _="string, number or funcref"} +local optnumber={["nil"]=true,["number"]=true, _="number"} +local optmethod={["nil"]=true,["string"]=true,["function"]=true, _="methodname or funcref"} +local optmethodfalse={["nil"]=true,["string"]=true,["function"]=true,["boolean"]={[false]=true}, _="methodname, funcref or false"} +local optmethodnumber={["nil"]=true,["string"]=true,["function"]=true,["number"]=true, _="methodname, funcref or number"} +local optmethodtable={["nil"]=true,["string"]=true,["function"]=true,["table"]=true, _="methodname, funcref or table"} +local optmethodbool={["nil"]=true,["string"]=true,["function"]=true,["boolean"]=true, _="methodname, funcref or boolean"} +local opttable={["nil"]=true,["table"]=true, _="table"} +local optbool={["nil"]=true,["boolean"]=true, _="boolean"} +local optboolnumber={["nil"]=true,["boolean"]=true,["number"]=true, _="boolean or number"} + +local basekeys={ + type=isstring, + name=isstringfunc, + desc=optstringfunc, + descStyle=optstring, + order=optmethodnumber, + validate=optmethodfalse, + confirm=optmethodbool, + confirmText=optstring, + disabled=optmethodbool, + hidden=optmethodbool, + guiHidden=optmethodbool, + dialogHidden=optmethodbool, + dropdownHidden=optmethodbool, + cmdHidden=optmethodbool, + icon=optstringnumberfunc, + iconCoords=optmethodtable, + handler=opttable, + get=optmethodfalse, + set=optmethodfalse, + func=optmethodfalse, + arg={["*"]=true}, + width=optstring, +} + +local typedkeys={ + header={}, + description={ + image=optstringnumberfunc, + imageCoords=optmethodtable, + imageHeight=optnumber, + imageWidth=optnumber, + fontSize=optstringfunc, + }, + group={ + args=istable, + plugins=opttable, + inline=optbool, + cmdInline=optbool, + guiInline=optbool, + dropdownInline=optbool, + dialogInline=optbool, + childGroups=optstring, + }, + execute={ + image=optstringnumberfunc, + imageCoords=optmethodtable, + imageHeight=optnumber, + imageWidth=optnumber, + }, + input={ + pattern=optstring, + usage=optstring, + control=optstring, + dialogControl=optstring, + dropdownControl=optstring, + multiline=optboolnumber, + }, + toggle={ + tristate=optbool, + image=optstringnumberfunc, + imageCoords=optmethodtable, + }, + tristate={ + }, + range={ + min=optnumber, + softMin=optnumber, + max=optnumber, + softMax=optnumber, + step=optnumber, + bigStep=optnumber, + isPercent=optbool, + }, + select={ + values=ismethodtable, + style={ + ["nil"]=true, + ["string"]={dropdown=true,radio=true}, + _="string: 'dropdown' or 'radio'" + }, + control=optstring, + dialogControl=optstring, + dropdownControl=optstring, + itemControl=optstring, + }, + multiselect={ + values=ismethodtable, + style=optstring, + tristate=optbool, + control=optstring, + dialogControl=optstring, + dropdownControl=optstring, + }, + color={ + hasAlpha=optmethodbool, + }, + keybinding={ + -- TODO + }, +} + +local function validateKey(k,errlvl,...) + errlvl=(errlvl or 0)+1 + if type(k)~="string" then + err("["..tostring(k).."] - key is not a string", errlvl,...) + end + if strfind(k, "[%c\127]") then + err("["..tostring(k).."] - key name contained control characters", errlvl,...) + end +end + +local function validateVal(v, oktypes, errlvl,...) + errlvl=(errlvl or 0)+1 + local isok=oktypes[type(v)] or oktypes["*"] + + if not isok then + err(": expected a "..oktypes._..", got '"..tostring(v).."'", errlvl,...) + end + if type(isok)=="table" then -- isok was a table containing specific values to be tested for! + if not isok[v] then + err(": did not expect "..type(v).." value '"..tostring(v).."'", errlvl,...) + end + end +end + +local function validate(options,errlvl,...) + errlvl=(errlvl or 0)+1 + -- basic consistency + if type(options)~="table" then + err(": expected a table, got a "..type(options), errlvl,...) + end + if type(options.type)~="string" then + err(".type: expected a string, got a "..type(options.type), errlvl,...) + end + + -- get type and 'typedkeys' member + local tk = typedkeys[options.type] + if not tk then + err(".type: unknown type '"..options.type.."'", errlvl,...) + end + + -- make sure that all options[] are known parameters + for k,v in pairs(options) do + if not (tk[k] or basekeys[k]) then + err(": unknown parameter", errlvl,tostring(k),...) + end + end + + -- verify that required params are there, and that everything is the right type + for k,oktypes in pairs(basekeys) do + validateVal(options[k], oktypes, errlvl,k,...) + end + for k,oktypes in pairs(tk) do + validateVal(options[k], oktypes, errlvl,k,...) + end + + -- extra logic for groups + if options.type=="group" then + for k,v in pairs(options.args) do + validateKey(k,errlvl,"args",...) + validate(v, errlvl,k,"args",...) + end + if options.plugins then + for plugname,plugin in pairs(options.plugins) do + if type(plugin)~="table" then + err(": expected a table, got '"..tostring(plugin).."'", errlvl,tostring(plugname),"plugins",...) + end + for k,v in pairs(plugin) do + validateKey(k,errlvl,tostring(plugname),"plugins",...) + validate(v, errlvl,k,tostring(plugname),"plugins",...) + end + end + end + end +end + + +--- Validates basic structure and integrity of an options table \\ +-- Does NOT verify that get/set etc actually exist, since they can be defined at any depth +-- @param options The table to be validated +-- @param name The name of the table to be validated (shown in any error message) +-- @param errlvl (optional number) error level offset, default 0 (=errors point to the function calling :ValidateOptionsTable) +function AceConfigRegistry:ValidateOptionsTable(options,name,errlvl) + errlvl=(errlvl or 0)+1 + name = name or "Optionstable" + if not options.name then + options.name=name -- bit of a hack, the root level doesn't really need a .name :-/ + end + validate(options,errlvl,name) +end + +--- Fires a "ConfigTableChange" callback for those listening in on it, allowing config GUIs to refresh. +-- You should call this function if your options table changed from any outside event, like a game event +-- or a timer. +-- @param appName The application name as given to `:RegisterOptionsTable()` +function AceConfigRegistry:NotifyChange(appName) + if not AceConfigRegistry.tables[appName] then return end + AceConfigRegistry.callbacks:Fire("ConfigTableChange", appName) +end + +-- ------------------------------------------------------------------- +-- Registering and retreiving options tables: + + +-- validateGetterArgs: helper function for :GetOptionsTable (or, rather, the getter functions returned by it) + +local function validateGetterArgs(uiType, uiName, errlvl) + errlvl=(errlvl or 0)+2 + if uiType~="cmd" and uiType~="dropdown" and uiType~="dialog" then + error(MAJOR..": Requesting options table: 'uiType' - invalid configuration UI type, expected 'cmd', 'dropdown' or 'dialog'", errlvl) + end + if not strmatch(uiName, "[A-Za-z]%-[0-9]") then -- Expecting e.g. "MyLib-1.2" + error(MAJOR..": Requesting options table: 'uiName' - badly formatted or missing version number. Expected e.g. 'MyLib-1.2'", errlvl) + end +end + +--- Register an options table with the config registry. +-- @param appName The application name as given to `:RegisterOptionsTable()` +-- @param options The options table, OR a function reference that generates it on demand. \\ +-- See the top of the page for info on arguments passed to such functions. +-- @param skipValidation Skip options table validation (primarily useful for extremely huge options, with a noticeable slowdown) +function AceConfigRegistry:RegisterOptionsTable(appName, options, skipValidation) + if type(options)=="table" then + if options.type~="group" then -- quick sanity checker + error(MAJOR..": RegisterOptionsTable(appName, options): 'options' - missing type='group' member in root group", 2) + end + AceConfigRegistry.tables[appName] = function(uiType, uiName, errlvl) + errlvl=(errlvl or 0)+1 + validateGetterArgs(uiType, uiName, errlvl) + if not AceConfigRegistry.validated[uiType][appName] and not skipValidation then + AceConfigRegistry:ValidateOptionsTable(options, appName, errlvl) -- upgradable + AceConfigRegistry.validated[uiType][appName] = true + end + return options + end + elseif type(options)=="function" then + AceConfigRegistry.tables[appName] = function(uiType, uiName, errlvl) + errlvl=(errlvl or 0)+1 + validateGetterArgs(uiType, uiName, errlvl) + local tab = assert(options(uiType, uiName, appName)) + if not AceConfigRegistry.validated[uiType][appName] and not skipValidation then + AceConfigRegistry:ValidateOptionsTable(tab, appName, errlvl) -- upgradable + AceConfigRegistry.validated[uiType][appName] = true + end + return tab + end + else + error(MAJOR..": RegisterOptionsTable(appName, options): 'options' - expected table or function reference", 2) + end +end + +--- Returns an iterator of ["appName"]=funcref pairs +function AceConfigRegistry:IterateOptionsTables() + return pairs(AceConfigRegistry.tables) +end + + + + +--- Query the registry for a specific options table. +-- If only appName is given, a function is returned which you +-- can call with (uiType,uiName) to get the table.\\ +-- If uiType&uiName are given, the table is returned. +-- @param appName The application name as given to `:RegisterOptionsTable()` +-- @param uiType The type of UI to get the table for, one of "cmd", "dropdown", "dialog" +-- @param uiName The name of the library/addon querying for the table, e.g. "MyLib-1.0" +function AceConfigRegistry:GetOptionsTable(appName, uiType, uiName) + local f = AceConfigRegistry.tables[appName] + if not f then + return nil + end + + if uiType then + return f(uiType,uiName,1) -- get the table for us + else + return f -- return the function + end +end diff --git a/Libs/AceConfig-3.0/AceConfigRegistry-3.0/AceConfigRegistry-3.0.xml b/Libs/AceConfig-3.0/AceConfigRegistry-3.0/AceConfigRegistry-3.0.xml new file mode 100644 index 0000000..5989072 --- /dev/null +++ b/Libs/AceConfig-3.0/AceConfigRegistry-3.0/AceConfigRegistry-3.0.xml @@ -0,0 +1,4 @@ +<Ui xmlns="http://www.blizzard.com/wow/ui/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.blizzard.com/wow/ui/ +..\FrameXML\UI.xsd"> + <Script file="AceConfigRegistry-3.0.lua"/> +</Ui>