/
--]]------------------------------------------ |
-- Import Ace3 Libraries |
--]]------------------------------------------ |
local MassMailer = LibStub("AceAddon-3.0"):NewAddon("MassMailer", "AceConsole-3.0", "AceEvent-3.0") |
local AceGUI = LibStub("AceGUI-3.0") |
local L = LibStub("AceLocale-3.0"):GetLocale("MassMailer", true) |
--]]------------------------------------------ |
-- Local variables |
--]]------------------------------------------ |
local MMFrame = nil |
local AddressFrame = nil |
local GroupFrame = nil |
local AddressBox = nil |
local BodyBox = nil |
local CustomDD = nil |
local GroupDD = nil |
local UpdateFrame = CreateFrame("Frame") |
local rosterUpdate = false |
local officerUpdate = false |
local sliderValue = nil |
local friendUpdate = false |
local arenaUpdate = false |
local whichTeam = nil |
local loadedGroups = {} |
local loadedStrings = {} |
local activeSend = false |
local activeName = nil |
local nextMessageReady = nill |
local nameStr = nil |
local nIter = 1 |
local bIter = 1 |
local names = {} |
local subject = nil |
local body = {} |
--[[------------------------------------------ |
-- Locales |
--]]------------------------------------------ |
--widget text |
local addonName = L["MassMailer"] |
local toText = L["To: (Comma Separated)"] |
local subjectText = L["Subject:"] |
local bodyText = L["Body:"] |
local sendText = L["Send"] |
local addressText = L["Address Book"] |
local personalText = L["Personal"] |
local friendsText = L["Friends"] |
local guildText = L["Guild"] |
local officerText = L["Officers"] |
local minRankText = L["Min Officer Rank:"] |
local arenaText = L["Arena"] |
local twosText = L["2v2"] |
local threesText = L["3v3"] |
local fivesText = L["5v5"] |
local customText = L["Select Group:"] |
local editGroupsText = L["Edit Groups"] |
local editorText = L["Group Editor"] |
local editText = L["Edit:"] |
local newText = L["New:"] |
local membersText = L["Enter the Group members: (Comma separated)"] |
local deleteText = L["Delete Group"] |
local saveText = L["Save"] |
--error text |
local sendError = L["MassMailer: There was an error sending your message."] |
local nameError = L["MassMailer: Please enter a character name."] |
local subjectError = L["MassMailer: Please enter a subject."] |
local friendError = L["MassMailer: You have no friends!"] |
local addressError = L["MassMailer: Please enter a receipient to mail."] |
local guildError = L["MassMailer: You are not in a guild!"] |
local groupNameError = L["MassMailer: Please enter a group name."] |
local deleteError = L["MassMailer: Please select a Group to delete."] |
local arenaError = L["MassMailer: You are not in an Arena team!"] |
local twosError = L["MassMailer: You are not in a 2v2 team!"] |
local threesError = L["MassMailer: You are not in a 3v3 team!"] |
local fivesError = L["MassMailer: You are not in a 5v5 team!"] |
--status text |
local completeText = L["MassMailer: Send complete."] |
local friendStatus = L["Mail your entire friends list."] |
local findFriendText = L["(Finding Friends list. This may take a moment...)"] |
local guildStatus = L["Mail your entire guild."] |
local findGuildText = L["(Finding Guild Members. This may take a moment...)"] |
local officerStatus = L["Mail the guild officers."] |
local findOfficerText1 = L["(Finding Officers of Rank "] |
local findOfficerText2 = L[". This may take a moment...)"] |
local rankStatus = L["Rank 0 = GM, Rank 9 = Lowest Rank, etc."] |
local twosStatus = L["Mail your entire 2v2 team."] |
local threesStatus = L["Mail your entire 3v3 team."] |
local fivesStatus = L["Mail your entire 5v5 team."] |
local customStatus = L["Select a custom group."] |
local editGroupsStatus = L["Create/Edit custom groups."] |
local messageStatus1 = L["Message is "] |
local messageStatus2 = L[" characters long. Will be split into at least "] |
local messageStatus3 = L[" parts."] |
local editStatus = L["Select a pre-existing group to edit."] |
local newStatus = L["Create a new group."] |
local membersStatus = L["Enter the Group Members, seperated by commas."] |
local deleteStatus = L["Deletes the currently selected Group."] |
local saveStatus = L["Save your changes to the Group."] |
local findArenaStatus = L["(Finding Arena team members. This may take a moment...)"] |
--[[------------------------------------------ |
-- Default Options |
--]]------------------------------------------ |
local defaultGroups = { |
char = { |
officerRank = 2, |
groupNames = {}, |
groupStrings = {} |
} |
} |
--[[------------------------------------------ |
-- Stuff to do when the addon loads |
--]]------------------------------------------ |
function MassMailer:OnInitialize() |
self.db = LibStub("AceDB-3.0"):New("MassMailerDB", defaultGroups) |
MassMailer:RegisterEvent("MAIL_CLOSED", function() |
if (MMFrame) then |
MMFrame:Hide() |
end |
if (AddressFrame) then |
AddressFrame:Hide() |
end |
if (GroupFrame) then |
GroupFrame:Hide() |
end |
end) |
MassMailer:RegisterEvent("MAIL_SEND_SUCCESS") |
MassMailer:RegisterEvent("MAIL_FAILED") |
MassMailer:RegisterEvent("GUILD_ROSTER_UPDATE") |
MassMailer:RegisterEvent("FRIENDLIST_UPDATE") |
MassMailer:RegisterEvent("ARENA_TEAM_ROSTER_UPDATE") |
UpdateFrame:SetScript("OnUpdate", UpdateFrame.OnUpdate) |
MassMailer:LoadSavedOptions() |
local MMButton = CreateFrame("Button",nil,SendMailFrame,"UIPanelButtonTemplate") |
MMButton:SetHeight(18) |
MMButton:SetWidth(70) |
MMButton:SetText(addonName) |
MMButton:SetPoint("TOPRIGHT",-55,-15) |
MMButton:SetScript("OnClick",function() MassMailer:ToggleFrame() end) |
end |
--[[------------------------------------------ |
-- OnUpdate |
--]]------------------------------------------ |
function UpdateFrame.OnUpdate(self, elapsed) |
if(MMFrame) then |
MMFrame:SetStatusText(messageStatus1..BodyBox:GetText():len()..messageStatus2..math.ceil(BodyBox:GetText():len()/500)..messageStatus3) |
end |
if (activeSend) then |
if (nextMessageReady == "success") then |
bIter = bIter + 1 |
MassMailer:SendMessage(activeName, subject, body) |
elseif (nextMessageReady == "failed") then |
print(sendError) |
nextMessageReady = nil |
activeSend = false |
iter = 1 |
end |
end |
end |
--[[------------------------------------------ |
-- Event Handlers |
--]]------------------------------------------ |
function MassMailer:MAIL_SEND_SUCCESS() |
if (activeSend) then |
nextMessageReady = "success" |
end |
end |
function MassMailer:MAIL_FAILED() |
if (activeSend) then |
nextMessageReady = "failed" |
end |
end |
function MassMailer:GUILD_ROSTER_UPDATE() |
if (rosterUpdate) then |
rosterUpdate = false |
local memberName = {} |
local memberRank = {} |
for i=1, GetNumGuildMembers(true), 1 do |
memberName[i],_,memberRank[i],_,_,_,_,_,_ = GetGuildRosterInfo(i) |
end |
local guildStr = "" |
if (officerUpdate) then |
officerUpdate = false |
for k=1, getn(memberName), 1 do |
if (memberRank[k] <= sliderValue) then |
guildStr = guildStr..memberName[k]..", " |
end |
end |
else |
for j=1, getn(memberName), 1 do |
guildStr = guildStr..memberName[j]..", " |
end |
end |
guildStr = guildStr:sub(1, guildStr:len() - 2) |
if (AddressBox) then |
AddressBox:SetText(guildStr) |
end |
end |
end |
function MassMailer:FRIENDLIST_UPDATE() |
if (friendUpdate) then |
friendUpdate = false |
if (GetNumFriends() > 0) then |
local friendName = {} |
for i=1, GetNumFriends(), 1 do |
friendName[i],_,_,_,_,_,_,_ = GetFriendInfo(i) |
end |
local friendStr = "" |
for j=1, getn(friendName), 1 do |
friendStr = friendStr..friendName[j]..", " |
end |
friendStr = friendStr:sub(1, friendStr:len() - 2) |
if (AddressBox) then |
AddressBox:SetText(friendStr) |
end |
else |
print(friendError) |
AddressBox:SetText("") |
end |
end |
end |
function MassMailer:ARENA_TEAM_ROSTER_UPDATE() |
if (arenaUpdate) then |
arenaUpdate = false |
local teamMemberName = {} |
for i=1, GetNumArenaTeamMembers(ArenaTeam_GetTeamSizeID(whichTeam)), 1 do |
teamMemberName[i],_,_,_,_,_,_,_,_,_ = GetArenaTeamRosterInfo(ArenaTeam_GetTeamSizeID(whichTeam), i) |
end |
whichTeam = nil |
local teamStr = "" |
for j=1, getn(teamMemberName), 1 do |
teamStr = teamStr..teamMemberName[j]..", " |
end |
teamStr = teamStr:sub(1, teamStr:len() - 2) |
if (AddressBox) then |
AddressBox:SetText(teamStr) |
end |
end |
end |
--[[------------------------------------------ |
-- Frame Togglers |
--]]------------------------------------------ |
function MassMailer:ToggleFrame() |
if (MMFrame) then |
if (MMFrame:IsVisible()) then |
MMFrame:Hide() |
if (AddressFrame) then |
AddressFrame:Hide() |
end |
if (GroupFrame) then |
GroupFrame:Hide() |
end |
else |
MMFrame:Show() |
end |
else |
MassMailer:SpawnFrame() |
end |
end |
function MassMailer:ToggleAddress() |
if (AddressFrame) then |
if (AddressFrame:IsVisible()) then |
AddressFrame:Hide() |
if (GroupFrame) then |
GroupFrame:Hide() |
end |
else |
AddressFrame:Show() |
end |
else |
MassMailer:SpawnAddress() |
end |
end |
function MassMailer:ToggleGroup() |
if (GroupFrame) then |
if (GroupFrame:IsVisible()) then |
GroupFrame:Hide() |
else |
GroupFrame:Show() |
end |
else |
MassMailer:SpawnGroupEditor() |
end |
end |
--[[------------------------------------------ |
-- Hack to disable frame resizing |
--]]------------------------------------------ |
function MassMailer:DisableResize(whichFrame) |
whichFrame.frame:SetResizable(false) |
whichFrame.sizer_se:EnableMouse(false) |
whichFrame.sizer_s:EnableMouse(false) |
whichFrame.sizer_e:EnableMouse(false) |
whichFrame.sizer_se:Hide() |
whichFrame.sizer_s:Hide() |
whichFrame.sizer_e:Hide() |
end |
--[[------------------------------------------ |
-- Create the message frame |
--]]------------------------------------------ |
function MassMailer:SpawnFrame() |
local subject = nil |
MMFrame = AceGUI:Create("Frame") |
MMFrame:SetTitle(addonName) |
MMFrame:SetWidth(500) |
MMFrame:SetHeight(600) |
MMFrame:SetPoint("TOPLEFT", SendMailFrame, "TOPRIGHT", -25, -12) |
MMFrame.frame:SetMinResize(400,300) |
MMFrame.closebutton:SetScript("OnClick", function() MassMailer:ToggleFrame() end) |
AddressBox = AceGUI:Create("EditBox") |
AddressBox:SetLabel(toText) |
AddressBox:SetCallback("OnTextChanged", function(widget, event, text) nameStr = text end) |
AddressBox.editbox:SetMaxLetters(5000) |
MMFrame:AddChild(AddressBox) |
local SubjectBox = AceGUI:Create("EditBox") |
SubjectBox:SetLabel(subjectText) |
SubjectBox:SetCallback("OnTextChanged", function(widget, event, text) subject = text end) |
MMFrame:AddChild(SubjectBox) |
BodyBox = AceGUI:Create("MultiLineEditBox") |
BodyBox:SetLabel(bodyText) |
BodyBox.button:Hide() |
BodyBox.editbox:SetMaxLetters(5000) |
MMFrame:AddChild(BodyBox) |
local SendButton = AceGUI:Create("Button") |
SendButton:SetCallback("OnClick", function() |
nameStr = AddressBox.editbox:GetText() |
subject = SubjectBox.editbox:GetText() |
if (nameStr and nameStr ~= "") then |
if (subject and subject ~= "") then |
MassMailer:Sender(MassMailer:ParseNames(nameStr), subject, MassMailer:ParseBody(BodyBox:GetText())) |
nameStr = nil |
else |
print(subjectError) |
end |
else |
print(nameError) |
end |
end) |
SendButton:SetText(sendText) |
MMFrame:AddChild(SendButton) |
local AddressButton = AceGUI:Create("Button") |
AddressButton:SetCallback("OnClick", function() MassMailer:ToggleAddress() end) |
AddressButton:SetText(addressText) |
MMFrame:AddChild(AddressButton) |
AceGUI:RegisterLayout("MassMailer", function(content, children) |
children[1]:SetWidth(content:GetWidth()) |
children[2]:SetWidth(content:GetWidth()) |
children[3]:SetWidth(content:GetWidth()) |
local editHeight = content:GetHeight()-children[4].frame:GetHeight()-children[1].frame:GetHeight()-children[2].frame:GetHeight() |
children[3]:SetHeight(editHeight) |
children[4]:ClearAllPoints() |
children[4]:SetWidth((content:GetWidth()/2)-10) |
children[4]:SetPoint("BOTTOMRIGHT", children[3].frame, "BOTTOMRIGHT", 0, -5) |
children[5]:ClearAllPoints() |
children[5]:SetWidth((content:GetWidth()/2)-10) |
children[5]:SetPoint("BOTTOMLEFT", children[3].frame, "BOTTOMLEFT", 0, -5) |
end) |
MMFrame:SetLayout("MassMailer") |
end |
--[[------------------------------------------ |
-- Create the Address Book frame |
--]]------------------------------------------ |
function MassMailer:SpawnAddress() |
AddressFrame = AceGUI:Create("Frame") |
AddressFrame:SetTitle(addressText) |
AddressFrame:SetWidth(400) |
AddressFrame:SetHeight(270) |
AddressFrame:SetLayout("Fill") |
AddressFrame:SetPoint("TOPLEFT", MMFrame.frame, "TOPRIGHT", 0, 0) |
AddressFrame.closebutton:SetScript("OnClick", function() MassMailer:ToggleAddress() end) |
MassMailer:DisableResize(AddressFrame) |
local AddressGroup = AceGUI:Create("SimpleGroup") |
AddressFrame:AddChild(AddressGroup) |
local PersonalGroup = AceGUI:Create("InlineGroup") |
PersonalGroup:SetTitle(personalText) |
AddressGroup:AddChild(PersonalGroup) |
local FriendCB = AceGUI:Create("CheckBox") |
FriendCB:SetType("checkbox") |
FriendCB:SetLabel(friendsText) |
FriendCB:SetWidth(100) |
FriendCB:SetCallback("OnEnter", function() AddressFrame:SetStatusText(friendStatus) end) |
FriendCB:SetCallback("OnLeave", function() AddressFrame:SetStatusText("") end) |
FriendCB:SetCallback("OnValueChanged", function(widget, event, value) |
if (value) then |
UncheckOthers(FriendCB) |
friendUpdate = true |
AddressBox:SetText(findFriendText) |
ShowFriends() |
else |
friendUpdate = false |
AddressBox:SetText("") |
end |
end) |
PersonalGroup:AddChild(FriendCB) |
local GuildCB = AceGUI:Create("CheckBox") |
GuildCB:SetType("checkbox") |
GuildCB:SetLabel(guildText) |
GuildCB:SetWidth(100) |
GuildCB:SetCallback("OnEnter", function() AddressFrame:SetStatusText(guildStatus) end) |
GuildCB:SetCallback("OnLeave", function() AddressFrame:SetStatusText("") end) |
GuildCB:SetCallback("OnValueChanged", function(widget, event, value) |
if (value) then |
UncheckOthers(GuildCB) |
AddressBox:SetText("") |
if (IsInGuild()) then |
rosterUpdate = true |
AddressBox:SetText(findGuildText) |
GuildRoster() |
else |
print(guildError) |
end |
else |
rosterUpdate = false |
AddressBox:SetText("") |
end |
end) |
PersonalGroup:AddChild(GuildCB) |
local OfficerCB = AceGUI:Create("CheckBox") |
OfficerCB:SetType("checkbox") |
OfficerCB:SetLabel(officerText) |
OfficerCB:SetWidth(80) |
OfficerCB:SetCallback("OnEnter", function() AddressFrame:SetStatusText(officerStatus) end) |
OfficerCB:SetCallback("OnLeave", function() AddressFrame:SetStatusText("") end) |
OfficerCB:SetCallback("OnValueChanged", function(widget, event, value) |
if (value) then |
UncheckOthers(OfficerCB) |
AddressBox:SetText("") |
if (IsInGuild()) then |
rosterUpdate = true |
officerUpdate = true |
AddressBox:SetText(findOfficerText1..sliderValue..findOfficerText2) |
GuildRoster() |
else |
print(guildError) |
end |
else |
rosterUpdate = false |
officerUpdate = false |
AddressBox:SetText("") |
end |
end) |
PersonalGroup:AddChild(OfficerCB) |
local OfficerSlide = AceGUI:Create("Slider") |
OfficerSlide:SetSliderValues(0,9,1) |
OfficerSlide:SetValue(sliderValue) |
OfficerSlide:SetLabel(minRankText) |
OfficerSlide.frame:SetScale(0.75) |
OfficerSlide:SetWidth(100) |
OfficerSlide:SetCallback("OnEnter", function() AddressFrame:SetStatusText(rankStatus) end) |
OfficerSlide:SetCallback("OnLeave", function() AddressFrame:SetStatusText("") end) |
OfficerSlide:SetCallback("OnValueChanged", function(widget, event, value) |
sliderValue = value |
self.db.char.officerRank = value |
end) |
PersonalGroup:AddChild(OfficerSlide) |
AceGUI:RegisterLayout("PersonalGroup", function(content, children) |
children[4]:SetPoint("TOPLEFT", children[3].frame, "TOPRIGHT", 0, 15) |
end) |
PersonalGroup:SetLayout("PersonalGroup") |
local ArenaGroup = AceGUI:Create("InlineGroup") |
ArenaGroup:SetTitle(arenaText) |
AddressGroup:AddChild(ArenaGroup) |
local TwosCB = AceGUI:Create("CheckBox") |
TwosCB:SetType("checkbox") |
TwosCB:SetLabel(twosText) |
TwosCB:SetWidth(100) |
TwosCB:SetCallback("OnEnter", function() AddressFrame:SetStatusText(twosStatus) end) |
TwosCB:SetCallback("OnLeave", function() AddressFrame:SetStatusText("") end) |
TwosCB:SetCallback("OnValueChanged", function(widget, event, value) |
if (value) then |
UncheckOthers(TwosCB) |
if (IsInArenaTeam()) then |
if (ArenaTeam_GetTeamSizeID(2)) then |
AddressBox:SetText(findArenaStatus) |
arenaUpdate = true |
whichTeam = 2 |
ArenaTeamRoster(ArenaTeam_GetTeamSizeID(2)) |
else |
whichTeam = nil |
arenaUpdate = false |
print(twosError) |
end |
else |
AddressBox:SetText("") |
whichTeam = nil |
arenaUpdate = false |
print(arenaError) |
end |
end |
end) |
ArenaGroup:AddChild(TwosCB) |
local ThreesCB = AceGUI:Create("CheckBox") |
ThreesCB:SetType("checkbox") |
ThreesCB:SetLabel(threesText) |
ThreesCB:SetWidth(100) |
ThreesCB:SetCallback("OnEnter", function() AddressFrame:SetStatusText(threesStatus) end) |
ThreesCB:SetCallback("OnLeave", function() AddressFrame:SetStatusText("") end) |
ThreesCB:SetCallback("OnValueChanged", function(widget, event, value) |
if (value) then |
UncheckOthers(ThreesCB) |
if (IsInArenaTeam()) then |
if (ArenaTeam_GetTeamSizeID(3)) then |
AddressBox:SetText(findArenaStatus) |
arenaUpdate = true |
whichTeam = 3 |
ArenaTeamRoster(ArenaTeam_GetTeamSizeID(3)) |
else |
whichTeam = nil |
arenaUpdate = false |
print(threesError) |
end |
else |
AddressBox:SetText("") |
whichTeam = nil |
arenaUpdate = false |
print(arenaError) |
end |
end |
end) |
ArenaGroup:AddChild(ThreesCB) |
local FivesCB = AceGUI:Create("CheckBox") |
FivesCB:SetType("checkbox") |
FivesCB:SetLabel(fivesText) |
FivesCB:SetWidth(100) |
FivesCB:SetCallback("OnEnter", function() AddressFrame:SetStatusText(fivesStatus) end) |
FivesCB:SetCallback("OnLeave", function() AddressFrame:SetStatusText("") end) |
FivesCB:SetCallback("OnValueChanged", function(widget, event, value) |
if (value) then |
UncheckOthers(FivesCB) |
if (IsInArenaTeam()) then |
if (ArenaTeam_GetTeamSizeID(5)) then |
AddressBox:SetText(findArenaStatus) |
arenaUpdate = true |
whichTeam = 5 |
ArenaTeamRoster(ArenaTeam_GetTeamSizeID(5)) |
else |
whichTeam = nil |
arenaUpdate = false |
print(fivesError) |
end |
else |
AddressBox:SetText("") |
whichTeam = nil |
arenaUpdate = false |
print(arenaError) |
end |
end |
end) |
ArenaGroup:AddChild(FivesCB) |
local CustomGroup = AceGUI:Create("InlineGroup") |
CustomGroup:SetTitle("Custom Groups") |
AddressGroup:AddChild(CustomGroup) |
CustomDD = AceGUI:Create("Dropdown") |
CustomDD:SetLabel(customText) |
CustomDD:SetList(loadedGroups) |
CustomDD:SetCallback("OnEnter", function() AddressFrame:SetStatusText(customStatus) end) |
CustomDD:SetCallback("OnLeave", function() AddressFrame:SetStatusText("") end) |
CustomDD:SetCallback("OnValueChanged", function(widget, event, key) |
UncheckOthers(CustomDD) |
AddressBox:SetText(loadedStrings[key]) |
end) |
CustomGroup:AddChild(CustomDD) |
local CustomButton = AceGUI:Create("Button") |
CustomButton:SetText(editGroupsText) |
CustomButton:SetCallback("OnEnter", function() AddressFrame:SetStatusText(editGroupsStatus) end) |
CustomButton:SetCallback("OnLeave", function() AddressFrame:SetStatusText("") end) |
CustomButton:SetCallback("OnClick", function() MassMailer:ToggleGroup() end) |
CustomGroup:AddChild(CustomButton) |
AceGUI:RegisterLayout("AddressBook", function(content, children) |
children[1]:SetWidth(content:GetWidth()/2) |
children[1]:SetHeight(112) |
children[2]:SetWidth(content:GetWidth()/2) |
children[3]:SetWidth(content:GetWidth()) |
children[3]:SetHeight(82) |
children[2]:SetPoint("TOPLEFT", children[1].frame, "TOPRIGHT", 0, 0) |
children[3]:SetPoint("TOPLEFT", children[1].frame, "BOTTOMLEFT", 0, 0) |
end) |
AddressGroup:SetLayout("AddressBook") |
AceGUI:RegisterLayout("CustomGroup", function(content, children) |
children[1]:SetWidth(content:GetWidth()/2-5) |
children[2]:SetWidth(content:GetWidth()/2-5) |
children[2]:SetPoint("TOPLEFT", children[1].frame, "TOPRIGHT", 10, -18) |
end) |
CustomGroup:SetLayout("CustomGroup") |
--Toggles the checkboxes when a new one is selected |
--probably a better way to do this... |
function UncheckOthers(whichCB) |
if (whichCB == FriendCB) then |
if (GuildCB) then |
if (GuildCB:GetValue()) then |
GuildCB:ToggleChecked() |
end |
end |
if (OfficerCB) then |
if (OfficerCB:GetValue()) then |
OfficerCB:ToggleChecked() |
end |
end |
if (TwosCB) then |
if (TwosCB:GetValue()) then |
TwosCB:ToggleChecked() |
end |
end |
if (ThreesCB) then |
if (ThreesCB:GetValue()) then |
ThreesCB:ToggleChecked() |
end |
end |
if (FivesCB) then |
if (FivesCB:GetValue()) then |
FivesCB:ToggleChecked() |
end |
end |
if (CustomDD) then |
CustomDD:SetValue() |
end |
elseif (whichCB == GuildCB) then |
if (FriendCB) then |
if (FriendCB:GetValue()) then |
FriendCB:ToggleChecked() |
end |
end |
if (OfficerCB) then |
if (OfficerCB:GetValue()) then |
OfficerCB:ToggleChecked() |
end |
end |
if (TwosCB) then |
if (TwosCB:GetValue()) then |
TwosCB:ToggleChecked() |
end |
end |
if (ThreesCB) then |
if (ThreesCB:GetValue()) then |
ThreesCB:ToggleChecked() |
end |
end |
if (FivesCB) then |
if (FivesCB:GetValue()) then |
FivesCB:ToggleChecked() |
end |
end |
if (CustomDD) then |
CustomDD:SetValue() |
end |
elseif (whichCB == OfficerCB) then |
if (FriendCB) then |
if (FriendCB:GetValue()) then |
FriendCB:ToggleChecked() |
end |
end |
if (GuildCB) then |
if (GuildCB:GetValue()) then |
GuildCB:ToggleChecked() |
end |
end |
if (TwosCB) then |
if (TwosCB:GetValue()) then |
TwosCB:ToggleChecked() |
end |
end |
if (ThreesCB) then |
if (ThreesCB:GetValue()) then |
ThreesCB:ToggleChecked() |
end |
end |
if (FivesCB) then |
if (FivesCB:GetValue()) then |
FivesCB:ToggleChecked() |
end |
end |
if (CustomDD) then |
CustomDD:SetValue() |
end |
elseif (whichCB == CustomDD) then |
if (FriendCB) then |
if (FriendCB:GetValue()) then |
FriendCB:ToggleChecked() |
end |
end |
if (GuildCB) then |
if (GuildCB:GetValue()) then |
GuildCB:ToggleChecked() |
end |
end |
if (OfficerCB) then |
if (OfficerCB:GetValue()) then |
OfficerCB:ToggleChecked() |
end |
end |
if (TwosCB) then |
if (TwosCB:GetValue()) then |
TwosCB:ToggleChecked() |
end |
end |
if (ThreesCB) then |
if (ThreesCB:GetValue()) then |
ThreesCB:ToggleChecked() |
end |
end |
if (FivesCB) then |
if (FivesCB:GetValue()) then |
FivesCB:ToggleChecked() |
end |
end |
elseif (whichCB == TwosCB) then |
if (FriendCB) then |
if (FriendCB:GetValue()) then |
FriendCB:ToggleChecked() |
end |
end |
if (GuildCB) then |
if (GuildCB:GetValue()) then |
GuildCB:ToggleChecked() |
end |
end |
if (OfficerCB) then |
if (OfficerCB:GetValue()) then |
OfficerCB:ToggleChecked() |
end |
end |
if (ThreesCB) then |
if (ThreesCB:GetValue()) then |
ThreesCB:ToggleChecked() |
end |
end |
if (FivesCB) then |
if (FivesCB:GetValue()) then |
FivesCB:ToggleChecked() |
end |
end |
if (CustomDD) then |
CustomDD:SetValue() |
end |
elseif (whichCB == ThreesCB) then |
if (FriendCB) then |
if (FriendCB:GetValue()) then |
FriendCB:ToggleChecked() |
end |
end |
if (GuildCB) then |
if (GuildCB:GetValue()) then |
GuildCB:ToggleChecked() |
end |
end |
if (OfficerCB) then |
if (OfficerCB:GetValue()) then |
OfficerCB:ToggleChecked() |
end |
end |
if (TwosCB) then |
if (TwosCB:GetValue()) then |
TwosCB:ToggleChecked() |
end |
end |
if (FivesCB) then |
if (FivesCB:GetValue()) then |
FivesCB:ToggleChecked() |
end |
end |
if (CustomDD) then |
CustomDD:SetValue() |
end |
elseif (whichCB == FivesCB) then |
if (FriendCB) then |
if (FriendCB:GetValue()) then |
FriendCB:ToggleChecked() |
end |
end |
if (GuildCB) then |
if (GuildCB:GetValue()) then |
GuildCB:ToggleChecked() |
end |
end |
if (OfficerCB) then |
if (OfficerCB:GetValue()) then |
OfficerCB:ToggleChecked() |
end |
end |
if (TwosCB) then |
if (TwosCB:GetValue()) then |
TwosCB:ToggleChecked() |
end |
end |
if (ThreesCB) then |
if (ThreesCB:GetValue()) then |
ThreesCB:ToggleChecked() |
end |
end |
if (CustomDD) then |
CustomDD:SetValue() |
end |
else |
if (FriendCB) then |
if (FriendCB:GetValue()) then |
FriendCB:ToggleChecked() |
end |
end |
if (GuildCB) then |
if (GuildCB:GetValue()) then |
GuildCB:ToggleChecked() |
end |
end |
if (OfficerCB) then |
if (OfficerCB:GetValue()) then |
OfficerCB:ToggleChecked() |
end |
end |
if (TwosCB) then |
if (TwosCB:GetValue()) then |
TwosCB:ToggleChecked() |
end |
end |
if (ThreesCB) then |
if (ThreesCB:GetValue()) then |
ThreesCB:ToggleChecked() |
end |
end |
if (FivesCB) then |
if (FivesCB:GetValue()) then |
FivesCB:ToggleChecked() |
end |
end |
if (CustomDD) then |
CustomDD:SetValue() |
end |
end |
end |
end |
--[[------------------------------------------ |
-- Create the Group Editing window |
--]]------------------------------------------ |
function MassMailer:SpawnGroupEditor() |
GroupFrame = AceGUI:Create("Frame") |
GroupFrame:SetTitle(editorText) |
GroupFrame:SetWidth(400) |
GroupFrame:SetHeight(330) |
GroupFrame:SetPoint("TOPLEFT", AddressFrame.frame, "BOTTOMLEFT", 0, 0) |
MassMailer:DisableResize(GroupFrame) |
local selectedGroup = nil |
local currentText = nil |
GroupDD = AceGUI:Create("Dropdown") |
GroupDD:SetLabel(editText) |
GroupDD:SetList(loadedGroups) |
GroupDD:SetCallback("OnEnter", function() GroupFrame:SetStatusText(editStatus) end) |
GroupDD:SetCallback("OnLeave", function() GroupFrame:SetStatusText("") end) |
GroupFrame:AddChild(GroupDD) |
local GroupEdit = AceGUI:Create("EditBox") |
GroupEdit:SetLabel(newText) |
GroupEdit:SetCallback("OnEnter", function() GroupFrame:SetStatusText(newStatus) end) |
GroupEdit:SetCallback("OnLeave", function() GroupFrame:SetStatusText("") end) |
GroupEdit:SetCallback("OnTextChanged", function(widget, event, text) |
GroupEdit.button:Show() |
currentText = text |
end) |
GroupFrame:AddChild(GroupEdit) |
local GroupMembers = AceGUI:Create("MultiLineEditBox") |
GroupMembers:SetLabel(membersText) |
GroupMembers:SetCallback("OnEnter", function() GroupFrame:SetStatusText(membersStatus) end) |
GroupMembers:SetCallback("OnLeave", function() GroupFrame:SetStatusText("") end) |
GroupMembers:SetCallback("OnTextChanged", function() GroupMembers.button:Enable() end) |
GroupMembers.button:SetText(saveText) |
GroupFrame:AddChild(GroupMembers) |
local DeleteButton = AceGUI:Create("Button") |
DeleteButton:SetText(deleteText) |
DeleteButton:SetCallback("OnEnter", function() GroupFrame:SetStatusText(deleteStatus) end) |
DeleteButton:SetCallback("OnLeave", function() GroupFrame:SetStatusText("") end) |
GroupFrame:AddChild(DeleteButton) |
GroupDD:SetCallback("OnValueChanged", function(widget, event, key) |
selectedGroup = key |
GroupMembers:SetText(loadedStrings[key]) |
end) |
GroupMembers.button:SetScript("OnClick", function() |
self.db.char.groupStrings[selectedGroup] = GroupMembers:GetText() |
MassMailer:LoadGroups() |
GroupMembers.button:Disable() |
end) |
GroupMembers.button:SetScript("OnEnter", function() GroupFrame:SetStatusText(saveStatus) end) |
GroupMembers.button:SetScript("OnLeave", function() GroupFrame:SetStatusText("") end) |
GroupEdit.button:SetScript("OnClick", function() |
if (currentText and currentText:len() > 0) then |
self.db.char.groupNames[getn(self.db.char.groupNames)+1] = currentText |
self.db.char.groupStrings[getn(self.db.char.groupNames)+1] = "" |
selectedGroup = getn(self.db.char.groupNames) |
MassMailer:ReloadDropdowns() |
GroupEdit:SetText("") |
GroupDD:SetValue(selectedGroup) |
GroupMembers:SetText(loadedStrings[selectedGroup]) |
else |
print(groupNameError) |
end |
GroupEdit.button:Hide() |
end) |
DeleteButton:SetCallback("OnClick", function() |
if (selectedGroup) then |
table.remove(self.db.char.groupNames, selectedGroup) |
table.remove(self.db.char.groupStrings, selectedGroup) |
MassMailer:ReloadDropdowns() |
GroupDD:SetValue() |
GroupMembers:SetText("") |
else |
print(deleteError) |
end |
end) |
AceGUI:RegisterLayout("GroupEditor", function(content, children) |
children[1]:SetWidth(content:GetWidth()/2) |
children[2]:SetWidth(content:GetWidth()/2) |
children[2]:SetPoint("TOPLEFT", children[1].frame, "TOPRIGHT",0,0) |
children[3]:SetWidth(content:GetWidth()) |
children[3]:SetHeight(content:GetHeight() - children[1].frame:GetHeight() - 10) |
children[3]:SetPoint("TOPLEFT", children[1].frame, "BOTTOMLEFT",0,0) |
children[4]:ClearAllPoints() |
children[4]:SetWidth(95) |
children[4]:SetHeight(20) |
children[4]:SetPoint("BOTTOMLEFT", children[3].frame, "BOTTOMLEFT", 82, 2) |
end) |
GroupFrame:SetLayout("GroupEditor") |
end |
--[[------------------------------------------ |
-- Load the groups from Saved options |
--]]------------------------------------------ |
function MassMailer:LoadSavedOptions() |
MassMailer:LoadGroups() |
sliderValue = self.db.char.officerRank |
end |
function MassMailer:LoadGroups() |
loadedGroups = {} |
loadedStrings = {} |
local savedGroups = self.db.char.groupNames |
local savedStrings = self.db.char.groupStrings |
for i=1, getn(savedGroups), 1 do |
loadedGroups[i] = savedGroups[i] |
loadedStrings[i] = savedStrings[i] |
end |
end |
function MassMailer:ReloadDropdowns() |
MassMailer:LoadGroups() |
GroupDD:SetList(loadedGroups) |
CustomDD:SetList(loadedGroups) |
end |
--[[------------------------------------------ |
-- Handle the Send actions |
--]]------------------------------------------ |
-- |
-- Note: I've noticed that, despite my best efforts, |
-- the mails on the other end are sometimes received |
-- out of order (i.e. receipient will get them ordered |
-- like 3-2-4-1 or 1-4-2-3). After extensive testing, |
-- I'm pretty sure this is due to server lag, so I don't |
-- think there is much I can do about it. I'll |
-- investigate further, though. Maybe stick a delay in |
-- so the server has time to catch up? Seems clunky. |
-- |
function MassMailer:Sender(n, s, b) |
names = n |
subject = s |
body = b |
activeSend = true |
bIter = 1 |
if (getn(names) > 0) then |
if (nIter <= getn(names)) then |
activeName = names[nIter] |
MassMailer:SendMessage(activeName, subject, body) |
else |
nIter = 1 |
activeSend = false |
print(completeText) |
end |
else |
print(addressError) |
end |
end |
function MassMailer:SendMessage(name, subject, body) |
if (bIter <= getn(body)) then |
nextMessageReady = nil |
SendMail(name, subject.." ("..bIter.." / "..getn(body)..")", body[bIter]) |
else |
nIter = nIter + 1 |
MassMailer:Sender(names, subject, body) |
end |
end |
--[[------------------------------------------ |
-- String Parsing stuff |
--]]------------------------------------------ |
function MassMailer:ParseNames(str) --Parses the "To:" input into usuable strings |
local strTable = MassMailer:Split(str, ",") |
local i = 1 |
repeat |
strTable[i] = MassMailer:trim(strTable[i]) |
i = i + 1 |
until (i > getn(strTable)) |
return strTable |
end |
function MassMailer:ParseBody(str) --Parses the body into 500 character sections |
local textLength = str:len() |
local bodyTable = {} |
if (textLength > 500) then |
local firstPos = 1 |
local lastPos = 500 |
local i = 1 |
repeat |
local offSet = 0 |
local j = lastPos |
repeat |
j = j - 1 |
until (str:sub(j,j) == " " or j <= 0) |
if not (j <= 0) then |
offSet = lastPos - j |
lastPos = j |
end |
bodyTable[i] = str:sub(firstPos, lastPos) |
firstPos = firstPos + 500 - offSet |
lastPos = lastPos + 500 |
i = i + 1 |
if (lastPos > textLength) then |
lastPos = textLength |
bodyTable[i] = str:sub(firstPos, lastPos) |
end |
until (lastPos == textLength) |
return bodyTable |
else |
bodyTable[1] = str |
return bodyTable |
end |
end |
function MassMailer:trim(s) --trims out any extra spaces |
return s:match'^%s*(.*%S)' or '' |
end |
function MassMailer:Split(str, delim, maxNb) --splits the string based on the given delimiter |
if string.find(str, delim) == nil then |
return { str } |
end |
if maxNb == nil or maxNb < 1 then |
maxNb = 0 -- No limit |
end |
local result = {} |
local pat = "(.-)" .. delim .. "()" |
local nb = 0 |
local lastPos |
for part, pos in string.gmatch(str, pat) do |
nb = nb + 1 |
result[nb] = part |
lastPos = pos |
if nb == maxNb then break end |
end |
if nb ~= maxNb then |
result[nb + 1] = string.sub(str, lastPos) |
end |
return result |
end |
<Ui xsi:schemaLocation="http://www.blizzard.com/wow/ui/ ..\FrameXML\UI.xsd"> |
<Script file="Libs\LibStub\LibStub.lua"/> |
<Include file="Libs\AceAddon-3.0\AceAddon-3.0.xml"/> |
<Include file="Libs\AceConsole-3.0\AceConsole-3.0.xml"/> |
<Include file="Libs\AceEvent-3.0\AceEvent-3.0.xml" /> |
<Include file="Libs\AceDB-3.0\AceDB-3.0.xml" /> |
<Include file="Libs\AceGUI-3.0\AceGUI-3.0.xml"/> |
<Include file="Libs\AceLocale-3.0\AceLocale-3.0.xml" /> |
</Ui> |
FaraFrames.toc |
## Interface: 30300 |
## Author: Shirokuma |
## Title: Mass Mailer |
## Notes: Enhanced Mail Features |
## Version: 0.1 |
## SavedVariables: MassMailerDB |
embeds.xml |
locales\Locale-enUS.lua |
MassMailer.lua |
local L = LibStub("AceLocale-3.0"):NewLocale("MassMailer", "enUS", true) |
if L then |
--[[--------------------------------------------- |
-- Widget Texts |
--]]--------------------------------------------- |
L["MassMailer"] = "MassMailer" |
L["To: (Comma Separated)"] = "To: (Comma Separated)" |
L["Subject:"] = "Subject:" |
L["Body:"] = "Body:" |
L["Send"] = "Send" |
L["Address Book"] = "Address Book" |
L["Personal"] = "Personal" |
L["Friends"] = "Friends" |
L["Guild"] = "Guild" |
L["Officers"] = "Officers" |
L["Min Officer Rank:"] = "Min Officer Rank:" |
L["Arena"] = "Arena" |
L["2v2"] = "2v2" |
L["3v3"] = "3v3" |
L["5v5"] = "5v5" |
L["Select Group:"] = "Select Group:" |
L["Edit Groups"] = "Edit Groups" |
L["Group Editor"] = "Group Editor" |
L["Edit:"] = "Edit:" |
L["New:"] = "New:" |
L["Enter the Group members: (Comma separated)"] = "Enter the Group members: (Comma separated)" |
L["Delete Group"] = "Delete Group" |
L["Save"] = "Save" |
--[[--------------------------------------------- |
-- Error Texts |
--]]--------------------------------------------- |
L["MassMailer: There was an error sending your message."] = "MassMailer: There was an error sending your message." |
L["MassMailer: Please enter a character name."] = "MassMailer: Please enter a character name." |
L["MassMailer: Please enter a subject."] = "MassMailer: Please enter a subject." |
L["MassMailer: You have no friends!"] = "MassMailer: You have no friends!" |
L["MassMailer: Please enter a receipient to mail."] = "MassMailer: Please enter a receipient to mail." |
L["MassMailer: You are not in a guild!"] = "MassMailer: You are not in a guild!" |
L["MassMailer: Please enter a group name."] = "MassMailer: Please enter a group name." |
L["MassMailer: Please select a Group to delete."] = "MassMailer: Please select a Group to delete." |
L["MassMailer: You are not in an Arena team!"] = "MassMailer: You are not in an Arena team!" |
L["MassMailer: You are not in a 2v2 team!"] = "MassMailer: You are not in a 2v2 team!" |
L["MassMailer: You are not in a 3v3 team!"] = "MassMailer: You are not in a 3v3 team!" |
L["MassMailer: You are not in a 5v5 team!"] = "MassMailer: You are not in a 5v5 team!" |
--[[--------------------------------------------- |
-- Status Texts |
--]]--------------------------------------------- |
L["MassMailer: Send complete."] = "MassMailer: Send complete." |
L["Mail your entire friends list."] = "Mail your entire friends list." |
L["(Finding Friends list. This may take a moment...)"] = "(Finding Friends list. This may take a moment...)" |
L["Mail your entire guild."] = "Mail your entire guild." |
L["(Finding Guild Members. This may take a moment...)"] = "(Finding Guild Members. This may take a moment...)" |
L["Mail the guild officers."] = "Mail the guild officers." |
-- Reads: "(Find Officers of Rank X. This may take a moment...)" |
L["(Finding Officers of Rank "] = "(Finding Officers of Rank " |
L[". This may take a moment...)"] = ". This may take a moment...)" |
L["Rank 0 = GM, Rank 9 = Lowest Rank, etc."] = "Rank 0 = GM, Rank 9 = Lowest Rank, etc." |
L["Mail your entire 2v2 team."] = "Mail your entire 2v2 team." |
L["Mail your entire 3v3 team."] = "Mail your entire 3v3 team." |
L["Mail your entire 5v5 team."] = "Mail your entire 5v5 team." |
L["Select a custom group."] = "Select a custom group." |
L["Create/Edit custom groups."] = "Create/Edit custom groups." |
--Reads: "Message is X characters long. Will be split into X parts." |
L["Message is "] = "Message is " |
L[" characters long. Will be split into at least "] = " characters long. Will be split into at least " |
L[" parts."] = " parts." |
L["Select a pre-existing group to edit."] = "Select a pre-existing group to edit." |
L["Create a new group."] = "Create a new group." |
L["Enter the Group Members, seperated by commas."] = "Enter the Group Members, seperated by commas." |
L["Deletes the currently selected Group."] = "Deletes the currently selected Group." |
L["Save your changes to the Group."] = "Save your changes to the Group." |
L["(Finding Arena team members. This may take a moment...)"] = "(Finding Arena team members. This may take a moment...)" |
end |
Ace3 Release - Revision r907 (December 16th, 2009) |
--------------------------------------------------- |
- AceGUI-3.0: Frame: Properly save the width in the status table. |
- AceConfigCmd-3.0: Properly handle help output of inline groups with a different handler. (Ticket #101) |
- AceConfigDialog-3.0: Don't bail out and error when a dialogControl was invalid, instead show the error and fallback to the default control for that type. |
- AceConfigDialog-3.0: Fix a hickup with the OnUpdate script not getting upgraded properly in some situations. |
Ace3 Release - Revision r900 (December 8th, 2009) |
-------------------------------------------------- |
- AceGUI-3.0: Alot of visual fixes regarding margins and general widget styles. |
- AceGUI-3.0: Ability to accept links for EditBox Widget (Ticket #21) |
- AceGUI-3.0: ScrollFrame: Hide the scrollbar when there is no overflowing content, and allow the Layout functions to use that space for widgets. |
- AceGUI-3.0: DropDown: Added a GetValue() API to the Widget (Ticket #69) |
- AceGUI-3.0: Button: Pass the arguments of the OnClick handler to the OnClick callback (Ticket #57) |
- AceGUI-3.0: add a Window container, basically a plain window with close button |
- AceGUI-3.0: Add support for inline descriptions to the checkbox widget. |
- AceGUI-3.0: Added an API to the Window container to disable the user-resizing of the same. (Ticket #80) |
- AceGUI-3.0: TreeGroup: Allow iconCoords to be passed for the tree elements. (Ticket #59) |
- AceGUI-3.0: Slider: Add a more visible backdrop/border around the manual input area (Ticket #98, #46) |
- AceGUI-3.0: Allow displaying a image in front of the checkbox label. (Ticket #82) |
- AceConfig-3.0: Added an experimental "descStyle" member to all option table nodes that allows you to control the way the description is presented. |
Supported values are "tooltip" for the old behaviour, and "inline" for a inline display of the description, pending support in AceGUI-3.0 widgets. |
- AceConfigCmd-3.0: Properly parse functions and methods supplied for the "hidden" option table member. (Ticket #96) |
- AceConfigDialog-3.0: Fix the unpacking of the basepath arguments when internally calling :Open (Ticket #90) |
- AceConfigDialog-3.0: Properly refresh BlizOptions Windows which are registered with a path on NotifyChange. (Ticket #93) |
- AceConfigDialog-3.0: Allow image/imageCoords on toogle elements (Note that the width/height of the image on the toggle cannot be changed) (Ticket #82) |
- AceConfigDialog-3.0: Pass the groups "name" tag to DropDownGroups as the title. (Ticket #79) |
- AceDB-3.0: Remove the metatable from the DB before removing defaults, so we don't accidentally invoke it in the process. (Ticket #66) |
- AceDB-3.0: Don't save the profileKeys for namespaces, since we use the profile of the parent DB anyway. This will cut down on SV complexity when using alot of namespaces. |
- AceDB-3.0: Don't fire the OnProfileReset callback when copying a profile. |
- AceDBOptions-3.0: Show the current profile on the dialog. (Ticket #56) |
- AceComm-3.0: Add callbacks for message chunks going out the wire (via CTL). Useful for displaying progress for very large messages. |
- AceConsole-3.0: Add :Printf() so you don't have to do Print(format()) |
Ace3 Beta - Revision 820 (August 7th, 2009) |
-------------------------------------------- |
- AceComm-3.0: Updated ChatThrottleLib to v21 |
- AceGUI-3.0: Fixed a glitch in the TabGroup code that caused tabs to be unresponsive under rare conditions. (Ticket #38) |
- AceGUI-3.0: Consistent "disabled" behaviour of all widgets. (Ticket #47) |
- AceGUI-3.0: Changed the way widgets are handled on release to avoid a crash in the game client. (Ticket #49) |
- AceGUI-3.0: Fixed a glitch in the button graphics. (Ticket #58) |
- AceGUI-3.0: Localized the "Close" Text on the Frame widget. |
Ace3 Beta - Revision 803 (April 14th, 2009) |
-------------------------------------------- |
- AceConfig-3.0: Allow spaces in the keys of config tables. Spaces will be changed on the fly to underscores in AceConfigCmd-3.0 - there is no collision check in place, yet. |
- AceConfig-3.0: Support a "fontSize" attribute to the description type. Possible values are "small" (default), "medium" and "large". |
- AceConfigDialog-3.0: Fixed an error that would occur when calling InterfaceOptionsFrame_OpenToCategory from within an event handler in a Blizzard Options integrated frame. (Ticket #33) |
- AceConfigDialog-3.0: The "execute" type does now recognize the "image" attributes, and will display a clickable icon instead of the button when an image is supplied. (Ticket #35) |
- AceConfigDialog-3.0: Pass icons defined in the option table to the TreeGroup widget (Ticket #20) |
- AceConfigDialog-3.0: Fixed a bug that caused an empty group widget to be drawn if all groups were hidden. |
- AceConfigCmd-3.0: Improved the behaviour of select and multiselect elements. (Ticket #26) |
- AceDB-3.0: Add a GetNamespace function to the DB Objects which returns an existing namespace from the DB object. |
- AceGUI-3.0 Slider Widget: Properly show percentage values as min/max if isPercent is true. (Ticket #32) |
- AceGUI-3.0: Fixed an error in the TreeGroup Widget that caused execution to stop if no name was provided. |
- AceGUI-3.0: Fixed the behaviour of the MultiLineEditbox Widget (Accept button not clickable). (Ticket #28) |
- AceGUI-3.0: TabGroup: Set a maximum width for tabs based on the size of the widget. (Ticket #34) |
- AceGUI-3.0: Added a new InteractiveLabel with OnEnter/OnLeave/OnClick callbacks and a highlight texture |
- AceGUI-3.0: Add SetFont and SetFontObject functions to the Label widget (and the new InteractiveLabel) |
- AceGUI-3.0: Support icons in the TreeGroup display. (Ticket #20) |
- AceGUI-3.0: Added a new :SetRelativeWidth Widget-API that allows you to set the width of widgets relative to their container. |
- AceGUI-3.0: Alot of fixes, tweaks and consistency changes. |
Ace3 Beta - Revision 741 (Feb 15th, 2009) |
-------------------------------------------- |
- AceDBOptions-3.0: Disable the "Copy From" and "Delete" dropdowns if there are no profiles to choose from. (Ticket #19) |
- AceGUI-3.0: Improve TabGroup visual style - only stretch them to the full width if they would use more then 75% of the exisiting space. |
- AceGUI-3.0: Added a third optional argument to <container>:AddChild() to specify the position for the new widget. (Ticket #22) |
- AceConfigCmd-3.0: Improve help output when viewing groups. |
- AceConfigDialog-3.0: Refresh the Options Panel after a confirmation is canceled to reset the value to its previous value. (Ticket #23) |
- AceDB-3.0: Fix a data inconsistency when using false as a table key. (Ticket #25) |
Ace3 Beta - Revision 722 (Jan 4th, 2009) |
-------------------------------------------- |
- AceHook-3.0: Fix :SecureHookScript to not fail on previously empty scripts since frame:HookScript does nothing at all in that case. (Ticket #16) |
- AceLocale-3.0: Implement 'silent' option for :NewLocale to disable the warnings on unknown entrys (Ticket #18) |
- AceTimer-3.0: Implement :TimeLeft(handle) function (Ticket #10) |
- AceGUI-3.0: Fix TabGroup tab resizing to be consistent |
- AceGUI-3.0: Fixed EditBox alignment when the label is disabled (Ticket #13) |
- AceDB-3.0: Implement OnProfileShutdown callback (Ticket #7) |
- AceDBOptions-3.0: Updated esES and ruRU locale |
Ace3 Beta - Revision 706 (Oct 18th, 2008) |
-------------------------------------------- |
- First Beta release after WoWAce move |
- Removed WoW 2.4.x compat layer |
- AceGUI-3.0: Fix disabling of the Multiline Editbox |
- AceGUI-3.0: Improvements to the Keybinding Widget |
Ace3 Beta - Revision 81437 (Sept 6th, 2008) |
-------------------------------------------- |
- AceConfigDialog-3.0: the confirm callback will now receive the new value that is being set (same signature as the validate callback) |
- AceConfigDialog-3.0: :Close and :CloseAll are now safe to call from within callbacks. |
- AceGUI-3.0: Added new methods to the widget base table, see ACE-205 for full reference |
- AceGUI-3.0: Various fixes to Widgets and recycling process |
- Now compatible with WoW 3.0 (compat layer is to be removed upon 3.0 release) |
Ace3 Beta - Revision 76325 (June 9th, 2008) |
-------------------------------------------- |
- AceGUI-3.0: Finish Multiselect support for the Dropdown widget (nargiddley) |
- AceGUI-3.0: Re-write TabGroup layouting (nargiddley) |
- AceGUI-3.0: TreeGroup: Add :EnableButtonTooltips(enable) to make the default tooltips on the tree optional, enabled by default. (nargiddley) |
- AceGUI-3.0: TabGroup: Add OnTabEnter and OnTabLeave Callbacks (nargiddley) |
- AceConfigDialog-3.0: Add :SelectGroup(appName, ...) - Selects the group given by the path specified then refreshes open windows. (nargiddley) |
- AceConfigDialog-3.0: :Open now accepts an optional path, when given will open the window with only the given group and its children visible (nargiddley) |
- AceConfigDialog-3.0: :AddToBlizOptions now accepts an optional path, this will add the config page to display the specified group and its children only. (nargiddley) |
- AceConfigDialog-3.0: ACE-189: allow multiselect to be shown as a dropdown by setting dialogControl = "Dropdown" (nargiddley) |
- AceConfigDialog-3.0: Add Custom tooltips to the TreeGroup and TabGroup, shows both name and desc for the group. (nargiddley) |
- AceConfigCmd-3.0: ACE-195: Remove unneeded references to .confirm, will no longer error when .confirm is a boolean (nargiddley) |
- AceAddon-3.0: Allow for an optional first argument to NewAddon to be a table to be used as the base for the addon. (ammo) |
Ace3 Beta - Revision 74633 (May 19th, 2008) |
-------------------------------------------- |
- AceTimer-3.0: ACE-173: don't error on nil handle for CancelTimer(), just bail out early. (ammo) |
- AceGUI-3.0: ACE-161, ACE-180, ACE-181: New and improved DropDown widget (originally coded by Borlox) (nargiddley,nevcairiel) |
- AceGUI-3.0: AceGUI will call OnWidthSet and OnHeightSet as frames resize (nargiddley) |
- AceGUI-3.0: TabGroup: Use OptionsFrameTabButtonTemplate for tabs (nargiddley) |
- AceGUI-3.0: TabGroup: Tabs now span multiple lines when there are too many to fit in the width of the frame (nargiddley) |
- AceGUI-3.0: TreeGroup: Tree is now sizable by dragging, orig patch by yssaril (nargiddley) |
- AceGUI-3.0: Flow layout will now reduce widgets width to fit rather than leaving them sticking out the side of container widgets (nargiddley) |
- AceGUI-3.0: Dropdowns will no longer be left open in the background when the frame is clicked or other widgets are activated (nargiddley) |
- AceGUI-3.0: ACE-159: Rename Release to OnRelease and Acquire to OnAcquire for widgets. (nargiddley) |
- AceGUI-3.0: ACE-171: add IsVisible and IsShown methods to the widget metatable (nargiddley) |
- AceGUI-3.0: ACE-164: add tooltips to tree to show full text of childs that got clipped (ammo) |
- AceGUI-3.0: ACE-174: make buttons in AceGUI-3.0 locale independant (ammo) |
- AceGUI-3.0: ACE-166: fix treegroup visual bug (ammo) |
- AceGUI-3.0: ACE-184: make numeric entry for slider more intuitive (ammo) |
- AceConfigCmd-3.0: ACE-172 - ignore description in cmd (ammo) |
- AceConsole-3.0: nolonger check for existance of slashcommands, overwrite where needed. Last one wins, this enables AddonLoader to X-LoadOn-Slash and override the slashcommand from AddonLoader slashcommand with an Ace3 one. (Ammo) |
Ace3 Beta - Revision 69509 (April 13th, 2008) |
--------------------------------------------- |
- AceComm-3.0: turn off error messages when receiving invalid multi-part messages (its happening on login etc) (nevcairiel) |
- AceDBOptions-3.0: shorten info text at top to prevent scrollbars. (nevcairiel) |
- AceHook-3.0: ACE-162: fix unhooking of objects that were not actually hooked (nevcairiel) |
- AceDB-3.0: fire the DB callbacks after the namespaces changed their profile as well (nevcairiel) |
- AceDB-3.0: namespaces can now be individually reset using :ResetProfile() on the namespace directly (nevcairiel) |
- AceDB-3.0: added a optional argument to :ResetProfile to not populate the reset to all namespaces (so the main profile can reset individually without reseting all namespaces too) (nevcairiel) |
Ace3 Beta - Revision 66329 (March 27th, 2008) |
--------------------------------------------- |
- Overall 2.4 clean ups - removing 2.4 checks and work arounds (nevcairiel) |
- AceBucket-3.0: clear the timer reference when unregistering a bucket to prevent a error when unregistering a bucket that was never fired (nevcairiel) |
- AceAddon-3.0: Bugfix when enabling/disabling modules from the parents OnEnable after disabling / enabling the parent addon. (ammo) |
- AceGUI-3.0: Don't parent the BlizOptionsGroup widget to UIParent and Hide it by default. Fixes stray controls on the screen. (nargiddley) |
- AceConfigDialog-3.0: Config windows without a default size won't incorrectly get a default size from a previously open window. (nargiddley) |
- AceDBOptions-3.0: added zhCN and zhTW locale (nevcairiel) |
Ace3 Beta - Revision 65665 (March 25th, 2008) |
--------------------------------------------- |
- AceGUI-3.0: ACE-139: Changed all Widgets to resemble the Blizzard 2.4 Options Style (nevcairiel) |
- AceGUI-3.0: Fixed "List"-Layout not reporting new width to "fill"-mode widgets (mikk) |
- AceGUI-3.0: added :SetColor to the Label widget (nevcairiel) |
- AceGUI-3.0: ACE-132: ColorPicker: added checkers texture for better alpha channel display, and fixed "white"-texture bug (nevcairiel,nargiddley,ammo) |
- AceConfig-3.0: ACE-113: Added uiName, uiType, handler, option, type to the info table (nevcairiel,nargiddley) |
- AceConfigDialog-3.0: ACE-139: Adjusted for 2.4 options panels (nevcairiel) |
- AceConfigDialog-3.0: Use "width" parameter for the description widget (if present) (nevcairiel) |
- AceConfigDialog-3.0: ACE-135: Add support for specifying a rowcount for multiline editboxes (nargiddley) |
- AceConfigDialog-3.0: :AddToBlizOptions will return the frame registered so you can use it in InterfaceOptionsFrame_OpenToFrame (nevcairiel) |
- AceConfigCmd-3.0: handle "hidden" in help-output (nevcairiel) |
- AceHook-3.0: fix unhooking of secure hooks (nevcairiel) |
- AceDBOptions-3.0: add optional argument to GetOptionsTable(db[, noDefaultProfiles]) - if set to true will not show the default profiles in the profile selection (nevcairiel) |
- AceDBOptions-3.0: added koKR locale (nevcairiel) |
- Ace3 Standalone: Removed the "Ace3" Category from the 2.4 options panel (nevcairiel) |
Ace3 Beta - Revision 64176 (March 10th, 2008) |
--------------------------------------------- |
- AceGUI-3.0: Improve Alpha handling for the ColorPicker widget, ColorPicker widget closes the ColorPickerFrame before opening to prevent values getting carried over (nargiddley) |
- AceGUI-3.0: The Slider widget will only react to the mousewheel after it has been clicked (anywhere including the label) to prevent accidental changes to the value when trying to scroll the container it is in (nargiddley) |
- AceGUI-3.0: The TreeGroup widget is scrollable with the mousewheel (nargiddley) |
- AceGUI-3.0: ACE-154: Fix frame levels in more cases to prevent widgets ending up behind their containers (nargiddley) |
- AceConfigDialog: Color picker obeys hasAlpha on the color type (nargiddley) |
- AceConfigDialog-3.0: ACE-155: Make sure that the selected group is type='group' when checking if it exists (nargiddley) |
- AceDBOptions-3.0: added frFR locale (nevcairiel) |
Ace3 Beta - Revision 63886 (March 8th, 2008) |
--------------------------------------------- |
- AceDBOptions-3.0: new library to provide a Ace3Options table to control the AceDB-3.0 profiles (nevcairiel) |
- AceDB-3.0: add "silent" option to DeleteProfile and CopyProfile when we deal with namespaces (nevcairiel) |
- AceDB-3.0: implement library upgrade path (nevcairiel) |
- AceDB-3.0: ACE-146: fix problem with non-table values overruling ['*']-type defaults (nevcairiel) |
- AceConsole-3.0: treat |T|t texture links similar to |H|h|h links. (ammo) |
- AceGUI-3.0: Use Blizzard Templates for the EditBox and DropDown widget (nevcairiel) |
- AceBucket-3.0: ACE-150: callback is now optional, if not supplied will use the eventname as method name (only possible if one event is supplied, and not a event table) (nevcairiel) |
- tests: adjust tests for AceGUI and AceConsole changes (nevcairiel) |
Ace3 Beta - Revision 63220 (Feb 29th, 2008) |
--------------------------------------------- |
- AceTimer-3.0: CancelAllTimers() now cancels silent (elkano) |
- AceConfigDialog: Add :SetDefaultSize(appName, width, height), sets the size the dialog will open to. Does not effect already open windows. (nargiddley) |
- AceConfigDialog: Fix typo in type check for range values (nargiddley) |
- AceGUI: ColorPicker widget will correctly fire OnValueChanged for the cancel event of the colorpicker popup. Reset ColorPicker's color on Acquire. (nargiddley) |
- AceGUI: Fix Spelling of Aquire -> Acquire for widgets, all custom widgets will need to be updated. A warning will be printed for widgets not upgraded yet. (nargiddley) |
- AceConfigCmd-3.0: add simple coloring to slashcommand output. (ammo) |
- AceConsole-3.0: add some color to :Print (ammo) |
- AceAddon-3.0: set error level on library embedding to point to the :NewAddon call (nevcairiel) |
Ace3 Beta - Revision 62182 (Feb 20th, 2008) |
--------------------------------------------- |
- Ace3 StandAlone: Add a page to the Blizzard 2.4 Interface Options with icons to open dialogs for configs registered when installed standalone (nargiddley) |
- AceConfigDialog: type = 'description' now uses the fields image and imageCoords instead of icon and iconCoords, add imageWidth and imageHeight (nargiddley) |
- AceConfigDialog: Add :AddToBlizzardOptions(appName, name), this will add the specified config to the Blizzard Options pane new in 2.4. This will only be available if running on the 2.4 PTR (nargiddley) |
- AceDB: fix GetProfiles() when setting the same profile twice (nevcairiel) |
- AceDB: bail out of :SetProfile early when trying to set to the same profile (nevcairiel) |
- AceDB: add nil checks to metatable handling (nevcairiel) |
- AceDB: clear tables that are empty after defaults removal (nevcairiel) |
- AceGUI: Fix a couple of layout bugs causing the width of groups to be wrong (nargiddley) |
- AceGUI: Add Icon widget (nargiddley) |
- AceGUI: Allow room for the border in the BlizOptionsGroup widget (nargiddley) |
- AceGUI: Button and Keybinding use UIPanelButtonTemplate2 (nargiddley) |
- AceConsole-3.0: Fix bug where no table for [self] was created when registering weak commands (ammo) |
- AceTimer-3.0: add missing :OnEmbedDisable (ammo) |
- AceAddon-3.0: added :GetName() that will always return the "real" name of a addon or module object without any prefixes (nevcairiel) |
Ace3 Beta - Revision 60697 (Feb 9th, 2008) |
--------------------------------------------- |
- CallbackHandler-1.0: remove unnecessary table creation if a event is fired thats not registered (nevcairiel) |
- AceAddon-3.0: fixed a bug with recursive addon loading (nevcairiel) |
- AceGUI: Update TabGroup's tablist format, tabs are selected by value not index (nargiddley) |
- AceGUI: Add MultiLineEditBox widget (nargiddley, originally by bam) |
- AceGUI: Small fix to the flow layout preventing controls overlapping in some cases (nargiddley) |
- AceConfigDialog: Implement control and dialogControl for types 'input' and 'select' (nargiddley) |
- AceConfigDialog: Add support for multiline = true on type = 'input' (nargiddley) |
- AceConfigDialog: Fix an error when all groups are hidden in a group with childGroups = 'select' (nargiddley) |
- AceConfigDialog: type = 'description' will now show .icon as an image with its text (nargiddley) |
- AceConfigDialog: multiline inputs are no longer forced to width = "full" (nargiddley) |
- AceConfigDialog: bug fix when loading without AceConsole present (nevcairiel) |
Ace3 Beta - Revision 60545 (Feb 7th, 2008) |
--------------------------------------------- |
- AceGUI: SetToplevel(true) for the Frame widget, multiple open windows should play nice together now (nargiddley) |
- AceGUI: Move Frames to the FULLSCREEN_DIALOG strata (nargiddley) |
- AceGUI: Dropdown, Editbox and Keybinding labels grey out when disabled (nargiddley) |
- AceGUI: Add OnClick callback to the TreeGroup widget (nargiddley) |
- AceConfigDialog: Confirm popups will be above the config window (nargiddley) |
Ace3 Beta - Revision 60163 (Feb 3rd, 2008) |
--------------------------------------------- |
- Initial Beta release |
<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="AceLocale-3.0.lua"/> |
</Ui> |
--- **AceLocale-3.0** manages localization in addons, allowing for multiple locale to be registered with fallback to the base locale for untranslated strings. |
-- @class file |
-- @name AceLocale-3.0 |
-- @release $Id: AceLocale-3.0.lua 895 2009-12-06 16:28:55Z nevcairiel $ |
local MAJOR,MINOR = "AceLocale-3.0", 2 |
local AceLocale, oldminor = LibStub:NewLibrary(MAJOR, MINOR) |
if not AceLocale then return end -- no upgrade needed |
-- Lua APIs |
local assert, tostring, error = assert, tostring, error |
local setmetatable, rawset, rawget = setmetatable, rawset, rawget |
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded |
-- List them here for Mikk's FindGlobals script |
-- GLOBALS: GAME_LOCALE, geterrorhandler |
local gameLocale = GetLocale() |
if gameLocale == "enGB" then |
gameLocale = "enUS" |
end |
AceLocale.apps = AceLocale.apps or {} -- array of ["AppName"]=localetableref |
AceLocale.appnames = AceLocale.appnames or {} -- array of [localetableref]="AppName" |
-- This metatable is used on all tables returned from GetLocale |
local readmeta = { |
__index = function(self, key) -- requesting totally unknown entries: fire off a nonbreaking error and return key |
rawset(self, key, key) -- only need to see the warning once, really |
geterrorhandler()(MAJOR..": "..tostring(AceLocale.appnames[self])..": Missing entry for '"..tostring(key).."'") |
return key |
end |
} |
-- This metatable is used on all tables returned from GetLocale if the silent flag is true, it does not issue a warning on unknown keys |
local readmetasilent = { |
__index = function(self, key) -- requesting totally unknown entries: return key |
rawset(self, key, key) -- only need to invoke this function once |
return key |
end |
} |
-- Remember the locale table being registered right now (it gets set by :NewLocale()) |
-- NOTE: Do never try to register 2 locale tables at once and mix their definition. |
local registering |
-- local assert false function |
local assertfalse = function() assert(false) end |
-- This metatable proxy is used when registering nondefault locales |
local writeproxy = setmetatable({}, { |
__newindex = function(self, key, value) |
rawset(registering, key, value == true and key or value) -- assigning values: replace 'true' with key string |
end, |
__index = assertfalse |
}) |
-- This metatable proxy is used when registering the default locale. |
-- It refuses to overwrite existing values |
-- Reason 1: Allows loading locales in any order |
-- Reason 2: If 2 modules have the same string, but only the first one to be |
-- loaded has a translation for the current locale, the translation |
-- doesn't get overwritten. |
-- |
local writedefaultproxy = setmetatable({}, { |
__newindex = function(self, key, value) |
if not rawget(registering, key) then |
rawset(registering, key, value == true and key or value) |
end |
end, |
__index = assertfalse |
}) |
--- Register a new locale (or extend an existing one) for the specified application. |
-- :NewLocale will return a table you can fill your locale into, or nil if the locale isn't needed for the players |
-- game locale. |
-- @paramsig application, locale[, isDefault[, silent]] |
-- @param application Unique name of addon / module |
-- @param locale Name of the locale to register, e.g. "enUS", "deDE", etc. |
-- @param isDefault If this is the default locale being registered (your addon is written in this language, generally enUS) |
-- @param silent If true, the locale will not issue warnings for missing keys. Can only be set on the default locale. |
-- @usage |
-- -- enUS.lua |
-- local L = LibStub("AceLocale-3.0"):NewLocale("TestLocale", "enUS", true) |
-- L["string1"] = true |
-- |
-- -- deDE.lua |
-- local L = LibStub("AceLocale-3.0"):NewLocale("TestLocale", "deDE") |
-- if not L then return end |
-- L["string1"] = "Zeichenkette1" |
-- @return Locale Table to add localizations to, or nil if the current locale is not required. |
function AceLocale:NewLocale(application, locale, isDefault, silent) |
if silent and not isDefault then |
error("Usage: NewLocale(application, locale[, isDefault[, silent]]): 'silent' can only be specified for the default locale", 2) |
end |
-- GAME_LOCALE allows translators to test translations of addons without having that wow client installed |
-- Ammo: I still think this is a bad idea, for instance an addon that checks for some ingame string will fail, just because some other addon |
-- gives the user the illusion that they can run in a different locale? Ditch this whole thing or allow a setting per 'application'. I'm of the |
-- opinion to remove this. |
local gameLocale = GAME_LOCALE or gameLocale |
if locale ~= gameLocale and not isDefault then |
return -- nop, we don't need these translations |
end |
local app = AceLocale.apps[application] |
if not app then |
app = setmetatable({}, silent and readmetasilent or readmeta) |
AceLocale.apps[application] = app |
AceLocale.appnames[app] = application |
end |
registering = app -- remember globally for writeproxy and writedefaultproxy |
if isDefault then |
return writedefaultproxy |
end |
return writeproxy |
end |
--- Returns localizations for the current locale (or default locale if translations are missing). |
-- Errors if nothing is registered (spank developer, not just a missing translation) |
-- @param application Unique name of addon / module |
-- @param silent If true, the locale is optional, silently return nil if it's not found (defaults to false, optional) |
-- @return The locale table for the current language. |
function AceLocale:GetLocale(application, silent) |
if not silent and not AceLocale.apps[application] then |
error("Usage: GetLocale(application[, silent]): 'application' - No locales registered for '"..tostring(application).."'", 2) |
end |
return AceLocale.apps[application] |
end |
<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="AceHook-3.0.lua"/> |
</Ui> |
--- **AceHook-3.0** offers safe Hooking/Unhooking of functions, methods and frame scripts. |
-- Using AceHook-3.0 is recommended when you need to unhook your hooks again, so the hook chain isn't broken |
-- when you manually restore the original function. |
-- |
-- **AceHook-3.0** can be embeded into your addon, either explicitly by calling AceHook:Embed(MyAddon) or by |
-- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object |
-- and can be accessed directly, without having to explicitly call AceHook itself.\\ |
-- It is recommended to embed AceHook, otherwise you'll have to specify a custom `self` on all calls you |
-- make into AceHook. |
-- @class file |
-- @name AceHook-3.0 |
-- @release $Id: AceHook-3.0.lua 877 2009-11-02 15:56:50Z nevcairiel $ |
local ACEHOOK_MAJOR, ACEHOOK_MINOR = "AceHook-3.0", 5 |
local AceHook, oldminor = LibStub:NewLibrary(ACEHOOK_MAJOR, ACEHOOK_MINOR) |
if not AceHook then return end -- No upgrade needed |
AceHook.embeded = AceHook.embeded or {} |
AceHook.registry = AceHook.registry or setmetatable({}, {__index = function(tbl, key) tbl[key] = {} return tbl[key] end }) |
AceHook.handlers = AceHook.handlers or {} |
AceHook.actives = AceHook.actives or {} |
AceHook.scripts = AceHook.scripts or {} |
AceHook.onceSecure = AceHook.onceSecure or {} |
AceHook.hooks = AceHook.hooks or {} |
-- local upvalues |
local registry = AceHook.registry |
local handlers = AceHook.handlers |
local actives = AceHook.actives |
local scripts = AceHook.scripts |
local onceSecure = AceHook.onceSecure |
-- Lua APIs |
local pairs, next, type = pairs, next, type |
local format = string.format |
local assert, error = assert, error |
-- WoW APIs |
local issecurevariable, hooksecurefunc = issecurevariable, hooksecurefunc |
local _G = _G |
-- functions for later definition |
local donothing, createHook, hook |
local protectedScripts = { |
OnClick = true, |
} |
-- upgrading of embeded is done at the bottom of the file |
local mixins = { |
"Hook", "SecureHook", |
"HookScript", "SecureHookScript", |
"Unhook", "UnhookAll", |
"IsHooked", |
"RawHook", "RawHookScript" |
} |
-- AceHook:Embed( target ) |
-- target (object) - target object to embed AceHook in |
-- |
-- Embeds AceEevent into the target object making the functions from the mixins list available on target:.. |
function AceHook:Embed( target ) |
for k, v in pairs( mixins ) do |
target[v] = self[v] |
end |
self.embeded[target] = true |
-- inject the hooks table safely |
target.hooks = target.hooks or {} |
return target |
end |
-- AceHook:OnEmbedDisable( target ) |
-- target (object) - target object that is being disabled |
-- |
-- Unhooks all hooks when the target disables. |
-- this method should be called by the target manually or by an addon framework |
function AceHook:OnEmbedDisable( target ) |
target:UnhookAll() |
end |
function createHook(self, handler, orig, secure, failsafe) |
local uid |
local method = type(handler) == "string" |
if failsafe and not secure then |
-- failsafe hook creation |
uid = function(...) |
if actives[uid] then |
if method then |
self[handler](self, ...) |
else |
handler(...) |
end |
end |
return orig(...) |
end |
-- /failsafe hook |
else |
-- all other hooks |
uid = function(...) |
if actives[uid] then |
if method then |
return self[handler](self, ...) |
else |
return handler(...) |
end |
elseif not secure then -- backup on non secure |
return orig(...) |
end |
end |
-- /hook |
end |
return uid |
end |
function donothing() end |
function hook(self, obj, method, handler, script, secure, raw, forceSecure, usage) |
if not handler then handler = method end |
-- These asserts make sure AceHooks's devs play by the rules. |
assert(not script or type(script) == "boolean") |
assert(not secure or type(secure) == "boolean") |
assert(not raw or type(raw) == "boolean") |
assert(not forceSecure or type(forceSecure) == "boolean") |
assert(usage) |
-- Error checking Battery! |
if obj and type(obj) ~= "table" then |
error(format("%s: 'object' - nil or table expected got %s", usage, type(obj)), 3) |
end |
if type(method) ~= "string" then |
error(format("%s: 'method' - string expected got %s", usage, type(method)), 3) |
end |
if type(handler) ~= "string" and type(handler) ~= "function" then |
error(format("%s: 'handler' - nil, string, or function expected got %s", usage, type(handler)), 3) |
end |
if type(handler) == "string" and type(self[handler]) ~= "function" then |
error(format("%s: 'handler' - Handler specified does not exist at self[handler]", usage), 3) |
end |
if script then |
if not secure and obj:IsProtected() and protectedScripts[method] then |
error(format("Cannot hook secure script %q; Use SecureHookScript(obj, method, [handler]) instead.", method), 3) |
end |
if not obj or not obj.GetScript or not obj:HasScript(method) then |
error(format("%s: You can only hook a script on a frame object", usage), 3) |
end |
else |
local issecure |
if obj then |
issecure = onceSecure[obj] and onceSecure[obj][method] or issecurevariable(obj, method) |
else |
issecure = onceSecure[method] or issecurevariable(method) |
end |
if issecure then |
if forceSecure then |
if obj then |
onceSecure[obj] = onceSecure[obj] or {} |
onceSecure[obj][method] = true |
else |
onceSecure[method] = true |
end |
elseif not secure then |
error(format("%s: Attempt to hook secure function %s. Use `SecureHook' or add `true' to the argument list to override.", usage, method), 3) |
end |
end |
end |
local uid |
if obj then |
uid = registry[self][obj] and registry[self][obj][method] |
else |
uid = registry[self][method] |
end |
if uid then |
if actives[uid] then |
-- Only two sane choices exist here. We either a) error 100% of the time or b) always unhook and then hook |
-- choice b would likely lead to odd debuging conditions or other mysteries so we're going with a. |
error(format("Attempting to rehook already active hook %s.", method)) |
end |
if handlers[uid] == handler then -- turn on a decative hook, note enclosures break this ability, small memory leak |
actives[uid] = true |
return |
elseif obj then -- is there any reason not to call unhook instead of doing the following several lines? |
if self.hooks and self.hooks[obj] then |
self.hooks[obj][method] = nil |
end |
registry[self][obj][method] = nil |
else |
if self.hooks then |
self.hooks[method] = nil |
end |
registry[self][method] = nil |
end |
handlers[uid], actives[uid], scripts[uid] = nil, nil, nil |
uid = nil |
end |
local orig |
if script then |
orig = obj:GetScript(method) or donothing |
elseif obj then |
orig = obj[method] |
else |
orig = _G[method] |
end |
if not orig then |
error(format("%s: Attempting to hook a non existing target", usage), 3) |
end |
uid = createHook(self, handler, orig, secure, not (raw or secure)) |
if obj then |
self.hooks[obj] = self.hooks[obj] or {} |
registry[self][obj] = registry[self][obj] or {} |
registry[self][obj][method] = uid |
if not secure then |
self.hooks[obj][method] = orig |
end |
if script then |
-- If the script is empty before, HookScript will not work, so use SetScript instead |
-- This will make the hook insecure, but shouldnt matter, since it was empty before. |
-- It does not taint the full frame. |
if not secure or orig == donothing then |
obj:SetScript(method, uid) |
elseif secure then |
obj:HookScript(method, uid) |
end |
else |
if not secure then |
obj[method] = uid |
else |
hooksecurefunc(obj, method, uid) |
end |
end |
else |
registry[self][method] = uid |
if not secure then |
_G[method] = uid |
self.hooks[method] = orig |
else |
hooksecurefunc(method, uid) |
end |
end |
actives[uid], handlers[uid], scripts[uid] = true, handler, script and true or nil |
end |
--- Hook a function or a method on an object. |
-- The hook created will be a "safe hook", that means that your handler will be called |
-- before the hooked function ("Pre-Hook"), and you don't have to call the original function yourself, |
-- however you cannot stop the execution of the function, or modify any of the arguments/return values.\\ |
-- This type of hook is typically used if you need to know if some function got called, and don't want to modify it. |
-- @paramsig [object], method, [handler], [hookSecure] |
-- @param object The object to hook a method from |
-- @param method If object was specified, the name of the method, or the name of the function to hook. |
-- @param handler The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked function) |
-- @param hookSecure If true, AceHook will allow hooking of secure functions. |
-- @usage |
-- -- create an addon with AceHook embeded |
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("HookDemo", "AceHook-3.0") |
-- |
-- function MyAddon:OnEnable() |
-- -- Hook ActionButton_UpdateHotkeys, overwriting the secure status |
-- self:Hook("ActionButton_UpdateHotkeys", true) |
-- end |
-- |
-- function MyAddon:ActionButton_UpdateHotkeys(button, type) |
-- print(button:GetName() .. " is updating its HotKey") |
-- end |
function AceHook:Hook(object, method, handler, hookSecure) |
if type(object) == "string" then |
method, handler, hookSecure, object = object, method, handler, nil |
end |
if handler == true then |
handler, hookSecure = nil, true |
end |
hook(self, object, method, handler, false, false, false, hookSecure or false, "Usage: Hook([object], method, [handler], [hookSecure])") |
end |
--- RawHook a function or a method on an object. |
-- The hook created will be a "raw hook", that means that your handler will completly replace |
-- the original function, and your handler has to call the original function (or not, depending on your intentions).\\ |
-- The original function will be stored in `self.hooks[object][method]` or `self.hooks[functionName]` respectively.\\ |
-- This type of hook can be used for all purposes, and is usually the most common case when you need to modify arguments |
-- or want to control execution of the original function. |
-- @paramsig [object], method, [handler], [hookSecure] |
-- @param object The object to hook a method from |
-- @param method If object was specified, the name of the method, or the name of the function to hook. |
-- @param handler The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked function) |
-- @param hookSecure If true, AceHook will allow hooking of secure functions. |
-- @usage |
-- -- create an addon with AceHook embeded |
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("HookDemo", "AceHook-3.0") |
-- |
-- function MyAddon:OnEnable() |
-- -- Hook ActionButton_UpdateHotkeys, overwriting the secure status |
-- self:RawHook("ActionButton_UpdateHotkeys", true) |
-- end |
-- |
-- function MyAddon:ActionButton_UpdateHotkeys(button, type) |
-- if button:GetName() == "MyButton" then |
-- -- do stuff here |
-- else |
-- self.hooks.ActionButton_UpdateHotkeys(button, type) |
-- end |
-- end |
function AceHook:RawHook(object, method, handler, hookSecure) |
if type(object) == "string" then |
method, handler, hookSecure, object = object, method, handler, nil |
end |
if handler == true then |
handler, hookSecure = nil, true |
end |
hook(self, object, method, handler, false, false, true, hookSecure or false, "Usage: RawHook([object], method, [handler], [hookSecure])") |
end |
--- SecureHook a function or a method on an object. |
-- This function is a wrapper around the `hooksecurefunc` function in the WoW API. Using AceHook |
-- extends the functionality of secure hooks, and adds the ability to unhook once the hook isn't |
-- required anymore, or the addon is being disabled.\\ |
-- Secure Hooks should be used if the secure-status of the function is vital to its function, |
-- and taint would block execution. Secure Hooks are always called after the original function was called |
-- ("Post Hook"), and you cannot modify the arguments, return values or control the execution. |
-- @paramsig [object], method, [handler] |
-- @param object The object to hook a method from |
-- @param method If object was specified, the name of the method, or the name of the function to hook. |
-- @param handler The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked function) |
function AceHook:SecureHook(object, method, handler) |
if type(object) == "string" then |
method, handler, object = object, method, nil |
end |
hook(self, object, method, handler, false, true, false, false, "Usage: SecureHook([object], method, [handler])") |
end |
--- Hook a script handler on a frame. |
-- The hook created will be a "safe hook", that means that your handler will be called |
-- before the hooked script ("Pre-Hook"), and you don't have to call the original function yourself, |
-- however you cannot stop the execution of the function, or modify any of the arguments/return values.\\ |
-- This is the frame script equivalent of the :Hook safe-hook. It would typically be used to be notified |
-- when a certain event happens to a frame. |
-- @paramsig frame, script, [handler] |
-- @param frame The Frame to hook the script on |
-- @param script The script to hook |
-- @param handler The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked script) |
-- @usage |
-- -- create an addon with AceHook embeded |
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("HookDemo", "AceHook-3.0") |
-- |
-- function MyAddon:OnEnable() |
-- -- Hook the OnShow of FriendsFrame |
-- self:HookScript(FriendsFrame, "OnShow", "FriendsFrameOnShow") |
-- end |
-- |
-- function MyAddon:FriendsFrameOnShow(frame) |
-- print("The FriendsFrame was shown!") |
-- end |
function AceHook:HookScript(frame, script, handler) |
hook(self, frame, script, handler, true, false, false, false, "Usage: HookScript(object, method, [handler])") |
end |
--- RawHook a script handler on a frame. |
-- The hook created will be a "raw hook", that means that your handler will completly replace |
-- the original script, and your handler has to call the original script (or not, depending on your intentions).\\ |
-- The original script will be stored in `self.hooks[frame][script]`.\\ |
-- This type of hook can be used for all purposes, and is usually the most common case when you need to modify arguments |
-- or want to control execution of the original script. |
-- @paramsig frame, script, [handler] |
-- @param frame The Frame to hook the script on |
-- @param script The script to hook |
-- @param handler The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked script) |
-- @usage |
-- -- create an addon with AceHook embeded |
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("HookDemo", "AceHook-3.0") |
-- |
-- function MyAddon:OnEnable() |
-- -- Hook the OnShow of FriendsFrame |
-- self:RawHookScript(FriendsFrame, "OnShow", "FriendsFrameOnShow") |
-- end |
-- |
-- function MyAddon:FriendsFrameOnShow(frame) |
-- -- Call the original function |
-- self.hooks[frame].OnShow(frame) |
-- -- Do our processing |
-- -- .. stuff |
-- end |
function AceHook:RawHookScript(frame, script, handler) |
hook(self, frame, script, handler, true, false, true, false, "Usage: RawHookScript(object, method, [handler])") |
end |
--- SecureHook a script handler on a frame. |
-- This function is a wrapper around the `frame:HookScript` function in the WoW API. Using AceHook |
-- extends the functionality of secure hooks, and adds the ability to unhook once the hook isn't |
-- required anymore, or the addon is being disabled.\\ |
-- Secure Hooks should be used if the secure-status of the function is vital to its function, |
-- and taint would block execution. Secure Hooks are always called after the original function was called |
-- ("Post Hook"), and you cannot modify the arguments, return values or control the execution. |
-- @paramsig frame, script, [handler] |
-- @param frame The Frame to hook the script on |
-- @param script The script to hook |
-- @param handler The handler for the hook, a funcref or a method name. (Defaults to the name of the hooked script) |
function AceHook:SecureHookScript(frame, script, handler) |
hook(self, frame, script, handler, true, true, false, false, "Usage: SecureHookScript(object, method, [handler])") |
end |
--- Unhook from the specified function, method or script. |
-- @paramsig [obj], method |
-- @param obj The object or frame to unhook from |
-- @param method The name of the method, function or script to unhook from. |
function AceHook:Unhook(obj, method) |
local usage = "Usage: Unhook([obj], method)" |
if type(obj) == "string" then |
method, obj = obj, nil |
end |
if obj and type(obj) ~= "table" then |
error(format("%s: 'obj' - expecting nil or table got %s", usage, type(obj)), 2) |
end |
if type(method) ~= "string" then |
error(format("%s: 'method' - expeting string got %s", usage, type(method)), 2) |
end |
local uid |
if obj then |
uid = registry[self][obj] and registry[self][obj][method] |
else |
uid = registry[self][method] |
end |
if not uid or not actives[uid] then |
-- Declining to error on an unneeded unhook since the end effect is the same and this would just be annoying. |
return false |
end |
actives[uid], handlers[uid] = nil, nil |
if obj then |
registry[self][obj][method] = nil |
registry[self][obj] = next(registry[self][obj]) and registry[self][obj] or nil |
-- if the hook reference doesnt exist, then its a secure hook, just bail out and dont do any unhooking |
if not self.hooks[obj] or not self.hooks[obj][method] then return true end |
if scripts[uid] and obj:GetScript(method) == uid then -- unhooks scripts |
obj:SetScript(method, self.hooks[obj][method] ~= donothing and self.hooks[obj][method] or nil) |
scripts[uid] = nil |
elseif obj and self.hooks[obj] and self.hooks[obj][method] and obj[method] == uid then -- unhooks methods |
obj[method] = self.hooks[obj][method] |
end |
self.hooks[obj][method] = nil |
self.hooks[obj] = next(self.hooks[obj]) and self.hooks[obj] or nil |
else |
registry[self][method] = nil |
-- if self.hooks[method] doesn't exist, then this is a SecureHook, just bail out |
if not self.hooks[method] then return true end |
if self.hooks[method] and _G[method] == uid then -- unhooks functions |
_G[method] = self.hooks[method] |
end |
self.hooks[method] = nil |
end |
return true |
end |
--- Unhook all existing hooks for this addon. |
function AceHook:UnhookAll() |
for key, value in pairs(registry[self]) do |
if type(key) == "table" then |
for method in pairs(value) do |
self:Unhook(key, method) |
end |
else |
self:Unhook(key) |
end |
end |
end |
--- Check if the specific function, method or script is already hooked. |
-- @paramsig [obj], method |
-- @param obj The object or frame to unhook from |
-- @param method The name of the method, function or script to unhook from. |
function AceHook:IsHooked(obj, method) |
-- we don't check if registry[self] exists, this is done by evil magicks in the metatable |
if type(obj) == "string" then |
if registry[self][obj] and actives[registry[self][obj]] then |
return true, handlers[registry[self][obj]] |
end |
else |
if registry[self][obj] and registry[self][obj][method] and actives[registry[self][obj][method]] then |
return true, handlers[registry[self][obj][method]] |
end |
end |
return false, nil |
end |
--- Upgrade our old embeded |
for target, v in pairs( AceHook.embeded ) do |
AceHook:Embed( target ) |
end |
<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="AceDBOptions-3.0.lua"/> |
</Ui> |
--- AceDBOptions-3.0 provides a universal AceConfig options screen for managing AceDB-3.0 profiles. |
-- @class file |
-- @name AceDBOptions-3.0 |
-- @release $Id: AceDBOptions-3.0.lua 895 2009-12-06 16:28:55Z nevcairiel $ |
local ACEDBO_MAJOR, ACEDBO_MINOR = "AceDBOptions-3.0", 11 |
local AceDBOptions, oldminor = LibStub:NewLibrary(ACEDBO_MAJOR, ACEDBO_MINOR) |
if not AceDBOptions then return end -- No upgrade needed |
-- Lua APIs |
local pairs, next = pairs, next |
-- WoW APIs |
local UnitClass = UnitClass |
-- 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_CODE, FONT_COLOR_CODE_CLOSE |
AceDBOptions.optionTables = AceDBOptions.optionTables or {} |
AceDBOptions.handlers = AceDBOptions.handlers or {} |
--[[ |
Localization of AceDBOptions-3.0 |
]] |
local L = { |
default = "Default", |
intro = "You can change the active database profile, so you can have different settings for every character.", |
reset_desc = "Reset the current profile back to its default values, in case your configuration is broken, or you simply want to start over.", |
reset = "Reset Profile", |
reset_sub = "Reset the current profile to the default", |
choose_desc = "You can either create a new profile by entering a name in the editbox, or choose one of the already exisiting profiles.", |
new = "New", |
new_sub = "Create a new empty profile.", |
choose = "Existing Profiles", |
choose_sub = "Select one of your currently available profiles.", |
copy_desc = "Copy the settings from one existing profile into the currently active profile.", |
copy = "Copy From", |
delete_desc = "Delete existing and unused profiles from the database to save space, and cleanup the SavedVariables file.", |
delete = "Delete a Profile", |
delete_sub = "Deletes a profile from the database.", |
delete_confirm = "Are you sure you want to delete the selected profile?", |
profiles = "Profiles", |
profiles_sub = "Manage Profiles", |
current = "Current Profile:", |
} |
local LOCALE = GetLocale() |
if LOCALE == "deDE" then |
L["default"] = "Standard" |
L["intro"] = "Hier kannst du das aktive Datenbankprofile \195\164ndern, damit du verschiedene Einstellungen f\195\188r jeden Charakter erstellen kannst, wodurch eine sehr flexible Konfiguration m\195\182glich wird." |
L["reset_desc"] = "Setzt das momentane Profil auf Standardwerte zur\195\188ck, f\195\188r den Fall das mit der Konfiguration etwas schief lief oder weil du einfach neu starten willst." |
L["reset"] = "Profil zur\195\188cksetzen" |
L["reset_sub"] = "Das aktuelle Profil auf Standard zur\195\188cksetzen." |
L["choose_desc"] = "Du kannst ein neues Profil erstellen, indem du einen neuen Namen in der Eingabebox 'Neu' eingibst, oder w\195\164hle eines der vorhandenen Profile aus." |
L["new"] = "Neu" |
L["new_sub"] = "Ein neues Profil erstellen." |
L["choose"] = "Vorhandene Profile" |
L["choose_sub"] = "W\195\164hlt ein bereits vorhandenes Profil aus." |
L["copy_desc"] = "Kopiere die Einstellungen von einem vorhandenen Profil in das aktive Profil." |
L["copy"] = "Kopieren von..." |
L["delete_desc"] = "L\195\182sche vorhandene oder unbenutzte Profile aus der Datenbank um Platz zu sparen und um die SavedVariables Datei 'sauber' zu halten." |
L["delete"] = "Profil l\195\182schen" |
L["delete_sub"] = "L\195\182scht ein Profil aus der Datenbank." |
L["delete_confirm"] = "Willst du das ausgew\195\164hlte Profil wirklich l\195\182schen?" |
L["profiles"] = "Profile" |
L["profiles_sub"] = "Profile verwalten" |
--L["current"] = "Current Profile:" |
elseif LOCALE == "frFR" then |
L["default"] = "D\195\169faut" |
L["intro"] = "Vous pouvez changer le profil actuel afin d'avoir des param\195\168tres diff\195\169rents pour chaque personnage, permettant ainsi d'avoir une configuration tr\195\168s flexible." |
L["reset_desc"] = "R\195\169initialise le profil actuel au cas o\195\185 votre configuration est corrompue ou si vous voulez tout simplement faire table rase." |
L["reset"] = "R\195\169initialiser le profil" |
L["reset_sub"] = "R\195\169initialise le profil actuel avec les param\195\168tres par d\195\169faut." |
L["choose_desc"] = "Vous pouvez cr\195\169er un nouveau profil en entrant un nouveau nom dans la bo\195\174te de saisie, ou en choississant un des profils d\195\169j\195\160 existants." |
L["new"] = "Nouveau" |
L["new_sub"] = "Cr\195\169\195\169e un nouveau profil vierge." |
L["choose"] = "Profils existants" |
L["choose_sub"] = "Permet de choisir un des profils d\195\169j\195\160 disponibles." |
L["copy_desc"] = "Copie les param\195\168tres d'un profil d\195\169j\195\160 existant dans le profil actuellement actif." |
L["copy"] = "Copier \195\160 partir de" |
L["delete_desc"] = "Supprime les profils existants inutilis\195\169s de la base de donn\195\169es afin de gagner de la place et de nettoyer le fichier SavedVariables." |
L["delete"] = "Supprimer un profil" |
L["delete_sub"] = "Supprime un profil de la base de donn\195\169es." |
L["delete_confirm"] = "Etes-vous s\195\187r de vouloir supprimer le profil s\195\169lectionn\195\169 ?" |
L["profiles"] = "Profils" |
L["profiles_sub"] = "Gestion des profils" |
--L["current"] = "Current Profile:" |
elseif LOCALE == "koKR" then |
L["default"] = "기본ê°" |
L["intro"] = "모ë ìºë¦í°ì ë¤ìí ì¤ì ê³¼ ì¬ì©ì¤ì¸ ë°ì´í°ë² ì´ì¤ íë¡í, ì´ëê²ì´ëì§ ë§¤ì° ë¤ë£¨ê¸° ì½ê² ë°ê¿ì ììµëë¤." |
L["reset_desc"] = "ë¨ìí ë¤ì ìë¡ê² 구ì±ì ìíë ê²½ì°, íì¬ íë¡íì 기본ê°ì¼ë¡ ì´ê¸°í í©ëë¤." |
L["reset"] = "íë¡í ì´ê¸°í" |
L["reset_sub"] = "íì¬ì íë¡íì 기본ê°ì¼ë¡ ì´ê¸°í í©ëë¤" |
L["choose_desc"] = "ìë¡ì´ ì´ë¦ì ì ë ¥íê±°ë, ì´ë¯¸ ìë íë¡íì¤ íë를 ì ííì¬ ìë¡ì´ íë¡íì ë§ë¤ ì ììµëë¤." |
L["new"] = "ìë¡ì´ íë¡í" |
L["new_sub"] = "ìë¡ì´ íë¡íì ë§ëëë¤." |
L["choose"] = "íë¡í ì í" |
L["choose_sub"] = "ë¹ì ì´ íì¬ ì´ì©í ì ìë íë¡íì ì íí©ëë¤." |
L["copy_desc"] = "íì¬ ì¬ì©ì¤ì¸ íë¡íì, ì íí íë¡íì ì¤ì ì ë³µì¬í©ëë¤." |
L["copy"] = "ë³µì¬" |
L["delete_desc"] = "ë°ì´í°ë² ì´ì¤ì ì¬ì©ì¤ì´ê±°ë ì ì¥ë íë¡íì¼ ìì ë¡ SavedVariables íì¼ì ì 리ì ê³µê° ì ì½ì´ ë©ëë¤." |
L["delete"] = "íë¡í ìì " |
L["delete_sub"] = "ë°ì´í°ë² ì´ì¤ì íë¡íì ìì í©ëë¤." |
L["delete_confirm"] = "ì ë§ë¡ ì íí íë¡íì ìì 를 ìíìëê¹?" |
L["profiles"] = "íë¡í" |
L["profiles_sub"] = "íë¡í ì¤ì " |
--L["current"] = "Current Profile:" |
elseif LOCALE == "esES" or LOCALE == "esMX" then |
L["default"] = "Por defecto" |
L["intro"] = "Puedes cambiar el perfil activo de tal manera que cada personaje tenga diferentes configuraciones." |
L["reset_desc"] = "Reinicia el perfil actual a los valores por defectos, en caso de que se haya estropeado la configuración o quieras volver a empezar de nuevo." |
L["reset"] = "Reiniciar Perfil" |
L["reset_sub"] = "Reinicar el perfil actual al de por defecto" |
L["choose_desc"] = "Puedes crear un nuevo perfil introduciendo un nombre en el recuadro o puedes seleccionar un perfil de los ya existentes." |
L["new"] = "Nuevo" |
L["new_sub"] = "Crear un nuevo perfil vacio." |
L["choose"] = "Perfiles existentes" |
L["choose_sub"] = "Selecciona uno de los perfiles disponibles." |
L["copy_desc"] = "Copia los ajustes de un perfil existente al perfil actual." |
L["copy"] = "Copiar de" |
L["delete_desc"] = "Borra los perfiles existentes y sin uso de la base de datos para ganar espacio y limpiar el archivo SavedVariables." |
L["delete"] = "Borrar un Perfil" |
L["delete_sub"] = "Borra un perfil de la base de datos." |
L["delete_confirm"] = "¿Estas seguro que quieres borrar el perfil seleccionado?" |
L["profiles"] = "Perfiles" |
L["profiles_sub"] = "Manejar Perfiles" |
--L["current"] = "Current Profile:" |
elseif LOCALE == "zhTW" then |
L["default"] = "é è¨" |
L["intro"] = "ä½ å¯ä»¥é¸æä¸åæ´»åçè³æè¨å®æªï¼éæ¨£ä½ çæ¯åè§è²å°±å¯ä»¥ææä¸åçè¨å®å¼ï¼å¯ä»¥çµ¦ä½ çæä»¶è¨å®å¸¶ä¾æ¥µå¤§çéæ´»æ§ã" |
L["reset_desc"] = "å°ç¶åçè¨å®æªæ¢å¾©å°å®çé è¨å¼ï¼ç¨æ¼ä½ çè¨å®æªæå£ï¼æè ä½ åªæ¯æ³éä¾çæ æ³ã" |
L["reset"] = "éç½®è¨å®æª" |
L["reset_sub"] = "å°ç¶åçè¨å®æªæ¢å¾©çºé è¨å¼" |
L["choose_desc"] = "ä½ å¯ä»¥ééå¨ææ¬æ¡å §è¼¸å ¥ä¸ååååµç«ä¸åæ°çè¨å®æªï¼ä¹å¯ä»¥é¸æä¸åå·²ç¶åå¨çè¨å®æªã" |
L["new"] = "æ°å»º" |
L["new_sub"] = "æ°å»ºä¸å空çè¨å®æªã" |
L["choose"] = "ç¾æçè¨å®æª" |
L["choose_sub"] = "å¾ç¶åå¯ç¨çè¨å®æªè£é¢é¸æä¸åã" |
L["copy_desc"] = "å¾ç¶åæåå·²ä¿åçè¨å®æªè¤è£½å°ç¶åæ£ä½¿ç¨çè¨å®æªã" |
L["copy"] = "è¤è£½èª" |
L["delete_desc"] = "å¾è³æåº«è£åªé¤ä¸å使ç¨çè¨å®æªï¼ä»¥ç¯ç空éï¼ä¸¦ä¸æ¸ çSavedVariablesæªã" |
L["delete"] = "åªé¤ä¸åè¨å®æª" |
L["delete_sub"] = "å¾è³æåº«è£åªé¤ä¸åè¨å®æªã" |
L["delete_confirm"] = "ä½ ç¢ºå®è¦åªé¤æé¸æçè¨å®æªåï¼" |
L["profiles"] = "è¨å®æª" |
L["profiles_sub"] = "管çè¨å®æª" |
--L["current"] = "Current Profile:" |
elseif LOCALE == "zhCN" then |
L["default"] = "é»è®¤" |
L["intro"] = "ä½ å¯ä»¥éæ©ä¸ä¸ªæ´»å¨çæ°æ®é ç½®æä»¶ï¼è¿æ ·ä½ çæ¯ä¸ªè§è²å°±å¯ä»¥æ¥æä¸åç设置å¼ï¼å¯ä»¥ç»ä½ çæä»¶é ç½®å¸¦æ¥æå¤§ççµæ´»æ§ã" |
L["reset_desc"] = "å°å½åçé ç½®æä»¶æ¢å¤å°å®çé»è®¤å¼ï¼ç¨äºä½ çé ç½®æä»¶æåï¼æè ä½ åªæ¯æ³éæ¥çæ åµã" |
L["reset"] = "éç½®é ç½®æä»¶" |
L["reset_sub"] = "å°å½åçé ç½®æä»¶æ¢å¤ä¸ºé»è®¤å¼" |
L["choose_desc"] = "ä½ å¯ä»¥éè¿å¨ææ¬æ¡å è¾å ¥ä¸ä¸ªåååç«ä¸ä¸ªæ°çé ç½®æä»¶ï¼ä¹å¯ä»¥éæ©ä¸ä¸ªå·²ç»åå¨çé ç½®æä»¶ã" |
L["new"] = "æ°å»º" |
L["new_sub"] = "æ°å»ºä¸ä¸ªç©ºçé ç½®æä»¶ã" |
L["choose"] = "ç°æçé ç½®æä»¶" |
L["choose_sub"] = "ä»å½åå¯ç¨çé ç½®æä»¶éé¢éæ©ä¸ä¸ªã" |
L["copy_desc"] = "ä»å½åæä¸ªå·²ä¿åçé ç½®æä»¶å¤å¶å°å½åæ£ä½¿ç¨çé ç½®æä»¶ã" |
L["copy"] = "å¤å¶èª" |
L["delete_desc"] = "仿°æ®åºéå é¤ä¸å使ç¨çé ç½®æä»¶ï¼ä»¥èç空é´ï¼å¹¶ä¸æ¸ çSavedVariablesæä»¶ã" |
L["delete"] = "å é¤ä¸ä¸ªé ç½®æä»¶" |
L["delete_sub"] = "仿°æ®åºéå é¤ä¸ä¸ªé ç½®æä»¶ã" |
L["delete_confirm"] = "ä½ ç¡®å®è¦å 餿鿩çé ç½®æä»¶ä¹ï¼" |
L["profiles"] = "é ç½®æä»¶" |
L["profiles_sub"] = "管çé ç½®æä»¶" |
--L["current"] = "Current Profile:" |
elseif LOCALE == "ruRU" then |
L["default"] = "Ðо ÑмолÑаниÑ" |
L["intro"] = "ÐзменÑÑ Ð°ÐºÑивнÑй пÑоÑилÑ, Ð²Ñ Ð¼Ð¾Ð¶ÐµÑе задаÑÑ ÑазлиÑнÑе наÑÑÑойки модиÑикаÑий Ð´Ð»Ñ ÐºÐ°Ð¶Ð´Ð¾Ð³Ð¾ пеÑÑонажа." |
L["reset_desc"] = "ÐÑли ваÑа конÑигÑÑаÑии иÑпоÑÑена или еÑли Ð²Ñ Ñ Ð¾ÑиÑе наÑÑÑоиÑÑ Ð²ÑÑ Ð·Ð°Ð½Ð¾Ð²Ð¾ - ÑбÑоÑÑÑе ÑекÑÑий пÑоÑÐ¸Ð»Ñ Ð½Ð° ÑÑандаÑÑнÑе знаÑениÑ." |
L["reset"] = "СбÑÐ¾Ñ Ð¿ÑоÑилÑ" |
L["reset_sub"] = "СбÑÐ¾Ñ ÑекÑÑего пÑоÑÐ¸Ð»Ñ Ð½Ð° ÑÑандаÑÑнÑй" |
L["choose_desc"] = "ÐÑ Ð¼Ð¾Ð¶ÐµÑе ÑоздаÑÑ Ð½Ð¾Ð²Ñй пÑоÑилÑ, Ð²Ð²ÐµÐ´Ñ Ð½Ð°Ð·Ð²Ð°Ð½Ð¸Ðµ в поле ввода, или вÑбÑаÑÑ Ð¾Ð´Ð¸Ð½ из Ñже ÑÑÑеÑÑвÑÑÑÐ¸Ñ Ð¿ÑоÑилей." |
L["new"] = "ÐовÑй" |
L["new_sub"] = "СоздаÑÑ Ð½Ð¾Ð²Ñй ÑиÑÑÑй пÑоÑилÑ" |
L["choose"] = "СÑÑеÑÑвÑÑÑие пÑоÑили" |
L["choose_sub"] = "ÐÑÐ±Ð¾Ñ Ð¾Ð´Ð¸Ð½Ð¾Ð³Ð¾ из Ñже доÑÑÑпнÑÑ Ð¿ÑоÑилей" |
L["copy_desc"] = "СкопиÑоваÑÑ Ð½Ð°ÑÑÑойки из вÑбÑанного пÑоÑÐ¸Ð»Ñ Ð² акÑивнÑй." |
L["copy"] = "СкопиÑоваÑÑ Ð¸Ð·" |
L["delete_desc"] = "УдалиÑÑ ÑÑÑеÑÑвÑÑÑий и неиÑполÑзÑемÑй пÑоÑÐ¸Ð»Ñ Ð¸Ð· ÐÐ Ð´Ð»Ñ ÑÐ¾Ñ ÑÐ°Ð½ÐµÐ½Ð¸Ñ Ð¼ÐµÑÑа, и оÑиÑÑиÑÑ SavedVariables Ñайл." |
L["delete"] = "УдалиÑÑ Ð¿ÑоÑилÑ" |
L["delete_sub"] = "Удаление пÑоÑÐ¸Ð»Ñ Ð¸Ð· ÐÐ" |
L["delete_confirm"] = "ÐÑ ÑвеÑенÑ, ÑÑо Ð²Ñ Ñ Ð¾ÑиÑе ÑдалиÑÑ Ð²ÑбÑаннÑй пÑоÑилÑ?" |
L["profiles"] = "ÐÑоÑили" |
L["profiles_sub"] = "УпÑавление пÑоÑилÑми" |
--L["current"] = "Current Profile:" |
end |
local defaultProfiles |
local tmpprofiles = {} |
-- Get a list of available profiles for the specified database. |
-- You can specify which profiles to include/exclude in the list using the two boolean parameters listed below. |
-- @param db The db object to retrieve the profiles from |
-- @param common If true, getProfileList will add the default profiles to the return list, even if they have not been created yet |
-- @param nocurrent If true, then getProfileList will not display the current profile in the list |
-- @return Hashtable of all profiles with the internal name as keys and the display name as value. |
local function getProfileList(db, common, nocurrent) |
local profiles = {} |
-- copy existing profiles into the table |
local currentProfile = db:GetCurrentProfile() |
for i,v in pairs(db:GetProfiles(tmpprofiles)) do |
if not (nocurrent and v == currentProfile) then |
profiles[v] = v |
end |
end |
-- add our default profiles to choose from ( or rename existing profiles) |
for k,v in pairs(defaultProfiles) do |
if (common or profiles[k]) and not (nocurrent and k == currentProfile) then |
profiles[k] = v |
end |
end |
return profiles |
end |
--[[ |
OptionsHandlerPrototype |
prototype class for handling the options in a sane way |
]] |
local OptionsHandlerPrototype = {} |
--[[ Reset the profile ]] |
function OptionsHandlerPrototype:Reset() |
self.db:ResetProfile() |
end |
--[[ Set the profile to value ]] |
function OptionsHandlerPrototype:SetProfile(info, value) |
self.db:SetProfile(value) |
end |
--[[ returns the currently active profile ]] |
function OptionsHandlerPrototype:GetCurrentProfile() |
return self.db:GetCurrentProfile() |
end |
--[[ |
List all active profiles |
you can control the output with the .arg variable |
currently four modes are supported |
(empty) - return all available profiles |
"nocurrent" - returns all available profiles except the currently active profile |
"common" - returns all avaialble profiles + some commonly used profiles ("char - realm", "realm", "class", "Default") |
"both" - common except the active profile |
]] |
function OptionsHandlerPrototype:ListProfiles(info) |
local arg = info.arg |
local profiles |
if arg == "common" and not self.noDefaultProfiles then |
profiles = getProfileList(self.db, true, nil) |
elseif arg == "nocurrent" then |
profiles = getProfileList(self.db, nil, true) |
elseif arg == "both" then -- currently not used |
profiles = getProfileList(self.db, (not self.noDefaultProfiles) and true, true) |
else |
profiles = getProfileList(self.db) |
end |
return profiles |
end |
function OptionsHandlerPrototype:HasNoProfiles(info) |
local profiles = self:ListProfiles(info) |
return ((not next(profiles)) and true or false) |
end |
--[[ Copy a profile ]] |
function OptionsHandlerPrototype:CopyProfile(info, value) |
self.db:CopyProfile(value) |
end |
--[[ Delete a profile from the db ]] |
function OptionsHandlerPrototype:DeleteProfile(info, value) |
self.db:DeleteProfile(value) |
end |
--[[ fill defaultProfiles with some generic values ]] |
local function generateDefaultProfiles(db) |
defaultProfiles = { |
["Default"] = L["default"], |
[db.keys.char] = db.keys.char, |
[db.keys.realm] = db.keys.realm, |
[db.keys.class] = UnitClass("player") |
} |
end |
--[[ create and return a handler object for the db, or upgrade it if it already existed ]] |
local function getOptionsHandler(db, noDefaultProfiles) |
if not defaultProfiles then |
generateDefaultProfiles(db) |
end |
local handler = AceDBOptions.handlers[db] or { db = db, noDefaultProfiles = noDefaultProfiles } |
for k,v in pairs(OptionsHandlerPrototype) do |
handler[k] = v |
end |
AceDBOptions.handlers[db] = handler |
return handler |
end |
--[[ |
the real options table |
]] |
local optionsTable = { |
desc = { |
order = 1, |
type = "description", |
name = L["intro"] .. "\n", |
}, |
descreset = { |
order = 9, |
type = "description", |
name = L["reset_desc"], |
}, |
reset = { |
order = 10, |
type = "execute", |
name = L["reset"], |
desc = L["reset_sub"], |
func = "Reset", |
}, |
current = { |
order = 11, |
type = "description", |
name = function(info) return L["current"] .. " " .. NORMAL_FONT_COLOR_CODE .. info.handler:GetCurrentProfile() .. FONT_COLOR_CODE_CLOSE end, |
width = "default", |
}, |
choosedesc = { |
order = 20, |
type = "description", |
name = "\n" .. L["choose_desc"], |
}, |
new = { |
name = L["new"], |
desc = L["new_sub"], |
type = "input", |
order = 30, |
get = false, |
set = "SetProfile", |
}, |
choose = { |
name = L["choose"], |
desc = L["choose_sub"], |
type = "select", |
order = 40, |
get = "GetCurrentProfile", |
set = "SetProfile", |
values = "ListProfiles", |
arg = "common", |
}, |
copydesc = { |
order = 50, |
type = "description", |
name = "\n" .. L["copy_desc"], |
}, |
copyfrom = { |
order = 60, |
type = "select", |
name = L["copy"], |
desc = L["copy_desc"], |
get = false, |
set = "CopyProfile", |
values = "ListProfiles", |
disabled = "HasNoProfiles", |
arg = "nocurrent", |
}, |
deldesc = { |
order = 70, |
type = "description", |
name = "\n" .. L["delete_desc"], |
}, |
delete = { |
order = 80, |
type = "select", |
name = L["delete"], |
desc = L["delete_sub"], |
get = false, |
set = "DeleteProfile", |
values = "ListProfiles", |
disabled = "HasNoProfiles", |
arg = "nocurrent", |
confirm = true, |
confirmText = L["delete_confirm"], |
}, |
} |
--- Get/Create a option table that you can use in your addon to control the profiles of AceDB-3.0. |
-- @param db The database object to create the options table for. |
-- @return The options table to be used in AceConfig-3.0 |
-- @usage |
-- -- Assuming `options` is your top-level options table and `self.db` is your database: |
-- options.args.profiles = LibStub("AceDBOptions-3.0"):GetOptionsTable(self.db) |
function AceDBOptions:GetOptionsTable(db, noDefaultProfiles) |
local tbl = AceDBOptions.optionTables[db] or { |
type = "group", |
name = L["profiles"], |
desc = L["profiles_sub"], |
} |
tbl.handler = getOptionsHandler(db, noDefaultProfiles) |
tbl.args = optionsTable |
AceDBOptions.optionTables[db] = tbl |
return tbl |
end |
-- upgrade existing tables |
for db,tbl in pairs(AceDBOptions.optionTables) do |
tbl.handler = getOptionsHandler(db) |
tbl.args = optionsTable |
end |
<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="AceConsole-3.0.lua"/> |
</Ui> |
--- **AceConsole-3.0** provides registration facilities for slash commands. |
-- You can register slash commands to your custom functions and use the `GetArgs` function to parse them |
-- to your addons individual needs. |
-- |
-- **AceConsole-3.0** can be embeded into your addon, either explicitly by calling AceConsole:Embed(MyAddon) or by |
-- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object |
-- and can be accessed directly, without having to explicitly call AceConsole itself.\\ |
-- It is recommended to embed AceConsole, otherwise you'll have to specify a custom `self` on all calls you |
-- make into AceConsole. |
-- @class file |
-- @name AceConsole-3.0 |
-- @release $Id: AceConsole-3.0.lua 878 2009-11-02 18:51:58Z nevcairiel $ |
local MAJOR,MINOR = "AceConsole-3.0", 7 |
local AceConsole, oldminor = LibStub:NewLibrary(MAJOR, MINOR) |
if not AceConsole then return end -- No upgrade needed |
AceConsole.embeds = AceConsole.embeds or {} -- table containing objects AceConsole is embedded in. |
AceConsole.commands = AceConsole.commands or {} -- table containing commands registered |
AceConsole.weakcommands = AceConsole.weakcommands or {} -- table containing self, command => func references for weak commands that don't persist through enable/disable |
-- Lua APIs |
local tconcat, tostring, select = table.concat, tostring, select |
local type, pairs, error = type, pairs, error |
local format, strfind, strsub = string.format, string.find, string.sub |
local max = math.max |
-- 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: DEFAULT_CHAT_FRAME, SlashCmdList, hash_SlashCmdList |
local tmp={} |
local function Print(self,frame,...) |
local n=0 |
if self ~= AceConsole then |
n=n+1 |
tmp[n] = "|cff33ff99"..tostring( self ).."|r:" |
end |
for i=1, select("#", ...) do |
n=n+1 |
tmp[n] = tostring(select(i, ...)) |
end |
frame:AddMessage( tconcat(tmp," ",1,n) ) |
end |
--- Print to DEFAULT_CHAT_FRAME or given ChatFrame (anything with an .AddMessage function) |
-- @paramsig [chatframe ,] ... |
-- @param chatframe Custom ChatFrame to print to (or any frame with an .AddMessage function) |
-- @param ... List of any values to be printed |
function AceConsole:Print(...) |
local frame = ... |
if type(frame) == "table" and frame.AddMessage then -- Is first argument something with an .AddMessage member? |
return Print(self, frame, select(2,...)) |
else |
return Print(self, DEFAULT_CHAT_FRAME, ...) |
end |
end |
--- Formatted (using format()) print to DEFAULT_CHAT_FRAME or given ChatFrame (anything with an .AddMessage function) |
-- @paramsig [chatframe ,] "format"[, ...] |
-- @param chatframe Custom ChatFrame to print to (or any frame with an .AddMessage function) |
-- @param format Format string - same syntax as standard Lua format() |
-- @param ... Arguments to the format string |
function AceConsole:Printf(...) |
local frame = ... |
if type(frame) == "table" and frame.AddMessage then -- Is first argument something with an .AddMessage member? |
return Print(self, frame, format(select(2,...))) |
else |
return Print(self, DEFAULT_CHAT_FRAME, format(...)) |
end |
end |
--- Register a simple chat command |
-- @param command Chat command to be registered WITHOUT leading "/" |
-- @param func Function to call when the slash command is being used (funcref or methodname) |
-- @param persist if false, the command will be soft disabled/enabled when aceconsole is used as a mixin (default: true) |
function AceConsole:RegisterChatCommand( command, func, persist ) |
if type(command)~="string" then error([[Usage: AceConsole:RegisterChatCommand( "command", func[, persist ]): 'command' - expected a string]], 2) end |
if persist==nil then persist=true end -- I'd rather have my addon's "/addon enable" around if the author screws up. Having some extra slash regged when it shouldnt be isn't as destructive. True is a better default. /Mikk |
local name = "ACECONSOLE_"..command:upper() |
if type( func ) == "string" then |
SlashCmdList[name] = function(input, editBox) |
self[func](self, input, editBox) |
end |
else |
SlashCmdList[name] = func |
end |
_G["SLASH_"..name.."1"] = "/"..command:lower() |
AceConsole.commands[command] = name |
-- non-persisting commands are registered for enabling disabling |
if not persist then |
if not AceConsole.weakcommands[self] then AceConsole.weakcommands[self] = {} end |
AceConsole.weakcommands[self][command] = func |
end |
return true |
end |
--- Unregister a chatcommand |
-- @param command Chat command to be unregistered WITHOUT leading "/" |
function AceConsole:UnregisterChatCommand( command ) |
local name = AceConsole.commands[command] |
if name then |
SlashCmdList[name] = nil |
_G["SLASH_" .. name .. "1"] = nil |
hash_SlashCmdList["/" .. command:upper()] = nil |
AceConsole.commands[command] = nil |
end |
end |
--- Get an iterator over all Chat Commands registered with AceConsole |
-- @return Iterator (pairs) over all commands |
function AceConsole:IterateChatCommands() return pairs(AceConsole.commands) end |
local function nils(n, ...) |
if n>1 then |
return nil, nils(n-1, ...) |
elseif n==1 then |
return nil, ... |
else |
return ... |
end |
end |
--- Retreive one or more space-separated arguments from a string. |
-- Treats quoted strings and itemlinks as non-spaced. |
-- @param string The raw argument string |
-- @param numargs How many arguments to get (default 1) |
-- @param startpos Where in the string to start scanning (default 1) |
-- @return Returns arg1, arg2, ..., nextposition\\ |
-- Missing arguments will be returned as nils. 'nextposition' is returned as 1e9 at the end of the string. |
function AceConsole:GetArgs(str, numargs, startpos) |
numargs = numargs or 1 |
startpos = max(startpos or 1, 1) |
local pos=startpos |
-- find start of new arg |
pos = strfind(str, "[^ ]", pos) |
if not pos then -- whoops, end of string |
return nils(numargs, 1e9) |
end |
if numargs<1 then |
return pos |
end |
-- quoted or space separated? find out which pattern to use |
local delim_or_pipe |
local ch = strsub(str, pos, pos) |
if ch=='"' then |
pos = pos + 1 |
delim_or_pipe='([|"])' |
elseif ch=="'" then |
pos = pos + 1 |
delim_or_pipe="([|'])" |
else |
delim_or_pipe="([| ])" |
end |
startpos = pos |
while true do |
-- find delimiter or hyperlink |
local ch,_ |
pos,_,ch = strfind(str, delim_or_pipe, pos) |
if not pos then break end |
if ch=="|" then |
-- some kind of escape |
if strsub(str,pos,pos+1)=="|H" then |
-- It's a |H....|hhyper link!|h |
pos=strfind(str, "|h", pos+2) -- first |h |
if not pos then break end |
pos=strfind(str, "|h", pos+2) -- second |h |
if not pos then break end |
elseif strsub(str,pos, pos+1) == "|T" then |
-- It's a |T....|t texture |
pos=strfind(str, "|t", pos+2) |
if not pos then break end |
end |
pos=pos+2 -- skip past this escape (last |h if it was a hyperlink) |
else |
-- found delimiter, done with this arg |
return strsub(str, startpos, pos-1), AceConsole:GetArgs(str, numargs-1, pos+1) |
end |
end |
-- search aborted, we hit end of string. return it all as one argument. (yes, even if it's an unterminated quote or hyperlink) |
return strsub(str, startpos), nils(numargs-1, 1e9) |
end |
--- embedding and embed handling |
local mixins = { |
"Print", |
"Printf", |
"RegisterChatCommand", |
"UnregisterChatCommand", |
"GetArgs", |
} |
-- Embeds AceConsole into the target object making the functions from the mixins list available on target:.. |
-- @param target target object to embed AceBucket in |
function AceConsole:Embed( target ) |
for k, v in pairs( mixins ) do |
target[v] = self[v] |
end |
self.embeds[target] = true |
return target |
end |
function AceConsole:OnEmbedEnable( target ) |
if AceConsole.weakcommands[target] then |
for command, func in pairs( AceConsole.weakcommands[target] ) do |
target:RegisterChatCommand( command, func, false, true ) -- nonpersisting and silent registry |
end |
end |
end |
function AceConsole:OnEmbedDisable( target ) |
if AceConsole.weakcommands[target] then |
for command, func in pairs( AceConsole.weakcommands[target] ) do |
target:UnregisterChatCommand( command ) -- TODO: this could potentially unregister a command from another application in case of command conflicts. Do we care? |
end |
end |
end |
for addon in pairs(AceConsole.embeds) do |
AceConsole:Embed(addon) |
end |
<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> |
--- 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 877 2009-11-02 15:56:50Z nevcairiel $ |
--[[ |
AceConfig-3.0 |
Very light wrapper library that combines all the AceConfig subcomponents into one more easily used whole. |
]] |
local MAJOR, MINOR = "AceConfig-3.0", 2 |
local AceConfig = LibStub:NewLibrary(MAJOR, MINOR) |
if not AceConfig then return end |
local cfgreg = LibStub("AceConfigRegistry-3.0") |
local cfgcmd = LibStub("AceConfigCmd-3.0") |
local cfgdlg = LibStub("AceConfigDialog-3.0") |
--TODO: local cfgdrp = LibStub("AceConfigDropdown-3.0") |
-- 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) |
-- @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 |
<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> |
--- 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 902 2009-12-12 14:56:14Z nevcairiel $ |
local LibStub = LibStub |
local MAJOR, MINOR = "AceConfigDialog-3.0", 43 |
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 {} |
local gui = LibStub("AceGUI-3.0") |
local reg = LibStub("AceConfigRegistry-3.0") |
-- Lua APIs |
local tconcat, tinsert, tsort, tremove = table.concat, table.insert, table.sort, table.remove |
local strmatch, format = string.match, string.format |
local assert, loadstring, error = assert, loadstring, error |
local pairs, next, select, type, unpack = pairs, next, select, type, unpack |
local rawset, tostring = rawset, tostring |
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 |
for k in pairs(t) do |
t[k] = nil |
end |
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 |
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, 1) |
if opt.type == 'multiselect' then |
GameTooltip:AddLine(user.text,0.5, 0.5, 0.8, 1) |
end |
if type(desc) == "string" then |
GameTooltip:AddLine(desc, 1, 1, 1, 1) |
end |
if type(usage) == "string" then |
GameTooltip:AddLine("Usage: "..usage, NORMAL_FONT_COLOR.r, NORMAL_FONT_COLOR.g, NORMAL_FONT_COLOR.b, 1) |
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 |
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 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 type(validated) == "string" then |
--validate function returned a message to display |
if rootframe.SetStatusText then |
rootframe:SetStatusText(validated) |
else |
-- TODO: do something else. |
end |
PlaySound("igPlayerInviteDecline") |
del(info) |
return true |
elseif not validated then |
--validate returned false |
if rootframe.SetStatusText then |
if usage then |
rootframe:SetStatusText(name..": "..usage) |
else |
if pattern then |
rootframe:SetStatusText(name..": Expected "..pattern) |
else |
rootframe:SetStatusText(name..": Invalid Value") |
end |
end |
else |
-- TODO: do something else |
end |
PlaySound("igPlayerInviteDecline") |
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 0, option.max or 100, option.step |
if step then |
value = math_floor((value - min) / step + 0.5) * step + min |
else |
value = math_max(math_min(value,max),min) |
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 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) |
end |
path[#path] = nil |
end |
end |
del(keySort) |
del(opts) |
return groups |
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.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' 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 then |
local lines = 4 |
if type(v.multiline) == "number" then |
lines = v.multiline |
end |
control:SetHeight(60 + (14*lines)) |
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' 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.min or 0,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) |
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 |
control:SetLabel(name) |
control:SetList(values) |
local value = GetOptionsMemberValue("get",v, options, path, appName) |
if not values[value] then |
value = nil |
end |
control:SetValue(value) |
control:SetCallback("OnValueChanged",ActivateControl) |
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(v.hasAlpha) |
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' 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, 1) |
if type(desc) == "string" then |
GameTooltip:AddLine(desc, 1, 1, 1, 1) |
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" |
--temp path table to pass to callbacks as we traverse the tree |
local temppath = new() |
for i = 1, #path do |
local v = path[i] |
temppath[i] = v |
group = GetSubOption(group, v) |
inline = inline or pickfirstset(v.dialogInline,v.guiInline,v.inline, false) |
parenttype = grouptype |
grouptype = group.childGroups |
end |
del(temppath) |
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 = BuildSelect(group, options, path, appName) |
select:SetGroupList(grouplist) |
select:SetUserData("grouplist", grouplist) |
local firstgroup |
for k, v in pairs(grouplist) do |
if not firstgroup or k < firstgroup then |
firstgroup = k |
end |
end |
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 |
v:Hide() |
end |
this.closeAll = nil |
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 |
--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) |
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 |
<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> |
--- 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 904 2009-12-13 11:56:37Z nevcairiel $ |
--[[ |
AceConfigCmd-3.0 |
Handles commandline optionstable access |
REQUIRES: AceConsole-3.0 for command registration (loaded on demand) |
]] |
-- TODO: plugin args |
local MAJOR, MINOR = "AceConfigCmd-3.0", 12 |
local AceConfigCmd = LibStub:NewLibrary(MAJOR, MINOR) |
if not AceConfigCmd then return end |
AceConfigCmd.commands = AceConfigCmd.commands or {} |
local commands = AceConfigCmd.commands |
local cfgreg = LibStub("AceConfigRegistry-3.0") |
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 |
if tab.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 |
--- 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 890 2009-12-06 12:50:05Z nevcairiel $ |
local MAJOR, MINOR = "AceConfigRegistry-3.0", 11 |
local AceConfigRegistry = LibStub:NewLibrary(MAJOR, MINOR) |
if not AceConfigRegistry then return end |
AceConfigRegistry.tables = AceConfigRegistry.tables or {} |
local CallbackHandler = LibStub:GetLibrary("CallbackHandler-1.0") |
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 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=optstringfunc, |
iconCoords=optmethodtable, |
handler=opttable, |
get=optmethodfalse, |
set=optmethodfalse, |
func=optmethodfalse, |
arg={["*"]=true}, |
width=optstring, |
} |
local typedkeys={ |
header={}, |
description={ |
image=optstringfunc, |
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=optstringfunc, |
imageCoords=optmethodtable, |
imageHeight=optnumber, |
imageWidth=optnumber, |
}, |
input={ |
pattern=optstring, |
usage=optstring, |
control=optstring, |
dialogControl=optstring, |
dropdownControl=optstring, |
multiline=optboolnumber, |
}, |
toggle={ |
tristate=optbool, |
image=optstringfunc, |
imageCoords=optmethodtable, |
}, |
tristate={ |
}, |
range={ |
min=optnumber, |
max=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, |
}, |
multiselect={ |
values=ismethodtable, |
style=optstring, |
tristate=optbool, |
control=optstring, |
dialogControl=optstring, |
dropdownControl=optstring, |
}, |
color={ |
hasAlpha=optbool, |
}, |
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. |
function AceConfigRegistry:RegisterOptionsTable(appName, options) |
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] 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] 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 |
<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> |
--- AceConfigTab-3.0 provides support for tab-completion to AceConfig tables. |
-- Note: This library is not yet finalized. |
-- @class file |
-- @name AceConfigTab-3.0 |
-- @release $Id: AceConfigTab-3.0.lua 769 2009-04-04 11:05:08Z nevcairiel $ |
local MAJOR, MINOR = "AceConfigTab-3.0", 1 |
local lib = LibStub:NewLibrary(MAJOR, MINOR) |
if not lib then return end |
local ac = LibStub("AceConsole-3.0") |
local function printf(...) |
DEFAULT_CHAT_FRAME:AddMessage(string.format(...)) |
end |
-- getChildren(opt, ...) |
-- |
-- Retrieve the next valid group args in an AceConfig table. |
-- |
-- opt - AceConfig options table |
-- ... - args following the slash command |
-- |
-- opt will need to be determined by the slash-command |
-- The args will be obtained using AceConsole:GetArgs() or something similar on the remainder of the line. |
-- |
-- Returns arg1, arg2, ... |
local function getLevel(opt, ...) |
-- Walk down the options tree to the last arg in the commandline, or return if it does not follow the tree. |
local path = "" |
local lastChild |
for i = 1, select('#', ...) do |
local arg = select(i, ...) |
if not arg or type(arg) == 'number' then break end |
if opt.plugins then |
for k in pairs(opt.plugins) do |
if string.lower(k) == string.lower(arg) then |
opt = opt.plugins[k] |
path = path..arg.." " |
lastChild = arg |
break |
end |
end |
elseif opt.args then |
for k in pairs(opt.args) do |
if string.lower(k) == string.lower(arg) then |
opt = opt.args[k] |
path = path..arg.." " |
lastChild = arg |
break |
end |
end |
else |
break |
end |
end |
return opt, path |
end |
local function getChildren(opt, ...) |
local lastChild, path |
opt, path, lastChild = getLevel(opt, ...) |
local args = {} |
for _, field in ipairs({"args", "plugins"}) do |
if type(opt[field]) == 'table' then |
for k in pairs(opt[field]) do |
if opt[field].type ~= 'header' then |
table.insert(args, k) |
end |
end |
end |
end |
return args, path |
end |
--LibStub("AceConfig-3.0"):RegisterOptionsTable("ag_UnitFrames", aUF.Options.table) |
local function createWordlist(t, cmdline, pos) |
local cmd = string.match(cmdline, "(/[^ \t\n]+)") |
local argslist = string.sub(cmdline, pos, this:GetCursorPosition()) |
local opt -- TODO: figure out options table using cmd |
opt = LibStub("AceConfigRegistry-3.0"):GetOptionsTable("ag_UnitFrames", "cmd", "AceTab-3.0") -- hardcoded temporarily for testing |
if not opt then return end |
local args, path = getChildren(opt, ac:GetArgs(argslist, #argslist/2)) -- largest # of args representable by a string of length #argslist, since they must be separated by spaces |
for _, v in ipairs(args) do |
table.insert(t, path..v) |
end |
end |
local function usage(t, matches, _, cmdline) |
local cmd = string.match(cmdline, "(/[^ \t\n]+)") |
local argslist = string.sub(cmdline, #cmd, this:GetCursorPosition()) |
local opt -- TODO: figure out options table using cmd |
opt = LibStub("AceConfigRegistry-3.0"):GetOptionsTable("ag_UnitFrames")("cmd", "AceTab-3.0") -- hardcoded temporarily for testing |
if not opt then return end |
local level = getLevel(opt, ac:GetArgs(argslist, #argslist/2)) -- largest # of args representable by a string of length #argslist, since they must be separated by spaces |
local option |
for _, m in pairs(matches) do |
local tail = string.match(m, "([^ \t\n]+)$") |
option = level.plugins and level.plugins[tail] or level.args and level.args[tail] |
printf("%s - %s", tail, option.desc) |
end |
end |
LibStub("AceTab-3.0"):RegisterTabCompletion("aguftest", "%/%w+ ", createWordlist, usage) |
<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="AceTab-3.0.lua"/> |
<Script file="AceConfigTab-3.0.lua"/> |
</Ui> |
--- AceTab-3.0 provides support for tab-completion. |
-- Note: This library is not yet finalized. |
-- @class file |
-- @name AceTab-3.0 |
-- @release $Id: AceTab-3.0.lua 905 2009-12-15 16:48:32Z nevcairiel $ |
local ACETAB_MAJOR, ACETAB_MINOR = 'AceTab-3.0', 5 |
local AceTab, oldminor = LibStub:NewLibrary(ACETAB_MAJOR, ACETAB_MINOR) |
if not AceTab then return end -- No upgrade needed |
AceTab.registry = AceTab.registry or {} |
-- local upvalues |
local _G = _G |
local pairs = pairs |
local ipairs = ipairs |
local type = type |
local registry = AceTab.registry |
local strfind = string.find |
local strsub = string.sub |
local strlower = string.lower |
local strformat = string.format |
local strmatch = string.match |
local function printf(...) |
DEFAULT_CHAT_FRAME:AddMessage(strformat(...)) |
end |
local function getTextBeforeCursor(this, start) |
return strsub(this:GetText(), start or 1, this:GetCursorPosition()) |
end |
-- Hook OnTabPressed and OnTextChanged for the frame, give it an empty matches table, and set its curMatch to 0, if we haven't done so already. |
local function hookFrame(f) |
if f.hookedByAceTab3 then return end |
f.hookedByAceTab3 = true |
if f == ChatFrameEditBox then |
local origCTP = ChatEdit_CustomTabPressed |
function ChatEdit_CustomTabPressed() |
if AceTab:OnTabPressed(f) then |
return origCTP() |
else |
return true |
end |
end |
else |
local origOTP = f:GetScript('OnTabPressed') |
if type(origOTP) ~= 'function' then |
origOTP = function() end |
end |
f:SetScript('OnTabPressed', function() |
if AceTab:OnTabPressed(f) then |
return origOTP() |
end |
end) |
end |
f.at3curMatch = 0 |
f.at3matches = {} |
end |
local firstPMLength |
local fallbacks, notfallbacks = {}, {} -- classifies completions into those which have preconditions and those which do not. Those without preconditions are only considered if no other completions have matches. |
local pmolengths = {} -- holds the number of characters to overwrite according to pmoverwrite and the current prematch |
-- ------------------------------------------------------------------------------ |
-- RegisterTabCompletion( descriptor, prematches, wordlist, usagefunc, listenframes, postfunc, pmoverwrite ) |
-- See http://www.wowace.com/wiki/AceTab-2.0 for detailed API documentation |
-- |
-- descriptor string Unique identifier for this tab completion set |
-- |
-- prematches string|table|nil String match(es) AFTER which this tab completion will apply. |
-- AceTab will ignore tabs NOT preceded by the string(s). |
-- If no value is passed, will check all tabs pressed in the specified editframe(s) UNLESS a more-specific tab complete applies. |
-- |
-- wordlist function|table Function that will be passed a table into which it will insert strings corresponding to all possible completions, or an equivalent table. |
-- The text in the editbox, the position of the start of the word to be completed, and the uncompleted partial word |
-- are passed as second, third, and fourth arguments, to facilitate pre-filtering or conditional formatting, if desired. |
-- |
-- usagefunc function|boolean|nil Usage statement function. Defaults to the wordlist, one per line. A boolean true squelches usage output. |
-- |
-- listenframes string|table|nil EditFrames to monitor. Defaults to ChatFrameEditBox. |
-- |
-- postfunc function|nil Post-processing function. If supplied, matches will be passed through this function after they've been identified as a match. |
-- |
-- pmoverwrite boolean|number|nil Offset the beginning of the completion string in the editbox when making a completion. Passing a boolean true indicates that we want to overwrite |
-- the entire prematch string, and passing a number will overwrite that many characters prior to the cursor. |
-- This is useful when you want to use the prematch as an indicator character, but ultimately do not want it as part of the text, itself. |
-- |
-- no return |
-- ------------------------------------------------------------------------------ |
function AceTab:RegisterTabCompletion(descriptor, prematches, wordlist, usagefunc, listenframes, postfunc, pmoverwrite) |
-- Arg checks |
if type(descriptor) ~= 'string' then error("Usage: RegisterTabCompletion(descriptor, prematches, wordlist, usagefunc, listenframes, postfunc, pmoverwrite): 'descriptor' - string expected.", 3) end |
if prematches and type(prematches) ~= 'string' and type(prematches) ~= 'table' then error("Usage: RegisterTabCompletion(descriptor, prematches, wordlist, usagefunc, listenframes, postfunc, pmoverwrite): 'prematches' - string, table, or nil expected.", 3) end |
if type(wordlist) ~= 'function' and type(wordlist) ~= 'table' then error("Usage: RegisterTabCompletion(descriptor, prematches, wordlist, usagefunc, listenframes, postfunc, pmoverwrite): 'wordlist' - function or table expected.", 3) end |
if usagefunc and type(usagefunc) ~= 'function' and type(usagefunc) ~= 'boolean' then error("Usage: RegisterTabCompletion(descriptor, prematches, wordlist, usagefunc, listenframes, postfunc, pmoverwrite): 'usagefunc' - function or boolean expected.", 3) end |
if listenframes and type(listenframes) ~= 'string' and type(listenframes) ~= 'table' then error("Usage: RegisterTabCompletion(descriptor, prematches, wordlist, usagefunc, listenframes, postfunc, pmoverwrite): 'listenframes' - string or table expected.", 3) end |
if postfunc and type(postfunc) ~= 'function' then error("Usage: RegisterTabCompletion(descriptor, prematches, wordlist, usagefunc, listenframes, postfunc, pmoverwrite): 'postfunc' - function expected.", 3) end |
if pmoverwrite and type(pmoverwrite) ~= 'boolean' and type(pmoverwrite) ~= 'number' then error("Usage: RegisterTabCompletion(descriptor, prematches, wordlist, usagefunc, listenframes, postfunc, pmoverwrite): 'pmoverwrite' - boolean or number expected.", 3) end |
local pmtable = type(prematches) == 'table' and prematches or {} |
-- Mark this group as a fallback group if no value was passed. |
if not prematches then |
pmtable[1] = "" |
fallbacks[descriptor] = true |
-- Make prematches into a one-element table if it was passed as a string. |
elseif type(prematches) == 'string' then |
pmtable[1] = prematches |
if prematches == "" then |
fallbacks[descriptor] = true |
else |
notfallbacks[descriptor] = true |
end |
end |
-- Make listenframes into a one-element table if it was not passed a table of frames. |
if not listenframes then -- default |
listenframes = { ChatFrameEditBox } |
elseif type(listenframes) ~= 'table' or type(listenframes[0]) == 'userdata' and type(listenframes.IsObjectType) == 'function' then -- single frame or framename |
listenframes = { listenframes } |
end |
-- Hook each registered listenframe and give it a matches table. |
for _, f in pairs(listenframes) do |
if type(f) == 'string' then |
f = _G[f] |
end |
if type(f) ~= 'table' or type(f[0]) ~= 'userdata' or type(f.IsObjectType) ~= 'function' then |
error(format(ACETAB_MAJOR..": Cannot register frame %q; it does not exist", f:GetName())) |
end |
if f then |
if f:GetObjectType() ~= 'EditBox' then |
error(format(ACETAB_MAJOR..": Cannot register frame %q; it is not an EditBox", f:GetName())) |
else |
hookFrame(f) |
end |
end |
end |
-- Everything checks out; register this completion. |
if not registry[descriptor] then |
registry[descriptor] = { prematches = pmtable, wordlist = wordlist, usagefunc = usagefunc, listenframes = listenframes, postfunc = postfunc, pmoverwrite = pmoverwrite } |
end |
end |
function AceTab:IsTabCompletionRegistered(descriptor) |
return registry and registry[descriptor] |
end |
function AceTab:UnregisterTabCompletion(descriptor) |
registry[descriptor] = nil |
pmolengths[descriptor] = nil |
fallbacks[descriptor] = nil |
notfallbacks[descriptor] = nil |
end |
-- ------------------------------------------------------------------------------ |
-- gcbs( s1, s2 ) |
-- |
-- s1 string First string to be compared |
-- |
-- s2 string Second string to be compared |
-- |
-- returns the greatest common substring beginning s1 and s2 |
-- ------------------------------------------------------------------------------ |
local function gcbs(s1, s2) |
if not s1 and not s2 then return end |
if not s1 then s1 = s2 end |
if not s2 then s2 = s1 end |
if #s2 < #s1 then |
s1, s2 = s2, s1 |
end |
if strfind(strlower(s2), "^"..strlower(s1)) then |
return s1 |
else |
return gcbs(strsub(s1, 1, -2), s2) |
end |
end |
local cursor -- Holds cursor position. Set in :OnTabPressed(). |
-- ------------------------------------------------------------------------------ |
-- cycleTab() |
-- For when a tab press has multiple possible completions, we need to allow the user to press tab repeatedly to cycle through them. |
-- If we have multiple possible completions, all tab presses after the first will call this function to cycle through and insert the different possible matches. |
-- This function will stop being called after OnTextChanged() is triggered by something other than AceTab (i.e. the user inputs a character). |
-- ------------------------------------------------------------------------------ |
local previousLength, cMatch, matched, postmatch |
local function cycleTab(this) |
cMatch = 0 -- Counter across all sets. The pseudo-index relevant to this value and corresponding to the current match is held in this.at3curMatch |
matched = false |
-- Check each completion group registered to this frame. |
for desc, compgrp in pairs(this.at3matches) do |
-- Loop through the valid completions for this set. |
for m, pm in pairs(compgrp) do |
cMatch = cMatch + 1 |
if cMatch == this.at3curMatch then -- we're back to where we left off last time through the combined list |
this.at3lastMatch = m |
this.at3lastWord = pm |
this.at3curMatch = cMatch + 1 -- save the new cMatch index |
matched = true |
break |
end |
end |
if matched then break end |
end |
-- If our index is beyond the end of the list, reset the original uncompleted substring and let the cycle start over next time tab is pressed. |
if not matched then |
this.at3lastMatch = this.at3origMatch |
this.at3lastWord = this.at3origWord |
this.at3curMatch = 1 |
end |
-- Insert the completion. |
this:HighlightText(this.at3matchStart-1, cursor) |
this:Insert(this.at3lastWord or '') |
this.at3_last_precursor = getTextBeforeCursor(this) or '' |
end |
local IsSecureCmd = IsSecureCmd |
local cands, candUsage = {}, {} |
local numMatches = 0 |
local firstMatch, hasNonFallback, allGCBS, setGCBS, usage |
local text_precursor, text_all, text_pmendToCursor |
local matches, usagefunc -- convenience locals |
-- Fill the this.at3matches[descriptor] tables with matching completion pairs for each entry, based on |
-- the partial string preceding the cursor position and using the corresponding registered wordlist. |
-- |
-- The entries of the matches tables are of the format raw_match = formatted_match, where raw_match is the plaintext completion and |
-- formatted_match is the match after being formatted/altered/processed by the registered postfunc. |
-- If no postfunc exists, then the formatted and raw matches are the same. |
local pms, pme, pmt, prematchStart, prematchEnd, text_prematch, entry |
local function fillMatches(this, desc, fallback) |
entry = registry[desc] |
-- See what frames are registered for this completion group. If the frame in which we pressed tab is one of them, then we start building matches. |
for _, f in ipairs(entry.listenframes) do |
if f == this then |
-- Try each precondition string registered for this completion group. |
for _, prematch in ipairs(entry.prematches) do |
-- Test if our prematch string is satisfied. |
-- If it is, then we find its last occurence prior to the cursor, calculate and store its pmoverwrite value (if applicable), and start considering completions. |
if fallback then prematch = "%s" end |
-- Find the last occurence of the prematch before the cursor. |
pms, pme, pmt = nil, 1, '' |
text_prematch, prematchEnd, prematchStart = nil, nil, nil |
while true do |
pms, pme, pmt = strfind(text_precursor, "("..prematch..")", pme) |
if pms then |
prematchStart, prematchEnd, text_prematch = pms, pme, pmt |
pme = pme + 1 |
else |
break |
end |
end |
if not prematchStart and fallback then |
prematchStart, prematchEnd, text_prematch = 0, 0, '' |
end |
if prematchStart then |
-- text_pmendToCursor should be the sub-word/phrase to be completed. |
text_pmendToCursor = strsub(text_precursor, prematchEnd + 1) |
-- How many characters should we eliminate before the completion before writing it in. |
pmolengths[desc] = entry.pmoverwrite == true and #text_prematch or entry.pmoverwrite or 0 |
-- This is where we will insert completions, taking the prematch overwrite into account. |
this.at3matchStart = prematchEnd + 1 - (pmolengths[desc] or 0) |
-- We're either a non-fallback set or all completions thus far have been fallback sets, and the precondition matches. |
-- Create cands from the registered wordlist, filling it with all potential (unfiltered) completion strings. |
local wordlist = entry.wordlist |
local cands = type(wordlist) == 'table' and wordlist or {} |
if type(wordlist) == 'function' then |
wordlist(cands, text_all, prematchEnd + 1, text_pmendToCursor) |
end |
if cands ~= false then |
matches = this.at3matches[desc] or {} |
for i in pairs(matches) do matches[i] = nil end |
-- Check each of the entries in cands to see if it completes the word before the cursor. |
-- Finally, increment our match count and set firstMatch, if appropriate. |
for _, m in ipairs(cands) do |
if strfind(strlower(m), strlower(text_pmendToCursor), 1, 1) == 1 then -- we have a matching completion! |
hasNonFallback = not fallback |
matches[m] = entry.postfunc and entry.postfunc(m, prematchEnd + 1, text_all) or m |
numMatches = numMatches + 1 |
if numMatches == 1 then |
firstMatch = matches[m] |
firstPMLength = pmolengths[desc] or 0 |
end |
end |
end |
this.at3matches[desc] = numMatches > 0 and matches or nil |
end |
end |
end |
end |
end |
end |
function AceTab:OnTabPressed(this) |
if this:GetText() == '' then return true end |
-- allow Blizzard to handle slash commands, themselves |
if this == ChatFrameEditBox then |
local command = this:GetText() |
if strfind(command, "^/[%a%d_]+$") then |
return true |
end |
local cmd = strmatch(command, "^/[%a%d_]+") |
if cmd and IsSecureCmd(cmd) then |
return true |
end |
end |
cursor = this:GetCursorPosition() |
text_all = this:GetText() |
text_precursor = getTextBeforeCursor(this) or '' |
-- If we've already found some matches and haven't done anything since the last tab press, then (continue) cycling matches. |
-- Otherwise, reset this frame's matches and proceed to creating our list of possible completions. |
this.at3lastMatch = this.at3curMatch > 0 and (this.at3lastMatch or this.at3origWord) |
-- Detects if we've made any edits since the last tab press. If not, continue cycling completions. |
if text_precursor == this.at3_last_precursor then |
return cycleTab(this) |
else |
for i in pairs(this.at3matches) do this.at3matches[i] = nil end |
this.at3curMatch = 0 |
this.at3origWord = nil |
this.at3origMatch = nil |
this.at3lastWord = nil |
this.at3lastMatch = nil |
this.at3_last_precursor = text_precursor |
end |
numMatches = 0 |
firstMatch = nil |
firstPMLength = 0 |
hasNonFallback = false |
for i in pairs(pmolengths) do pmolengths[i] = nil end |
for desc in pairs(notfallbacks) do |
fillMatches(this, desc) |
end |
if not hasNonFallback then |
for desc in pairs(fallbacks) do |
fillMatches(this, desc, true) |
end |
end |
if not firstMatch then |
this.at3_last_precursor = "\0" |
return true |
end |
-- We want to replace the entire word with our completion, so highlight it up to the cursor. |
-- If only one match exists, then stick it in there and append a space. |
if numMatches == 1 then |
-- HighlightText takes the value AFTER which the highlighting starts, so we have to subtract 1 to have it start before the first character. |
this:HighlightText(this.at3matchStart-1, cursor) |
this:Insert(firstMatch) |
this:Insert(" ") |
else |
-- Otherwise, we want to begin cycling through the valid completions. |
-- Beginning a cycle also causes the usage statement to be printed, if one exists. |
-- Print usage statements for each possible completion (and gather up the GCBS of all matches while we're walking the tables). |
allGCBS = nil |
for desc, matches in pairs(this.at3matches) do |
-- Don't print usage statements for fallback completion groups if we have 'real' completion groups with matches. |
if hasNonFallback and fallbacks[desc] then break end |
-- Use the group's description as a heading for its usage statements. |
DEFAULT_CHAT_FRAME:AddMessage(desc..":") |
usagefunc = registry[desc].usagefunc |
if not usagefunc then |
-- No special usage processing; just print a list of the (formatted) matches. |
for m, fm in pairs(matches) do |
DEFAULT_CHAT_FRAME:AddMessage(fm) |
allGCBS = gcbs(allGCBS, m) |
end |
else |
-- Print a usage statement based on the corresponding registered usagefunc. |
-- candUsage is the table passed to usagefunc to be filled with candidate = usage_statement pairs. |
if type(usagefunc) == 'function' then |
for i in pairs(candUsage) do candUsage[i] = nil end |
-- usagefunc takes the greatest common substring of valid matches as one of its args, so let's find that now. |
-- TODO: Make the GCBS function accept a vararg or table, after which we can just pass in the list of matches. |
setGCBS = nil |
for m in pairs(matches) do |
setGCBS = gcbs(setGCBS, m) |
end |
allGCBS = gcbs(allGCBS, setGCBS) |
usage = usagefunc(candUsage, matches, setGCBS, strsub(text_precursor, 1, prematchEnd)) |
-- If the usagefunc returns a string, then the entire usage statement has been taken care of by usagefunc, and we need only to print it... |
if type(usage) == 'string' then |
DEFAULT_CHAT_FRAME:AddMessage(usage) |
-- ...otherwise, it should have filled candUsage with candidate-usage statement pairs, and we need to print the matching ones. |
elseif next(candUsage) and numMatches > 0 then |
for m, fm in pairs(matches) do |
if candUsage[m] then DEFAULT_CHAT_FRAME:AddMessage(strformat("%s - %s", fm, candUsage[m])) end |
end |
end |
end |
end |
-- Replace the original string with the greatest common substring of all valid completions. |
this.at3curMatch = 1 |
this.at3origWord = strsub(text_precursor, this.at3matchStart, this.at3matchStart + pmolengths[desc] - 1) .. allGCBS or "" |
this.at3origMatch = allGCBS or "" |
this.at3lastWord = this.at3origWord |
this.at3lastMatch = this.at3origMatch |
this:HighlightText(this.at3matchStart-1, cursor) |
this:Insert(this.at3origWord) |
this.at3_last_precursor = getTextBeforeCursor(this) or '' |
end |
end |
end |
<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="AceSerializer-3.0.lua"/> |
</Ui> |
--- **AceSerializer-3.0** can serialize any variable (except functions or userdata) into a string format, |
-- that can be send over the addon comm channel. AceSerializer was designed to keep all data intact, especially |
-- very large numbers or floating point numbers, and table structures. The only caveat currently is, that multiple |
-- references to the same table will be send individually. |
-- |
-- **AceSerializer-3.0** can be embeded into your addon, either explicitly by calling AceSerializer:Embed(MyAddon) or by |
-- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object |
-- and can be accessed directly, without having to explicitly call AceSerializer itself.\\ |
-- It is recommended to embed AceSerializer, otherwise you'll have to specify a custom `self` on all calls you |
-- make into AceSerializer. |
-- @class file |
-- @name AceSerializer-3.0 |
-- @release $Id: AceSerializer-3.0.lua 877 2009-11-02 15:56:50Z nevcairiel $ |
local MAJOR,MINOR = "AceSerializer-3.0", 2 |
local AceSerializer, oldminor = LibStub:NewLibrary(MAJOR, MINOR) |
if not AceSerializer then return end |
-- Lua APIs |
local strbyte, strchar, gsub, gmatch, format = string.byte, string.char, string.gsub, string.gmatch, string.format |
local assert, error, pcall = assert, error, pcall |
local type, tostring, tonumber = type, tostring, tonumber |
local pairs, select, frexp = pairs, select, math.frexp |
local tconcat = table.concat |
-- quick copies of string representations of wonky numbers |
local serNaN = tostring(0/0) |
local serInf = tostring(1/0) |
local serNegInf = tostring(-1/0) |
-- Serialization functions |
local function SerializeStringHelper(ch) -- Used by SerializeValue for strings |
-- We use \126 ("~") as an escape character for all nonprints plus a few more |
local n = strbyte(ch) |
if n<=32 then -- nonprint + space |
return "\126"..strchar(n+64) |
elseif n==94 then -- value separator |
return "\126\125" |
elseif n==126 then -- our own escape character |
return "\126\124" |
elseif n==127 then -- nonprint (DEL) |
return "\126\123" |
else |
assert(false) -- can't be reached if caller uses a sane regex |
end |
end |
local function SerializeValue(v, res, nres) |
-- We use "^" as a value separator, followed by one byte for type indicator |
local t=type(v) |
if t=="string" then -- ^S = string (escaped to remove nonprints, "^"s, etc) |
res[nres+1] = "^S" |
res[nres+2] = gsub(v,"[%c \94\126\127]", SerializeStringHelper) |
nres=nres+2 |
elseif t=="number" then -- ^N = number (just tostring()ed) or ^F (float components) |
local str = tostring(v) |
if tonumber(str)==v or str==serNaN or str==serInf or str==serNegInf then |
-- translates just fine, transmit as-is |
res[nres+1] = "^N" |
res[nres+2] = str |
nres=nres+2 |
else |
local m,e = frexp(v) |
res[nres+1] = "^F" |
res[nres+2] = format("%.0f",m*2^53) -- force mantissa to become integer (it's originally 0.5--0.9999) |
res[nres+3] = "^f" |
res[nres+4] = tostring(e-53) -- adjust exponent to counteract mantissa manipulation |
nres=nres+4 |
end |
elseif t=="table" then -- ^T...^t = table (list of key,value pairs) |
nres=nres+1 |
res[nres] = "^T" |
for k,v in pairs(v) do |
nres = SerializeValue(k, res, nres) |
nres = SerializeValue(v, res, nres) |
end |
nres=nres+1 |
res[nres] = "^t" |
elseif t=="boolean" then -- ^B = true, ^b = false |
nres=nres+1 |
if v then |
res[nres] = "^B" -- true |
else |
res[nres] = "^b" -- false |
end |
elseif t=="nil" then -- ^Z = nil (zero, "N" was taken :P) |
nres=nres+1 |
res[nres] = "^Z" |
else |
error(MAJOR..": Cannot serialize a value of type '"..t.."'") -- can't produce error on right level, this is wildly recursive |
end |
return nres |
end |
local serializeTbl = { "^1" } -- "^1" = Hi, I'm data serialized by AceSerializer protocol rev 1 |
--- Serialize the data passed into the function. |
-- Takes a list of values (strings, numbers, booleans, nils, tables) |
-- and returns it in serialized form (a string).\\ |
-- May throw errors on invalid data types. |
-- @param ... List of values to serialize |
-- @return The data in its serialized form (string) |
function AceSerializer:Serialize(...) |
local nres = 1 |
for i=1,select("#", ...) do |
local v = select(i, ...) |
nres = SerializeValue(v, serializeTbl, nres) |
end |
serializeTbl[nres+1] = "^^" -- "^^" = End of serialized data |
return tconcat(serializeTbl, "", 1, nres+1) |
end |
-- Deserialization functions |
local function DeserializeStringHelper(escape) |
if escape<"~\123" then |
return strchar(strbyte(escape,2,2)-64) |
elseif escape=="~\123" then |
return "\127" |
elseif escape=="~\124" then |
return "\126" |
elseif escape=="~\125" then |
return "\94" |
end |
error("DeserializeStringHelper got called for '"..escape.."'?!?") -- can't be reached unless regex is screwed up |
end |
local function DeserializeNumberHelper(number) |
if number == serNaN then |
return 0/0 |
elseif number == serNegInf then |
return -1/0 |
elseif number == serInf then |
return 1/0 |
else |
return tonumber(number) |
end |
end |
-- DeserializeValue: worker function for :Deserialize() |
-- It works in two modes: |
-- Main (top-level) mode: Deserialize a list of values and return them all |
-- Recursive (table) mode: Deserialize only a single value (_may_ of course be another table with lots of subvalues in it) |
-- |
-- The function _always_ works recursively due to having to build a list of values to return |
-- |
-- Callers are expected to pcall(DeserializeValue) to trap errors |
local function DeserializeValue(iter,single,ctl,data) |
if not single then |
ctl,data = iter() |
end |
if not ctl then |
error("Supplied data misses AceSerializer terminator ('^^')") |
end |
if ctl=="^^" then |
-- ignore extraneous data |
return |
end |
local res |
if ctl=="^S" then |
res = gsub(data, "~.", DeserializeStringHelper) |
elseif ctl=="^N" then |
res = DeserializeNumberHelper(data) |
if not res then |
error("Invalid serialized number: '"..tostring(data).."'") |
end |
elseif ctl=="^F" then -- ^F<mantissa>^f<exponent> |
local ctl2,e = iter() |
if ctl2~="^f" then |
error("Invalid serialized floating-point number, expected '^f', not '"..tostring(ctl2).."'") |
end |
local m=tonumber(data) |
e=tonumber(e) |
if not (m and e) then |
error("Invalid serialized floating-point number, expected mantissa and exponent, got '"..tostring(m).."' and '"..tostring(e).."'") |
end |
res = m*(2^e) |
elseif ctl=="^B" then -- yeah yeah ignore data portion |
res = true |
elseif ctl=="^b" then -- yeah yeah ignore data portion |
res = false |
elseif ctl=="^Z" then -- yeah yeah ignore data portion |
res = nil |
elseif ctl=="^T" then |
-- ignore ^T's data, future extensibility? |
res = {} |
local k,v |
while true do |
ctl,data = iter() |
if ctl=="^t" then break end -- ignore ^t's data |
k = DeserializeValue(iter,true,ctl,data) |
if k==nil then |
error("Invalid AceSerializer table format (no table end marker)") |
end |
ctl,data = iter() |
v = DeserializeValue(iter,true,ctl,data) |
if v==nil then |
error("Invalid AceSerializer table format (no table end marker)") |
end |
res[k]=v |
end |
else |
error("Invalid AceSerializer control code '"..ctl.."'") |
end |
if not single then |
return res,DeserializeValue(iter) |
else |
return res |
end |
end |
--- Deserializes the data into its original values. |
-- Accepts serialized data, ignoring all control characters and whitespace. |
-- @param str The serialized data (from :Serialize) |
-- @return true followed by a list of values, OR false followed by an error message |
function AceSerializer:Deserialize(str) |
str = gsub(str, "[%c ]", "") -- ignore all control characters; nice for embedding in email and stuff |
local iter = gmatch(str, "(^.)([^^]*)") -- Any ^x followed by string of non-^ |
local ctl,data = iter() |
if not ctl or ctl~="^1" then |
-- we purposefully ignore the data portion of the start code, it can be used as an extension mechanism |
return false, "Supplied data is not AceSerializer data (rev 1)" |
end |
return pcall(DeserializeValue, iter) |
end |
---------------------------------------- |
-- Base library stuff |
---------------------------------------- |
AceSerializer.internals = { -- for test scripts |
SerializeValue = SerializeValue, |
SerializeStringHelper = SerializeStringHelper, |
} |
local mixins = { |
"Serialize", |
"Deserialize", |
} |
AceSerializer.embeds = AceSerializer.embeds or {} |
function AceSerializer:Embed(target) |
for k, v in pairs(mixins) do |
target[v] = self[v] |
end |
self.embeds[target] = true |
return target |
end |
-- Update embeds |
for target, v in pairs(AceSerializer.embeds) do |
AceSerializer:Embed(target) |
end |
<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="AceBucket-3.0.lua"/> |
</Ui> |
--- A bucket to catch events in. **AceBucket-3.0** provides throttling of events that fire in bursts and |
-- your addon only needs to know about the full burst. |
-- |
-- This Bucket implementation works as follows:\\ |
-- Initially, no schedule is running, and its waiting for the first event to happen.\\ |
-- The first event will start the bucket, and get the scheduler running, which will collect all |
-- events in the given interval. When that interval is reached, the bucket is pushed to the |
-- callback and a new schedule is started. When a bucket is empty after its interval, the scheduler is |
-- stopped, and the bucket is only listening for the next event to happen, basically back in its initial state. |
-- |
-- In addition, the buckets collect information about the "arg1" argument of the events that fire, and pass those as a |
-- table to your callback. This functionality was mostly designed for the UNIT_* events.\\ |
-- The table will have the different values of "arg1" as keys, and the number of occurances as their value, e.g.\\ |
-- { ["player"] = 2, ["target"] = 1, ["party1"] = 1 } |
-- |
-- **AceBucket-3.0** can be embeded into your addon, either explicitly by calling AceBucket:Embed(MyAddon) or by |
-- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object |
-- and can be accessed directly, without having to explicitly call AceBucket itself.\\ |
-- It is recommended to embed AceBucket, otherwise you'll have to specify a custom `self` on all calls you |
-- make into AceBucket. |
-- @usage |
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("BucketExample", "AceBucket-3.0") |
-- |
-- function MyAddon:OnEnable() |
-- -- Register a bucket that listens to all the HP related events, |
-- -- and fires once per second |
-- self:RegisterBucketEvent({"UNIT_HEALTH", "UNIT_MAXHEALTH"}, 1, "UpdateHealth") |
-- end |
-- |
-- function MyAddon:UpdateHealth(units) |
-- if units.player then |
-- print("Your HP changed!") |
-- end |
-- end |
-- @class file |
-- @name AceBucket-3.0.lua |
-- @release $Id: AceBucket-3.0.lua 895 2009-12-06 16:28:55Z nevcairiel $ |
local MAJOR, MINOR = "AceBucket-3.0", 3 |
local AceBucket, oldminor = LibStub:NewLibrary(MAJOR, MINOR) |
if not AceBucket then return end -- No Upgrade needed |
AceBucket.buckets = AceBucket.buckets or {} |
AceBucket.embeds = AceBucket.embeds or {} |
-- the libraries will be lazyly bound later, to avoid errors due to loading order issues |
local AceEvent, AceTimer |
-- Lua APIs |
local tconcat = table.concat |
local type, next, pairs, select = type, next, pairs, select |
local tonumber, tostring, rawset = tonumber, tostring, rawset |
local assert, loadstring, error = assert, loadstring, error |
-- 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, geterrorhandler |
local bucketCache = setmetatable({}, {__mode='k'}) |
--[[ |
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 |
-- FireBucket ( bucket ) |
-- |
-- send the bucket to the callback function and schedule the next FireBucket in interval seconds |
local function FireBucket(bucket) |
local received = bucket.received |
-- we dont want to fire empty buckets |
if next(received) then |
local callback = bucket.callback |
if type(callback) == "string" then |
safecall(bucket.object[callback], bucket.object, received) |
else |
safecall(callback, received) |
end |
for k in pairs(received) do |
received[k] = nil |
end |
-- if the bucket was not empty, schedule another FireBucket in interval seconds |
bucket.timer = AceTimer.ScheduleTimer(bucket, FireBucket, bucket.interval, bucket) |
else -- if it was empty, clear the timer and wait for the next event |
bucket.timer = nil |
end |
end |
-- BucketHandler ( event, arg1 ) |
-- |
-- callback func for AceEvent |
-- stores arg1 in the received table, and schedules the bucket if necessary |
local function BucketHandler(self, event, arg1) |
if arg1 == nil then |
arg1 = "nil" |
end |
self.received[arg1] = (self.received[arg1] or 0) + 1 |
-- if we are not scheduled yet, start a timer on the interval for our bucket to be cleared |
if not self.timer then |
self.timer = AceTimer.ScheduleTimer(self, FireBucket, self.interval, self) |
end |
end |
-- RegisterBucket( event, interval, callback, isMessage ) |
-- |
-- event(string or table) - the event, or a table with the events, that this bucket listens to |
-- interval(int) - time between bucket fireings |
-- callback(func or string) - function pointer, or method name of the object, that gets called when the bucket is cleared |
-- isMessage(boolean) - register AceEvent Messages instead of game events |
local function RegisterBucket(self, event, interval, callback, isMessage) |
-- try to fetch the librarys |
if not AceEvent or not AceTimer then |
AceEvent = LibStub:GetLibrary("AceEvent-3.0", true) |
AceTimer = LibStub:GetLibrary("AceTimer-3.0", true) |
if not AceEvent or not AceTimer then |
error(MAJOR .. " requires AceEvent-3.0 and AceTimer-3.0", 3) |
end |
end |
if type(event) ~= "string" and type(event) ~= "table" then error("Usage: RegisterBucket(event, interval, callback): 'event' - string or table expected.", 3) end |
if not callback then |
if type(event) == "string" then |
callback = event |
else |
error("Usage: RegisterBucket(event, interval, callback): cannot omit callback when event is not a string.", 3) |
end |
end |
if not tonumber(interval) then error("Usage: RegisterBucket(event, interval, callback): 'interval' - number expected.", 3) end |
if type(callback) ~= "string" and type(callback) ~= "function" then error("Usage: RegisterBucket(event, interval, callback): 'callback' - string or function or nil expected.", 3) end |
if type(callback) == "string" and type(self[callback]) ~= "function" then error("Usage: RegisterBucket(event, interval, callback): 'callback' - method not found on target object.", 3) end |
local bucket = next(bucketCache) |
if bucket then |
bucketCache[bucket] = nil |
else |
bucket = { handler = BucketHandler, received = {} } |
end |
bucket.object, bucket.callback, bucket.interval = self, callback, tonumber(interval) |
local regFunc = isMessage and AceEvent.RegisterMessage or AceEvent.RegisterEvent |
if type(event) == "table" then |
for _,e in pairs(event) do |
regFunc(bucket, e, "handler") |
end |
else |
regFunc(bucket, event, "handler") |
end |
local handle = tostring(bucket) |
AceBucket.buckets[handle] = bucket |
return handle |
end |
--- Register a Bucket for an event (or a set of events) |
-- @param event The event to listen for, or a table of events. |
-- @param interval The Bucket interval (burst interval) |
-- @param callback The callback function, either as a function reference, or a string pointing to a method of the addon object. |
-- @return The handle of the bucket (for unregistering) |
-- @usage |
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceBucket-3.0") |
-- MyAddon:RegisterBucketEvent("BAG_UPDATE", 0.2, "UpdateBags") |
-- |
-- function MyAddon:UpdateBags() |
-- -- do stuff |
-- end |
function AceBucket:RegisterBucketEvent(event, interval, callback) |
return RegisterBucket(self, event, interval, callback, false) |
end |
--- Register a Bucket for an AceEvent-3.0 addon message (or a set of messages) |
-- @param message The message to listen for, or a table of messages. |
-- @param interval The Bucket interval (burst interval) |
-- @param callback The callback function, either as a function reference, or a string pointing to a method of the addon object. |
-- @return The handle of the bucket (for unregistering) |
-- @usage |
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceBucket-3.0") |
-- MyAddon:RegisterBucketEvent("SomeAddon_InformationMessage", 0.2, "ProcessData") |
-- |
-- function MyAddon:ProcessData() |
-- -- do stuff |
-- end |
function AceBucket:RegisterBucketMessage(message, interval, callback) |
return RegisterBucket(self, message, interval, callback, true) |
end |
--- Unregister any events and messages from the bucket and clear any remaining data. |
-- @param handle The handle of the bucket as returned by RegisterBucket* |
function AceBucket:UnregisterBucket(handle) |
local bucket = AceBucket.buckets[handle] |
if bucket then |
AceEvent.UnregisterAllEvents(bucket) |
AceEvent.UnregisterAllMessages(bucket) |
-- clear any remaining data in the bucket |
for k in pairs(bucket.received) do |
bucket.received[k] = nil |
end |
if bucket.timer then |
AceTimer.CancelTimer(bucket, bucket.timer) |
bucket.timer = nil |
end |
AceBucket.buckets[handle] = nil |
-- store our bucket in the cache |
bucketCache[bucket] = true |
end |
end |
--- Unregister all buckets of the current addon object (or custom "self"). |
function AceBucket:UnregisterAllBuckets() |
-- hmm can we do this more efficient? (it is not done often so shouldn't matter much) |
for handle, bucket in pairs(AceBucket.buckets) do |
if bucket.object == self then |
AceBucket.UnregisterBucket(self, handle) |
end |
end |
end |
-- embedding and embed handling |
local mixins = { |
"RegisterBucketEvent", |
"RegisterBucketMessage", |
"UnregisterBucket", |
"UnregisterAllBuckets", |
} |
-- Embeds AceBucket into the target object making the functions from the mixins list available on target:.. |
-- @param target target object to embed AceBucket in |
function AceBucket:Embed( target ) |
for _, v in pairs( mixins ) do |
target[v] = self[v] |
end |
self.embeds[target] = true |
return target |
end |
function AceBucket:OnEmbedDisable( target ) |
target:UnregisterAllBuckets() |
end |
for addon in pairs(AceBucket.embeds) do |
AceBucket:Embed(addon) |
end |
<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="CallbackHandler-1.0.lua"/> |
</Ui> |
--[[ $Id: CallbackHandler-1.0.lua 895 2009-12-06 16:28:55Z nevcairiel $ ]] |
local MAJOR, MINOR = "CallbackHandler-1.0", 5 |
local CallbackHandler = LibStub:NewLibrary(MAJOR, MINOR) |
if not CallbackHandler then return end -- No upgrade needed |
local meta = {__index = function(tbl, key) tbl[key] = {} return tbl[key] end} |
-- Lua APIs |
local tconcat = table.concat |
local assert, error, loadstring = assert, error, loadstring |
local setmetatable, rawset, rawget = setmetatable, rawset, rawget |
local next, select, pairs, type, tostring = next, select, pairs, type, tostring |
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded |
-- List them here for Mikk's FindGlobals script |
-- GLOBALS: geterrorhandler |
local xpcall = xpcall |
local function errorhandler(err) |
return geterrorhandler()(err) |
end |
local function CreateDispatcher(argCount) |
local code = [[ |
local next, xpcall, eh = ... |
local method, ARGS |
local function call() method(ARGS) end |
local function dispatch(handlers, ...) |
local index |
index, method = next(handlers) |
if not method then return end |
local OLD_ARGS = ARGS |
ARGS = ... |
repeat |
xpcall(call, eh) |
index, method = next(handlers, index) |
until not method |
ARGS = OLD_ARGS |
end |
return dispatch |
]] |
local ARGS, OLD_ARGS = {}, {} |
for i = 1, argCount do ARGS[i], OLD_ARGS[i] = "arg"..i, "old_arg"..i end |
code = code:gsub("OLD_ARGS", tconcat(OLD_ARGS, ", ")):gsub("ARGS", tconcat(ARGS, ", ")) |
return assert(loadstring(code, "safecall Dispatcher["..argCount.."]"))(next, xpcall, errorhandler) |
end |
local Dispatchers = setmetatable({}, {__index=function(self, argCount) |
local dispatcher = CreateDispatcher(argCount) |
rawset(self, argCount, dispatcher) |
return dispatcher |
end}) |
-------------------------------------------------------------------------- |
-- CallbackHandler:New |
-- |
-- target - target object to embed public APIs in |
-- RegisterName - name of the callback registration API, default "RegisterCallback" |
-- UnregisterName - name of the callback unregistration API, default "UnregisterCallback" |
-- UnregisterAllName - name of the API to unregister all callbacks, default "UnregisterAllCallbacks". false == don't publish this API. |
function CallbackHandler:New(target, RegisterName, UnregisterName, UnregisterAllName, OnUsed, OnUnused) |
-- TODO: Remove this after beta has gone out |
assert(not OnUsed and not OnUnused, "ACE-80: OnUsed/OnUnused are deprecated. Callbacks are now done to registry.OnUsed and registry.OnUnused") |
RegisterName = RegisterName or "RegisterCallback" |
UnregisterName = UnregisterName or "UnregisterCallback" |
if UnregisterAllName==nil then -- false is used to indicate "don't want this method" |
UnregisterAllName = "UnregisterAllCallbacks" |
end |
-- we declare all objects and exported APIs inside this closure to quickly gain access |
-- to e.g. function names, the "target" parameter, etc |
-- Create the registry object |
local events = setmetatable({}, meta) |
local registry = { recurse=0, events=events } |
-- registry:Fire() - fires the given event/message into the registry |
function registry:Fire(eventname, ...) |
if not rawget(events, eventname) or not next(events[eventname]) then return end |
local oldrecurse = registry.recurse |
registry.recurse = oldrecurse + 1 |
Dispatchers[select('#', ...) + 1](events[eventname], eventname, ...) |
registry.recurse = oldrecurse |
if registry.insertQueue and oldrecurse==0 then |
-- Something in one of our callbacks wanted to register more callbacks; they got queued |
for eventname,callbacks in pairs(registry.insertQueue) do |
local first = not rawget(events, eventname) or not next(events[eventname]) -- test for empty before. not test for one member after. that one member may have been overwritten. |
for self,func in pairs(callbacks) do |
events[eventname][self] = func |
-- fire OnUsed callback? |
if first and registry.OnUsed then |
registry.OnUsed(registry, target, eventname) |
first = nil |
end |
end |
end |
registry.insertQueue = nil |
end |
end |
-- Registration of a callback, handles: |
-- self["method"], leads to self["method"](self, ...) |
-- self with function ref, leads to functionref(...) |
-- "addonId" (instead of self) with function ref, leads to functionref(...) |
-- all with an optional arg, which, if present, gets passed as first argument (after self if present) |
target[RegisterName] = function(self, eventname, method, ... --[[actually just a single arg]]) |
if type(eventname) ~= "string" then |
error("Usage: "..RegisterName.."(eventname, method[, arg]): 'eventname' - string expected.", 2) |
end |
method = method or eventname |
local first = not rawget(events, eventname) or not next(events[eventname]) -- test for empty before. not test for one member after. that one member may have been overwritten. |
if type(method) ~= "string" and type(method) ~= "function" then |
error("Usage: "..RegisterName.."(\"eventname\", \"methodname\"): 'methodname' - string or function expected.", 2) |
end |
local regfunc |
if type(method) == "string" then |
-- self["method"] calling style |
if type(self) ~= "table" then |
error("Usage: "..RegisterName.."(\"eventname\", \"methodname\"): self was not a table?", 2) |
elseif self==target then |
error("Usage: "..RegisterName.."(\"eventname\", \"methodname\"): do not use Library:"..RegisterName.."(), use your own 'self'", 2) |
elseif type(self[method]) ~= "function" then |
error("Usage: "..RegisterName.."(\"eventname\", \"methodname\"): 'methodname' - method '"..tostring(method).."' not found on self.", 2) |
end |
if select("#",...)>=1 then -- this is not the same as testing for arg==nil! |
local arg=select(1,...) |
regfunc = function(...) self[method](self,arg,...) end |
else |
regfunc = function(...) self[method](self,...) end |
end |
else |
-- function ref with self=object or self="addonId" |
if type(self)~="table" and type(self)~="string" then |
error("Usage: "..RegisterName.."(self or \"addonId\", eventname, method): 'self or addonId': table or string expected.", 2) |
end |
if select("#",...)>=1 then -- this is not the same as testing for arg==nil! |
local arg=select(1,...) |
regfunc = function(...) method(arg,...) end |
else |
regfunc = method |
end |
end |
if events[eventname][self] or registry.recurse<1 then |
-- if registry.recurse<1 then |
-- we're overwriting an existing entry, or not currently recursing. just set it. |
events[eventname][self] = regfunc |
-- fire OnUsed callback? |
if registry.OnUsed and first then |
registry.OnUsed(registry, target, eventname) |
end |
else |
-- we're currently processing a callback in this registry, so delay the registration of this new entry! |
-- yes, we're a bit wasteful on garbage, but this is a fringe case, so we're picking low implementation overhead over garbage efficiency |
registry.insertQueue = registry.insertQueue or setmetatable({},meta) |
registry.insertQueue[eventname][self] = regfunc |
end |
end |
-- Unregister a callback |
target[UnregisterName] = function(self, eventname) |
if not self or self==target then |
error("Usage: "..UnregisterName.."(eventname): bad 'self'", 2) |
end |
if type(eventname) ~= "string" then |
error("Usage: "..UnregisterName.."(eventname): 'eventname' - string expected.", 2) |
end |
if rawget(events, eventname) and events[eventname][self] then |
events[eventname][self] = nil |
-- Fire OnUnused callback? |
if registry.OnUnused and not next(events[eventname]) then |
registry.OnUnused(registry, target, eventname) |
end |
end |
if registry.insertQueue and rawget(registry.insertQueue, eventname) and registry.insertQueue[eventname][self] then |
registry.insertQueue[eventname][self] = nil |
end |
end |
-- OPTIONAL: Unregister all callbacks for given selfs/addonIds |
if UnregisterAllName then |
target[UnregisterAllName] = function(...) |
if select("#",...)<1 then |
error("Usage: "..UnregisterAllName.."([whatFor]): missing 'self' or \"addonId\" to unregister events for.", 2) |
end |
if select("#",...)==1 and ...==target then |
error("Usage: "..UnregisterAllName.."([whatFor]): supply a meaningful 'self' or \"addonId\"", 2) |
end |
for i=1,select("#",...) do |
local self = select(i,...) |
if registry.insertQueue then |
for eventname, callbacks in pairs(registry.insertQueue) do |
if callbacks[self] then |
callbacks[self] = nil |
end |
end |
end |
for eventname, callbacks in pairs(events) do |
if callbacks[self] then |
callbacks[self] = nil |
-- Fire OnUnused callback? |
if registry.OnUnused and not next(callbacks) then |
registry.OnUnused(registry, target, eventname) |
end |
end |
end |
end |
end |
end |
return registry |
end |
-- CallbackHandler purposefully does NOT do explicit embedding. Nor does it |
-- try to upgrade old implicit embeds since the system is selfcontained and |
-- relies on closures to work. |
<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="AceTimer-3.0.lua"/> |
</Ui> |
--- **AceTimer-3.0** provides a central facility for registering timers. |
-- AceTimer supports one-shot timers and repeating timers. All timers are stored in an efficient |
-- data structure that allows easy dispatching and fast rescheduling. Timers can be registered, rescheduled |
-- or canceled at any time, even from within a running timer, without conflict or large overhead.\\ |
-- AceTimer is currently limited to firing timers at a frequency of 0.1s. This constant may change |
-- in the future, but for now it seemed like a good compromise in efficiency and accuracy. |
-- |
-- All `:Schedule` functions will return a handle to the current timer, which you will need to store if you |
-- need to cancel or reschedule the timer you just registered. |
-- |
-- **AceTimer-3.0** can be embeded into your addon, either explicitly by calling AceTimer:Embed(MyAddon) or by |
-- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object |
-- and can be accessed directly, without having to explicitly call AceTimer itself.\\ |
-- It is recommended to embed AceTimer, otherwise you'll have to specify a custom `self` on all calls you |
-- make into AceTimer. |
-- @class file |
-- @name AceTimer-3.0 |
-- @release $Id: AceTimer-3.0.lua 895 2009-12-06 16:28:55Z nevcairiel $ |
--[[ |
Basic assumptions: |
* In a typical system, we do more re-scheduling per second than there are timer pulses per second |
* Regardless of timer implementation, we cannot guarantee timely delivery due to FPS restriction (may be as low as 10) |
This implementation: |
CON: The smallest timer interval is constrained by HZ (currently 1/10s). |
PRO: It will still correctly fire any timer slower than HZ over a length of time, e.g. 0.11s interval -> 90 times over 10 seconds |
PRO: In lag bursts, the system simly skips missed timer intervals to decrease load |
CON: Algorithms depending on a timer firing "N times per minute" will fail |
PRO: (Re-)scheduling is O(1) with a VERY small constant. It's a simple linked list insertion in a hash bucket. |
CAUTION: The BUCKETS constant constrains how many timers can be efficiently handled. With too many hash collisions, performance will decrease. |
Major assumptions upheld: |
- ALLOWS scheduling multiple timers with the same funcref/method |
- ALLOWS scheduling more timers during OnUpdate processing |
- ALLOWS unscheduling ANY timer (including the current running one) at any time, including during OnUpdate processing |
]] |
local MAJOR, MINOR = "AceTimer-3.0", 5 |
local AceTimer, oldminor = LibStub:NewLibrary(MAJOR, MINOR) |
if not AceTimer then return end -- No upgrade needed |
AceTimer.hash = AceTimer.hash or {} -- Array of [0..BUCKET-1] = linked list of timers (using .next member) |
-- Linked list gets around ACE-88 and ACE-90. |
AceTimer.selfs = AceTimer.selfs or {} -- Array of [self]={[handle]=timerobj, [handle2]=timerobj2, ...} |
AceTimer.frame = AceTimer.frame or CreateFrame("Frame", "AceTimer30Frame") |
-- Lua APIs |
local assert, error, loadstring = assert, error, loadstring |
local setmetatable, rawset, rawget = setmetatable, rawset, rawget |
local select, pairs, type, next, tostring = select, pairs, type, next, tostring |
local floor, max, min = math.floor, math.max, math.min |
local tconcat = table.concat |
-- WoW APIs |
local GetTime = GetTime |
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded |
-- List them here for Mikk's FindGlobals script |
-- GLOBALS: DEFAULT_CHAT_FRAME, geterrorhandler |
-- Simple ONE-SHOT timer cache. Much more efficient than a full compost for our purposes. |
local timerCache = nil |
--[[ |
Timers will not be fired more often than HZ-1 times per second. |
Keep at intended speed PLUS ONE or we get bitten by floating point rounding errors (n.5 + 0.1 can be n.599999) |
If this is ever LOWERED, all existing timers need to be enforced to have a delay >= 1/HZ on lib upgrade. |
If this number is ever changed, all entries need to be rehashed on lib upgrade. |
]] |
local HZ = 11 |
--[[ |
Prime for good distribution |
If this number is ever changed, all entries need to be rehashed on lib upgrade. |
]] |
local BUCKETS = 131 |
local hash = AceTimer.hash |
for i=1,BUCKETS do |
hash[i] = hash[i] or false -- make it an integer-indexed array; it's faster than hashes |
end |
--[[ |
xpcall safecall implementation |
]] |
local xpcall = xpcall |
local function errorhandler(err) |
return geterrorhandler()(err) |
end |
local function CreateDispatcher(argCount) |
local code = [[ |
local xpcall, eh = ... -- our arguments are received as unnamed values in "..." since we don't have a proper function declaration |
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 lastint = floor(GetTime() * HZ) |
-- -------------------------------------------------------------------- |
-- OnUpdate handler |
-- |
-- traverse buckets, always chasing "now", and fire timers that have expired |
local function OnUpdate() |
local now = GetTime() |
local nowint = floor(now * HZ) |
-- Have we passed into a new hash bucket? |
if nowint == lastint then return end |
local soon = now + 1 -- +1 is safe as long as 1 < HZ < BUCKETS/2 |
-- Pass through each bucket at most once |
-- Happens on e.g. instance loads, but COULD happen on high local load situations also |
for curint = (max(lastint, nowint - BUCKETS) + 1), nowint do -- loop until we catch up with "now", usually only 1 iteration |
local curbucket = (curint % BUCKETS)+1 |
-- Yank the list of timers out of the bucket and empty it. This allows reinsertion in the currently-processed bucket from callbacks. |
local nexttimer = hash[curbucket] |
hash[curbucket] = false -- false rather than nil to prevent the array from becoming a hash |
while nexttimer do |
local timer = nexttimer |
nexttimer = timer.next |
local when = timer.when |
if when < soon then |
-- Call the timer func, either as a method on given object, or a straight function ref |
local callback = timer.callback |
if type(callback) == "string" then |
safecall(timer.object[callback], timer.object, timer.arg) |
elseif callback then |
safecall(callback, timer.arg) |
else |
-- probably nilled out by CancelTimer |
timer.delay = nil -- don't reschedule it |
end |
local delay = timer.delay -- NOW make a local copy, can't do it earlier in case the timer cancelled itself in the callback |
if not delay then |
-- single-shot timer (or cancelled) |
AceTimer.selfs[timer.object][tostring(timer)] = nil |
timerCache = timer |
else |
-- repeating timer |
local newtime = when + delay |
if newtime < now then -- Keep lag from making us firing a timer unnecessarily. (Note that this still won't catch too-short-delay timers though.) |
newtime = now + delay |
end |
timer.when = newtime |
-- add next timer execution to the correct bucket |
local bucket = (floor(newtime * HZ) % BUCKETS) + 1 |
timer.next = hash[bucket] |
hash[bucket] = timer |
end |
else -- if when>=soon |
-- reinsert (yeah, somewhat expensive, but shouldn't be happening too often either due to hash distribution) |
timer.next = hash[curbucket] |
hash[curbucket] = timer |
end -- if when<soon ... else |
end -- while nexttimer do |
end -- for curint=lastint,nowint |
lastint = nowint |
end |
-- --------------------------------------------------------------------- |
-- Reg( callback, delay, arg, repeating ) |
-- |
-- callback( function or string ) - direct function ref or method name in our object for the callback |
-- delay(int) - delay for the timer |
-- arg(variant) - any argument to be passed to the callback function |
-- repeating(boolean) - repeating timer, or oneshot |
-- |
-- returns the handle of the timer for later processing (canceling etc) |
local function Reg(self, callback, delay, arg, repeating) |
if type(callback) ~= "string" and type(callback) ~= "function" then |
local error_origin = repeating and "ScheduleRepeatingTimer" or "ScheduleTimer" |
error(MAJOR..": " .. error_origin .. "(callback, delay, arg): 'callback' - function or method name expected.", 3) |
end |
if type(callback) == "string" then |
if type(self)~="table" then |
local error_origin = repeating and "ScheduleRepeatingTimer" or "ScheduleTimer" |
error(MAJOR..": " .. error_origin .. "(\"methodName\", delay, arg): 'self' - must be a table.", 3) |
end |
if type(self[callback]) ~= "function" then |
local error_origin = repeating and "ScheduleRepeatingTimer" or "ScheduleTimer" |
error(MAJOR..": " .. error_origin .. "(\"methodName\", delay, arg): 'methodName' - method not found on target object.", 3) |
end |
end |
if delay < (1 / (HZ - 1)) then |
delay = 1 / (HZ - 1) |
end |
-- Create and stuff timer in the correct hash bucket |
local now = GetTime() |
local timer = timerCache or {} -- Get new timer object (from cache if available) |
timerCache = nil |
timer.object = self |
timer.callback = callback |
timer.delay = (repeating and delay) |
timer.arg = arg |
timer.when = now + delay |
local bucket = (floor((now+delay)*HZ) % BUCKETS) + 1 |
timer.next = hash[bucket] |
hash[bucket] = timer |
-- Insert timer in our self->handle->timer registry |
local handle = tostring(timer) |
local selftimers = AceTimer.selfs[self] |
if not selftimers then |
selftimers = {} |
AceTimer.selfs[self] = selftimers |
end |
selftimers[handle] = timer |
selftimers.__ops = (selftimers.__ops or 0) + 1 |
return handle |
end |
--- Schedule a new one-shot timer. |
-- The timer will fire once in `delay` seconds, unless canceled before. |
-- @param callback Callback function for the timer pulse (funcref or method name). |
-- @param delay Delay for the timer, in seconds. |
-- @param arg An optional argument to be passed to the callback function. |
-- @usage |
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("TimerTest", "AceTimer-3.0") |
-- |
-- function MyAddon:OnEnable() |
-- self:ScheduleTimer("TimerFeedback", 5) |
-- end |
-- |
-- function MyAddon:TimerFeedback() |
-- print("5 seconds passed") |
-- end |
function AceTimer:ScheduleTimer(callback, delay, arg) |
return Reg(self, callback, delay, arg) |
end |
--- Schedule a repeating timer. |
-- The timer will fire every `delay` seconds, until canceled. |
-- @param callback Callback function for the timer pulse (funcref or method name). |
-- @param delay Delay for the timer, in seconds. |
-- @param arg An optional argument to be passed to the callback function. |
-- @usage |
-- MyAddon = LibStub("AceAddon-3.0"):NewAddon("TimerTest", "AceTimer-3.0") |
-- |
-- function MyAddon:OnEnable() |
-- self.timerCount = 0 |
-- self.testTimer = self:ScheduleRepeatingTimer("TimerFeedback", 5) |
-- end |
-- |
-- function MyAddon:TimerFeedback() |
-- self.timerCount = self.timerCount + 1 |
-- print(("%d seconds passed"):format(5 * self.timerCount)) |
-- -- run 30 seconds in total |
-- if self.timerCount == 6 then |
-- self:CancelTimer(self.testTimer) |
-- end |
-- end |
function AceTimer:ScheduleRepeatingTimer(callback, delay, arg) |
return Reg(self, callback, delay, arg, true) |
end |
--- Cancels a timer with the given handle, registered by the same addon object as used for `:ScheduleTimer` |
-- Both one-shot and repeating timers can be canceled with this function, as long as the `handle` is valid |
-- and the timer has not fired yet or was canceled before. |
-- @param handle The handle of the timer, as returned by `:ScheduleTimer` or `:ScheduleRepeatingTimer` |
-- @param silent If true, no error is raised if the timer handle is invalid (expired or already canceled) |
-- @return True if the timer was successfully cancelled. |
function AceTimer:CancelTimer(handle, silent) |
if not handle then return end -- nil handle -> bail out without erroring |
if type(handle) ~= "string" then |
error(MAJOR..": CancelTimer(handle): 'handle' - expected a string", 2) -- for now, anyway |
end |
local selftimers = AceTimer.selfs[self] |
local timer = selftimers and selftimers[handle] |
if silent then |
if timer then |
timer.callback = nil -- don't run it again |
timer.delay = nil -- if this is the currently-executing one: don't even reschedule |
-- The timer object is removed in the OnUpdate loop |
end |
return not not timer -- might return "true" even if we double-cancel. we'll live. |
else |
if not timer then |
geterrorhandler()(MAJOR..": CancelTimer(handle[, silent]): '"..tostring(handle).."' - no such timer registered") |
return false |
end |
if not timer.callback then |
geterrorhandler()(MAJOR..": CancelTimer(handle[, silent]): '"..tostring(handle).."' - timer already cancelled or expired") |
return false |
end |
timer.callback = nil -- don't run it again |
timer.delay = nil -- if this is the currently-executing one: don't even reschedule |
return true |
end |
end |
--- Cancels all timers registered to the current addon object ('self') |
function AceTimer:CancelAllTimers() |
if not(type(self) == "string" or type(self) == "table") then |
error(MAJOR..": CancelAllTimers(): 'self' - must be a string or a table",2) |
end |
if self == AceTimer then |
error(MAJOR..": CancelAllTimers(): supply a meaningful 'self'", 2) |
end |
local selftimers = AceTimer.selfs[self] |
if selftimers then |
for handle,v in pairs(selftimers) do |
if type(v) == "table" then -- avoid __ops, etc |
AceTimer.CancelTimer(self, handle, true) |
end |
end |
end |
end |
--- Returns the time left for a timer with the given handle, registered by the current addon object ('self'). |
-- This function will raise a warning when the handle is invalid, but not stop execution. |
-- @param handle The handle of the timer, as returned by `:ScheduleTimer` or `:ScheduleRepeatingTimer` |
-- @return The time left on the timer, or false if the handle is invalid. |
function AceTimer:TimeLeft(handle) |
if not handle then return end |
if type(handle) ~= "string" then |
error(MAJOR..": TimeLeft(handle): 'handle' - expected a string", 2) -- for now, anyway |
end |
local selftimers = AceTimer.selfs[self] |
local timer = selftimers and selftimers[handle] |
if not timer then |
geterrorhandler()(MAJOR..": TimeLeft(handle): '"..tostring(handle).."' - no such timer registered") |
return false |
end |
return timer.when - GetTime() |
end |
-- --------------------------------------------------------------------- |
-- PLAYER_REGEN_ENABLED: Run through our .selfs[] array step by step |
-- and clean it out - otherwise the table indices can grow indefinitely |
-- if an addon starts and stops a lot of timers. AceBucket does this! |
-- |
-- See ACE-94 and tests/AceTimer-3.0-ACE-94.lua |
local lastCleaned = nil |
local function OnEvent(this, event) |
if event~="PLAYER_REGEN_ENABLED" then |
return |
end |
-- Get the next 'self' to process |
local selfs = AceTimer.selfs |
local self = next(selfs, lastCleaned) |
if not self then |
self = next(selfs) |
end |
lastCleaned = self |
if not self then -- should only happen if .selfs[] is empty |
return |
end |
-- Time to clean it out? |
local list = selfs[self] |
if (list.__ops or 0) < 250 then -- 250 slosh indices = ~10KB wasted (max!). For one 'self'. |
return |
end |
-- Create a new table and copy all members over |
local newlist = {} |
local n=0 |
for k,v in pairs(list) do |
newlist[k] = v |
n=n+1 |
end |
newlist.__ops = 0 -- Reset operation count |
-- And since we now have a count of the number of live timers, check that it's reasonable. Emit a warning if not. |
if n>BUCKETS then |
DEFAULT_CHAT_FRAME:AddMessage(MAJOR..": Warning: The addon/module '"..tostring(self).."' has "..n.." live timers. Surely that's not intended?") |
end |
selfs[self] = newlist |
end |
-- --------------------------------------------------------------------- |
-- Embed handling |
AceTimer.embeds = AceTimer.embeds or {} |
local mixins = { |
"ScheduleTimer", "ScheduleRepeatingTimer", |
"CancelTimer", "CancelAllTimers", |
"TimeLeft" |
} |
function AceTimer:Embed(target) |
AceTimer.embeds[target] = true |
for _,v in pairs(mixins) do |
target[v] = AceTimer[v] |
end |
return target |
end |
-- AceTimer:OnEmbedDisable( target ) |
-- target (object) - target object that AceTimer is embedded in. |
-- |
-- cancel all timers registered for the object |
function AceTimer:OnEmbedDisable( target ) |
target:CancelAllTimers() |
end |
for addon in pairs(AceTimer.embeds) do |
AceTimer:Embed(addon) |
end |
-- --------------------------------------------------------------------- |
-- Debug tools (expose copies of internals to test suites) |
AceTimer.debug = AceTimer.debug or {} |
AceTimer.debug.HZ = HZ |
AceTimer.debug.BUCKETS = BUCKETS |
-- --------------------------------------------------------------------- |
-- Finishing touchups |
AceTimer.frame:SetScript("OnUpdate", OnUpdate) |
AceTimer.frame:SetScript("OnEvent", OnEvent) |
AceTimer.frame:RegisterEvent("PLAYER_REGEN_ENABLED") |
-- In theory, we should hide&show the frame based on there being timers or not. |
-- However, this job is fairly expensive, and the chance that there will |
-- actually be zero timers running is diminuitive to say the lest. |
<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="AceEvent-3.0.lua"/> |
</Ui> |
--- AceEvent-3.0 provides event registration and secure dispatching. |
-- All dispatching is done using **CallbackHandler-1.0**. AceEvent is a simple wrapper around |
-- CallbackHandler, and dispatches all game events or addon message to the registrees. |
-- |
-- **AceEvent-3.0** can be embeded into your addon, either explicitly by calling AceEvent:Embed(MyAddon) or by |
-- specifying it as an embeded library in your AceAddon. All functions will be available on your addon object |
-- and can be accessed directly, without having to explicitly call AceEvent itself.\\ |
-- It is recommended to embed AceEvent, otherwise you'll have to specify a custom `self` on all calls you |
-- make into AceEvent. |
-- @class file |
-- @name AceEvent-3.0 |
-- @release $Id: AceEvent-3.0.lua 877 2009-11-02 15:56:50Z nevcairiel $ |
local MAJOR, MINOR = "AceEvent-3.0", 3 |
local AceEvent = LibStub:NewLibrary(MAJOR, MINOR) |
if not AceEvent then return end |
-- Lua APIs |
local pairs = pairs |
local CallbackHandler = LibStub:GetLibrary("CallbackHandler-1.0") |
AceEvent.frame = AceEvent.frame or CreateFrame("Frame", "AceEvent30Frame") -- our event frame |
AceEvent.embeds = AceEvent.embeds or {} -- what objects embed this lib |
-- APIs and registry for blizzard events, using CallbackHandler lib |
if not AceEvent.events then |
AceEvent.events = CallbackHandler:New(AceEvent, |
"RegisterEvent", "UnregisterEvent", "UnregisterAllEvents") |
end |
function AceEvent.events:OnUsed(target, eventname) |
AceEvent.frame:RegisterEvent(eventname) |
end |
function AceEvent.events:OnUnused(target, eventname) |
AceEvent.frame:UnregisterEvent(eventname) |
end |
-- APIs and registry for IPC messages, using CallbackHandler lib |
if not AceEvent.messages then |
AceEvent.messages = CallbackHandler:New(AceEvent, |
"RegisterMessage", "UnregisterMessage", "UnregisterAllMessages" |
) |
AceEvent.SendMessage = AceEvent.messages.Fire |
end |
--- embedding and embed handling |
local mixins = { |
"RegisterEvent", "UnregisterEvent", |
"RegisterMessage", "UnregisterMessage", |
"SendMessage", |
"UnregisterAllEvents", "UnregisterAllMessages", |
} |
--- Register for a Blizzard Event. |
-- The callback will always be called with the event as the first argument, and if supplied, the `arg` as second argument. |
-- Any arguments to the event will be passed on after that. |
-- @name AceEvent:RegisterEvent |
-- @class function |
-- @paramsig event[, callback [, arg]] |
-- @param event The event to register for |
-- @param callback The callback function to call when the event is triggered (funcref or method, defaults to a method with the event name) |
-- @param arg An optional argument to pass to the callback function |
--- Unregister an event. |
-- @name AceEvent:UnregisterEvent |
-- @class function |
-- @paramsig event |
-- @param event The event to unregister |
--- Register for a custom AceEvent-internal message. |
-- The callback will always be called with the event as the first argument, and if supplied, the `arg` as second argument. |
-- Any arguments to the event will be passed on after that. |
-- @name AceEvent:RegisterMessage |
-- @class function |
-- @paramsig message[, callback [, arg]] |
-- @param message The message to register for |
-- @param callback The callback function to call when the message is triggered (funcref or method, defaults to a method with the event name) |
-- @param arg An optional argument to pass to the callback function |
--- Unregister a message |
-- @name AceEvent:UnregisterMessage |
-- @class function |
-- @paramsig message |
-- @param message The message to unregister |
--- Send a message over the AceEvent-3.0 internal message system to other addons registered for this message. |
-- @name AceEvent:SendMessage |
-- @class function |
-- @paramsig message, ... |
-- @param message The message to send |
-- @param ... Any arguments to the message |
-- Embeds AceEvent into the target object making the functions from the mixins list available on target:.. |
-- @param target target object to embed AceEvent in |
function AceEvent:Embed(target) |
for k, v in pairs(mixins) do |
target[v] = self[v] |
end |
self.embeds[target] = true |
return target |
end |
-- AceEvent:OnEmbedDisable( target ) |
-- target (object) - target object that is being disabled |
-- |
-- Unregister all events messages etc when the target disables. |
-- this method should be called by the target manually or by an addon framework |
function AceEvent:OnEmbedDisable(target) |
target:UnregisterAllEvents() |
target:UnregisterAllMessages() |
end |
-- Script to fire blizzard events into the event listeners |
local events = AceEvent.events |
AceEvent.frame:SetScript("OnEvent", function(this, event, ...) |
events:Fire(event, ...) |
end) |
--- Finally: upgrade our old embeds |
for target, v in pairs(AceEvent.embeds) do |
AceEvent:Embed(target) |
end |
------------------------------------------------------------------------ |
r907 | nevcairiel | 2009-12-16 17:08:05 +0000 (Wed, 16 Dec 2009) | 1 line |
Changed paths: |
A /tags/Release-r907 (from /trunk:906) |
Maintenance release that fixes two annoying bugs since r900 |
------------------------------------------------------------------------ |
r906 | nevcairiel | 2009-12-16 17:06:39 +0000 (Wed, 16 Dec 2009) | 1 line |
Changed paths: |
M /trunk/changelog.txt |
Update changelog.txt |
------------------------------------------------------------------------ |
r905 | nevcairiel | 2009-12-15 16:48:32 +0000 (Tue, 15 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceTab-3.0/AceTab-3.0.lua |
Remove 3.2 compat hack |
------------------------------------------------------------------------ |
r904 | nevcairiel | 2009-12-13 11:56:37 +0000 (Sun, 13 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceConfig-3.0/AceConfigCmd-3.0/AceConfigCmd-3.0.lua |
AceConfigCmd-3.0: Properly handle inline groups with a different handler in help output. (Ticket #101) |
------------------------------------------------------------------------ |
r903 | nevcairiel | 2009-12-13 11:09:35 +0000 (Sun, 13 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-Frame.lua |
AceGUI-3.0: Frame: Properly save the width in the status table. |
------------------------------------------------------------------------ |
r902 | nevcairiel | 2009-12-12 14:56:14 +0000 (Sat, 12 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.lua |
AceConfigDialog-3.0: Don't bail out and error when a dialogControl was invalid, instead show the error and fallback to the default control for that type. |
------------------------------------------------------------------------ |
r901 | nevcairiel | 2009-12-08 17:56:17 +0000 (Tue, 08 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.lua |
AceConfigDialog-3.0: Fix a hickup with the OnUpdate script not getting upgraded properly in some situations. |
------------------------------------------------------------------------ |
r899 | nevcairiel | 2009-12-08 13:44:20 +0000 (Tue, 08 Dec 2009) | 1 line |
Changed paths: |
M /trunk/Ace3.toc |
Update .toc for 3.3 |
------------------------------------------------------------------------ |
r898 | nevcairiel | 2009-12-08 13:44:01 +0000 (Tue, 08 Dec 2009) | 1 line |
Changed paths: |
M /trunk/changelog.txt |
Update changelog.txt |
------------------------------------------------------------------------ |
r897 | mikk | 2009-12-06 17:02:27 +0000 (Sun, 06 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceConfig-3.0/AceConfigCmd-3.0/AceConfigCmd-3.0.lua |
Regression fix from ticket #96: If "cmdHidden" is non-nil, we obey it before "hidden". Not just if it's true. |
------------------------------------------------------------------------ |
r896 | nevcairiel | 2009-12-06 16:29:49 +0000 (Sun, 06 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceGUI-3.0/AceGUI-3.0.lua |
M /trunk/tests/AceGUI-3.0-recycle.lua |
Adjust tests for AceGUI changes. |
------------------------------------------------------------------------ |
r895 | nevcairiel | 2009-12-06 16:28:55 +0000 (Sun, 06 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceAddon-3.0/AceAddon-3.0.lua |
M /trunk/AceBucket-3.0/AceBucket-3.0.lua |
M /trunk/AceComm-3.0/AceComm-3.0.lua |
M /trunk/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.lua |
M /trunk/AceDBOptions-3.0/AceDBOptions-3.0.lua |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-CheckBox.lua |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-TreeGroup.lua |
M /trunk/AceLocale-3.0/AceLocale-3.0.lua |
M /trunk/AceTimer-3.0/AceTimer-3.0.lua |
M /trunk/CallbackHandler-1.0/CallbackHandler-1.0.lua |
Adjust upvalues slightly to allow debugging and running tests. |
------------------------------------------------------------------------ |
r894 | nevcairiel | 2009-12-06 16:14:30 +0000 (Sun, 06 Dec 2009) | 1 line |
Changed paths: |
M /trunk/.pkgmeta |
Don't include tests in the zip, devs working on Ace3 have svn checkouts, anyway! |
------------------------------------------------------------------------ |
r893 | nevcairiel | 2009-12-06 16:01:49 +0000 (Sun, 06 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceConfig-3.0/AceConfigCmd-3.0/AceConfigCmd-3.0.lua |
AceConfigCmd-3.0: Properly parse functions and methods supplied for the "hidden" option table member. (Ticket #96) |
------------------------------------------------------------------------ |
r892 | nevcairiel | 2009-12-06 15:16:45 +0000 (Sun, 06 Dec 2009) | 2 lines |
Changed paths: |
M /trunk/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.lua |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-DropDownGroup.lua |
AceGUI-3.0: DropDownGroup: Adjust the positioning of the title text |
AceConfigDialog-3.0: Pass the groups "name" tag to DropDownGroups as the title. |
------------------------------------------------------------------------ |
r891 | nevcairiel | 2009-12-06 13:02:19 +0000 (Sun, 06 Dec 2009) | 1 line |
Changed paths: |
M /trunk/changelog.txt |
Update changelog.txt |
------------------------------------------------------------------------ |
r890 | nevcairiel | 2009-12-06 12:50:05 +0000 (Sun, 06 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.lua |
M /trunk/AceConfig-3.0/AceConfigRegistry-3.0/AceConfigRegistry-3.0.lua |
AceConfigDialog-3.0: Allow image/imageCoords on toogle elements (Note that the width/height of the image on the toggle cannot be changed) |
------------------------------------------------------------------------ |
r889 | nevcairiel | 2009-12-06 12:47:43 +0000 (Sun, 06 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-CheckBox.lua |
AceGUI-3.0: Allow displaying a image in front of the checkbox label |
------------------------------------------------------------------------ |
r888 | nevcairiel | 2009-12-05 21:32:19 +0000 (Sat, 05 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-Slider.lua |
AceGUI-3.0: Slider: Add a more visible backdrop/border around the manual input area (Ticket #98) |
------------------------------------------------------------------------ |
r887 | nevcairiel | 2009-12-05 21:23:38 +0000 (Sat, 05 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-ScrollFrame.lua |
AceGUI-3.0: ScrollFrame: Potentially fix an issue that caused the scrollframe to reset to top in certain resolution/UIScale combinations. |
------------------------------------------------------------------------ |
r886 | nevcairiel | 2009-12-05 18:10:29 +0000 (Sat, 05 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-TreeGroup.lua |
AceGUI-3.0: TreeGroup: Allow iconCoords to be passed for the tree elements. (Ticket #59) |
------------------------------------------------------------------------ |
r885 | nevcairiel | 2009-12-05 18:02:30 +0000 (Sat, 05 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-Window.lua |
AceGUI-3.0: Added an API to the Window container to disable the user-resizing of the same. (Ticket #80) |
------------------------------------------------------------------------ |
r884 | nevcairiel | 2009-12-02 19:01:14 +0000 (Wed, 02 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceDBOptions-3.0/AceDBOptions-3.0.lua |
AceDBOptions-3.0: Use the esES locale for esMX until someone provides a real translation. |
------------------------------------------------------------------------ |
r883 | nevcairiel | 2009-12-02 18:58:49 +0000 (Wed, 02 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceDBOptions-3.0/AceDBOptions-3.0.lua |
AceDBOptions-3.0: Show the current profile on the dialog. |
------------------------------------------------------------------------ |
r882 | nevcairiel | 2009-12-02 18:04:53 +0000 (Wed, 02 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceConfig-3.0/AceConfigDialog-3.0/AceConfigDialog-3.0.lua |
AceConfigDialog-3.0: Properly refresh BlizOptions Windows which are registered with a path on NotifyChange. This required a re-design of the AceConfigDialog.BlizOptions table, so if any 3rd party addon somehow accessed this table, it will have to be adjusted. |
------------------------------------------------------------------------ |
r881 | nevcairiel | 2009-12-02 17:26:07 +0000 (Wed, 02 Dec 2009) | 1 line |
Changed paths: |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-Icon.lua |
AceGUI-3.0: Icon: Explicitly set the TexCoords to the default value if none are specified. |
------------------------------------------------------------------------ |
r880 | nevcairiel | 2009-11-15 17:02:07 +0000 (Sun, 15 Nov 2009) | 1 line |
Changed paths: |
M /trunk/AceGUI-3.0/widgets/AceGUIWidget-EditBox.lua |
AceGUI-3.0: Clear the contents of the editbox when releasing it. |
------------------------------------------------------------------------ |
r879 | nevcairiel | 2009-11-02 18:59:34 +0000 (Mon, 02 Nov 2009) | 1 line |
Changed paths: |
M /trunk/changelog.txt |
Updated changelog |
------------------------------------------------------------------------ |
-- This file is only there in standalone Ace3 and provides handy dev tool stuff I guess |
-- for now only /rl to reload your UI :) |
-- note the complete overkill use of AceAddon and console, ain't it cool? |
-- GLOBALS: next, loadstring, ReloadUI, geterrorhandler |
-- GLOBALS: BINDING_HEADER_ACE3, BINDING_NAME_RELOADUI, Ace3, LibStub |
-- BINDINGs labels |
BINDING_HEADER_ACE3 = "Ace3" |
BINDING_NAME_RELOADUI = "ReloadUI" |
-- |
local gui = LibStub("AceGUI-3.0") |
local reg = LibStub("AceConfigRegistry-3.0") |
local dialog = LibStub("AceConfigDialog-3.0") |
Ace3 = LibStub("AceAddon-3.0"):NewAddon("Ace3", "AceConsole-3.0") |
local Ace3 = Ace3 |
local selectedgroup |
local frame |
local select |
local status = {} |
local configs = {} |
local function frameOnClose() |
gui:Release(frame) |
frame = nil |
end |
local function RefreshConfigs() |
for name in reg:IterateOptionsTables() do |
configs[name] = name |
end |
end |
local function ConfigSelected(widget, event, value) |
selectedgroup = value |
dialog:Open(value, widget) |
end |
local old_CloseSpecialWindows |
-- GLOBALS: CloseSpecialWindows, next |
function Ace3:Open() |
if not old_CloseSpecialWindows then |
old_CloseSpecialWindows = CloseSpecialWindows |
CloseSpecialWindows = function() |
local found = old_CloseSpecialWindows() |
if frame then |
frame:Hide() |
return true |
end |
return found |
end |
end |
RefreshConfigs() |
if next(configs) == nil then |
self:Print("No Configs are Registered") |
return |
end |
if not frame then |
frame = gui:Create("Frame") |
frame:ReleaseChildren() |
frame:SetTitle("Ace3 Options") |
frame:SetLayout("FILL") |
frame:SetCallback("OnClose", frameOnClose) |
select = gui:Create("DropdownGroup") |
select:SetGroupList(configs) |
select:SetCallback("OnGroupSelected", ConfigSelected) |
frame:AddChild(select) |
end |
if not selectedgroup then |
selectedgroup = next(configs) |
end |
select:SetGroup(selectedgroup) |
frame:Show() |
end |
local function RefreshOnUpdate(this) |
select:SetGroup(selectedgroup) |
this:SetScript("OnUpdate", nil) |
end |
function Ace3:ConfigTableChanged(event, appName) |
if selectedgroup == appName and frame then |
frame.frame:SetScript("OnUpdate", RefreshOnUpdate) |
end |
end |
reg.RegisterCallback(Ace3, "ConfigTableChange", "ConfigTableChanged") |
function Ace3:PrintCmd(input) |
input = input:trim():match("^(.-);*$") |
local func, err = loadstring("LibStub(\"AceConsole-3.0\"):Print(" .. input .. ")") |
if not func then |
LibStub("AceConsole-3.0"):Print("Error: " .. err) |
else |
func() |
end |
end |
function Ace3:OnInitialize() |
self:RegisterChatCommand("ace3", function() self:Open() end) |
self:RegisterChatCommand("rl", function() ReloadUI() end) |
self:RegisterChatCommand("print", "PrintCmd") |
end |
--- **AceGUI-3.0** provides access to numerous widgets which can be used to create GUIs. |
-- AceGUI is used by AceConfigDialog to create the option GUIs, but you can use it by itself |
-- to create any custom GUI. There are more extensive examples in the test suite in the Ace3 |
-- stand-alone distribution. |
-- |
-- **Note**: When using AceGUI-3.0 directly, please do not modify the frames of the widgets directly, |
-- as any "unknown" change to the widgets will cause addons that get your widget out of the widget pool |
-- to misbehave. If you think some part of a widget should be modifiable, please open a ticket, and we'll |
-- implement a proper API to modify it. |
-- @usage |
-- local AceGUI = LibStub("AceGUI-3.0") |
-- -- Create a container frame |
-- local f = AceGUI:Create("Frame") |
-- f:SetCallback("OnClose",function(widget) AceGUI:Release(widget) end) |
-- f:SetTitle("AceGUI-3.0 Example") |
-- f:SetStatusText("Status Bar") |
-- f:SetLayout("Flow") |
-- -- Create a button |
-- local btn = AceGUI:Create("Button") |
-- btn:SetWidth(170) |
-- btn:SetText("Button !") |
-- btn:SetCallback("OnClick", function() print("Click!") end) |
-- -- Add the button to the container |
-- f:AddChild(btn) |
-- @class file |
-- @name AceGUI-3.0 |
-- @release $Id: AceGUI-3.0.lua 896 2009-12-06 16:29:49Z nevcairiel $ |
local ACEGUI_MAJOR, ACEGUI_MINOR = "AceGUI-3.0", 30 |
local AceGUI, oldminor = LibStub:NewLibrary(ACEGUI_MAJOR, ACEGUI_MINOR) |
if not AceGUI then return end -- No upgrade needed |
-- Lua APIs |
local tconcat, tremove, tinsert = table.concat, table.remove, table.insert |
local select, pairs, next, type = select, pairs, next, type |
local error, assert, loadstring = error, assert, loadstring |
local setmetatable, rawget, rawset = setmetatable, rawget, rawset |
local math_max = math.max |
-- WoW APIs |
local UIParent = UIParent |
-- Global vars/functions that we don't upvalue since they might get hooked, or upgraded |
-- List them here for Mikk's FindGlobals script |
-- GLOBALS: geterrorhandler, LibStub |
--local con = LibStub("AceConsole-3.0",true) |
AceGUI.WidgetRegistry = AceGUI.WidgetRegistry or {} |
AceGUI.LayoutRegistry = AceGUI.LayoutRegistry or {} |
AceGUI.WidgetBase = AceGUI.WidgetBase or {} |
AceGUI.WidgetContainerBase = AceGUI.WidgetContainerBase or {} |
AceGUI.WidgetVersions = AceGUI.WidgetVersions or {} |
-- local upvalues |
local WidgetRegistry = AceGUI.WidgetRegistry |
local LayoutRegistry = AceGUI.LayoutRegistry |
local WidgetVersions = AceGUI.WidgetVersions |
--[[ |
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 |
-- Recycling functions |
local newWidget, delWidget |
do |
-- Version Upgrade in Minor 29 |
-- Internal Storage of the objects changed, from an array table |
-- to a hash table, and additionally we introduced versioning on |
-- the widgets which would discard all widgets from a pre-29 version |
-- anyway, so we just clear the storage now, and don't try to |
-- convert the storage tables to the new format. |
-- This should generally not cause *many* widgets to end up in trash, |
-- since once dialogs are opened, all addons should be loaded already |
-- and AceGUI should be on the latest version available on the users |
-- setup. |
-- -- nevcairiel - Nov 2nd, 2009 |
if oldminor and oldminor < 29 and AceGUI.objPools then |
AceGUI.objPools = nil |
end |
AceGUI.objPools = AceGUI.objPools or {} |
local objPools = AceGUI.objPools |
--Returns a new instance, if none are available either returns a new table or calls the given contructor |
function newWidget(type) |
if not WidgetRegistry[type] then |
error("Attempt to instantiate unknown widget type", 2) |
end |
if not objPools[type] then |
objPools[type] = {} |
end |
local newObj = next(objPools[type]) |
if not newObj then |
newObj = WidgetRegistry[type]() |
newObj.AceGUIWidgetVersion = WidgetVersions[type] |
else |
objPools[type][newObj] = nil |
-- if the widget is older then the latest, don't even try to reuse it |
-- just forget about it, and grab a new one. |
if not newObj.AceGUIWidgetVersion or newObj.AceGUIWidgetVersion < WidgetVersions[type] then |
return newWidget(type) |
end |
end |
return newObj |
end |
-- Releases an instance to the Pool |
function delWidget(obj,type) |
if not objPools[type] then |
objPools[type] = {} |
end |
if objPools[type][obj] then |
error("Attempt to Release Widget that is already released", 2) |
end |
objPools[type][obj] = true |
end |
end |
------------------- |
-- API Functions -- |
------------------- |
-- Gets a widget Object |
--- Create a new Widget of the given type. |
-- This function will instantiate a new widget (or use one from the widget pool), and call the |
-- OnAcquire function on it, before returning. |
-- @param type The type of the widget. |
-- @return The newly created widget. |
function AceGUI:Create(type) |
if WidgetRegistry[type] then |
local widget = newWidget(type) |
if rawget(widget,'Acquire') then |
widget.OnAcquire = widget.Acquire |
widget.Acquire = nil |
elseif rawget(widget,'Aquire') then |
widget.OnAcquire = widget.Aquire |
widget.Aquire = nil |
end |
if rawget(widget,'Release') then |
widget.OnRelease = rawget(widget,'Release') |
widget.Release = nil |
end |
if widget.OnAcquire then |
widget:OnAcquire() |
else |
error(("Widget type %s doesn't supply an OnAcquire Function"):format(type)) |
end |
-- Set the default Layout ('List') |
safecall(widget.SetLayout, widget, 'List') |
safecall(widget.ResumeLayout, widget) |
return widget |
end |
end |
--- Releases a widget Object. |
-- This function calls OnRelease on the widget and places it back in the widget pool. |
-- Any data on the widget is being erased, and the widget will be hidden.\\ |
-- If this widget is a Container-Widget, all of its Child-Widgets will be releases as well. |
-- @param widget The widget to release |
function AceGUI:Release(widget) |
safecall( widget.PauseLayout, widget ) |
widget:Fire("OnRelease") |
safecall( widget.ReleaseChildren, widget ) |
if widget.OnRelease then |
widget:OnRelease() |
else |
error(("Widget type %s doesn't supply an OnRelease Function"):format(type)) |
end |
for k in pairs(widget.userdata) do |
widget.userdata[k] = nil |
end |
for k in pairs(widget.events) do |
widget.events[k] = nil |
end |
widget.width = nil |
widget.relWidth = nil |
widget.height = nil |
widget.relHeight = nil |
widget.noAutoHeight = nil |
widget.frame:ClearAllPoints() |
widget.frame:Hide() |
widget.frame:SetParent(UIParent) |
widget.frame.width = nil |
widget.frame.height = nil |
if widget.content then |
widget.content.width = nil |
widget.content.height = nil |
end |
delWidget(widget, widget.type) |
end |
----------- |
-- Focus -- |
----------- |
--- Called when a widget has taken focus. |
-- e.g. Dropdowns opening, Editboxes gaining kb focus |
-- @param widget The widget that should be focused |
function AceGUI:SetFocus(widget) |
if self.FocusedWidget and self.FocusedWidget ~= widget then |
safecall(self.FocusedWidget.ClearFocus, self.FocusedWidget) |
end |
self.FocusedWidget = widget |
end |
--- Called when something has happened that could cause widgets with focus to drop it |
-- e.g. titlebar of a frame being clicked |
function AceGUI:ClearFocus() |
if self.FocusedWidget then |
safecall(self.FocusedWidget.ClearFocus, self.FocusedWidget) |
self.FocusedWidget = nil |
end |
end |
------------- |
-- Widgets -- |
------------- |
--[[ |
Widgets must provide the following functions |
OnAcquire() - Called when the object is acquired, should set everything to a default hidden state |
OnRelease() - Called when the object is Released, should remove any anchors and hide the Widget |
And the following members |
frame - the frame or derivitive object that will be treated as the widget for size and anchoring purposes |
type - the type of the object, same as the name given to :RegisterWidget() |
Widgets contain a table called userdata, this is a safe place to store data associated with the wigdet |
It will be cleared automatically when a widget is released |
Placing values directly into a widget object should be avoided |
If the Widget can act as a container for other Widgets the following |
content - frame or derivitive that children will be anchored to |
The Widget can supply the following Optional Members |
:OnWidthSet(width) - Called when the width of the widget is changed |
:OnHeightSet(height) - Called when the height of the widget is changed |
Widgets should not use the OnSizeChanged events of thier frame or content members, use these methods instead |
AceGUI already sets a handler to the event |
:LayoutFinished(width, height) - called after a layout has finished, the width and height will be the width and height of the |
area used for controls. These can be nil if the layout used the existing size to layout the controls. |
]] |
-------------------------- |
-- Widget Base Template -- |
-------------------------- |
do |
local function fixlevels(parent,...) |
local i = 1 |
local child = select(i, ...) |
while child do |
child:SetFrameLevel(parent:GetFrameLevel()+1) |
fixlevels(child, child:GetChildren()) |
i = i + 1 |
child = select(i, ...) |
end |
end |
local WidgetBase = AceGUI.WidgetBase |
WidgetBase.SetParent = function(self, parent) |
local frame = self.frame |
frame:SetParent(nil) |
frame:SetParent(parent.content) |
self.parent = parent |
--fixlevels(parent.frame,parent.frame:GetChildren()) |
end |
WidgetBase.SetCallback = function(self, name, func) |
if type(func) == "function" then |
self.events[name] = func |
end |
end |
WidgetBase.Fire = function(self, name, ...) |
if self.events[name] then |
local success, ret = safecall(self.events[name], self, name, ...) |
if success then |
return ret |
end |
end |
end |
WidgetBase.SetWidth = function(self, width) |
self.frame:SetWidth(width) |
self.frame.width = width |
if self.OnWidthSet then |
self:OnWidthSet(width) |
end |
end |
WidgetBase.SetRelativeWidth = function(self, width) |
if width <= 0 or width > 1 then |
error(":SetRelativeWidth(width): Invalid relative width.", 2) |
end |
self.relWidth = width |
self.width = "relative" |
end |
WidgetBase.SetHeight = function(self, height) |
self.frame:SetHeight(height) |
self.frame.height = height |
if self.OnHeightSet then |
self:OnHeightSet(height) |
end |
end |
--[[ WidgetBase.SetRelativeHeight = function(self, height) |
if height <= 0 or height > 1 then |
error(":SetRelativeHeight(height): Invalid relative height.", 2) |
end |
self.relHeight = height |
self.height = "relative" |
end ]] |
WidgetBase.IsVisible = function(self) |
return self.frame:IsVisible() |
end |
WidgetBase.IsShown= function(self) |
return self.frame:IsShown() |
end |
WidgetBase.Release = function(self) |
AceGUI:Release(self) |
end |
WidgetBase.SetPoint = function(self, ...) |
return self.frame:SetPoint(...) |
end |
WidgetBase.ClearAllPoints = function(self) |
return self.frame:ClearAllPoints() |
end |
WidgetBase.GetNumPoints = function(self) |
return self.frame:GetNumPoints() |
end |
WidgetBase.GetPoint = function(self, ...) |
return self.frame:GetPoint(...) |
end |
WidgetBase.GetUserDataTable = function(self) |
return self.userdata |
end |
WidgetBase.SetUserData = function(self, key, value) |
self.userdata[key] = value |
end |
WidgetBase.GetUserData = function(self, key) |
return self.userdata[key] |
end |
WidgetBase.IsFullHeight = function(self) |
return self.height == "fill" |
end |
WidgetBase.SetFullHeight = function(self, isFull) |
if isFull then |
self.height = "fill" |
else |
self.height = nil |
end |
end |
WidgetBase.IsFullWidth = function(self) |
return self.width == "fill" |
end |
WidgetBase.SetFullWidth = function(self, isFull) |
if isFull then |
self.width = "fill" |
else |
self.width = nil |
end |
end |
-- local function LayoutOnUpdate(this) |
-- this:SetScript("OnUpdate",nil) |
-- this.obj:PerformLayout() |
-- end |
local WidgetContainerBase = AceGUI.WidgetContainerBase |
WidgetContainerBase.PauseLayout = function(self) |
self.LayoutPaused = true |
end |
WidgetContainerBase.ResumeLayout = function(self) |
self.LayoutPaused = nil |
end |
WidgetContainerBase.PerformLayout = function(self) |
if self.LayoutPaused then |
return |
end |
safecall(self.LayoutFunc,self.content, self.children) |
end |
--call this function to layout, makes sure layed out objects get a frame to get sizes etc |
WidgetContainerBase.DoLayout = function(self) |
self:PerformLayout() |
-- if not self.parent then |
-- self.frame:SetScript("OnUpdate", LayoutOnUpdate) |
-- end |
end |
WidgetContainerBase.AddChild = function(self, child, beforeWidget) |
if beforeWidget then |
local siblingIndex = 1 |
for _, widget in pairs(self.children) do |
if widget == beforeWidget then |
break |
end |
siblingIndex = siblingIndex + 1 |
end |
tinsert(self.children, siblingIndex, child) |
else |
tinsert(self.children, child) |
end |
child:SetParent(self) |
child.frame:Show() |
self:DoLayout() |
end |
WidgetContainerBase.AddChildren = function(self, ...) |
for i = 1, select("#", ...) do |
local child = select(i, ...) |
tinsert(self.children, child) |
child:SetParent(self) |
child.frame:Show() |
end |
self:DoLayout() |
end |
WidgetContainerBase.ReleaseChildren = function(self) |
local children = self.children |
for i = 1,#children do |
AceGUI:Release(children[i]) |
children[i] = nil |
end |
end |
WidgetContainerBase.SetLayout = function(self, Layout) |
self.LayoutFunc = AceGUI:GetLayout(Layout) |
end |
WidgetContainerBase.SetAutoAdjustHeight = function(self, adjust) |
if adjust then |
self.noAutoHeight = nil |
else |
self.noAutoHeight = true |
end |
end |
local function FrameResize(this) |
local self = this.obj |
if this:GetWidth() and this:GetHeight() then |
if self.OnWidthSet then |
self:OnWidthSet(this:GetWidth()) |
end |
if self.OnHeightSet then |
self:OnHeightSet(this:GetHeight()) |
end |
end |
end |
local function ContentResize(this) |
if this:GetWidth() and this:GetHeight() then |
this.width = this:GetWidth() |
this.height = this:GetHeight() |
this.obj:DoLayout() |
end |
end |
setmetatable(WidgetContainerBase,{__index=WidgetBase}) |
--One of these function should be called on each Widget Instance as part of its creation process |
--- Register a widget-class as a container for newly created widgets. |
-- @param widget The widget class |
function AceGUI:RegisterAsContainer(widget) |
widget.children = {} |
widget.userdata = {} |
widget.events = {} |
widget.base = WidgetContainerBase |
widget.content.obj = widget |
widget.frame.obj = widget |
widget.content:SetScript("OnSizeChanged",ContentResize) |
widget.frame:SetScript("OnSizeChanged",FrameResize) |
setmetatable(widget,{__index=WidgetContainerBase}) |
widget:SetLayout("List") |
end |
--- Register a widget-class as a widget. |
-- @param widget The widget class |
function AceGUI:RegisterAsWidget(widget) |
widget.userdata = {} |
widget.events = {} |
widget.base = WidgetBase |
widget.frame.obj = widget |
widget.frame:SetScript("OnSizeChanged",FrameResize) |
setmetatable(widget,{__index=WidgetBase}) |
end |
end |
------------------ |
-- Widget API -- |
------------------ |
--- Registers a widget Constructor, this function returns a new instance of the Widget |
-- @param Name The name of the widget |
-- @param Constructor The widget constructor function |
-- @param Version The version of the widget |
function AceGUI:RegisterWidgetType(Name, Constructor, Version) |
assert(type(Constructor) == "function") |
assert(type(Version) == "number") |
local oldVersion = WidgetVersions[Name] |
if oldVersion and oldVersion >= Version then return end |
WidgetVersions[Name] = Version |
WidgetRegistry[Name] = Constructor |
end |
--- Registers a Layout Function |
-- @param Name The name of the layout |
-- @param LayoutFunc Reference to the layout function |
function AceGUI:RegisterLayout(Name, LayoutFunc) |
assert(type(LayoutFunc) == "function") |
if type(Name) == "string" then |
Name = Name:upper() |
end |
LayoutRegistry[Name] = LayoutFunc |
end |
--- Get a Layout Function from the registry |
-- @param Name The name of the layout |
function AceGUI:GetLayout(Name) |
if type(Name) == "string" then |
Name = Name:upper() |
end |
return LayoutRegistry[Name] |
end |
AceGUI.counts = AceGUI.counts or {} |
--- A type-based counter to count the number of widgets created. |
-- This is used by widgets that require a named frame, e.g. when a Blizzard |
-- Template requires it. |
-- @param type The widget type |
function AceGUI:GetNextWidgetNum(type) |
if not self.counts[type] then |
self.counts[type] = 0 |
end |
self.counts[type] = self.counts[type] + 1 |
return self.counts[type] |
end |
--[[ Widget Template |
-------------------------- |
-- Widget Name -- |
-------------------------- |
do |
local Type = "Type" |
local function OnAcquire(self) |
end |
local function OnRelease(self) |
self.frame:ClearAllPoints() |
self.frame:Hide() |
end |
local function Constructor() |
local frame = CreateFrame("Frame",nil,UIParent) |
local self = {} |
self.type = Type |
self.OnRelease = OnRelease |
self.OnAcquire = OnAcquire |
self.frame = frame |
frame.obj = self |
--Container Support |
--local content = CreateFrame("Frame",nil,frame) |
--self.content = content |
--AceGUI:RegisterAsContainer(self) |
AceGUI:RegisterAsWidget(self) |
return self |
end |
AceGUI:RegisterWidgetType(Type,Constructor) |
end |
]] |
------------- |
-- Layouts -- |
------------- |
--[[ |
A Layout is a func that takes 2 parameters |
content - the frame that widgets will be placed inside |
children - a table containing the widgets to layout |
]] |
-- Very simple Layout, Children are stacked on top of each other down the left side |
AceGUI:RegisterLayout("List", |
function(content, children) |
local height = 0 |
local width = content.width or content:GetWidth() or 0 |
for i = 1, #children do |
local child = children[i] |
local frame = child.frame |
frame:ClearAllPoints() |
frame:Show() |
if i == 1 then |
frame:SetPoint("TOPLEFT",content,"TOPLEFT",0,0) |
else |
frame:SetPoint("TOPLEFT",children[i-1].frame,"BOTTOMLEFT",0,0) |
end |
if child.width == "fill" then |
child:SetWidth(width) |
frame:SetPoint("RIGHT",content,"RIGHT") |
if child.OnWidthSet then |
child:OnWidthSet(content.width or content:GetWidth()) |
end |
if child.DoLayout then |
child:DoLayout() |
end |
elseif child.width == "relative" then |
child:SetWidth(width * child.relWidth) |
if child.OnWidthSet then |
child:OnWidthSet(content.width or content:GetWidth()) |
end |
if child.DoLayout then |
child:DoLayout() |
end |
end |
height = height + (frame.height or frame:GetHeight() or 0) |
end |
safecall( content.obj.LayoutFinished, content.obj, nil, height ) |
end |
) |
-- A single control fills the whole content area |
AceGUI:RegisterLayout("Fill", |
function(content, children) |
if children[1] then |
children[1]:SetWidth(content:GetWidth() or 0) |
children[1]:SetHeight(content:GetHeight() or 0) |
children[1].frame:SetAllPoints(content) |
children[1].frame:Show() |
safecall( content.obj.LayoutFinished, content.obj, nil, children[1].frame:GetHeight() ) |
end |
end |
) |
AceGUI:RegisterLayout("Flow", |
function(content, children) |
--used height so far |
local height = 0 |
--width used in the current row |
local usedwidth = 0 |
--height of the current row |
local rowheight = 0 |
local rowoffset = 0 |
local lastrowoffset |
local width = content.width or content:GetWidth() or 0 |
--control at the start of the row |
local rowstart |
local rowstartoffset |
local lastrowstart |
local isfullheight |
local frameoffset |
local lastframeoffset |
local oversize |
for i = 1, #children do |
local child = children[i] |
oversize = nil |
local frame = child.frame |
local frameheight = frame.height or frame:GetHeight() or 0 |
local framewidth = frame.width or frame:GetWidth() or 0 |
lastframeoffset = frameoffset |
-- HACK: Why did we set a frameoffset of (frameheight / 2) ? |
-- That was moving all widgets half the widgets size down, is that intended? |
-- Actually, it seems to be neccessary for many cases, we'll leave it in for now. |
-- If widgets seem to anchor weirdly with this, provide a valid alignoffset for them. |
-- TODO: Investigate moar! |
frameoffset = child.alignoffset or (frameheight / 2) |
if child.width == "relative" then |
framewidth = width * child.relWidth |
end |
frame:Show() |
frame:ClearAllPoints() |
if i == 1 then |
-- anchor the first control to the top left |
frame:SetPoint("TOPLEFT",content,"TOPLEFT",0,0) |
rowheight = frameheight |
rowoffset = frameoffset |
rowstart = frame |
rowstartoffset = frameoffset |
usedwidth = framewidth |
if usedwidth > width then |
oversize = true |
end |
else |
-- if there isn't available width for the control start a new row |
-- if a control is "fill" it will be on a row of its own full width |
if usedwidth == 0 or ((framewidth) + usedwidth > width) or child.width == "fill" then |
if isfullheight then |
-- a previous row has already filled the entire height, there's nothing we can usefully do anymore |
-- (maybe error/warn about this?) |
break |
end |
--anchor the previous row, we will now know its height and offset |
rowstart:SetPoint("TOPLEFT",content,"TOPLEFT",0,-(height+(rowoffset-rowstartoffset)+3)) |
height = height + rowheight + 3 |
--save this as the rowstart so we can anchor it after the row is complete and we have the max height and offset of controls in it |
rowstart = frame |
rowstartoffset = frameoffset |
rowheight = frameheight |
rowoffset = frameoffset |
usedwidth = framewidth |
if usedwidth > width then |
oversize = true |
end |
-- put the control on the current row, adding it to the width and checking if the height needs to be increased |
else |
--handles cases where the new height is higher than either control because of the offsets |
--math.max(rowheight-rowoffset+frameoffset, frameheight-frameoffset+rowoffset) |
--offset is always the larger of the two offsets |
rowoffset = math_max(rowoffset, frameoffset) |
rowheight = math_max(rowheight,rowoffset+(frameheight/2)) |
--print("type:", child.type, "offset:",frameoffset-lastframeoffset) |
frame:SetPoint("TOPLEFT",children[i-1].frame,"TOPRIGHT",0,frameoffset-lastframeoffset) |
usedwidth = framewidth + usedwidth |
end |
end |
if child.width == "fill" then |
child:SetWidth(width) |
frame:SetPoint("RIGHT",content,"RIGHT",0,0) |
usedwidth = 0 |
rowstart = frame |
rowstartoffset = frameoffset |
if child.OnWidthSet then |
child:OnWidthSet(width) |
end |
if child.DoLayout then |
child:DoLayout() |
end |
rowheight = frame.height or frame:GetHeight() or 0 |
rowoffset = child.alignoffset or (rowheight / 2) |
rowstartoffset = rowoffset |
elseif child.width == "relative" then |
child:SetWidth(width * child.relWidth) |
if child.OnWidthSet then |
child:OnWidthSet(width) |
end |
if child.DoLayout then |
child:DoLayout() |
end |
elseif oversize then |
if width > 1 then |
frame:SetPoint("RIGHT",content,"RIGHT",0,0) |
end |
end |
if child.height == "fill" then |
frame:SetPoint("BOTTOM",content,"BOTTOM") |
isfullheight = true |
end |
end |
--anchor the last row, if its full height needs a special case since its height has just been changed by the anchor |
if isfullheight then |
rowstart:SetPoint("TOPLEFT",content,"TOPLEFT",0,-height) |
elseif rowstart then |
rowstart:SetPoint("TOPLEFT",content,"TOPLEFT",0,-(height+(rowoffset-rowstartoffset)+3)) |
end |
height = height + rowheight + 3 |
safecall( content.obj.LayoutFinished, content.obj, nil, height ) |
end |
) |
local AceGUI = LibStub("AceGUI-3.0") |
-- WoW APIs |
local CreateFrame, UIParent = CreateFrame, UIParent |
------------- |
-- Widgets -- |
------------- |
--[[ |
Widgets must provide the following functions |
Acquire() - Called when the object is aquired, should set everything to a default hidden state |
Release() - Called when the object is Released, should remove any anchors and hide the Widget |
And the following members |
frame - the frame or derivitive object that will be treated as the widget for size and anchoring purposes |
type - the type of the object, same as the name given to :RegisterWidget() |
Widgets contain a table called userdata, this is a safe place to store data associated with the wigdet |
It will be cleared automatically when a widget is released |
Placing values directly into a widget object should be avoided |
If the Widget can act as a container for other Widgets the following |
content - frame or derivitive that children will be anchored to |
The Widget can supply the following Optional Members |
]] |
-------------------------- |
-- Inline Group -- |
-------------------------- |
--[[ |
This is a simple grouping container, no selection |
It will resize automatically to the height of the controls added to it |
]] |
do |
local Type = "InlineGroup" |
local Version = 6 |
local function OnAcquire(self) |