AddonCompatibility.lua

---@class BuffOverlay: AceModule
local BuffOverlay = LibStub("AceAddon-3.0"):GetAddon("BuffOverlay")

local pairs, IsAddOnLoaded, next, type = pairs, C_AddOns.IsAddOnLoaded, next, type
local addOnsExist = true
local enabledPatterns = {}
local framesToFind = {}
local tempFrameCache = {}

BuffOverlay.frames = {}

--[[ addonFrameInfo

    key:    The name of the addon. This key checked with IsAddOnLoaded, so it must match the name of the
            addon's .toc file exactly.

    frame:  The pattern to match the frame name against. Be as specific as possible, preferrably with beginnings (^)
            and endings ($) as we want to minimize the number of frames we need to process and avoid attaching
            to incorrect frames.

    type:   The filter type of frame. This is used to determine which bars to show/hide when the user changes
            visibility settings.

            Current valid types are "arena", "raid", "party", "pet", "tank", "assist", and "player". If adding more types,
            be sure to update the defaultBarSettings table in BuffOverlay.lua.

    unit:   The name of the key that the addon uses to identify the frame's corresponding displayed unit.
]]
local addonFrameInfo = {
    ["ElvUI"] = {
        {
            frame = "^ElvUF_Raid%d+Group%dUnitButton%d+$",
            type = "raid",
            unit = "unit",
        },
        {
            frame = "^ElvUF_PartyGroup1UnitButton%d+$",
            type = "party",
            unit = "unit",
        },
        {
            frame = "^ElvUF_RaidpetGroup%dUnitButton%d+$",
            type = "pet",
            unit = "unit",
        },
        {
            frame = "^ElvUF_TankUnitButton%d$",
            type = "tank",
            unit = "unit",
        },
        {
            frame = "^ElvUF_AssistUnitButton%d$",
            type = "assist",
            unit = "unit",
        },
    },
    ["VuhDo"] = {
        {
            frame = "^Vd%dH%d+$",
            type = "raid",
            unit = "raidid",
        },
    },
    ["Grid"] = {
        {
            frame = "^GridLayout",
            type = "raid",
            unit = "unit",
        },
    },
    ["Grid2"] = {
        {
            frame = "^Grid2Layout",
            type = "raid",
            unit = "unit",
        },
    },
    ["HealBot"] = {
        {
            frame = "^HealBot_Action_HealUnit%d+$",
            type = "raid",
            unit = "unit",
        },
        {
            frame = "^HealBot_HealUnit%d+$",
            type = "raid",
            unit = "unit",
        },
        {
            frame = "^hbTest_HealUnit%d+$",
            type = "raid",
            unit = "unit",
        },
    },
    ["Cell"] = {
        {
            frame = "^CellRaidFrameHeader%d+UnitButton%d+$",
            type = "raid",
            unit = "unitid",
        },
        {
            frame = "^CellPartyFrameHeaderUnitButton%d+$",
            type = "party",
            unit = "unitid",
        },
        {
            frame = "^CellRaidFrameHeader%d+UnitButton%d+Pet$",
            type = "pet",
            unit = "unitid",
        },
        {
            frame = "^CellPartyFrameHeaderUnitButton%d+Pet$",
            type = "pet",
            unit = "unitid",
        },
        {
            frame = "^CellSoloFramePlayer$",
            -- type = "solo",
            type = "party",
            unit = "unitid",
        },
        {
            frame = "^CellSoloFramePet$",
            type = "pet",
            unit = "unitid",
        },
    },
    ["Aptechka"] = {
        {
            frame = "^NugRaid%d+UnitButton%d+",
            type = "raid",
            unit = "unit",
        },
    },
    ["InvenRaidFrames3"] = {
        {
            frame = "^InvenRaidFrames3Group%dUnitButton",
            type = "raid",
            unit = "unit",
        },
        {
            frame = "^InvenUnitFrames_Party%d",
            type = "party",
            unit = "unit",
        },
    },
    ["Lime"] = {
        {
            frame = "^LimeGroup",
            type = "raid",
            unit = "unit",
        },
    },
    ["Plexus"] = {
        {
            frame = "^PlexusLayoutHeader%dUnitButton",
            type = "raid",
            unit = "unit",
        },
    },
    ["Tukui"] = {
        {
            frame = "TuikuiPartyUnitButton",
            type = "party",
            unit = "unit",
        },
        {
            frame = "TukuiRaidUnitButton",
            type = "raid",
            unit = "unit",
        },
    },
    ["ShadowedUnitFrames"] = {
        {
            frame = "^SUFHeaderraidUnitButton",
            type = "raid",
            unit = "unit",
        },
        {
            frame = "^SUFHeaderraid%dUnitButton",
            type = "raid",
            unit = "unit",
        },
        {
            frame = "^SUFHeaderpartyUnitButton",
            type = "party",
            unit = "unit",
        },
        {
            frame = "^SUFUnitplayer$",
            type = "player",
            unit = "unit",
        },
    },
    ["ZPerl"] = {
        {
            frame = "^XPerl_Raid",
            type = "raid",
            unit = "partyid",
        },
    },
    ["PitBull4"] = {
        {
            frame = "^PitBull4_Groups_Party",
            type = "raid",
            unit = "unit",
        },
    },
    ["NDui"] = {
        {
            frame = "^oUF_.-Party",
            type = "party",
            unit = "unit",
        },
        {
            frame = "^oUF_.-Raid",
            type = "raid",
            unit = "unit",
        },
    },
    ["oUF"] = {
        {
            frame = "^oUF_.-Party",
            type = "party",
            unit = "unit",
        },
        {
            frame = "^oUF_.-Raid",
            type = "raid",
            unit = "unit",
        },
    },
    ["KkthxUI"] = {
        {
            frame = "^oUF_.-Party",
            type = "party",
            unit = "unit",
        },
        {
            frame = "^oUF_.-Raid",
            type = "raid",
            unit = "unit",
        },
    },
    ["GW2_UI"] = {
        {
            frame = "^GwCompactRaidFrame",
            type = "raid",
            unit = "unit",
        },
    },
    ["AltzUI"] = {
        {
            frame = "^Altz_HealerRaidUnitButton",
            type = "raid",
            unit = "unit",
        },
        {
            frame = "^Altz_DpsRaidUnitButton",
            type = "raid",
            unit = "unit",
        },
    },
    ["AshToAsh"] = {
        {
            frame = "^AshToAshUnit%d+Unit%d+",
            type = "raid",
            unit = "unit",
        },
        {
            frame = "^AshToAshPet%d+Unit%d+",
            type = "pet",
            unit = "unit",
        },
        {
            frame = "^AshToAshUnitWatch%d+Unit%d+",
            type = "raid",
            unit = "unit",
        },
    },
    ["LunaUnitFrames"] = {
        {
            frame = "^LUFHeaderpartyUnitButton%d+",
            type = "party",
            unit = "unit",
        },
        {
            frame = "^LUFHeaderraid%d+UnitButton%d+",
            type = "raid",
            unit = "unit",
        },
        {
            frame = "^LUFHeadermaintankUnitButton%d+",
            type = "tank",
            unit = "unit",
        },
    },
    ["PartyPetsFix"] = {
        {
            frame = "^PPF_PetButton$",
            type = "pet",
            unit = "unit",
        },
    },
}

