thirdparty: unify bag sort integration code

modules/thirdparty-tbc.lua

@@ -195,104 +195,31 @@ pfUI:RegisterModule("thirdparty-tbc", "tbc", function ()
 
   HookAddonOrVariable("Bag_Sort", function()
     if C.thirdparty.bag_sort.enable == "0" then return end
-    pfUI.thirdparty.bagsort = "bag_sort"
 
-    pfUI.thirdparty.bag_sort = CreateFrame("Frame", nil)
+    local sort = CreateFrame("Frame", nil)
-    pfUI.thirdparty.bag_sort:RegisterEvent("PLAYER_ENTERING_WORLD")
+    sort:RegisterEvent("PLAYER_ENTERING_WORLD")
-    pfUI.thirdparty.bag_sort:SetScript("OnEvent", function()
+    sort:SetScript("OnEvent", function()
-      pfUI.thirdparty.bag_sort:UnregisterAllEvents()
+      this:UnregisterAllEvents()
 
-      -- don't do anything if another bagsorter was found
+      pfUI.thirdparty.RegisterBagSort("Bag_Sort",
-      if pfUI.thirdparty.bagsort ~= "bag_sort" then return end
+        function()
-
-      -- make sure the bag module is enabled
-      if not pfUI.bag or not pfUI.bag.right then return end
-
-      local rawborder, default_border = GetBorderSize("bags")
-
-      -- draw the button
-      if not pfUI.bag.right.sort then
-        pfUI.bag.right.sort = CreateFrame("Button", "pfBagSlotSort", UIParent)
-        pfUI.bag.right.sort:SetParent(pfUI.bag.right)
-        pfUI.bag.right.sort:SetPoint("TOPRIGHT", pfUI.bag.right.keys, "TOPLEFT", -default_border*3, 0)
-
-        CreateBackdrop(pfUI.bag.right.sort, default_border)
-        pfUI.bag.right.sort:SetHeight(12)
-        pfUI.bag.right.sort:SetWidth(12)
-        pfUI.bag.right.sort:SetTextColor(1,1,.25,1)
-        pfUI.bag.right.sort:SetFont(pfUI.font_default, C.global.font_size, "OUTLINE")
-        pfUI.bag.right.sort.texture = pfUI.bag.right.sort:CreateTexture("pfBagArrowUp")
-        pfUI.bag.right.sort.texture:SetTexture(pfUI.media["img:sort"])
-        pfUI.bag.right.sort.texture:ClearAllPoints()
-        pfUI.bag.right.sort.texture:SetPoint("TOPLEFT", pfUI.bag.right.sort, "TOPLEFT", 2, -2)
-        pfUI.bag.right.sort.texture:SetPoint("BOTTOMRIGHT", pfUI.bag.right.sort, "BOTTOMRIGHT", -2, 2)
-        pfUI.bag.right.sort.texture:SetVertexColor(.25,.25,.25,1)
-
-        pfUI.bag.right.sort:SetScript("OnEnter", function ()
-          pfUI.bag.right.sort.backdrop:SetBackdropBorderColor(1,1,.25,1)
-          pfUI.bag.right.sort.texture:SetVertexColor(1,1,.25,1)
-          GameTooltip:SetOwner(this, "ANCHOR_RIGHT")
-          GameTooltip:SetText(GetAddOnMetadata("Bag_Sort","Title"))
-          GameTooltip:AddLine(GetAddOnMetadata("Bag_Sort","Notes"),1,1,1)
-          GameTooltip:Show()
-        end)
-
-        pfUI.bag.right.sort:SetScript("OnLeave", function ()
-          CreateBackdrop(pfUI.bag.right.sort)
-          pfUI.bag.right.sort.texture:SetVertexColor(.25,.25,.25,1)
-          if GameTooltip:IsOwned(this) then
-            GameTooltip:Hide()
-          end
-        end)
-
-        pfUI.bag.right.sort:SetScript("OnClick", function()
           BS_slashBagSortHandler()
-        end)
+        end,
-
+        function()
-        pfUI.bag.right.search:ClearAllPoints()
+          GameTooltip:SetOwner(this, "ANCHOR_RIGHT")
-        pfUI.bag.right.search:SetPoint("TOPLEFT", pfUI.bag.right, "TOPLEFT", default_border, -default_border)
+          GameTooltip:SetText(GetAddOnMetadata("Bag_Sort","Title"))
-        pfUI.bag.right.search:SetPoint("TOPRIGHT", pfUI.bag.right.sort, "TOPLEFT", -default_border*3, -default_border)
+          GameTooltip:AddLine(GetAddOnMetadata("Bag_Sort","Notes"),1,1,1)
-      end
+          GameTooltip:Show()
-
+        end,
-      -- draw the button
+        function()
-      if not pfUI.bag.left.sort then
+          BS_slashBankSortHandler()
-        pfUI.bag.left.sort = CreateFrame("Button", "pfBankSlotSort", UIParent)
+        end,
-        pfUI.bag.left.sort:SetParent(pfUI.bag.left)
+        function()
-        pfUI.bag.left.sort:SetPoint("TOPRIGHT", pfUI.bag.left.bags, "TOPLEFT", -default_border*3, 0)
-
-        CreateBackdrop(pfUI.bag.left.sort, default_border)
-        pfUI.bag.left.sort:SetHeight(12)
-        pfUI.bag.left.sort:SetWidth(12)
-        pfUI.bag.left.sort:SetTextColor(1,1,.25,1)
-        pfUI.bag.left.sort:SetFont(pfUI.font_default, C.global.font_size, "OUTLINE")
-        pfUI.bag.left.sort.texture = pfUI.bag.left.sort:CreateTexture("pfBagArrowUp")
-        pfUI.bag.left.sort.texture:SetTexture(pfUI.media["img:sort"])
-        pfUI.bag.left.sort.texture:ClearAllPoints()
-        pfUI.bag.left.sort.texture:SetPoint("TOPLEFT", pfUI.bag.left.sort, "TOPLEFT", 2, -2)
-        pfUI.bag.left.sort.texture:SetPoint("BOTTOMRIGHT", pfUI.bag.left.sort, "BOTTOMRIGHT", -2, 2)
-        pfUI.bag.left.sort.texture:SetVertexColor(.25,.25,.25,1)
-
-        pfUI.bag.left.sort:SetScript("OnEnter", function ()
-          pfUI.bag.left.sort.backdrop:SetBackdropBorderColor(1,1,.25,1)
-          pfUI.bag.left.sort.texture:SetVertexColor(1,1,.25,1)
           GameTooltip:SetOwner(this, "ANCHOR_RIGHT")
           GameTooltip:SetText(GetAddOnMetadata("Bag_Sort","Title"))
           GameTooltip:AddLine(GetAddOnMetadata("Bag_Sort","Notes"),1,1,1)
           GameTooltip:Show()
         end)
-
-        pfUI.bag.left.sort:SetScript("OnLeave", function ()
-          CreateBackdrop(pfUI.bag.left.sort)
-          pfUI.bag.left.sort.texture:SetVertexColor(.25,.25,.25,1)
-          if GameTooltip:IsOwned(this) then
-            GameTooltip:Hide()
-          end
-        end)
-
-        pfUI.bag.left.sort:SetScript("OnClick", function()
-          BS_slashBankSortHandler()
-        end)
-      end
     end)
   end)
 

modules/thirdparty-vanilla.lua

@@ -721,105 +721,32 @@ pfUI:RegisterModule("thirdparty-vanilla", "vanilla", function()
   end)
 
   HookAddonOrVariable("SortBags", function()
-    if C.thirdparty.sortbags.enable == "0" then return end
+    if C.thirdparty.mrplow.enable == "0" then return end
 
-    if not pfUI.thirdparty.bagsort then pfUI.thirdparty.bagsort = "sortbags" end
+    local sort = CreateFrame("Frame", nil)
-    pfUI.thirdparty.sortbags = CreateFrame("Frame", nil)
+    sort:RegisterEvent("PLAYER_ENTERING_WORLD")
-    pfUI.thirdparty.sortbags:RegisterEvent("PLAYER_ENTERING_WORLD")
+    sort:SetScript("OnEvent", function()
-    pfUI.thirdparty.sortbags:SetScript("OnEvent", function()
+      this:UnregisterAllEvents()
-      pfUI.thirdparty.sortbags:UnregisterAllEvents()
 
-      -- don't do anything if another bagsorter was found
+      pfUI.thirdparty.RegisterBagSort("SortBags",
-      if pfUI.thirdparty.bagsort ~= "sortbags" then return end
+        function()
-
-      -- make sure the bag module is enabled
-      if not pfUI.bag or not pfUI.bag.right then return end
-
-      local rawborder, default_border = GetBorderSize("bags")
-
-      -- draw the button
-      if not pfUI.bag.right.sort then
-        pfUI.bag.right.sort = CreateFrame("Button", "pfBagSlotSort", UIParent)
-        pfUI.bag.right.sort:SetParent(pfUI.bag.right)
-        pfUI.bag.right.sort:SetPoint("TOPRIGHT", pfUI.bag.right.keys, "TOPLEFT", -default_border*3, 0)
-
-        CreateBackdrop(pfUI.bag.right.sort, default_border)
-        pfUI.bag.right.sort:SetHeight(12)
-        pfUI.bag.right.sort:SetWidth(12)
-        pfUI.bag.right.sort:SetTextColor(1,1,.25,1)
-        pfUI.bag.right.sort:SetFont(pfUI.font_default, C.global.font_size, "OUTLINE")
-        pfUI.bag.right.sort.texture = pfUI.bag.right.sort:CreateTexture("pfBagArrowUp")
-        pfUI.bag.right.sort.texture:SetTexture(pfUI.media["img:sort"])
-        pfUI.bag.right.sort.texture:ClearAllPoints()
-        pfUI.bag.right.sort.texture:SetPoint("TOPLEFT", pfUI.bag.right.sort, "TOPLEFT", 2, -2)
-        pfUI.bag.right.sort.texture:SetPoint("BOTTOMRIGHT", pfUI.bag.right.sort, "BOTTOMRIGHT", -2, 2)
-        pfUI.bag.right.sort.texture:SetVertexColor(.25,.25,.25,1)
-
-        pfUI.bag.right.sort:SetScript("OnEnter", function ()
-          pfUI.bag.right.sort.backdrop:SetBackdropBorderColor(1,1,.25,1)
-          pfUI.bag.right.sort.texture:SetVertexColor(1,1,.25,1)
-          GameTooltip:SetOwner(this, "ANCHOR_RIGHT")
-          GameTooltip:SetText(GetAddOnMetadata("SortBags","Title"))
-          GameTooltip:AddLine(GetAddOnMetadata("SortBags","Notes"),1,1,1)
-          GameTooltip:Show()
-        end)
-
-        pfUI.bag.right.sort:SetScript("OnLeave", function ()
-          CreateBackdrop(pfUI.bag.right.sort)
-          pfUI.bag.right.sort.texture:SetVertexColor(.25,.25,.25,1)
-          if GameTooltip:IsOwned(this) then
-            GameTooltip:Hide()
-          end
-        end)
-
-        pfUI.bag.right.sort:SetScript("OnClick", function()
           SortBags()
-        end)
+        end,
-
+        function()
-        pfUI.bag.right.search:ClearAllPoints()
+          GameTooltip:SetOwner(this, "ANCHOR_RIGHT")
-        pfUI.bag.right.search:SetPoint("TOPLEFT", pfUI.bag.right, "TOPLEFT", default_border, -default_border)
+          GameTooltip:SetText(GetAddOnMetadata("SortBags","Title"))
-        pfUI.bag.right.search:SetPoint("TOPRIGHT", pfUI.bag.right.sort, "TOPLEFT", -default_border*3, -default_border)
+          GameTooltip:AddLine(GetAddOnMetadata("SortBags","Notes"),1,1,1)
-      end
+          GameTooltip:Show()
-
+        end,
-      -- draw the button
+        function()
-      if not pfUI.bag.left.sort then
+          SortBankBags()
-        pfUI.bag.left.sort = CreateFrame("Button", "pfBankSlotSort", UIParent)
+        end,
-        pfUI.bag.left.sort:SetParent(pfUI.bag.left)
+        function()
-        pfUI.bag.left.sort:SetPoint("TOPRIGHT", pfUI.bag.left.bags, "TOPLEFT", -default_border*3, 0)
-
-        CreateBackdrop(pfUI.bag.left.sort, default_border)
-        pfUI.bag.left.sort:SetHeight(12)
-        pfUI.bag.left.sort:SetWidth(12)
-        pfUI.bag.left.sort:SetTextColor(1,1,.25,1)
-        pfUI.bag.left.sort:SetFont(pfUI.font_default, C.global.font_size, "OUTLINE")
-        pfUI.bag.left.sort.texture = pfUI.bag.left.sort:CreateTexture("pfBagArrowUp")
-        pfUI.bag.left.sort.texture:SetTexture(pfUI.media["img:sort"])
-        pfUI.bag.left.sort.texture:ClearAllPoints()
-        pfUI.bag.left.sort.texture:SetPoint("TOPLEFT", pfUI.bag.left.sort, "TOPLEFT", 2, -2)
-        pfUI.bag.left.sort.texture:SetPoint("BOTTOMRIGHT", pfUI.bag.left.sort, "BOTTOMRIGHT", -2, 2)
-        pfUI.bag.left.sort.texture:SetVertexColor(.25,.25,.25,1)
-
-        pfUI.bag.left.sort:SetScript("OnEnter", function ()
-          pfUI.bag.left.sort.backdrop:SetBackdropBorderColor(1,1,.25,1)
-          pfUI.bag.left.sort.texture:SetVertexColor(1,1,.25,1)
           GameTooltip:SetOwner(this, "ANCHOR_RIGHT")
           GameTooltip:SetText(GetAddOnMetadata("SortBags","Title"))
           GameTooltip:AddLine(GetAddOnMetadata("SortBags","Notes"),1,1,1)
           GameTooltip:Show()
         end)
-
-        pfUI.bag.left.sort:SetScript("OnLeave", function ()
-          CreateBackdrop(pfUI.bag.left.sort)
-          pfUI.bag.left.sort.texture:SetVertexColor(.25,.25,.25,1)
-          if GameTooltip:IsOwned(this) then
-            GameTooltip:Hide()
-          end
-        end)
-
-        pfUI.bag.left.sort:SetScript("OnClick", function()
-          SortBankBags()
-        end)
-      end
     end)
   end)
 

modules/thirdparty.lua

@@ -7,7 +7,6 @@ pfUI:RegisterModule("thirdparty", "vanilla:tbc", function()
   -- For expansion related code, see: thirdparty-vanilla and thirdparty-tbc.
 
   pfUI.thirdparty = {}
-  pfUI.thirdparty.bagsort = nil
 
   do -- addon dockframe
     pfUI.thirdparty.meters = CreateFrame("Frame")
@@ -97,27 +96,16 @@ pfUI:RegisterModule("thirdparty", "vanilla:tbc", function()
     end
   end
 
-  -- MrPlow Bag Sorting Addon.
-  -- Vanilla: https://www.wowace.com/projects/mr-plow/files/288059
-  -- TBC: https://www.wowace.com/projects/mr-plow/files/136162
-  HookAddonOrVariable("MrPlow", function()
-    if C.thirdparty.mrplow.enable == "0" then return end
 
-    local MrPlowL = AceLibrary and AceLibrary("AceLocale-2.2"):new("MrPlow")
+  do -- bag sort addon
-    if not (MrPlowL and MrPlowL["Bank"]) then return end
+    pfUI.thirdparty.bagsort = nil
-    pfUI.thirdparty.bagsort = "mrplow" -- dont't check for sortbags, use mrplow as default
+    function pfUI.thirdparty.RegisterBagSort(name, bag, bagtooltip, bank, banktooltip)
-
+      -- skip on certain conditions
-    pfUI.thirdparty.mrplow = CreateFrame("Frame", nil)
+      if pfUI.thirdparty.bagsort then return end
-    pfUI.thirdparty.mrplow:RegisterEvent("PLAYER_ENTERING_WORLD")
-    pfUI.thirdparty.mrplow:SetScript("OnEvent", function()
-      pfUI.thirdparty.mrplow:UnregisterAllEvents()
-
-      -- don't do anything if another bagsorter was found
-      if pfUI.thirdparty.bagsort ~= "mrplow" then return end
-
-      -- make sure the bag module is enabled
       if not pfUI.bag or not pfUI.bag.right then return end
 
+      pfUI.thirdparty.bagsort = name
+
       local rawborder, default_border = GetBorderSize("bags")
 
       -- draw the button
@@ -138,13 +126,12 @@ pfUI:RegisterModule("thirdparty", "vanilla:tbc", function()
         pfUI.bag.right.sort.texture:SetPoint("BOTTOMRIGHT", pfUI.bag.right.sort, "BOTTOMRIGHT", -2, 2)
         pfUI.bag.right.sort.texture:SetVertexColor(.25,.25,.25,1)
 
+        pfUI.bag.right.sort:SetScript("OnClick", bag)
+
         pfUI.bag.right.sort:SetScript("OnEnter", function ()
           pfUI.bag.right.sort.backdrop:SetBackdropBorderColor(1,1,.25,1)
           pfUI.bag.right.sort.texture:SetVertexColor(1,1,.25,1)
-          GameTooltip:SetOwner(this, "ANCHOR_RIGHT")
+          if bagtooltip then bagtooltip() end
-          GameTooltip:SetText(MrPlowL["Mr Plow"])
-          GameTooltip:AddLine(MrPlowL["The Works"],1,1,1)
-          GameTooltip:Show()
         end)
 
         pfUI.bag.right.sort:SetScript("OnLeave", function ()
@@ -155,10 +142,6 @@ pfUI:RegisterModule("thirdparty", "vanilla:tbc", function()
           end
         end)
 
-        pfUI.bag.right.sort:SetScript("OnClick", function()
-          MrPlow:Works()
-        end)
-
         pfUI.bag.right.search:ClearAllPoints()
         pfUI.bag.right.search:SetPoint("TOPLEFT", pfUI.bag.right, "TOPLEFT", default_border, -default_border)
         pfUI.bag.right.search:SetPoint("TOPRIGHT", pfUI.bag.right.sort, "TOPLEFT", -default_border*3, -default_border)
@@ -182,13 +165,12 @@ pfUI:RegisterModule("thirdparty", "vanilla:tbc", function()
         pfUI.bag.left.sort.texture:SetPoint("BOTTOMRIGHT", pfUI.bag.left.sort, "BOTTOMRIGHT", -2, 2)
         pfUI.bag.left.sort.texture:SetVertexColor(.25,.25,.25,1)
 
+        pfUI.bag.left.sort:SetScript("OnClick", bank)
+
         pfUI.bag.left.sort:SetScript("OnEnter", function ()
           pfUI.bag.left.sort.backdrop:SetBackdropBorderColor(1,1,.25,1)
           pfUI.bag.left.sort.texture:SetVertexColor(1,1,.25,1)
-          GameTooltip:SetOwner(this, "ANCHOR_RIGHT")
+          if banktooltip then banktooltip() end
-          GameTooltip:SetText(MrPlowL["Mr Plow"])
-          GameTooltip:AddLine(MrPlowL["Bank"],1,1,1)
-          GameTooltip:Show()
         end)
 
         pfUI.bag.left.sort:SetScript("OnLeave", function ()
@@ -198,11 +180,43 @@ pfUI:RegisterModule("thirdparty", "vanilla:tbc", function()
             GameTooltip:Hide()
           end
         end)
-
-        pfUI.bag.left.sort:SetScript("OnClick", function()
-          MrPlow:Works(MrPlowL["Bank"])
-        end)
       end
+    end
+  end
+
+  -- MrPlow Bag Sorting Addon.
+  -- Vanilla: https://www.wowace.com/projects/mr-plow/files/288059
+  -- TBC: https://www.wowace.com/projects/mr-plow/files/136162
+  HookAddonOrVariable("MrPlow", function()
+    if C.thirdparty.mrplow.enable == "0" then return end
+
+    local sort = CreateFrame("Frame", nil)
+    sort:RegisterEvent("PLAYER_ENTERING_WORLD")
+    sort:SetScript("OnEvent", function()
+      this:UnregisterAllEvents()
+
+      local MrPlowL = AceLibrary and AceLibrary("AceLocale-2.2"):new("MrPlow")
+      if not (MrPlowL and MrPlowL["Bank"]) then return end
+
+      pfUI.thirdparty.RegisterBagSort("MrPlow",
+        function()
+          MrPlow:Works()
+        end,
+        function()
+          GameTooltip:SetOwner(this, "ANCHOR_RIGHT")
+          GameTooltip:SetText(MrPlowL["Mr Plow"])
+          GameTooltip:AddLine(MrPlowL["The Works"],1,1,1)
+          GameTooltip:Show()
+        end,
+        function()
+          MrPlow:Works(MrPlowL["Bank"])
+        end,
+        function()
+          GameTooltip:SetOwner(this, "ANCHOR_RIGHT")
+          GameTooltip:SetText(MrPlowL["Mr Plow"])
+          GameTooltip:AddLine(MrPlowL["Bank"],1,1,1)
+          GameTooltip:Show()
+        end)
     end)
   end)