Fixer.lua

--------------------------------------------------------------------------------
-- BadPet @project-version@
-- File:    Fixer.lua
-- Author:  @project-author@
-- License: LICENSE.txt
--------------------------------------------------------------------------------

-- Check that dependencies are available.

if not BadPet then return end
local BadPet = BadPet;

local ldb = LibStub:GetLibrary("LibDataBroker-1.1", true);
if not ldb then return end

local qtip = LibStub:GetLibrary("LibQTip-1.0", true);
if not qtip then return end

local BadPet = BadPet;
local Fixer = BadPet.Fixer;

if not Fixer then
    Fixer = BadPet:NewModule("BadPetFixer", "AceConsole-3.0", "AceEvent-3.0",
        "AceTimer-3.0");
    Fixer.parent = BadPet;
    BadPet.Fixer = Fixer;
    Fixer.spells = {};
end

--------------------------------------------------------------------------------
-- Configuration
--------------------------------------------------------------------------------

Fixer.options = {
    name = "BadPetFixer",
    type = 'group',
    handler = BadPet,
    set = "SetOption",
    get = "GetOption",
    order = 50,
    args = {
        p1 = {
            name = "BadPet_Fixer is a module for helping hunters and warlocks control"
                    .. " their pets. It provides a hidden frame which you can click with"
                    .. " a macro to set your pets taunt events to whatever you configure"
                    .. " here. Add this to a macro, or type it into chat:",
            type = "description",
            fontSize = "medium",
            order = 1,
        },
        p2 = {
            name = "/click BadPetFixer",
            type = "description",
            fontSize = "large",
            order = 2,
        },
        p3 = {
            name = "There is also a LibDataBroker plugin for ChocolateBar or"
                    .. " similar which shows the state of your pet's auto-cast taunts."
                    .. " You can click on the taunts in the LDB tooltip to toggle them.",
            type = "description",
            fontSize = "medium",
            order = 3,
        },
        fixer = {
            name = "Enable BadPet_Fixer (Data Broker Feed)",
            type = "toggle",
            order = 4,
            width = "double",
        },
        spells = {
            name = "Spells",
            type = "group",
            handler = Fixer,
            get = "GetSpellState",
            set = "SetSpellState",
            order = 5,
            args = {
                inside = {
                    name = "Inside Instances",
                    type = "group",
                    args = {},
                },
                outside = {
                    name = "Outside Instances",
                    type = "group",
                    args = {},
                },
            },
        },
    },
};

BadPet.options.args.fixer = Fixer.options;