local blizzardFrameInfo = {
    {
        frame = "^CompactRaidGroup%d+Member%d+$",
        type = "raid",
        unit = "displayedUnit",
    },
    {
        frame = "^CompactRaidFrame%d+$",
        type = "raid",
        unit = "displayedUnit",
    },
    {
        frame = "^CompactPartyFrameMember%d+$",
        type = "party",
        unit = "displayedUnit",
    },
    {
        frame = "^CompactPartyFramePet%d+$",
        type = "pet",
        unit = "displayedUnit",
    },
    {
        frame = "^CompactArenaFrameMember%d+$",
        type = "arena",
        unit = "displayedUnit",
    },
    {
        frame = "^CompactArenaFramePet%d+$",
        type = "pet",
        unit = "displayedUnit",
    },
}

local function AddOnsExist()
    local addonsExist = false
    for addon, info in pairs(addonFrameInfo) do
        if IsAddOnLoaded(addon) then
            for _, frameInfo in pairs(info) do
                enabledPatterns[frameInfo.frame] = { unit = frameInfo.unit, type = frameInfo.type }
            end

            if not addonsExist then
                addonsExist = true
            end

            -- Fix for ElvUI Party Pet Frames. They are not in the frame cache due
            -- to the way ElvUI creates them. This is unique to party pets, thankfully.
            if addon == "ElvUI" then
                for i = 1, 5 do
                    framesToFind["ElvUF_PartyGroup1UnitButton" .. i .. "Pet"] = { unit = "unit", type = "pet" }
                end
            end

            -- PartyPets Fix does not create button frames with unique names, so we
            -- have to add them manually.
            if addon == "PartyPetsFix" then
                for i = 1, 4 do
                    local parent = _G["PPF_P" .. i]
                    local children = { parent:GetChildren() }

                    for _, child in pairs(children) do
                        local name = child:GetName()
                        if name and name:match("^CPPFets_PlayerPetButton$") then
                            BuffOverlay.frames[child] = { unit = "unit", type = "pet" }
                            break
                        end
                    end
                end
            end
        end
    end

    -- Fix for AshToAsh
    if IsAddOnLoaded("AshToAsh") and IsAddOnLoaded("Scorpio") then
        -- Declare a ui style property to receive the unit from the unit frame
        Scorpio.UI.Property {
            name = "BuffOverlayUnit",
            require = Scorpio.Secure.UnitFrame,
            nilable = true,
            set = function(self, unit)
                if unit and unit ~= "clear" then
                    local frame = Scorpio.UI.GetRawUI(self)

                    if not BuffOverlay.frames[frame] then
                        tempFrameCache[frame] = frame:GetName()
                    end

                    frame.unit = unit
                end
            end,
        }

        -- Add the property to the base unit frame class's default skin
        -- So all unit frame generated from Scorpio will use that
        Scorpio.UI.Style.UpdateSkin("Default", {
            [Scorpio.Secure.UnitFrame] = {
                -- Scorpio.Wow.Unit() is an observable data source
                -- provide the unit from the unit frame
                BuffOverlayUnit = Scorpio.Wow.Unit()
            }
        }, true)
    end

    addOnsExist = addonsExist
    BuffOverlay.addons = addonsExist
    return addonsExist
end

local function cleanFrameCache()
    for frame, name in pairs(tempFrameCache) do
        for addOnFramePattern, data in pairs(enabledPatterns) do
            if name:match(addOnFramePattern) then
                BuffOverlay.frames[frame] = { unit = data.unit, type = data.type }
                break
            end
        end

        tempFrameCache[frame] = nil
    end
end

local function updateUnits()
    cleanFrameCache()

    if next(framesToFind) ~= nil then
        for f, data in pairs(framesToFind) do
            local frame = _G[f]
            if frame and not BuffOverlay.frames[frame] then
                BuffOverlay.frames[frame] = { unit = data.unit, type = data.type }
                framesToFind[f] = nil
            end
        end
    end

    for frame, data in pairs(BuffOverlay.frames) do
        local unit = frame[data.unit] or SecureButton_GetUnit(frame)

        if unit and not data.blizz then
            BuffOverlay:AddUnitFrame(frame, unit)
        end
    end
    BuffOverlay:RefreshOverlays()
end

function BuffOverlay:UpdateUnits()
    if not addOnsExist then return end
    -- Some addons take a second to load their frames fully.
    -- updateUnits() is cheap so we'll just run it twice.
    updateUnits()
    C_Timer.After(1, updateUnits)
end

function BuffOverlay:InitFrames()
    -- Double wait to make sure all addons are loaded.
    -- PLAYER_LOGIN fires too early.
    C_Timer.After(0, function()
        C_Timer.After(0, function()
            -- Blizzard frames are handled differently so if we have no supported addons
            -- installed then we don't need to waste cycles scanning for frames.
            if AddOnsExist() then
                self.eventHandler:RegisterEvent("UNIT_EXITED_VEHICLE")
                self.eventHandler:RegisterEvent("UNIT_ENTERED_VEHICLE")

                self:UpdateUnits()
            end
        end)
    end)
end

-- Blizzard Frames are handled separately because we do not need to scan for them.
hooksecurefunc("CompactUnitFrame_SetUpFrame", function(frame)
    if not frame.buffFrames then return end

    if not BuffOverlay.frames[frame] then
        local name = frame:GetName()

        for _, info in pairs(blizzardFrameInfo) do
            if name:match(info.frame) then
                BuffOverlay.frames[frame] = { unit = info.unit, type = info.type, blizz = true }
                break
            end
        end
    end

    if not BuffOverlay.blizzFrames[frame] then
        BuffOverlay.blizzFrames[frame] = true
    end
end)

-- We obtain frame references entirely from this CreateFrame hook. If an addon does not
-- give the frames they create a unique name, we cannot get the reference here (since we rely on
-- looking the frame up in the global table to get the reference) and therefore it needs
-- to be handled on an addon-specific basis.
hooksecurefunc("CreateFrame", function(frameType, frameName)
    if not addOnsExist then return end

    if frameName and frameType == "Button" then
        local frame = _G[frameName]

        if frame
        and type(frame) == "table"
        and frame.IsForbidden
        and not frame:IsForbidden() then
            if not frameName:match("BuffOverlayBar") then
                tempFrameCache[frame] = frameName
            end
        end
    end
end)

-- HACK: Fix for Blizzard change introduced in Cata classic which breaks LibDialog.
-- TODO: Update LibDialog
do
    if not _G.StaticPopup_DisplayedFrames then
        _G.StaticPopup_DisplayedFrames = {}
    end
end