--- Get the state of a sepll in the spells option table.
function Fixer:GetSpellState(info)
    local where, id = info[#info - 1], tonumber(info[#info]);
    local db = self.parent.db.profile.fixerdb;

    if db and db[where] and db[where][id] ~= nil then
        if db[where][id] then
            return true
        else
            return false
        end
    end

    if where == "inside" then
        return false;
    else
        return true;
    end
end

--- Set the state of a spell in the spells option table.
function Fixer:SetSpellState(info, value)
    local where = info[#info - 1]
    local id = tonumber(info[#info]);
    local db = self.parent.db.profile.fixerdb;

    if not db then
        db = {};
        db.inside = {};
        db.outside = {};
        self.parent.db.profile.fixerdb = db;
    end

    db[where][id] = value;

    self:Refresh();
end

--- Refresh the spells option table.
function Fixer:RefreshSpells()
    local inside = self.options.args.spells.args.inside;
    local outside = self.options.args.spells.args.outside;
    local db = self.parent.db.profile.fixerdb;
    local inInstance = self.parent:GetInInstance();

    local where;
    if inInstance then
        where = "inside";
    else
        where = "outside";
    end

    inside.args = {};
    outside.args = {};
    self.spells = {};

    for id, name in pairs(self.parent.spells) do
        local c = { name = name, type = "toggle" };
        inside.args[tostring(id)] = c;
        outside.args[tostring(id)] = c;

        if db and db[where] and db[where][id] ~= nil then
            self.spells[name] = db[where][id];
        else
            self.spells[name] = not inInstance;
        end
    end

    LibStub("AceConfigRegistry-3.0"):NotifyChange("BadPet: Fixer");
end

--------------------------------------------------------------------------------
-- Setup
--------------------------------------------------------------------------------

--- Initializes the addon's configuration and registers hooks.
-- Called by Ace3 when the addon loads and saved variables are available.
function Fixer:OnInitialize()

    -- Create Frame
    self.frame = CreateFrame("Button", "BadPetFixer", UIParent,
        "SecureActionButtonTemplate");
    self.frame:SetAttribute("type", "macro");
    self.frame:SetAttribute("macrotext", "");

    -- Register configuration page and slash commands.
    local conf = LibStub("AceConfig-3.0");
    conf:RegisterOptionsTable("BadPet: Fixer", self.options);

    local dialog = LibStub("AceConfigDialog-3.0");
    dialog:AddToBlizOptions("BadPet: Fixer", "Fixer", "BadPet");
end

--- Called by framework when user enables module, and after load.
function Fixer:OnEnable()
    self:RegisterEvent("PLAYER_ENTERING_WORLD", "Refresh");
    self:RegisterEvent("PET_BAR_UPDATE", "Refresh");
    self:RegisterEvent("UNIT_PET", "Refresh");
    self:RegisterEvent("PLAYER_REGEN_ENABLED", "Refresh");
    self:Refresh();

    self.ldbdata.OnEnter = function(frame)
        Fixer:ShowTooltip(frame);
    end
end

--- Called by framework when user disables module.
function Fixer:OnDisable()
    self:UnregisterEvent("PLAYER_ENTERING_WORLD");
    self:UnregisterEvent("PET_BAR_UPDATE");
    self:UnregisterEvent("UNIT_PET");
    self:UnregisterEvent("PLAYER_REGEN_ENABLED");
    self:Refresh();

    self.ldbdata.OnEnter = function(frame) end
end

--- Updates the LDB Object, Frame, and spells.
function Fixer:Refresh()
    local inLockdown = InCombatLockdown()

    if not self.parent.db.profile.fixer then
        self.ldbdata.text = "Bad Pet";
        if not inLockdown then
            self.frame:SetAttribute("macrotext", "/bp config");
        end
        return;
    end

    self:RefreshSpells();

    local pet = GetUnitName("pet");
    local color;
    local macrotext = "";

    local inInstance = self.parent:GetInInstance();
    for name, goal in pairs(self.spells) do
        local castable, state = GetSpellAutocast(name, BOOKTYPE_PET);
        if castable then
            if goal == not state then
                color = "|cffff0000"
                macrotext = macrotext .. "/petautocasttoggle " .. name .. "\n";
            end
        end
    end

    if not color then
        color = "|cff00ff00"
    end

    if not inLockdown then
        self.frame:SetAttribute("macrotext", macrotext);
    end
    if pet then
        self.ldbdata.text = color .. pet .. "|r";

        if pet == "Unknown" then
            self:ScheduleTimer("Refresh", 0.5);
        end
    else
        self.ldbdata.text = "Bad Pet";
    end
end

--- Show tooltip.
function Fixer:ShowTooltip(frame)
    local tooltip = qtip:Acquire("BadPetTooltip", 2, "LEFT", "RIGHT");
    frame.tooltip = tooltip;

    tooltip:Clear();

    local inInstance = self.parent:GetInInstance();

    tooltip:AddHeader("|cffffff00Bad Pet|r");
    tooltip:AddLine("Report Frequency", BadPet.db.profile.state);
    tooltip:AddLine("Report Target", BadPet.db.profile.frame);
    tooltip:AddLine("In Instance", "yes" and inInstance or "no");

    if BadPet.db.profile.debug then
        tooltip:AddLine("Debug", BadPet.db.profile.debug);
    end

    tooltip:AddLine(" ");

    local pet = GetUnitName("pet");
    if not pet then
        tooltip:AddLine("You do not have a pet");
    else
        tooltip:AddHeader("|cffffff00" .. pet .. "|r");

        for spell, _ in pairs(self.spells) do
            local castable, state = GetSpellAutocast(spell, BOOKTYPE_PET);
            local font;
            if castable then
                local line = tooltip:AddLine(spell);
                tooltip:SetCell(line, 2, spell, self.cellProvider);
            end
        end
    end

    tooltip:SmartAnchorTo(frame);
    tooltip:SetAutoHideDelay(0.25, frame);
    tooltip:Show();
end

--------------------------------------------------------------------------------
-- LibDataBroker
--------------------------------------------------------------------------------

--- LDB Data Object
if not Fixer.ldbdata then
    Fixer.ldbdata = LibStub:GetLibrary("LibDataBroker-1.1"):NewDataObject("Bad Pet", { type = "data source", text = "Bad Pet" });
end

function Fixer.ldbdata:OnClick()
    InterfaceOptionsFrame_OpenToCategory(BadPet.config);
    InterfaceOptionsFrame_OpenToCategory(BadPet.config);
end

--------------------------------------------------------------------------------
-- QTip Secure Buttons for toggling casts
--------------------------------------------------------------------------------

Fixer.cellPrototype = {
    SetupCell = function(frame, tooltip, value, align, font)
        local fs = frame.fontString;
        fs:SetFontObject(font or tooltip:GetFont());
        fs:SetJustifyH(align);

        frame.value = value;
        frame:RefreshCell();

        frame:SetAttribute("macrotext", "/petautocasttoggle " .. value);

        frame:Show();
        return fs:GetStringWidth(), fs:GetStringHeight();
    end,
    RefreshCell = function(frame)
        local castable, state = GetSpellAutocast(frame.value, BOOKTYPE_PET);
        if not castable then
            frame.fontString:SetText("error");
        else
            local goal = Fixer.spells[frame.value];
            if goal and state or not goal and not state then
                frame.fontString:SetTextColor(0, 1, 0);
            else
                frame.fontString:SetTextColor(1, 0, 0);
            end
            if state then
                frame.fontString:SetText("on");
            else
                frame.fontString:SetText("off");
            end
        end
    end,
    InitCell = function(frame)
        frame.fontString = frame:CreateFontString();
        frame.fontString:SetAllPoints(frame);
        frame:SetAttribute("type", "macro");
        frame:SetAttribute("macrotext", "");
        frame:SetScript("PostClick", function(frame, ...)
            frame:RefreshCell();
        end);
    end,
    ResetCell = function(frame)
        frame.value = nil;
        frame.fontString:SetText("");
        frame.fontString:SetTextColor(frame.r, frame.g, frame.b);
        frame:SetAttribute("type", "macro");
        frame:SetAttribute("macrotext", "");
    end,
}

setmetatable(Fixer.cellPrototype,
    {
        __index = CreateFrame("Button", nil, UIParent, "SecureActionButtonTemplate")
    });

Fixer.cellProvider = {
    heap = {},
    cellPrototype = Fixer.cellPrototype,
    cellMetatable = { __index = Fixer.cellPrototype }
}

function Fixer.cellProvider:AcquireCell(tooltip)
    local cell = table.remove(self.heap);

    if not cell then
        cell = CreateFrame("Button", nil, UIParent, "SecureActionButtonTemplate");
        setmetatable(cell, self.cellMetatable);
        cell:InitCell();
    end

    return cell;
end

function Fixer.cellProvider:ReleaseCell(cell)
    cell:ResetCell();
    table.insert(self.heap, cell);
end

function Fixer.cellProvider:GetCellPrototype()
    return self.cellPrototype, self.cellMetatable;
end